@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / ListMethodOptions

Interface: ListMethodOptions<T>

@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.ListMethodOptions

A utility type for defining the options for a list method operation.

Type parameters

Name	Type	Description
T	extends ModuleModelDefinition	The type of the module model.

Hierarchy

• ListMethodOptions

  ↳ ListTradingAccountOptions

  ↳ ListDepositOptions

  ↳ ListCommentOptions

Properties

fields

• Optional fields: keyof T[]

The fields to return in the response. If not provided, all fields will be returned.

Defined in

src/clients/affiliateApi/utils.ts:563

---

filter

• Optional filter: Filters<T>

The filters to apply to the results.

Defined in

src/clients/affiliateApi/utils.ts:567

---

limit

• Optional limit: number

The maximum number of results to return. Cannot exceed 200.

Defined in

src/clients/affiliateApi/utils.ts:559

---

page

• Optional page: number

The page number of the results to return.

Defined in

src/clients/affiliateApi/utils.ts:555

---

sort

• Optional sort: Object

The field and order to sort the results by.

Type declaration

Name	Type
asc	undefined | keyof SortableKeys<T>
desc	undefined | keyof SortableKeys<T>

asc: undefined | keyof SortableKeys<T>

-

---

desc: undefined | keyof SortableKeys<T>

-

---

Defined in

src/clients/affiliateApi/utils.ts:571