@wix/auto_sdk_app-management_custom-charges 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export * from './src/service-plugins-types';
+export * from './src/interfaces-premium-v1-custom-charges-provider.context';

package/build/cjs/index.js

@@ -0,0 +1,19 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/service-plugins-types"), exports);
+__exportStar(require("./src/interfaces-premium-v1-custom-charges-provider.context"), exports);
+//# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8DAA4C;AAC5C,8FAA4E"}

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,59 @@
+import { GetChargeLimitResponse, ListChargesResponse, ChargesRejectedResponse, InvoiceCreatedResponse, ChargeLimitUpdatedResponse } from './src/service-plugins-types.js';
+import { GetChargeLimitEnvelope, ListChargesEnvelope, ChargesRejectedEventEnvelope, InvoiceCreatedEventEnvelope, ChargeLimitUpdatedEventEnvelope } from './src/interfaces-premium-v1-custom-charges-provider.public.js';
+export * from './src/service-plugins-types';
+export { GetChargeLimitEnvelope, ListChargesEnvelope, ChargesRejectedEventEnvelope, InvoiceCreatedEventEnvelope, ChargeLimitUpdatedEventEnvelope, };
+/**
+ * Wix calls this method to retrieve the initial charge limit for a paid instance
+ * of your app. This happens every time a customer is upgrading to a paid version of
+ * your app.
+ *
+ * You can't update the charge limit after you've set an initial
+ * value. Customers can increase the limit in their site's dashboard, currently they
+ * aren't allowed to decrease it.
+ */
+export declare function getChargeLimit(payload: GetChargeLimitEnvelope): GetChargeLimitResponse | Promise<GetChargeLimitResponse>;
+/**
+ * Wix calls this method to retrieve a list of charges for a paid instance
+ * of your app. This happens when Wix creates an invoice or in case the customer
+ * wants to preview how much your app would charge them at the moment.
+ *
+ * You must return the charges in the currency that's specified in the request,
+ * you aren't allowed to return more than 5 charges, and their sum must be lower
+ * than the charge limit.
+ *
+ * You may not bill customers for any usage that didn’t occur during the period
+ * Wix specifies when retrieving the charges. If Wix discovers that your app has
+ * charged customers for usage outside of an invoice's specified period, we may
+ * take action such as blocking your app from charging the customer, removing
+ * your app from the Wix App Market, revoking your access to the Wix developer
+ * program, or pursuing legal action to recover damages caused by overcharging.
+ * We understand that mistakes can happen and encourage you to contact
+ * [the Wix App Market team](https://devforum.wix.com/kb/en/contact) immediately if you
+ * become aware of any overcharging issues so that we can work together to
+ * resolve the situation.
+ */
+export declare function listCharges(payload: ListChargesEnvelope): ListChargesResponse | Promise<ListChargesResponse>;
+/**
+ * Triggered in case Wix doesn't accept the charges you've returned in the
+ * List Charges method.
+ *
+ *
+ * You aren't allowed to charge a site owner more than the charge limit. Wix
+ * call List Charges in regular intervals until the sum of all charges is lower than the
+ * charge limit. Wix doesn't create an invoice in case the charges aren't accepted.
+ */
+export declare function chargesRejectedEvent(payload: ChargesRejectedEventEnvelope): ChargesRejectedResponse | Promise<ChargesRejectedResponse>;
+/**
+ * Triggered in case Wix creates an invoice that includes charges for an instance
+ * of your app.
+ */
+export declare function invoiceCreatedEvent(payload: InvoiceCreatedEventEnvelope): InvoiceCreatedResponse | Promise<InvoiceCreatedResponse>;
+/**
+ * Triggered in case the charge limit for an instance of your app is updated.
+ *
+ *
+ * You can't update the charge limit after you've set an initial
+ * value. Site owners can increase the limit in their site's dashboard,
+ * currently they aren't allowed to decrease it.
+ */
+export declare function chargeLimitUpdatedEvent(payload: ChargeLimitUpdatedEventEnvelope): ChargeLimitUpdatedResponse | Promise<ChargeLimitUpdatedResponse>;

package/build/cjs/index.typings.js

