@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi
Namespace: @nht-pandats/sdk/clients/affiliateApi
@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi
Classes
- AffiliateApiAuthenticationError
- AffiliateApiCallbacksModule
- AffiliateApiClient
- AffiliateApiCommentsModule
- AffiliateApiCustomersModule
- AffiliateApiDecryptorModule
- AffiliateApiDepositsModule
- AffiliateApiLeadsModule
- AffiliateApiMarketingModule
- AffiliateApiOperationError
- AffiliateApiOperationResponse
- AffiliateApiOperationResponsePaginationInformation
- AffiliateApiOperationResponseRateLimitInformation
- AffiliateApiSystemModule
- AffiliateApiTradingAccountsModule
Interfaces
- AffiliateApiCallbackSaveSuccessfulResponse
- AffiliateApiCallbacksModelDefinition
- AffiliateApiCommentSaveSuccessfulResponse
- AffiliateApiCommentsModelDefinition
- AffiliateApiComplianceStatusModelDefinition
- AffiliateApiCustomerModelDefinition
- AffiliateApiCustomerSaveSuccessfulResponse
- AffiliateApiDepositModelDefinition
- AffiliateApiError
- AffiliateApiErrorResponse
- AffiliateApiLeadModelDefinition
- AffiliateApiLeadSaveSuccessfulResponse
- AffiliateApiLoginTokenModelDefinition
- AffiliateApiMarketingSaveSuccessfulResponse
- AffiliateApiPartnerRestriction
- AffiliateApiPartnerRestrictionLimit
- AffiliateApiTradingAccountsModelDefinition
- ListCommentOptions
- ListDepositOptions
- ListMethodOptions
- ListTradingAccountOptions
- ModuleFieldDefinition
- ModuleModelDefinition
- PandaTsAuthenticatedReturnUrlOptions
- RemarketCustomerOptionsBase
- RemarketCustomerOptionsWithClientSource
- RemarketCustomerOptionsWithReferral
Type Aliases
AffiliateApiClientStore
Ƭ AffiliateApiClientStore: Redis
Describes the store used to cache the JWT token to prevent unnecessary re-authentication.
Defined in
src/clients/affiliateApi/index.ts:78
AffiliateApiLoginTokenOptions
Ƭ AffiliateApiLoginTokenOptions: Omit<CreatePayload<AffiliateApiLoginTokenModelDefinition>, "email">
Describes the shape of the optional arguments for the loginToken method.
Defined in
src/clients/affiliateApi/system.ts:68
ContainFilter
Ƭ ContainFilter<T>: T | T[]
A utility type for defining a contain filter (OR).
Type parameters
| Name | Description |
|---|---|
T | The type of the field. |
Defined in
src/clients/affiliateApi/utils.ts:506
CreatePayload
Ƭ CreatePayload<T>: OptionalCreateFields<T> & RequiredCreateFields<T>
Combines optional and required fields into a single type for create payload.
Type parameters
| Name | Type |
|---|---|
T | extends ModuleModelDefinition |
Defined in
src/clients/affiliateApi/utils.ts:473
FieldFilter
Ƭ FieldFilter<T>: T["filters"] extends { match: true } ? { [K in string]?: MatchFilter<T["type"]> } : {} & T["filters"] extends { contain: true } ? { [K in string]?: ContainFilter<T["type"]> } : {} & T["filters"] extends { range: true } ? { [K in string]?: RangeFilter<T["type"]> } : {}
A utility type for defining an available filter for a module model for a list method operation.
Type parameters
| Name | Type | Description |
|---|---|---|
T | extends ModuleFieldDefinition | The type of the field. |
Defined in
src/clients/affiliateApi/utils.ts:517
Filters
Ƭ Filters<T>: { [K in keyof T]?: FieldFilter<T[K]> }
A utility type for defining the available filters for a module model for a list method operation.
Type parameters
| Name | Type | Description |
|---|---|---|
T | extends ModuleModelDefinition | The type of the module model. |
Defined in
src/clients/affiliateApi/utils.ts:527
MatchFilter
Ƭ MatchFilter<T>: T
A utility type for defining a match filter (AND).
Type parameters
| Name | Description |
|---|---|
T | The type of the field. |
Defined in
src/clients/affiliateApi/utils.ts:501
ModuleModelResponse
Ƭ ModuleModelResponse<T, K>: K extends keyof ResponseFields<T> ? Pick<ResponseFields<T>, K> : ResponseFields<T>
Utility type to optionally restrict the model response to only include specified fields. If no fields are provided, it defaults to all fields that can be included in the response.
Type parameters
| Name | Type | Description |
|---|---|---|
T | extends ModuleModelDefinition | The type of the module model. |
K | extends keyof ResponseFields<T> | undefined = undefined | Optional subset of keys to include in the response. |
Defined in
src/clients/affiliateApi/utils.ts:450
OptionalCreateFields
Ƭ OptionalCreateFields<T>: { [P in keyof T as T[P]["inCreatePayload"] extends true ? P : never]?: T[P]["type"] }
Utility type to extract fields that can be included in create payload. Optional fields will have their types wrapped with ? to mark them as optional.
Type parameters
| Name | Type |
|---|---|
T | extends ModuleModelDefinition |
Defined in
src/clients/affiliateApi/utils.ts:459
OptionalUpdateFields
Ƭ OptionalUpdateFields<T>: { [P in keyof T as T[P]["inUpdatePayload"] extends true ? P : never]?: T[P]["type"] }
Utility type to extract fields that can be included in update payload. Optional fields will have their types wrapped with ? to mark them as optional.
Type parameters
| Name | Type |
|---|---|
T | extends ModuleModelDefinition |
Defined in
src/clients/affiliateApi/utils.ts:480
PandaTsAuthenticatedUrlApiAction
Ƭ PandaTsAuthenticatedUrlApiAction: undefined | "forexDeposit" | "forexSignup" | "forexLogin" | "forexPersonalDetails" | "forexChangePassword" | "forexVerification" | "forexManageAccounts" | "forexServiceDesk" | "forexWithdraw" | "forexTransactions"
The possible actions that can be triggered on platform load when using the autologin token.
Defined in
src/clients/affiliateApi/system.ts:76
RangeFilter
Ƭ RangeFilter<T>: Object
A utility type for defining a range filter (min <= value <= max).
Type parameters
| Name | Description |
|---|---|
T | The type of the field. |
Type declaration
| Name | Type |
|---|---|
max? | T |
min? | T |
max?: T
-
min?: T
-
Defined in
src/clients/affiliateApi/utils.ts:511
RemarketCustomerOptions
Ƭ RemarketCustomerOptions: RemarketCustomerOptionsWithReferral | RemarketCustomerOptionsWithClientSource
Options for a request to remarket a customer.
Defined in
src/clients/affiliateApi/marketing.ts:32
RequiredCreateFields
Ƭ RequiredCreateFields<T>: { [P in keyof T as T[P]["requiredInCreatePayload"] extends true ? P : never]: T[P]["type"] }
Utility type to extract fields that are required in create payload.
Type parameters
| Name | Type |
|---|---|
T | extends ModuleModelDefinition |
Defined in
src/clients/affiliateApi/utils.ts:466
RequiredUpdateFields
Ƭ RequiredUpdateFields<T>: { [P in keyof T as T[P]["requiredInUpdatePayload"] extends true ? P : never]: T[P]["type"] }
Utility type to extract fields that are required in update payload.
Type parameters
| Name | Type |
|---|---|
T | extends ModuleModelDefinition |
Defined in
src/clients/affiliateApi/utils.ts:487
ResponseFields
Ƭ ResponseFields<T>: { [P in keyof T as T[P]["inResponsePayload"] extends true ? P : never]: T[P]["type"] }
Utility type to extract fields that are included in the response payload.
Type parameters
| Name | Type |
|---|---|
T | extends ModuleModelDefinition |
Defined in
src/clients/affiliateApi/utils.ts:440
SortOrder
Ƭ SortOrder<T>: { [P in keyof SortableKeys<T>]: "asc" | "desc" }
A utility type for defining the sort order of a list method operation.
Type parameters
| Name | Type | Description |
|---|---|---|
T | extends ModuleModelDefinition | The type of the module model. |
Defined in
src/clients/affiliateApi/utils.ts:543
SortableKeys
Ƭ SortableKeys<T>: { [K in keyof T as T[K]["sortable"] extends true ? K : never]: K }
A utility type for defining the sortable keys of a module model.
Type parameters
| Name | Type | Description |
|---|---|---|
T | extends ModuleModelDefinition | The type of the module model. |
Defined in
src/clients/affiliateApi/utils.ts:535
UpdatePayload
Ƭ UpdatePayload<T>: OptionalUpdateFields<T> & RequiredUpdateFields<T>
Combines optional and required fields into a single type for update payload.
Type parameters
| Name | Type |
|---|---|
T | extends ModuleModelDefinition |