Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WordPressApi

WordPressApi - object-oriented interface

export

Hierarchy

  • BaseAPI
    • WordPressApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = ...
    • axios: AxiosInstance = ...

    Returns WordPressApi

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

sitesSiteIdWordpressSiteCheckWpSetupNotificationIdGet

  • sitesSiteIdWordpressSiteCheckWpSetupNotificationIdGet(siteId: string, notificationId: string, options?: any): Promise<AxiosResponse<string>>

  • Start WordPress

    throws

    {RequiredError}

    memberof

    WordPressApi

    Parameters

    • siteId: string

      Site ID

    • notificationId: string

      Notification ID

    • Optional options: any

    Returns Promise<AxiosResponse<string>>

sitesSiteIdWordpressSiteErrorsGet

  • sitesSiteIdWordpressSiteErrorsGet(siteId: string, options?: any): Promise<AxiosResponse<InlineResponse200>>

  • Get errors of WordPress container

    throws

    {RequiredError}

    memberof

    WordPressApi

    Parameters

    • siteId: string

      Site ID

    • Optional options: any

    Returns Promise<AxiosResponse<InlineResponse200>>

sitesSiteIdWordpressSiteStartPost

  • Start WordPress

    throws

    {RequiredError}

    memberof

    WordPressApi

    Parameters

    • siteId: string

      Site ID

    • Optional request: InlineObject4
    • Optional options: any

    Returns Promise<AxiosResponse<InlineResponse201>>

sitesSiteIdWordpressSiteStopPost

  • sitesSiteIdWordpressSiteStopPost(siteId: string, options?: any): Promise<AxiosResponse<InlineResponse2011>>

  • Stop WordPress

    throws

    {RequiredError}

    memberof

    WordPressApi

    Parameters

    • siteId: string

      Site ID

    • Optional options: any

    Returns Promise<AxiosResponse<InlineResponse2011>>

Generated using TypeDoc