@@ -0,0 +1,18 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/service-plugins-types"), exports);
+//# sourceMappingURL=index.typings.js.map

package/build/cjs/index.typings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.typings.js","sourceRoot":"","sources":["../../index.typings.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAeA,8DAA4C"}

package/build/cjs/src/interfaces-premium-v1-custom-charges-provider.context.d.ts

@@ -0,0 +1,5 @@
+import './interfaces-premium-v1-custom-charges-provider.public.js';
+import { createServicePluginModule } from '@wix/sdk-runtime/service-plugin-modules';
+import { provideHandlers as publicProvideHandlers } from './interfaces-premium-v1-custom-charges-provider.public.js';
+export { publicProvideHandlers };
+export declare const provideHandlers: ReturnType<typeof createServicePluginModule<typeof publicProvideHandlers>>;

package/build/cjs/src/interfaces-premium-v1-custom-charges-provider.context.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.provideHandlers = exports.publicProvideHandlers = void 0;
+require("./interfaces-premium-v1-custom-charges-provider.public.js");
+const service_plugin_modules_1 = require("@wix/sdk-runtime/service-plugin-modules");
+const interfaces_premium_v1_custom_charges_provider_public_js_1 = require("./interfaces-premium-v1-custom-charges-provider.public.js");
+Object.defineProperty(exports, "publicProvideHandlers", { enumerable: true, get: function () { return interfaces_premium_v1_custom_charges_provider_public_js_1.provideHandlers; } });
+exports.provideHandlers = (0, service_plugin_modules_1.createServicePluginModule)(interfaces_premium_v1_custom_charges_provider_public_js_1.provideHandlers);
+//# sourceMappingURL=interfaces-premium-v1-custom-charges-provider.context.js.map

package/build/cjs/src/interfaces-premium-v1-custom-charges-provider.context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces-premium-v1-custom-charges-provider.context.js","sourceRoot":"","sources":["../../../src/interfaces-premium-v1-custom-charges-provider.context.ts"],"names":[],"mappings":";;;AAAA,qEAAmE;AACnE,oFAAoF;AACpF,uIAAqH;AAE5G,sGAFmB,yEAAqB,OAEnB;AAEjB,QAAA,eAAe,GAExB,IAAA,kDAAyB,EAAC,yEAAqB,CAAC,CAAC"}

package/build/cjs/src/interfaces-premium-v1-custom-charges-provider.public.d.ts

