@wix/auto_sdk_app-management_custom-charges 1.0.2 → 1.0.4

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../index.ts","../src/service-plugins-types.ts","../src/interfaces-premium-v1-custom-charges-provider.public.ts","../src/interfaces-premium-v1-custom-charges-provider.context.ts"],"sourcesContent":["export * from './src/service-plugins-types';\nexport * from './src/interfaces-premium-v1-custom-charges-provider.context';\n","export interface GetChargeLimitRequest {\n  /**\n   * ID of the subscription for which Wix retrieves the charge limit. Equals\n   * `null` in case Wix hasn't created the subscription when retrieving an\n   * initial charge limit. To track usage and billing for apps, we recommend to\n   * use `instanceId` instead of the `subscriptionId`.\n   * @format GUID\n   */\n  subscriptionId?: string | null;\n  /**\n   * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.\n   *\n   * 3-letter currency code in\n   * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)\n   * format of the charge limit. Wix may add supported currencies in the future.\n   * @format CURRENCY\n   */\n  currency?: string;\n}\n\nexport interface GetChargeLimitResponse {\n  /**\n   * Retrieved charge limit for the app instance. You can't update the\n   * charge limit after you've set an initial value. Site owners can increase the\n   * limit in their site's dashboard, currently they aren't allowed to decrease it.\n   * @format DECIMAL_VALUE\n   * @decimalValue options { gt:0.00 }\n   */\n  chargeLimit?: string | null;\n}\n\nexport interface ListChargesRequest {\n  /**\n   * ID of the subscription for which Wix retrieves your custom charges.\n   * To track usage and billing for apps, we recommend to use `instanceId` instead\n   * of the `subscriptionId`.\n   * @format GUID\n   */\n  subscriptionId?: string;\n  /**\n   * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.\n   *\n   * 3-letter currency code in\n   * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)\n   * format of your charges to return. Wix may add supported currencies in the future.\n   * @format CURRENCY\n   */\n  currency?: string;\n  /**\n   * Begin of the period Wix retrieves the app instance's charges for in\n   * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n   */\n  periodStart?: Date | null;\n  /**\n   * End of the period Wix retrieves the app instance's charges for in\n   * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n   */\n  periodEnd?: Date | null;\n  /** Information about what Wix intends to do with the retrieved charges. */\n  intent?: Intent;\n}\n\nexport enum Intent {\n  /** Inform the customer about how much your app would charge them at the moment. Wix doesn't create an invoice. */\n  DISPLAY_ONLY = 'DISPLAY_ONLY',\n  /** Create an invoice for the customer. */\n  CREATE_INVOICE = 'CREATE_INVOICE',\n}\n\nexport interface ListChargesResponse {\n  /**\n   * Retrieved charges.\n   *\n   * Max: 5 charges\n   * @maxSize 5\n   */\n  charges?: ChargeLineItem[];\n}\n\nexport interface ChargeLineItem {\n  /**\n   * ID of the charge. Make sure to save the charge ID on your servers for future\n   * reference. Identical to `lineItem.chargeId` in the Invoice Created Event.\n   *\n   * Max: 64 characters\n   * @maxLength 64\n   */\n  _id?: string | null;\n  /** Charge description. */\n  description?: string;\n  /**\n   * Charge amount in the currency that's specified in the request. Use a whole number\n   * or separate major and minor units with a dot. For example, `10` or `1.99`. If\n   * you return an amount with more minor units than supported according to\n   * [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes),\n   * Wix truncates the additional minor units.\n   *\n   * Min: `0.50`\n   * @format DECIMAL_VALUE\n   */\n  amount?: string;\n}\n\nexport interface ChargesRejectedRequest {\n  /**\n   * ID of the subscription for which Wix hasn't accepted your custom charges.\n   * To track usage and billing for apps, we recommend to use `instanceId` instead\n   * of the `subscriptionId`.\n   * @format GUID\n   */\n  subscriptionId?: string;\n  /**\n   * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.\n   *\n   * 3-letter currency code in\n   * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)\n   * format of the charges. Wix may add supported currencies in the future.\n   * @format CURRENCY\n   */\n  currency?: string;\n  /**\n   * IDs of the rejected charges.\n   *\n   * Max: 5 charges\n   * @maxSize 5\n   */\n  chargeIds?: string[] | null;\n  /**\n   * Maximum amount that your app may charge the customer per billing cycle.\n   *\n   * Min: `0.50`\n   * @format DECIMAL_VALUE\n   * @decimalValue options { gt:0.00 }\n   */\n  chargeLimit?: string | null;\n  /**\n   * Information about why Wix has rejected your app's charges.\n   *\n   * Max: 20 reasons\n   * @maxSize 20\n   */\n  reasons?: ChargesRejectedReason[];\n}\n\nexport enum ChargesRejectedReason {\n  /** There is no information about why Wix has rejected the charges. */\n  UNKNOWN = 'UNKNOWN',\n  /** The sum of the charges is higher than the limit that you may charge the customer per billing cycle. */\n  CHARGE_LIMIT_EXCEEDED = 'CHARGE_LIMIT_EXCEEDED',\n  /** You can't provide more than 5 charges per invoice. */\n  TOO_MANY_CHARGES = 'TOO_MANY_CHARGES',\n  /** 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. */\n  INVALID_FORMAT = 'INVALID_FORMAT',\n}\n\nexport interface ChargesRejectedResponse {}\n\nexport interface InvoiceCreatedRequest {\n  /**\n   * ID of the subscription for which Wix has created an invoice that includes\n   * your custom charges. To track usage and billing for apps, we recommend to use\n   * `instanceId` instead of the `subscriptionId`.\n   * @format GUID\n   */\n  subscriptionId?: string;\n  /**\n   * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.\n   *\n   * 3-letter currency code in\n   * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)\n   * format of the charges. Wix may add supported currencies in the future.\n   * @format CURRENCY\n   */\n  currency?: string;\n  /** ID of the created invoice. */\n  invoiceId?: string;\n  /**\n   * Line items included in the invoice.\n   * @maxSize 5\n   */\n  lineItems?: InvoiceLineItem[];\n}\n\nexport interface InvoiceLineItem {\n  /**\n   * ID of the charge as returned in List Charges.\n   *\n   * Max: 64 characters\n   * @maxLength 64\n   */\n  chargeId?: string | null;\n  /**\n   * Charge amount.\n   * @format DECIMAL_VALUE\n   */\n  amount?: string;\n  /**\n   * ID of the line item in the invoice that Wix sends to the customer.\n   * @format GUID\n   */\n  _id?: string;\n}\n\nexport interface InvoiceCreatedResponse {}\n\nexport interface ChargeLimitUpdatedRequest {\n  /**\n   * ID of the subscription for which the charge limit has been updated.\n   * To track usage and billing for apps, we recommend to use `instanceId` instead\n   * of the `subscriptionId`.\n   * @format GUID\n   */\n  subscriptionId?: string;\n  /**\n   * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.\n   *\n   * 3-letter currency code in\n   * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)\n   * format of the charges. Wix may add supported currencies in the future.\n   * @format CURRENCY\n   */\n  currency?: string;\n  /**\n   * Updated charge limit.\n   * @format DECIMAL_VALUE\n   */\n  chargeLimit?: string | null;\n}\n\nexport interface ChargeLimitUpdatedResponse {}\n\nexport interface CustomChargesConfig {\n  /**\n   * Base part of your integration's deployment URI for the Custom Charges SPI.\n   * For example `\"https://provider.example.com\"`, if Wix should call your\n   * integration at `https://provider.example.com/v1/charge-limit` for the\n   * Get Charge Limit method.\n   */\n  baseUri?: SpiBaseUri;\n}\n\nexport interface SpiBaseUri {\n  /**\n   * Base URI where the methods are called. Wix appends the path to the `baseUri`.\n   * 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/`.\n   * @minLength 6\n   * @maxLength 2048\n   */\n  baseUri?: string;\n  /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */\n  alternativeUris?: AlternativeUri[];\n}\n\nexport interface AlternativeUri {\n  /**\n   * Name of the method to create a custom URI for.\n   *\n   * For `methodName`, use the name of the method in PascalCase.\n   * For example, for Get Shipping Rates use `GetShippingRates`.\n   * @minLength 3\n   * @maxLength 128\n   */\n  methodName?: string;\n  /**\n   * 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.\n   * Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.\n   * @minLength 6\n   * @maxLength 2048\n   */\n  absoluteUri?: string;\n}\n\n/**\n * this message is not directly used by any service,\n * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.\n * e.g. SPIs, event-handlers, etc..\n * NOTE: this context object MUST be provided as the last argument in each Velo method signature.\n *\n * Example:\n * ```typescript\n * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {\n * ...\n * }\n * ```\n */\nexport interface Context {\n  /** 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. */\n  requestId?: string | null;\n  /**\n   * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.\n   * @format CURRENCY\n   */\n  currency?: string | null;\n  /** An object that describes the identity that triggered this request. */\n  identity?: IdentificationData;\n  /** 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\"`. */\n  languages?: string[];\n  /**\n   * The service provider app's instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n}\n\nexport enum IdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: IdentityType;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n","import { ServicePluginDefinition } from '@wix/sdk-types';\nimport {\n  Context,\n  GetChargeLimitRequest,\n  GetChargeLimitResponse,\n  ListChargesRequest,\n  ListChargesResponse,\n  ChargesRejectedRequest,\n  ChargesRejectedResponse,\n  InvoiceCreatedRequest,\n  InvoiceCreatedResponse,\n  ChargeLimitUpdatedRequest,\n  ChargeLimitUpdatedResponse,\n} from './service-plugins-types.js';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\n\nexport interface GetChargeLimitEnvelope {\n  request: GetChargeLimitRequest;\n  metadata: Context;\n}\n\nexport interface ListChargesEnvelope {\n  request: ListChargesRequest;\n  metadata: Context;\n}\n\nexport interface ChargesRejectedEventEnvelope {\n  request: ChargesRejectedRequest;\n  metadata: Context;\n}\n\nexport interface InvoiceCreatedEventEnvelope {\n  request: InvoiceCreatedRequest;\n  metadata: Context;\n}\n\nexport interface ChargeLimitUpdatedEventEnvelope {\n  request: ChargeLimitUpdatedRequest;\n  metadata: Context;\n}\n\nexport const provideHandlers = ServicePluginDefinition<{\n  /**\n   *\n   * Wix calls this method to retrieve the initial charge limit for a paid instance\n   * of your app. This happens every time a customer is upgrading to a paid version of\n   * your app.\n   *\n   * You can't update the charge limit after you've set an initial\n   * value. Customers can increase the limit in their site's dashboard, currently they\n   * aren't allowed to decrease it. */\n  getChargeLimit(\n    payload: GetChargeLimitEnvelope\n  ): GetChargeLimitResponse | Promise<GetChargeLimitResponse>;\n\n  /**\n   *\n   * Wix calls this method to retrieve a list of charges for a paid instance\n   * of your app. This happens when Wix creates an invoice or in case the customer\n   * wants to preview how much your app would charge them at the moment.\n   *\n   * You must return the charges in the currency that's specified in the request,\n   * you aren't allowed to return more than 5 charges, and their sum must be lower\n   * than the charge limit.\n   *\n   * You may not bill customers for any usage that didn’t occur during the period\n   * Wix specifies when retrieving the charges. If Wix discovers that your app has\n   * charged customers for usage outside of an invoice's specified period, we may\n   * take action such as blocking your app from charging the customer, removing\n   * your app from the Wix App Market, revoking your access to the Wix developer\n   * program, or pursuing legal action to recover damages caused by overcharging.\n   * We understand that mistakes can happen and encourage you to contact\n   * [the Wix App Market team](https://devforum.wix.com/kb/en/contact) immediately if you\n   * become aware of any overcharging issues so that we can work together to\n   * resolve the situation. */\n  listCharges(\n    payload: ListChargesEnvelope\n  ): ListChargesResponse | Promise<ListChargesResponse>;\n\n  /**\n   *\n   * Triggered in case Wix doesn't accept the charges you've returned in the\n   * List Charges method.\n   *\n   *\n   * You aren't allowed to charge a site owner more than the charge limit. Wix\n   * call List Charges in regular intervals until the sum of all charges is lower than the\n   * charge limit. Wix doesn't create an invoice in case the charges aren't accepted. */\n  chargesRejectedEvent(\n    payload: ChargesRejectedEventEnvelope\n  ): ChargesRejectedResponse | Promise<ChargesRejectedResponse>;\n\n  /**\n   *\n   * Triggered in case Wix creates an invoice that includes charges for an instance\n   * of your app. */\n  invoiceCreatedEvent(\n    payload: InvoiceCreatedEventEnvelope\n  ): InvoiceCreatedResponse | Promise<InvoiceCreatedResponse>;\n\n  /**\n   *\n   * Triggered in case the charge limit for an instance of your app is updated.\n   *\n   *\n   * You can't update the charge limit after you've set an initial\n   * value. Site owners can increase the limit in their site's dashboard,\n   * currently they aren't allowed to decrease it. */\n  chargeLimitUpdatedEvent(\n    payload: ChargeLimitUpdatedEventEnvelope\n  ): ChargeLimitUpdatedResponse | Promise<ChargeLimitUpdatedResponse>;\n}>('PREMIUM_CUSTOM_CHARGES', [\n  {\n    name: 'getChargeLimit',\n    primaryHttpMappingPath: '/v1/charge-limit',\n    transformations: {\n      toREST: (payload: any) => {\n        const toRestResponse = payload;\n\n        return renameKeysFromSDKRequestToRESTRequest(toRestResponse);\n      },\n      fromREST: (payload: any) => {\n        const fromRestRequest = payload;\n\n        return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);\n      },\n    },\n  },\n\n  {\n    name: 'listCharges',\n    primaryHttpMappingPath: '/v1/charges',\n    transformations: {\n      toREST: (payload: any) => {\n        const toRestResponse = payload;\n\n        return renameKeysFromSDKRequestToRESTRequest(toRestResponse);\n      },\n      fromREST: (payload: any) => {\n        const fromRestRequest = transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [\n              { path: 'request.periodStart' },\n              { path: 'request.periodEnd' },\n            ],\n          },\n        ]);\n\n        return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);\n      },\n    },\n  },\n\n  {\n    name: 'chargesRejectedEvent',\n    primaryHttpMappingPath: '/v1/charges-rejected',\n    transformations: {\n      toREST: (payload: any) => {\n        const toRestResponse = payload;\n\n        return renameKeysFromSDKRequestToRESTRequest(toRestResponse);\n      },\n      fromREST: (payload: any) => {\n        const fromRestRequest = payload;\n\n        return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);\n      },\n    },\n  },\n\n  {\n    name: 'invoiceCreatedEvent',\n    primaryHttpMappingPath: '/v1/invoice-created',\n    transformations: {\n      toREST: (payload: any) => {\n        const toRestResponse = payload;\n\n        return renameKeysFromSDKRequestToRESTRequest(toRestResponse);\n      },\n      fromREST: (payload: any) => {\n        const fromRestRequest = payload;\n\n        return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);\n      },\n    },\n  },\n\n  {\n    name: 'chargeLimitUpdatedEvent',\n    primaryHttpMappingPath: '/v1/limit-updated',\n    transformations: {\n      toREST: (payload: any) => {\n        const toRestResponse = payload;\n\n        return renameKeysFromSDKRequestToRESTRequest(toRestResponse);\n      },\n      fromREST: (payload: any) => {\n        const fromRestRequest = payload;\n\n        return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);\n      },\n    },\n  },\n]);\n","import './interfaces-premium-v1-custom-charges-provider.public.js';\nimport { createServicePluginModule } from '@wix/sdk-runtime/service-plugin-modules';\nimport { provideHandlers as publicProvideHandlers } from './interfaces-premium-v1-custom-charges-provider.public.js';\n\nexport { publicProvideHandlers };\n\nexport const provideHandlers: ReturnType<\n  typeof createServicePluginModule<typeof publicProvideHandlers>\n> = createServicePluginModule(publicProvideHandlers);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAAA;AAAA,EAAA;AAAA;AAAA;;;AC8DO,IAAK,SAAL,kBAAKC,YAAL;AAEL,EAAAA,QAAA,kBAAe;AAEf,EAAAA,QAAA,oBAAiB;AAJP,SAAAA;AAAA,GAAA;AAkFL,IAAK,wBAAL,kBAAKC,2BAAL;AAEL,EAAAA,uBAAA,aAAU;AAEV,EAAAA,uBAAA,2BAAwB;AAExB,EAAAA,uBAAA,sBAAmB;AAEnB,EAAAA,uBAAA,oBAAiB;AARP,SAAAA;AAAA,GAAA;AAgKL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,uBAAoB;AACpB,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,cAAW;AACX,EAAAA,cAAA,SAAM;AALI,SAAAA;AAAA,GAAA;;;AChTZ,uBAAwC;AAcxC,uBAAqD;AACrD,6BAA+B;AAC/B,oCAGO;AA2BA,IAAM,sBAAkB,0CAsE5B,0BAA0B;AAAA,EAC3B;AAAA,IACE,MAAM;AAAA,IACN,wBAAwB;AAAA,IACxB,iBAAiB;AAAA,MACf,QAAQ,CAAC,YAAiB;AACxB,cAAM,iBAAiB;AAEvB,mBAAO,qEAAsC,cAAc;AAAA,MAC7D;AAAA,MACA,UAAU,CAAC,YAAiB;AAC1B,cAAM,kBAAkB;AAExB,mBAAO,uEAAwC,eAAe;AAAA,MAChE;AAAA,IACF;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,wBAAwB;AAAA,IACxB,iBAAiB;AAAA,MACf,QAAQ,CAAC,YAAiB;AACxB,cAAM,iBAAiB;AAEvB,mBAAO,qEAAsC,cAAc;AAAA,MAC7D;AAAA,MACA,UAAU,CAAC,YAAiB;AAC1B,cAAM,sBAAkB,uCAAe,SAAS;AAAA,UAC9C;AAAA,YACE,aAAa;AAAA,YACb,OAAO;AAAA,cACL,EAAE,MAAM,sBAAsB;AAAA,cAC9B,EAAE,MAAM,oBAAoB;AAAA,YAC9B;AAAA,UACF;AAAA,QACF,CAAC;AAED,mBAAO,uEAAwC,eAAe;AAAA,MAChE;AAAA,IACF;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,wBAAwB;AAAA,IACxB,iBAAiB;AAAA,MACf,QAAQ,CAAC,YAAiB;AACxB,cAAM,iBAAiB;AAEvB,mBAAO,qEAAsC,cAAc;AAAA,MAC7D;AAAA,MACA,UAAU,CAAC,YAAiB;AAC1B,cAAM,kBAAkB;AAExB,mBAAO,uEAAwC,eAAe;AAAA,MAChE;AAAA,IACF;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,wBAAwB;AAAA,IACxB,iBAAiB;AAAA,MACf,QAAQ,CAAC,YAAiB;AACxB,cAAM,iBAAiB;AAEvB,mBAAO,qEAAsC,cAAc;AAAA,MAC7D;AAAA,MACA,UAAU,CAAC,YAAiB;AAC1B,cAAM,kBAAkB;AAExB,mBAAO,uEAAwC,eAAe;AAAA,MAChE;AAAA,IACF;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,wBAAwB;AAAA,IACxB,iBAAiB;AAAA,MACf,QAAQ,CAAC,YAAiB;AACxB,cAAM,iBAAiB;AAEvB,mBAAO,qEAAsC,cAAc;AAAA,MAC7D;AAAA,MACA,UAAU,CAAC,YAAiB;AAC1B,cAAM,kBAAkB;AAExB,mBAAO,uEAAwC,eAAe;AAAA,MAChE;AAAA,IACF;AAAA,EACF;AACF,CAAC;;;AChND,oCAA0C;AAKnC,IAAMC,uBAET,yDAA0B,eAAqB;","names":["provideHandlers","Intent","ChargesRejectedReason","IdentityType","provideHandlers"]}

