@paynow-gg/typescript-sdk 2.0.3 → 2.1.1

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

@@ -360,6 +360,34 @@ export type BansGetBansQuery = {
     asc?: boolean;
 };
 export type BanType = "unknown" | "steam" | "ip" | "customer" | "customer_name" | "email";
+/**
+ * Query parameters
+ */
+export type BillingGetStoreInvoicesQuery = {
+    /**
+     * 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)?
@@ -458,6 +486,16 @@ export interface CashAppDetailsDto {
      */
     cashtag: string;
 }
+/**
+ * Represents a request to move a store onto a different plan.
+ */
+export interface ChangeSubscriptionPlanDto {
+    /**
+     * The identifier of the plan to move the store onto.
+     */
+    plan_id: string;
+    renewal_period: SubscriptionRenewalPeriodDto;
+}
 /**
  * Defines the type of chargeback coverage provided.
  * - `unspecified`: Chargeback coverage type is not specified.
@@ -512,6 +550,20 @@ export interface CheckoutPaymentInfoDto {
      */
     checkout_url?: string | null;
 }
+/**
+ * Represents the outcome of a subscription change that may require the store owner to pay.
+ */
+export interface CheckoutSessionDto {
+    /**
+     * The URL the store owner is sent to in order to complete payment. Null when
+     * 'requires_payment' is false.
+     */
+    session_url?: string | null;
+    /**
+     * Whether the change needs a payment before it takes effect.
+     */
+    requires_payment: boolean;
+}
 export interface CheckoutStyleDto {
     store_id: FlakeId;
     font_family?: string | null;
@@ -1130,6 +1182,34 @@ export interface CreateWebhookDto {
     discord_color?: string | null;
     discord_format?: WebhookDiscordFormatDto;
 }
+export interface CreateWebstoreModuleDto {
+    enabled: boolean;
+    type: string;
+    settings?: null;
+    /**
+     * @format date-time
+     */
+    starts_at?: string | null;
+    /**
+     * @format date-time
+     */
+    ends_at?: string | null;
+}
+export interface CreateWebstoreTemplateDto {
+    name: string;
+    compatibility_mode: WebstoreTemplateCompatibilityModeDto;
+}
+export interface CreateWebstoreTemplateFileDto {
+    file_name: string;
+    content_type: string;
+    content?: string;
+}
+export interface CreateWebstoreTemplateVariableDto {
+    name: string;
+    variable: string;
+    type: WebstoreTemplateVariableTypeDto;
+    value: string;
+}
 /**
  * Cryptocurrency payment method details
  */
@@ -2250,6 +2330,9 @@ export interface FinishTagImageUploadUrlRequestDto {
      */
     image_id: string;
 }
+export interface FinishWebstoreTemplateUploadResponseDto {
+    failed_files: Array<string>;
+}
 /**
  * @format flake-id
  * @example "411486491630370816"
@@ -2399,6 +2482,12 @@ export interface GetTagImageUploadUrlResponseDto {
      */
     upload_url: string;
 }
+export interface GetWebstoreTemplateArchiveResponseDto {
+    download_url: string;
+}
+export interface GetWebstoreTemplateUploadUrlResponseDto {
+    upload_url: string;
+}
 /**
  * Represents a gift card in the PayNow system.
  */
@@ -2882,6 +2971,15 @@ export type InvoicesListInvoicesQuery = {
 };
 export type InvoiceStatusDto = "invalid" | "pending" | "generated" | "failed";
 export type InvoiceTypeDto = "invalid" | "invoice" | "credit_note";
+/**
+ * Represents a freshly issued link to a hosted invoice.
+ */
+export interface InvoiceUrlDto {
+    /**
+     * The hosted invoice URL.
+     */
+    url: string;
+}
 /**
  * Klarna payment method details
  */
@@ -4321,6 +4419,76 @@ export interface PixDetailsDto {
      */
     payer_name?: string | null;
 }