@@ -0,0 +1,79 @@
+import { ServicePluginDefinition } from '@wix/sdk-types';
+import { Context, GetChargeLimitRequest, GetChargeLimitResponse, ListChargesRequest, ListChargesResponse, ChargesRejectedRequest, ChargesRejectedResponse, InvoiceCreatedRequest, InvoiceCreatedResponse, ChargeLimitUpdatedRequest, ChargeLimitUpdatedResponse } from './service-plugins-types.js';
+export interface GetChargeLimitEnvelope {
+    request: GetChargeLimitRequest;
+    metadata: Context;
+}
+export interface ListChargesEnvelope {
+    request: ListChargesRequest;
+    metadata: Context;
+}
+export interface ChargesRejectedEventEnvelope {
+    request: ChargesRejectedRequest;
+    metadata: Context;
+}
+export interface InvoiceCreatedEventEnvelope {
+    request: InvoiceCreatedRequest;
+    metadata: Context;
+}
+export interface ChargeLimitUpdatedEventEnvelope {
+    request: ChargeLimitUpdatedRequest;
+    metadata: Context;
+}
+export declare const provideHandlers: ServicePluginDefinition<{
+    /**
+     *
+     * Wix calls this method to retrieve the initial charge limit for a paid instance
+     * of your app. This happens every time a customer is upgrading to a paid version of
+     * your app.
+     *
+     * You can't update the charge limit after you've set an initial
+     * value. Customers can increase the limit in their site's dashboard, currently they
+     * aren't allowed to decrease it. */
+    getChargeLimit(payload: GetChargeLimitEnvelope): GetChargeLimitResponse | Promise<GetChargeLimitResponse>;
+    /**
+     *
+     * Wix calls this method to retrieve a list of charges for a paid instance
+     * of your app. This happens when Wix creates an invoice or in case the customer
+     * wants to preview how much your app would charge them at the moment.
+     *
+     * You must return the charges in the currency that's specified in the request,
+     * you aren't allowed to return more than 5 charges, and their sum must be lower
+     * than the charge limit.
+     *
+     * You may not bill customers for any usage that didn’t occur during the period
+     * Wix specifies when retrieving the charges. If Wix discovers that your app has
+     * charged customers for usage outside of an invoice's specified period, we may
+     * take action such as blocking your app from charging the customer, removing
+     * your app from the Wix App Market, revoking your access to the Wix developer
+     * program, or pursuing legal action to recover damages caused by overcharging.
+     * We understand that mistakes can happen and encourage you to contact
+     * [the Wix App Market team](https://devforum.wix.com/kb/en/contact) immediately if you
+     * become aware of any overcharging issues so that we can work together to
+     * resolve the situation. */
+    listCharges(payload: ListChargesEnvelope): ListChargesResponse | Promise<ListChargesResponse>;
+    /**
+     *
+     * Triggered in case Wix doesn't accept the charges you've returned in the
+     * List Charges method.
+     *
+     *
+     * You aren't allowed to charge a site owner more than the charge limit. Wix
+     * call List Charges in regular intervals until the sum of all charges is lower than the
+     * charge limit. Wix doesn't create an invoice in case the charges aren't accepted. */
+    chargesRejectedEvent(payload: ChargesRejectedEventEnvelope): ChargesRejectedResponse | Promise<ChargesRejectedResponse>;
+    /**
+     *
+     * Triggered in case Wix creates an invoice that includes charges for an instance
+     * of your app. */
+    invoiceCreatedEvent(payload: InvoiceCreatedEventEnvelope): InvoiceCreatedResponse | Promise<InvoiceCreatedResponse>;
+    /**
+     *
+     * Triggered in case the charge limit for an instance of your app is updated.
+     *
+     *
+     * You can't update the charge limit after you've set an initial
+     * value. Site owners can increase the limit in their site's dashboard,
+     * currently they aren't allowed to decrease it. */
+    chargeLimitUpdatedEvent(payload: ChargeLimitUpdatedEventEnvelope): ChargeLimitUpdatedResponse | Promise<ChargeLimitUpdatedResponse>;
+}>;

package/build/cjs/src/interfaces-premium-v1-custom-charges-provider.public.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.provideHandlers = void 0;
+const sdk_types_1 = require("@wix/sdk-types");
+const timestamp_1 = require("@wix/sdk-runtime/transformations/timestamp");
+const transform_paths_1 = require("@wix/sdk-runtime/transformations/transform-paths");
+const rename_all_nested_keys_1 = require("@wix/sdk-runtime/rename-all-nested-keys");
+exports.provideHandlers = (0, sdk_types_1.ServicePluginDefinition)('PREMIUM_CUSTOM_CHARGES', [
+    {
+        name: 'getChargeLimit',
+        primaryHttpMappingPath: '/v1/charge-limit',
+        transformations: {
+            toREST: (payload) => {
+                const toRestResponse = payload;
+                return (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)(toRestResponse);
+            },
+            fromREST: (payload) => {
+                const fromRestRequest = payload;
+                return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(fromRestRequest);
+            },
+        },
+    },
+    {
+        name: 'listCharges',
+        primaryHttpMappingPath: '/v1/charges',
+        transformations: {
+            toREST: (payload) => {
+                const toRestResponse = payload;
+                return (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)(toRestResponse);
+            },
+            fromREST: (payload) => {
+                const fromRestRequest = (0, transform_paths_1.transformPaths)(payload, [
+                    {
+                        transformFn: timestamp_1.transformRESTTimestampToSDKTimestamp,
+                        paths: [
+                            { path: 'request.periodStart' },
+                            { path: 'request.periodEnd' },
+                        ],
+                    },
+                ]);
+                return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(fromRestRequest);
+            },
+        },
+    },
+    {
+        name: 'chargesRejectedEvent',
+        primaryHttpMappingPath: '/v1/charges-rejected',
+        transformations: {
+            toREST: (payload) => {
+                const toRestResponse = payload;
+                return (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)(toRestResponse);
+            },
+            fromREST: (payload) => {
+                const fromRestRequest = payload;
+                return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(fromRestRequest);
+            },
+        },
+    },
+    {
+        name: 'invoiceCreatedEvent',
+        primaryHttpMappingPath: '/v1/invoice-created',
+        transformations: {
+            toREST: (payload) => {
+                const toRestResponse = payload;
+                return (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)(toRestResponse);
+            },
+            fromREST: (payload) => {
+                const fromRestRequest = payload;
+                return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(fromRestRequest);
+            },
+        },
+    },
+    {
+        name: 'chargeLimitUpdatedEvent',
+        primaryHttpMappingPath: '/v1/limit-updated',
+        transformations: {
+            toREST: (payload) => {
+                const toRestResponse = payload;
+                return (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)(toRestResponse);
+            },
+            fromREST: (payload) => {
+                const fromRestRequest = payload;
+                return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(fromRestRequest);
+            },
+        },
+    },
+]);
+//# sourceMappingURL=interfaces-premium-v1-custom-charges-provider.public.js.map

