@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / AffiliateApiSystemModule
Class: AffiliateApiSystemModule
@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.AffiliateApiSystemModule
A module for interacting with the Affiliate API's system endpoints.
Since
v1.20240429.0
Reference
Methods
complianceStatus
▸ complianceStatus(): Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiComplianceStatusModelDefinition>[], ResponseFields<AffiliateApiComplianceStatusModelDefinition>[]>>
Retrieve the available compliance statuses for a client.
Returns
Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiComplianceStatusModelDefinition>[], ResponseFields<AffiliateApiComplianceStatusModelDefinition>[]>>
The available compliance statuses for a client.
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/system.ts:227
country
▸ country(): Promise<AffiliateApiOperationResponse<string[], string[]>>
Retrieve the available countries.
Returns
Promise<AffiliateApiOperationResponse<string[], string[]>>
The available countries.
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/system.ts:247
countryWithMeta
▸ countryWithMeta(): Promise<AffiliateApiOperationResponse<PandaTsCountry[], PandaTsCountry[]>>
Retrieve the available PandaTsCountry instances.
Returns
Promise<AffiliateApiOperationResponse<PandaTsCountry[], PandaTsCountry[]>>
The available PandaTsCountry instances.
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/system.ts:262
currency
▸ currency(country): Promise<AffiliateApiOperationResponse<string[], string[]>>
Retrieve the available currencies for a country.
Parameters
| Name | Type | Description |
|---|---|---|
country | PandaTsCountryAlpha2 | The country to retrieve the available currencies for |
Returns
Promise<AffiliateApiOperationResponse<string[], string[]>>
The available currencies for the specified country
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/system.ts:285
getLoginToken
▸ getLoginToken(email, options?): Promise<string>
Retrieve a login token for a client to use to automatically log in.
Parameters
| Name | Type | Description |
|---|---|---|
email | string | The email of the client to generate a login token for |
options | AffiliateApiLoginTokenOptions | The additional options / parameters to use when generating the login token |
Returns
Promise<string>
The login token which can be added as a query parameter to a URL to allow a client to automatically log in on platform loading
Throws
AffiliateApiOperationError If the operation to retrieve the autologin URL was not successful.
Throws
Error If the autologin URL returned does not contain a token
Defined in
src/clients/affiliateApi/system.ts:210
language
▸ language(): Promise<AffiliateApiOperationResponse<string[], string[]>>
Retrieve the available languages.
Returns
Promise<AffiliateApiOperationResponse<string[], string[]>>
The available languages.
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/system.ts:301
languageWithMeta
▸ languageWithMeta(): Promise<AffiliateApiOperationResponse<PandaTsLanguage[], PandaTsLanguage[]>>
Retrieve the available PandaTsLanguage instances.
Returns
Promise<AffiliateApiOperationResponse<PandaTsLanguage[], PandaTsLanguage[]>>
The available PandaTsLanguage instances.
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/system.ts:316
loginToken
▸ loginToken(email, options?, urlApiOptions?): Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiLoginTokenModelDefinition>, ResponseFields<AffiliateApiLoginTokenModelDefinition>>>
Create a URL with an autologin token which can be passed to a client to log in.
Parameters
| Name | Type | Description |
|---|---|---|
email | string | The email of the client to generate a login token for |
options | AffiliateApiLoginTokenOptions | The additional options / parameters to use when generating the login token |
urlApiOptions | PandaTsAuthenticatedReturnUrlOptions | The additional options / parameters to use when generating the autologin URL |
Returns
Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiLoginTokenModelDefinition>, ResponseFields<AffiliateApiLoginTokenModelDefinition>>>
A URL that the client can use to log in
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/system.ts:165
partnerRestrictions
▸ partnerRestrictions(): Promise<AffiliateApiOperationResponse<AffiliateApiPartnerRestriction, AffiliateApiPartnerRestriction>>
Retrieve the available partner restrictions.
Returns
Promise<AffiliateApiOperationResponse<AffiliateApiPartnerRestriction, AffiliateApiPartnerRestriction>>
The available partner restrictions.
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Deprecated
As of v1.20240429.0, this endpoint is broken and will always return an error.