File

src/sites/sites.interface.ts

Properties

cf_domain
cf_domain: string
Type : string

CloudFront Domain',

create_time
create_time: string
Type : string

The time of created the site',

ID
ID: string
Type : string

Site ID',

is_trial
is_trial: boolean
Type : boolean

Trial site flag

plan_id
plan_id: string
Type : string

Subscribing plan id',

service_state
service_state: string
Type : string

service status

site_name
site_name: string
Type : string

The name of the site',

site_owner
site_owner: string
Type : string

Site owner name',

subscription_id
subscription_id: string
Type : string

Subscription id',

wp_url
wp_url: string
Type : string

WordPress site URL',

export interface SiteListItem {
  /**
   * Site ID',
   */
  ID: string;

  /**
   * Site owner name',
   */
  site_owner: string;

  /**
   * The name of the site',
   */
  site_name: string;

  /**
   * Subscribing plan id',
   */
  plan_id: string;

  /**
   * Subscription id',
   */
  subscription_id?: string;

  /**
   * The time of created the site',
   */
  create_time: string;

  /**
   * WordPress site URL',
   */
  wp_url: string;

  /**
   * CloudFront Domain',
   */
  cf_domain: string;

  /**
   * service status
   **/
  service_state: string;

  /**
   * Trial site flag
   **/
  is_trial: boolean;
}

/**
 * Site List items
 */
export type SiteListItems = Array<SiteListItem>;

/**
 * Retrieve Site item
 */
export interface SiteItem extends SiteListItem {
  container_status: string;
  container_service_status: string;
}

/**
 * Site creation request options
 */
export interface SiteCreateOptions {
  /**
   * Name of site
   */
  site_name: string;

  /**
   * subscription id
   */
  subscription_id?: string;

  /**
   * subscribed id
   */
  plan_id?: string;
}

export interface SiteUpdateNameOptions {
  site_name: string;
}

/**
 * Site deleting request options
 */
export interface SiteDeleteOptions {
  /**
   * If you keep the subscription, should be true
   */
  remain_subscription?: boolean;
}

results matching ""

    No results matching ""