+export interface PlanDto {
+    id: string;
+    name: string;
+    description?: string | null;
+    is_custom: boolean;
+}
+/**
+ * Represents a publicly listed plan a store can subscribe to.
+ */
+export interface PlanPreviewDto {
+    /**
+     * The unique identifier of the plan.
+     */
+    id: string;
+    /**
+     * The display name of the plan.
+     */
+    name: string;
+    /**
+     * The description of the plan.
+     */
+    description?: string | null;
+    /**
+     * Whether the plan is negotiated for a specific store rather than publicly offered.
+     */
+    is_custom: boolean;
+    /**
+     * The identifier of the plan this one inherits its limits and feature flags from, if any.
+     */
+    inherits_from_plan_id?: string | null;
+    /**
+     * The platform fee charged on the store's revenue, in basis points.
+     * @format int64
+     */
+    platform_fee_rate: number;
+    /**
+     * The monthly subscription price, in the smallest currency unit.
+     * @format int64
+     */
+    subscription_price_monthly: number;
+    /**
+     * The annual subscription price, in the smallest currency unit, when the plan is billed annually.
+     * @format int64
+     */
+    subscription_price_annually?: number | null;
+}
+export interface PlanPricingDto {
+    id: FlakeId;
+    plan_id: string;
+    /**
+     * @format int64
+     */
+    platform_fee_rate: number;
+    /**
+     * @format int64
+     */
+    subscription_price_monthly: number;
+    /**
+     * @format int64
+     */
+    subscription_price_annually?: number | null;
+    /**
+     * @format date-time
+     */
+    begins_at: string;
+    /**
+     * @format date-time
+     */
+    ends_at?: string | null;
+}
 export type PlatformCapability = "invalid" | "connected_users";
 export interface PlatformStoreTypeAssociationDetailsDto {
     platform_id: FlakeId;
@@ -5500,6 +5668,16 @@ export interface SetDiscordActionDto {
     role_id?: FlakeId;
     message?: string | null;
 }
+export interface SetWebstoreCustomDomainRequestDto {
+    domain: string;
+    verification_type: WebstoreCustomDomainVerificationTypeDto;
+}
+export interface SetWebstoreDefaultTemplateRequestDto {
+    template_id: FlakeId;
+}
+export interface SetWebstoreSlugRequestDto {
+    slug: string;
+}
 export interface StartDataMigrationFromTebexRequestDto {
     /**
      * The public-facing Headless API token.
@@ -5555,6 +5733,92 @@ export interface SteamSkinsInventoryItemDetailsDto {
      */
     price: number;
 }
+export interface StoreAlertDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    entity_id?: FlakeId;
+    status: StoreAlertStatus;
+    type: StoreAlertType;
+    custom_title?: string | null;
+    custom_message?: string | null;
+    /**
+     * @format date-time
+     */
+    action_required_at?: string | null;
+    action_link?: string | null;
+    store_visible: boolean;
+    admin_visible: boolean;
+    resolved_by?: FlakeId;
+    /**
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * @format date-time
+     */
+    updated_at?: string | null;
+    /**
+     * @format date-time
+     */
+    expires_at?: string | null;
+    /**
+     * @format date-time
+     */
+    resolved_at?: string | null;
+    metadata: Record<string, string>;
+}
+export type StoreAlertStatus = "info" | "warning" | "action_required" | "resolved";
+export type StoreAlertType = "other" | "excessive_chargeback_rate" | "kyc_required" | "business_details_required" | "increased_fraud_rate" | "unsupported_product" | "product_compliance_check" | "integration_issue" | "storefront_compliance" | "support_inquiry" | "feature_eligibility" | "feature_enrolled";
+/**
+ * Represents the billing address and tax details a store is invoiced under.
+ */
+export interface StoreBillingDetailsDto {
+    /**
+     * The country of the billing address.
+     */
+    country?: string | null;
+    /**
+     * The state or province of the billing address.
+     */
+    state?: string | null;
+    /**
+     * The city of the billing address.
+     */
+    city?: string | null;
+    /**
+     * The postal code or zip code of the billing address.
+     */
+    postal_code?: string | null;
+    /**
+     * The first line of the billing street address.
+     */
+    line_1?: string | null;
+    /**
+     * The second line of the billing street address, if any (apartment, suite, etc.).
+     */
+    line_2?: string | null;
+    /**
+     * The tax identifier the store is invoiced under, if any.
+     */
+    tax_id?: string | null;
+}
+export interface StoreBillingStatusDto {
+    store_id: FlakeId;
+    is_locked: boolean;
+    lock_reason?: string | null;
+    no_billing_details: boolean;
+    /**
+     * @format int64
+     */
+    revenue_usage: number;
+    plan_limits: Record<string, number>;
+    feature_flags: Array<string>;
+    plan: PlanDto;
+    plan_pricing: PlanPricingDto;
+    subscription?: StoreSubscriptionDto;
+    alerts: Array<StoreAlertDto>;
+    payment_method?: SubscriptionPaymentMethodDto;
+}
 /**
  * Query parameters
  */