package/build/cjs/src/interfaces-premium-v1-custom-charges-provider.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces-premium-v1-custom-charges-provider.public.js","sourceRoot":"","sources":["../../../src/interfaces-premium-v1-custom-charges-provider.public.ts"],"names":[],"mappings":";;;AAAA,8CAAyD;AAczD,0EAAkG;AAClG,sFAAkF;AAClF,oFAGiD;AA2BpC,QAAA,eAAe,GAAG,IAAA,mCAAuB,EAsEnD,wBAAwB,EAAE;IAC3B;QACE,IAAI,EAAE,gBAAgB;QACtB,sBAAsB,EAAE,kBAAkB;QAC1C,eAAe,EAAE;YACf,MAAM,EAAE,CAAC,OAAY,EAAE,EAAE;gBACvB,MAAM,cAAc,GAAG,OAAO,CAAC;gBAE/B,OAAO,IAAA,8DAAqC,EAAC,cAAc,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,EAAE;gBACzB,MAAM,eAAe,GAAG,OAAO,CAAC;gBAEhC,OAAO,IAAA,gEAAuC,EAAC,eAAe,CAAC,CAAC;YAClE,CAAC;SACF;KACF;IAED;QACE,IAAI,EAAE,aAAa;QACnB,sBAAsB,EAAE,aAAa;QACrC,eAAe,EAAE;YACf,MAAM,EAAE,CAAC,OAAY,EAAE,EAAE;gBACvB,MAAM,cAAc,GAAG,OAAO,CAAC;gBAE/B,OAAO,IAAA,8DAAqC,EAAC,cAAc,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,EAAE;gBACzB,MAAM,eAAe,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;oBAC9C;wBACE,WAAW,EAAE,gDAAoC;wBACjD,KAAK,EAAE;4BACL,EAAE,IAAI,EAAE,qBAAqB,EAAE;4BAC/B,EAAE,IAAI,EAAE,mBAAmB,EAAE;yBAC9B;qBACF;iBACF,CAAC,CAAC;gBAEH,OAAO,IAAA,gEAAuC,EAAC,eAAe,CAAC,CAAC;YAClE,CAAC;SACF;KACF;IAED;QACE,IAAI,EAAE,sBAAsB;QAC5B,sBAAsB,EAAE,sBAAsB;QAC9C,eAAe,EAAE;YACf,MAAM,EAAE,CAAC,OAAY,EAAE,EAAE;gBACvB,MAAM,cAAc,GAAG,OAAO,CAAC;gBAE/B,OAAO,IAAA,8DAAqC,EAAC,cAAc,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,EAAE;gBACzB,MAAM,eAAe,GAAG,OAAO,CAAC;gBAEhC,OAAO,IAAA,gEAAuC,EAAC,eAAe,CAAC,CAAC;YAClE,CAAC;SACF;KACF;IAED;QACE,IAAI,EAAE,qBAAqB;QAC3B,sBAAsB,EAAE,qBAAqB;QAC7C,eAAe,EAAE;YACf,MAAM,EAAE,CAAC,OAAY,EAAE,EAAE;gBACvB,MAAM,cAAc,GAAG,OAAO,CAAC;gBAE/B,OAAO,IAAA,8DAAqC,EAAC,cAAc,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,EAAE;gBACzB,MAAM,eAAe,GAAG,OAAO,CAAC;gBAEhC,OAAO,IAAA,gEAAuC,EAAC,eAAe,CAAC,CAAC;YAClE,CAAC;SACF;KACF;IAED;QACE,IAAI,EAAE,yBAAyB;QAC/B,sBAAsB,EAAE,mBAAmB;QAC3C,eAAe,EAAE;YACf,MAAM,EAAE,CAAC,OAAY,EAAE,EAAE;gBACvB,MAAM,cAAc,GAAG,OAAO,CAAC;gBAE/B,OAAO,IAAA,8DAAqC,EAAC,cAAc,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,EAAE;gBACzB,MAAM,eAAe,GAAG,OAAO,CAAC;gBAEhC,OAAO,IAAA,gEAAuC,EAAC,eAAe,CAAC,CAAC;YAClE,CAAC;SACF;KACF;CACF,CAAC,CAAC"}

