Class default

Hierarchy (View Summary)

default
- default

Index

Constructors

Properties

client env host token

Methods

addCustomDomain checkBaseDomain get getPendingDomains getValidatedDomains removeCustomDomain setClient update validateCustomDomain

Constructors

constructor

new default(options?: { env?: string; host?: string; token?: string }): default
Parameters
- Optionaloptions: { env?: string; host?: string; token?: string }
Returns default
Inherited from default.constructor
- Defined in v0.10/api/integrationsBaseClient.ts:10

Properties

client

client: AxiosInstance

`Protected`env

env: null | string = null

`Protected`host

host: null | string = null

`Protected`token

token: null | string = null

Methods

addCustomDomain

addCustomDomain(domain: string): Promise<AddDomainResponse>
Add a custom domain (returns a verification token for DNS validation).
Parameters
- domain: string
Returns Promise<AddDomainResponse>
- Defined in v0.10/api/integrations/ecommerce.ts:35

checkBaseDomain

checkBaseDomain(domain: string): Promise<CheckDomainResponse>
Check whether a base domain subdomain is available.
Parameters
- domain: string
Returns Promise<CheckDomainResponse>
- Defined in v0.10/api/integrations/ecommerce.ts:28

get

get(): Promise<EcommerceIntegrationUser>
Get the ecommerce integration user for the current project.

Returns Promise<EcommerceIntegrationUser>
- Defined in v0.10/api/integrations/ecommerce.ts:14

getPendingDomains

getPendingDomains(): Promise<DomainsResponse>
List pending (unvalidated) custom domains.

Returns Promise<DomainsResponse>
- Defined in v0.10/api/integrations/ecommerce.ts:56

getValidatedDomains

getValidatedDomains(): Promise<DomainsResponse>
List validated custom domains.

Returns Promise<DomainsResponse>
- Defined in v0.10/api/integrations/ecommerce.ts:63

removeCustomDomain

removeCustomDomain(
domain: string,
): Promise<{ integration: EcommerceIntegrationUser; message: string }>
Remove a custom domain.
Parameters
- domain: string
Returns Promise<{ integration: EcommerceIntegrationUser; message: string }>
- Defined in v0.10/api/integrations/ecommerce.ts:49

setClient

setClient(client: AxiosInstance): default
Parameters
- client: AxiosInstance
Returns default
Inherited from default.setClient
- Defined in v0.10/api/baseClient.ts:10

update

update(req: UpdateEcommerceSettingsRequest): Promise<EcommerceIntegrationUser>
Update ecommerce integration settings (onboarding or partial update).
Parameters
- req: UpdateEcommerceSettingsRequest
Returns Promise<EcommerceIntegrationUser>
- Defined in v0.10/api/integrations/ecommerce.ts:21

validateCustomDomain

validateCustomDomain(
domain: string,
token: string,
): Promise<{ integration: EcommerceIntegrationUser; message: string }>
Validate a custom domain with its verification token.
Parameters
- domain: string
- token: string
Returns Promise<{ integration: EcommerceIntegrationUser; message: string }>
- Defined in v0.10/api/integrations/ecommerce.ts:42