Interface APIResponse<T>

Standard API response wrapper

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

Example

const response: APIResponse<UserInterface> = {
  data: {
    id: 'user-123',
    email: 'user@example.com',
    name: 'John Doe'
  },
  paging: {
    limit: 10,
    offset: 0,
    total: 1
  }
};
interface APIResponse<T> {
    data: null | T | T[];
    paging?: PagingInterface;
}

Type Parameters

  • T

    The type of data contained in the response

Properties

data paging?

Properties

data

data: null | T | T[]

The response data, can be a single item or array

Optionalpaging

paging?: PagingInterface

Pagination information for list responses

Settings

Member Visibility

On This Page

Properties