@shifter/sdk

Index

Enumerations

Classes

Interfaces

Functions

Const AccountApiAxiosParamCreator

AccountApiAxiosParamCreator(configuration?: Configuration): { accountAvailablePost: (options?: any) => Promise<RequestArgs>; accountDelete: (options?: any) => Promise<RequestArgs>; accountInvoiceAddressPost: (request?: InlineObject27, options?: any) => Promise<RequestArgs>; accountLogAuthEventsGet: (maxResults?: number, options?: any) => Promise<RequestArgs>; accountNotificationEmailSynchronizationPost: (options?: any) => Promise<RequestArgs>; accountNotificationTargetPost: (target: "email", request?: InlineObject26, options?: any) => Promise<RequestArgs> }

- Defined in api.ts:3719
AccountApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { accountAvailablePost: (options?: any) => Promise<RequestArgs>; accountDelete: (options?: any) => Promise<RequestArgs>; accountInvoiceAddressPost: (request?: InlineObject27, options?: any) => Promise<RequestArgs>; accountLogAuthEventsGet: (maxResults?: number, options?: any) => Promise<RequestArgs>; accountNotificationEmailSynchronizationPost: (options?: any) => Promise<RequestArgs>; accountNotificationTargetPost: (target: "email", request?: InlineObject26, options?: any) => Promise<RequestArgs> }
- accountAvailablePost: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - Check user is valid
      
      throws
      
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- accountDelete: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - You can delete your account. An invited user cannot be accessed this API.
      
      throws
      
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- accountInvoiceAddressPost: (request?: InlineObject27, options?: any) => Promise<RequestArgs>
  - - (request?: InlineObject27, options?: any): Promise<RequestArgs>
    - Update address which will be written it to the invoice
      
      throws
      
      {RequiredError}
      
      Parameters
      - Optional request: InlineObject27
      - options: any = {}
      Returns Promise<RequestArgs>
- accountLogAuthEventsGet: (maxResults?: number, options?: any) => Promise<RequestArgs>
  - - (maxResults?: number, options?: any): Promise<RequestArgs>
    - Get events of user authentication
      
      throws
      
      {RequiredError}
      
      Parameters
      - Optional maxResults: number
      - options: any = {}
      Returns Promise<RequestArgs>
- accountNotificationEmailSynchronizationPost: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - Synchronize your email to stripe
      
      throws
      
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- accountNotificationTargetPost: (target: "email", request?: InlineObject26, options?: any) => Promise<RequestArgs>
  - - (target: "email", request?: InlineObject26, options?: any): Promise<RequestArgs>
    - Adding your email destination when sending some notifications
      
      throws
      
      {RequiredError}
      
      Parameters
      - target: "email"
      - Optional request: InlineObject26
      - options: any = {}
      Returns Promise<RequestArgs>

Const AccountApiFactory

AccountApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { accountAvailablePost: any; accountDelete: any; accountInvoiceAddressPost: any; accountLogAuthEventsGet: any; accountNotificationEmailSynchronizationPost: any; accountNotificationTargetPost: any }

- Defined in api.ts:4005
AccountApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { accountAvailablePost: any; accountDelete: any; accountInvoiceAddressPost: any; accountLogAuthEventsGet: any; accountNotificationEmailSynchronizationPost: any; accountNotificationTargetPost: any }
- accountAvailablePost: function
  - accountAvailablePost(options?: any): AxiosPromise<InlineResponse2015>
  - - Defined in api.ts:4013
    Check user is valid
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<InlineResponse2015>
- accountDelete: function
  - accountDelete(options?: any): AxiosPromise<void>
  - - Defined in api.ts:4021
    You can delete your account. An invited user cannot be accessed this API.
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<void>
- accountInvoiceAddressPost: function
  - accountInvoiceAddressPost(request?: InlineObject27, options?: any): AxiosPromise<void>
  - - Defined in api.ts:4030
    Update address which will be written it to the invoice
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional request: InlineObject27
    - Optional options: any
    Returns AxiosPromise<void>
- accountLogAuthEventsGet: function
  - accountLogAuthEventsGet(maxResults?: number, options?: any): AxiosPromise<InlineResponse20012[]>
  - - Defined in api.ts:4039
    Get events of user authentication
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional maxResults: number
    - Optional options: any
    Returns AxiosPromise<InlineResponse20012[]>
- accountNotificationEmailSynchronizationPost: function
  - accountNotificationEmailSynchronizationPost(options?: any): AxiosPromise<void>
  - - Defined in api.ts:4047
    Synchronize your email to stripe
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<void>
- accountNotificationTargetPost: function
  - accountNotificationTargetPost(target: "email", request?: InlineObject26, options?: any): AxiosPromise<void>
  - - Defined in api.ts:4057
    Adding your email destination when sending some notifications
    
    throws
    
    {RequiredError}
    
    Parameters
    - target: "email"
    - Optional request: InlineObject26
    - Optional options: any
    Returns AxiosPromise<void>

Const AccountApiFp

AccountApiFp(configuration?: Configuration): { accountAvailablePost: any; accountDelete: any; accountInvoiceAddressPost: any; accountLogAuthEventsGet: any; accountNotificationEmailSynchronizationPost: any; accountNotificationTargetPost: any }

