Class SiteEndpoint

Hierarchy

SiteEndpoint

Index

Constructors

constructor

Properties

client

Methods

Constructors

constructor

new SiteEndpoint(client: BegetRequest): SiteEndpoint

- Defined in src/endpoints/site.ts:5
Parameters
- client: BegetRequest
Returns SiteEndpoint

Properties

Private Readonly client

client: BegetRequest

Methods

add

add(name: string): Promise<boolean>

- Defined in src/endpoints/site.ts:30
Method creates new website with given name.

Parameters
- name: string
  
  name of directory with website (e.g. site.de);
Returns Promise<boolean>

Returns property of successful or unsuccessful execution. In case of a successful response the full path to directory with website will be name/public_html.

delete

delete(params: Pick<Website, "id">): Promise<boolean>

- Defined in src/endpoints/site.ts:39
Method deletes website. If domains were linked to the website, they will be unlinked from it.

Parameters
- params: Pick<Website, "id">
Returns Promise<boolean>

Returns property of successful or unsuccessful execution.

freeze

freeze(params: FreezeOptions): Promise<boolean>

- Defined in src/endpoints/site.ts:67
The method prohibits changing site files.

Parameters
- params: FreezeOptions
Returns Promise<boolean>

Returns property of successful or unsuccessful execution. Upon operation performance, the website will begin to open under the domain name within 5-10 minutes.

getList

getList(): Promise<Website[]>

- Defined in src/endpoints/site.ts:19
Method returns website list. If domains are linked to it, they will also be returned.

Returns Promise<Website[]>

isSiteFrozen

isSiteFrozen(params: Pick<LinkDomain, "site_id">): Promise<boolean>

- Defined in src/endpoints/site.ts:83
The method returns the current status of the site, whether file editing is available.

Parameters
- params: Pick<LinkDomain, "site_id">
Returns Promise<boolean>

linkDomain

linkDomain(params: LinkDomain): Promise<boolean>

- Defined in src/endpoints/site.ts:49
Method links domain to website.

Parameters
- params: LinkDomain
Returns Promise<boolean>

Returns property of successful or unsuccessful execution. Upon operation performance, the website will begin to open under the domain name within 5-10 minutes.

Private method

method<T>(method: Methods["site"], data?: object): Promise<T>

- Defined in src/endpoints/site.ts:11
Type parameters
- T
Parameters
- method: Methods["site"]
- Optional data: object
Returns Promise<T>

unfreeze

unfreeze(params: Pick<Website, "id">): Promise<boolean>

- Defined in src/endpoints/site.ts:76
The method allows changing site files.

Parameters
- params: Pick<Website, "id">
Returns Promise<boolean>

Returns property of successful or unsuccessful execution. Upon operation performance, the website will begin to open under the domain name within 5-10 minutes.

unlinkDomain

unlinkDomain(params: Pick<LinkDomain, "domain_id">): Promise<boolean>

- Defined in src/endpoints/site.ts:57
Method unlinks domain.

Parameters
- params: Pick<LinkDomain, "domain_id">
Returns Promise<boolean>

Returns property of successful or unsuccessful execution.

Generated using TypeDoc