package/build/index.mjs

@@ -0,0 +1,122 @@
+// src/service-plugins-types.ts
+var Intent = /* @__PURE__ */ ((Intent2) => {
+  Intent2["DISPLAY_ONLY"] = "DISPLAY_ONLY";
+  Intent2["CREATE_INVOICE"] = "CREATE_INVOICE";
+  return Intent2;
+})(Intent || {});
+var ChargesRejectedReason = /* @__PURE__ */ ((ChargesRejectedReason2) => {
+  ChargesRejectedReason2["UNKNOWN"] = "UNKNOWN";
+  ChargesRejectedReason2["CHARGE_LIMIT_EXCEEDED"] = "CHARGE_LIMIT_EXCEEDED";
+  ChargesRejectedReason2["TOO_MANY_CHARGES"] = "TOO_MANY_CHARGES";
+  ChargesRejectedReason2["INVALID_FORMAT"] = "INVALID_FORMAT";
+  return ChargesRejectedReason2;
+})(ChargesRejectedReason || {});
+var IdentityType = /* @__PURE__ */ ((IdentityType2) => {
+  IdentityType2["UNKNOWN"] = "UNKNOWN";
+  IdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  IdentityType2["MEMBER"] = "MEMBER";
+  IdentityType2["WIX_USER"] = "WIX_USER";
+  IdentityType2["APP"] = "APP";
+  return IdentityType2;
+})(IdentityType || {});
+
+// src/interfaces-premium-v1-custom-charges-provider.public.ts
+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";
+var 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);
+      }
+    }
+  }
+]);
+
+// src/interfaces-premium-v1-custom-charges-provider.context.ts
+import { createServicePluginModule } from "@wix/sdk-runtime/service-plugin-modules";
+var provideHandlers2 = createServicePluginModule(provideHandlers);
+export {
+  ChargesRejectedReason,
+  IdentityType,
+  Intent,
+  provideHandlers2 as provideHandlers,
+  provideHandlers as publicProvideHandlers
+};
+//# sourceMappingURL=index.mjs.map

