@paynow-gg/typescript-sdk 2.1.3 → 2.1.5

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

@@ -108,6 +108,10 @@ export interface AbandonedCheckoutStoreConfigurationUpdateDto {
     commands: Array<AbandonedCheckoutStoreConfigurationUpdateCommandDto>;
     coupon_configuration: MarketingCouponConfigurationDto;
 }
+/**
+ * Represents the actor that performed an action, such as the user, API key or game server that
+ * created or changed a record.
+ */
 export interface ActorDto {
     type: PayNowActorType;
     id?: FlakeId;
@@ -298,29 +302,51 @@ export interface BancontactDetailsDto {
      */
     payer_name?: string | null;
 }
+/**
+ * Represents a ban that blocks customers matching any of its identities from purchasing in the store.
+ */
 export interface BanDto {
     id: FlakeId;
     store_id: FlakeId;
+    /**
+     * The reason recorded for the ban.
+     */
     reason: string;
+    /**
+     * Indicates whether the ban is currently enforced.
+     */
     enabled: boolean;
+    /**
+     * The identities the ban applies to. A customer matching any one of them is banned.
+     */
     identities: Array<BanIdentityDto>;
     created_by: ActorDto;
     /**
+     * The date and time the ban was created.
      * @format date-time
      */
     created_at: string;
     /**
+     * The date and time the ban was last updated, or null when it has never been updated.
      * @format date-time
      */
     updated_at?: string | null;
     updated_by?: ActorDto;
     /**
+     * The date and time the ban lifts, or null when the ban is permanent.
      * @format date-time
      */
     expires_at?: string | null;
 }
+/**
+ * Represents one identity a ban applies to.
+ */
 export interface BanIdentityDto {
     ban_type: BanType;
+    /**
+     * The value to match for 'ban_type': the Steam ID, IP address, customer ID, customer name or
+     * email address respectively.
+     */
     ban_type_value: string;
 }
 export interface BanResult {
@@ -360,34 +386,6 @@ export type BansGetBansQuery = {
     asc?: boolean;
 };
 export type BanType = "unknown" | "steam" | "ip" | "customer" | "customer_name" | "email";
-/**
- * Query parameters
- */
-export type BillingGetStoreBillingOrdersQuery = {
-    /**
-     * The maximum number of items to return in a single request.
-     * @format int32
-     * @minimum 1
-     * @maximum 100
-     */
-    limit?: number;
-    /**
-     * Returns items after the specified ID.
-     * Used for forward pagination through results.
-     */
-    after?: FlakeId;
-    /**
-     * Returns items before the specified ID.
-     * Used for backward pagination through results.
-     */
-    before?: FlakeId;
-    /**
-     * Determines the sort order of returned items.
-     * When true, items are returned in ascending order.
-     * When false, items are returned in descending order.
-     */
-    asc?: boolean;
-};
 export interface CancelSubscriptionRequestDto {
     /**
      * Should the subscription be cancelled immediately (false) or on the next billing period (true)?
@@ -564,19 +562,52 @@ export interface CheckoutSessionDto {
      */
     requires_payment: boolean;
 }
+/**
+ * Represents the styling applied to the store's hosted checkout.
+ */
 export interface CheckoutStyleDto {
     store_id: FlakeId;
+    /**
+     * The CSS font family used for text on the checkout, or null to use the default font.
+     */
     font_family?: string | null;
     /**
+     * The corner radius applied to buttons, inputs and panels on the checkout, in pixels, or null to
+     * use the default radius.
      * @format int32
      */
     border_radius?: number | null;
+    /**
+     * The accent colour used for primary buttons and highlights, as a CSS colour value, or null to
+     * use the default.
+     */
     color_primary?: string | null;
+    /**
+     * The background colour of panels and cards on the checkout, as a CSS colour value, or null to
+     * use the default.
+     */
     color_elements?: string | null;
+    /**
+     * The background colour of input fields, as a CSS colour value, or null to use the default.
+     */
     color_input?: string | null;
+    /**
+     * The background colour of the checkout page, as a CSS colour value, or null to use the default.
+     */
     color_background?: string | null;
+    /**
+     * The colour of text on the checkout, as a CSS colour value, or null to use the default.
+     */
     color_text?: string | null;
+    /**
+     * The colour of borders and outlines on the checkout, as a CSS colour value, or null to use the
+     * default.
+     */
     color_outline?: string | null;
+    /**
+     * The URL of the image shown behind the checkout, or null when none has been uploaded. It cannot
+     * be set directly; upload an image through the background image endpoints instead.
+     */
     url_background?: string | null;
 }
 export interface CommandAttemptDto {
@@ -646,7 +677,9 @@ export interface CouponDto {
     duration_in_intervals?: number | null;
     discount_type: CouponDiscountTypeDto;
     /**
-     * The discount amount in the smallest currency unit (e.g., cents).
+     * The discount amount, interpreted based on discount type: for a fixed-amount
+     * discount, this is in the smallest currency unit (e.g., cents); for a
+     * percentage discount, this is in tenths of a percent (e.g., 100 = 10.0% off).
      * @format int64
      */
     discount_amount: number;
@@ -750,7 +783,7 @@ export interface CouponResult {
 /**
  * Query parameters
  */
-export type CouponsGetCouponsForStoreQuery = {
+export type CouponsGetCouponsQuery = {
     /**
      * The maximum number of items to return in a single request.
      * @format int32
@@ -788,26 +821,51 @@ export type CouponsGetCouponsForStoreQuery = {
     usable_by_customer_id?: FlakeId;
 };
 export interface CreateAffiliateLinkDto {
+    /**
+     * The identifier of the wallet that receives the affiliate commission payouts.
+     */
     wallet_id: string;
+    /**
+     * Indicates whether the affiliate link is enabled.
+     */
     enabled: boolean;
+    /**
+     * The unique code associated with the affiliate link.
+     */
     code: string;
     referer_type: AffiliateLinkRefererTypeDto;
     /**
+     * The number of days a customer's referral is tracked after following the affiliate link.
      * @format int32
      */
     tracking_length_days: number;
+    /**
+     * Whether the affiliate earns commission on subscription renewals.
+     * Must be enabled for 'commission_amount_steps' past the first cycle to apply - when disabled, only the initial purchase earns commission.
+     */
     apply_for_subscriptions: boolean;
     discount_type: AffiliateLinkDiscountTypeDto;
     /**
+     * The discount amount, in the smallest currency unit (e.g., cents) for fixed discounts, or tenths of a percent (e.g., 125 = 12.5%) for percentage discounts.
      * @format int64
      */
     discount_amount: number;
     commission_type: AffiliateLinkCommissionTypeDto;
     /**
+     * The commission amount, in tenths of a percent (e.g., 125 = 12.5%) for percentage commissions.
      * @format int64
      */
     commission_amount: number;
+    /**
+     * Per-cycle commission overrides. Requires 'apply_for_subscriptions' to be enabled for billing cycles past 1.
+     * When empty, the base commission amount applies to every renewal. When steps are defined, each renewal cycle pays its matching steps amount.
+     * Cycles without a matching step earn no commission, except cycles past the last step when 'last_commission_amount_step_repeats' is true.
+     */
     commission_amount_steps: Array<AffiliateLinkCommissionAmountStepDto>;
+    /**
+     * Whether the last commission amount steps rate continues to apply to all billing cycles past the last step.
+     * When false, cycles past the last step earn no commission.
+     */
     last_commission_amount_step_repeats: boolean;
 }
 /**
@@ -951,65 +1009,135 @@ export interface CreateCheckoutSessionResponseDto {
     url: string;
 }
 export interface CreateCheckoutStyleDto {
+    /**
+     * The CSS font family used for text on the checkout, or null to use the default font.
+     */
     font_family?: string;
     /**
+     * The corner radius applied to buttons, inputs and panels on the checkout, in pixels, or null to
+     * use the default radius.
      * @format int32
      */
-    border_radius?: number | null;
+    border_radius?: number;
+    /**
+     * The accent colour used for primary buttons and highlights, as a CSS colour value, or null to
+     * use the default.
+     */
     color_primary?: string;
+    /**
+     * The background colour of panels and cards on the checkout, as a CSS colour value, or null to
+     * use the default.
+     */
     color_elements?: string;
+    /**
+     * The background colour of input fields, as a CSS colour value, or null to use the default.
+     */
     color_input?: string;
+    /**
+     * The background colour of the checkout page, as a CSS colour value, or null to use the default.
+     */
     color_background?: string;
+    /**
+     * The colour of text on the checkout, as a CSS colour value, or null to use the default.
+     */
     color_text?: string;
+    /**
+     * The colour of borders and outlines on the checkout, as a CSS colour value, or null to use the
+     * default.
+     */
     color_outline?: string;
 }
 export interface CreateCouponDto {
+    /**
+     * Indicates whether the coupon is enabled.
+     */
     enabled: boolean;
+    /**
+     * The unique code associated with the coupon.
+     */
     code: string;
+    /**
+     * A note or internal description of the coupon.
+     */
     note?: string;
     duration: CouponDurationDto;
     /**
+     * The number of months the coupon is valid for, used if the duration is repeating.
      * @format int32
+     * @deprecated
      */
-    duration_in_months?: number | null;
+    duration_in_months?: number;
     /**
+     * The number of subscription renewals the coupon is valid for, used if the duration is repeating.
      * @format int32
      */
-    duration_in_intervals?: number | null;
+    duration_in_intervals?: number;
     discount_type: CouponDiscountTypeDto;
     /**
+     * The discount amount, interpreted based on discount type: for a fixed-amount
+     * discount, this is in the smallest currency unit (e.g., cents); for a
+     * percentage discount, this is in tenths of a percent (e.g., 100 = 10.0% off).
      * @format int64
      */
     discount_amount: number;
+    /**
+     * Indicates whether the discount should be applied individually to required tags or products.
+     */
     discount_apply_individually: boolean;
+    /**
+     * Indicates whether the discount is applied before existing sales.
+     */
     discount_apply_before_sales: boolean;
+    /**
+     * A list of product IDs the coupon applies to.
+     */
     apply_to_products?: Array<FlakeId>;
+    /**
+     * A list of tag IDs the coupon applies to.
+     */
     apply_to_tags?: Array<FlakeId>;
     usable_by_customer_id?: FlakeId;
     /**
+     * The minimum order value required to use the coupon.
      * @format int64
      */
     minimum_order_value: number;
+    /**
+     * Indicates whether a global redemption limit is enabled.
+     */
     redeem_limit_store_enabled: boolean;
     /**
+     * The maximum number of times the coupon can be redeemed across the store.
      * @format int64
      */
     redeem_limit_store_amount: number;
+    /**
+     * Indicates whether a per-customer redemption limit is enabled.
+     */
     redeem_limit_customer_enabled: boolean;
     /**
+     * The maximum number of times the coupon can be redeemed per customer.
      * @format int64
      */
     redeem_limit_customer_amount: number;
+    /**
+     * Indicates whether the coupon can be used for one-time purchases.
+     */
     usable_on_one_time_purchase: boolean;
+    /**
+     * Indicates whether the coupon can be used for subscriptions.
+     */
     usable_on_subscription: boolean;
     /**
+     * The date and time when the coupon becomes valid.
      * @format date-time
      */
-    usable_at?: string | null;
+    usable_at?: string;
     /**
+     * The date and time when the coupon expires.
      * @format date-time
      */
-    expires_at?: string | null;
+    expires_at?: string;
 }
 /**
  * Request to create a new customer portal session from your back-end server using the management API
@@ -1037,47 +1165,89 @@ export interface CreateEmailTemplateDto {
 }
 export interface CreateGameServerConsoleDto {
     type: GameServerConsoleTypeDto;
+    /**
+     * Indicates whether PayNow keeps the connection to the console open.
+     */
     enabled: boolean;
+    /**
+     * The hostname or IP address the game server's console listens on.
+     */
     host: string;
     /**
+     * The port the game server's console listens on.
      * @format int32
      */
     port: number;
+    /**
+     * The password used to authenticate with the console, or null when it requires none.
+     */
     password?: string;
+    /**
+     * Indicates whether the connection is made over TLS.
+     */
     secure: boolean;
 }
 export interface CreateGameServerDto {
+    /**
+     * The display name of the game server.
+     */
     name: string;
+    /**
+     * Indicates whether the game server is currently enabled.
+     */
     enabled: boolean;
 }
 export interface CreateGiftCardDto {
+    /**
+     * Indicates whether the gift card is currently enabled and can be used.
+     */
     enabled: boolean;
+    /**
+     * The unique code that customers use to redeem the gift card.
+     * @example "GIFT-2024-ABCD1234"
+     */
     code: string;
+    /**
+     * Optional note or description associated with the gift card.
+     */
     note?: string;
     /**
+     * The current balance remaining on the gift card in cents.
      * @format int64
+     * @example 2500
      */
     balance: number;
     /**
+     * The date and time when the gift card becomes usable.
      * @format date-time
      */
     usable_at: string;
     /**
+     * The date and time when the gift card expires, if applicable.
      * @format date-time
      */
-    expires_at?: string | null;
+    expires_at?: string;
 }
 export interface CreateInviteDto {
     role_id: FlakeId;
+    /**
+     * The email address the invite was sent to.
+     */
     user_email: string;
 }
 export interface CreateNavLinkDto {
     tag_id: FlakeId;
+    /**
+     * The 'node_id' of the link this one nests under, or null when it sits at the top level of the
+     * navigation.
+     */
     parent_node_id?: string;
     /**
+     * The position of the link among its siblings, lowest first, or null when no explicit order has
+     * been set.
      * @format int32
      */
-    order?: number | null;
+    order?: number;
 }
 export interface CreateProductDependentMigrationRequestDto {
     send_new_commands_to_all_servers: boolean;
@@ -1098,53 +1268,120 @@ export interface CreateRoleDto {
     permissions?: Record<string, boolean>;
 }
 export interface CreateSaleDto {
+    /**
+     * Indicates whether the sale is enabled.
+     */
     enabled: boolean;
+    /**
+     * The name of the sale.
+     */
     name: string;
     discount_type: SaleDiscountTypeDto;
     /**
+     * The discount value. For percent discounts, this represents the percentage
+     * multiplied by 10 (e.g., 250 = 25%). For amount discounts, this represents
+     * the value in the smallest currency unit (e.g., cents).
      * @format int32
      */
     discount_amount: number;
     duration: SaleDurationDto;
     /**
+     * The number of subscription intervals the coupon is valid for, used if the duration is repeating.
      * @format int32
      */
     duration_in_intervals: number;
+    /**
+     * A list of product IDs the sale applies to.
+     */
     apply_to_product_ids: Array<FlakeId>;
+    /**
+     * A list of tag IDs the sale applies to.
+     */
     apply_to_tag_ids: Array<FlakeId>;
     /**
+     * The minimum order value required to apply the sale, in the smallest currency unit (e.g., cents).
      * @format int32
      */
     minimum_order_value: number;
     /**
+     * The date and time when the sale begins.
      * @format date-time
      */
     begins_at: string;
     /**
+     * The date and time when the sale ends.
      * @format date-time
      */
-    ends_at?: string | null;
+    ends_at?: string;
 }
 export interface CreateStoreDto {
+    /**
+     * The URL-safe slug used to identify the store (e.g. "my-rust-server").
+     */
     slug: string;
+    /**
+     * The display name of the store.
+     */
     name: string;
+    /**
+     * The platform this store is associated with (e.g. "rust", "minecraft").
+     */
     platform: string;
+    /**
+     * Alias for 'platform'. Returns the platform identifier as a game name.
+     */
     game: string;
+    /**
+     * The ISO 4217 currency code used by this store for pricing (e.g. "usd", "eur")
+     */
     currency: string;
+    /**
+     * A human-readable description of the store shown to customers and PayNow.
+     */
     description: string;
+    /**
+     * The store's public website URL.
+     */
     website_url?: string;
+    /**
+     * General contact email address for the store.
+     */
     contact_email?: string;
+    /**
+     * Dedicated support email address for customer inquiries.
+     */
     support_email?: string;
+    /**
+     * URL to the store's support portal or help page.
+     */
     support_url?: string;
+    /**
+     * The integration type used by the store.
+     */
     integration_type?: string;
+    /**
+     * Username prefix used to identify Minecraft Bedrock players (e.g. ".").
+     */
     minecraft_bedrock_username_prefix?: string;
 }
 export interface CreateStorePaymentSettingsDto {
+    /**
+     * Whether to show all available payment methods for subscription purchases.
+     */
     show_all_payment_methods_for_subscriptions: boolean;
+    /**
+     * Whether store pricing is tax-inclusive.
+     */
     store_tax_inclusive_pricing: boolean;
     block_prepaid_cards: PrepaidCardsBlockingTypeDto;
     promo_code_stacking_behavior: StorePromoCodeStackingBehaviorDto;
+    /**
+     * Whether the 'Adaptive Currency' feature is enabled.
+     */
     adaptive_currency_enabled: boolean;
+    /**
+     * Whether the displayed currency on the storefront should be the Adaptive Currency by default.
+     */
     show_adaptive_currency_on_storefront: boolean;
 }
 export interface CreateStoreUpsellSettingsDto {
@@ -1168,9 +1405,13 @@ export interface CreateTierGroupRequestDto {
 export interface CreateTrialEligibilityOverrideDto {
     product_id: FlakeId;
     /**
+     * The date and time when this override expires and is no longer valid.
      * @format date-time
      */
     expires_at: string;
+    /**
+     * An optional note or comment about this override.
+     */
     note?: string;
 }
 export interface CreateWebhookDto {
@@ -1183,31 +1424,68 @@ export interface CreateWebhookDto {
     discord_format?: WebhookDiscordFormatDto;
 }
 export interface CreateWebstoreModuleDto {
-    enabled: boolean;
+    /**
+     * Indicates whether the module is rendered. A disabled module keeps its settings but is not
+     * shown to customers.
+     */
+    enabled: boolean;
+    /**
+     * The kind of module. Decides which 'settings' it accepts and how the template renders it.
+     */
     type: string;
-    settings?: null;
     /**
+     * The module's type-specific configuration as a JSON object, or null when it has none.
+     */
+    settings?: unknown;
+    /**
+     * The date and time the module starts being shown, or null to show it as soon as it is enabled.
      * @format date-time
      */
-    starts_at?: string | null;
+    starts_at?: string;
     /**
+     * The date and time the module stops being shown, or null to show it indefinitely.
      * @format date-time
      */
-    ends_at?: string | null;
+    ends_at?: string;
 }
 export interface CreateWebstoreTemplateDto {
+    /**
+     * The display name of the template.
+     */
     name: string;
     compatibility_mode: WebstoreTemplateCompatibilityModeDto;
 }
 export interface CreateWebstoreTemplateFileDto {
+    /**
+     * The name of the file within the template, without an extension. The extension follows from
+     * 'content_type'.
+     */
     file_name: string;
+    /**
+     * The MIME type of the file (e.g., text/html, text/css, application/json). Decides how the file
+     * is served and whether it is public.
+     */
     content_type: string;
+    /**
+     * The text content of the file. Null when files are listed; content is only returned when a
+     * single file is fetched or the template is fetched with 'include' set to 'files'.
+     */
     content?: string;
 }
 export interface CreateWebstoreTemplateVariableDto {
+    /**
+     * The label shown for the variable in the editor.
+     */
     name: string;
+    /**
+     * The name the template's files reference the value by.
+     */
     variable: string;
     type: WebstoreTemplateVariableTypeDto;
+    /**
+     * The value of the variable, always stored as a string and parsed according to 'type' when the
+     * template renders.
+     */
     value: string;
 }
 /**
@@ -1551,6 +1829,17 @@ export interface CustomerStatsDto_V2 {
      */
     total_refunds: number;
 }
+export interface CustomerStatsForRangeDto_V2 {
+    customer_id: FlakeId;
+    total_spend_gross: MoneyDto_V2;
+    total_spend_net: MoneyDto_V2;
+    average_spend_gross: MoneyDto_V2;
+    average_spend_net: MoneyDto_V2;
+    /**
+     * @format int32
+     */
+    total_payments: number;
+}
 /**
  * Represents a Steam profile for a customer.
  */
@@ -1715,37 +2004,6 @@ export interface CustomVariableOptionRequestDto {
             Customers can enter numeric values (subject to validation).
  */
 export type CustomVariableType = "dropdown" | "text" | "number";
-/**
- * Query parameters
- */
-export type DashboardSearchDashboardQuery = {
-    query?: string;
-    search_hints?: Record<string, string>;
-    search_result_type?: DashboardSearchResultTypeDto;
-    /**
-     * The maximum number of items to return in a single request.
-     * @format int32
-     * @minimum 1
-     * @maximum 100
-     */
-    limit?: number;
-    /**
-     * Returns items after the specified ID.
-     * Used for forward pagination through results.
-     */
-    after?: FlakeId;
-    /**
-     * Returns items before the specified ID.
-     * Used for backward pagination through results.
-     */
-    before?: FlakeId;
-    /**
-     * Determines the sort order of returned items.
-     * When true, items are returned in ascending order.
-     * When false, items are returned in descending order.
-     */
-    asc?: boolean;
-};
 export interface DashboardSearchHintDto {
     prefix: string;
     example: string;
@@ -1930,6 +2188,9 @@ export type DeliveryGetCustomerDeliveryItemsQuery = {
      * When false, items are returned in descending order.
      */
     asc?: boolean;
+    /**
+     * Whether to only retrieve delivery items that are currently active.
+     */
     activeOnly?: boolean;
 };
 /**
@@ -1959,6 +2220,9 @@ export type DeliveryGetGameServerDeliveryItemsQuery = {
      * When false, items are returned in descending order.
      */
     asc?: boolean;
+    /**
+     * Whether to only retrieve delivery items that are currently active.
+     */
     activeOnly?: boolean;
 };
 /**
@@ -1994,6 +2258,9 @@ export type DeliveryGetStoreDeliveryItemsQuery = {
      * When false, items are returned in descending order.
      */
     asc?: boolean;
+    /**
+     * Whether to only retrieve delivery items that are currently active.
+     */
     activeOnly?: boolean;
 };
 export interface DeliveryItemAssignmentBulkDto {
@@ -2207,6 +2474,7 @@ export interface DiscordServerRoleDto {
  */
 export type DiscordSetUserToDeliveryItemLinkQuery = {
     /**
+     * The ID of the Discord user to link.
      * @format int64
      */
     discordUserId?: number;
@@ -2223,6 +2491,27 @@ export interface DistributionTotalsDto_V2 {
     order_count: number;
     gross_volume?: MoneyDto_V2;
 }
+/**
+ * Represents one matching section of a documentation page.
+ */
+export interface DocsSearchHitDto {
+    /**
+     * The title of the page the section belongs to.
+     */
+    title: string;
+    /**
+     * The heading of the matching section within the page.
+     */
+    heading: string;
+    /**
+     * The full URL of the section on docs.paynow.gg, including the heading anchor.
+     */
+    url: string;
+    /**
+     * A short excerpt of the section text around the matching terms.
+     */
+    snippet: string;
+}
 export interface EmailBrandingDto {
     store_id: FlakeId;
     color: string;
@@ -2330,7 +2619,14 @@ export interface FinishTagImageUploadUrlRequestDto {
      */
     image_id: string;
 }
+/**
+ * Represents the result of importing an uploaded template archive into a template.
+ */
 export interface FinishWebstoreTemplateUploadResponseDto {
+    /**
+     * The names of the files in the archive that could not be imported. Empty when every file was
+     * imported.
+     */
     failed_files: Array<string>;
 }
 /**
@@ -2338,31 +2634,64 @@ export interface FinishWebstoreTemplateUploadResponseDto {
  * @example "411486491630370816"
  */
 export type FlakeId = string;
+/**
+ * Specifies the state of PayNow's connection to a game server's console.
+ * - `unknown`: The connection state is not known. This value is typically used as a default or uninitialized state.
+ * - `disconnected`: No connection is open to the console.
+ * - `connecting`: A runner is in the middle of establishing the connection.
+ * - `connected`: The connection is open and commands can be run.
+ * - `backoff`: The last connection attempt failed and the runner is waiting before trying again.
+ */
 export type GameServerConsoleConnectionStatusDto = "unknown" | "disconnected" | "connecting" | "connected" | "backoff";
+/**
+ * Represents the remote console connection PayNow keeps open to a game server, used to run
+ * delivery commands in game and to read the server's console output.
+ */
 export interface GameServerConsoleDto {
     game_server_id: FlakeId;
     store_id: FlakeId;
     type: GameServerConsoleTypeDto;
+    /**
+     * Indicates whether PayNow keeps the connection to the console open.
+     */
     enabled: boolean;
+    /**
+     * The identifier of the PayNow runner currently holding the connection, or empty when none has
+     * been assigned.
+     */
     assigned_runner_id: string;
     connection_status: GameServerConsoleConnectionStatusDto;
     /**
+     * The date and time the runner last reported the connection alive, or null when it has never
+     * connected.
      * @format date-time
      */
     last_heartbeat_at?: string | null;
+    /**
+     * The hostname or IP address the game server's console listens on.
+     */
     host: string;
     /**
+     * The port the game server's console listens on.
      * @format int32
      */
     port: number;
+    /**
+     * The password used to authenticate with the console, or null when it requires none.
+     */
     password?: string | null;
+    /**
+     * Indicates whether the connection is made over TLS.
+     */
     secure: boolean;
     /**
+     * The date and time the console was created.
      * @format date-time
      */
     created_at: string;
     created_by: ActorDto;
     /**
+     * The date and time the console was last updated, or null when it has never been updated.
      * @format date-time
      */
     updated_at?: string | null;
@@ -2377,6 +2706,11 @@ export interface GameServerConsoleMessageDto {
     time: string;
 }
 export type GameServerConsoleMessageTypeDto = "unknown" | "output" | "command" | "response" | "system";
+/**
+ * Specifies the console protocol a game server speaks.
+ * - `unknown`: No console type specified. This value is typically used as a default or uninitialized state.
+ * - `rust`: The WebSocket RCON console of a Rust server.
+ */
 export type GameServerConsoleTypeDto = "unknown" | "rust";
 /**
  * Represents a game server in the PayNow system with authentication tokens and linking information.
@@ -2482,10 +2816,41 @@ export interface GetTagImageUploadUrlResponseDto {
      */
     upload_url: string;
 }
+/**
+ * Represents a link to download a template's files as an archive.
+ */
 export interface GetWebstoreTemplateArchiveResponseDto {
+    /**
+     * The temporary URL the archive can be downloaded from.
+     */
     download_url: string;
 }
+/**
+ * Represents a short-lived link that renders a template preview without caching.
+ */
+export interface GetWebstoreTemplatePreviewUrlResponseDto {
+    /**
+     * The preview slug the link is keyed by.
+     */
+    slug: string;
+    /**
+     * The URL to open the preview at.
+     */
+    url: string;
+    /**
+     * The date and time the link stops working.
+     * @format date-time
+     */
+    expires_at: string;
+}
+/**
+ * Represents a pre-signed URL for uploading a template archive.
+ */
 export interface GetWebstoreTemplateUploadUrlResponseDto {
+    /**
+     * The URL to upload the archive to with an HTTP PUT. Once the upload completes, finish it through
+     * the upload finish endpoint to import the files into the template.
+     */
     upload_url: string;
 }
 /**
@@ -2784,6 +3149,12 @@ export interface InlineProductCreateDto {
     is_affiliate_links_disabled?: boolean | null;
     tier_group_id?: FlakeId;
 }
+/**
+ * Represents the result of installing a marketplace template into a store's webstore.
+ */
+export interface InstallMarketplaceTemplateResponseDto {
+    installed_template_id: FlakeId;
+}
 export interface IntervalGameServerStatsDto {
     store_id: FlakeId;
     gameserver_id: FlakeId;
@@ -3143,13 +3514,32 @@ export interface MoneyDto_V2 {
      */
     amount_minor_units: number;
 }
+/**
+ * Represents a link in the storefront's navigation. Each link points at a tag, and links nest under
+ * one another through 'parent_node_id' to form the navigation tree.
+ */
 export interface NavLinkDto {
+    /**
+     * The unique identifier of the navigation link.
+     */
     node_id: string;
     tag_id: FlakeId;
+    /**
+     * The 'node_id' of the link this one nests under, or null when it sits at the top level of the
+     * navigation.
+     */
     parent_node_id?: string | null;
+    /**
+     * The slug of the tag the link points at.
+     */
     tag_slug: string;
+    /**
+     * The text shown for the link, taken from the tag it points at.
+     */
     name: string;
     /**
+     * The position of the link among its siblings, lowest first, or null when no explicit order has
+     * been set.
      * @format int32
      */
     order?: number | null;
@@ -6695,6 +7085,54 @@ export interface StoreUpsellSettingsDto {
     updated_at: string;
     updated_by: ActorDto;
 }
+/**
+ * Represents an invoice Stripe Billing raised for the store's subscription before the store moved to PayNow.
+ */
+export interface StripeStoreInvoiceDto {
+    /**
+     * The Stripe identifier of the invoice, starting with 'in_'.
+     */
+    id: string;
+    /**
+     * The invoice number printed on the document.
+     */
+    number?: string | null;
+    /**
+     * What the invoice was raised for.
+     */
+    description?: string | null;
+    /**
+     * The lowercase ISO 4217 currency the invoice was raised in.
+     */
+    currency: string;
+    /**
+     * The invoice total in the smallest currency unit.
+     * @format int64
+     */
+    total: number;
+    /**
+     * Whether the invoice has been paid.
+     */
+    is_paid: boolean;
+    /**
+     * When the invoice was created.
+     * @format date-time
+     */
+    created_at: string;
+}
+/**
+ * Represents a page of the store's Stripe Billing invoices, newest first.
+ */
+export interface StripeStoreInvoicesDto {
+    /**
+     * The invoices on this page.
+     */
+    invoices: Array<StripeStoreInvoiceDto>;
+    /**
+     * Whether more invoices follow. Pass the last invoice's 'id' as 'starting_after' to fetch them.
+     */
+    has_more: boolean;
+}
 /**
  * Represents a billing amount breakdown for a subscription.
  */
@@ -8058,88 +8496,183 @@ export interface UnqueueCommandsResponseDto {
     unqueued_count: number;
 }
 export interface UpdateAffiliateLinkDto {
+    /**
+     * The identifier of the wallet that receives the affiliate commission payouts.
+     */
     wallet_id?: string;
+    /**
+     * Indicates whether the affiliate link is enabled.
+     */
     enabled?: boolean;
+    /**
+     * The unique code associated with the affiliate link.
+     */
     code?: string;
     referer_type?: AffiliateLinkRefererTypeDto;
     /**
+     * The number of days a customer's referral is tracked after following the affiliate link.
      * @format int32
      */
     tracking_length_days?: number;
+    /**
+     * Whether the affiliate earns commission on subscription renewals.
+     * Must be enabled for 'commission_amount_steps' past the first cycle to apply - when disabled, only the initial purchase earns commission.
+     */
     apply_for_subscriptions?: boolean;
     discount_type?: AffiliateLinkDiscountTypeDto;
     /**
+     * The discount amount, in the smallest currency unit (e.g., cents) for fixed discounts, or tenths of a percent (e.g., 125 = 12.5%) for percentage discounts.
      * @format int64
      */
     discount_amount?: number;
     commission_type?: AffiliateLinkCommissionTypeDto;
     /**
+     * The commission amount, in tenths of a percent (e.g., 125 = 12.5%) for percentage commissions.
      * @format int64
      */
     commission_amount?: number;
+    /**
+     * Per-cycle commission overrides. Requires 'apply_for_subscriptions' to be enabled for billing cycles past 1.
+     * When empty, the base commission amount applies to every renewal. When steps are defined, each renewal cycle pays its matching steps amount.
+     * Cycles without a matching step earn no commission, except cycles past the last step when 'last_commission_amount_step_repeats' is true.
+     */
     commission_amount_steps?: Array<AffiliateLinkCommissionAmountStepDto>;
+    /**
+     * Whether the last commission amount steps rate continues to apply to all billing cycles past the last step.
+     * When false, cycles past the last step earn no commission.
+     */
     last_commission_amount_step_repeats?: boolean;
 }
 export interface UpdateCheckoutStyleDto {
+    /**
+     * The CSS font family used for text on the checkout, or null to use the default font.
+     */
     font_family?: string;
     /**
+     * The corner radius applied to buttons, inputs and panels on the checkout, in pixels, or null to
+     * use the default radius.
      * @format int32
      */
-    border_radius?: number | null;
+    border_radius?: number;
+    /**
+     * The accent colour used for primary buttons and highlights, as a CSS colour value, or null to
+     * use the default.
+     */
     color_primary?: string;
+    /**
+     * The background colour of panels and cards on the checkout, as a CSS colour value, or null to
+     * use the default.
+     */
     color_elements?: string;
+    /**
+     * The background colour of input fields, as a CSS colour value, or null to use the default.
+     */
     color_input?: string;
+    /**
+     * The background colour of the checkout page, as a CSS colour value, or null to use the default.
+     */
     color_background?: string;
+    /**
+     * The colour of text on the checkout, as a CSS colour value, or null to use the default.
+     */
     color_text?: string;
+    /**
+     * The colour of borders and outlines on the checkout, as a CSS colour value, or null to use the
+     * default.
+     */
     color_outline?: string;
 }
 export interface UpdateCouponDto {
+    /**
+     * Indicates whether the coupon is enabled.
+     */
     enabled?: boolean;
+    /**
+     * The unique code associated with the coupon.
+     */
     code?: string;
+    /**
+     * A note or internal description of the coupon.
+     */
     note?: string;
     duration?: CouponDurationDto;
     /**
+     * The number of months the coupon is valid for, used if the duration is repeating.
      * @format int32
+     * @deprecated
      */
-    duration_in_months?: number | null;
+    duration_in_months?: number;
     /**
+     * The number of subscription renewals the coupon is valid for, used if the duration is repeating.
      * @format int32
      */
-    duration_in_intervals?: number | null;
+    duration_in_intervals?: number;
     discount_type?: CouponDiscountTypeDto;
     /**
+     * The discount amount, interpreted based on discount type: for a fixed-amount
+     * discount, this is in the smallest currency unit (e.g., cents); for a
+     * percentage discount, this is in tenths of a percent (e.g., 100 = 10.0% off).
      * @format int64
      */
     discount_amount?: number;
+    /**
+     * Indicates whether the discount should be applied individually to required tags or products.
+     */
     discount_apply_individually?: boolean;
+    /**
+     * Indicates whether the discount is applied before existing sales.
+     */
     discount_apply_before_sales?: boolean;
+    /**
+     * A list of product IDs the coupon applies to.
+     */
     apply_to_products?: Array<FlakeId>;
+    /**
+     * A list of tag IDs the coupon applies to.
+     */
     apply_to_tags?: Array<FlakeId>;
     usable_by_customer_id?: FlakeId;
     /**
+     * The minimum order value required to use the coupon.
      * @format int64
      */
     minimum_order_value?: number;
+    /**
+     * Indicates whether a global redemption limit is enabled.
+     */
     redeem_limit_store_enabled?: boolean;
     /**
+     * The maximum number of times the coupon can be redeemed across the store.
      * @format int64
      */
     redeem_limit_store_amount?: number;
+    /**
+     * Indicates whether a per-customer redemption limit is enabled.
+     */
     redeem_limit_customer_enabled?: boolean;
     /**
+     * The maximum number of times the coupon can be redeemed per customer.
      * @format int64
      */
     redeem_limit_customer_amount?: number;
+    /**
+     * Indicates whether the coupon can be used for one-time purchases.
+     */
     usable_on_one_time_purchase?: boolean;
+    /**
+     * Indicates whether the coupon can be used for subscriptions.
+     */
     usable_on_subscription?: boolean;
     /**
+     * The date and time when the coupon becomes valid.
      * @format date-time
      */
-    usable_at?: string | null;
+    usable_at?: string;
     /**
+     * The date and time when the coupon expires.
      * @format date-time
      */
-    expires_at?: string | null;
+    expires_at?: string;
 }
 export interface UpdateEmailBrandingDto {
     color?: string;
@@ -8151,47 +8684,89 @@ export interface UpdateEmailTemplateDto {
     content?: string;
 }
 export interface UpdateGameServerConsoleDto {
+    /**
+     * Indicates whether PayNow keeps the connection to the console open.
+     */
     enabled?: boolean;
+    /**
+     * The hostname or IP address the game server's console listens on.
+     */
     host?: string;
     /**
+     * The port the game server's console listens on.
      * @format int32
      */
     port?: number;
+    /**
+     * The password used to authenticate with the console, or null when it requires none.
+     */
     password?: string;
+    /**
+     * Indicates whether the connection is made over TLS.
+     */
     secure?: boolean;
 }
 export interface UpdateGameServerDto {
+    /**
+     * The display name of the game server.
+     */
     name?: string;
+    /**
+     * Indicates whether the game server is currently enabled.
+     */
     enabled?: boolean;
 }
 export interface UpdateGiftCardDto {
+    /**
+     * Indicates whether the gift card is currently enabled and can be used.
+     */
     enabled?: boolean;
+    /**
+     * The unique code that customers use to redeem the gift card.
+     * @example "GIFT-2024-ABCD1234"
+     */
     code?: string;
+    /**
+     * Optional note or description associated with the gift card.
+     */
     note?: string;
     /**
+     * The current balance remaining on the gift card in cents.
      * @format int64
+     * @example 2500
      */
     balance?: number;
     /**
+     * The date and time when the gift card becomes usable.
      * @format date-time
      */
     usable_at?: string;
     /**
+     * The date and time when the gift card expires, if applicable.
      * @format date-time
      */
-    expires_at?: string | null;
+    expires_at?: string;
 }
 export interface UpdateInviteDto {
     role_id?: FlakeId;
+    /**
+     * The email address the invite was sent to.
+     */
     user_email?: string;
 }
 export interface UpdateNavLinkDto {
     tag_id?: FlakeId;
+    /**
+     * The 'node_id' of the link this one nests under, or null when it sits at the top level of the
+     * navigation.
+     */
     parent_node_id?: string;
     /**
+     * The position of the link among its siblings, lowest first, or null when no explicit order has
+     * been set.
      * @format int32
      */
-    order?: number | null;
+    order?: number;
 }
 export interface UpdateNavLinkOrderChangeDto {
     node_id: FlakeId;
@@ -8212,56 +8787,123 @@ export interface UpdateRoleDto {
     permissions?: Record<string, boolean>;
 }
 export interface UpdateSaleDto {
+    /**
+     * Indicates whether the sale is enabled.
+     */
     enabled?: boolean;
+    /**
+     * The name of the sale.
+     */
     name?: string;
     discount_type?: SaleDiscountTypeDto;
     /**
+     * The discount value. For percent discounts, this represents the percentage
+     * multiplied by 10 (e.g., 250 = 25%). For amount discounts, this represents
+     * the value in the smallest currency unit (e.g., cents).
      * @format int32
      */
     discount_amount?: number;
     duration?: SaleDurationDto;
     /**
+     * The number of subscription intervals the coupon is valid for, used if the duration is repeating.
      * @format int32
      */
     duration_in_intervals?: number;
+    /**
+     * A list of product IDs the sale applies to.
+     */
     apply_to_product_ids?: Array<FlakeId>;
+    /**
+     * A list of tag IDs the sale applies to.
+     */
     apply_to_tag_ids?: Array<FlakeId>;
     /**
+     * The minimum order value required to apply the sale, in the smallest currency unit (e.g., cents).
      * @format int32
      */
     minimum_order_value?: number;
     /**
+     * The date and time when the sale begins.
      * @format date-time
      */
     begins_at?: string;
     /**
+     * The date and time when the sale ends.
      * @format date-time
      */
-    ends_at?: string | null;
+    ends_at?: string;
 }
 export interface UpdateStoreDto {
+    /**
+     * The URL-safe slug used to identify the store (e.g. "my-rust-server").
+     */
     slug?: string;
+    /**
+     * The display name of the store.
+     */
     name?: string;
+    /**
+     * The platform this store is associated with (e.g. "rust", "minecraft").
+     */
     platform?: string;
+    /**
+     * Alias for 'platform'. Returns the platform identifier as a game name.
+     */
     game?: string;
+    /**
+     * A human-readable description of the store shown to customers and PayNow.
+     */
     description?: string;
+    /**
+     * The store's public website URL.
+     */
     website_url?: string;
+    /**
+     * General contact email address for the store.
+     */
     contact_email?: string;
+    /**
+     * Dedicated support email address for customer inquiries.
+     */
     support_email?: string;
+    /**
+     * URL to the store's support portal or help page.
+     */
     support_url?: string;
+    /**
+     * The integration type used by the store.
+     */
     integration_type?: string;
+    /**
+     * When set to true, the store is processing real transactions in live mode.
+     */
     live_mode?: boolean;
+    /**
+     * Username prefix used to identify Minecraft Bedrock players (e.g. ".").
+     */
     minecraft_bedrock_username_prefix?: string;
 }
 export interface UpdateStoreMemberDto {
     role_id: FlakeId;
 }
 export interface UpdateStorePaymentSettingsDto {
+    /**
+     * Whether to show all available payment methods for subscription purchases.
+     */
     show_all_payment_methods_for_subscriptions?: boolean;
+    /**
+     * Whether store pricing is tax-inclusive.
+     */
     store_tax_inclusive_pricing?: boolean;
     block_prepaid_cards?: PrepaidCardsBlockingTypeDto;
     promo_code_stacking_behavior?: StorePromoCodeStackingBehaviorDto;
+    /**
+     * Whether the 'Adaptive Currency' feature is enabled.
+     */
     adaptive_currency_enabled?: boolean;
+    /**
+     * Whether the displayed currency on the storefront should be the Adaptive Currency by default.
+     */
     show_adaptive_currency_on_storefront?: boolean;
 }
 export interface UpdateStoreUpsellSettingsDto {
@@ -8308,9 +8950,13 @@ export interface UpdateTierGroupRequestDto {
 export interface UpdateTrialEligibilityOverrideDto {
     product_id?: FlakeId;
     /**
+     * The date and time when this override expires and is no longer valid.
      * @format date-time
      */
     expires_at?: string;
+    /**
+     * An optional note or comment about this override.
+     */
     note?: string;
 }
 export interface UpdateWebhookDto {
@@ -8323,34 +8969,77 @@ export interface UpdateWebhookDto {
     discord_format?: WebhookDiscordFormatDto;
 }
 export interface UpdateWebstoreModuleDto {
+    /**
+     * Indicates whether the module is rendered. A disabled module keeps its settings but is not
+     * shown to customers.
+     */
     enabled?: boolean;
+    /**
+     * The kind of module. Decides which 'settings' it accepts and how the template renders it.
+     */
     type?: string;
-    settings?: null;
     /**
+     * The module's type-specific configuration as a JSON object, or null when it has none.
+     */
+    settings?: unknown;
+    /**
+     * The date and time the module starts being shown, or null to show it as soon as it is enabled.
      * @format date-time
      */
-    starts_at?: string | null;
+    starts_at?: string;
     /**
+     * The date and time the module stops being shown, or null to show it indefinitely.
      * @format date-time
      */
-    ends_at?: string | null;
+    ends_at?: string;
 }
 export interface UpdateWebstoreTemplateDto {
+    /**
+     * The display name of the template.
+     */
     name?: string;
     compatibility_mode?: WebstoreTemplateCompatibilityModeDto;
 }
 export interface UpdateWebstoreTemplateFileDto {
+    /**
+     * The name of the file within the template, without an extension. The extension follows from
+     * 'content_type'.
+     */
     file_name?: string;
+    /**
+     * The MIME type of the file (e.g., text/html, text/css, application/json). Decides how the file
+     * is served and whether it is public.
+     */
     content_type?: string;
+    /**
+     * The text content of the file. Null when files are listed; content is only returned when a
+     * single file is fetched or the template is fetched with 'include' set to 'files'.
+     */
     content?: string;
 }
+/**
+ * Represents a request to replace the content of a template file.
+ */
 export interface UpdateWebstoreTemplateFileRequestDto {
+    /**
+     * The full new text content of the file. It replaces the existing content in its entirety.
+     */
     content: string;
 }
 export interface UpdateWebstoreTemplateVariableDto {
+    /**
+     * The label shown for the variable in the editor.
+     */
     name?: string;
+    /**
+     * The name the template's files reference the value by.
+     */
     variable?: string;
     type?: WebstoreTemplateVariableTypeDto;
+    /**
+     * The value of the variable, always stored as a string and parsed according to 'type' when the
+     * template renders.
+     */
     value?: string;
 }
 export type UpsellDiscountTypeDto = "unknown" | "none" | "fixed" | "percentage";
@@ -8667,6 +9356,12 @@ export interface ValidationError {
      */
     validation: string;
 }
+/**
+ * Specifies how a Discord webhook renders its message.
+ * - `Invalid`: No format specified. This value is typically used as a default or uninitialized state.
+ * - `Embed`: The message is sent as a rich embed with the configured title, colour and description.
+ * - `Text`: The message is sent as plain text rendered from the description template.
+ */
 export type WebhookDiscordFormatDto = "Invalid" | "Embed" | "Text";
 export type WebhookEventType = "OnIgnore" | "OnOrderCompleted" | "OnRefund" | "OnChargeback" | "OnDeliveryItemAdded" | "OnDeliveryItemActivated" | "OnDeliveryItemUsed" | "OnDeliveryItemRevoked" | "OnSubscriptionActivated" | "OnSubscriptionRenewed" | "OnSubscriptionCanceled" | "OnDiscordOrderActionsQueued" | "OnConnectedUserRegistered" | "OnConnectedUserBecamePayable" | "OnConnectedUserPayoutCreated" | "OnConnectedUserPayoutCompleted" | "OnConnectedUserTransactionInserted" | "OnConnectedUserBecameUnpayable" | "OnTrialActivated" | "OnTrialCompleted" | "OnTrialCanceled" | "OnPurchaseFollowUpAttemptEmailSent" | "OnPurchaseFollowUpAttemptSucceeded" | "OnAbandonedCheckoutRecoveryAttemptEmailSent" | "OnAbandonedCheckoutRecoveryAttemptSucceeded" | "OnChargebackClosed" | "OnDeliveryItemExpired" | "OnDeliveryItemRenewed" | "OnConnectedUserTrustStatusChanged" | "OnPaymentCompleted" | "OnPaymentFailed";
 export interface WebhookHistoryDto {
@@ -8681,20 +9376,46 @@ export interface WebhookHistoryDto {
  */
 export type WebhooksGetHistoryQuery = {
     /**
+     * The page of history to retrieve.
      * @format int32
      */
     page?: number;
+    /**
+     * Filters the history to a specific delivery state.
+     */
     state?: string;
 };
 export type WebhookState = "success" | "pending" | "failed" | "all";
+/**
+ * Represents a webhook subscription: an endpoint that receives a request whenever one of the
+ * subscribed events happens in the store.
+ */
 export interface WebhookSubscriptionDto {
     id: FlakeId;
+    /**
+     * The URL each event is delivered to. For the 'discord_v1' type this is the Discord webhook URL.
+     */
     url: string;
+    /**
+     * The secret used to sign each delivery. Receivers use it to verify the request's signature
+     * header and confirm it came from PayNow.
+     */
     secret: string;
     subscribed_to: WebhookEventType;
     type: WebhookType;
+    /**
+     * The template rendered into the body of the Discord message, with webhook variables substituted.
+     * Only used by the 'discord_v1' type.
+     */
     discord_description_template?: string | null;
+    /**
+     * The title of the Discord embed. Only used by the 'discord_v1' type with the 'embed' format.
+     */
     discord_title?: string | null;
+    /**
+     * The accent colour of the Discord embed, as a hex colour. Only used by the 'discord_v1' type
+     * with the 'embed' format.
+     */
     discord_color?: string | null;
     discord_format?: WebhookDiscordFormatDto;
 }
@@ -8864,6 +9585,9 @@ export interface WebstoreDto {
  * Query parameters
  */
 export type WebstoreGetWebstoreTemplateQuery = {
+    /**
+     * Set to 'files' to include the template's files in the response.
+     */
     include?: string;
 };
 /**
@@ -8871,154 +9595,367 @@ export type WebstoreGetWebstoreTemplateQuery = {
  */
 export type WebstoreGetWebstoreTemplateUploadUrlQuery = {
     /**
+     * The size of the archive to be uploaded, in bytes.
      * @format int64
      */
     content_length?: number;
 };
+/**
+ * Represents a module on a webstore: a self-contained block of content or functionality the
+ * template renders.
+ */
 export interface WebstoreModuleDto {
     id: FlakeId;
     webstore_id: FlakeId;
+    /**
+     * Indicates whether the module is rendered. A disabled module keeps its settings but is not
+     * shown to customers.
+     */
     enabled: boolean;
+    /**
+     * The kind of module. Decides which 'settings' it accepts and how the template renders it.
+     */
     type: string;
     /**
+     * The position of the module among the webstore's modules, lowest first.
      * @format int32
      */
     sort_order: number;
+    /**
+     * The module's type-specific configuration as a JSON object, or null when it has none.
+     */
     settings?: null;
     /**
+     * The date and time the module starts being shown, or null to show it as soon as it is enabled.
      * @format date-time
      */
     starts_at?: string | null;
     /**
+     * The date and time the module stops being shown, or null to show it indefinitely.
      * @format date-time
      */
     ends_at?: string | null;
     /**
+     * The date and time the module was created.
      * @format date-time
      */
     created_at: string;
     /**
+     * The date and time the module was last updated.
      * @format date-time
      */
     updated_at: string;
 }
+/**
+ * Specifies the dialect a webstore template is written in.
+ * - `invalid`: No compatibility mode specified. This value is typically used as a default or uninitialized state.
+ * - `paynow`: A native PayNow template.
+ * - `tebex`: A template written for Tebex, rendered through a compatibility layer so it works without changes.
+ */
 export type WebstoreTemplateCompatibilityModeDto = "invalid" | "paynow" | "tebex";
+/**
+ * Represents one file of a template after compilation.
+ */
 export interface WebstoreTemplateCompiledFileDto {
+    /**
+     * The name of the file within the template.
+     */
     file_name: string;
+    /**
+     * The MIME type of the file.
+     */
     content_type: string;
+    /**
+     * The compiled output of the file, or null when compilation failed.
+     */
     compiled?: string | null;
+    /**
+     * The error compilation raised, or null when the file compiled successfully.
+     */
     error?: string | null;
 }
+/**
+ * Represents a template a webstore can render: a named set of pages, styles, scripts and assets
+ * served to customers while it is the webstore's current template.
+ */
 export interface WebstoreTemplateDto {
     id: FlakeId;
     webstore_id: FlakeId;
+    /**
+     * The display name of the template.
+     */
     name: string;
+    /**
+     * Indicates whether the template is shared with every store, as PayNow's built-in templates are,
+     * rather than private to this webstore.
+     */
     is_public: boolean;
     compatibility_mode: WebstoreTemplateCompatibilityModeDto;
     /**
+     * The date and time the template was created.
      * @format date-time
      */
     created_at: string;
     /**
+     * The date and time the template was last updated.
      * @format date-time
      */
     updated_at: string;
+    /**
+     * The template's files, content included. Only returned when a single template is fetched with
+     * 'include' set to 'files'; null otherwise.
+     */
     template_files?: Array<WebstoreTemplateFileDto> | null;
 }
+/**
+ * Represents one file within a webstore template, such as a page, stylesheet, script or image.
+ */
 export interface WebstoreTemplateFileDto {
     id: FlakeId;
     template_id: FlakeId;
+    /**
+     * The name of the file within the template, without an extension. The extension follows from
+     * 'content_type'.
+     */
     file_name: string;
+    /**
+     * The MIME type of the file (e.g., text/html, text/css, application/json). Decides how the file
+     * is served and whether it is public.
+     */
     content_type: string;
+    /**
+     * Indicates whether the file is served directly to browsers as a static asset. Pages and the
+     * schema file are private and rendered on the server; styles, scripts and images are public.
+     */
     is_public: boolean;
+    /**
+     * Indicates whether the file can be deleted. Files the template cannot render without are not
+     * deletable.
+     */
     is_deletable: boolean;
+    /**
+     * The text content of the file. Null when files are listed; content is only returned when a
+     * single file is fetched or the template is fetched with 'include' set to 'files'.
+     */
     content?: string | null;
     /**
+     * The date and time the file was created.
      * @format date-time
      */
     created_at: string;
     /**
+     * The date and time the file was last updated.
      * @format date-time
      */
     updated_at: string;
 }
+/**
+ * Represents the newest version available for a template installed from the marketplace.
+ */
 export interface WebstoreTemplateLatestVersionDto {
+    /**
+     * The newest published version of the template, or null when no update is available or the
+     * template was not installed from the marketplace.
+     */
     version?: string | null;
 }
+/**
+ * Represents a template compiled and ready to render.
+ */
 export interface WebstoreTemplatePreviewDto {
+    /**
+     * The template's files after compilation, including any that failed to compile.
+     */
     compiled: Array<WebstoreTemplateCompiledFileDto>;
     schema?: WebstoreTemplateSchemaDto;
     compatibilityMode: WebstoreTemplateCompatibilityModeDto;
     /**
+     * The date and time the template was compiled.
      * @format date-time
      */
     compiled_at: string;
 }
+/**
+ * Represents the data the editor uses to preview a template.
+ */
 export interface WebstoreTemplatePreviewResponseDto {
     template: WebstoreTemplatePreviewDto;
     variables: WebstoreTemplatePreviewVariablesDto;
 }
+/**
+ * Represents the variable values a template preview renders with.
+ */
 export interface WebstoreTemplatePreviewVariablesDto {
+    /**
+     * The template's variables and their current values.
+     */
     variables: Array<WebstoreTemplateVariableDto>;
     /**
+     * The date and time the variable values were last saved.
      * @format date-time
      */
     saved_at: string;
 }
+/**
+ * Represents a template's schema, declared by its author: who maintains it, how it receives updates
+ * and the settings a store can configure without editing the template's files.
+ */
 export interface WebstoreTemplateSchemaDto {
+    /**
+     * The name of the template's author.
+     */
     author: string;
+    /**
+     * The email address to contact for support with the template, or null when none is given.
+     */
     support_email?: string | null;
+    /**
+     * The URL to visit for support with the template, or null when none is given.
+     */
     support_url?: string | null;
     updates?: WebstoreTemplateSchemaUpdatesDto;
+    /**
+     * The sections of settings the template exposes, in display order.
+     */
     config: Array<WebstoreTemplateSchemaSectionDto>;
 }
+/**
+ * Represents one configurable setting in a template's schema.
+ */
 export interface WebstoreTemplateSchemaOptionDto {
+    /**
+     * The key the setting's value is stored under. Use it as the variable name when setting values
+     * through the schema variables endpoint.
+     */
     id: string;
+    /**
+     * The label shown for the setting.
+     */
     name: string;
+    /**
+     * A longer explanation of the setting, or null when the template gives none.
+     */
     description?: string | null;
+    /**
+     * The kind of control used to edit the setting (e.g., text, toggle, select, color).
+     */
     type: string;
+    /**
+     * The value used while the store has not set one, or null when there is no default.
+     */
     default?: null;
+    /**
+     * The choices a select-style setting offers. Empty for other kinds of setting.
+     */
     values: Array<string>;
+    /**
+     * Indicates whether a text setting only accepts numbers, or null when it does not apply.
+     */
     numeric?: boolean | null;
+    /**
+     * Indicates whether a text setting accepts multiple lines, or null when it does not apply.
+     */
     multiline?: boolean | null;
     /**
+     * The lowest value a numeric setting accepts, or null when it is unbounded.
      * @format double
      */
     min?: number | null;
     /**
+     * The highest value a numeric setting accepts, or null when it is unbounded.
      * @format double
      */
     max?: number | null;
+    /**
+     * The settings nested under this one. Empty when it has none.
+     */
     nested_options: Array<WebstoreTemplateSchemaOptionDto>;
 }
+/**
+ * Represents a group of related settings in a template's schema.
+ */
 export interface WebstoreTemplateSchemaSectionDto {
+    /**
+     * The heading shown above the section.
+     */
     header: string;
+    /**
+     * The settings in the section, in display order.
+     */
     options: Array<WebstoreTemplateSchemaOptionDto>;
 }
+/**
+ * Represents how a template receives updates from its author.
+ */
 export interface WebstoreTemplateSchemaUpdatesDto {
+    /**
+     * Indicates whether the template can be updated in place.
+     */
     supported: boolean;
+    /**
+     * Indicates whether the newest available version can be looked up before updating.
+     */
     version_check_supported: boolean;
+    /**
+     * The version of the template currently installed, or null when the template does not declare
+     * one.
+     */
     version?: string | null;
+    /**
+     * The URL of the GitHub repository updates are pulled from, or null when updates do not come from
+     * GitHub.
+     */
     github_url?: string | null;
+    /**
+     * The branch of the repository updates are pulled from.
+     */
     github_branch: string;
+    /**
+     * The token used to read a private repository, or null when the repository is public.
+     */
     github_token?: string | null;
 }
+/**
+ * Represents a value a template's files can reference, letting a store customise a template without
+ * editing its files.
+ */
 export interface WebstoreTemplateVariableDto {
     id: FlakeId;
     template_id: FlakeId;
     webstore_id: FlakeId;
+    /**
+     * The label shown for the variable in the editor.
+     */
     name: string;
+    /**
+     * The name the template's files reference the value by.
+     */
     variable: string;
     type: WebstoreTemplateVariableTypeDto;
+    /**
+     * The value of the variable, always stored as a string and parsed according to 'type' when the
+     * template renders.
+     */
     value: string;
     /**
+     * The date and time the variable was created.
      * @format date-time
      */
     created_at: string;
     /**
+     * The date and time the variable was last updated.
      * @format date-time
      */
     updated_at: string;
 }
+/**
+ * Specifies how a template variable's 'value' is interpreted when the template renders.
+ * - `invalid`: No type specified. This value is typically used as a default or uninitialized state.
+ * - `string`: The value is used as plain text.
+ * - `html`: The value is inserted as raw HTML without escaping.
+ * - `number`: The value is parsed as a number.
+ * - `boolean`: The value is parsed as a boolean; 'true' is true, anything else is false.
+ * - `json`: The value is parsed as a JSON document.
+ */
 export type WebstoreTemplateVariableTypeDto = "invalid" | "string" | "html" | "number" | "boolean" | "json";
 //# sourceMappingURL=types.d.ts.map