@@ -5729,6 +5993,54 @@ export interface StorefrontStoreDto {
      */
     updated_at?: string | null;
 }
+/**
+ * Represents an invoice raised against a store's own subscription.
+ */
+export interface StoreInvoiceDto {
+    id: FlakeId;
+    subscription_id: FlakeId;
+    plan_pricing_id: FlakeId;
+    /**
+     * The payment gateway that issued the invoice.
+     */
+    gateway: string;
+    /**
+     * The identifier of the invoice within the payment gateway.
+     */
+    gateway_invoice_id: string;
+    /**
+     * The hosted invoice URL recorded when the invoice was raised. May expire; request
+     * 'invoices/{invoice_id}/url' for a freshly issued link.
+     */
+    invoice_url: string;
+    /**
+     * The description of what was billed.
+     */
+    description: string;
+    /**
+     * The currency the invoice was issued in.
+     */
+    currency: string;
+    /**
+     * The invoiced total, in the smallest currency unit.
+     * @format int64
+     */
+    total: number;
+    /**
+     * Whether the invoice has been paid.
+     */
+    is_paid: boolean;
+    /**
+     * When the invoice was raised.
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * When the invoice was last updated.
+     * @format date-time
+     */
+    updated_at?: string | null;
+}
 /**
  * Represents a member of a PayNow store.
  */
@@ -5880,6 +6192,44 @@ export interface StoreResult {
     store_id?: FlakeId;
     store: StoreDto;
 }
