@wix/auto_sdk_app-management_billing 1.0.7 → 1.0.9

package/build/internal/cjs/src/devcenter-checkout-v1-purchased-item-billing.universal.d.ts

@@ -0,0 +1,401 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface PurchasedItem {
+    /** ID of your app's paid plan. */
+    productId?: string;
+    /** Price of your app's paid plan. For example, `9.95`. */
+    price?: string;
+    /**
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     */
+    currency?: string;
+    /** Information about the billing cycle for your app's paid plan. */
+    billingCycle?: PaymentCycle;
+    /**
+     * Date and time the site onwers have purchased your app's paid plan in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    dateCreated?: Date | null;
+}
+export declare enum PaymentCycle {
+    NO_CYCLE = "NO_CYCLE",
+    MONTHLY = "MONTHLY",
+    YEARLY = "YEARLY",
+    ONE_TIME = "ONE_TIME",
+    TWO_YEARS = "TWO_YEARS",
+    THREE_YEARS = "THREE_YEARS",
+    FOUR_YEARS = "FOUR_YEARS",
+    FIVE_YEARS = "FIVE_YEARS"
+}
+export interface InvoiceStatusUpdated {
+    /** Invoice payment status. */
+    status?: InvoiceStatus;
+    /**
+     * Wix Premium invoice ID.
+     * @maxLength 50
+     */
+    invoiceId?: string;
+    /**
+     * App instance ID - a unique ID assigned to each app in each site.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /** Whether the invoice is for a single payment or for multiple, recurring payments. */
+    recurring?: boolean;
+}
+export declare enum InvoiceStatus {
+    UNKNOWN_INVOICE_STATUS = "UNKNOWN_INVOICE_STATUS",
+    PAYMENT_FAILED = "PAYMENT_FAILED",
+    PAID = "PAID",
+    REFUNDED = "REFUNDED",
+    VOIDED = "VOIDED",
+    CHARGEDBACK = "CHARGEDBACK"
+}
+export interface GetUrlRequest {
+    /**
+     * ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
+     * for a list of your app's supported product IDs.
+     */
+    productId: string;
+    /**
+     * URL for the Wix checkout page. Redirect site owners to this URL after
+     * they've successfully purchased a paid plan for your app.
+     * @format WEB_URL
+     */
+    successUrl?: string | null;
+    /**
+     * Whether the checkout is for testing purposes only. Testing is mainly
+     * relevant for in-app purchase flows. When `true`, Wix charges the site
+     * owners an amount of `0.00`.
+     */
+    testCheckout?: boolean;
+    /** Information about the paid plan's billing cycle. */
+    billingCycle?: PaymentCycle;
+    /**
+     * 2-letter country code in
+     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+     * format.
+     *
+     * Default: `"US"`
+     */
+    countryCode?: string | null;
+    /**
+     * 2-letter language code in
+     * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     *
+     * Default: `"EN"`
+     */
+    languageCode?: string | null;
+    /** Coupon code for the paid plan. Available only in case there is a discount. */
+    couponCode?: string | null;
+}
+export interface ChargeOverride {
+    /**
+     * Override price. In case you omit the override price, Wix charges site
+     * owners the app's default price that's configured in the Pricing page of your app's dashboard.
+     */
+    price?: number;
+    /**
+     * Override 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     */
+    currency?: string;
+}
+export interface GetUrlResponse {
+    /**
+     * URL for the Wix checkout page.
+     * @format WEB_URL
+     */
+    checkoutUrl?: string;
+    /**
+     * Token for the Wix checkout page. The token holds all data about the order
+     * you're creating a checkout for.  It is [signed](),
+     * so you can verify that it comes from Wix.
+     */
+    token?: string | null;
+}
+export interface GetPurchaseHistoryRequest {
+}
+export interface GetPurchaseHistoryResponse {
+    /** Retrieved purchases the site owners have completed for you app. */
+    purchases?: PurchasedItem[];
+}
+export interface GetSitePaymentMethodsStatusRequest {
+}
+export interface GetSitePaymentMethodsStatusResponse {
+    /**
+     * Whether the site owners have enabled at least a single online payment method.
+     * Online payment methods include Wix Payments, Stripe, PayPal, and credit
+     * cards.
+     */
+    onlineProviderEnabled?: boolean;
+    /** Whether the site owners accept offline payments. */
+    offlineProviderEnabled?: boolean;
+    /**
+     * Whether the site owners have enabled the
+     * [Wix Point of Sale](https://www.wix.com/pos).
+     * This allows their customers to make electronic payments in person.
+     */
+    wixPosProviderEnabled?: boolean;
+    /**
+     * Whether the site owners have enabled at least one 3rd-party point-of-sale
+     * provider. This allows their customers to make electronic payments in person.
+     */
+    thirdPartyPosProviderEnabled?: boolean;
+}
+export interface GetMeteredBillingChargesRequest {
+    /**
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * @format CURRENCY
+     */
+    currency?: string | null;
+    /**
+     * Start of the period you want to retrieve the custom charges for in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    startDate?: Date | null;
+    /**
+     * End of the period you want to retrieve the custom charges for in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    endDate?: Date | null;
+}
+export interface GetMeteredBillingChargesResponse {
+    /** List of retrieved custom charges. */
+    charges?: Charge[];
+}
+export interface Charge {
+    /** ID of the custom charge. The ID consists of 64 characters. */
+    _id?: string | null;
+    /** Description of the custom charge. */
+    description?: string;
+    /**
+     * Charge amount.
+     *
+     * Min: `0.50`
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gt:0.00 }
+     */
+    amount?: string;
+}
+export interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+export interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface PurchasedItemInvoiceStatusUpdatedEnvelope {
+    data: InvoiceStatusUpdated;
+    metadata: BaseEventMetadata;
+}
+/**
+ * Triggered when there is an update to the payment status of an invoice.
+ * Charges made using the [Custom Charges SPI](https://dev.wix.com/docs/rest/app-management/app-billing/custom-charges-service-plugin/introduction) may be based on usage.
+ * Learn more about [usage-based charges](https://dev.wix.com/docs/build-apps/launch-your-app/pricing-and-billing/set-up-a-usage-based-business-model).
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE
+ * @webhook
+ * @eventType InvoiceStatusUpdated
+ * @serviceIdentifier com.wixpress.market.aim.api.Checkout
+ * @slug invoice_status_updated
+ */
+export declare function onPurchasedItemInvoiceStatusUpdated(handler: (event: PurchasedItemInvoiceStatusUpdatedEnvelope) => void | Promise<void>): void;
+type PurchasedItemNonNullablePaths = `productId` | `price` | `currency` | `billingCycle`;
+/**
+ * Retrieves the URL for a Wix checkout page for the specified paid plan of your app.
+ *
+ *
+ * This call succeeds only in case you have previously
+ * [set up an external pricing page in your app's dashboard](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-an-external-pricing-page).
+ *
+ * The returned checkout URL is valid for 48 hours.
+ *
+ * This API allows your app to manage your pricing page outside of Wix while
+ * still using the standard Wix checkout flow.
+ * @param productId - ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
+ * for a list of your app's supported product IDs.
+ * @public
+ * @requiredField productId
+ * @permissionId WIX_DEVELOPERS.CREATE_CHECKOUT
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @applicableIdentity APP
+ * @fqn com.wixpress.market.aim.api.Checkout.GetUrl
+ */
+export declare function getUrl(productId: string, options?: GetUrlOptions): Promise<NonNullablePaths<GetUrlResponse, `checkoutUrl`>>;
+export interface GetUrlOptions {
+    /**
+     * URL for the Wix checkout page. Redirect site owners to this URL after
+     * they've successfully purchased a paid plan for your app.
+     * @format WEB_URL
+     */
+    successUrl?: string | null;
+    /**
+     * Whether the checkout is for testing purposes only. Testing is mainly
+     * relevant for in-app purchase flows. When `true`, Wix charges the site
+     * owners an amount of `0.00`.
+     */
+    testCheckout?: boolean;
+    /** Information about the paid plan's billing cycle. */
+    billingCycle?: PaymentCycle;
+    /**
+     * 2-letter country code in
+     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+     * format.
+     *
+     * Default: `"US"`
+     */
+    countryCode?: string | null;
+    /**
+     * 2-letter language code in
+     * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     *
+     * Default: `"EN"`
+     */
+    languageCode?: string | null;
+    /** Coupon code for the paid plan. Available only in case there is a discount. */
+    couponCode?: string | null;
+}
+/**
+ * Retrieves a list of the site owner's past purchases for your app.
+ *
+ *
+ * You don't have to explicitly pass an identifier for the Wix site as part of
+ * the request, since this information is taken automatically from the context.
+ *
+ * The response doesn't include any details about cancellations.
+ * @public
+ * @permissionId WIX_DEVELOPERS.APP_PURCHASE_HISTORY
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @applicableIdentity APP
+ * @fqn com.wixpress.market.aim.api.Checkout.GetPurchaseHistory
+ */
+export declare function getPurchaseHistory(): Promise<NonNullablePaths<GetPurchaseHistoryResponse, {
+    [P in PurchasedItemNonNullablePaths]: `purchases.${number}.${P}`;
+}[PurchasedItemNonNullablePaths]>>;
+/**
+ * Triggers Wix to call the
+ * [List Custom Charges SPI](https://dev.wix.com/docs/rest/internal-only/premium/custom-charges-spi/custom-charges-provider-v1/list-charges).
+ *
+ *
+ * Wix doesn't use the response from _List Charges_ SPI to actually create an
+ * invoice that's sent to the customer. Instead, calling _Get Metered Billing Charges_
+ * allows you confirm that your integration with the Custom Charges SPI is
+ * working as intended.
+ * @internal
+ * @documentationMaturity preview
+ * @permissionId WIX_DEVELOPERS.METERED_BILLING_CHARGES_READ
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @applicableIdentity APP
+ * @fqn com.wixpress.market.aim.api.Checkout.GetMeteredBillingCharges
+ */
+export declare function getMeteredBillingCharges(options?: GetMeteredBillingChargesOptions): Promise<NonNullablePaths<GetMeteredBillingChargesResponse, `charges` | `charges.${number}.description` | `charges.${number}.amount`>>;
+export interface GetMeteredBillingChargesOptions {
+    /**
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * @format CURRENCY
+     */
+    currency?: string | null;
+    /**
+     * Start of the period you want to retrieve the custom charges for in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    startDate?: Date | null;
+    /**
+     * End of the period you want to retrieve the custom charges for in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    endDate?: Date | null;
+}
+export {};

package/build/internal/cjs/src/devcenter-checkout-v1-purchased-item-billing.universal.js

@@ -0,0 +1,207 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMeteredBillingCharges = exports.getPurchaseHistory = exports.getUrl = exports.WebhookIdentityType = exports.InvoiceStatus = exports.PaymentCycle = void 0;
+const transform_error_1 = require("@wix/sdk-runtime/transform-error");
+const rename_all_nested_keys_1 = require("@wix/sdk-runtime/rename-all-nested-keys");
+const ambassadorWixDevcenterCheckoutV1PurchasedItem = __importStar(require("./devcenter-checkout-v1-purchased-item-billing.http.js"));
+var PaymentCycle;
+(function (PaymentCycle) {
+    PaymentCycle["NO_CYCLE"] = "NO_CYCLE";
+    PaymentCycle["MONTHLY"] = "MONTHLY";
+    PaymentCycle["YEARLY"] = "YEARLY";
+    PaymentCycle["ONE_TIME"] = "ONE_TIME";
+    PaymentCycle["TWO_YEARS"] = "TWO_YEARS";
+    PaymentCycle["THREE_YEARS"] = "THREE_YEARS";
+    PaymentCycle["FOUR_YEARS"] = "FOUR_YEARS";
+    PaymentCycle["FIVE_YEARS"] = "FIVE_YEARS";
+})(PaymentCycle || (exports.PaymentCycle = PaymentCycle = {}));
+var InvoiceStatus;
+(function (InvoiceStatus) {
+    InvoiceStatus["UNKNOWN_INVOICE_STATUS"] = "UNKNOWN_INVOICE_STATUS";
+    InvoiceStatus["PAYMENT_FAILED"] = "PAYMENT_FAILED";
+    InvoiceStatus["PAID"] = "PAID";
+    InvoiceStatus["REFUNDED"] = "REFUNDED";
+    InvoiceStatus["VOIDED"] = "VOIDED";
+    InvoiceStatus["CHARGEDBACK"] = "CHARGEDBACK";
+})(InvoiceStatus || (exports.InvoiceStatus = InvoiceStatus = {}));
+var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
+/**
+ * Retrieves the URL for a Wix checkout page for the specified paid plan of your app.
+ *
+ *
+ * This call succeeds only in case you have previously
+ * [set up an external pricing page in your app's dashboard](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-an-external-pricing-page).
+ *
+ * The returned checkout URL is valid for 48 hours.
+ *
+ * This API allows your app to manage your pricing page outside of Wix while
+ * still using the standard Wix checkout flow.
+ * @param productId - ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
+ * for a list of your app's supported product IDs.
+ * @public
+ * @requiredField productId
+ * @permissionId WIX_DEVELOPERS.CREATE_CHECKOUT
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @applicableIdentity APP
+ * @fqn com.wixpress.market.aim.api.Checkout.GetUrl
+ */
+async function getUrl(productId, options) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[2];
+    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
+        productId: productId,
+        successUrl: options?.successUrl,
+        testCheckout: options?.testCheckout,
+        billingCycle: options?.billingCycle,
+        countryCode: options?.countryCode,
+        languageCode: options?.languageCode,
+        couponCode: options?.couponCode,
+    });
+    const reqOpts = ambassadorWixDevcenterCheckoutV1PurchasedItem.getUrl(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
+    }
+    catch (err) {
+        const transformedError = (0, transform_error_1.transformError)(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {
+                productId: '$[0]',
+                successUrl: '$[1].successUrl',
+                testCheckout: '$[1].testCheckout',
+                billingCycle: '$[1].billingCycle',
+                countryCode: '$[1].countryCode',
+                languageCode: '$[1].languageCode',
+                couponCode: '$[1].couponCode',
+            },
+            singleArgumentUnchanged: false,
+        }, ['productId', 'options']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+exports.getUrl = getUrl;
+/**
+ * Retrieves a list of the site owner's past purchases for your app.
+ *
+ *
+ * You don't have to explicitly pass an identifier for the Wix site as part of
+ * the request, since this information is taken automatically from the context.
+ *
+ * The response doesn't include any details about cancellations.
+ * @public
+ * @permissionId WIX_DEVELOPERS.APP_PURCHASE_HISTORY
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @applicableIdentity APP
+ * @fqn com.wixpress.market.aim.api.Checkout.GetPurchaseHistory
+ */
+async function getPurchaseHistory() {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[0];
+    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({});
+    const reqOpts = ambassadorWixDevcenterCheckoutV1PurchasedItem.getPurchaseHistory(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
+    }
+    catch (err) {
+        const transformedError = (0, transform_error_1.transformError)(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {},
+            singleArgumentUnchanged: false,
+        }, []);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+exports.getPurchaseHistory = getPurchaseHistory;
+/**
+ * Triggers Wix to call the
+ * [List Custom Charges SPI](https://dev.wix.com/docs/rest/internal-only/premium/custom-charges-spi/custom-charges-provider-v1/list-charges).
+ *
+ *
+ * Wix doesn't use the response from _List Charges_ SPI to actually create an
+ * invoice that's sent to the customer. Instead, calling _Get Metered Billing Charges_
+ * allows you confirm that your integration with the Custom Charges SPI is
+ * working as intended.
+ * @internal
+ * @documentationMaturity preview
+ * @permissionId WIX_DEVELOPERS.METERED_BILLING_CHARGES_READ
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @applicableIdentity APP
+ * @fqn com.wixpress.market.aim.api.Checkout.GetMeteredBillingCharges
+ */
+async function getMeteredBillingCharges(options) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
+        currency: options?.currency,
+        startDate: options?.startDate,
+        endDate: options?.endDate,
+    });
+    const reqOpts = ambassadorWixDevcenterCheckoutV1PurchasedItem.getMeteredBillingCharges(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
+    }
+    catch (err) {
+        const transformedError = (0, transform_error_1.transformError)(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {
+                currency: '$[0].currency',
+                startDate: '$[0].startDate',
+                endDate: '$[0].endDate',
+            },
+            singleArgumentUnchanged: false,
+        }, ['options']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+exports.getMeteredBillingCharges = getMeteredBillingCharges;
+//# sourceMappingURL=devcenter-checkout-v1-purchased-item-billing.universal.js.map

package/build/internal/cjs/src/devcenter-checkout-v1-purchased-item-billing.universal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"devcenter-checkout-v1-purchased-item-billing.universal.js","sourceRoot":"","sources":["../../../../src/devcenter-checkout-v1-purchased-item-billing.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,sIAAwH;AAqBxH,IAAY,YASX;AATD,WAAY,YAAY;IACtB,qCAAqB,CAAA;IACrB,mCAAmB,CAAA;IACnB,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,uCAAuB,CAAA;IACvB,2CAA2B,CAAA;IAC3B,yCAAyB,CAAA;IACzB,yCAAyB,CAAA;AAC3B,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AAmBD,IAAY,aAOX;AAPD,WAAY,aAAa;IACvB,kEAAiD,CAAA;IACjD,kDAAiC,CAAA;IACjC,8BAAa,CAAA;IACb,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;IACjB,4CAA2B,CAAA;AAC7B,CAAC,EAPW,aAAa,6BAAb,aAAa,QAOxB;AA4MD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAgDD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACI,KAAK,UAAU,MAAM,CAC1B,SAAiB,EACjB,OAAuB;IAEvB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,SAAS,EAAE,SAAS;QACpB,UAAU,EAAE,OAAO,EAAE,UAAU;QAC/B,YAAY,EAAE,OAAO,EAAE,YAAY;QACnC,YAAY,EAAE,OAAO,EAAE,YAAY;QACnC,WAAW,EAAE,OAAO,EAAE,WAAW;QACjC,YAAY,EAAE,OAAO,EAAE,YAAY;QACnC,UAAU,EAAE,OAAO,EAAE,UAAU;KAChC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,6CAA6C,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAE9E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,SAAS,EAAE,MAAM;gBACjB,UAAU,EAAE,iBAAiB;gBAC7B,YAAY,EAAE,mBAAmB;gBACjC,YAAY,EAAE,mBAAmB;gBACjC,WAAW,EAAE,kBAAkB;gBAC/B,YAAY,EAAE,mBAAmB;gBACjC,UAAU,EAAE,iBAAiB;aAC9B;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,WAAW,EAAE,SAAS,CAAC,CACzB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAlDD,wBAkDC;AAoCD;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,kBAAkB;IAQtC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,6CAA6C,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAE5E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAvCD,gDAuCC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,wBAAwB,CAC5C,OAAyC;IAOzC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,QAAQ,EAAE,OAAO,EAAE,QAAQ;QAC3B,SAAS,EAAE,OAAO,EAAE,SAAS;QAC7B,OAAO,EAAE,OAAO,EAAE,OAAO;KAC1B,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,6CAA6C,CAAC,wBAAwB,CACpE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,QAAQ,EAAE,eAAe;gBACzB,SAAS,EAAE,gBAAgB;gBAC3B,OAAO,EAAE,cAAc;aACxB;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,SAAS,CAAC,CACZ,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAjDD,4DAiDC"}

package/build/internal/es/index.d.ts

@@ -0,0 +1 @@
+export * from './src/devcenter-checkout-v1-purchased-item-billing.context.js';

package/build/internal/es/index.js

@@ -0,0 +1,2 @@
+export * from './src/devcenter-checkout-v1-purchased-item-billing.context.js';
+//# sourceMappingURL=index.js.map

package/build/internal/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../index.ts"],"names":[],"mappings":"AAAA,cAAc,+DAA+D,CAAC"}

package/build/internal/es/index.typings.d.ts

@@ -0,0 +1 @@
+export * from './src/devcenter-checkout-v1-purchased-item-billing.universal.js';

package/build/internal/es/index.typings.js

@@ -0,0 +1,2 @@
+export * from './src/devcenter-checkout-v1-purchased-item-billing.universal.js';
+//# sourceMappingURL=index.typings.js.map

package/build/internal/es/index.typings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.typings.js","sourceRoot":"","sources":["../../../index.typings.ts"],"names":[],"mappings":"AAAA,cAAc,iEAAiE,CAAC"}

package/build/internal/es/meta.d.ts

@@ -0,0 +1 @@
+export * from './src/devcenter-checkout-v1-purchased-item-billing.meta.js';

package/build/internal/es/meta.js

@@ -0,0 +1,2 @@
+export * from './src/devcenter-checkout-v1-purchased-item-billing.meta.js';
+//# sourceMappingURL=meta.js.map

package/build/internal/es/meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../../meta.ts"],"names":[],"mappings":"AAAA,cAAc,4DAA4D,CAAC"}

package/build/internal/es/src/devcenter-checkout-v1-purchased-item-billing.context.d.ts

@@ -0,0 +1,16 @@
+import { getUrl as publicGetUrl, getPurchaseHistory as publicGetPurchaseHistory, getMeteredBillingCharges as publicGetMeteredBillingCharges } from './devcenter-checkout-v1-purchased-item-billing.public.js';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+import { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
+import { onPurchasedItemInvoiceStatusUpdated as publicOnPurchasedItemInvoiceStatusUpdated } from './devcenter-checkout-v1-purchased-item-billing.public.js';
+export declare const getUrl: MaybeContext<BuildRESTFunction<typeof publicGetUrl> & typeof publicGetUrl>;
+export declare const getPurchaseHistory: MaybeContext<BuildRESTFunction<typeof publicGetPurchaseHistory> & typeof publicGetPurchaseHistory>;
+/** @internal */
+export declare const getMeteredBillingCharges: MaybeContext<BuildRESTFunction<typeof publicGetMeteredBillingCharges> & typeof publicGetMeteredBillingCharges>;
+/**
+ * Triggered when there is an update to the payment status of an invoice.
+ * Charges made using the [Custom Charges SPI](https://dev.wix.com/docs/rest/app-management/app-billing/custom-charges-service-plugin/introduction) may be based on usage.
+ * Learn more about [usage-based charges](https://dev.wix.com/docs/build-apps/launch-your-app/pricing-and-billing/set-up-a-usage-based-business-model).
+ */
+export declare const onPurchasedItemInvoiceStatusUpdated: ReturnType<typeof createEventModule<typeof publicOnPurchasedItemInvoiceStatusUpdated>>;
+export { PaymentCycle, InvoiceStatus, WebhookIdentityType, } from './devcenter-checkout-v1-purchased-item-billing.universal.js';
+export { PurchasedItem, InvoiceStatusUpdated, GetUrlRequest, ChargeOverride, GetUrlResponse, GetPurchaseHistoryRequest, GetPurchaseHistoryResponse, GetSitePaymentMethodsStatusRequest, GetSitePaymentMethodsStatusResponse, GetMeteredBillingChargesRequest, GetMeteredBillingChargesResponse, Charge, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, BaseEventMetadata, PurchasedItemInvoiceStatusUpdatedEnvelope, GetUrlOptions, GetMeteredBillingChargesOptions, } from './devcenter-checkout-v1-purchased-item-billing.universal.js';