package/build/cjs/src/service-plugins-types.d.ts

@@ -0,0 +1,275 @@
+export interface GetChargeLimitRequest {
+    /**
+     * ID of the subscription for which Wix retrieves the charge limit. Equals
+     * `null` in case Wix hasn't created the subscription when retrieving an
+     * initial charge limit. To track usage and billing for apps, we recommend to
+     * use `instanceId` instead of the `subscriptionId`.
+     */
+    subscriptionId?: string | null;
+    /**
+     * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.
+     *
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
+     * format of the charge limit. Wix may add supported currencies in the future.
+     */
+    currency?: string;
+}
+export interface GetChargeLimitResponse {
+    /**
+     * Retrieved charge limit for the app instance. You can't update the
+     * charge limit after you've set an initial value. Site owners can increase the
+     * limit in their site's dashboard, currently they aren't allowed to decrease it.
+     */
+    chargeLimit?: string | null;
+}
+export interface ListChargesRequest {
+    /**
+     * ID of the subscription for which Wix retrieves your custom charges.
+     * To track usage and billing for apps, we recommend to use `instanceId` instead
+     * of the `subscriptionId`.
+     */
+    subscriptionId?: string;
+    /**
+     * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.
+     *
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
+     * format of your charges to return. Wix may add supported currencies in the future.
+     */
+    currency?: string;
+    /**
+     * Begin of the period Wix retrieves the app instance's charges for in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    periodStart?: Date | null;
+    /**
+     * End of the period Wix retrieves the app instance's charges for in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    periodEnd?: Date | null;
+    /** Information about what Wix intends to do with the retrieved charges. */
+    intent?: Intent;
+}
+export declare enum Intent {
+    /** Inform the customer about how much your app would charge them at the moment. Wix doesn't create an invoice. */
+    DISPLAY_ONLY = "DISPLAY_ONLY",
+    /** Create an invoice for the customer. */
+    CREATE_INVOICE = "CREATE_INVOICE"
+}
+export interface ListChargesResponse {
+    /**
+     * Retrieved charges.
+     *
+     * Max: 5 charges
+     */
+    charges?: ChargeLineItem[];
+}
+export interface ChargeLineItem {
+    /**
+     * ID of the charge. Make sure to save the charge ID on your servers for future
+     * reference. Identical to `lineItem.chargeId` in the Invoice Created Event.
+     *
+     * Max: 64 characters
+     */
+    _id?: string | null;
+    /** Charge description. */
+    description?: string;
+    /**
+     * Charge amount in the currency that's specified in the request. Use a whole number
+     * or separate major and minor units with a dot. For example, `10` or `1.99`. If
+     * you return an amount with more minor units than supported according to
+     * [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes),
+     * Wix truncates the additional minor units.
+     *
+     * Min: `0.50`
+     */
+    amount?: string;
+}
+export interface ChargesRejectedRequest {
+    /**
+     * ID of the subscription for which Wix hasn't accepted your custom charges.
+     * To track usage and billing for apps, we recommend to use `instanceId` instead
+     * of the `subscriptionId`.
+     */
+    subscriptionId?: string;
+    /**
+     * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.
+     *
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
+     * format of the charges. Wix may add supported currencies in the future.
+     */
+    currency?: string;
+    /**
+     * IDs of the rejected charges.
+     *
+     * Max: 5 charges
+     */
+    chargeIds?: string[] | null;
+    /**
+     * Maximum amount that your app may charge the customer per billing cycle.
+     *
+     * Min: `0.50`
+     */
+    chargeLimit?: string | null;
+    /**
+     * Information about why Wix has rejected your app's charges.
+     *
+     * Max: 20 reasons
+     */
+    reasons?: ChargesRejectedReason[];
+}
+export declare enum ChargesRejectedReason {
+    /** There is no information about why Wix has rejected the charges. */
+    UNKNOWN = "UNKNOWN",
+    /** The sum of the charges is higher than the limit that you may charge the customer per billing cycle. */
+    CHARGE_LIMIT_EXCEEDED = "CHARGE_LIMIT_EXCEEDED",
+    /** You can't provide more than 5 charges per invoice. */
+    TOO_MANY_CHARGES = "TOO_MANY_CHARGES",
+    /** You must submit charges as whole numbers or use a dot to separate major and minor units. For example, `10` or `1.50`. Currently, Wix doesn't validate whether the submitted number of decimals for the minor unit is supported for the given currency. */
+    INVALID_FORMAT = "INVALID_FORMAT"
+}
+export interface ChargesRejectedResponse {
+}
+export interface InvoiceCreatedRequest {
+    /**
+     * ID of the subscription for which Wix has created an invoice that includes
+     * your custom charges. To track usage and billing for apps, we recommend to use
+     * `instanceId` instead of the `subscriptionId`.
+     */
+    subscriptionId?: string;
+    /**
+     * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.
+     *
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
+     * format of the charges. Wix may add supported currencies in the future.
+     */
+    currency?: string;
+    /** ID of the created invoice. */
+    invoiceId?: string;
+    /** Line items included in the invoice. */
+    lineItems?: InvoiceLineItem[];
+}
+export interface InvoiceLineItem {
+    /**
+     * ID of the charge as returned in List Charges.
+     *
+     * Max: 64 characters
+     */
+    chargeId?: string | null;
+    /** Charge amount. */
+    amount?: string;
+    /** ID of the line item in the invoice that Wix sends to the customer. */
+    _id?: string;
+}
+export interface InvoiceCreatedResponse {
+}
+export interface ChargeLimitUpdatedRequest {
+    /**
+     * ID of the subscription for which the charge limit has been updated.
+     * To track usage and billing for apps, we recommend to use `instanceId` instead
+     * of the `subscriptionId`.
+     */
+    subscriptionId?: string;
+    /**
+     * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.
+     *
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
+     * format of the charges. Wix may add supported currencies in the future.
+     */
+    currency?: string;
+    /** Updated charge limit. */
+    chargeLimit?: string | null;
+}
+export interface ChargeLimitUpdatedResponse {
+}
+export interface CustomChargesConfig {
+    /**
+     * Base part of your integration's deployment URI for the Custom Charges SPI.
+     * For example `"https://provider.example.com"`, if Wix should call your
+     * integration at `https://provider.example.com/v1/charge-limit` for the
+     * Get Charge Limit method.
+     */
+    baseUri?: SpiBaseUri;
+}
+export interface SpiBaseUri {
+    /**
+     * Base URI where the methods are called. Wix appends the path to the `baseUri`.
+     * For example, to call the Get Shipping Rates method at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.
+     */
+    baseUri?: string;
+    /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */
+    alternativeUris?: AlternativeUri[];
+}
+export interface AlternativeUri {
+    /**
+     * Name of the method to create a custom URI for.
+     *
+     * For `methodName`, use the name of the method in PascalCase.
+     * For example, for Get Shipping Rates use `GetShippingRates`.
+     */
+    methodName?: string;
+    /**
+     * Custom URI that Wix uses to call your server for this method. The path-suffix documented in the method will not be appended to this URI.
+     * Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.
+     */
+    absoluteUri?: string;
+}
+/**
+ * this message is not directly used by any service,
+ * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
+ * e.g. SPIs, event-handlers, etc..
+ * NOTE: this context object MUST be provided as the last argument in each Velo method signature.
+ *
+ * Example:
+ * ```typescript
+ * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {
+ * ...
+ * }
+ * ```
+ */
+export interface Context {
+    /** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
+    requestId?: string | null;
+    /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
+    currency?: string | null;
+    /** An object that describes the identity that triggered this request. */
+    identity?: IdentificationData;
+    /** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
+    languages?: string[];
+    /** The service provider app's instance ID. */
+    instanceId?: string | null;
+}
+export declare enum IdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: IdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}

