SDK: WebsitesClient

This page is auto-generated from TypeDoc. Do not edit directly. To update, modify the TypeScript source in @lumeweb/pinner and run pnpm generate:sdk.

Client for managing websites hosted on IPFS with custom domains and SSL.

Constructor

new WebsitesClient(config: PinnerConfig)

Parameter	Type	Description
`config`	`PinnerConfig`	SDK configuration

Methods

Method	Returns	Description
`listWebsites(options)`	`Promise<WebsiteItemResponse>`	List all websites.
`createWebsite(request, options)`	`Promise<WebsiteResponse>`	Create a new website.
`getWebsite(id, options)`	`Promise<WebsiteResponse>`	Get website details by ID.
`updateWebsite(id, request, options)`	`Promise<WebsiteResponse>`	Update a website's configuration.
`deleteWebsite(id, options)`	`Promise<void>`	Delete a website by ID.
`validateWebsite(id, options)`	`Promise<WebsiteValidateResponse>`	Validate a website's DNS and SSL configuration.
`getSSLStatus(domain, options)`	`Promise<SSLStatusInfo>`	Check the SSL certificate status for a domain.
`getWebsiteConfig(options)`	`Promise<WebsiteConfigResponse>`	Get the global website configuration.
`watchSSL(domain, options)`	`SSLWatcher`	Watch SSL status until provisioned, failed, or timed out.

`listWebsites(options?)`

listWebsites(options?: WebsitesClientOptions): Promise<WebsiteItemResponse>

List all websites.

Parameters:

Name	Type	Description
`options`	`WebsitesClientOptions`	Request options optional

Returns: Promise<WebsiteItemResponse>

`createWebsite(request, options?)`

createWebsite(request: WebsiteRequest, options?: WebsitesClientOptions): Promise<WebsiteResponse>

Create a new website.

Parameters:

Name	Type	Description
`request`	`WebsiteRequest`	Website creation parameters
`options`	`WebsitesClientOptions`	Request options optional

Returns: Promise<WebsiteResponse>

`getWebsite(id, options?)`

getWebsite(id: number, options?: WebsitesClientOptions): Promise<WebsiteResponse>

Get website details by ID.

Parameters:

Name	Type	Description
`id`	`number`	Website ID
`options`	`WebsitesClientOptions`	Request options optional

Returns: Promise<WebsiteResponse>

`updateWebsite(id, request, options?)`

updateWebsite(id: number, request: WebsiteUpdateRequest, options?: WebsitesClientOptions): Promise<WebsiteResponse>

Update a website's configuration.

Parameters:

Name	Type	Description
`id`	`number`	Website ID
`request`	`WebsiteUpdateRequest`	Update parameters
`options`	`WebsitesClientOptions`	Request options optional

Returns: Promise<WebsiteResponse>

`deleteWebsite(id, options?)`

deleteWebsite(id: number, options?: WebsitesClientOptions): Promise<void>

Delete a website by ID.

Parameters:

Name	Type	Description
`id`	`number`	Website ID
`options`	`WebsitesClientOptions`	Request options optional

Returns: Promise<void>

`validateWebsite(id, options?)`

validateWebsite(id: number, options?: WebsitesClientOptions): Promise<WebsiteValidateResponse>

Validate a website's DNS and SSL configuration.

Parameters:

Name	Type	Description
`id`	`number`	Website ID
`options`	`WebsitesClientOptions`	Request options optional

Returns: Promise<WebsiteValidateResponse>

`getSSLStatus(domain, options?)`

getSSLStatus(domain: string, options?: WebsitesClientOptions): Promise<SSLStatusInfo>

Check the SSL certificate status for a domain.

Parameters:

Name	Type	Description
`domain`	`string`	Domain name
`options`	`WebsitesClientOptions`	Request options optional

Returns: Promise<SSLStatusInfo>

`getWebsiteConfig(options?)`

getWebsiteConfig(options?: WebsitesClientOptions): Promise<WebsiteConfigResponse>

Get the global website configuration.

Parameters:

Name	Type	Description
`options`	`WebsitesClientOptions`	Request options optional

Returns: Promise<WebsiteConfigResponse>

`watchSSL(domain, options?)`

watchSSL(domain: string, options?: WatchOptions): SSLWatcher

Watch SSL status until provisioned, failed, or timed out.

Parameters:

Name	Type	Description
`domain`	`string`	Domain name
`options`	`WatchOptions`	Watch interval and timeout optional

Returns: SSLWatcher

Source: api/websites.ts