@wix/auto_sdk_app-management_custom-charges 1.0.11 → 1.0.13

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

@@ -1,85 +0,0 @@
-import { ServicePluginDefinition } from '@wix/sdk-types';
-import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
-import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
-import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
-export const provideHandlers = ServicePluginDefinition('PREMIUM_CUSTOM_CHARGES', [
-    {
-        name: 'getChargeLimit',
-        primaryHttpMappingPath: '/v1/charge-limit',
-        transformations: {
-            toREST: (payload) => {
-                const toRestResponse = payload;
-                return renameKeysFromSDKRequestToRESTRequest(toRestResponse);
-            },
-            fromREST: (payload) => {
-                const fromRestRequest = payload;
-                return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);
-            },
-        },
-    },
-    {
-        name: 'listCharges',
-        primaryHttpMappingPath: '/v1/charges',
-        transformations: {
-            toREST: (payload) => {
-                const toRestResponse = payload;
-                return renameKeysFromSDKRequestToRESTRequest(toRestResponse);
-            },
-            fromREST: (payload) => {
-                const fromRestRequest = transformPaths(payload, [
-                    {
-                        transformFn: transformRESTTimestampToSDKTimestamp,
-                        paths: [
-                            { path: 'request.periodStart' },
-                            { path: 'request.periodEnd' },
-                        ],
-                    },
-                ]);
-                return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);
-            },
-        },
-    },
-    {
-        name: 'chargesRejectedEvent',
-        primaryHttpMappingPath: '/v1/charges-rejected',
-        transformations: {
-            toREST: (payload) => {
-                const toRestResponse = payload;
-                return renameKeysFromSDKRequestToRESTRequest(toRestResponse);
-            },
-            fromREST: (payload) => {
-                const fromRestRequest = payload;
-                return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);
-            },
-        },
-    },
-    {
-        name: 'invoiceCreatedEvent',
-        primaryHttpMappingPath: '/v1/invoice-created',
-        transformations: {
-            toREST: (payload) => {
-                const toRestResponse = payload;
-                return renameKeysFromSDKRequestToRESTRequest(toRestResponse);
-            },
-            fromREST: (payload) => {
-                const fromRestRequest = payload;
-                return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);
-            },
-        },
-    },
-    {
-        name: 'chargeLimitUpdatedEvent',
-        primaryHttpMappingPath: '/v1/limit-updated',
-        transformations: {
-            toREST: (payload) => {
-                const toRestResponse = payload;
-                return renameKeysFromSDKRequestToRESTRequest(toRestResponse);
-            },
-            fromREST: (payload) => {
-                const fromRestRequest = payload;
-                return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);
-            },
-        },
-    },
-]);
-//# sourceMappingURL=interfaces-premium-v1-custom-charges-provider.public.js.map

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

@@ -1 +0,0 @@
-{"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,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAczD,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AA2BjD,MAAM,CAAC,MAAM,eAAe,GAAG,uBAAuB,CAsEnD,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,qCAAqC,CAAC,cAAc,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,EAAE;gBACzB,MAAM,eAAe,GAAG,OAAO,CAAC;gBAEhC,OAAO,uCAAuC,CAAC,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,qCAAqC,CAAC,cAAc,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,EAAE;gBACzB,MAAM,eAAe,GAAG,cAAc,CAAC,OAAO,EAAE;oBAC9C;wBACE,WAAW,EAAE,oCAAoC;wBACjD,KAAK,EAAE;4BACL,EAAE,IAAI,EAAE,qBAAqB,EAAE;4BAC/B,EAAE,IAAI,EAAE,mBAAmB,EAAE;yBAC9B;qBACF;iBACF,CAAC,CAAC;gBAEH,OAAO,uCAAuC,CAAC,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,qCAAqC,CAAC,cAAc,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,EAAE;gBACzB,MAAM,eAAe,GAAG,OAAO,CAAC;gBAEhC,OAAO,uCAAuC,CAAC,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,qCAAqC,CAAC,cAAc,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,EAAE;gBACzB,MAAM,eAAe,GAAG,OAAO,CAAC;gBAEhC,OAAO,uCAAuC,CAAC,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,qCAAqC,CAAC,cAAc,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,EAAE;gBACzB,MAAM,eAAe,GAAG,OAAO,CAAC;gBAEhC,OAAO,uCAAuC,CAAC,eAAe,CAAC,CAAC;YAClE,CAAC;SACF;KACF;CACF,CAAC,CAAC"}