package/build/cjs/src/service-plugins-types.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdentityType = exports.ChargesRejectedReason = exports.Intent = void 0;
+var Intent;
+(function (Intent) {
+    /** Inform the customer about how much your app would charge them at the moment. Wix doesn't create an invoice. */
+    Intent["DISPLAY_ONLY"] = "DISPLAY_ONLY";
+    /** Create an invoice for the customer. */
+    Intent["CREATE_INVOICE"] = "CREATE_INVOICE";
+})(Intent || (exports.Intent = Intent = {}));
+var ChargesRejectedReason;
+(function (ChargesRejectedReason) {
+    /** There is no information about why Wix has rejected the charges. */
+    ChargesRejectedReason["UNKNOWN"] = "UNKNOWN";
+    /** The sum of the charges is higher than the limit that you may charge the customer per billing cycle. */
+    ChargesRejectedReason["CHARGE_LIMIT_EXCEEDED"] = "CHARGE_LIMIT_EXCEEDED";
+    /** You can't provide more than 5 charges per invoice. */
+    ChargesRejectedReason["TOO_MANY_CHARGES"] = "TOO_MANY_CHARGES";
+    /** You must submit charges as whole numbers or use a dot to separate major and minor units. For example, `10` or `1.50`. Currently, Wix doesn't validate whether the submitted number of decimals for the minor unit is supported for the given currency. */
+    ChargesRejectedReason["INVALID_FORMAT"] = "INVALID_FORMAT";
+})(ChargesRejectedReason || (exports.ChargesRejectedReason = ChargesRejectedReason = {}));
+var IdentityType;
+(function (IdentityType) {
+    IdentityType["UNKNOWN"] = "UNKNOWN";
+    IdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    IdentityType["MEMBER"] = "MEMBER";
+    IdentityType["WIX_USER"] = "WIX_USER";
+    IdentityType["APP"] = "APP";
+})(IdentityType || (exports.IdentityType = IdentityType = {}));
+//# sourceMappingURL=service-plugins-types.js.map

