Interface BatchAPIResponse<T>

Batch API response wrapper

All batch API responses are wrapped in this structure to provide consistent response handling across the SDK.

Example

const batchResponse: BatchAPIResponse<UserInterface> = {
  data: [
    { id: 'user-1', email: 'user1@example.com' },
    { id: 'user-2', email: 'user2@example.com' }
  ],
  paging: {
    limit: 10,
    offset: 0,
    total: 2
  }
};
interface BatchAPIResponse<T> {
    data: T[];
    paging?: PagingInterface;
}

Type Parameters

  • T

    The type of data contained in the response

Properties

data paging?

Properties

data

data: T[]

Array of response data items

Optionalpaging

paging?: PagingInterface

Pagination information

Settings

Member Visibility

On This Page

Properties