package/build/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/service-plugins-types.ts","../src/interfaces-premium-v1-custom-charges-provider.public.ts","../src/interfaces-premium-v1-custom-charges-provider.context.ts"],"sourcesContent":["export interface GetChargeLimitRequest {\n  /**\n   * ID of the subscription for which Wix retrieves the charge limit. Equals\n   * `null` in case Wix hasn't created the subscription when retrieving an\n   * initial charge limit. To track usage and billing for apps, we recommend to\n   * use `instanceId` instead of the `subscriptionId`.\n   * @format GUID\n   */\n  subscriptionId?: string | null;\n  /**\n   * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.\n   *\n   * 3-letter currency code in\n   * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)\n   * format of the charge limit. Wix may add supported currencies in the future.\n   * @format CURRENCY\n   */\n  currency?: string;\n}\n\nexport interface GetChargeLimitResponse {\n  /**\n   * Retrieved charge limit for the app instance. You can't update the\n   * charge limit after you've set an initial value. Site owners can increase the\n   * limit in their site's dashboard, currently they aren't allowed to decrease it.\n   * @format DECIMAL_VALUE\n   * @decimalValue options { gt:0.00 }\n   */\n  chargeLimit?: string | null;\n}\n\nexport interface ListChargesRequest {\n  /**\n   * ID of the subscription for which Wix retrieves your custom charges.\n   * To track usage and billing for apps, we recommend to use `instanceId` instead\n   * of the `subscriptionId`.\n   * @format GUID\n   */\n  subscriptionId?: string;\n  /**\n   * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.\n   *\n   * 3-letter currency code in\n   * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)\n   * format of your charges to return. Wix may add supported currencies in the future.\n   * @format CURRENCY\n   */\n  currency?: string;\n  /**\n   * Begin of the period Wix retrieves the app instance's charges for in\n   * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n   */\n  periodStart?: Date | null;\n  /**\n   * End of the period Wix retrieves the app instance's charges for in\n   * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n   */\n  periodEnd?: Date | null;\n  /** Information about what Wix intends to do with the retrieved charges. */\n  intent?: Intent;\n}\n\nexport enum Intent {\n  /** Inform the customer about how much your app would charge them at the moment. Wix doesn't create an invoice. */\n  DISPLAY_ONLY = 'DISPLAY_ONLY',\n  /** Create an invoice for the customer. */\n  CREATE_INVOICE = 'CREATE_INVOICE',\n}\n\nexport interface ListChargesResponse {\n  /**\n   * Retrieved charges.\n   *\n   * Max: 5 charges\n   * @maxSize 5\n   */\n  charges?: ChargeLineItem[];\n}\n\nexport interface ChargeLineItem {\n  /**\n   * ID of the charge. Make sure to save the charge ID on your servers for future\n   * reference. Identical to `lineItem.chargeId` in the Invoice Created Event.\n   *\n   * Max: 64 characters\n   * @maxLength 64\n   */\n  _id?: string | null;\n  /** Charge description. */\n  description?: string;\n  /**\n   * Charge amount in the currency that's specified in the request. Use a whole number\n   * or separate major and minor units with a dot. For example, `10` or `1.99`. If\n   * you return an amount with more minor units than supported according to\n   * [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes),\n   * Wix truncates the additional minor units.\n   *\n   * Min: `0.50`\n   * @format DECIMAL_VALUE\n   */\n  amount?: string;\n}\n\nexport interface ChargesRejectedRequest {\n  /**\n   * ID of the subscription for which Wix hasn't accepted your custom charges.\n   * To track usage and billing for apps, we recommend to use `instanceId` instead\n   * of the `subscriptionId`.\n   * @format GUID\n   */\n  subscriptionId?: string;\n  /**\n   * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.\n   *\n   * 3-letter currency code in\n   * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)\n   * format of the charges. Wix may add supported currencies in the future.\n   * @format CURRENCY\n   */\n  currency?: string;\n  /**\n   * IDs of the rejected charges.\n   *\n   * Max: 5 charges\n   * @maxSize 5\n   */\n  chargeIds?: string[] | null;\n  /**\n   * Maximum amount that your app may charge the customer per billing cycle.\n   *\n   * Min: `0.50`\n   * @format DECIMAL_VALUE\n   * @decimalValue options { gt:0.00 }\n   */\n  chargeLimit?: string | null;\n  /**\n   * Information about why Wix has rejected your app's charges.\n   *\n   * Max: 20 reasons\n   * @maxSize 20\n   */\n  reasons?: ChargesRejectedReason[];\n}\n\nexport enum ChargesRejectedReason {\n  /** There is no information about why Wix has rejected the charges. */\n  UNKNOWN = 'UNKNOWN',\n  /** The sum of the charges is higher than the limit that you may charge the customer per billing cycle. */\n  CHARGE_LIMIT_EXCEEDED = 'CHARGE_LIMIT_EXCEEDED',\n  /** You can't provide more than 5 charges per invoice. */\n  TOO_MANY_CHARGES = 'TOO_MANY_CHARGES',\n  /** 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. */\n  INVALID_FORMAT = 'INVALID_FORMAT',\n}\n\nexport interface ChargesRejectedResponse {}\n\nexport interface InvoiceCreatedRequest {\n  /**\n   * ID of the subscription for which Wix has created an invoice that includes\n   * your custom charges. To track usage and billing for apps, we recommend to use\n   * `instanceId` instead of the `subscriptionId`.\n   * @format GUID\n   */\n  subscriptionId?: string;\n  /**\n   * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.\n   *\n   * 3-letter currency code in\n   * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)\n   * format of the charges. Wix may add supported currencies in the future.\n   * @format CURRENCY\n   */\n  currency?: string;\n  /** ID of the created invoice. */\n  invoiceId?: string;\n  /**\n   * Line items included in the invoice.\n   * @maxSize 5\n   */\n  lineItems?: InvoiceLineItem[];\n}\n\nexport interface InvoiceLineItem {\n  /**\n   * ID of the charge as returned in List Charges.\n   *\n   * Max: 64 characters\n   * @maxLength 64\n   */\n  chargeId?: string | null;\n  /**\n   * Charge amount.\n   * @format DECIMAL_VALUE\n   */\n  amount?: string;\n  /**\n   * ID of the line item in the invoice that Wix sends to the customer.\n   * @format GUID\n   */\n  _id?: string;\n}\n\nexport interface InvoiceCreatedResponse {}\n\nexport interface ChargeLimitUpdatedRequest {\n  /**\n   * ID of the subscription for which the charge limit has been updated.\n   * To track usage and billing for apps, we recommend to use `instanceId` instead\n   * of the `subscriptionId`.\n   * @format GUID\n   */\n  subscriptionId?: string;\n  /**\n   * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.\n   *\n   * 3-letter currency code in\n   * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)\n   * format of the charges. Wix may add supported currencies in the future.\n   * @format CURRENCY\n   */\n  currency?: string;\n  /**\n   * Updated charge limit.\n   * @format DECIMAL_VALUE\n   */\n  chargeLimit?: string | null;\n}\n\nexport interface ChargeLimitUpdatedResponse {}\n\nexport interface CustomChargesConfig {\n  /**\n   * Base part of your integration's deployment URI for the Custom Charges SPI.\n   * For example `\"https://provider.example.com\"`, if Wix should call your\n   * integration at `https://provider.example.com/v1/charge-limit` for the\n   * Get Charge Limit method.\n   */\n  baseUri?: SpiBaseUri;\n}\n\nexport interface SpiBaseUri {\n  /**\n   * Base URI where the methods are called. Wix appends the path to the `baseUri`.\n   * 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/`.\n   * @minLength 6\n   * @maxLength 2048\n   */\n  baseUri?: string;\n  /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */\n  alternativeUris?: AlternativeUri[];\n}\n\nexport interface AlternativeUri {\n  /**\n   * Name of the method to create a custom URI for.\n   *\n   * For `methodName`, use the name of the method in PascalCase.\n   * For example, for Get Shipping Rates use `GetShippingRates`.\n   * @minLength 3\n   * @maxLength 128\n   */\n  methodName?: string;\n  /**\n   * 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.\n   * Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.\n   * @minLength 6\n   * @maxLength 2048\n   */\n  absoluteUri?: string;\n}\n\n/**\n * this message is not directly used by any service,\n * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.\n * e.g. SPIs, event-handlers, etc..\n * NOTE: this context object MUST be provided as the last argument in each Velo method signature.\n *\n * Example:\n * ```typescript\n * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {\n * ...\n * }\n * ```\n */\nexport interface Context {\n  /** 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. */\n  requestId?: string | null;\n  /**\n   * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.\n   * @format CURRENCY\n   */\n  currency?: string | null;\n  /** An object that describes the identity that triggered this request. */\n  identity?: IdentificationData;\n  /** 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\"`. */\n  languages?: string[];\n  /**\n   * The service provider app's instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n}\n\nexport enum IdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: IdentityType;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n","import { ServicePluginDefinition } from '@wix/sdk-types';\nimport {\n  Context,\n  GetChargeLimitRequest,\n  GetChargeLimitResponse,\n  ListChargesRequest,\n  ListChargesResponse,\n  ChargesRejectedRequest,\n  ChargesRejectedResponse,\n  InvoiceCreatedRequest,\n  InvoiceCreatedResponse,\n  ChargeLimitUpdatedRequest,\n  ChargeLimitUpdatedResponse,\n} from './service-plugins-types.js';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\n\nexport interface GetChargeLimitEnvelope {\n  request: GetChargeLimitRequest;\n  metadata: Context;\n}\n\nexport interface ListChargesEnvelope {\n  request: ListChargesRequest;\n  metadata: Context;\n}\n\nexport interface ChargesRejectedEventEnvelope {\n  request: ChargesRejectedRequest;\n  metadata: Context;\n}\n\nexport interface InvoiceCreatedEventEnvelope {\n  request: InvoiceCreatedRequest;\n  metadata: Context;\n}\n\nexport interface ChargeLimitUpdatedEventEnvelope {\n  request: ChargeLimitUpdatedRequest;\n  metadata: Context;\n}\n\nexport const provideHandlers = ServicePluginDefinition<{\n  /**\n   *\n   * Wix calls this method to retrieve the initial charge limit for a paid instance\n   * of your app. This happens every time a customer is upgrading to a paid version of\n   * your app.\n   *\n   * You can't update the charge limit after you've set an initial\n   * value. Customers can increase the limit in their site's dashboard, currently they\n   * aren't allowed to decrease it. */\n  getChargeLimit(\n    payload: GetChargeLimitEnvelope\n  ): GetChargeLimitResponse | Promise<GetChargeLimitResponse>;\n\n  /**\n   *\n   * Wix calls this method to retrieve a list of charges for a paid instance\n   * of your app. This happens when Wix creates an invoice or in case the customer\n   * wants to preview how much your app would charge them at the moment.\n   *\n   * You must return the charges in the currency that's specified in the request,\n   * you aren't allowed to return more than 5 charges, and their sum must be lower\n   * than the charge limit.\n   *\n   * You may not bill customers for any usage that didn’t occur during the period\n   * Wix specifies when retrieving the charges. If Wix discovers that your app has\n   * charged customers for usage outside of an invoice's specified period, we may\n   * take action such as blocking your app from charging the customer, removing\n   * your app from the Wix App Market, revoking your access to the Wix developer\n   * program, or pursuing legal action to recover damages caused by overcharging.\n   * We understand that mistakes can happen and encourage you to contact\n   * [the Wix App Market team](https://devforum.wix.com/kb/en/contact) immediately if you\n   * become aware of any overcharging issues so that we can work together to\n   * resolve the situation. */\n  listCharges(\n    payload: ListChargesEnvelope\n  ): ListChargesResponse | Promise<ListChargesResponse>;\n\n  /**\n   *\n   * Triggered in case Wix doesn't accept the charges you've returned in the\n   * List Charges method.\n   *\n   *\n   * You aren't allowed to charge a site owner more than the charge limit. Wix\n   * call List Charges in regular intervals until the sum of all charges is lower than the\n   * charge limit. Wix doesn't create an invoice in case the charges aren't accepted. */\n  chargesRejectedEvent(\n    payload: ChargesRejectedEventEnvelope\n  ): ChargesRejectedResponse | Promise<ChargesRejectedResponse>;\n\n  /**\n   *\n   * Triggered in case Wix creates an invoice that includes charges for an instance\n   * of your app. */\n  invoiceCreatedEvent(\n    payload: InvoiceCreatedEventEnvelope\n  ): InvoiceCreatedResponse | Promise<InvoiceCreatedResponse>;\n\n  /**\n   *\n   * Triggered in case the charge limit for an instance of your app is updated.\n   *\n   *\n   * You can't update the charge limit after you've set an initial\n   * value. Site owners can increase the limit in their site's dashboard,\n   * currently they aren't allowed to decrease it. */\n  chargeLimitUpdatedEvent(\n    payload: ChargeLimitUpdatedEventEnvelope\n  ): ChargeLimitUpdatedResponse | Promise<ChargeLimitUpdatedResponse>;\n}>('PREMIUM_CUSTOM_CHARGES', [\n  {\n    name: 'getChargeLimit',\n    primaryHttpMappingPath: '/v1/charge-limit',\n    transformations: {\n      toREST: (payload: any) => {\n        const toRestResponse = payload;\n\n        return renameKeysFromSDKRequestToRESTRequest(toRestResponse);\n      },\n      fromREST: (payload: any) => {\n        const fromRestRequest = payload;\n\n        return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);\n      },\n    },\n  },\n\n  {\n    name: 'listCharges',\n    primaryHttpMappingPath: '/v1/charges',\n    transformations: {\n      toREST: (payload: any) => {\n        const toRestResponse = payload;\n\n        return renameKeysFromSDKRequestToRESTRequest(toRestResponse);\n      },\n      fromREST: (payload: any) => {\n        const fromRestRequest = transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [\n              { path: 'request.periodStart' },\n              { path: 'request.periodEnd' },\n            ],\n          },\n        ]);\n\n        return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);\n      },\n    },\n  },\n\n  {\n    name: 'chargesRejectedEvent',\n    primaryHttpMappingPath: '/v1/charges-rejected',\n    transformations: {\n      toREST: (payload: any) => {\n        const toRestResponse = payload;\n\n        return renameKeysFromSDKRequestToRESTRequest(toRestResponse);\n      },\n      fromREST: (payload: any) => {\n        const fromRestRequest = payload;\n\n        return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);\n      },\n    },\n  },\n\n  {\n    name: 'invoiceCreatedEvent',\n    primaryHttpMappingPath: '/v1/invoice-created',\n    transformations: {\n      toREST: (payload: any) => {\n        const toRestResponse = payload;\n\n        return renameKeysFromSDKRequestToRESTRequest(toRestResponse);\n      },\n      fromREST: (payload: any) => {\n        const fromRestRequest = payload;\n\n        return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);\n      },\n    },\n  },\n\n  {\n    name: 'chargeLimitUpdatedEvent',\n    primaryHttpMappingPath: '/v1/limit-updated',\n    transformations: {\n      toREST: (payload: any) => {\n        const toRestResponse = payload;\n\n        return renameKeysFromSDKRequestToRESTRequest(toRestResponse);\n      },\n      fromREST: (payload: any) => {\n        const fromRestRequest = payload;\n\n        return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);\n      },\n    },\n  },\n]);\n","import './interfaces-premium-v1-custom-charges-provider.public.js';\nimport { createServicePluginModule } from '@wix/sdk-runtime/service-plugin-modules';\nimport { provideHandlers as publicProvideHandlers } from './interfaces-premium-v1-custom-charges-provider.public.js';\n\nexport { publicProvideHandlers };\n\nexport const provideHandlers: ReturnType<\n  typeof createServicePluginModule<typeof publicProvideHandlers>\n> = createServicePluginModule(publicProvideHandlers);\n"],"mappings":";AA8DO,IAAK,SAAL,kBAAKA,YAAL;AAEL,EAAAA,QAAA,kBAAe;AAEf,EAAAA,QAAA,oBAAiB;AAJP,SAAAA;AAAA,GAAA;AAkFL,IAAK,wBAAL,kBAAKC,2BAAL;AAEL,EAAAA,uBAAA,aAAU;AAEV,EAAAA,uBAAA,2BAAwB;AAExB,EAAAA,uBAAA,sBAAmB;AAEnB,EAAAA,uBAAA,oBAAiB;AARP,SAAAA;AAAA,GAAA;AAgKL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,uBAAoB;AACpB,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,cAAW;AACX,EAAAA,cAAA,SAAM;AALI,SAAAA;AAAA,GAAA;;;AChTZ,SAAS,+BAA+B;AAcxC,SAAS,4CAA4C;AACrD,SAAS,sBAAsB;AAC/B;AAAA,EACE;AAAA,EACA;AAAA,OACK;AA2BA,IAAM,kBAAkB,wBAsE5B,0BAA0B;AAAA,EAC3B;AAAA,IACE,MAAM;AAAA,IACN,wBAAwB;AAAA,IACxB,iBAAiB;AAAA,MACf,QAAQ,CAAC,YAAiB;AACxB,cAAM,iBAAiB;AAEvB,eAAO,sCAAsC,cAAc;AAAA,MAC7D;AAAA,MACA,UAAU,CAAC,YAAiB;AAC1B,cAAM,kBAAkB;AAExB,eAAO,wCAAwC,eAAe;AAAA,MAChE;AAAA,IACF;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,wBAAwB;AAAA,IACxB,iBAAiB;AAAA,MACf,QAAQ,CAAC,YAAiB;AACxB,cAAM,iBAAiB;AAEvB,eAAO,sCAAsC,cAAc;AAAA,MAC7D;AAAA,MACA,UAAU,CAAC,YAAiB;AAC1B,cAAM,kBAAkB,eAAe,SAAS;AAAA,UAC9C;AAAA,YACE,aAAa;AAAA,YACb,OAAO;AAAA,cACL,EAAE,MAAM,sBAAsB;AAAA,cAC9B,EAAE,MAAM,oBAAoB;AAAA,YAC9B;AAAA,UACF;AAAA,QACF,CAAC;AAED,eAAO,wCAAwC,eAAe;AAAA,MAChE;AAAA,IACF;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,wBAAwB;AAAA,IACxB,iBAAiB;AAAA,MACf,QAAQ,CAAC,YAAiB;AACxB,cAAM,iBAAiB;AAEvB,eAAO,sCAAsC,cAAc;AAAA,MAC7D;AAAA,MACA,UAAU,CAAC,YAAiB;AAC1B,cAAM,kBAAkB;AAExB,eAAO,wCAAwC,eAAe;AAAA,MAChE;AAAA,IACF;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,wBAAwB;AAAA,IACxB,iBAAiB;AAAA,MACf,QAAQ,CAAC,YAAiB;AACxB,cAAM,iBAAiB;AAEvB,eAAO,sCAAsC,cAAc;AAAA,MAC7D;AAAA,MACA,UAAU,CAAC,YAAiB;AAC1B,cAAM,kBAAkB;AAExB,eAAO,wCAAwC,eAAe;AAAA,MAChE;AAAA,IACF;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,wBAAwB;AAAA,IACxB,iBAAiB;AAAA,MACf,QAAQ,CAAC,YAAiB;AACxB,cAAM,iBAAiB;AAEvB,eAAO,sCAAsC,cAAc;AAAA,MAC7D;AAAA,MACA,UAAU,CAAC,YAAiB;AAC1B,cAAM,kBAAkB;AAExB,eAAO,wCAAwC,eAAe;AAAA,MAChE;AAAA,IACF;AAAA,EACF;AACF,CAAC;;;AChND,SAAS,iCAAiC;AAKnC,IAAMC,mBAET,0BAA0B,eAAqB;","names":["Intent","ChargesRejectedReason","IdentityType","provideHandlers"]}