package/build/internal/es/src/service-plugins-types.d.ts

@@ -1,343 +0,0 @@
-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`.
-     * @format GUID
-     */
-    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.
-     * @format CURRENCY
-     */
-    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.
-     * @format DECIMAL_VALUE
-     * @decimalValue options { gt:0.00 }
-     */
-    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`.
-     * @format GUID
-     */
-    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.
-     * @format CURRENCY
-     */
-    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
-     * @maxSize 5
-     */
-    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
-     * @maxLength 64
-     */
-    _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`
-     * @format DECIMAL_VALUE
-     */
-    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`.
-     * @format GUID
-     */
-    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.
-     * @format CURRENCY
-     */
-    currency?: string;
-    /**
-     * IDs of the rejected charges.
-     *
-     * Max: 5 charges
-     * @maxSize 5
-     */
-    chargeIds?: string[] | null;
-    /**
-     * Maximum amount that your app may charge the customer per billing cycle.
-     *
-     * Min: `0.50`
-     * @format DECIMAL_VALUE
-     * @decimalValue options { gt:0.00 }
-     */
-    chargeLimit?: string | null;
-    /**
-     * Information about why Wix has rejected your app's charges.
-     *
-     * Max: 20 reasons
-     * @maxSize 20
-     */
-    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`.
-     * @format GUID
-     */
-    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.
-     * @format CURRENCY
-     */
-    currency?: string;
-    /** ID of the created invoice. */
-    invoiceId?: string;
-    /**
-     * Line items included in the invoice.
-     * @maxSize 5
-     */
-    lineItems?: InvoiceLineItem[];
-}
-export interface InvoiceLineItem {
-    /**
-     * ID of the charge as returned in List Charges.
-     *
-     * Max: 64 characters
-     * @maxLength 64
-     */
-    chargeId?: string | null;
-    /**
-     * Charge amount.
-     * @format DECIMAL_VALUE
-     */
-    amount?: string;
-    /**
-     * ID of the line item in the invoice that Wix sends to the customer.
-     * @format GUID
-     */
-    _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`.
-     * @format GUID
-     */
-    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.
-     * @format CURRENCY
-     */
-    currency?: string;
-    /**
-     * Updated charge limit.
-     * @format DECIMAL_VALUE
-     */
-    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/`.
-     * @minLength 6
-     * @maxLength 2048
-     */
-    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`.
-     * @minLength 3
-     * @maxLength 128
-     */
-    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`.
-     * @minLength 6
-     * @maxLength 2048
-     */
-    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.
-     * @format CURRENCY
-     */
-    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.
-     * @format GUID
-     */
-    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.
-     * @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?: IdentityType;
-}
-/** @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;
-}

package/build/internal/es/src/service-plugins-types.js

@@ -1,27 +0,0 @@
-export 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 || (Intent = {}));
-export 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 || (ChargesRejectedReason = {}));
-export var IdentityType;
-(function (IdentityType) {
-    IdentityType["UNKNOWN"] = "UNKNOWN";
-    IdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
-    IdentityType["MEMBER"] = "MEMBER";
-    IdentityType["WIX_USER"] = "WIX_USER";
-    IdentityType["APP"] = "APP";
-})(IdentityType || (IdentityType = {}));
-//# sourceMappingURL=service-plugins-types.js.map

package/build/internal/es/src/service-plugins-types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"service-plugins-types.js","sourceRoot":"","sources":["../../../../src/service-plugins-types.ts"],"names":[],"mappings":"AA8DA,MAAM,CAAN,IAAY,MAKX;AALD,WAAY,MAAM;IAChB,kHAAkH;IAClH,uCAA6B,CAAA;IAC7B,0CAA0C;IAC1C,2CAAiC,CAAA;AACnC,CAAC,EALW,MAAM,KAAN,MAAM,QAKjB;AA6ED,MAAM,CAAN,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,KAArB,qBAAqB,QAShC;AAuJD,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB"}