package/build/cjs/src/service-plugins-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-plugins-types.js","sourceRoot":"","sources":["../../../src/service-plugins-types.ts"],"names":[],"mappings":";;;AAwDA,IAAY,MAKX;AALD,WAAY,MAAM;IAChB,kHAAkH;IAClH,uCAA6B,CAAA;IAC7B,0CAA0C;IAC1C,2CAAiC,CAAA;AACnC,CAAC,EALW,MAAM,sBAAN,MAAM,QAKjB;AAoED,IAAY,qBASX;AATD,WAAY,qBAAqB;IAC/B,sEAAsE;IACtE,4CAAmB,CAAA;IACnB,0GAA0G;IAC1G,wEAA+C,CAAA;IAC/C,yDAAyD;IACzD,8DAAqC,CAAA;IACrC,6PAA6P;IAC7P,0DAAiC,CAAA;AACnC,CAAC,EATW,qBAAqB,qCAArB,qBAAqB,QAShC;AA0HD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB"}

package/build/es/index.d.ts

@@ -0,0 +1,2 @@
+export * from './src/service-plugins-types';
+export * from './src/interfaces-premium-v1-custom-charges-provider.context';

package/build/es/index.js

@@ -0,0 +1,3 @@
+export * from './src/service-plugins-types';
+export * from './src/interfaces-premium-v1-custom-charges-provider.context';
+//# sourceMappingURL=index.js.map

package/build/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6DAA6D,CAAC"}