package/build/{es/src/service-plugins-types.d.ts → internal/index.d.mts}

@@ -1,4 +1,7 @@
-export interface GetChargeLimitRequest {
+import { createServicePluginModule } from '@wix/sdk-runtime/service-plugin-modules';
+import { ServicePluginDefinition } from '@wix/sdk-types';
+
+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
@@ -17,7 +20,7 @@ export interface GetChargeLimitRequest {
      */
     currency?: string;
 }
-export interface GetChargeLimitResponse {
+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
@@ -27,7 +30,7 @@ export interface GetChargeLimitResponse {
      */
     chargeLimit?: string | null;
 }
-export interface ListChargesRequest {
+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
@@ -57,13 +60,13 @@ export interface ListChargesRequest {
     /** Information about what Wix intends to do with the retrieved charges. */
     intent?: Intent;
 }
-export declare enum Intent {
+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 {
+interface ListChargesResponse {
     /**
      * Retrieved charges.
      *
@@ -72,7 +75,7 @@ export interface ListChargesResponse {
      */
     charges?: ChargeLineItem[];
 }
-export interface ChargeLineItem {
+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.
@@ -95,7 +98,7 @@ export interface ChargeLineItem {
      */
     amount?: string;
 }
-export interface ChargesRejectedRequest {
+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
@@ -135,7 +138,7 @@ export interface ChargesRejectedRequest {
      */
     reasons?: ChargesRejectedReason[];
 }
-export declare enum ChargesRejectedReason {
+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. */
@@ -145,9 +148,9 @@ export declare enum ChargesRejectedReason {
     /** 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 {
+interface ChargesRejectedResponse {
 }
-export interface InvoiceCreatedRequest {
+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
@@ -172,7 +175,7 @@ export interface InvoiceCreatedRequest {
      */
     lineItems?: InvoiceLineItem[];
 }
-export interface InvoiceLineItem {
+interface InvoiceLineItem {
     /**
      * ID of the charge as returned in List Charges.
      *
@@ -191,9 +194,9 @@ export interface InvoiceLineItem {
      */
     _id?: string;
 }
-export interface InvoiceCreatedResponse {
+interface InvoiceCreatedResponse {
 }
-export interface ChargeLimitUpdatedRequest {
+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
@@ -216,9 +219,9 @@ export interface ChargeLimitUpdatedRequest {
      */
     chargeLimit?: string | null;
 }
-export interface ChargeLimitUpdatedResponse {
+interface ChargeLimitUpdatedResponse {
 }
-export interface CustomChargesConfig {
+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
@@ -227,7 +230,7 @@ export interface CustomChargesConfig {
      */
     baseUri?: SpiBaseUri;
 }
-export interface SpiBaseUri {
+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/`.
@@ -238,7 +241,7 @@ export interface SpiBaseUri {
     /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */
     alternativeUris?: AlternativeUri[];
 }
-export interface AlternativeUri {
+interface AlternativeUri {
     /**
      * Name of the method to create a custom URI for.
      *
@@ -269,7 +272,7 @@ export interface AlternativeUri {
  * }
  * ```
  */
-export interface Context {
+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;
     /**
@@ -287,14 +290,14 @@ export interface Context {
      */
     instanceId?: string | null;
 }
-export declare enum IdentityType {
+declare enum IdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -319,7 +322,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: IdentityType;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -341,3 +344,85 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
+
+interface GetChargeLimitEnvelope {
+    request: GetChargeLimitRequest;
+    metadata: Context;
+}
+interface ListChargesEnvelope {
+    request: ListChargesRequest;
+    metadata: Context;
+}
+interface ChargesRejectedEventEnvelope {
+    request: ChargesRejectedRequest;
+    metadata: Context;
+}
+interface InvoiceCreatedEventEnvelope {
+    request: InvoiceCreatedRequest;
+    metadata: Context;
+}
+interface ChargeLimitUpdatedEventEnvelope {
+    request: ChargeLimitUpdatedRequest;
+    metadata: Context;
+}
+declare const provideHandlers$1: 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>;
+}>;
+
+declare const provideHandlers: ReturnType<typeof createServicePluginModule<typeof publicProvideHandlers>>;
+
+export { type AlternativeUri, type ChargeLimitUpdatedRequest, type ChargeLimitUpdatedResponse, type ChargeLineItem, ChargesRejectedReason, type ChargesRejectedRequest, type ChargesRejectedResponse, type Context, type CustomChargesConfig, type GetChargeLimitRequest, type GetChargeLimitResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, Intent, type InvoiceCreatedRequest, type InvoiceCreatedResponse, type InvoiceLineItem, type ListChargesRequest, type ListChargesResponse, type SpiBaseUri, provideHandlers, provideHandlers$1 as publicProvideHandlers };