@wix/auto_sdk_app-management_billing 1.0.7 → 1.0.9

package/build/{internal/devcenter-checkout-v1-purchased-item-billing.universal-Bv6aTKH_.d.mts → cjs/src/devcenter-checkout-v1-purchased-item-billing.types.d.ts}

@@ -1,4 +1,4 @@
-interface PurchasedItem {
+export interface PurchasedItem {
     /** ID of your app's paid plan. */
     productId?: string;
     /** Price of your app's paid plan. For example, `9.95`. */
@@ -16,7 +16,7 @@ interface PurchasedItem {
      */
     dateCreated?: Date | null;
 }
-declare enum PaymentCycle {
+export declare enum PaymentCycle {
     NO_CYCLE = "NO_CYCLE",
     MONTHLY = "MONTHLY",
     YEARLY = "YEARLY",
@@ -26,7 +26,7 @@ declare enum PaymentCycle {
     FOUR_YEARS = "FOUR_YEARS",
     FIVE_YEARS = "FIVE_YEARS"
 }
-interface InvoiceStatusUpdated {
+export interface InvoiceStatusUpdated {
     /** Invoice payment status. */
     status?: InvoiceStatus;
     /**
@@ -42,7 +42,7 @@ interface InvoiceStatusUpdated {
     /** Whether the invoice is for a single payment or for multiple, recurring payments. */
     recurring?: boolean;
 }
-declare enum InvoiceStatus {
+export declare enum InvoiceStatus {
     UNKNOWN_INVOICE_STATUS = "UNKNOWN_INVOICE_STATUS",
     PAYMENT_FAILED = "PAYMENT_FAILED",
     PAID = "PAID",
@@ -50,7 +50,7 @@ declare enum InvoiceStatus {
     VOIDED = "VOIDED",
     CHARGEDBACK = "CHARGEDBACK"
 }
-interface GetUrlRequest {
+export interface GetUrlRequest {
     /**
      * ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
      * for a list of your app's supported product IDs.
@@ -88,7 +88,7 @@ interface GetUrlRequest {
     /** Coupon code for the paid plan. Available only in case there is a discount. */
     couponCode?: string | null;
 }
-interface ChargeOverride {
+export interface ChargeOverride {
     /**
      * Override price. In case you omit the override price, Wix charges site
      * owners the app's default price that's configured in the Pricing page of your app's dashboard.
@@ -100,7 +100,7 @@ interface ChargeOverride {
      */
     currency?: string;
 }
-interface GetUrlResponse {
+export interface GetUrlResponse {
     /**
      * URL for the Wix checkout page.
      * @format WEB_URL
@@ -113,15 +113,15 @@ interface GetUrlResponse {
      */
     token?: string | null;
 }
-interface GetPurchaseHistoryRequest {
+export interface GetPurchaseHistoryRequest {
 }
-interface GetPurchaseHistoryResponse {
+export interface GetPurchaseHistoryResponse {
     /** Retrieved purchases the site owners have completed for you app. */
     purchases?: PurchasedItem[];
 }
-interface GetSitePaymentMethodsStatusRequest {
+export interface GetSitePaymentMethodsStatusRequest {
 }
-interface GetSitePaymentMethodsStatusResponse {
+export interface GetSitePaymentMethodsStatusResponse {
     /**
      * Whether the site owners have enabled at least a single online payment method.
      * Online payment methods include Wix Payments, Stripe, PayPal, and credit
@@ -142,7 +142,7 @@ interface GetSitePaymentMethodsStatusResponse {
      */
     thirdPartyPosProviderEnabled?: boolean;
 }
-interface GetMeteredBillingChargesRequest {
+export interface GetMeteredBillingChargesRequest {
     /**
      * 3-letter currency code in
      * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
@@ -160,13 +160,13 @@ interface GetMeteredBillingChargesRequest {
      */
     endDate?: Date | null;
 }
-interface GetMeteredBillingChargesResponse {
+export interface GetMeteredBillingChargesResponse {
     /** List of retrieved custom charges. */
     charges?: Charge[];
 }
-interface Charge {
+export interface Charge {
     /** ID of the custom charge. The ID consists of 64 characters. */
-    _id?: string | null;
+    id?: string | null;
     /** Description of the custom charge. */
     description?: string;
     /**
@@ -178,7 +178,7 @@ interface Charge {
      */
     amount?: string;
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -194,7 +194,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -219,7 +219,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -241,81 +241,10 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface BaseEventMetadata {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-}
-interface PurchasedItemInvoiceStatusUpdatedEnvelope {
-    data: InvoiceStatusUpdated;
-    metadata: BaseEventMetadata;
-}
-interface GetUrlOptions {
-    /**
-     * URL for the Wix checkout page. Redirect site owners to this URL after
-     * they've successfully purchased a paid plan for your app.
-     * @format WEB_URL
-     */
-    successUrl?: string | null;
-    /**
-     * Whether the checkout is for testing purposes only. Testing is mainly
-     * relevant for in-app purchase flows. When `true`, Wix charges the site
-     * owners an amount of `0.00`.
-     */
-    testCheckout?: boolean;
-    /** Information about the paid plan's billing cycle. */
-    billingCycle?: PaymentCycle;
-    /**
-     * 2-letter country code in
-     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
-     * format.
-     *
-     * Default: `"US"`
-     */
-    countryCode?: string | null;
-    /**
-     * 2-letter language code in
-     * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
-     *
-     * Default: `"EN"`
-     */
-    languageCode?: string | null;
-    /** Coupon code for the paid plan. Available only in case there is a discount. */
-    couponCode?: string | null;
-}
-interface GetMeteredBillingChargesOptions {
-    /**
-     * 3-letter currency code in
-     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
-     * @format CURRENCY
-     */
-    currency?: string | null;
-    /**
-     * Start of the period you want to retrieve the custom charges for in
-     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
-     */
-    startDate?: Date | null;
-    /**
-     * End of the period you want to retrieve the custom charges for in
-     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
-     */
-    endDate?: Date | null;
-}
-
-export { type BaseEventMetadata as B, type ChargeOverride as C, type GetUrlOptions as G, InvoiceStatus as I, type MessageEnvelope as M, PaymentCycle as P, WebhookIdentityType as W, type GetUrlResponse as a, type GetPurchaseHistoryResponse as b, type GetMeteredBillingChargesOptions as c, type GetMeteredBillingChargesResponse as d, type PurchasedItem as e, type InvoiceStatusUpdated as f, type GetUrlRequest as g, type GetPurchaseHistoryRequest as h, type GetSitePaymentMethodsStatusRequest as i, type GetSitePaymentMethodsStatusResponse as j, type GetMeteredBillingChargesRequest as k, type Charge as l, type IdentificationData as m, type IdentificationDataIdOneOf as n, type PurchasedItemInvoiceStatusUpdatedEnvelope as o };

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

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookIdentityType = exports.InvoiceStatus = exports.PaymentCycle = void 0;
+var PaymentCycle;
+(function (PaymentCycle) {
+    PaymentCycle["NO_CYCLE"] = "NO_CYCLE";
+    PaymentCycle["MONTHLY"] = "MONTHLY";
+    PaymentCycle["YEARLY"] = "YEARLY";
+    PaymentCycle["ONE_TIME"] = "ONE_TIME";
+    PaymentCycle["TWO_YEARS"] = "TWO_YEARS";
+    PaymentCycle["THREE_YEARS"] = "THREE_YEARS";
+    PaymentCycle["FOUR_YEARS"] = "FOUR_YEARS";
+    PaymentCycle["FIVE_YEARS"] = "FIVE_YEARS";
+})(PaymentCycle || (exports.PaymentCycle = PaymentCycle = {}));
+var InvoiceStatus;
+(function (InvoiceStatus) {
+    InvoiceStatus["UNKNOWN_INVOICE_STATUS"] = "UNKNOWN_INVOICE_STATUS";
+    InvoiceStatus["PAYMENT_FAILED"] = "PAYMENT_FAILED";
+    InvoiceStatus["PAID"] = "PAID";
+    InvoiceStatus["REFUNDED"] = "REFUNDED";
+    InvoiceStatus["VOIDED"] = "VOIDED";
+    InvoiceStatus["CHARGEDBACK"] = "CHARGEDBACK";
+})(InvoiceStatus || (exports.InvoiceStatus = InvoiceStatus = {}));
+var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
+//# sourceMappingURL=devcenter-checkout-v1-purchased-item-billing.types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"devcenter-checkout-v1-purchased-item-billing.types.js","sourceRoot":"","sources":["../../../src/devcenter-checkout-v1-purchased-item-billing.types.ts"],"names":[],"mappings":";;;AAmBA,IAAY,YASX;AATD,WAAY,YAAY;IACtB,qCAAqB,CAAA;IACrB,mCAAmB,CAAA;IACnB,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,uCAAuB,CAAA;IACvB,2CAA2B,CAAA;IAC3B,yCAAyB,CAAA;IACzB,yCAAyB,CAAA;AAC3B,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AAmBD,IAAY,aAOX;AAPD,WAAY,aAAa;IACvB,kEAAiD,CAAA;IACjD,kDAAiC,CAAA;IACjC,8BAAa,CAAA;IACb,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;IACjB,4CAA2B,CAAA;AAC7B,CAAC,EAPW,aAAa,6BAAb,aAAa,QAOxB;AA4MD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}

package/build/{devcenter-checkout-v1-purchased-item-billing.universal-BvkvBr8A.d.mts → cjs/src/devcenter-checkout-v1-purchased-item-billing.universal.d.ts}

@@ -1,4 +1,5 @@
-interface PurchasedItem {
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface PurchasedItem {
     /** ID of your app's paid plan. */
     productId?: string;
     /** Price of your app's paid plan. For example, `9.95`. */
@@ -16,7 +17,7 @@ interface PurchasedItem {
      */
     dateCreated?: Date | null;
 }
-declare enum PaymentCycle {
+export declare enum PaymentCycle {
     NO_CYCLE = "NO_CYCLE",
     MONTHLY = "MONTHLY",
     YEARLY = "YEARLY",
@@ -26,7 +27,7 @@ declare enum PaymentCycle {
     FOUR_YEARS = "FOUR_YEARS",
     FIVE_YEARS = "FIVE_YEARS"
 }
-interface InvoiceStatusUpdated {
+export interface InvoiceStatusUpdated {
     /** Invoice payment status. */
     status?: InvoiceStatus;
     /**
@@ -42,7 +43,7 @@ interface InvoiceStatusUpdated {
     /** Whether the invoice is for a single payment or for multiple, recurring payments. */
     recurring?: boolean;
 }
-declare enum InvoiceStatus {
+export declare enum InvoiceStatus {
     UNKNOWN_INVOICE_STATUS = "UNKNOWN_INVOICE_STATUS",
     PAYMENT_FAILED = "PAYMENT_FAILED",
     PAID = "PAID",
@@ -50,7 +51,7 @@ declare enum InvoiceStatus {
     VOIDED = "VOIDED",
     CHARGEDBACK = "CHARGEDBACK"
 }
-interface GetUrlRequest {
+export interface GetUrlRequest {
     /**
      * ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
      * for a list of your app's supported product IDs.
@@ -88,7 +89,7 @@ interface GetUrlRequest {
     /** Coupon code for the paid plan. Available only in case there is a discount. */
     couponCode?: string | null;
 }
-interface ChargeOverride {
+export interface ChargeOverride {
     /**
      * Override price. In case you omit the override price, Wix charges site
      * owners the app's default price that's configured in the Pricing page of your app's dashboard.
@@ -100,7 +101,7 @@ interface ChargeOverride {
      */
     currency?: string;
 }
-interface GetUrlResponse {
+export interface GetUrlResponse {
     /**
      * URL for the Wix checkout page.
      * @format WEB_URL
@@ -113,15 +114,15 @@ interface GetUrlResponse {
      */
     token?: string | null;
 }
-interface GetPurchaseHistoryRequest {
+export interface GetPurchaseHistoryRequest {
 }
-interface GetPurchaseHistoryResponse {
+export interface GetPurchaseHistoryResponse {
     /** Retrieved purchases the site owners have completed for you app. */
     purchases?: PurchasedItem[];
 }
-interface GetSitePaymentMethodsStatusRequest {
+export interface GetSitePaymentMethodsStatusRequest {
 }
-interface GetSitePaymentMethodsStatusResponse {
+export interface GetSitePaymentMethodsStatusResponse {
     /**
      * Whether the site owners have enabled at least a single online payment method.
      * Online payment methods include Wix Payments, Stripe, PayPal, and credit
@@ -142,7 +143,7 @@ interface GetSitePaymentMethodsStatusResponse {
      */
     thirdPartyPosProviderEnabled?: boolean;
 }
-interface GetMeteredBillingChargesRequest {
+export interface GetMeteredBillingChargesRequest {
     /**
      * 3-letter currency code in
      * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
@@ -160,11 +161,11 @@ interface GetMeteredBillingChargesRequest {
      */
     endDate?: Date | null;
 }
-interface GetMeteredBillingChargesResponse {
+export interface GetMeteredBillingChargesResponse {
     /** List of retrieved custom charges. */
     charges?: Charge[];
 }
-interface Charge {
+export interface Charge {
     /** ID of the custom charge. The ID consists of 64 characters. */
     _id?: string | null;
     /** Description of the custom charge. */
@@ -178,7 +179,7 @@ interface Charge {
      */
     amount?: string;
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -194,7 +195,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -219,7 +220,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -241,14 +242,14 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface BaseEventMetadata {
+export interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -262,11 +263,51 @@ interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-interface PurchasedItemInvoiceStatusUpdatedEnvelope {
+export interface PurchasedItemInvoiceStatusUpdatedEnvelope {
     data: InvoiceStatusUpdated;
     metadata: BaseEventMetadata;
 }
-interface GetUrlOptions {
+/**
+ * Triggered when there is an update to the payment status of an invoice.
+ * Charges made using the [Custom Charges SPI](https://dev.wix.com/docs/rest/app-management/app-billing/custom-charges-service-plugin/introduction) may be based on usage.
+ * Learn more about [usage-based charges](https://dev.wix.com/docs/build-apps/launch-your-app/pricing-and-billing/set-up-a-usage-based-business-model).
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE
+ * @webhook
+ * @eventType InvoiceStatusUpdated
+ * @serviceIdentifier com.wixpress.market.aim.api.Checkout
+ * @slug invoice_status_updated
+ */
+export declare function onPurchasedItemInvoiceStatusUpdated(handler: (event: PurchasedItemInvoiceStatusUpdatedEnvelope) => void | Promise<void>): void;
+type PurchasedItemNonNullablePaths = `productId` | `price` | `currency` | `billingCycle`;
+/**
+ * Retrieves the URL for a Wix checkout page for the specified paid plan of your app.
+ *
+ *
+ * This call succeeds only in case you have previously
+ * [set up an external pricing page in your app's dashboard](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-an-external-pricing-page).
+ *
+ * The returned checkout URL is valid for 48 hours.
+ *
+ * This API allows your app to manage your pricing page outside of Wix while
+ * still using the standard Wix checkout flow.
+ * @param productId - ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
+ * for a list of your app's supported product IDs.
+ * @public
+ * @requiredField productId
+ * @permissionId WIX_DEVELOPERS.CREATE_CHECKOUT
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @applicableIdentity APP
+ * @fqn com.wixpress.market.aim.api.Checkout.GetUrl
+ */
+export declare function getUrl(productId: string, options?: GetUrlOptions): Promise<NonNullablePaths<GetUrlResponse, `checkoutUrl`>>;
+export interface GetUrlOptions {
     /**
      * URL for the Wix checkout page. Redirect site owners to this URL after
      * they've successfully purchased a paid plan for your app.
@@ -299,7 +340,27 @@ interface GetUrlOptions {
     /** Coupon code for the paid plan. Available only in case there is a discount. */
     couponCode?: string | null;
 }
-interface GetMeteredBillingChargesOptions {
+/**
+ * Retrieves a list of the site owner's past purchases for your app.
+ *
+ *
+ * You don't have to explicitly pass an identifier for the Wix site as part of
+ * the request, since this information is taken automatically from the context.
+ *
+ * The response doesn't include any details about cancellations.
+ * @public
+ * @permissionId WIX_DEVELOPERS.APP_PURCHASE_HISTORY
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @applicableIdentity APP
+ * @fqn com.wixpress.market.aim.api.Checkout.GetPurchaseHistory
+ */
+export declare function getPurchaseHistory(): Promise<NonNullablePaths<GetPurchaseHistoryResponse, {
+    [P in PurchasedItemNonNullablePaths]: `purchases.${number}.${P}`;
+}[PurchasedItemNonNullablePaths]>>;
+export interface GetMeteredBillingChargesOptions {
     /**
      * 3-letter currency code in
      * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
@@ -317,5 +378,4 @@ interface GetMeteredBillingChargesOptions {
      */
     endDate?: Date | null;
 }
-
-export { type BaseEventMetadata as B, type ChargeOverride as C, type GetUrlOptions as G, InvoiceStatus as I, type MessageEnvelope as M, PaymentCycle as P, WebhookIdentityType as W, type GetUrlResponse as a, type GetPurchaseHistoryResponse as b, type PurchasedItem as c, type InvoiceStatusUpdated as d, type GetUrlRequest as e, type GetPurchaseHistoryRequest as f, type GetSitePaymentMethodsStatusRequest as g, type GetSitePaymentMethodsStatusResponse as h, type GetMeteredBillingChargesRequest as i, type GetMeteredBillingChargesResponse as j, type Charge as k, type IdentificationData as l, type IdentificationDataIdOneOf as m, type PurchasedItemInvoiceStatusUpdatedEnvelope as n, type GetMeteredBillingChargesOptions as o };
+export {};