+export interface StoreSubscriptionDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    plan_id: string;
+    gateway: string;
+    gateway_subscription_id: string;
+    gateway_checkout_id: string;
+    gateway_payment_method_id: string;
+    currency: string;
+    status: StoreSubscriptionStatus;
+    downgrade_period_end_plan_id?: string | null;
+    cancel_at_period_end: boolean;
+    /**
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * @format date-time
+     */
+    updated_at?: string | null;
+    /**
+     * @format date-time
+     */
+    ended_at?: string | null;
+    /**
+     * @format date-time
+     */
+    cancel_at?: string | null;
+    /**
+     * @format date-time
+     */
+    current_period_start: string;
+    /**
+     * @format date-time
+     */
+    current_period_end: string;
+}
+export type StoreSubscriptionStatus = "incomplete" | "trialing" | "active" | "requires_action" | "canceled";
 export interface StoreTrustDto {
     store_id: FlakeId;
     status: StoreTrustStatusDto;
@@ -6770,12 +7120,49 @@ export interface SubscriptionLineDto {
      */
     initial_presentment_total_amount_str?: string | null;
 }
+/**
+ * Represents the payment method a store's subscription is billed to.
+ */
+export interface SubscriptionPaymentMethodDto {
+    /**
+     * The identifier of the payment method within the payment gateway.
+     */
+    id: string;
+    /**
+     * The kind of payment method, such as a card.
+     */
+    type: string;
+    /**
+     * The card network, when the payment method is a card.
+     */
+    card_brand?: string | null;
+    /**
+     * The month the card expires, when the payment method is a card.
+     * @format int64
+     */
+    card_exp_month?: number | null;
+    /**
+     * The year the card expires, when the payment method is a card.
+     * @format int64
+     */
+    card_exp_year?: number | null;
+    /**
+     * The last four digits of the card, when the payment method is a card.
+     */
+    card_last4?: string | null;
+}
 /**
  * Portal flow for updating the payment method of a specific subscription
  */
 export interface SubscriptionPaymentMethodUpdateFlowDto {
     subscription_id: FlakeId;
 }
+/**
+ * Specifies how often a subscription renews.
+ * - `monthly`: The subscription renews every month.
+ * - `annually`: The subscription renews every year.
+ */
+export type SubscriptionRenewalPeriodDto = "monthly" | "annually";
 export interface SubscriptionResult {
     id: FlakeId;
     store_id?: FlakeId;
@@ -7579,6 +7966,37 @@ export interface UpdateWebhookDto {
     discord_color?: string | null;
     discord_format?: WebhookDiscordFormatDto;
 }
+export interface UpdateWebstoreModuleDto {
+    enabled?: boolean;
+    type?: string;
+    settings?: null;
+    /**
+     * @format date-time
+     */
+    starts_at?: string | null;
+    /**
+     * @format date-time
+     */
+    ends_at?: string | null;
+}
+export interface UpdateWebstoreTemplateDto {
+    name?: string;
+    compatibility_mode?: WebstoreTemplateCompatibilityModeDto;
+}
+export interface UpdateWebstoreTemplateFileDto {
+    file_name?: string;
+    content_type?: string;
+    content?: string;
+}
+export interface UpdateWebstoreTemplateFileRequestDto {
+    content: string;
+}
+export interface UpdateWebstoreTemplateVariableDto {
+    name?: string;
+    variable?: string;
+    type?: WebstoreTemplateVariableTypeDto;
+    value?: string;
+}
 export type UpsellDiscountTypeDto = "unknown" | "none" | "fixed" | "percentage";
 /**
  * - `unknown`: Unknown upsell type.
@@ -7929,4 +8347,211 @@ export interface WebhookVariablesDto {
     event_type: WebhookEventType;
     variables: Array<string>;
 }
+export interface WebstoreCustomDomainDto {
+    id: string;
+    hostname: string;
+    status: string;
+    ssl?: WebstoreCustomDomainSslDto;
+    ownership_verification?: WebstoreCustomDomainOwnershipVerificationDto;
+    ownership_verification_http?: WebstoreCustomDomainOwnershipVerificationHttpDto;
+    verification_errors: Array<string>;
+    /**
+     * @format date-time
+     */
+    created_at?: string | null;
+}
+export interface WebstoreCustomDomainOwnershipVerificationDto {
+    type: string;
+    name: string;
+    value: string;
+}
+export interface WebstoreCustomDomainOwnershipVerificationHttpDto {
+    http_url: string;
+    http_body: string;
+}
+export interface WebstoreCustomDomainSslDto {
+    id: string;
+    method: string;
+    status: string;
+    certificate_authority?: string | null;
+    validation_records: Array<WebstoreCustomDomainSslValidationRecordDto>;
+    validation_errors: Array<string>;
+}
+export interface WebstoreCustomDomainSslValidationRecordDto {
+    txt_name?: string | null;
+    txt_value?: string | null;
+    http_url?: string | null;
+    http_body?: string | null;
+    emails: Array<string>;
+}
+export type WebstoreCustomDomainVerificationTypeDto = "invalid" | "http" | "txt" | "email" | "cname";
+export interface WebstoreDto {
+    id: FlakeId;
+    slug: string;
+    is_active: boolean;
+    custom_domain?: string | null;
+    custom_domain_verified: boolean;
+    current_template_id?: FlakeId;
+}
+/**
+ * Query parameters
+ */
+export type WebstoreGetWebstoreTemplateQuery = {
+    include?: string;
+};
+/**
+ * Query parameters
+ */
+export type WebstoreGetWebstoreTemplateUploadUrlQuery = {
+    /**
+     * @format int64
+     */
+    content_length?: number;
+};
+export interface WebstoreModuleDto {
+    id: FlakeId;
+    webstore_id: FlakeId;
+    enabled: boolean;
+    type: string;
+    /**
+     * @format int32
+     */
+    sort_order: number;
+    settings?: null;
+    /**
+     * @format date-time
+     */
+    starts_at?: string | null;
+    /**
+     * @format date-time
+     */
+    ends_at?: string | null;
+    /**
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * @format date-time
+     */
+    updated_at: string;
+}
+export type WebstoreTemplateCompatibilityModeDto = "invalid" | "paynow" | "tebex";
+export interface WebstoreTemplateCompiledFileDto {
+    file_name: string;
+    content_type: string;
+    compiled?: string | null;
+    error?: string | null;
+}
+export interface WebstoreTemplateDto {
+    id: FlakeId;
+    webstore_id: FlakeId;
+    name: string;
+    is_public: boolean;
+    compatibility_mode: WebstoreTemplateCompatibilityModeDto;
+    /**
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * @format date-time
+     */
+    updated_at: string;
+    template_files?: Array<WebstoreTemplateFileDto> | null;
+}
+export interface WebstoreTemplateFileDto {
+    id: FlakeId;
+    template_id: FlakeId;
+    file_name: string;
+    content_type: string;
+    is_public: boolean;
+    is_deletable: boolean;
+    content?: string | null;
+    /**
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * @format date-time
+     */
+    updated_at: string;
+}
+export interface WebstoreTemplateLatestVersionDto {
+    version?: string | null;
+}
+export interface WebstoreTemplatePreviewDto {
+    compiled: Array<WebstoreTemplateCompiledFileDto>;
+    schema?: WebstoreTemplateSchemaDto;
+    compatibilityMode: WebstoreTemplateCompatibilityModeDto;
+    /**
+     * @format date-time
+     */
+    compiled_at: string;
+}
+export interface WebstoreTemplatePreviewResponseDto {
+    template: WebstoreTemplatePreviewDto;
+    variables: WebstoreTemplatePreviewVariablesDto;
+}
+export interface WebstoreTemplatePreviewVariablesDto {
+    variables: Array<WebstoreTemplateVariableDto>;
+    /**
+     * @format date-time
+     */
+    saved_at: string;
+}
+export interface WebstoreTemplateSchemaDto {
+    author: string;
+    support_email?: string | null;
+    support_url?: string | null;
+    updates?: WebstoreTemplateSchemaUpdatesDto;
+    config: Array<WebstoreTemplateSchemaSectionDto>;
+}
+export interface WebstoreTemplateSchemaOptionDto {
+    id: string;
+    name: string;
+    description?: string | null;
+    type: string;
+    default?: null;
+    values: Array<string>;
+    numeric?: boolean | null;
+    multiline?: boolean | null;
+    /**
+     * @format double
+     */
+    min?: number | null;
+    /**
+     * @format double
+     */
+    max?: number | null;
+    nested_options: Array<WebstoreTemplateSchemaOptionDto>;
+}
+export interface WebstoreTemplateSchemaSectionDto {
+    header: string;
+    options: Array<WebstoreTemplateSchemaOptionDto>;
+}
+export interface WebstoreTemplateSchemaUpdatesDto {
+    supported: boolean;
+    version_check_supported: boolean;
+    version?: string | null;
+    github_url?: string | null;
+    github_branch: string;
+    github_token?: string | null;
+}
+export interface WebstoreTemplateVariableDto {
+    id: FlakeId;
+    template_id: FlakeId;
+    webstore_id: FlakeId;
+    name: string;
+    variable: string;
+    type: WebstoreTemplateVariableTypeDto;
+    value: string;
+    /**
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * @format date-time
+     */
+    updated_at: string;
+}
+export type WebstoreTemplateVariableTypeDto = "invalid" | "string" | "html" | "number" | "boolean" | "json";
 //# sourceMappingURL=types.d.ts.map