@paynow-gg/typescript-sdk 2.1.1 → 2.1.2

package/dist/cjs/generated/management/types.d.ts

@@ -5668,14 +5668,29 @@ export interface SetDiscordActionDto {
     role_id?: FlakeId;
     message?: string | null;
 }
+/**
+ * Represents a request to attach a custom domain to a webstore.
+ */
 export interface SetWebstoreCustomDomainRequestDto {
+    /**
+     * The domain to serve the webstore from, without a scheme (e.g., store.example.com).
+     */
     domain: string;
     verification_type: WebstoreCustomDomainVerificationTypeDto;
 }
+/**
+ * Represents a request to set the template a webstore renders.
+ */
 export interface SetWebstoreDefaultTemplateRequestDto {
     template_id: FlakeId;
 }
+/**
+ * Represents a request to change the slug a webstore is served from.
+ */
 export interface SetWebstoreSlugRequestDto {
+    /**
+     * The new slug to serve the webstore from. Slugs are unique across all webstores.
+     */
     slug: string;
 }
 export interface StartDataMigrationFromTebexRequestDto {
@@ -8347,49 +8362,160 @@ export interface WebhookVariablesDto {
     event_type: WebhookEventType;
     variables: Array<string>;
 }
+/**
+ * Represents a custom domain attached to a webstore, together with the state of its ownership and
+ * SSL verification.
+ */
 export interface WebstoreCustomDomainDto {
+    /**
+     * The identifier the domain was registered under with the hosting provider.
+     */
     id: string;
+    /**
+     * The domain the webstore is served from, without a scheme (e.g., store.example.com).
+     */
     hostname: string;
+    /**
+     * The verification state of the domain as reported by the hosting provider.
+     * The domain only serves the webstore once it is active.
+     */
     status: string;
     ssl?: WebstoreCustomDomainSslDto;
     ownership_verification?: WebstoreCustomDomainOwnershipVerificationDto;
     ownership_verification_http?: WebstoreCustomDomainOwnershipVerificationHttpDto;
+    /**
+     * The errors raised by the last ownership verification attempt. Empty when the last attempt
+     * raised none.
+     */
     verification_errors: Array<string>;
     /**
+     * The date and time the domain was attached to the webstore.
      * @format date-time
      */
     created_at?: string | null;
 }
+/**
+ * Represents the DNS record that has to be published to prove ownership of a webstore's custom domain.
+ */
 export interface WebstoreCustomDomainOwnershipVerificationDto {
+    /**
+     * The kind of DNS record to publish (e.g., txt).
+     */
     type: string;
+    /**
+     * The name to publish the record under.
+     */
     name: string;
+    /**
+     * The value the record has to hold.
+     */
     value: string;
 }
+/**
+ * Represents the token file that has to be served over HTTP to prove ownership of a webstore's
+ * custom domain.
+ */
 export interface WebstoreCustomDomainOwnershipVerificationHttpDto {
+    /**
+     * The URL on the domain the token file has to be served from.
+     */
     http_url: string;
+    /**
+     * The body that URL has to return.
+     */
     http_body: string;
 }
+/**
+ * Represents the SSL certificate issued for a webstore's custom domain.
+ */
 export interface WebstoreCustomDomainSslDto {
+    /**
+     * The identifier the certificate was issued under.
+     */
     id: string;
+    /**
+     * How control of the domain is validated for the certificate (e.g., txt, http, email).
+     */
     method: string;
+    /**
+     * The state of the certificate (e.g., pending_validation, active). The domain only serves
+     * traffic over HTTPS once it is active.
+     */
     status: string;
+    /**
+     * The authority issuing the certificate, or null while one has not been chosen.
+     */
     certificate_authority?: string | null;
+    /**
+     * The records that have to be published to validate the certificate. Empty once validation no
+     * longer needs them.
+     */
     validation_records: Array<WebstoreCustomDomainSslValidationRecordDto>;
+    /**
+     * The errors raised by the last certificate validation attempt. Empty when the last attempt
+     * raised none.
+     */
     validation_errors: Array<string>;
 }
+/**
+ * Represents one record that has to be published to validate a custom domain's SSL certificate.
+ * Which fields are populated depends on the 'ssl' block's 'method'.
+ */
 export interface WebstoreCustomDomainSslValidationRecordDto {
+    /**
+     * The name to publish the DNS TXT record under, or null when validation is not by TXT record.
+     */
     txt_name?: string | null;
+    /**
+     * The value that TXT record has to hold, or null when validation is not by TXT record.
+     */
     txt_value?: string | null;
+    /**
+     * The URL on the domain the token file has to be served from, or null when validation is not
+     * over HTTP.
+     */
     http_url?: string | null;
+    /**
+     * The body that URL has to return, or null when validation is not over HTTP.
+     */
     http_body?: string | null;
+    /**
+     * The addresses a validation link can be sent to. Empty when validation is not by email.
+     */
     emails: Array<string>;
 }
+/**
+ * Specifies how ownership of a webstore's custom domain is proven.
+ * The only officially supported method is the 'http' method.
+ * - `invalid`: No verification type specified. This value is typically used as a default or uninitialized state.
+ * - `http`: Ownership is proven by serving a token file over HTTP from the domain.
+            This is the RECOMMENDED way to prove ownership, and is used by the dashboard.
+ * - `txt`: Ownership is proven by publishing a DNS TXT record on the domain.
+ * - `email`: Ownership is proven by following a link sent to an administrative address on the domain.
+ * - `cname`: Ownership is proven by publishing a DNS CNAME record on the domain.
+ */
 export type WebstoreCustomDomainVerificationTypeDto = "invalid" | "http" | "txt" | "email" | "cname";
+/**
+ * Represents a store's webstore, the hosted storefront customers browse and buy from.
+ */
 export interface WebstoreDto {
     id: FlakeId;
+    /**
+     * The slug the webstore is served from, unique across all webstores.
+     */
     slug: string;
+    /**
+     * Indicates whether the webstore is being served to customers.
+     */
     is_active: boolean;
+    /**
+     * The custom domain the webstore is served from, or null when it is only reachable at its slug.
+     */
     custom_domain?: string | null;
+    /**
+     * Indicates whether ownership of 'custom_domain' has been verified. Until it is, the webstore is
+     * only served from its slug.
+     */
     custom_domain_verified: boolean;
     current_template_id?: FlakeId;
 }