- Defined in api.ts:3937
AccountApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { accountAvailablePost: any; accountDelete: any; accountInvoiceAddressPost: any; accountLogAuthEventsGet: any; accountNotificationEmailSynchronizationPost: any; accountNotificationTargetPost: any }
- accountAvailablePost: function
  - accountAvailablePost(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2015>>
  - - Defined in api.ts:3945
    Check user is valid
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2015>>
- accountDelete: function
  - accountDelete(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:3954
    You can delete your account. An invited user cannot be accessed this API.
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- accountInvoiceAddressPost: function
  - accountInvoiceAddressPost(request?: InlineObject27, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:3964
    Update address which will be written it to the invoice
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional request: InlineObject27
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- accountLogAuthEventsGet: function
  - accountLogAuthEventsGet(maxResults?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse20012[]>>
  - - Defined in api.ts:3974
    Get events of user authentication
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional maxResults: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse20012[]>>
- accountNotificationEmailSynchronizationPost: function
  - accountNotificationEmailSynchronizationPost(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:3983
    Synchronize your email to stripe
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- accountNotificationTargetPost: function
  - accountNotificationTargetPost(target: "email", request?: InlineObject26, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:3994
    Adding your email destination when sending some notifications
    
    throws
    
    {RequiredError}
    
    Parameters
    - target: "email"
    - Optional request: InlineObject26
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const ArtifactsApiAxiosParamCreator

ArtifactsApiAxiosParamCreator(configuration?: Configuration): { projectsProjectIdArtifactsArtifactIdDownloadUrlGet: (projectId: string, artifactId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdArtifactNamePut: (siteId: string, artifactId: string, request: InlineObject24, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdBackupUrlGet: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdDelete: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdDeployDeployTypePost: (siteId: string, artifactId: string, deployType: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdDownloadUrlGet: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdGeneratorDelete: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdPreviewPost: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdPublishJobIdDelete: (siteId: string, artifactId: string, jobId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdPublishJobIdPost: (siteId: string, artifactId: string, jobId: string, request: InlineObject23, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdPublishPost: (siteId: string, artifactId: string, request?: InlineObject22, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdWebhookRunnerPost: (siteId: string, artifactId: string, request?: InlineObject25, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsGet: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsPost: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdCheckGeneratorProcessGet: (siteId: string, options?: any) => Promise<RequestArgs> }

- Defined in api.ts:4140
ArtifactsApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { projectsProjectIdArtifactsArtifactIdDownloadUrlGet: (projectId: string, artifactId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdArtifactNamePut: (siteId: string, artifactId: string, request: InlineObject24, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdBackupUrlGet: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdDelete: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdDeployDeployTypePost: (siteId: string, artifactId: string, deployType: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdDownloadUrlGet: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdGeneratorDelete: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdPreviewPost: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdPublishJobIdDelete: (siteId: string, artifactId: string, jobId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdPublishJobIdPost: (siteId: string, artifactId: string, jobId: string, request: InlineObject23, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdPublishPost: (siteId: string, artifactId: string, request?: InlineObject22, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsArtifactIdWebhookRunnerPost: (siteId: string, artifactId: string, request?: InlineObject25, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsGet: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdArtifactsPost: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdCheckGeneratorProcessGet: (siteId: string, options?: any) => Promise<RequestArgs> }
- projectsProjectIdArtifactsArtifactIdDownloadUrlGet: (projectId: string, artifactId: string, options?: any) => Promise<RequestArgs>
  - - (projectId: string, artifactId: string, options?: any): Promise<RequestArgs>
    - Get the URL of the artifact. All published assets of the site is included.
      
      throws
      
      {RequiredError}
      
      Parameters
      - projectId: string
        
        Site ID
      - artifactId: string
        
        Artifact ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdArtifactsArtifactIdArtifactNamePut: (siteId: string, artifactId: string, request: InlineObject24, options?: any) => Promise<RequestArgs>
  - - (siteId: string, artifactId: string, request: InlineObject24, options?: any): Promise<RequestArgs>
    - Update your artifact name.
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - artifactId: string
        
        Artifact ID
      - request: InlineObject24
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdArtifactsArtifactIdBackupUrlGet: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, artifactId: string, options?: any): Promise<RequestArgs>
    - Retrieve path of WordPress from backup archive
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - artifactId: string
        
        Artifact ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdArtifactsArtifactIdDelete: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, artifactId: string, options?: any): Promise<RequestArgs>
    - Delete artifacts
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - artifactId: string
        
        Artifact ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdArtifactsArtifactIdDeployDeployTypePost: (siteId: string, artifactId: string, deployType: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, artifactId: string, deployType: string, options?: any): Promise<RequestArgs>
    - Set the artifact to public on the CDN
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - artifactId: string
        
        Artifact ID
      - deployType: string
        
        Deployment Type (only shifter_cdn)
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdArtifactsArtifactIdDownloadUrlGet: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, artifactId: string, options?: any): Promise<RequestArgs>
    - Get the URL of the artifact. All published assets of the site is included.
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - artifactId: string
        
        Artifact ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdArtifactsArtifactIdGeneratorDelete: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, artifactId: string, options?: any): Promise<RequestArgs>
    - Stop generating process
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - artifactId: string
        
        Artifact ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdArtifactsArtifactIdPreviewPost: (siteId: string, artifactId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, artifactId: string, options?: any): Promise<RequestArgs>
    - Enable artifact previews
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - artifactId: string
        
        Artifact ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdArtifactsArtifactIdPublishJobIdDelete: (siteId: string, artifactId: string, jobId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, artifactId: string, jobId: string, options?: any): Promise<RequestArgs>
    - Delete scheduled publish
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - artifactId: string
        
        Artifact ID
      - jobId: string
        
        Schedule Job ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdArtifactsArtifactIdPublishJobIdPost: (siteId: string, artifactId: string, jobId: string, request: InlineObject23, options?: any) => Promise<RequestArgs>
  - - (siteId: string, artifactId: string, jobId: string, request: InlineObject23, options?: any): Promise<RequestArgs>
    - Update publish schedule
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - artifactId: string
        
        Artifact ID
      - jobId: string
        
        Schedule Job ID
      - request: InlineObject23
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdArtifactsArtifactIdPublishPost: (siteId: string, artifactId: string, request?: InlineObject22, options?: any) => Promise<RequestArgs>
  - - (siteId: string, artifactId: string, request?: InlineObject22, options?: any): Promise<RequestArgs>
    - Set the artifact to public on the Shifter CDN. OR Set the publish date of the artifact
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - artifactId: string
        
        Artifact ID
      - Optional request: InlineObject22
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdArtifactsArtifactIdWebhookRunnerPost: (siteId: string, artifactId: string, request?: InlineObject25, options?: any) => Promise<RequestArgs>
  - - (siteId: string, artifactId: string, request?: InlineObject25, options?: any): Promise<RequestArgs>
    - execute webhook of specific artifact
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
      - artifactId: string
      - Optional request: InlineObject25
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdArtifactsGet: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - List all artifacts.
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdArtifactsPost: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Generate artifact.
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdCheckGeneratorProcessGet: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - You can get the process of generating
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
      - options: any = {}
      Returns Promise<RequestArgs>

Const ArtifactsApiFactory

ArtifactsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { projectsProjectIdArtifactsArtifactIdDownloadUrlGet: any; sitesSiteIdArtifactsArtifactIdArtifactNamePut: any; sitesSiteIdArtifactsArtifactIdBackupUrlGet: any; sitesSiteIdArtifactsArtifactIdDelete: any; sitesSiteIdArtifactsArtifactIdDeployDeployTypePost: any; sitesSiteIdArtifactsArtifactIdDownloadUrlGet: any; sitesSiteIdArtifactsArtifactIdGeneratorDelete: any; sitesSiteIdArtifactsArtifactIdPreviewPost: any; sitesSiteIdArtifactsArtifactIdPublishJobIdDelete: any; sitesSiteIdArtifactsArtifactIdPublishJobIdPost: any; sitesSiteIdArtifactsArtifactIdPublishPost: any; sitesSiteIdArtifactsArtifactIdWebhookRunnerPost: any; sitesSiteIdArtifactsGet: any; sitesSiteIdArtifactsPost: any; sitesSiteIdCheckGeneratorProcessGet: any }

- Defined in api.ts:4948
ArtifactsApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { projectsProjectIdArtifactsArtifactIdDownloadUrlGet: any; sitesSiteIdArtifactsArtifactIdArtifactNamePut: any; sitesSiteIdArtifactsArtifactIdBackupUrlGet: any; sitesSiteIdArtifactsArtifactIdDelete: any; sitesSiteIdArtifactsArtifactIdDeployDeployTypePost: any; sitesSiteIdArtifactsArtifactIdDownloadUrlGet: any; sitesSiteIdArtifactsArtifactIdGeneratorDelete: any; sitesSiteIdArtifactsArtifactIdPreviewPost: any; sitesSiteIdArtifactsArtifactIdPublishJobIdDelete: any; sitesSiteIdArtifactsArtifactIdPublishJobIdPost: any; sitesSiteIdArtifactsArtifactIdPublishPost: any; sitesSiteIdArtifactsArtifactIdWebhookRunnerPost: any; sitesSiteIdArtifactsGet: any; sitesSiteIdArtifactsPost: any; sitesSiteIdCheckGeneratorProcessGet: any }
- projectsProjectIdArtifactsArtifactIdDownloadUrlGet: function
  - projectsProjectIdArtifactsArtifactIdDownloadUrlGet(projectId: string, artifactId: string, options?: any): AxiosPromise<ArtifactDownloadResponse>
  - - Defined in api.ts:4958
    Get the URL of the artifact. All published assets of the site is included.
    
    throws
    
    {RequiredError}
    
    Parameters
    - projectId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - Optional options: any
    Returns AxiosPromise<ArtifactDownloadResponse>
- sitesSiteIdArtifactsArtifactIdArtifactNamePut: function
  - sitesSiteIdArtifactsArtifactIdArtifactNamePut(siteId: string, artifactId: string, request: InlineObject24, options?: any): AxiosPromise<void>
  - - Defined in api.ts:4969
    Update your artifact name.
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - request: InlineObject24
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdArtifactsArtifactIdBackupUrlGet: function
  - sitesSiteIdArtifactsArtifactIdBackupUrlGet(siteId: string, artifactId: string, options?: any): AxiosPromise<InlineResponse2008>
  - - Defined in api.ts:4979
    Retrieve path of WordPress from backup archive
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - Optional options: any
    Returns AxiosPromise<InlineResponse2008>
- sitesSiteIdArtifactsArtifactIdDelete: function
  - sitesSiteIdArtifactsArtifactIdDelete(siteId: string, artifactId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:4989
    Delete artifacts
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdArtifactsArtifactIdDeployDeployTypePost: function
  - sitesSiteIdArtifactsArtifactIdDeployDeployTypePost(siteId: string, artifactId: string, deployType: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:5000
    Set the artifact to public on the CDN
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - deployType: string
      
      Deployment Type (only shifter_cdn)
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdArtifactsArtifactIdDownloadUrlGet: function
  - sitesSiteIdArtifactsArtifactIdDownloadUrlGet(siteId: string, artifactId: string, options?: any): AxiosPromise<ArtifactDownloadResponse>
  - - Defined in api.ts:5010
    Get the URL of the artifact. All published assets of the site is included.
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - Optional options: any
    Returns AxiosPromise<ArtifactDownloadResponse>
- sitesSiteIdArtifactsArtifactIdGeneratorDelete: function
  - sitesSiteIdArtifactsArtifactIdGeneratorDelete(siteId: string, artifactId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:5020
    Stop generating process
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdArtifactsArtifactIdPreviewPost: function
  - sitesSiteIdArtifactsArtifactIdPreviewPost(siteId: string, artifactId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:5030
    Enable artifact previews
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdArtifactsArtifactIdPublishJobIdDelete: function
  - sitesSiteIdArtifactsArtifactIdPublishJobIdDelete(siteId: string, artifactId: string, jobId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:5041
    Delete scheduled publish
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - jobId: string
      
      Schedule Job ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdArtifactsArtifactIdPublishJobIdPost: function
  - sitesSiteIdArtifactsArtifactIdPublishJobIdPost(siteId: string, artifactId: string, jobId: string, request: InlineObject23, options?: any): AxiosPromise<InlineResponse2014>
  - - Defined in api.ts:5053
    Update publish schedule
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - jobId: string
      
      Schedule Job ID
    - request: InlineObject23
    - Optional options: any
    Returns AxiosPromise<InlineResponse2014>
- sitesSiteIdArtifactsArtifactIdPublishPost: function
  - sitesSiteIdArtifactsArtifactIdPublishPost(siteId: string, artifactId: string, request?: InlineObject22, options?: any): AxiosPromise<InlineResponse2013>
  - - Defined in api.ts:5064
    Set the artifact to public on the Shifter CDN. OR Set the publish date of the artifact
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - Optional request: InlineObject22
    - Optional options: any
    Returns AxiosPromise<InlineResponse2013>
- sitesSiteIdArtifactsArtifactIdWebhookRunnerPost: function
  - sitesSiteIdArtifactsArtifactIdWebhookRunnerPost(siteId: string, artifactId: string, request?: InlineObject25, options?: any): AxiosPromise<void>
  - - Defined in api.ts:5075
    execute webhook of specific artifact
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - artifactId: string
    - Optional request: InlineObject25
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdArtifactsGet: function
  - sitesSiteIdArtifactsGet(siteId: string, options?: any): AxiosPromise<ArtifactGetResponse[]>
  - - Defined in api.ts:5084
    List all artifacts.
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<ArtifactGetResponse[]>
- sitesSiteIdArtifactsPost: function
  - sitesSiteIdArtifactsPost(siteId: string, options?: any): AxiosPromise<object>
  - - Defined in api.ts:5093
    Generate artifact.
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<object>
- sitesSiteIdCheckGeneratorProcessGet: function
  - sitesSiteIdCheckGeneratorProcessGet(siteId: string, options?: any): AxiosPromise<object>
  - - Defined in api.ts:5102
    You can get the process of generating
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional options: any
    Returns AxiosPromise<object>

Const ArtifactsApiFp

ArtifactsApiFp(configuration?: Configuration): { projectsProjectIdArtifactsArtifactIdDownloadUrlGet: any; sitesSiteIdArtifactsArtifactIdArtifactNamePut: any; sitesSiteIdArtifactsArtifactIdBackupUrlGet: any; sitesSiteIdArtifactsArtifactIdDelete: any; sitesSiteIdArtifactsArtifactIdDeployDeployTypePost: any; sitesSiteIdArtifactsArtifactIdDownloadUrlGet: any; sitesSiteIdArtifactsArtifactIdGeneratorDelete: any; sitesSiteIdArtifactsArtifactIdPreviewPost: any; sitesSiteIdArtifactsArtifactIdPublishJobIdDelete: any; sitesSiteIdArtifactsArtifactIdPublishJobIdPost: any; sitesSiteIdArtifactsArtifactIdPublishPost: any; sitesSiteIdArtifactsArtifactIdWebhookRunnerPost: any; sitesSiteIdArtifactsGet: any; sitesSiteIdArtifactsPost: any; sitesSiteIdCheckGeneratorProcessGet: any }

- Defined in api.ts:4769
ArtifactsApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { projectsProjectIdArtifactsArtifactIdDownloadUrlGet: any; sitesSiteIdArtifactsArtifactIdArtifactNamePut: any; sitesSiteIdArtifactsArtifactIdBackupUrlGet: any; sitesSiteIdArtifactsArtifactIdDelete: any; sitesSiteIdArtifactsArtifactIdDeployDeployTypePost: any; sitesSiteIdArtifactsArtifactIdDownloadUrlGet: any; sitesSiteIdArtifactsArtifactIdGeneratorDelete: any; sitesSiteIdArtifactsArtifactIdPreviewPost: any; sitesSiteIdArtifactsArtifactIdPublishJobIdDelete: any; sitesSiteIdArtifactsArtifactIdPublishJobIdPost: any; sitesSiteIdArtifactsArtifactIdPublishPost: any; sitesSiteIdArtifactsArtifactIdWebhookRunnerPost: any; sitesSiteIdArtifactsGet: any; sitesSiteIdArtifactsPost: any; sitesSiteIdCheckGeneratorProcessGet: any }
- projectsProjectIdArtifactsArtifactIdDownloadUrlGet: function
  - projectsProjectIdArtifactsArtifactIdDownloadUrlGet(projectId: string, artifactId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArtifactDownloadResponse>>
  - - Defined in api.ts:4779
    Get the URL of the artifact. All published assets of the site is included.
    
    throws
    
    {RequiredError}
    
    Parameters
    - projectId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArtifactDownloadResponse>>
- sitesSiteIdArtifactsArtifactIdArtifactNamePut: function
  - sitesSiteIdArtifactsArtifactIdArtifactNamePut(siteId: string, artifactId: string, request: InlineObject24, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:4791
    Update your artifact name.
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - request: InlineObject24
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdArtifactsArtifactIdBackupUrlGet: function
  - sitesSiteIdArtifactsArtifactIdBackupUrlGet(siteId: string, artifactId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2008>>
  - - Defined in api.ts:4802
    Retrieve path of WordPress from backup archive
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2008>>
- sitesSiteIdArtifactsArtifactIdDelete: function
  - sitesSiteIdArtifactsArtifactIdDelete(siteId: string, artifactId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:4813
    Delete artifacts
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdArtifactsArtifactIdDeployDeployTypePost: function
  - sitesSiteIdArtifactsArtifactIdDeployDeployTypePost(siteId: string, artifactId: string, deployType: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:4825
    Set the artifact to public on the CDN
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - deployType: string
      
      Deployment Type (only shifter_cdn)
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdArtifactsArtifactIdDownloadUrlGet: function
  - sitesSiteIdArtifactsArtifactIdDownloadUrlGet(siteId: string, artifactId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArtifactDownloadResponse>>
  - - Defined in api.ts:4836
    Get the URL of the artifact. All published assets of the site is included.
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArtifactDownloadResponse>>
- sitesSiteIdArtifactsArtifactIdGeneratorDelete: function
  - sitesSiteIdArtifactsArtifactIdGeneratorDelete(siteId: string, artifactId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:4847
    Stop generating process
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdArtifactsArtifactIdPreviewPost: function
  - sitesSiteIdArtifactsArtifactIdPreviewPost(siteId: string, artifactId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:4858
    Enable artifact previews
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdArtifactsArtifactIdPublishJobIdDelete: function
  - sitesSiteIdArtifactsArtifactIdPublishJobIdDelete(siteId: string, artifactId: string, jobId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:4870
    Delete scheduled publish
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - jobId: string
      
      Schedule Job ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdArtifactsArtifactIdPublishJobIdPost: function
  - sitesSiteIdArtifactsArtifactIdPublishJobIdPost(siteId: string, artifactId: string, jobId: string, request: InlineObject23, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2014>>
  - - Defined in api.ts:4883
    Update publish schedule
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - jobId: string
      
      Schedule Job ID
    - request: InlineObject23
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2014>>
- sitesSiteIdArtifactsArtifactIdPublishPost: function
  - sitesSiteIdArtifactsArtifactIdPublishPost(siteId: string, artifactId: string, request?: InlineObject22, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2013>>
  - - Defined in api.ts:4895
    Set the artifact to public on the Shifter CDN. OR Set the publish date of the artifact
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - artifactId: string
      
      Artifact ID
    - Optional request: InlineObject22
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2013>>
- sitesSiteIdArtifactsArtifactIdWebhookRunnerPost: function
  - sitesSiteIdArtifactsArtifactIdWebhookRunnerPost(siteId: string, artifactId: string, request?: InlineObject25, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:4907
    execute webhook of specific artifact
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - artifactId: string
    - Optional request: InlineObject25
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdArtifactsGet: function
  - sitesSiteIdArtifactsGet(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArtifactGetResponse[]>>
  - - Defined in api.ts:4917
    List all artifacts.
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArtifactGetResponse[]>>
- sitesSiteIdArtifactsPost: function
  - sitesSiteIdArtifactsPost(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
  - - Defined in api.ts:4927
    Generate artifact.
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
- sitesSiteIdCheckGeneratorProcessGet: function
  - sitesSiteIdCheckGeneratorProcessGet(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
  - - Defined in api.ts:4937
    You can get the process of generating
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>

Const BillingApiAxiosParamCreator

BillingApiAxiosParamCreator(configuration?: Configuration): { billingPost: (request: InlineObject14, options?: any) => Promise<RequestArgs>; billingsPlansGet: (interval?: "all" | "month" | "year", options?: any) => Promise<RequestArgs>; billingsSubscriptionsGet: (options?: any) => Promise<RequestArgs>; billingsSubscriptionsPost: (plan: InlineObject12, options?: any) => Promise<RequestArgs>; billingsSubscriptionsStatusGet: (options?: any) => Promise<RequestArgs>; billingsSubscriptionsSubscriptionIdDelete: (subscriptionId: string, options?: any) => Promise<RequestArgs>; billingsSubscriptionsSubscriptionIdPost: (subscriptionId: string, plan: InlineObject13, options?: any) => Promise<RequestArgs> }

- Defined in api.ts:5305
BillingApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { billingPost: (request: InlineObject14, options?: any) => Promise<RequestArgs>; billingsPlansGet: (interval?: "all" | "month" | "year", options?: any) => Promise<RequestArgs>; billingsSubscriptionsGet: (options?: any) => Promise<RequestArgs>; billingsSubscriptionsPost: (plan: InlineObject12, options?: any) => Promise<RequestArgs>; billingsSubscriptionsStatusGet: (options?: any) => Promise<RequestArgs>; billingsSubscriptionsSubscriptionIdDelete: (subscriptionId: string, options?: any) => Promise<RequestArgs>; billingsSubscriptionsSubscriptionIdPost: (subscriptionId: string, plan: InlineObject13, options?: any) => Promise<RequestArgs> }
- billingPost: (request: InlineObject14, options?: any) => Promise<RequestArgs>
  - - (request: InlineObject14, options?: any): Promise<RequestArgs>
    - Update payment method
      
      throws
      
      {RequiredError}
      
      Parameters
      - request: InlineObject14
      - options: any = {}
      Returns Promise<RequestArgs>
- billingsPlansGet: (interval?: "all" | "month" | "year", options?: any) => Promise<RequestArgs>
  - - (interval?: "all" | "month" | "year", options?: any): Promise<RequestArgs>
    - Get available plans
      
      throws
      
      {RequiredError}
      
      Parameters
      - Optional interval: "all" | "month" | "year"
      - options: any = {}
      Returns Promise<RequestArgs>
- billingsSubscriptionsGet: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - List all subscriptions in the current shifter account
      
      throws
      
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- billingsSubscriptionsPost: (plan: InlineObject12, options?: any) => Promise<RequestArgs>
  - - (plan: InlineObject12, options?: any): Promise<RequestArgs>
    - Create a subscription.
      
      throws
      
      {RequiredError}
      
      Parameters
      - plan: InlineObject12
      - options: any = {}
      Returns Promise<RequestArgs>
- billingsSubscriptionsStatusGet: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - Getting subscription status
      
      throws
      
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- billingsSubscriptionsSubscriptionIdDelete: (subscriptionId: string, options?: any) => Promise<RequestArgs>
  - - (subscriptionId: string, options?: any): Promise<RequestArgs>
    - Delete a subscription
      
      throws
      
      {RequiredError}
      
      Parameters
      - subscriptionId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- billingsSubscriptionsSubscriptionIdPost: (subscriptionId: string, plan: InlineObject13, options?: any) => Promise<RequestArgs>
  - - (subscriptionId: string, plan: InlineObject13, options?: any): Promise<RequestArgs>
    - Update a subscription. Calling this API is allowed to site owner or Administrator members
      
      throws
      
      {RequiredError}
      
      Parameters
      - subscriptionId: string
        
        Subscription id which update
      - plan: InlineObject13
      - options: any = {}
      Returns Promise<RequestArgs>

Const BillingApiFactory

BillingApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { billingPost: any; billingsPlansGet: any; billingsSubscriptionsGet: any; billingsSubscriptionsPost: any; billingsSubscriptionsStatusGet: any; billingsSubscriptionsSubscriptionIdDelete: any; billingsSubscriptionsSubscriptionIdPost: any }

- Defined in api.ts:5648
BillingApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { billingPost: any; billingsPlansGet: any; billingsSubscriptionsGet: any; billingsSubscriptionsPost: any; billingsSubscriptionsStatusGet: any; billingsSubscriptionsSubscriptionIdDelete: any; billingsSubscriptionsSubscriptionIdPost: any }
- billingPost: function
  - billingPost(request: InlineObject14, options?: any): AxiosPromise<void>
  - - Defined in api.ts:5657
    Update payment method
    
    throws
    
    {RequiredError}
    
    Parameters
    - request: InlineObject14
    - Optional options: any
    Returns AxiosPromise<void>
- billingsPlansGet: function
  - billingsPlansGet(interval?: "all" | "month" | "year", options?: any): AxiosPromise<PlanGetResponse[]>
  - - Defined in api.ts:5666
    Get available plans
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional interval: "all" | "month" | "year"
    - Optional options: any
    Returns AxiosPromise<PlanGetResponse[]>
- billingsSubscriptionsGet: function
  - billingsSubscriptionsGet(options?: any): AxiosPromise<SubscriptionGetResponse[]>
  - - Defined in api.ts:5674
    List all subscriptions in the current shifter account
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<SubscriptionGetResponse[]>
- billingsSubscriptionsPost: function
  - billingsSubscriptionsPost(plan: InlineObject12, options?: any): AxiosPromise<SubscriptionCreateResponse>
  - - Defined in api.ts:5683
    Create a subscription.
    
    throws
    
    {RequiredError}
    
    Parameters
    - plan: InlineObject12
    - Optional options: any
    Returns AxiosPromise<SubscriptionCreateResponse>
- billingsSubscriptionsStatusGet: function
  - billingsSubscriptionsStatusGet(options?: any): AxiosPromise<object>
  - - Defined in api.ts:5691
    Getting subscription status
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<object>
- billingsSubscriptionsSubscriptionIdDelete: function
  - billingsSubscriptionsSubscriptionIdDelete(subscriptionId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:5700
    Delete a subscription
    
    throws
    
    {RequiredError}
    
    Parameters
    - subscriptionId: string
    - Optional options: any
    Returns AxiosPromise<void>
- billingsSubscriptionsSubscriptionIdPost: function
  - billingsSubscriptionsSubscriptionIdPost(subscriptionId: string, plan: InlineObject13, options?: any): AxiosPromise<SubscriptionUpdateResponse>
  - - Defined in api.ts:5710
    Update a subscription. Calling this API is allowed to site owner or Administrator members
    
    throws
    
    {RequiredError}
    
    Parameters
    - subscriptionId: string
      
      Subscription id which update
    - plan: InlineObject13
    - Optional options: any
    Returns AxiosPromise<SubscriptionUpdateResponse>

Const BillingApiFp

BillingApiFp(configuration?: Configuration): { billingPost: any; billingsPlansGet: any; billingsSubscriptionsGet: any; billingsSubscriptionsPost: any; billingsSubscriptionsStatusGet: any; billingsSubscriptionsSubscriptionIdDelete: any; billingsSubscriptionsSubscriptionIdPost: any }

- Defined in api.ts:5569
BillingApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { billingPost: any; billingsPlansGet: any; billingsSubscriptionsGet: any; billingsSubscriptionsPost: any; billingsSubscriptionsStatusGet: any; billingsSubscriptionsSubscriptionIdDelete: any; billingsSubscriptionsSubscriptionIdPost: any }
- billingPost: function
  - billingPost(request: InlineObject14, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:5578
    Update payment method
    
    throws
    
    {RequiredError}
    
    Parameters
    - request: InlineObject14
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- billingsPlansGet: function
  - billingsPlansGet(interval?: "all" | "month" | "year", options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanGetResponse[]>>
  - - Defined in api.ts:5588
    Get available plans
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional interval: "all" | "month" | "year"
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanGetResponse[]>>
- billingsSubscriptionsGet: function
  - billingsSubscriptionsGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubscriptionGetResponse[]>>
  - - Defined in api.ts:5597
    List all subscriptions in the current shifter account
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubscriptionGetResponse[]>>
- billingsSubscriptionsPost: function
  - billingsSubscriptionsPost(plan: InlineObject12, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubscriptionCreateResponse>>
  - - Defined in api.ts:5607
    Create a subscription.
    
    throws
    
    {RequiredError}
    
    Parameters
    - plan: InlineObject12
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubscriptionCreateResponse>>
- billingsSubscriptionsStatusGet: function
  - billingsSubscriptionsStatusGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
  - - Defined in api.ts:5616
    Getting subscription status
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
- billingsSubscriptionsSubscriptionIdDelete: function
  - billingsSubscriptionsSubscriptionIdDelete(subscriptionId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:5626
    Delete a subscription
    
    throws
    
    {RequiredError}
    
    Parameters
    - subscriptionId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- billingsSubscriptionsSubscriptionIdPost: function
  - billingsSubscriptionsSubscriptionIdPost(subscriptionId: string, plan: InlineObject13, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubscriptionUpdateResponse>>
  - - Defined in api.ts:5637
    Update a subscription. Calling this API is allowed to site owner or Administrator members
    
    throws
    
    {RequiredError}
    
    Parameters
    - subscriptionId: string
      
      Subscription id which update
    - plan: InlineObject13
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubscriptionUpdateResponse>>

Const CouponApiAxiosParamCreator

CouponApiAxiosParamCreator(configuration?: Configuration): { couponGet: (options?: any) => Promise<RequestArgs>; couponsCodePost: (code: string, options?: any) => Promise<RequestArgs> }

- Defined in api.ts:5805
CouponApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { couponGet: (options?: any) => Promise<RequestArgs>; couponsCodePost: (code: string, options?: any) => Promise<RequestArgs> }
- couponGet: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - Get coupon
      
      throws
      
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- couponsCodePost: (code: string, options?: any) => Promise<RequestArgs>
  - - (code: string, options?: any): Promise<RequestArgs>
    - Register coupon code.
      
      throws
      
      {RequiredError}
      
      Parameters
      - code: string
        
        Code of coupon
      - options: any = {}
      Returns Promise<RequestArgs>

Const CouponApiFactory

CouponApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { couponGet: any; couponsCodePost: any }

- Defined in api.ts:5911
CouponApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { couponGet: any; couponsCodePost: any }
- couponGet: function
  - couponGet(options?: any): AxiosPromise<CouponGetResponse>
  - - Defined in api.ts:5919
    Get coupon
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<CouponGetResponse>
- couponsCodePost: function
  - couponsCodePost(code: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:5928
    Register coupon code.
    
    throws
    
    {RequiredError}
    
    Parameters
    - code: string
      
      Code of coupon
    - Optional options: any
    Returns AxiosPromise<void>

Const CouponApiFp

CouponApiFp(configuration?: Configuration): { couponGet: any; couponsCodePost: any }

- Defined in api.ts:5882
CouponApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { couponGet: any; couponsCodePost: any }
- couponGet: function
  - couponGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CouponGetResponse>>
  - - Defined in api.ts:5890
    Get coupon
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CouponGetResponse>>
- couponsCodePost: function
  - couponsCodePost(code: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:5900
    Register coupon code.
    
    throws
    
    {RequiredError}
    
    Parameters
    - code: string
      
      Code of coupon
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const DomainsReplacedToTheSiteDomainsApiAxiosParamCreator

DomainsReplacedToTheSiteDomainsApiAxiosParamCreator(configuration?: Configuration): { domainsDomainAttachDomainToShifterCdnPost: (domain: string, request: InlineObject30, options?: any) => Promise<RequestArgs>; domainsDomainDelete: (domain: string, options?: any) => Promise<RequestArgs>; domainsDomainDetachDomainFromShifterCdnPost: (domain: string, options?: any) => Promise<RequestArgs>; domainsDomainGet: (domain: string, options?: any) => Promise<RequestArgs>; domainsDomainPost: (domain: string, request?: InlineObject28, options?: any) => Promise<RequestArgs>; domainsDomainResendValidationEmailPost: (domain: string, options?: any) => Promise<RequestArgs>; domainsDomainSelectionPost: (domain: string, request: InlineObject29, options?: any) => Promise<RequestArgs>; domainsDomainValidateOperationDnsPost: (domain: string, request?: InlineObject31, options?: any) => Promise<RequestArgs>; domainsDomainValidateOperationDnsValidationGet: (domain: string, options?: any) => Promise<RequestArgs>; domainsDomainValidateOperationDnsValidationPost: (domain: string, options?: any) => Promise<RequestArgs>; domainsDomainValidateOperationEmailPost: (domain: string, request?: InlineObject32, options?: any) => Promise<RequestArgs>; domainsGet: (filter?: string, options?: any) => Promise<RequestArgs> }

- Defined in api.ts:5968
DomainsReplacedToTheSiteDomainsApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { domainsDomainAttachDomainToShifterCdnPost: (domain: string, request: InlineObject30, options?: any) => Promise<RequestArgs>; domainsDomainDelete: (domain: string, options?: any) => Promise<RequestArgs>; domainsDomainDetachDomainFromShifterCdnPost: (domain: string, options?: any) => Promise<RequestArgs>; domainsDomainGet: (domain: string, options?: any) => Promise<RequestArgs>; domainsDomainPost: (domain: string, request?: InlineObject28, options?: any) => Promise<RequestArgs>; domainsDomainResendValidationEmailPost: (domain: string, options?: any) => Promise<RequestArgs>; domainsDomainSelectionPost: (domain: string, request: InlineObject29, options?: any) => Promise<RequestArgs>; domainsDomainValidateOperationDnsPost: (domain: string, request?: InlineObject31, options?: any) => Promise<RequestArgs>; domainsDomainValidateOperationDnsValidationGet: (domain: string, options?: any) => Promise<RequestArgs>; domainsDomainValidateOperationDnsValidationPost: (domain: string, options?: any) => Promise<RequestArgs>; domainsDomainValidateOperationEmailPost: (domain: string, request?: InlineObject32, options?: any) => Promise<RequestArgs>; domainsGet: (filter?: string, options?: any) => Promise<RequestArgs> }
- domainsDomainAttachDomainToShifterCdnPost: (domain: string, request: InlineObject30, options?: any) => Promise<RequestArgs>
  - - (domain: string, request: InlineObject30, options?: any): Promise<RequestArgs>
    - Attache your domain to Shifter CDN
      
      throws
      
      {RequiredError}
      
      Parameters
      - domain: string
      - request: InlineObject30
      - options: any = {}
      Returns Promise<RequestArgs>
- domainsDomainDelete: (domain: string, options?: any) => Promise<RequestArgs>
  - - (domain: string, options?: any): Promise<RequestArgs>
    - Delete the added domain
      
      throws
      
      {RequiredError}
      
      Parameters
      - domain: string
      - options: any = {}
      Returns Promise<RequestArgs>
- domainsDomainDetachDomainFromShifterCdnPost: (domain: string, options?: any) => Promise<RequestArgs>
  - - (domain: string, options?: any): Promise<RequestArgs>
    - Detach your domain from Shifter CDN
      
      throws
      
      {RequiredError}
      
      Parameters
      - domain: string
      - options: any = {}
      Returns Promise<RequestArgs>
- domainsDomainGet: (domain: string, options?: any) => Promise<RequestArgs>
  - - (domain: string, options?: any): Promise<RequestArgs>
    - You can get the authentication information of the domain registered by the user
      
      throws
      
      {RequiredError}
      
      Parameters
      - domain: string
      - options: any = {}
      Returns Promise<RequestArgs>
- domainsDomainPost: (domain: string, request?: InlineObject28, options?: any) => Promise<RequestArgs>
  - - (domain: string, request?: InlineObject28, options?: any): Promise<RequestArgs>
    - Add your domain
      
      throws
      
      {RequiredError}
      
      Parameters
      - domain: string
      - Optional request: InlineObject28
      - options: any = {}
      Returns Promise<RequestArgs>
- domainsDomainResendValidationEmailPost: (domain: string, options?: any) => Promise<RequestArgs>
  - - (domain: string, options?: any): Promise<RequestArgs>
    - Resend the approval mail of the SSL certificate
      
      throws
      
      {RequiredError}
      
      Parameters
      - domain: string
      - options: any = {}
      Returns Promise<RequestArgs>
- domainsDomainSelectionPost: (domain: string, request: InlineObject29, options?: any) => Promise<RequestArgs>
  - - (domain: string, request: InlineObject29, options?: any): Promise<RequestArgs>
    - Select publishing Subject Alternative Name
      
      throws
      
      {RequiredError}
      
      Parameters
      - domain: string
      - request: InlineObject29
      - options: any = {}
      Returns Promise<RequestArgs>
- domainsDomainValidateOperationDnsPost: (domain: string, request?: InlineObject31, options?: any) => Promise<RequestArgs>
  - - (domain: string, request?: InlineObject31, options?: any): Promise<RequestArgs>
    - Validating domain by CNAME
      
      throws
      
      {RequiredError}
      
      Parameters
      - domain: string
      - Optional request: InlineObject31
      - options: any = {}
      Returns Promise<RequestArgs>
- domainsDomainValidateOperationDnsValidationGet: (domain: string, options?: any) => Promise<RequestArgs>
  - - (domain: string, options?: any): Promise<RequestArgs>
    - Get validation status of specified domain
      
      throws
      
      {RequiredError}
      
      Parameters
      - domain: string
      - options: any = {}
      Returns Promise<RequestArgs>
- domainsDomainValidateOperationDnsValidationPost: (domain: string, options?: any) => Promise<RequestArgs>
  - - (domain: string, options?: any): Promise<RequestArgs>
    - Re validating domain by dns
      
      throws
      
      {RequiredError}
      
      Parameters
      - domain: string
      - options: any = {}
      Returns Promise<RequestArgs>
- domainsDomainValidateOperationEmailPost: (domain: string, request?: InlineObject32, options?: any) => Promise<RequestArgs>
  - - (domain: string, request?: InlineObject32, options?: any): Promise<RequestArgs>
    - Validating domain by email
      
      throws
      
      {RequiredError}
      
      Parameters
      - domain: string
      - Optional request: InlineObject32
      - options: any = {}
      Returns Promise<RequestArgs>
- domainsGet: (filter?: string, options?: any) => Promise<RequestArgs>
  - - (filter?: string, options?: any): Promise<RequestArgs>
    - You can get information of your domains registered in shifter
      
      throws
      
      {RequiredError}
      
      Parameters
      - Optional filter: string
      - options: any = {}
      Returns Promise<RequestArgs>

Const DomainsReplacedToTheSiteDomainsApiFactory

DomainsReplacedToTheSiteDomainsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { domainsDomainAttachDomainToShifterCdnPost: any; domainsDomainDelete: any; domainsDomainDetachDomainFromShifterCdnPost: any; domainsDomainGet: any; domainsDomainPost: any; domainsDomainResendValidationEmailPost: any; domainsDomainSelectionPost: any; domainsDomainValidateOperationDnsPost: any; domainsDomainValidateOperationDnsValidationGet: any; domainsDomainValidateOperationDnsValidationPost: any; domainsDomainValidateOperationEmailPost: any; domainsGet: any }

- Defined in api.ts:6569
DomainsReplacedToTheSiteDomainsApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { domainsDomainAttachDomainToShifterCdnPost: any; domainsDomainDelete: any; domainsDomainDetachDomainFromShifterCdnPost: any; domainsDomainGet: any; domainsDomainPost: any; domainsDomainResendValidationEmailPost: any; domainsDomainSelectionPost: any; domainsDomainValidateOperationDnsPost: any; domainsDomainValidateOperationDnsValidationGet: any; domainsDomainValidateOperationDnsValidationPost: any; domainsDomainValidateOperationEmailPost: any; domainsGet: any }
- domainsDomainAttachDomainToShifterCdnPost: function
  - domainsDomainAttachDomainToShifterCdnPost(domain: string, request: InlineObject30, options?: any): AxiosPromise<void>
  - - Defined in api.ts:6579
    Attache your domain to Shifter CDN
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - request: InlineObject30
    - Optional options: any
    Returns AxiosPromise<void>
- domainsDomainDelete: function
  - domainsDomainDelete(domain: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:6588
    Delete the added domain
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional options: any
    Returns AxiosPromise<void>
- domainsDomainDetachDomainFromShifterCdnPost: function
  - domainsDomainDetachDomainFromShifterCdnPost(domain: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:6597
    Detach your domain from Shifter CDN
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional options: any
    Returns AxiosPromise<void>
- domainsDomainGet: function
  - domainsDomainGet(domain: string, options?: any): AxiosPromise<object>
  - - Defined in api.ts:6606
    You can get the authentication information of the domain registered by the user
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional options: any
    Returns AxiosPromise<object>
- domainsDomainPost: function
  - domainsDomainPost(domain: string, request?: InlineObject28, options?: any): AxiosPromise<void>
  - - Defined in api.ts:6616
    Add your domain
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional request: InlineObject28
    - Optional options: any
    Returns AxiosPromise<void>
- domainsDomainResendValidationEmailPost: function
  - domainsDomainResendValidationEmailPost(domain: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:6625
    Resend the approval mail of the SSL certificate
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional options: any
    Returns AxiosPromise<void>
- domainsDomainSelectionPost: function
  - domainsDomainSelectionPost(domain: string, request: InlineObject29, options?: any): AxiosPromise<void>
  - - Defined in api.ts:6635
    Select publishing Subject Alternative Name
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - request: InlineObject29
    - Optional options: any
    Returns AxiosPromise<void>
- domainsDomainValidateOperationDnsPost: function
  - domainsDomainValidateOperationDnsPost(domain: string, request?: InlineObject31, options?: any): AxiosPromise<void>
  - - Defined in api.ts:6645
    Validating domain by CNAME
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional request: InlineObject31
    - Optional options: any
    Returns AxiosPromise<void>
- domainsDomainValidateOperationDnsValidationGet: function
  - domainsDomainValidateOperationDnsValidationGet(domain: string, options?: any): AxiosPromise<object>
  - - Defined in api.ts:6654
    Get validation status of specified domain
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional options: any
    Returns AxiosPromise<object>
- domainsDomainValidateOperationDnsValidationPost: function
  - domainsDomainValidateOperationDnsValidationPost(domain: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:6663
    Re validating domain by dns
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional options: any
    Returns AxiosPromise<void>
- domainsDomainValidateOperationEmailPost: function
  - domainsDomainValidateOperationEmailPost(domain: string, request?: InlineObject32, options?: any): AxiosPromise<void>
  - - Defined in api.ts:6673
    Validating domain by email
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional request: InlineObject32
    - Optional options: any
    Returns AxiosPromise<void>
- domainsGet: function
  - domainsGet(filter?: string, options?: any): AxiosPromise<InlineResponse20013[]>
  - - Defined in api.ts:6682
    You can get information of your domains registered in shifter
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional filter: string
    - Optional options: any
    Returns AxiosPromise<InlineResponse20013[]>

Const DomainsReplacedToTheSiteDomainsApiFp

DomainsReplacedToTheSiteDomainsApiFp(configuration?: Configuration): { domainsDomainAttachDomainToShifterCdnPost: any; domainsDomainDelete: any; domainsDomainDetachDomainFromShifterCdnPost: any; domainsDomainGet: any; domainsDomainPost: any; domainsDomainResendValidationEmailPost: any; domainsDomainSelectionPost: any; domainsDomainValidateOperationDnsPost: any; domainsDomainValidateOperationDnsValidationGet: any; domainsDomainValidateOperationDnsValidationPost: any; domainsDomainValidateOperationEmailPost: any; domainsGet: any }

- Defined in api.ts:6434
DomainsReplacedToTheSiteDomainsApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { domainsDomainAttachDomainToShifterCdnPost: any; domainsDomainDelete: any; domainsDomainDetachDomainFromShifterCdnPost: any; domainsDomainGet: any; domainsDomainPost: any; domainsDomainResendValidationEmailPost: any; domainsDomainSelectionPost: any; domainsDomainValidateOperationDnsPost: any; domainsDomainValidateOperationDnsValidationGet: any; domainsDomainValidateOperationDnsValidationPost: any; domainsDomainValidateOperationEmailPost: any; domainsGet: any }
- domainsDomainAttachDomainToShifterCdnPost: function
  - domainsDomainAttachDomainToShifterCdnPost(domain: string, request: InlineObject30, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:6444
    Attache your domain to Shifter CDN
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - request: InlineObject30
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- domainsDomainDelete: function
  - domainsDomainDelete(domain: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:6454
    Delete the added domain
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- domainsDomainDetachDomainFromShifterCdnPost: function
  - domainsDomainDetachDomainFromShifterCdnPost(domain: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:6464
    Detach your domain from Shifter CDN
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- domainsDomainGet: function
  - domainsDomainGet(domain: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
  - - Defined in api.ts:6474
    You can get the authentication information of the domain registered by the user
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
- domainsDomainPost: function
  - domainsDomainPost(domain: string, request?: InlineObject28, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:6485
    Add your domain
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional request: InlineObject28
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- domainsDomainResendValidationEmailPost: function
  - domainsDomainResendValidationEmailPost(domain: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:6495
    Resend the approval mail of the SSL certificate
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- domainsDomainSelectionPost: function
  - domainsDomainSelectionPost(domain: string, request: InlineObject29, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:6506
    Select publishing Subject Alternative Name
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - request: InlineObject29
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- domainsDomainValidateOperationDnsPost: function
  - domainsDomainValidateOperationDnsPost(domain: string, request?: InlineObject31, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:6517
    Validating domain by CNAME
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional request: InlineObject31
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- domainsDomainValidateOperationDnsValidationGet: function
  - domainsDomainValidateOperationDnsValidationGet(domain: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
  - - Defined in api.ts:6527
    Get validation status of specified domain
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
- domainsDomainValidateOperationDnsValidationPost: function
  - domainsDomainValidateOperationDnsValidationPost(domain: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:6537
    Re validating domain by dns
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- domainsDomainValidateOperationEmailPost: function
  - domainsDomainValidateOperationEmailPost(domain: string, request?: InlineObject32, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:6548
    Validating domain by email
    
    throws
    
    {RequiredError}
    
    Parameters
    - domain: string
    - Optional request: InlineObject32
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- domainsGet: function
  - domainsGet(filter?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse20013[]>>
  - - Defined in api.ts:6558
    You can get information of your domains registered in shifter
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional filter: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse20013[]>>

Const IntercomApiAxiosParamCreator

IntercomApiAxiosParamCreator(configuration?: Configuration): { intercomHmacGet: (options?: any) => Promise<RequestArgs> }

- Defined in api.ts:6838
IntercomApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { intercomHmacGet: (options?: any) => Promise<RequestArgs> }
- intercomHmacGet: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - Get intercom hmac
      
      throws
      
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>

Const IntercomApiFactory

IntercomApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { intercomHmacGet: any }

- Defined in api.ts:6898
IntercomApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { intercomHmacGet: any }
- intercomHmacGet: function
  - intercomHmacGet(options?: any): AxiosPromise<string>
  - - Defined in api.ts:6906
    Get intercom hmac
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<string>

Const IntercomApiFp

IntercomApiFp(configuration?: Configuration): { intercomHmacGet: any }

- Defined in api.ts:6879
IntercomApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { intercomHmacGet: any }
- intercomHmacGet: function
  - intercomHmacGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
  - - Defined in api.ts:6887
    Get intercom hmac
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>

Const LoginApiAxiosParamCreator

LoginApiAxiosParamCreator(configuration?: Configuration): { loginPost: (request: LoginPostRequest, options?: any) => Promise<RequestArgs>; loginPut: (request: InlineObject, options?: any) => Promise<RequestArgs> }

- Defined in api.ts:6935
LoginApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { loginPost: (request: LoginPostRequest, options?: any) => Promise<RequestArgs>; loginPut: (request: InlineObject, options?: any) => Promise<RequestArgs> }
- loginPost: (request: LoginPostRequest, options?: any) => Promise<RequestArgs>
  - - (request: LoginPostRequest, options?: any): Promise<RequestArgs>
    - Login to the Shifter. username and password are required. Return AccessToken and RefreshToken when the request succeeded.
      
      throws
      
      {RequiredError}
      
      Parameters
      - request: LoginPostRequest
      - options: any = {}
      Returns Promise<RequestArgs>
- loginPut: (request: InlineObject, options?: any) => Promise<RequestArgs>
  - - (request: InlineObject, options?: any): Promise<RequestArgs>
    - Refresh AccessToken by RefreshToken. Return new AccessToken when request succeeded.
      
      throws
      
      {RequiredError}
      
      Parameters
      - request: InlineObject
      - options: any = {}
      Returns Promise<RequestArgs>

Const LoginApiFactory

LoginApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { loginPost: any; loginPut: any }

- Defined in api.ts:7050
LoginApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { loginPost: any; loginPut: any }
- loginPost: function
  - loginPost(request: LoginPostRequest, options?: any): AxiosPromise<LoginPostResponse>
  - - Defined in api.ts:7059
    Login to the Shifter. username and password are required. Return AccessToken and RefreshToken when the request succeeded.
    
    throws
    
    {RequiredError}
    
    Parameters
    - request: LoginPostRequest
    - Optional options: any
    Returns AxiosPromise<LoginPostResponse>
- loginPut: function
  - loginPut(request: InlineObject, options?: any): AxiosPromise<object>
  - - Defined in api.ts:7068
    Refresh AccessToken by RefreshToken. Return new AccessToken when request succeeded.
    
    throws
    
    {RequiredError}
    
    Parameters
    - request: InlineObject
    - Optional options: any
    Returns AxiosPromise<object>

Const LoginApiFp

LoginApiFp(configuration?: Configuration): { loginPost: any; loginPut: any }

- Defined in api.ts:7020
LoginApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { loginPost: any; loginPut: any }
- loginPost: function
  - loginPost(request: LoginPostRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginPostResponse>>
  - - Defined in api.ts:7029
    Login to the Shifter. username and password are required. Return AccessToken and RefreshToken when the request succeeded.
    
    throws
    
    {RequiredError}
    
    Parameters
    - request: LoginPostRequest
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginPostResponse>>
- loginPut: function
  - loginPut(request: InlineObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
  - - Defined in api.ts:7039
    Refresh AccessToken by RefreshToken. Return new AccessToken when request succeeded.
    
    throws
    
    {RequiredError}
    
    Parameters
    - request: InlineObject
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>

Const PlansApiAxiosParamCreator

PlansApiAxiosParamCreator(configuration?: Configuration): { plansGet: (options?: any) => Promise<RequestArgs>; plansPlanNamePlanTypeGet: (planName: "free" | "personal" | "business" | "agency" | "agency plus", planType: "annual" | "monthly", options?: any) => Promise<RequestArgs> }

- Defined in api.ts:7109
PlansApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { plansGet: (options?: any) => Promise<RequestArgs>; plansPlanNamePlanTypeGet: (planName: "free" | "personal" | "business" | "agency" | "agency plus", planType: "annual" | "monthly", options?: any) => Promise<RequestArgs> }
- plansGet: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - (Previous Plan) Get all plans. An invited user cannot be accessed this API.
      
      throws
      
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- plansPlanNamePlanTypeGet: (planName: "free" | "personal" | "business" | "agency" | "agency plus", planType: "annual" | "monthly", options?: any) => Promise<RequestArgs>
  - - (planName: "free" | "personal" | "business" | "agency" | "agency plus", planType: "annual" | "monthly", options?: any): Promise<RequestArgs>
    - (Previous plan) Get details of plan.
      
      throws
      
      {RequiredError}
      
      Parameters
      - planName: "free" | "personal" | "business" | "agency" | "agency plus"
        
        Name of play. Specify free or personal or business or agency or agency plus
      - planType: "annual" | "monthly"
        
        Team of plan. Specify annual or monthly
      - options: any = {}
      Returns Promise<RequestArgs>

Const PlansApiFactory

PlansApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { plansGet: any; plansPlanNamePlanTypeGet: any }

- Defined in api.ts:7220
PlansApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { plansGet: any; plansPlanNamePlanTypeGet: any }
- plansGet: function
  - plansGet(options?: any): AxiosPromise<object>
  - - Defined in api.ts:7228
    (Previous Plan) Get all plans. An invited user cannot be accessed this API.
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<object>
- plansPlanNamePlanTypeGet: function
  - plansPlanNamePlanTypeGet(planName: "free" | "personal" | "business" | "agency" | "agency plus", planType: "annual" | "monthly", options?: any): AxiosPromise<PreviousPlanResponse>
  - - Defined in api.ts:7238
    (Previous plan) Get details of plan.
    
    throws
    
    {RequiredError}
    
    Parameters
    - planName: "free" | "personal" | "business" | "agency" | "agency plus"
      
      Name of play. Specify free or personal or business or agency or agency plus
    - planType: "annual" | "monthly"
      
      Team of plan. Specify annual or monthly
    - Optional options: any
    Returns AxiosPromise<PreviousPlanResponse>

Const PlansApiFp

PlansApiFp(configuration?: Configuration): { plansGet: any; plansPlanNamePlanTypeGet: any }

- Defined in api.ts:7190
PlansApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { plansGet: any; plansPlanNamePlanTypeGet: any }
- plansGet: function
  - plansGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
  - - Defined in api.ts:7198
    (Previous Plan) Get all plans. An invited user cannot be accessed this API.
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
- plansPlanNamePlanTypeGet: function
  - plansPlanNamePlanTypeGet(planName: "free" | "personal" | "business" | "agency" | "agency plus", planType: "annual" | "monthly", options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreviousPlanResponse>>
  - - Defined in api.ts:7209
    (Previous plan) Get details of plan.
    
    throws
    
    {RequiredError}
    
    Parameters
    - planName: "free" | "personal" | "business" | "agency" | "agency plus"
      
      Name of play. Specify free or personal or business or agency or agency plus
    - planType: "annual" | "monthly"
      
      Team of plan. Specify annual or monthly
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreviousPlanResponse>>

Const RolesApiAxiosParamCreator

RolesApiAxiosParamCreator(configuration?: Configuration): { rolesGet: (options?: any) => Promise<RequestArgs>; rolesNameGet: (name: string, options?: any) => Promise<RequestArgs> }

- Defined in api.ts:7279
RolesApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { rolesGet: (options?: any) => Promise<RequestArgs>; rolesNameGet: (name: string, options?: any) => Promise<RequestArgs> }
- rolesGet: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - List team member roles
      
      throws
      
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- rolesNameGet: (name: string, options?: any) => Promise<RequestArgs>
  - - (name: string, options?: any): Promise<RequestArgs>
    - Get a shifter roles
      
      throws
      
      {RequiredError}
      
      Parameters
      - name: string
        
        Name of role
      - options: any = {}
      Returns Promise<RequestArgs>

Const RolesApiFactory

RolesApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { rolesGet: any; rolesNameGet: any }

- Defined in api.ts:7385
RolesApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { rolesGet: any; rolesNameGet: any }
- rolesGet: function
  - rolesGet(options?: any): AxiosPromise<RoleGetResponse[]>
  - - Defined in api.ts:7393
    List team member roles
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<RoleGetResponse[]>
- rolesNameGet: function
  - rolesNameGet(name: string, options?: any): AxiosPromise<RoleGetResponse>
  - - Defined in api.ts:7402
    Get a shifter roles
    
    throws
    
    {RequiredError}
    
    Parameters
    - name: string
      
      Name of role
    - Optional options: any
    Returns AxiosPromise<RoleGetResponse>

Const RolesApiFp

RolesApiFp(configuration?: Configuration): { rolesGet: any; rolesNameGet: any }

- Defined in api.ts:7356
RolesApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { rolesGet: any; rolesNameGet: any }
- rolesGet: function
  - rolesGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoleGetResponse[]>>
  - - Defined in api.ts:7364
    List team member roles
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoleGetResponse[]>>
- rolesNameGet: function
  - rolesNameGet(name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoleGetResponse>>
  - - Defined in api.ts:7374
    Get a shifter roles
    
    throws
    
    {RequiredError}
    
    Parameters
    - name: string
      
      Name of role
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoleGetResponse>>

Const SiteDomainsApiAxiosParamCreator

SiteDomainsApiAxiosParamCreator(configuration?: Configuration): { sitesSiteIdDomainsDomainAttachPost: (siteId: string, domain: string, request?: InlineObject9, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainDelete: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainDetachPost: (siteId: string, domain: string, request?: InlineObject10, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainGet: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainPost: (siteId: string, domain: string, request?: InlineObject8, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainSelectionDelete: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainSelectionPost: (siteId: string, domain: string, request?: InlineObject11, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainValidationGet: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainValidationPost: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsGet: (siteId: string, request?: InlineObject7, options?: any) => Promise<RequestArgs> }

- Defined in api.ts:7442
SiteDomainsApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { sitesSiteIdDomainsDomainAttachPost: (siteId: string, domain: string, request?: InlineObject9, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainDelete: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainDetachPost: (siteId: string, domain: string, request?: InlineObject10, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainGet: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainPost: (siteId: string, domain: string, request?: InlineObject8, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainSelectionDelete: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainSelectionPost: (siteId: string, domain: string, request?: InlineObject11, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainValidationGet: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsDomainValidationPost: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>; sitesSiteIdDomainsGet: (siteId: string, request?: InlineObject7, options?: any) => Promise<RequestArgs> }
- sitesSiteIdDomainsDomainAttachPost: (siteId: string, domain: string, request?: InlineObject9, options?: any) => Promise<RequestArgs>
  - - (siteId: string, domain: string, request?: InlineObject9, options?: any): Promise<RequestArgs>
    - attach domain to the Shifter Site
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - domain: string
        
        Name of domain which is attached
      - Optional request: InlineObject9
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdDomainsDomainDelete: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, domain: string, options?: any): Promise<RequestArgs>
    - Remove domain
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - domain: string
        
        Name of domain
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdDomainsDomainDetachPost: (siteId: string, domain: string, request?: InlineObject10, options?: any) => Promise<RequestArgs>
  - - (siteId: string, domain: string, request?: InlineObject10, options?: any): Promise<RequestArgs>
    - detach the domain from Shifter Site.
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - domain: string
        
        Name of domain
      - Optional request: InlineObject10
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdDomainsDomainGet: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, domain: string, options?: any): Promise<RequestArgs>
    - Get a domain under specific site
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - domain: string
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdDomainsDomainPost: (siteId: string, domain: string, request?: InlineObject8, options?: any) => Promise<RequestArgs>
  - - (siteId: string, domain: string, request?: InlineObject8, options?: any): Promise<RequestArgs>
    - add domain of Site
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - domain: string
        
        Name of domain
      - Optional request: InlineObject8
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdDomainsDomainSelectionDelete: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, domain: string, options?: any): Promise<RequestArgs>
    - reset deployment domain
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
      - domain: string
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdDomainsDomainSelectionPost: (siteId: string, domain: string, request?: InlineObject11, options?: any) => Promise<RequestArgs>
  - - (siteId: string, domain: string, request?: InlineObject11, options?: any): Promise<RequestArgs>
    - choose deployment domain
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
      - domain: string
      - Optional request: InlineObject11
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdDomainsDomainValidationGet: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, domain: string, options?: any): Promise<RequestArgs>
    - Get validation status of domain
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - domain: string
        
        Name of domain
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdDomainsDomainValidationPost: (siteId: string, domain: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, domain: string, options?: any): Promise<RequestArgs>
    - request(again) domain validation
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - domain: string
        
        Name of domain
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdDomainsGet: (siteId: string, request?: InlineObject7, options?: any) => Promise<RequestArgs>
  - - (siteId: string, request?: InlineObject7, options?: any): Promise<RequestArgs>
    - list domains
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - Optional request: InlineObject7
      - options: any = {}
      Returns Promise<RequestArgs>

Const SiteDomainsApiFactory

SiteDomainsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { sitesSiteIdDomainsDomainAttachPost: any; sitesSiteIdDomainsDomainDelete: any; sitesSiteIdDomainsDomainDetachPost: any; sitesSiteIdDomainsDomainGet: any; sitesSiteIdDomainsDomainPost: any; sitesSiteIdDomainsDomainSelectionDelete: any; sitesSiteIdDomainsDomainSelectionPost: any; sitesSiteIdDomainsDomainValidationGet: any; sitesSiteIdDomainsDomainValidationPost: any; sitesSiteIdDomainsGet: any }

- Defined in api.ts:7991
SiteDomainsApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { sitesSiteIdDomainsDomainAttachPost: any; sitesSiteIdDomainsDomainDelete: any; sitesSiteIdDomainsDomainDetachPost: any; sitesSiteIdDomainsDomainGet: any; sitesSiteIdDomainsDomainPost: any; sitesSiteIdDomainsDomainSelectionDelete: any; sitesSiteIdDomainsDomainSelectionPost: any; sitesSiteIdDomainsDomainValidationGet: any; sitesSiteIdDomainsDomainValidationPost: any; sitesSiteIdDomainsGet: any }
- sitesSiteIdDomainsDomainAttachPost: function
  - sitesSiteIdDomainsDomainAttachPost(siteId: string, domain: string, request?: InlineObject9, options?: any): AxiosPromise<void>
  - - Defined in api.ts:8002
    attach domain to the Shifter Site
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - domain: string
      
      Name of domain which is attached
    - Optional request: InlineObject9
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdDomainsDomainDelete: function
  - sitesSiteIdDomainsDomainDelete(siteId: string, domain: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:8012
    Remove domain
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - domain: string
      
      Name of domain
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdDomainsDomainDetachPost: function
  - sitesSiteIdDomainsDomainDetachPost(siteId: string, domain: string, request?: InlineObject10, options?: any): AxiosPromise<void>
  - - Defined in api.ts:8023
    detach the domain from Shifter Site.
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - domain: string
      
      Name of domain
    - Optional request: InlineObject10
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdDomainsDomainGet: function
  - sitesSiteIdDomainsDomainGet(siteId: string, domain: string, options?: any): AxiosPromise<DomainGetResponse>
  - - Defined in api.ts:8033
    Get a domain under specific site
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - domain: string
    - Optional options: any
    Returns AxiosPromise<DomainGetResponse>
- sitesSiteIdDomainsDomainPost: function
  - sitesSiteIdDomainsDomainPost(siteId: string, domain: string, request?: InlineObject8, options?: any): AxiosPromise<void>
  - - Defined in api.ts:8044
    add domain of Site
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - domain: string
      
      Name of domain
    - Optional request: InlineObject8
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdDomainsDomainSelectionDelete: function
  - sitesSiteIdDomainsDomainSelectionDelete(siteId: string, domain: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:8054
    reset deployment domain
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - domain: string
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdDomainsDomainSelectionPost: function
  - sitesSiteIdDomainsDomainSelectionPost(siteId: string, domain: string, request?: InlineObject11, options?: any): AxiosPromise<void>
  - - Defined in api.ts:8065
    choose deployment domain
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - domain: string
    - Optional request: InlineObject11
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdDomainsDomainValidationGet: function
  - sitesSiteIdDomainsDomainValidationGet(siteId: string, domain: string, options?: any): AxiosPromise<DomainValidationGetResponse>
  - - Defined in api.ts:8075
    Get validation status of domain
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - domain: string
      
      Name of domain
    - Optional options: any
    Returns AxiosPromise<DomainValidationGetResponse>
- sitesSiteIdDomainsDomainValidationPost: function
  - sitesSiteIdDomainsDomainValidationPost(siteId: string, domain: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:8085
    request(again) domain validation
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - domain: string
      
      Name of domain
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdDomainsGet: function
  - sitesSiteIdDomainsGet(siteId: string, request?: InlineObject7, options?: any): AxiosPromise<DomainGetResponse[]>
  - - Defined in api.ts:8095
    list domains
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional request: InlineObject7
    - Optional options: any
    Returns AxiosPromise<DomainGetResponse[]>

Const SiteDomainsApiFp

SiteDomainsApiFp(configuration?: Configuration): { sitesSiteIdDomainsDomainAttachPost: any; sitesSiteIdDomainsDomainDelete: any; sitesSiteIdDomainsDomainDetachPost: any; sitesSiteIdDomainsDomainGet: any; sitesSiteIdDomainsDomainPost: any; sitesSiteIdDomainsDomainSelectionDelete: any; sitesSiteIdDomainsDomainSelectionPost: any; sitesSiteIdDomainsDomainValidationGet: any; sitesSiteIdDomainsDomainValidationPost: any; sitesSiteIdDomainsGet: any }

- Defined in api.ts:7867
SiteDomainsApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { sitesSiteIdDomainsDomainAttachPost: any; sitesSiteIdDomainsDomainDelete: any; sitesSiteIdDomainsDomainDetachPost: any; sitesSiteIdDomainsDomainGet: any; sitesSiteIdDomainsDomainPost: any; sitesSiteIdDomainsDomainSelectionDelete: any; sitesSiteIdDomainsDomainSelectionPost: any; sitesSiteIdDomainsDomainValidationGet: any; sitesSiteIdDomainsDomainValidationPost: any; sitesSiteIdDomainsGet: any }
- sitesSiteIdDomainsDomainAttachPost: function
  - sitesSiteIdDomainsDomainAttachPost(siteId: string, domain: string, request?: InlineObject9, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:7878
    attach domain to the Shifter Site
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - domain: string
      
      Name of domain which is attached
    - Optional request: InlineObject9
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdDomainsDomainDelete: function
  - sitesSiteIdDomainsDomainDelete(siteId: string, domain: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:7889
    Remove domain
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - domain: string
      
      Name of domain
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdDomainsDomainDetachPost: function
  - sitesSiteIdDomainsDomainDetachPost(siteId: string, domain: string, request?: InlineObject10, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:7901
    detach the domain from Shifter Site.
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - domain: string
      
      Name of domain
    - Optional request: InlineObject10
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdDomainsDomainGet: function
  - sitesSiteIdDomainsDomainGet(siteId: string, domain: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainGetResponse>>
  - - Defined in api.ts:7912
    Get a domain under specific site
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - domain: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainGetResponse>>
- sitesSiteIdDomainsDomainPost: function
  - sitesSiteIdDomainsDomainPost(siteId: string, domain: string, request?: InlineObject8, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:7924
    add domain of Site
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - domain: string
      
      Name of domain
    - Optional request: InlineObject8
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdDomainsDomainSelectionDelete: function
  - sitesSiteIdDomainsDomainSelectionDelete(siteId: string, domain: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:7935
    reset deployment domain
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - domain: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdDomainsDomainSelectionPost: function
  - sitesSiteIdDomainsDomainSelectionPost(siteId: string, domain: string, request?: InlineObject11, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:7947
    choose deployment domain
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - domain: string
    - Optional request: InlineObject11
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdDomainsDomainValidationGet: function
  - sitesSiteIdDomainsDomainValidationGet(siteId: string, domain: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainValidationGetResponse>>
  - - Defined in api.ts:7958
    Get validation status of domain
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - domain: string
      
      Name of domain
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainValidationGetResponse>>
- sitesSiteIdDomainsDomainValidationPost: function
  - sitesSiteIdDomainsDomainValidationPost(siteId: string, domain: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:7969
    request(again) domain validation
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - domain: string
      
      Name of domain
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdDomainsGet: function
  - sitesSiteIdDomainsGet(siteId: string, request?: InlineObject7, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainGetResponse[]>>
  - - Defined in api.ts:7980
    list domains
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional request: InlineObject7
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainGetResponse[]>>

Const SiteSettingsApiAxiosParamCreator

SiteSettingsApiAxiosParamCreator(configuration?: Configuration): { sitesSiteIdBackupDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdBackupPost: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdBasicAuthDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdBasicAuthPost: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdCdnStatusGet: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdLogsPathDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdLogsPathPut: (siteId: string, s3BucketName: InlineObject6, options?: any) => Promise<RequestArgs>; sitesSiteIdMediaCdnDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdMediaCdnPost: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdProtectionDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdProtectionPost: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdPut: (siteId: string, request: InlineObject2, options?: any) => Promise<RequestArgs>; sitesSiteIdSiteNamePut: (siteId: string, request: InlineObject3, options?: any) => Promise<RequestArgs>; sitesSiteIdSiteSubdirDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdSiteSubdirPut: (siteId: string, dirName: InlineObject5, options?: any) => Promise<RequestArgs> }

- Defined in api.ts:8238
SiteSettingsApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { sitesSiteIdBackupDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdBackupPost: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdBasicAuthDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdBasicAuthPost: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdCdnStatusGet: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdLogsPathDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdLogsPathPut: (siteId: string, s3BucketName: InlineObject6, options?: any) => Promise<RequestArgs>; sitesSiteIdMediaCdnDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdMediaCdnPost: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdProtectionDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdProtectionPost: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdPut: (siteId: string, request: InlineObject2, options?: any) => Promise<RequestArgs>; sitesSiteIdSiteNamePut: (siteId: string, request: InlineObject3, options?: any) => Promise<RequestArgs>; sitesSiteIdSiteSubdirDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdSiteSubdirPut: (siteId: string, dirName: InlineObject5, options?: any) => Promise<RequestArgs> }
- sitesSiteIdBackupDelete: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Disabling WordPress backups
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdBackupPost: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Enabling WordPress backups
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdBasicAuthDelete: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Disabling basic authentication
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdBasicAuthPost: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Enabling basic authentication
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdCdnStatusGet: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Get the Shifter CDN status
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdLogsPathDelete: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - delete destination of access logs
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdLogsPathPut: (siteId: string, s3BucketName: InlineObject6, options?: any) => Promise<RequestArgs>
  - - (siteId: string, s3BucketName: InlineObject6, options?: any): Promise<RequestArgs>
    - set or update destination of access logs
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - s3BucketName: InlineObject6
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdMediaCdnDelete: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Disabling media CDN
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdMediaCdnPost: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Enabling media CDN
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdProtectionDelete: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - remove protection of delete
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdProtectionPost: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - add protection of delete
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdPut: (siteId: string, request: InlineObject2, options?: any) => Promise<RequestArgs>
  - - (siteId: string, request: InlineObject2, options?: any): Promise<RequestArgs>
    - update site settings. Updatable attributes are site_name, All in one WP migration configuration, Shifter media cdn configuration, and automatic publish configuration.
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - request: InlineObject2
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdSiteNamePut: (siteId: string, request: InlineObject3, options?: any) => Promise<RequestArgs>
  - - (siteId: string, request: InlineObject3, options?: any): Promise<RequestArgs>
    - Update your site name
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - request: InlineObject3
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdSiteSubdirDelete: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Remove subdirectory name for publishing
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdSiteSubdirPut: (siteId: string, dirName: InlineObject5, options?: any) => Promise<RequestArgs>
  - - (siteId: string, dirName: InlineObject5, options?: any): Promise<RequestArgs>
    - Set subdirectory name for publishing
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - dirName: InlineObject5
      - options: any = {}
      Returns Promise<RequestArgs>

Const SiteSettingsApiFactory

SiteSettingsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { sitesSiteIdBackupDelete: any; sitesSiteIdBackupPost: any; sitesSiteIdBasicAuthDelete: any; sitesSiteIdBasicAuthPost: any; sitesSiteIdCdnStatusGet: any; sitesSiteIdLogsPathDelete: any; sitesSiteIdLogsPathPut: any; sitesSiteIdMediaCdnDelete: any; sitesSiteIdMediaCdnPost: any; sitesSiteIdProtectionDelete: any; sitesSiteIdProtectionPost: any; sitesSiteIdPut: any; sitesSiteIdSiteNamePut: any; sitesSiteIdSiteSubdirDelete: any; sitesSiteIdSiteSubdirPut: any }

- Defined in api.ts:8975
SiteSettingsApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { sitesSiteIdBackupDelete: any; sitesSiteIdBackupPost: any; sitesSiteIdBasicAuthDelete: any; sitesSiteIdBasicAuthPost: any; sitesSiteIdCdnStatusGet: any; sitesSiteIdLogsPathDelete: any; sitesSiteIdLogsPathPut: any; sitesSiteIdMediaCdnDelete: any; sitesSiteIdMediaCdnPost: any; sitesSiteIdProtectionDelete: any; sitesSiteIdProtectionPost: any; sitesSiteIdPut: any; sitesSiteIdSiteNamePut: any; sitesSiteIdSiteSubdirDelete: any; sitesSiteIdSiteSubdirPut: any }
- sitesSiteIdBackupDelete: function
  - sitesSiteIdBackupDelete(siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:8984
    Disabling WordPress backups
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdBackupPost: function
  - sitesSiteIdBackupPost(siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:8993
    Enabling WordPress backups
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdBasicAuthDelete: function
  - sitesSiteIdBasicAuthDelete(siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:9002
    Disabling basic authentication
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdBasicAuthPost: function
  - sitesSiteIdBasicAuthPost(siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:9011
    Enabling basic authentication
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdCdnStatusGet: function
  - sitesSiteIdCdnStatusGet(siteId: string, options?: any): AxiosPromise<CdnStatusGetResponse>
  - - Defined in api.ts:9020
    Get the Shifter CDN status
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<CdnStatusGetResponse>
- sitesSiteIdLogsPathDelete: function
  - sitesSiteIdLogsPathDelete(siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:9029
    delete destination of access logs
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdLogsPathPut: function
  - sitesSiteIdLogsPathPut(siteId: string, s3BucketName: InlineObject6, options?: any): AxiosPromise<void>
  - - Defined in api.ts:9039
    set or update destination of access logs
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - s3BucketName: InlineObject6
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdMediaCdnDelete: function
  - sitesSiteIdMediaCdnDelete(siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:9048
    Disabling media CDN
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdMediaCdnPost: function
  - sitesSiteIdMediaCdnPost(siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:9057
    Enabling media CDN
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdProtectionDelete: function
  - sitesSiteIdProtectionDelete(siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:9066
    remove protection of delete
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdProtectionPost: function
  - sitesSiteIdProtectionPost(siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:9075
    add protection of delete
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdPut: function
  - sitesSiteIdPut(siteId: string, request: InlineObject2, options?: any): AxiosPromise<void>
  - - Defined in api.ts:9085
    update site settings. Updatable attributes are site_name, All in one WP migration configuration, Shifter media cdn configuration, and automatic publish configuration.
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - request: InlineObject2
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdSiteNamePut: function
  - sitesSiteIdSiteNamePut(siteId: string, request: InlineObject3, options?: any): AxiosPromise<void>
  - - Defined in api.ts:9095
    Update your site name
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - request: InlineObject3
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdSiteSubdirDelete: function
  - sitesSiteIdSiteSubdirDelete(siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:9104
    Remove subdirectory name for publishing
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdSiteSubdirPut: function
  - sitesSiteIdSiteSubdirPut(siteId: string, dirName: InlineObject5, options?: any): AxiosPromise<void>
  - - Defined in api.ts:9114
    Set subdirectory name for publishing
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - dirName: InlineObject5
    - Optional options: any
    Returns AxiosPromise<void>

Const SiteSettingsApiFp

SiteSettingsApiFp(configuration?: Configuration): { sitesSiteIdBackupDelete: any; sitesSiteIdBackupPost: any; sitesSiteIdBasicAuthDelete: any; sitesSiteIdBasicAuthPost: any; sitesSiteIdCdnStatusGet: any; sitesSiteIdLogsPathDelete: any; sitesSiteIdLogsPathPut: any; sitesSiteIdMediaCdnDelete: any; sitesSiteIdMediaCdnPost: any; sitesSiteIdProtectionDelete: any; sitesSiteIdProtectionPost: any; sitesSiteIdPut: any; sitesSiteIdSiteNamePut: any; sitesSiteIdSiteSubdirDelete: any; sitesSiteIdSiteSubdirPut: any }

- Defined in api.ts:8811
SiteSettingsApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { sitesSiteIdBackupDelete: any; sitesSiteIdBackupPost: any; sitesSiteIdBasicAuthDelete: any; sitesSiteIdBasicAuthPost: any; sitesSiteIdCdnStatusGet: any; sitesSiteIdLogsPathDelete: any; sitesSiteIdLogsPathPut: any; sitesSiteIdMediaCdnDelete: any; sitesSiteIdMediaCdnPost: any; sitesSiteIdProtectionDelete: any; sitesSiteIdProtectionPost: any; sitesSiteIdPut: any; sitesSiteIdSiteNamePut: any; sitesSiteIdSiteSubdirDelete: any; sitesSiteIdSiteSubdirPut: any }
- sitesSiteIdBackupDelete: function
  - sitesSiteIdBackupDelete(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:8820
    Disabling WordPress backups
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdBackupPost: function
  - sitesSiteIdBackupPost(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:8830
    Enabling WordPress backups
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdBasicAuthDelete: function
  - sitesSiteIdBasicAuthDelete(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:8840
    Disabling basic authentication
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdBasicAuthPost: function
  - sitesSiteIdBasicAuthPost(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:8850
    Enabling basic authentication
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdCdnStatusGet: function
  - sitesSiteIdCdnStatusGet(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CdnStatusGetResponse>>
  - - Defined in api.ts:8860
    Get the Shifter CDN status
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CdnStatusGetResponse>>
- sitesSiteIdLogsPathDelete: function
  - sitesSiteIdLogsPathDelete(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:8870
    delete destination of access logs
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdLogsPathPut: function
  - sitesSiteIdLogsPathPut(siteId: string, s3BucketName: InlineObject6, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:8881
    set or update destination of access logs
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - s3BucketName: InlineObject6
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdMediaCdnDelete: function
  - sitesSiteIdMediaCdnDelete(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:8891
    Disabling media CDN
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdMediaCdnPost: function
  - sitesSiteIdMediaCdnPost(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:8901
    Enabling media CDN
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdProtectionDelete: function
  - sitesSiteIdProtectionDelete(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:8911
    remove protection of delete
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdProtectionPost: function
  - sitesSiteIdProtectionPost(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:8921
    add protection of delete
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdPut: function
  - sitesSiteIdPut(siteId: string, request: InlineObject2, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:8932
    update site settings. Updatable attributes are site_name, All in one WP migration configuration, Shifter media cdn configuration, and automatic publish configuration.
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - request: InlineObject2
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdSiteNamePut: function
  - sitesSiteIdSiteNamePut(siteId: string, request: InlineObject3, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:8943
    Update your site name
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - request: InlineObject3
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdSiteSubdirDelete: function
  - sitesSiteIdSiteSubdirDelete(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:8953
    Remove subdirectory name for publishing
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdSiteSubdirPut: function
  - sitesSiteIdSiteSubdirPut(siteId: string, dirName: InlineObject5, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:8964
    Set subdirectory name for publishing
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - dirName: InlineObject5
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const SitesApiAxiosParamCreator

SitesApiAxiosParamCreator(configuration?: Configuration): { sitesGet: (options?: any) => Promise<RequestArgs>; sitesMysitesGet: (options?: any) => Promise<RequestArgs>; sitesPost: (request: InlineObject1, options?: any) => Promise<RequestArgs>; sitesSiteIdCdnPaygDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdCdnPaygPost: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdGenerateHistoryGet: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdGet: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdNotificationEmailDelete: (siteId: string, addresses?: string[], options?: any) => Promise<RequestArgs>; sitesSiteIdNotificationEmailGet: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdNotificationEmailPut: (siteId: string, addresses?: string[], options?: any) => Promise<RequestArgs>; sitesSiteIdPublicContentDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdShifterCdnTransferAmountGet: (siteId: string, startMonth?: number, range?: number, options?: any) => Promise<RequestArgs>; sitesSiteIdSubscriptionMigratePost: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdTeamsGet: (siteId: string, options?: any) => Promise<RequestArgs> }

- Defined in api.ts:9302
SitesApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { sitesGet: (options?: any) => Promise<RequestArgs>; sitesMysitesGet: (options?: any) => Promise<RequestArgs>; sitesPost: (request: InlineObject1, options?: any) => Promise<RequestArgs>; sitesSiteIdCdnPaygDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdCdnPaygPost: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdGenerateHistoryGet: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdGet: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdNotificationEmailDelete: (siteId: string, addresses?: string[], options?: any) => Promise<RequestArgs>; sitesSiteIdNotificationEmailGet: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdNotificationEmailPut: (siteId: string, addresses?: string[], options?: any) => Promise<RequestArgs>; sitesSiteIdPublicContentDelete: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdShifterCdnTransferAmountGet: (siteId: string, startMonth?: number, range?: number, options?: any) => Promise<RequestArgs>; sitesSiteIdSubscriptionMigratePost: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdTeamsGet: (siteId: string, options?: any) => Promise<RequestArgs> }
- sitesGet: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - List sites user can reach. In these sites, the sites that includes in the list are owner's one and member's one.
      
      throws
      
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesMysitesGet: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - List the information of your sites
      
      throws
      
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesPost: (request: InlineObject1, options?: any) => Promise<RequestArgs>
  - - (request: InlineObject1, options?: any): Promise<RequestArgs>
    - Create a new site. The body parameter site_name or project_name is required. To associate subscription set plan_id and subscription_id.
      
      throws
      
      {RequiredError}
      
      Parameters
      - request: InlineObject1
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdCdnPaygDelete: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Disable the Pay as you go of Data Transfer Usage
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdCdnPaygPost: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Enable the Pay as you go of Data Transfer Usage
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdDelete: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Delete your site
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdGenerateHistoryGet: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - You can get the history of generating in the site
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdGet: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Get your site information
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdNotificationEmailDelete: (siteId: string, addresses?: string[], options?: any) => Promise<RequestArgs>
  - - (siteId: string, addresses?: string[], options?: any): Promise<RequestArgs>
    - delete notification email for the site event
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
      - Optional addresses: string[]
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdNotificationEmailGet: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - get notification email for the site event
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdNotificationEmailPut: (siteId: string, addresses?: string[], options?: any) => Promise<RequestArgs>
  - - (siteId: string, addresses?: string[], options?: any): Promise<RequestArgs>
    - update notification email for the site event
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
      - Optional addresses: string[]
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdPublicContentDelete: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - clear public content
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdShifterCdnTransferAmountGet: (siteId: string, startMonth?: number, range?: number, options?: any) => Promise<RequestArgs>
  - - (siteId: string, startMonth?: number, range?: number, options?: any): Promise<RequestArgs>
    - You can get the transfer amount for Shifter CDN
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
      - Optional startMonth: number
      - Optional range: number
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdSubscriptionMigratePost: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Migrate from previous plan to Shifter current plan
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdTeamsGet: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - list team Id which the site belongs to
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>

Const SitesApiFactory

SitesApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { sitesGet: any; sitesMysitesGet: any; sitesPost: any; sitesSiteIdCdnPaygDelete: any; sitesSiteIdCdnPaygPost: any; sitesSiteIdDelete: any; sitesSiteIdGenerateHistoryGet: any; sitesSiteIdGet: any; sitesSiteIdNotificationEmailDelete: any; sitesSiteIdNotificationEmailGet: any; sitesSiteIdNotificationEmailPut: any; sitesSiteIdPublicContentDelete: any; sitesSiteIdShifterCdnTransferAmountGet: any; sitesSiteIdSubscriptionMigratePost: any; sitesSiteIdTeamsGet: any }

- Defined in api.ts:10025
SitesApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { sitesGet: any; sitesMysitesGet: any; sitesPost: any; sitesSiteIdCdnPaygDelete: any; sitesSiteIdCdnPaygPost: any; sitesSiteIdDelete: any; sitesSiteIdGenerateHistoryGet: any; sitesSiteIdGet: any; sitesSiteIdNotificationEmailDelete: any; sitesSiteIdNotificationEmailGet: any; sitesSiteIdNotificationEmailPut: any; sitesSiteIdPublicContentDelete: any; sitesSiteIdShifterCdnTransferAmountGet: any; sitesSiteIdSubscriptionMigratePost: any; sitesSiteIdTeamsGet: any }
- sitesGet: function
  - sitesGet(options?: any): AxiosPromise<SiteResponse[]>
  - - Defined in api.ts:10033
    List sites user can reach. In these sites, the sites that includes in the list are owner's one and member's one.
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<SiteResponse[]>
- sitesMysitesGet: function
  - sitesMysitesGet(options?: any): AxiosPromise<SiteResponse[]>
  - - Defined in api.ts:10041
    List the information of your sites
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<SiteResponse[]>
- sitesPost: function
  - sitesPost(request: InlineObject1, options?: any): AxiosPromise<SiteCreateResponse>
  - - Defined in api.ts:10050
    Create a new site. The body parameter site_name or project_name is required. To associate subscription set plan_id and subscription_id.
    
    throws
    
    {RequiredError}
    
    Parameters
    - request: InlineObject1
    - Optional options: any
    Returns AxiosPromise<SiteCreateResponse>
- sitesSiteIdCdnPaygDelete: function
  - sitesSiteIdCdnPaygDelete(siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:10059
    Disable the Pay as you go of Data Transfer Usage
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdCdnPaygPost: function
  - sitesSiteIdCdnPaygPost(siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:10068
    Enable the Pay as you go of Data Transfer Usage
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdDelete: function
  - sitesSiteIdDelete(siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:10077
    Delete your site
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdGenerateHistoryGet: function
  - sitesSiteIdGenerateHistoryGet(siteId: string, options?: any): AxiosPromise<InlineResponse20010[]>
  - - Defined in api.ts:10086
    You can get the history of generating in the site
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional options: any
    Returns AxiosPromise<InlineResponse20010[]>
- sitesSiteIdGet: function
  - sitesSiteIdGet(siteId: string, options?: any): AxiosPromise<SiteResponse>
  - - Defined in api.ts:10095
    Get your site information
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<SiteResponse>
- sitesSiteIdNotificationEmailDelete: function
  - sitesSiteIdNotificationEmailDelete(siteId: string, addresses?: string[], options?: any): AxiosPromise<void>
  - - Defined in api.ts:10105
    delete notification email for the site event
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional addresses: string[]
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdNotificationEmailGet: function
  - sitesSiteIdNotificationEmailGet(siteId: string, options?: any): AxiosPromise<string[]>
  - - Defined in api.ts:10114
    get notification email for the site event
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional options: any
    Returns AxiosPromise<string[]>
- sitesSiteIdNotificationEmailPut: function
  - sitesSiteIdNotificationEmailPut(siteId: string, addresses?: string[], options?: any): AxiosPromise<void>
  - - Defined in api.ts:10124
    update notification email for the site event
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional addresses: string[]
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdPublicContentDelete: function
  - sitesSiteIdPublicContentDelete(siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:10133
    clear public content
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional options: any
    Returns AxiosPromise<void>
- sitesSiteIdShifterCdnTransferAmountGet: function
  - sitesSiteIdShifterCdnTransferAmountGet(siteId: string, startMonth?: number, range?: number, options?: any): AxiosPromise<InlineResponse20011[]>
  - - Defined in api.ts:10144
    You can get the transfer amount for Shifter CDN
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional startMonth: number
    - Optional range: number
    - Optional options: any
    Returns AxiosPromise<InlineResponse20011[]>
- sitesSiteIdSubscriptionMigratePost: function
  - sitesSiteIdSubscriptionMigratePost(siteId: string, options?: any): AxiosPromise<string>
  - - Defined in api.ts:10153
    Migrate from previous plan to Shifter current plan
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<string>
- sitesSiteIdTeamsGet: function
  - sitesSiteIdTeamsGet(siteId: string, options?: any): AxiosPromise<object>
  - - Defined in api.ts:10162
    list team Id which the site belongs to
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<object>

Const SitesApiFp

SitesApiFp(configuration?: Configuration): { sitesGet: any; sitesMysitesGet: any; sitesPost: any; sitesSiteIdCdnPaygDelete: any; sitesSiteIdCdnPaygPost: any; sitesSiteIdDelete: any; sitesSiteIdGenerateHistoryGet: any; sitesSiteIdGet: any; sitesSiteIdNotificationEmailDelete: any; sitesSiteIdNotificationEmailGet: any; sitesSiteIdNotificationEmailPut: any; sitesSiteIdPublicContentDelete: any; sitesSiteIdShifterCdnTransferAmountGet: any; sitesSiteIdSubscriptionMigratePost: any; sitesSiteIdTeamsGet: any }

- Defined in api.ts:9863
SitesApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { sitesGet: any; sitesMysitesGet: any; sitesPost: any; sitesSiteIdCdnPaygDelete: any; sitesSiteIdCdnPaygPost: any; sitesSiteIdDelete: any; sitesSiteIdGenerateHistoryGet: any; sitesSiteIdGet: any; sitesSiteIdNotificationEmailDelete: any; sitesSiteIdNotificationEmailGet: any; sitesSiteIdNotificationEmailPut: any; sitesSiteIdPublicContentDelete: any; sitesSiteIdShifterCdnTransferAmountGet: any; sitesSiteIdSubscriptionMigratePost: any; sitesSiteIdTeamsGet: any }
- sitesGet: function
  - sitesGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SiteResponse[]>>
  - - Defined in api.ts:9871
    List sites user can reach. In these sites, the sites that includes in the list are owner's one and member's one.
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SiteResponse[]>>
- sitesMysitesGet: function
  - sitesMysitesGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SiteResponse[]>>
  - - Defined in api.ts:9880
    List the information of your sites
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SiteResponse[]>>
- sitesPost: function
  - sitesPost(request: InlineObject1, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SiteCreateResponse>>
  - - Defined in api.ts:9890
    Create a new site. The body parameter site_name or project_name is required. To associate subscription set plan_id and subscription_id.
    
    throws
    
    {RequiredError}
    
    Parameters
    - request: InlineObject1
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SiteCreateResponse>>
- sitesSiteIdCdnPaygDelete: function
  - sitesSiteIdCdnPaygDelete(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:9900
    Disable the Pay as you go of Data Transfer Usage
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdCdnPaygPost: function
  - sitesSiteIdCdnPaygPost(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:9910
    Enable the Pay as you go of Data Transfer Usage
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdDelete: function
  - sitesSiteIdDelete(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:9920
    Delete your site
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdGenerateHistoryGet: function
  - sitesSiteIdGenerateHistoryGet(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse20010[]>>
  - - Defined in api.ts:9930
    You can get the history of generating in the site
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse20010[]>>
- sitesSiteIdGet: function
  - sitesSiteIdGet(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SiteResponse>>
  - - Defined in api.ts:9940
    Get your site information
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SiteResponse>>
- sitesSiteIdNotificationEmailDelete: function
  - sitesSiteIdNotificationEmailDelete(siteId: string, addresses?: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:9951
    delete notification email for the site event
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional addresses: string[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdNotificationEmailGet: function
  - sitesSiteIdNotificationEmailGet(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>>
  - - Defined in api.ts:9961
    get notification email for the site event
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>>
- sitesSiteIdNotificationEmailPut: function
  - sitesSiteIdNotificationEmailPut(siteId: string, addresses?: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:9972
    update notification email for the site event
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional addresses: string[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdPublicContentDelete: function
  - sitesSiteIdPublicContentDelete(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:9982
    clear public content
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sitesSiteIdShifterCdnTransferAmountGet: function
  - sitesSiteIdShifterCdnTransferAmountGet(siteId: string, startMonth?: number, range?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse20011[]>>
  - - Defined in api.ts:9994
    You can get the transfer amount for Shifter CDN
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
    - Optional startMonth: number
    - Optional range: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse20011[]>>
- sitesSiteIdSubscriptionMigratePost: function
  - sitesSiteIdSubscriptionMigratePost(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
  - - Defined in api.ts:10004
    Migrate from previous plan to Shifter current plan
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
- sitesSiteIdTeamsGet: function
  - sitesSiteIdTeamsGet(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
  - - Defined in api.ts:10014
    list team Id which the site belongs to
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>

Const StatisticsApiAxiosParamCreator

StatisticsApiAxiosParamCreator(configuration?: Configuration): { statisticsUsageSummaryGet: (options?: any) => Promise<RequestArgs> }

- Defined in api.ts:10348
StatisticsApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { statisticsUsageSummaryGet: (options?: any) => Promise<RequestArgs> }
- statisticsUsageSummaryGet: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - (Previous Plan) Monthly Statistics of Site usage
      
      throws
      
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>

Const StatisticsApiFactory

StatisticsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { statisticsUsageSummaryGet: any }

- Defined in api.ts:10408
StatisticsApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { statisticsUsageSummaryGet: any }
- statisticsUsageSummaryGet: function
  - statisticsUsageSummaryGet(options?: any): AxiosPromise<UsageSummaryGetResponse>
  - - Defined in api.ts:10416
    (Previous Plan) Monthly Statistics of Site usage
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<UsageSummaryGetResponse>

Const StatisticsApiFp

StatisticsApiFp(configuration?: Configuration): { statisticsUsageSummaryGet: any }

- Defined in api.ts:10389
StatisticsApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { statisticsUsageSummaryGet: any }
- statisticsUsageSummaryGet: function
  - statisticsUsageSummaryGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UsageSummaryGetResponse>>
  - - Defined in api.ts:10397
    (Previous Plan) Monthly Statistics of Site usage
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UsageSummaryGetResponse>>

Const StatusApiAxiosParamCreator

StatusApiAxiosParamCreator(configuration?: Configuration): { statusGet: (options?: any) => Promise<RequestArgs>; statusTeamsTeamIdRoleGet: (teamId: string, options?: any) => Promise<RequestArgs> }

- Defined in api.ts:10445
StatusApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { statusGet: (options?: any) => Promise<RequestArgs>; statusTeamsTeamIdRoleGet: (teamId: string, options?: any) => Promise<RequestArgs> }
- statusGet: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - Get the status of your account and Shifter
      
      throws
      
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- statusTeamsTeamIdRoleGet: (teamId: string, options?: any) => Promise<RequestArgs>
  - - (teamId: string, options?: any): Promise<RequestArgs>
    - Get role specific team of logged in user
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - options: any = {}
      Returns Promise<RequestArgs>

Const StatusApiFactory

StatusApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { statusGet: any; statusTeamsTeamIdRoleGet: any }

- Defined in api.ts:10551
StatusApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { statusGet: any; statusTeamsTeamIdRoleGet: any }
- statusGet: function
  - statusGet(options?: any): AxiosPromise<StatusGetResponse>
  - - Defined in api.ts:10559
    Get the status of your account and Shifter
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<StatusGetResponse>
- statusTeamsTeamIdRoleGet: function
  - statusTeamsTeamIdRoleGet(teamId: string, options?: any): AxiosPromise<InlineResponse2009>
  - - Defined in api.ts:10568
    Get role specific team of logged in user
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - Optional options: any
    Returns AxiosPromise<InlineResponse2009>

Const StatusApiFp

StatusApiFp(configuration?: Configuration): { statusGet: any; statusTeamsTeamIdRoleGet: any }

- Defined in api.ts:10522
StatusApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { statusGet: any; statusTeamsTeamIdRoleGet: any }
- statusGet: function
  - statusGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StatusGetResponse>>
  - - Defined in api.ts:10530
    Get the status of your account and Shifter
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StatusGetResponse>>
- statusTeamsTeamIdRoleGet: function
  - statusTeamsTeamIdRoleGet(teamId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2009>>
  - - Defined in api.ts:10540
    Get role specific team of logged in user
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2009>>

Const TeamsApiAxiosParamCreator

TeamsApiAxiosParamCreator(configuration?: Configuration): { teamsGet: (options?: any) => Promise<RequestArgs>; teamsMembersMemberNameTeamsGet: (memberName: string, options?: any) => Promise<RequestArgs>; teamsPost: (request: TeamsResponseWithoutId, options?: any) => Promise<RequestArgs>; teamsTeamIdActivationKeyPost: (teamId: string, key: string, options?: any) => Promise<RequestArgs>; teamsTeamIdDelete: (teamId: string, options?: any) => Promise<RequestArgs>; teamsTeamIdGet: (teamId: string, options?: any) => Promise<RequestArgs>; teamsTeamIdMembersGet: (teamId: string, options?: any) => Promise<RequestArgs>; teamsTeamIdMembersNameGet: (teamId: string, name: string, options?: any) => Promise<RequestArgs>; teamsTeamIdMembersNameRoleDelete: (teamId: string, name: string, options?: any) => Promise<RequestArgs>; teamsTeamIdMembersNameRoleGet: (teamId: string, name: string, options?: any) => Promise<RequestArgs>; teamsTeamIdMembersNameRolePost: (teamId: string, name: string, request: InlineObject18, options?: any) => Promise<RequestArgs>; teamsTeamIdMembersNameRolePut: (teamId: string, name: string, request: InlineObject17, options?: any) => Promise<RequestArgs>; teamsTeamIdMembersPost: (teamId: string, request?: InlineObject[], options?: any) => Promise<RequestArgs>; teamsTeamIdPut: (teamId: string, request: TeamsResponseWithoutId, options?: any) => Promise<RequestArgs>; teamsTeamIdSitesDelete: (teamId: string, request?: InlineObject16, options?: any) => Promise<RequestArgs>; teamsTeamIdSitesGet: (teamId: string, options?: any) => Promise<RequestArgs>; teamsTeamIdSitesPost: (teamId: string, request: InlineObject15, options?: any) => Promise<RequestArgs>; teamsTeamIdSitesSiteIdGet: (teamId: string, siteId: string, options?: any) => Promise<RequestArgs>; teamsTeamIdSitesSiteIdPost: (teamId: string, siteId: string, options?: any) => Promise<RequestArgs> }

- Defined in api.ts:10608
TeamsApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { teamsGet: (options?: any) => Promise<RequestArgs>; teamsMembersMemberNameTeamsGet: (memberName: string, options?: any) => Promise<RequestArgs>; teamsPost: (request: TeamsResponseWithoutId, options?: any) => Promise<RequestArgs>; teamsTeamIdActivationKeyPost: (teamId: string, key: string, options?: any) => Promise<RequestArgs>; teamsTeamIdDelete: (teamId: string, options?: any) => Promise<RequestArgs>; teamsTeamIdGet: (teamId: string, options?: any) => Promise<RequestArgs>; teamsTeamIdMembersGet: (teamId: string, options?: any) => Promise<RequestArgs>; teamsTeamIdMembersNameGet: (teamId: string, name: string, options?: any) => Promise<RequestArgs>; teamsTeamIdMembersNameRoleDelete: (teamId: string, name: string, options?: any) => Promise<RequestArgs>; teamsTeamIdMembersNameRoleGet: (teamId: string, name: string, options?: any) => Promise<RequestArgs>; teamsTeamIdMembersNameRolePost: (teamId: string, name: string, request: InlineObject18, options?: any) => Promise<RequestArgs>; teamsTeamIdMembersNameRolePut: (teamId: string, name: string, request: InlineObject17, options?: any) => Promise<RequestArgs>; teamsTeamIdMembersPost: (teamId: string, request?: InlineObject[], options?: any) => Promise<RequestArgs>; teamsTeamIdPut: (teamId: string, request: TeamsResponseWithoutId, options?: any) => Promise<RequestArgs>; teamsTeamIdSitesDelete: (teamId: string, request?: InlineObject16, options?: any) => Promise<RequestArgs>; teamsTeamIdSitesGet: (teamId: string, options?: any) => Promise<RequestArgs>; teamsTeamIdSitesPost: (teamId: string, request: InlineObject15, options?: any) => Promise<RequestArgs>; teamsTeamIdSitesSiteIdGet: (teamId: string, siteId: string, options?: any) => Promise<RequestArgs>; teamsTeamIdSitesSiteIdPost: (teamId: string, siteId: string, options?: any) => Promise<RequestArgs> }
- teamsGet: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - List teams
      
      throws
      
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsMembersMemberNameTeamsGet: (memberName: string, options?: any) => Promise<RequestArgs>
  - - (memberName: string, options?: any): Promise<RequestArgs>
    - List teams which member belongs into
      
      throws
      
      {RequiredError}
      
      Parameters
      - memberName: string
        
        Member's name
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsPost: (request: TeamsResponseWithoutId, options?: any) => Promise<RequestArgs>
  - - (request: TeamsResponseWithoutId, options?: any): Promise<RequestArgs>
    - Create a team
      
      throws
      
      {RequiredError}
      
      Parameters
      - request: TeamsResponseWithoutId
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdActivationKeyPost: (teamId: string, key: string, options?: any) => Promise<RequestArgs>
  - - (teamId: string, key: string, options?: any): Promise<RequestArgs>
    - Activate user who is invited the team
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - key: string
        
        Activation key which is sent when owner invites other user to the team
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdDelete: (teamId: string, options?: any) => Promise<RequestArgs>
  - - (teamId: string, options?: any): Promise<RequestArgs>
    - Delete a team
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdGet: (teamId: string, options?: any) => Promise<RequestArgs>
  - - (teamId: string, options?: any): Promise<RequestArgs>
    - Get a details of team
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdMembersGet: (teamId: string, options?: any) => Promise<RequestArgs>
  - - (teamId: string, options?: any): Promise<RequestArgs>
    - List users specified team
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdMembersNameGet: (teamId: string, name: string, options?: any) => Promise<RequestArgs>
  - - (teamId: string, name: string, options?: any): Promise<RequestArgs>
    - Get member information specified team and name
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - name: string
        
        Name of a member
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdMembersNameRoleDelete: (teamId: string, name: string, options?: any) => Promise<RequestArgs>
  - - (teamId: string, name: string, options?: any): Promise<RequestArgs>
    - Delete role of specific team member
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - name: string
        
        name of member
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdMembersNameRoleGet: (teamId: string, name: string, options?: any) => Promise<RequestArgs>
  - - (teamId: string, name: string, options?: any): Promise<RequestArgs>
    - Get role of specific team member
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - name: string
        
        Name of member
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdMembersNameRolePost: (teamId: string, name: string, request: InlineObject18, options?: any) => Promise<RequestArgs>
  - - (teamId: string, name: string, request: InlineObject18, options?: any): Promise<RequestArgs>
    - Add role of specific team member
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - name: string
        
        Name of member
      - request: InlineObject18
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdMembersNameRolePut: (teamId: string, name: string, request: InlineObject17, options?: any) => Promise<RequestArgs>
  - - (teamId: string, name: string, request: InlineObject17, options?: any): Promise<RequestArgs>
    - Update role of specific team member
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - name: string
        
        name of member
      - request: InlineObject17
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdMembersPost: (teamId: string, request?: InlineObject[], options?: any) => Promise<RequestArgs>
  - - (teamId: string, request?: InlineObject[], options?: any): Promise<RequestArgs>
    - Add members to the team by email. If new member already has Shifter Account, This API sends invitation to the the user who matched with email. If new member does not have Shifter account yet, API sends invitation to that email with Sign Up link.
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - Optional request: InlineObject[]
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdPut: (teamId: string, request: TeamsResponseWithoutId, options?: any) => Promise<RequestArgs>
  - - (teamId: string, request: TeamsResponseWithoutId, options?: any): Promise<RequestArgs>
    - Update a team
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - request: TeamsResponseWithoutId
        
        New team information
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdSitesDelete: (teamId: string, request?: InlineObject16, options?: any) => Promise<RequestArgs>
  - - (teamId: string, request?: InlineObject16, options?: any): Promise<RequestArgs>
    - Detach sites from specified team
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - Optional request: InlineObject16
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdSitesGet: (teamId: string, options?: any) => Promise<RequestArgs>
  - - (teamId: string, options?: any): Promise<RequestArgs>
    - List sites in specified team
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdSitesPost: (teamId: string, request: InlineObject15, options?: any) => Promise<RequestArgs>
  - - (teamId: string, request: InlineObject15, options?: any): Promise<RequestArgs>
    - Add sites to the team
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - request: InlineObject15
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdSitesSiteIdGet: (teamId: string, siteId: string, options?: any) => Promise<RequestArgs>
  - - (teamId: string, siteId: string, options?: any): Promise<RequestArgs>
    - Get site details which specified team
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- teamsTeamIdSitesSiteIdPost: (teamId: string, siteId: string, options?: any) => Promise<RequestArgs>
  - - (teamId: string, siteId: string, options?: any): Promise<RequestArgs>
    - Add a site to specific team
      
      throws
      
      {RequiredError}
      
      Parameters
      - teamId: string
        
        Team ID
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>

Const TeamsApiFactory

TeamsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { teamsGet: any; teamsMembersMemberNameTeamsGet: any; teamsPost: any; teamsTeamIdActivationKeyPost: any; teamsTeamIdDelete: any; teamsTeamIdGet: any; teamsTeamIdMembersGet: any; teamsTeamIdMembersNameGet: any; teamsTeamIdMembersNameRoleDelete: any; teamsTeamIdMembersNameRoleGet: any; teamsTeamIdMembersNameRolePost: any; teamsTeamIdMembersNameRolePut: any; teamsTeamIdMembersPost: any; teamsTeamIdPut: any; teamsTeamIdSitesDelete: any; teamsTeamIdSitesGet: any; teamsTeamIdSitesPost: any; teamsTeamIdSitesSiteIdGet: any; teamsTeamIdSitesSiteIdPost: any }

- Defined in api.ts:11576
TeamsApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { teamsGet: any; teamsMembersMemberNameTeamsGet: any; teamsPost: any; teamsTeamIdActivationKeyPost: any; teamsTeamIdDelete: any; teamsTeamIdGet: any; teamsTeamIdMembersGet: any; teamsTeamIdMembersNameGet: any; teamsTeamIdMembersNameRoleDelete: any; teamsTeamIdMembersNameRoleGet: any; teamsTeamIdMembersNameRolePost: any; teamsTeamIdMembersNameRolePut: any; teamsTeamIdMembersPost: any; teamsTeamIdPut: any; teamsTeamIdSitesDelete: any; teamsTeamIdSitesGet: any; teamsTeamIdSitesPost: any; teamsTeamIdSitesSiteIdGet: any; teamsTeamIdSitesSiteIdPost: any }
- teamsGet: function
  - teamsGet(options?: any): AxiosPromise<InlineResponse2001>
  - - Defined in api.ts:11584
    List teams
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<InlineResponse2001>
- teamsMembersMemberNameTeamsGet: function
  - teamsMembersMemberNameTeamsGet(memberName: string, options?: any): AxiosPromise<InlineResponse2002>
  - - Defined in api.ts:11593
    List teams which member belongs into
    
    throws
    
    {RequiredError}
    
    Parameters
    - memberName: string
      
      Member's name
    - Optional options: any
    Returns AxiosPromise<InlineResponse2002>
- teamsPost: function
  - teamsPost(request: TeamsResponseWithoutId, options?: any): AxiosPromise<InlineResponse2012>
  - - Defined in api.ts:11602
    Create a team
    
    throws
    
    {RequiredError}
    
    Parameters
    - request: TeamsResponseWithoutId
    - Optional options: any
    Returns AxiosPromise<InlineResponse2012>
- teamsTeamIdActivationKeyPost: function
  - teamsTeamIdActivationKeyPost(teamId: string, key: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:11612
    Activate user who is invited the team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - key: string
      
      Activation key which is sent when owner invites other user to the team
    - Optional options: any
    Returns AxiosPromise<void>
- teamsTeamIdDelete: function
  - teamsTeamIdDelete(teamId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:11621
    Delete a team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - Optional options: any
    Returns AxiosPromise<void>
- teamsTeamIdGet: function
  - teamsTeamIdGet(teamId: string, options?: any): AxiosPromise<TeamsResponseWithId>
  - - Defined in api.ts:11630
    Get a details of team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - Optional options: any
    Returns AxiosPromise<TeamsResponseWithId>
- teamsTeamIdMembersGet: function
  - teamsTeamIdMembersGet(teamId: string, options?: any): AxiosPromise<InlineResponse2003[]>
  - - Defined in api.ts:11639
    List users specified team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - Optional options: any
    Returns AxiosPromise<InlineResponse2003[]>
- teamsTeamIdMembersNameGet: function
  - teamsTeamIdMembersNameGet(teamId: string, name: string, options?: any): AxiosPromise<InlineResponse2004>
  - - Defined in api.ts:11649
    Get member information specified team and name
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - name: string
      
      Name of a member
    - Optional options: any
    Returns AxiosPromise<InlineResponse2004>
- teamsTeamIdMembersNameRoleDelete: function
  - teamsTeamIdMembersNameRoleDelete(teamId: string, name: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:11659
    Delete role of specific team member
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - name: string
      
      name of member
    - Optional options: any
    Returns AxiosPromise<void>
- teamsTeamIdMembersNameRoleGet: function
  - teamsTeamIdMembersNameRoleGet(teamId: string, name: string, options?: any): AxiosPromise<InlineResponse2005>
  - - Defined in api.ts:11669
    Get role of specific team member
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - name: string
      
      Name of member
    - Optional options: any
    Returns AxiosPromise<InlineResponse2005>
- teamsTeamIdMembersNameRolePost: function
  - teamsTeamIdMembersNameRolePost(teamId: string, name: string, request: InlineObject18, options?: any): AxiosPromise<void>
  - - Defined in api.ts:11680
    Add role of specific team member
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - name: string
      
      Name of member
    - request: InlineObject18
    - Optional options: any
    Returns AxiosPromise<void>
- teamsTeamIdMembersNameRolePut: function
  - teamsTeamIdMembersNameRolePut(teamId: string, name: string, request: InlineObject17, options?: any): AxiosPromise<void>
  - - Defined in api.ts:11691
    Update role of specific team member
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - name: string
      
      name of member
    - request: InlineObject17
    - Optional options: any
    Returns AxiosPromise<void>
- teamsTeamIdMembersPost: function
  - teamsTeamIdMembersPost(teamId: string, request?: InlineObject[], options?: any): AxiosPromise<void>
  - - Defined in api.ts:11701
    Add members to the team by email. If new member already has Shifter Account, This API sends invitation to the the user who matched with email. If new member does not have Shifter account yet, API sends invitation to that email with Sign Up link.
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - Optional request: InlineObject[]
    - Optional options: any
    Returns AxiosPromise<void>
- teamsTeamIdPut: function
  - teamsTeamIdPut(teamId: string, request: TeamsResponseWithoutId, options?: any): AxiosPromise<void>
  - - Defined in api.ts:11711
    Update a team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - request: TeamsResponseWithoutId
      
      New team information
    - Optional options: any
    Returns AxiosPromise<void>
- teamsTeamIdSitesDelete: function
  - teamsTeamIdSitesDelete(teamId: string, request?: InlineObject16, options?: any): AxiosPromise<void>
  - - Defined in api.ts:11721
    Detach sites from specified team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - Optional request: InlineObject16
    - Optional options: any
    Returns AxiosPromise<void>
- teamsTeamIdSitesGet: function
  - teamsTeamIdSitesGet(teamId: string, options?: any): AxiosPromise<SiteResponse[]>
  - - Defined in api.ts:11730
    List sites in specified team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - Optional options: any
    Returns AxiosPromise<SiteResponse[]>
- teamsTeamIdSitesPost: function
  - teamsTeamIdSitesPost(teamId: string, request: InlineObject15, options?: any): AxiosPromise<void>
  - - Defined in api.ts:11740
    Add sites to the team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - request: InlineObject15
    - Optional options: any
    Returns AxiosPromise<void>
- teamsTeamIdSitesSiteIdGet: function
  - teamsTeamIdSitesSiteIdGet(teamId: string, siteId: string, options?: any): AxiosPromise<SiteResponse>
  - - Defined in api.ts:11750
    Get site details which specified team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<SiteResponse>
- teamsTeamIdSitesSiteIdPost: function
  - teamsTeamIdSitesSiteIdPost(teamId: string, siteId: string, options?: any): AxiosPromise<void>
  - - Defined in api.ts:11760
    Add a site to specific team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<void>

Const TeamsApiFp

TeamsApiFp(configuration?: Configuration): { teamsGet: any; teamsMembersMemberNameTeamsGet: any; teamsPost: any; teamsTeamIdActivationKeyPost: any; teamsTeamIdDelete: any; teamsTeamIdGet: any; teamsTeamIdMembersGet: any; teamsTeamIdMembersNameGet: any; teamsTeamIdMembersNameRoleDelete: any; teamsTeamIdMembersNameRoleGet: any; teamsTeamIdMembersNameRolePost: any; teamsTeamIdMembersNameRolePut: any; teamsTeamIdMembersPost: any; teamsTeamIdPut: any; teamsTeamIdSitesDelete: any; teamsTeamIdSitesGet: any; teamsTeamIdSitesPost: any; teamsTeamIdSitesSiteIdGet: any; teamsTeamIdSitesSiteIdPost: any }

- Defined in api.ts:11363
TeamsApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { teamsGet: any; teamsMembersMemberNameTeamsGet: any; teamsPost: any; teamsTeamIdActivationKeyPost: any; teamsTeamIdDelete: any; teamsTeamIdGet: any; teamsTeamIdMembersGet: any; teamsTeamIdMembersNameGet: any; teamsTeamIdMembersNameRoleDelete: any; teamsTeamIdMembersNameRoleGet: any; teamsTeamIdMembersNameRolePost: any; teamsTeamIdMembersNameRolePut: any; teamsTeamIdMembersPost: any; teamsTeamIdPut: any; teamsTeamIdSitesDelete: any; teamsTeamIdSitesGet: any; teamsTeamIdSitesPost: any; teamsTeamIdSitesSiteIdGet: any; teamsTeamIdSitesSiteIdPost: any }
- teamsGet: function
  - teamsGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2001>>
  - - Defined in api.ts:11371
    List teams
    
    throws
    
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2001>>
- teamsMembersMemberNameTeamsGet: function
  - teamsMembersMemberNameTeamsGet(memberName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2002>>
  - - Defined in api.ts:11381
    List teams which member belongs into
    
    throws
    
    {RequiredError}
    
    Parameters
    - memberName: string
      
      Member's name
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2002>>
- teamsPost: function
  - teamsPost(request: TeamsResponseWithoutId, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2012>>
  - - Defined in api.ts:11391
    Create a team
    
    throws
    
    {RequiredError}
    
    Parameters
    - request: TeamsResponseWithoutId
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2012>>
- teamsTeamIdActivationKeyPost: function
  - teamsTeamIdActivationKeyPost(teamId: string, key: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:11402
    Activate user who is invited the team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - key: string
      
      Activation key which is sent when owner invites other user to the team
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- teamsTeamIdDelete: function
  - teamsTeamIdDelete(teamId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:11412
    Delete a team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- teamsTeamIdGet: function
  - teamsTeamIdGet(teamId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamsResponseWithId>>
  - - Defined in api.ts:11422
    Get a details of team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamsResponseWithId>>
- teamsTeamIdMembersGet: function
  - teamsTeamIdMembersGet(teamId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003[]>>
  - - Defined in api.ts:11432
    List users specified team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003[]>>
- teamsTeamIdMembersNameGet: function
  - teamsTeamIdMembersNameGet(teamId: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2004>>
  - - Defined in api.ts:11443
    Get member information specified team and name
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - name: string
      
      Name of a member
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2004>>
- teamsTeamIdMembersNameRoleDelete: function
  - teamsTeamIdMembersNameRoleDelete(teamId: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:11454
    Delete role of specific team member
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - name: string
      
      name of member
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- teamsTeamIdMembersNameRoleGet: function
  - teamsTeamIdMembersNameRoleGet(teamId: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2005>>
  - - Defined in api.ts:11465
    Get role of specific team member
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - name: string
      
      Name of member
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2005>>
- teamsTeamIdMembersNameRolePost: function
  - teamsTeamIdMembersNameRolePost(teamId: string, name: string, request: InlineObject18, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:11477
    Add role of specific team member
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - name: string
      
      Name of member
    - request: InlineObject18
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- teamsTeamIdMembersNameRolePut: function
  - teamsTeamIdMembersNameRolePut(teamId: string, name: string, request: InlineObject17, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:11489
    Update role of specific team member
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - name: string
      
      name of member
    - request: InlineObject17
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- teamsTeamIdMembersPost: function
  - teamsTeamIdMembersPost(teamId: string, request?: InlineObject[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:11500
    Add members to the team by email. If new member already has Shifter Account, This API sends invitation to the the user who matched with email. If new member does not have Shifter account yet, API sends invitation to that email with Sign Up link.
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - Optional request: InlineObject[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- teamsTeamIdPut: function
  - teamsTeamIdPut(teamId: string, request: TeamsResponseWithoutId, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:11511
    Update a team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - request: TeamsResponseWithoutId
      
      New team information
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- teamsTeamIdSitesDelete: function
  - teamsTeamIdSitesDelete(teamId: string, request?: InlineObject16, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:11522
    Detach sites from specified team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - Optional request: InlineObject16
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- teamsTeamIdSitesGet: function
  - teamsTeamIdSitesGet(teamId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SiteResponse[]>>
  - - Defined in api.ts:11532
    List sites in specified team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SiteResponse[]>>
- teamsTeamIdSitesPost: function
  - teamsTeamIdSitesPost(teamId: string, request: InlineObject15, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:11543
    Add sites to the team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - request: InlineObject15
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- teamsTeamIdSitesSiteIdGet: function
  - teamsTeamIdSitesSiteIdGet(teamId: string, siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SiteResponse>>
  - - Defined in api.ts:11554
    Get site details which specified team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SiteResponse>>
- teamsTeamIdSitesSiteIdPost: function
  - teamsTeamIdSitesSiteIdPost(teamId: string, siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in api.ts:11565
    Add a site to specific team
    
    throws
    
    {RequiredError}
    
    Parameters
    - teamId: string
      
      Team ID
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const WebhooksApiAxiosParamCreator

WebhooksApiAxiosParamCreator(configuration?: Configuration): { webhooksSiteSiteIdDelete: (siteId: string, request: InlineObject21, options?: any) => Promise<RequestArgs>; webhooksSiteSiteIdGet: (siteId: string, options?: any) => Promise<RequestArgs>; webhooksSiteSiteIdHistoryGet: (siteId: string, options?: any) => Promise<RequestArgs>; webhooksSiteSiteIdPost: (siteId: string, request: InlineObject20, options?: any) => Promise<RequestArgs>; webhooksSiteSiteIdPut: (siteId: string, request: InlineObject19, options?: any) => Promise<RequestArgs> }

- Defined in api.ts:12001
WebhooksApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { webhooksSiteSiteIdDelete: (siteId: string, request: InlineObject21, options?: any) => Promise<RequestArgs>; webhooksSiteSiteIdGet: (siteId: string, options?: any) => Promise<RequestArgs>; webhooksSiteSiteIdHistoryGet: (siteId: string, options?: any) => Promise<RequestArgs>; webhooksSiteSiteIdPost: (siteId: string, request: InlineObject20, options?: any) => Promise<RequestArgs>; webhooksSiteSiteIdPut: (siteId: string, request: InlineObject19, options?: any) => Promise<RequestArgs> }
- webhooksSiteSiteIdDelete: (siteId: string, request: InlineObject21, options?: any) => Promise<RequestArgs>
  - - (siteId: string, request: InlineObject21, options?: any): Promise<RequestArgs>
    - Delete webhooks
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - request: InlineObject21
      - options: any = {}
      Returns Promise<RequestArgs>
- webhooksSiteSiteIdGet: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Get webhooks
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- webhooksSiteSiteIdHistoryGet: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - List webhook history
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- webhooksSiteSiteIdPost: (siteId: string, request: InlineObject20, options?: any) => Promise<RequestArgs>
  - - (siteId: string, request: InlineObject20, options?: any): Promise<RequestArgs>
    - Create webhooks
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - request: InlineObject20
      - options: any = {}
      Returns Promise<RequestArgs>
- webhooksSiteSiteIdPut: (siteId: string, request: InlineObject19, options?: any) => Promise<RequestArgs>
  - - (siteId: string, request: InlineObject19, options?: any): Promise<RequestArgs>
    - Update webhooks
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - request: InlineObject19
      - options: any = {}
      Returns Promise<RequestArgs>

Const WebhooksApiFactory

WebhooksApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { webhooksSiteSiteIdDelete: any; webhooksSiteSiteIdGet: any; webhooksSiteSiteIdHistoryGet: any; webhooksSiteSiteIdPost: any; webhooksSiteSiteIdPut: any }

- Defined in api.ts:12271
WebhooksApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { webhooksSiteSiteIdDelete: any; webhooksSiteSiteIdGet: any; webhooksSiteSiteIdHistoryGet: any; webhooksSiteSiteIdPost: any; webhooksSiteSiteIdPut: any }
- webhooksSiteSiteIdDelete: function
  - webhooksSiteSiteIdDelete(siteId: string, request: InlineObject21, options?: any): AxiosPromise<InlineResponse2006[]>
  - - Defined in api.ts:12281
    Delete webhooks
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - request: InlineObject21
    - Optional options: any
    Returns AxiosPromise<InlineResponse2006[]>
- webhooksSiteSiteIdGet: function
  - webhooksSiteSiteIdGet(siteId: string, options?: any): AxiosPromise<InlineResponse2006[]>
  - - Defined in api.ts:12290
    Get webhooks
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<InlineResponse2006[]>
- webhooksSiteSiteIdHistoryGet: function
  - webhooksSiteSiteIdHistoryGet(siteId: string, options?: any): AxiosPromise<InlineResponse2007[]>
  - - Defined in api.ts:12299
    List webhook history
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<InlineResponse2007[]>
- webhooksSiteSiteIdPost: function
  - webhooksSiteSiteIdPost(siteId: string, request: InlineObject20, options?: any): AxiosPromise<InlineResponse2006[]>
  - - Defined in api.ts:12309
    Create webhooks
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - request: InlineObject20
    - Optional options: any
    Returns AxiosPromise<InlineResponse2006[]>
- webhooksSiteSiteIdPut: function
  - webhooksSiteSiteIdPut(siteId: string, request: InlineObject19, options?: any): AxiosPromise<InlineResponse2006[]>
  - - Defined in api.ts:12319
    Update webhooks
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - request: InlineObject19
    - Optional options: any
    Returns AxiosPromise<InlineResponse2006[]>

Const WebhooksApiFp

WebhooksApiFp(configuration?: Configuration): { webhooksSiteSiteIdDelete: any; webhooksSiteSiteIdGet: any; webhooksSiteSiteIdHistoryGet: any; webhooksSiteSiteIdPost: any; webhooksSiteSiteIdPut: any }

- Defined in api.ts:12208
WebhooksApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { webhooksSiteSiteIdDelete: any; webhooksSiteSiteIdGet: any; webhooksSiteSiteIdHistoryGet: any; webhooksSiteSiteIdPost: any; webhooksSiteSiteIdPut: any }
- webhooksSiteSiteIdDelete: function
  - webhooksSiteSiteIdDelete(siteId: string, request: InlineObject21, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2006[]>>
  - - Defined in api.ts:12218
    Delete webhooks
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - request: InlineObject21
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2006[]>>
- webhooksSiteSiteIdGet: function
  - webhooksSiteSiteIdGet(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2006[]>>
  - - Defined in api.ts:12228
    Get webhooks
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2006[]>>
- webhooksSiteSiteIdHistoryGet: function
  - webhooksSiteSiteIdHistoryGet(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2007[]>>
  - - Defined in api.ts:12238
    List webhook history
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2007[]>>
- webhooksSiteSiteIdPost: function
  - webhooksSiteSiteIdPost(siteId: string, request: InlineObject20, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2006[]>>
  - - Defined in api.ts:12249
    Create webhooks
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - request: InlineObject20
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2006[]>>
- webhooksSiteSiteIdPut: function
  - webhooksSiteSiteIdPut(siteId: string, request: InlineObject19, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2006[]>>
  - - Defined in api.ts:12260
    Update webhooks
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - request: InlineObject19
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2006[]>>

Const WordPressApiAxiosParamCreator

WordPressApiAxiosParamCreator(configuration?: Configuration): { sitesSiteIdWordpressSiteCheckWpSetupNotificationIdGet: (siteId: string, notificationId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdWordpressSiteErrorsGet: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdWordpressSiteStartPost: (siteId: string, request?: InlineObject4, options?: any) => Promise<RequestArgs>; sitesSiteIdWordpressSiteStopPost: (siteId: string, options?: any) => Promise<RequestArgs> }

- Defined in api.ts:12396
WordPressApi - axios parameter creator

export

Parameters
- Optional configuration: Configuration
Returns { sitesSiteIdWordpressSiteCheckWpSetupNotificationIdGet: (siteId: string, notificationId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdWordpressSiteErrorsGet: (siteId: string, options?: any) => Promise<RequestArgs>; sitesSiteIdWordpressSiteStartPost: (siteId: string, request?: InlineObject4, options?: any) => Promise<RequestArgs>; sitesSiteIdWordpressSiteStopPost: (siteId: string, options?: any) => Promise<RequestArgs> }
- sitesSiteIdWordpressSiteCheckWpSetupNotificationIdGet: (siteId: string, notificationId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, notificationId: string, options?: any): Promise<RequestArgs>
    - Start WordPress
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - notificationId: string
        
        Notification ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdWordpressSiteErrorsGet: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Get errors of WordPress container
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdWordpressSiteStartPost: (siteId: string, request?: InlineObject4, options?: any) => Promise<RequestArgs>
  - - (siteId: string, request?: InlineObject4, options?: any): Promise<RequestArgs>
    - Start WordPress
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - Optional request: InlineObject4
      - options: any = {}
      Returns Promise<RequestArgs>
- sitesSiteIdWordpressSiteStopPost: (siteId: string, options?: any) => Promise<RequestArgs>
  - - (siteId: string, options?: any): Promise<RequestArgs>
    - Stop WordPress
      
      throws
      
      {RequiredError}
      
      Parameters
      - siteId: string
        
        Site ID
      - options: any = {}
      Returns Promise<RequestArgs>

Const WordPressApiFactory

WordPressApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { sitesSiteIdWordpressSiteCheckWpSetupNotificationIdGet: any; sitesSiteIdWordpressSiteErrorsGet: any; sitesSiteIdWordpressSiteStartPost: any; sitesSiteIdWordpressSiteStopPost: any }

- Defined in api.ts:12609
WordPressApi - factory interface

export

Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { sitesSiteIdWordpressSiteCheckWpSetupNotificationIdGet: any; sitesSiteIdWordpressSiteErrorsGet: any; sitesSiteIdWordpressSiteStartPost: any; sitesSiteIdWordpressSiteStopPost: any }
- sitesSiteIdWordpressSiteCheckWpSetupNotificationIdGet: function
  - sitesSiteIdWordpressSiteCheckWpSetupNotificationIdGet(siteId: string, notificationId: string, options?: any): AxiosPromise<string>
  - - Defined in api.ts:12619
    Start WordPress
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - notificationId: string
      
      Notification ID
    - Optional options: any
    Returns AxiosPromise<string>
- sitesSiteIdWordpressSiteErrorsGet: function
  - sitesSiteIdWordpressSiteErrorsGet(siteId: string, options?: any): AxiosPromise<InlineResponse200>
  - - Defined in api.ts:12628
    Get errors of WordPress container
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<InlineResponse200>
- sitesSiteIdWordpressSiteStartPost: function
  - sitesSiteIdWordpressSiteStartPost(siteId: string, request?: InlineObject4, options?: any): AxiosPromise<InlineResponse201>
  - - Defined in api.ts:12638
    Start WordPress
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional request: InlineObject4
    - Optional options: any
    Returns AxiosPromise<InlineResponse201>
- sitesSiteIdWordpressSiteStopPost: function
  - sitesSiteIdWordpressSiteStopPost(siteId: string, options?: any): AxiosPromise<InlineResponse2011>
  - - Defined in api.ts:12647
    Stop WordPress
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns AxiosPromise<InlineResponse2011>

Const WordPressApiFp

WordPressApiFp(configuration?: Configuration): { sitesSiteIdWordpressSiteCheckWpSetupNotificationIdGet: any; sitesSiteIdWordpressSiteErrorsGet: any; sitesSiteIdWordpressSiteStartPost: any; sitesSiteIdWordpressSiteStopPost: any }

- Defined in api.ts:12557
WordPressApi - functional programming interface

export

Parameters
- Optional configuration: Configuration
Returns { sitesSiteIdWordpressSiteCheckWpSetupNotificationIdGet: any; sitesSiteIdWordpressSiteErrorsGet: any; sitesSiteIdWordpressSiteStartPost: any; sitesSiteIdWordpressSiteStopPost: any }
- sitesSiteIdWordpressSiteCheckWpSetupNotificationIdGet: function
  - sitesSiteIdWordpressSiteCheckWpSetupNotificationIdGet(siteId: string, notificationId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
  - - Defined in api.ts:12567
    Start WordPress
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - notificationId: string
      
      Notification ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
- sitesSiteIdWordpressSiteErrorsGet: function
  - sitesSiteIdWordpressSiteErrorsGet(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>
  - - Defined in api.ts:12577
    Get errors of WordPress container
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>
- sitesSiteIdWordpressSiteStartPost: function
  - sitesSiteIdWordpressSiteStartPost(siteId: string, request?: InlineObject4, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse201>>
  - - Defined in api.ts:12588
    Start WordPress
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional request: InlineObject4
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse201>>
- sitesSiteIdWordpressSiteStopPost: function
  - sitesSiteIdWordpressSiteStopPost(siteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2011>>
  - - Defined in api.ts:12598
    Stop WordPress
    
    throws
    
    {RequiredError}
    
    Parameters
    - siteId: string
      
      Site ID
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2011>>

Index

Enumerations

Classes

Interfaces

Functions

Functions

Const AccountApiAxiosParamCreator

Parameters

Optional configuration: Configuration

accountAvailablePost: (options?: any) => Promise<RequestArgs>

Parameters

options: any = {}

Returns Promise<RequestArgs>

accountDelete: (options?: any) => Promise<RequestArgs>

Parameters

options: any = {}

Returns Promise<RequestArgs>

accountInvoiceAddressPost: (request?: InlineObject27, options?: any) => Promise<RequestArgs>

Parameters

Optional request: InlineObject27

options: any = {}

Returns Promise<RequestArgs>

accountLogAuthEventsGet: (maxResults?: number, options?: any) => Promise<RequestArgs>

Parameters

Optional maxResults: number

options: any = {}

Returns Promise<RequestArgs>

accountNotificationEmailSynchronizationPost: (options?: any) => Promise<RequestArgs>

Parameters

options: any = {}

Returns Promise<RequestArgs>

accountNotificationTargetPost: (target: "email", request?: InlineObject26, options?: any) => Promise<RequestArgs>

Parameters

target: "email"

Optional request: InlineObject26

options: any = {}

Returns Promise<RequestArgs>

Const AccountApiFactory

Parameters

Optional configuration: Configuration

Optional basePath: string

Optional axios: AxiosInstance

Returns { accountAvailablePost: any; accountDelete: any; accountInvoiceAddressPost: any; accountLogAuthEventsGet: any; accountNotificationEmailSynchronizationPost: any; accountNotificationTargetPost: any }

accountAvailablePost: function

Parameters

Optional options: any

Returns AxiosPromise<InlineResponse2015>

accountDelete: function

Parameters

Optional options: any

Returns AxiosPromise<void>

accountInvoiceAddressPost: function

Parameters

Optional request: InlineObject27

Optional options: any

Returns AxiosPromise<void>

accountLogAuthEventsGet: function

Parameters

Optional maxResults: number

Optional options: any

Returns AxiosPromise<InlineResponse20012[]>

accountNotificationEmailSynchronizationPost: function

Parameters

Optional options: any

Returns AxiosPromise<void>

accountNotificationTargetPost: function

Parameters

target: "email"

Optional request: InlineObject26

Optional options: any

Returns AxiosPromise<void>

Const AccountApiFp

Parameters

Optional configuration: Configuration

Returns { accountAvailablePost: any; accountDelete: any; accountInvoiceAddressPost: any; accountLogAuthEventsGet: any; accountNotificationEmailSynchronizationPost: any; accountNotificationTargetPost: any }

accountAvailablePost: function

Parameters

Optional options: any

Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2015>>

accountDelete: function