/** * Linkbreakers API * This is a documentation of all the APIs of Linkbreakers * * The version of the OpenAPI document: 1.118.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { CheckCustomDomainResponse, CreateCustomDomainRequest, CreateCustomDomainResponse, CustomDomainsServiceUpdateBody, GetCustomDomainResponse, ListCustomDomainsResponse, UpdateCustomDomainResponse, ValidationInstructionsCustomDomainResponse } from '../models/index'; export interface CustomDomainsServiceCheckRequest { id: string; } export interface CustomDomainsServiceCreateRequest { createCustomDomainRequest: CreateCustomDomainRequest; } export interface CustomDomainsServiceDeleteRequest { id: string; } export interface CustomDomainsServiceGetRequest { id: string; } export interface CustomDomainsServiceListRequest { status?: string; } export interface CustomDomainsServiceUpdateRequest { id: string; customDomainsServiceUpdateBody: CustomDomainsServiceUpdateBody; } export interface CustomDomainsServiceValidationInstructionsRequest { id: string; } /** * CustomDomainsApi - interface * * @export * @interface CustomDomainsApiInterface */ export interface CustomDomainsApiInterface { /** * Creates request options for customDomainsServiceCheck without sending the request * @param {string} id The ID of the custom domain to retrieve (UUID) * @throws {RequiredError} * @memberof CustomDomainsApiInterface */ customDomainsServiceCheckRequestOpts(requestParameters: CustomDomainsServiceCheckRequest): Promise; /** * Check a custom domain by looking up its DNS records and TLS status. This is automatically done when the domain is created. It will update the domain status. * @summary Check a custom domain * @param {string} id The ID of the custom domain to retrieve (UUID) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomDomainsApiInterface */ customDomainsServiceCheckRaw(requestParameters: CustomDomainsServiceCheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Check a custom domain by looking up its DNS records and TLS status. This is automatically done when the domain is created. It will update the domain status. * Check a custom domain */ customDomainsServiceCheck(requestParameters: CustomDomainsServiceCheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for customDomainsServiceCreate without sending the request * @param {CreateCustomDomainRequest} createCustomDomainRequest * @throws {RequiredError} * @memberof CustomDomainsApiInterface */ customDomainsServiceCreateRequestOpts(requestParameters: CustomDomainsServiceCreateRequest): Promise; /** * This endpoint allows users to register a new custom domain that can be used with their Linkbreakers workspace. * @summary Create a custom domain * @param {CreateCustomDomainRequest} createCustomDomainRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomDomainsApiInterface */ customDomainsServiceCreateRaw(requestParameters: CustomDomainsServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows users to register a new custom domain that can be used with their Linkbreakers workspace. * Create a custom domain */ customDomainsServiceCreate(requestParameters: CustomDomainsServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for customDomainsServiceDelete without sending the request * @param {string} id The ID of the custom domain to delete (UUID) * @throws {RequiredError} * @memberof CustomDomainsApiInterface */ customDomainsServiceDeleteRequestOpts(requestParameters: CustomDomainsServiceDeleteRequest): Promise; /** * Removes a custom domain from the workspace. This operation cannot be undone. * @summary Delete a custom domain * @param {string} id The ID of the custom domain to delete (UUID) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomDomainsApiInterface */ customDomainsServiceDeleteRaw(requestParameters: CustomDomainsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Removes a custom domain from the workspace. This operation cannot be undone. * Delete a custom domain */ customDomainsServiceDelete(requestParameters: CustomDomainsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for customDomainsServiceGet without sending the request * @param {string} id The ID of the custom domain to retrieve (UUID) * @throws {RequiredError} * @memberof CustomDomainsApiInterface */ customDomainsServiceGetRequestOpts(requestParameters: CustomDomainsServiceGetRequest): Promise; /** * Retrieves information about a custom domain including its verification status and timestamps. * @summary Get custom domain details * @param {string} id The ID of the custom domain to retrieve (UUID) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomDomainsApiInterface */ customDomainsServiceGetRaw(requestParameters: CustomDomainsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves information about a custom domain including its verification status and timestamps. * Get custom domain details */ customDomainsServiceGet(requestParameters: CustomDomainsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for customDomainsServiceList without sending the request * @param {string} [status] Filter by the status of the custom domains to list. Optional. - STATUS_UNSPECIFIED: The status is not specified - STATUS_INACTIVE: The domain is inactive. It was created but not checked yet. - STATUS_DOMAIN_PENDING: The domain is pending. Last time it was checked, it was not pointing to the correct Linkbreakers subdomain. - STATUS_VERIFICATION_PENDING: The domain is pending verification. Please verify through TXT record. - STATUS_CERTIFICATE_PENDING: The domain is pending certificate. The SSL certificate is not yet ready. - STATUS_ACTIVE: The domain is fully active - STATUS_RENEWAL_PENDING: The domain is still serving traffic on a valid certificate, but the renewal of that certificate cannot be validated. It stops working at certificate_expires_at. - STATUS_EXPIRED: The certificate expired or was withdrawn. The domain no longer serves HTTPS. * @throws {RequiredError} * @memberof CustomDomainsApiInterface */ customDomainsServiceListRequestOpts(requestParameters: CustomDomainsServiceListRequest): Promise; /** * Retrieves the custom domains for your workspace * @summary List custom domains * @param {string} [status] Filter by the status of the custom domains to list. Optional. - STATUS_UNSPECIFIED: The status is not specified - STATUS_INACTIVE: The domain is inactive. It was created but not checked yet. - STATUS_DOMAIN_PENDING: The domain is pending. Last time it was checked, it was not pointing to the correct Linkbreakers subdomain. - STATUS_VERIFICATION_PENDING: The domain is pending verification. Please verify through TXT record. - STATUS_CERTIFICATE_PENDING: The domain is pending certificate. The SSL certificate is not yet ready. - STATUS_ACTIVE: The domain is fully active - STATUS_RENEWAL_PENDING: The domain is still serving traffic on a valid certificate, but the renewal of that certificate cannot be validated. It stops working at certificate_expires_at. - STATUS_EXPIRED: The certificate expired or was withdrawn. The domain no longer serves HTTPS. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomDomainsApiInterface */ customDomainsServiceListRaw(requestParameters: CustomDomainsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves the custom domains for your workspace * List custom domains */ customDomainsServiceList(requestParameters: CustomDomainsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for customDomainsServiceUpdate without sending the request * @param {string} id The ID of the custom domain to update (UUID) * @param {CustomDomainsServiceUpdateBody} customDomainsServiceUpdateBody * @throws {RequiredError} * @memberof CustomDomainsApiInterface */ customDomainsServiceUpdateRequestOpts(requestParameters: CustomDomainsServiceUpdateRequest): Promise; /** * Update settings for a custom domain, such as the root destination URL. * @summary Update a custom domain * @param {string} id The ID of the custom domain to update (UUID) * @param {CustomDomainsServiceUpdateBody} customDomainsServiceUpdateBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomDomainsApiInterface */ customDomainsServiceUpdateRaw(requestParameters: CustomDomainsServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update settings for a custom domain, such as the root destination URL. * Update a custom domain */ customDomainsServiceUpdate(requestParameters: CustomDomainsServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for customDomainsServiceValidationInstructions without sending the request * @param {string} id The ID of the custom domain to retrieve (UUID) * @throws {RequiredError} * @memberof CustomDomainsApiInterface */ customDomainsServiceValidationInstructionsRequestOpts(requestParameters: CustomDomainsServiceValidationInstructionsRequest): Promise; /** * Get the instructions for validating a custom domain. There may be a delay before the instructions are available. * @summary Get the validation instructions * @param {string} id The ID of the custom domain to retrieve (UUID) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomDomainsApiInterface */ customDomainsServiceValidationInstructionsRaw(requestParameters: CustomDomainsServiceValidationInstructionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get the instructions for validating a custom domain. There may be a delay before the instructions are available. * Get the validation instructions */ customDomainsServiceValidationInstructions(requestParameters: CustomDomainsServiceValidationInstructionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class CustomDomainsApi extends runtime.BaseAPI implements CustomDomainsApiInterface { /** * Creates request options for customDomainsServiceCheck without sending the request */ customDomainsServiceCheckRequestOpts(requestParameters: CustomDomainsServiceCheckRequest): Promise; /** * Check a custom domain by looking up its DNS records and TLS status. This is automatically done when the domain is created. It will update the domain status. * Check a custom domain */ customDomainsServiceCheckRaw(requestParameters: CustomDomainsServiceCheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Check a custom domain by looking up its DNS records and TLS status. This is automatically done when the domain is created. It will update the domain status. * Check a custom domain */ customDomainsServiceCheck(requestParameters: CustomDomainsServiceCheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for customDomainsServiceCreate without sending the request */ customDomainsServiceCreateRequestOpts(requestParameters: CustomDomainsServiceCreateRequest): Promise; /** * This endpoint allows users to register a new custom domain that can be used with their Linkbreakers workspace. * Create a custom domain */ customDomainsServiceCreateRaw(requestParameters: CustomDomainsServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows users to register a new custom domain that can be used with their Linkbreakers workspace. * Create a custom domain */ customDomainsServiceCreate(requestParameters: CustomDomainsServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for customDomainsServiceDelete without sending the request */ customDomainsServiceDeleteRequestOpts(requestParameters: CustomDomainsServiceDeleteRequest): Promise; /** * Removes a custom domain from the workspace. This operation cannot be undone. * Delete a custom domain */ customDomainsServiceDeleteRaw(requestParameters: CustomDomainsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Removes a custom domain from the workspace. This operation cannot be undone. * Delete a custom domain */ customDomainsServiceDelete(requestParameters: CustomDomainsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for customDomainsServiceGet without sending the request */ customDomainsServiceGetRequestOpts(requestParameters: CustomDomainsServiceGetRequest): Promise; /** * Retrieves information about a custom domain including its verification status and timestamps. * Get custom domain details */ customDomainsServiceGetRaw(requestParameters: CustomDomainsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves information about a custom domain including its verification status and timestamps. * Get custom domain details */ customDomainsServiceGet(requestParameters: CustomDomainsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for customDomainsServiceList without sending the request */ customDomainsServiceListRequestOpts(requestParameters: CustomDomainsServiceListRequest): Promise; /** * Retrieves the custom domains for your workspace * List custom domains */ customDomainsServiceListRaw(requestParameters: CustomDomainsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves the custom domains for your workspace * List custom domains */ customDomainsServiceList(requestParameters?: CustomDomainsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for customDomainsServiceUpdate without sending the request */ customDomainsServiceUpdateRequestOpts(requestParameters: CustomDomainsServiceUpdateRequest): Promise; /** * Update settings for a custom domain, such as the root destination URL. * Update a custom domain */ customDomainsServiceUpdateRaw(requestParameters: CustomDomainsServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update settings for a custom domain, such as the root destination URL. * Update a custom domain */ customDomainsServiceUpdate(requestParameters: CustomDomainsServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for customDomainsServiceValidationInstructions without sending the request */ customDomainsServiceValidationInstructionsRequestOpts(requestParameters: CustomDomainsServiceValidationInstructionsRequest): Promise; /** * Get the instructions for validating a custom domain. There may be a delay before the instructions are available. * Get the validation instructions */ customDomainsServiceValidationInstructionsRaw(requestParameters: CustomDomainsServiceValidationInstructionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get the instructions for validating a custom domain. There may be a delay before the instructions are available. * Get the validation instructions */ customDomainsServiceValidationInstructions(requestParameters: CustomDomainsServiceValidationInstructionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }