@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / AffiliateApiDepositsModule
Class: AffiliateApiDepositsModule
@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.AffiliateApiDepositsModule
A module for interacting with the customer deposits endpoint of the Affiliate API.
Since
v1.20240429.0
Methods
all
▸ all(options?): Promise<ResponseFields<AffiliateApiDepositModelDefinition>[]>
List all customer deposits matching the specified options via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
options | Omit<ListDepositOptions, "limit" | "page"> | The options to use when listing all matching customer deposits. |
Returns
Promise<ResponseFields<AffiliateApiDepositModelDefinition>[]>
A list of all matching customer deposits.
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/deposits.ts:270
list
▸ list(options?): Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiDepositModelDefinition>[], ResponseFields<AffiliateApiDepositModelDefinition>[]>>
List customer deposits via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
options | ListDepositOptions | The options to use when listing customer deposits. |
Returns
Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiDepositModelDefinition>[], ResponseFields<AffiliateApiDepositModelDefinition>[]>>
List of customer deposits
Throws
AffiliateApiOperationError If the operation was not successful.
Reference