@stigg/typescript 0.1.0-alpha.9 → 0.1.0-beta.10

package/resources/v1/addons/addons.d.ts

@@ -0,0 +1,1025 @@
+import { APIResource } from "../../../core/resource.js";
+import * as EntitlementsAPI from "./entitlements.js";
+import { AddonPackageEntitlement, EntitlementCreateParams, EntitlementCreateResponse, EntitlementDeleteParams, EntitlementListResponse, EntitlementUpdateParams, Entitlements } from "./entitlements.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * Operations related to addons
+ */
+export declare class Addons extends APIResource {
+    entitlements: EntitlementsAPI.Entitlements;
+    /**
+     * Creates a new addon in draft status, associated with a specific product.
+     */
+    create(body: AddonCreateParams, options?: RequestOptions): APIPromise<Addon>;
+    /**
+     * Retrieves an addon by its unique identifier, including entitlements and pricing
+     * details.
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Addon>;
+    /**
+     * Updates an existing addon's properties such as display name, description, and
+     * metadata.
+     */
+    update(id: string, body: AddonUpdateParams, options?: RequestOptions): APIPromise<Addon>;
+    /**
+     * Retrieves a paginated list of addons in the environment.
+     */
+    list(query?: AddonListParams | null | undefined, options?: RequestOptions): PagePromise<AddonListResponsesMyCursorIDPage, AddonListResponse>;
+    /**
+     * Archives an addon, preventing it from being used in new subscriptions.
+     */
+    archive(id: string, options?: RequestOptions): APIPromise<Addon>;
+    /**
+     * Creates a draft version of an existing addon for modification before publishing.
+     */
+    createDraft(id: string, options?: RequestOptions): APIPromise<Addon>;
+    /**
+     * Retrieves the list of charges configured on an addon.
+     */
+    listCharges(id: string, query?: AddonListChargesParams | null | undefined, options?: RequestOptions): PagePromise<ChargeListDataMyCursorIDPage, ChargeList.Data>;
+    /**
+     * Publishes a draft addon, making it available for use in subscriptions.
+     */
+    publish(id: string, body: AddonPublishParams, options?: RequestOptions): APIPromise<AddonPublishResponse>;
+    /**
+     * Removes a draft version of an addon.
+     */
+    removeDraft(id: string, options?: RequestOptions): APIPromise<AddonRemoveDraftResponse>;
+}
+export type AddonListResponsesMyCursorIDPage = MyCursorIDPage<AddonListResponse>;
+export type ChargeListDataMyCursorIDPage = MyCursorIDPage<ChargeList.Data>;
+/**
+ * Response object
+ */
+export interface Addon {
+    /**
+     * Addon configuration object
+     */
+    data: Addon.Data;
+}
+export declare namespace Addon {
+    /**
+     * Addon configuration object
+     */
+    interface Data {
+        /**
+         * The unique identifier for the entity
+         */
+        id: string;
+        /**
+         * The unique identifier for the entity in the billing provider
+         */
+        billingId: string | null;
+        /**
+         * Timestamp of when the record was created
+         */
+        createdAt: string;
+        /**
+         * List of addons the addon is dependant on
+         */
+        dependencies: Array<string> | null;
+        /**
+         * The description of the package
+         */
+        description: string | null;
+        /**
+         * The display name of the package
+         */
+        displayName: string;
+        /**
+         * List of entitlements of the package
+         */
+        entitlements: Array<Data.Entitlement>;
+        /**
+         * Indicates if the package is the latest version
+         */
+        isLatest: boolean | null;
+        /**
+         * The maximum quantity of this addon that can be added to a subscription
+         */
+        maxQuantity: number | null;
+        /**
+         * Metadata associated with the entity
+         */
+        metadata: {
+            [key: string]: string;
+        };
+        /**
+         * The pricing type of the package
+         */
+        pricingType: 'FREE' | 'PAID' | 'CUSTOM' | null;
+        /**
+         * The product id of the package
+         */
+        productId: string;
+        /**
+         * The status of the package
+         */
+        status: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
+        /**
+         * Timestamp of when the record was last updated
+         */
+        updatedAt: string;
+        /**
+         * The version number of the package
+         */
+        versionNumber: number;
+    }
+    namespace Data {
+        /**
+         * Entitlement reference with type and identifier
+         */
+        interface Entitlement {
+            /**
+             * The unique identifier for the entity
+             */
+            id: string;
+            type: 'FEATURE' | 'CREDIT';
+        }
+    }
+}
+/**
+ * Response list object
+ */
+export interface ChargeList {
+    data: Array<ChargeList.Data>;
+    /**
+     * Pagination metadata including cursors for navigating through results
+     */
+    pagination: ChargeList.Pagination;
+}
+export declare namespace ChargeList {
+    /**
+     * A single pricing row on a plan or addon. Each charge encodes one (billingPeriod,
+     * billingModel, billingCadence, billingCountryCode) combination. Plans and addons
+     * own many of these — one per currency / billing period / feature.
+     */
+    interface Data {
+        /**
+         * Unique identifier of the charge
+         */
+        id: string;
+        /**
+         * The billing cadence (RECURRING or ONE_OFF)
+         */
+        billingCadence: 'RECURRING' | 'ONE_OFF';
+        /**
+         * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED, MINIMUM_SPEND)
+         */
+        billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
+        /**
+         * The billing period (MONTHLY or ANNUALLY)
+         */
+        billingPeriod: 'MONTHLY' | 'ANNUALLY';
+        /**
+         * Timestamp when the charge was created
+         */
+        createdAt: string;
+        /**
+         * ISO country code for localized pricing, if any
+         */
+        billingCountryCode?: string | null;
+        /**
+         * Identifier in the external billing integration (e.g. Stripe price id), if any
+         */
+        billingId?: string | null;
+        /**
+         * Block size for usage-based pricing
+         */
+        blockSize?: number | null;
+        /**
+         * When credits are granted (for credit-based pricing)
+         */
+        creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY' | null;
+        /**
+         * Credit rate configuration for credit-based pricing
+         */
+        creditRate?: Data.CreditRate | null;
+        /**
+         * Identifier in the linked CRM, if any
+         */
+        crmId?: string | null;
+        /**
+         * Deep link to the charge in the linked CRM, if any
+         */
+        crmLinkUrl?: string | null;
+        /**
+         * The feature this charge meters, if metered
+         */
+        featureId?: string | null;
+        /**
+         * Maximum unit quantity that can be purchased
+         */
+        maxUnitQuantity?: number | null;
+        /**
+         * Minimum unit quantity that can be purchased
+         */
+        minUnitQuantity?: number | null;
+        /**
+         * The flat price amount and currency, when applicable
+         */
+        price?: Data.Price | null;
+        /**
+         * Tiered pricing rows when the charge is tiered
+         */
+        tiers?: Array<Data.Tier> | null;
+        /**
+         * Tiered pricing mode (VOLUME or GRADUATED) when the charge is tiered
+         */
+        tiersMode?: 'VOLUME' | 'GRADUATED' | null;
+        /**
+         * Custom currency identifier for top-up pricing, if any
+         */
+        topUpCustomCurrencyId?: string | null;
+        /**
+         * True if this charge is referenced by at least one subscription
+         */
+        usedInSubscriptions?: boolean | null;
+    }
+    namespace Data {
+        /**
+         * Credit rate configuration for credit-based pricing
+         */
+        interface CreditRate {
+            /**
+             * Credit rate amount
+             */
+            amount: number;
+            /**
+             * Custom currency identifier
+             */
+            currencyId: string;
+            /**
+             * Optional cost formula expression
+             */
+            costFormula?: string | null;
+        }
+        /**
+         * The flat price amount and currency, when applicable
+         */
+        interface Price {
+            /**
+             * The price amount
+             */
+            amount: number;
+            /**
+             * ISO 4217 currency code
+             */
+            currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+        }
+        /**
+         * A single tier within a tiered charge
+         */
+        interface Tier {
+            /**
+             * Flat price for this tier
+             */
+            flatPrice?: Tier.FlatPrice | null;
+            /**
+             * Per-unit price in this tier
+             */
+            unitPrice?: Tier.UnitPrice | null;
+            /**
+             * Upper bound of this tier (null for unlimited)
+             */
+            upTo?: number | null;
+        }
+        namespace Tier {
+            /**
+             * Flat price for this tier
+             */
+            interface FlatPrice {
+                /**
+                 * The price amount
+                 */
+                amount: number;
+                /**
+                 * ISO 4217 currency code
+                 */
+                currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+            }
+            /**
+             * Per-unit price in this tier
+             */
+            interface UnitPrice {
+                /**
+                 * The price amount
+                 */
+                amount: number;
+                /**
+                 * ISO 4217 currency code
+                 */
+                currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+            }
+        }
+    }
+    /**
+     * Pagination metadata including cursors for navigating through results
+     */
+    interface Pagination {
+        /**
+         * Cursor for fetching the next page of results, or null if no additional pages
+         * exist
+         */
+        next: string | null;
+        /**
+         * Cursor for fetching the previous page of results, or null if at the beginning
+         */
+        prev: string | null;
+    }
+}
+/**
+ * Addon configuration object
+ */
+export interface AddonListResponse {
+    /**
+     * The unique identifier for the entity
+     */
+    id: string;
+    /**
+     * The unique identifier for the entity in the billing provider
+     */
+    billingId: string | null;
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt: string;
+    /**
+     * List of addons the addon is dependant on
+     */
+    dependencies: Array<string> | null;
+    /**
+     * The description of the package
+     */
+    description: string | null;
+    /**
+     * The display name of the package
+     */
+    displayName: string;
+    /**
+     * List of entitlements of the package
+     */
+    entitlements: Array<AddonListResponse.Entitlement>;
+    /**
+     * Indicates if the package is the latest version
+     */
+    isLatest: boolean | null;
+    /**
+     * The maximum quantity of this addon that can be added to a subscription
+     */
+    maxQuantity: number | null;
+    /**
+     * Metadata associated with the entity
+     */
+    metadata: {
+        [key: string]: string;
+    };
+    /**
+     * The pricing type of the package
+     */
+    pricingType: 'FREE' | 'PAID' | 'CUSTOM' | null;
+    /**
+     * The product id of the package
+     */
+    productId: string;
+    /**
+     * The status of the package
+     */
+    status: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt: string;
+    /**
+     * The version number of the package
+     */
+    versionNumber: number;
+}
+export declare namespace AddonListResponse {
+    /**
+     * Entitlement reference with type and identifier
+     */
+    interface Entitlement {
+        /**
+         * The unique identifier for the entity
+         */
+        id: string;
+        type: 'FEATURE' | 'CREDIT';
+    }
+}
+/**
+ * Response containing task ID for publish operation
+ */
+export interface AddonPublishResponse {
+    data: AddonPublishResponse.Data;
+}
+export declare namespace AddonPublishResponse {
+    interface Data {
+        /**
+         * Task ID for tracking the async publish operation
+         */
+        taskId: string | null;
+    }
+}
+/**
+ * Response confirming the addon draft was removed.
+ */
+export interface AddonRemoveDraftResponse {
+    data: AddonRemoveDraftResponse.Data;
+}
+export declare namespace AddonRemoveDraftResponse {
+    interface Data {
+        /**
+         * The unique identifier for the entity
+         */
+        id: string;
+    }
+}
+export interface AddonCreateParams {
+    /**
+     * The unique identifier for the entity
+     */
+    id: string;
+    /**
+     * The display name of the package
+     */
+    displayName: string;
+    /**
+     * The product id of the package
+     */
+    productId: string;
+    /**
+     * The unique identifier for the entity in the billing provider
+     */
+    billingId?: string | null;
+    /**
+     * The description of the package
+     */
+    description?: string | null;
+    /**
+     * The maximum quantity of this addon that can be added to a subscription
+     */
+    maxQuantity?: number | null;
+    /**
+     * Metadata associated with the entity
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+    /**
+     * The pricing type of the package
+     */
+    pricingType?: 'FREE' | 'PAID' | 'CUSTOM' | null;
+    /**
+     * The status of the package
+     */
+    status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
+}
+export interface AddonUpdateParams {
+    /**
+     * The unique identifier for the entity in the billing provider
+     */
+    billingId?: string | null;
+    /**
+     * Pricing configuration to set on the addon draft
+     */
+    charges?: AddonUpdateParams.Charges;
+    /**
+     * List of addons the addon is dependant on
+     */
+    dependencies?: Array<string> | null;
+    /**
+     * The description of the package
+     */
+    description?: string | null;
+    /**
+     * The display name of the package
+     */
+    displayName?: string;
+    /**
+     * The maximum quantity of this addon that can be added to a subscription
+     */
+    maxQuantity?: number | null;
+    /**
+     * Metadata associated with the entity
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+    /**
+     * The status of the package
+     */
+    status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
+}
+export declare namespace AddonUpdateParams {
+    /**
+     * Pricing configuration to set on the addon draft
+     */
+    interface Charges {
+        /**
+         * The pricing type (FREE, PAID, or CUSTOM)
+         */
+        pricingType: 'FREE' | 'PAID' | 'CUSTOM';
+        /**
+         * Deprecated: billing integration ID
+         */
+        billingId?: string;
+        /**
+         * Minimum spend configuration per billing period
+         */
+        minimumSpend?: Array<Charges.MinimumSpend> | null;
+        /**
+         * When overage charges are billed
+         */
+        overageBillingPeriod?: 'ON_SUBSCRIPTION_RENEWAL' | 'MONTHLY';
+        /**
+         * Array of overage pricing model configurations
+         */
+        overagePricingModels?: Array<Charges.OveragePricingModel>;
+        /**
+         * Array of pricing model configurations
+         */
+        pricingModels?: Array<Charges.PricingModel>;
+    }
+    namespace Charges {
+        /**
+         * Minimum spend configuration for a billing period.
+         */
+        interface MinimumSpend {
+            /**
+             * The billing period
+             */
+            billingPeriod: 'MONTHLY' | 'ANNUALLY';
+            /**
+             * The minimum spend amount
+             */
+            minimum: MinimumSpend.Minimum;
+        }
+        namespace MinimumSpend {
+            /**
+             * The minimum spend amount
+             */
+            interface Minimum {
+                /**
+                 * The price amount
+                 */
+                amount: number;
+                /**
+                 * The price currency
+                 */
+                currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+            }
+        }
+        /**
+         * Overage pricing model configuration.
+         */
+        interface OveragePricingModel {
+            /**
+             * The billing model for overages
+             */
+            billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
+            /**
+             * Price periods for overage pricing
+             */
+            pricePeriods: Array<OveragePricingModel.PricePeriod>;
+            /**
+             * The billing cadence for overages
+             */
+            billingCadence?: 'RECURRING' | 'ONE_OFF';
+            /**
+             * Entitlement configuration for the overage feature
+             */
+            entitlement?: OveragePricingModel.Entitlement;
+            /**
+             * The feature ID for overage pricing
+             */
+            featureId?: string;
+            /**
+             * Custom currency ID for overage top-up
+             */
+            topUpCustomCurrencyId?: string;
+        }
+        namespace OveragePricingModel {
+            /**
+             * Price configuration for a specific billing period.
+             */
+            interface PricePeriod {
+                /**
+                 * The billing period (MONTHLY or ANNUALLY)
+                 */
+                billingPeriod: 'MONTHLY' | 'ANNUALLY';
+                /**
+                 * ISO country code for localized pricing
+                 */
+                billingCountryCode?: string;
+                /**
+                 * Block size for usage-based pricing
+                 */
+                blockSize?: number;
+                /**
+                 * When credits are granted
+                 */
+                creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
+                /**
+                 * Credit rate configuration for credit-based pricing
+                 */
+                creditRate?: PricePeriod.CreditRate;
+                /**
+                 * The price amount and currency
+                 */
+                price?: PricePeriod.Price;
+                /**
+                 * Tiered pricing configuration
+                 */
+                tiers?: Array<PricePeriod.Tier>;
+            }
+            namespace PricePeriod {
+                /**
+                 * Credit rate configuration for credit-based pricing
+                 */
+                interface CreditRate {
+                    /**
+                     * The credit rate amount
+                     */
+                    amount: number;
+                    /**
+                     * The custom currency ID
+                     */
+                    currencyId: string;
+                    /**
+                     * Optional cost formula expression
+                     */
+                    costFormula?: string;
+                }
+                /**
+                 * The price amount and currency
+                 */
+                interface Price {
+                    /**
+                     * The price amount
+                     */
+                    amount: number;
+                    /**
+                     * The price currency
+                     */
+                    currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+                }
+                /**
+                 * A tier in tiered pricing.
+                 */
+                interface Tier {
+                    /**
+                     * Flat price for this tier
+                     */
+                    flatPrice?: Tier.FlatPrice;
+                    /**
+                     * Per-unit price in this tier
+                     */
+                    unitPrice?: Tier.UnitPrice;
+                    /**
+                     * Upper bound of this tier (null for unlimited)
+                     */
+                    upTo?: number;
+                }
+                namespace Tier {
+                    /**
+                     * Flat price for this tier
+                     */
+                    interface FlatPrice {
+                        /**
+                         * The price amount
+                         */
+                        amount: number;
+                        /**
+                         * The price currency
+                         */
+                        currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+                    }
+                    /**
+                     * Per-unit price in this tier
+                     */
+                    interface UnitPrice {
+                        /**
+                         * The price amount
+                         */
+                        amount: number;
+                        /**
+                         * The price currency
+                         */
+                        currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+                    }
+                }
+            }
+            /**
+             * Entitlement configuration for the overage feature
+             */
+            interface Entitlement {
+                /**
+                 * The feature ID for the entitlement
+                 */
+                featureId: string;
+                /**
+                 * Whether the limit is soft (allows overage)
+                 */
+                hasSoftLimit?: boolean;
+                /**
+                 * Whether usage is unlimited
+                 */
+                hasUnlimitedUsage?: boolean;
+                /**
+                 * Monthly reset configuration
+                 */
+                monthlyResetPeriodConfiguration?: Entitlement.MonthlyResetPeriodConfiguration;
+                /**
+                 * The usage reset period
+                 */
+                resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
+                /**
+                 * The usage limit before overage kicks in
+                 */
+                usageLimit?: number;
+                /**
+                 * Weekly reset configuration
+                 */
+                weeklyResetPeriodConfiguration?: Entitlement.WeeklyResetPeriodConfiguration;
+                /**
+                 * Yearly reset configuration
+                 */
+                yearlyResetPeriodConfiguration?: Entitlement.YearlyResetPeriodConfiguration;
+            }
+            namespace Entitlement {
+                /**
+                 * Monthly reset configuration
+                 */
+                interface MonthlyResetPeriodConfiguration {
+                    /**
+                     * Reset anchor (SubscriptionStart or StartOfTheMonth)
+                     */
+                    accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
+                }
+                /**
+                 * Weekly reset configuration
+                 */
+                interface WeeklyResetPeriodConfiguration {
+                    /**
+                     * Reset anchor (SubscriptionStart or specific day)
+                     */
+                    accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
+                }
+                /**
+                 * Yearly reset configuration
+                 */
+                interface YearlyResetPeriodConfiguration {
+                    /**
+                     * Reset anchor (SubscriptionStart)
+                     */
+                    accordingTo: 'SubscriptionStart';
+                }
+            }
+        }
+        /**
+         * A pricing model configuration with billing details and price periods.
+         */
+        interface PricingModel {
+            /**
+             * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED)
+             */
+            billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
+            /**
+             * Array of price period configurations (at least one required)
+             */
+            pricePeriods: Array<PricingModel.PricePeriod>;
+            /**
+             * The billing cadence (RECURRING or ONE_OFF)
+             */
+            billingCadence?: 'RECURRING' | 'ONE_OFF';
+            /**
+             * The feature ID this pricing model is associated with
+             */
+            featureId?: string;
+            /**
+             * Maximum number of units (max 999999)
+             */
+            maxUnitQuantity?: number;
+            /**
+             * Minimum number of units
+             */
+            minUnitQuantity?: number;
+            /**
+             * Monthly reset period configuration
+             */
+            monthlyResetPeriodConfiguration?: PricingModel.MonthlyResetPeriodConfiguration;
+            /**
+             * The usage reset period
+             */
+            resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
+            /**
+             * The tiered pricing mode (VOLUME or GRADUATED)
+             */
+            tiersMode?: 'VOLUME' | 'GRADUATED';
+            /**
+             * The custom currency ID for top-up pricing
+             */
+            topUpCustomCurrencyId?: string;
+            /**
+             * Weekly reset period configuration
+             */
+            weeklyResetPeriodConfiguration?: PricingModel.WeeklyResetPeriodConfiguration;
+            /**
+             * Yearly reset period configuration
+             */
+            yearlyResetPeriodConfiguration?: PricingModel.YearlyResetPeriodConfiguration;
+        }
+        namespace PricingModel {
+            /**
+             * Price configuration for a specific billing period.
+             */
+            interface PricePeriod {
+                /**
+                 * The billing period (MONTHLY or ANNUALLY)
+                 */
+                billingPeriod: 'MONTHLY' | 'ANNUALLY';
+                /**
+                 * ISO country code for localized pricing
+                 */
+                billingCountryCode?: string;
+                /**
+                 * Block size for usage-based pricing
+                 */
+                blockSize?: number;
+                /**
+                 * When credits are granted
+                 */
+                creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
+                /**
+                 * Credit rate configuration for credit-based pricing
+                 */
+                creditRate?: PricePeriod.CreditRate;
+                /**
+                 * The price amount and currency
+                 */
+                price?: PricePeriod.Price;
+                /**
+                 * Tiered pricing configuration
+                 */
+                tiers?: Array<PricePeriod.Tier>;
+            }
+            namespace PricePeriod {
+                /**
+                 * Credit rate configuration for credit-based pricing
+                 */
+                interface CreditRate {
+                    /**
+                     * The credit rate amount
+                     */
+                    amount: number;
+                    /**
+                     * The custom currency ID
+                     */
+                    currencyId: string;
+                    /**
+                     * Optional cost formula expression
+                     */
+                    costFormula?: string;
+                }
+                /**
+                 * The price amount and currency
+                 */
+                interface Price {
+                    /**
+                     * The price amount
+                     */
+                    amount: number;
+                    /**
+                     * The price currency
+                     */
+                    currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+                }
+                /**
+                 * A tier in tiered pricing.
+                 */
+                interface Tier {
+                    /**
+                     * Flat price for this tier
+                     */
+                    flatPrice?: Tier.FlatPrice;
+                    /**
+                     * Per-unit price in this tier
+                     */
+                    unitPrice?: Tier.UnitPrice;
+                    /**
+                     * Upper bound of this tier (null for unlimited)
+                     */
+                    upTo?: number;
+                }
+                namespace Tier {
+                    /**
+                     * Flat price for this tier
+                     */
+                    interface FlatPrice {
+                        /**
+                         * The price amount
+                         */
+                        amount: number;
+                        /**
+                         * The price currency
+                         */
+                        currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+                    }
+                    /**
+                     * Per-unit price in this tier
+                     */
+                    interface UnitPrice {
+                        /**
+                         * The price amount
+                         */
+                        amount: number;
+                        /**
+                         * The price currency
+                         */
+                        currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+                    }
+                }
+            }
+            /**
+             * Monthly reset period configuration
+             */
+            interface MonthlyResetPeriodConfiguration {
+                /**
+                 * Reset anchor (SubscriptionStart or StartOfTheMonth)
+                 */
+                accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
+            }
+            /**
+             * Weekly reset period configuration
+             */
+            interface WeeklyResetPeriodConfiguration {
+                /**
+                 * Reset anchor (SubscriptionStart or specific day)
+                 */
+                accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
+            }
+            /**
+             * Yearly reset period configuration
+             */
+            interface YearlyResetPeriodConfiguration {
+                /**
+                 * Reset anchor (SubscriptionStart)
+                 */
+                accordingTo: 'SubscriptionStart';
+            }
+        }
+    }
+}
+export interface AddonListParams extends MyCursorIDPageParams {
+    /**
+     * Filter by creation date using range operators: gt, gte, lt, lte
+     */
+    createdAt?: AddonListParams.CreatedAt;
+    /**
+     * Filter by product ID
+     */
+    productId?: string;
+    /**
+     * Filter by status. Supports comma-separated values for multiple statuses
+     */
+    status?: Array<'DRAFT' | 'PUBLISHED' | 'ARCHIVED'>;
+}
+export declare namespace AddonListParams {
+    /**
+     * Filter by creation date using range operators: gt, gte, lt, lte
+     */
+    interface CreatedAt {
+        /**
+         * Greater than the specified createdAt value
+         */
+        gt?: string;
+        /**
+         * Greater than or equal to the specified createdAt value
+         */
+        gte?: string;
+        /**
+         * Less than the specified createdAt value
+         */
+        lt?: string;
+        /**
+         * Less than or equal to the specified createdAt value
+         */
+        lte?: string;
+    }
+}
+export interface AddonListChargesParams extends MyCursorIDPageParams {
+}
+export interface AddonPublishParams {
+    /**
+     * The migration type of the package
+     */
+    migrationType: 'NEW_CUSTOMERS' | 'ALL_CUSTOMERS';
+}
+export declare namespace Addons {
+    export { type Addon as Addon, type ChargeList as ChargeList, type AddonListResponse as AddonListResponse, type AddonPublishResponse as AddonPublishResponse, type AddonRemoveDraftResponse as AddonRemoveDraftResponse, type AddonListResponsesMyCursorIDPage as AddonListResponsesMyCursorIDPage, type ChargeListDataMyCursorIDPage as ChargeListDataMyCursorIDPage, type AddonCreateParams as AddonCreateParams, type AddonUpdateParams as AddonUpdateParams, type AddonListParams as AddonListParams, type AddonListChargesParams as AddonListChargesParams, type AddonPublishParams as AddonPublishParams, };
+    export { Entitlements as Entitlements, type AddonPackageEntitlement as AddonPackageEntitlement, type EntitlementCreateResponse as EntitlementCreateResponse, type EntitlementListResponse as EntitlementListResponse, type EntitlementCreateParams as EntitlementCreateParams, type EntitlementUpdateParams as EntitlementUpdateParams, type EntitlementDeleteParams as EntitlementDeleteParams, };
+}
+//# sourceMappingURL=addons.d.ts.map