@wix/auto_sdk_app-management_billing 1.0.8 → 1.0.9

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

@@ -0,0 +1,53 @@
+import { EventDefinition, HttpClient } from '@wix/sdk-types';
+import { GetMeteredBillingChargesOptions, GetMeteredBillingChargesResponse, GetPurchaseHistoryResponse, GetUrlOptions, GetUrlResponse, PurchasedItemInvoiceStatusUpdatedEnvelope } from './devcenter-checkout-v1-purchased-item-billing.universal.js';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function getUrl(httpClient: HttpClient): GetUrlSignature;
+interface GetUrlSignature {
+    /**
+     * 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 - ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
+     * for a list of your app's supported product IDs.
+     */
+    (productId: string, options?: GetUrlOptions | undefined): Promise<GetUrlResponse>;
+}
+export declare function getPurchaseHistory(httpClient: HttpClient): GetPurchaseHistorySignature;
+interface GetPurchaseHistorySignature {
+    /**
+     * 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.
+     */
+    (): Promise<GetPurchaseHistoryResponse>;
+}
+/** @internal */
+export declare function getMeteredBillingCharges(httpClient: HttpClient): GetMeteredBillingChargesSignature;
+interface GetMeteredBillingChargesSignature {
+    /**
+     * Triggers Wix to call the
+     * [List Custom Charges SPI](https://dev.wix.com/docs/rest/internal-only/premium/custom-charges-spi/custom-charges-provider-v1/list-charges).
+     *
+     *
+     * Wix doesn't use the response from _List Charges_ SPI to actually create an
+     * invoice that's sent to the customer. Instead, calling _Get Metered Billing Charges_
+     * allows you confirm that your integration with the Custom Charges SPI is
+     * working as intended.
+     */
+    (options?: GetMeteredBillingChargesOptions | undefined): Promise<GetMeteredBillingChargesResponse>;
+}
+export declare const onPurchasedItemInvoiceStatusUpdated: EventDefinition<PurchasedItemInvoiceStatusUpdatedEnvelope, "InvoiceStatusUpdated">;
+export { BaseEventMetadata, Charge, ChargeOverride, GetMeteredBillingChargesOptions, GetMeteredBillingChargesRequest, GetMeteredBillingChargesResponse, GetPurchaseHistoryRequest, GetPurchaseHistoryResponse, GetSitePaymentMethodsStatusRequest, GetSitePaymentMethodsStatusResponse, GetUrlOptions, GetUrlRequest, GetUrlResponse, IdentificationData, IdentificationDataIdOneOf, InvoiceStatus, InvoiceStatusUpdated, MessageEnvelope, PaymentCycle, PurchasedItem, PurchasedItemInvoiceStatusUpdatedEnvelope, WebhookIdentityType, } from './devcenter-checkout-v1-purchased-item-billing.universal.js';

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

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookIdentityType = exports.PaymentCycle = exports.InvoiceStatus = exports.onPurchasedItemInvoiceStatusUpdated = exports.getMeteredBillingCharges = exports.getPurchaseHistory = exports.getUrl = exports.__metadata = void 0;
+const rename_all_nested_keys_1 = require("@wix/sdk-runtime/rename-all-nested-keys");
+const sdk_types_1 = require("@wix/sdk-types");
+const devcenter_checkout_v1_purchased_item_billing_universal_js_1 = require("./devcenter-checkout-v1-purchased-item-billing.universal.js");
+exports.__metadata = { PACKAGE_NAME: '@wix/app-management' };
+function getUrl(httpClient) {
+    return (productId, options) => (0, devcenter_checkout_v1_purchased_item_billing_universal_js_1.getUrl)(productId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.getUrl = getUrl;
+function getPurchaseHistory(httpClient) {
+    return () => (0, devcenter_checkout_v1_purchased_item_billing_universal_js_1.getPurchaseHistory)(
+    // @ts-ignore
+    { httpClient });
+}
+exports.getPurchaseHistory = getPurchaseHistory;
+/** @internal */
+function getMeteredBillingCharges(httpClient) {
+    return (options) => (0, devcenter_checkout_v1_purchased_item_billing_universal_js_1.getMeteredBillingCharges)(options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.getMeteredBillingCharges = getMeteredBillingCharges;
+exports.onPurchasedItemInvoiceStatusUpdated = (0, sdk_types_1.EventDefinition)('InvoiceStatusUpdated', false, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(event))();
+var devcenter_checkout_v1_purchased_item_billing_universal_js_2 = require("./devcenter-checkout-v1-purchased-item-billing.universal.js");
+Object.defineProperty(exports, "InvoiceStatus", { enumerable: true, get: function () { return devcenter_checkout_v1_purchased_item_billing_universal_js_2.InvoiceStatus; } });
+Object.defineProperty(exports, "PaymentCycle", { enumerable: true, get: function () { return devcenter_checkout_v1_purchased_item_billing_universal_js_2.PaymentCycle; } });
+Object.defineProperty(exports, "WebhookIdentityType", { enumerable: true, get: function () { return devcenter_checkout_v1_purchased_item_billing_universal_js_2.WebhookIdentityType; } });
+//# sourceMappingURL=devcenter-checkout-v1-purchased-item-billing.public.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"devcenter-checkout-v1-purchased-item-billing.public.js","sourceRoot":"","sources":["../../../../src/devcenter-checkout-v1-purchased-item-billing.public.ts"],"names":[],"mappings":";;;AAAA,oFAAkG;AAClG,8CAA6D;AAC7D,2IAUqE;AAExD,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,qBAAqB,EAAE,CAAC;AAElE,SAAgB,MAAM,CAAC,UAAsB;IAC3C,OAAO,CAAC,SAAiB,EAAE,OAAuB,EAAE,EAAE,CACpD,IAAA,kEAAe,EACb,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,wBAQC;AAuBD,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,IAAA,8EAA2B;IACzB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,gDAQC;AAeD,gBAAgB;AAChB,SAAgB,wBAAwB,CACtC,UAAsB;IAEtB,OAAO,CAAC,OAAyC,EAAE,EAAE,CACnD,IAAA,oFAAiC,EAC/B,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,4DASC;AAkBY,QAAA,mCAAmC,GAAG,IAAA,2BAAe,EAChE,sBAAsB,EACtB,KAAK,EACL,CAAC,KAAgD,EAAE,EAAE,CACnD,IAAA,gEAAuC,EAAC,KAAK,CAAC,CACjD,EAA6C,CAAC;AAE/C,yIAuBqE;AAPnE,0JAAA,aAAa,OAAA;AAGb,yJAAA,YAAY,OAAA;AAGZ,gKAAA,mBAAmB,OAAA"}

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

@@ -0,0 +1,250 @@
+export interface PurchasedItem {
+    /** ID of your app's paid plan. */
+    productId?: string;
+    /** Price of your app's paid plan. For example, `9.95`. */
+    price?: string;
+    /**
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     */
+    currency?: string;
+    /** Information about the billing cycle for your app's paid plan. */
+    billingCycle?: PaymentCycle;
+    /**
+     * Date and time the site onwers have purchased your app's paid plan in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    dateCreated?: Date | null;
+}
+export declare enum PaymentCycle {
+    NO_CYCLE = "NO_CYCLE",
+    MONTHLY = "MONTHLY",
+    YEARLY = "YEARLY",
+    ONE_TIME = "ONE_TIME",
+    TWO_YEARS = "TWO_YEARS",
+    THREE_YEARS = "THREE_YEARS",
+    FOUR_YEARS = "FOUR_YEARS",
+    FIVE_YEARS = "FIVE_YEARS"
+}
+export interface InvoiceStatusUpdated {
+    /** Invoice payment status. */
+    status?: InvoiceStatus;
+    /**
+     * Wix Premium invoice ID.
+     * @maxLength 50
+     */
+    invoiceId?: string;
+    /**
+     * App instance ID - a unique ID assigned to each app in each site.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /** Whether the invoice is for a single payment or for multiple, recurring payments. */
+    recurring?: boolean;
+}
+export declare enum InvoiceStatus {
+    UNKNOWN_INVOICE_STATUS = "UNKNOWN_INVOICE_STATUS",
+    PAYMENT_FAILED = "PAYMENT_FAILED",
+    PAID = "PAID",
+    REFUNDED = "REFUNDED",
+    VOIDED = "VOIDED",
+    CHARGEDBACK = "CHARGEDBACK"
+}
+export interface GetUrlRequest {
+    /**
+     * ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
+     * for a list of your app's supported product IDs.
+     */
+    productId: string;
+    /**
+     * URL for the Wix checkout page. Redirect site owners to this URL after
+     * they've successfully purchased a paid plan for your app.
+     * @format WEB_URL
+     */
+    successUrl?: string | null;
+    /**
+     * Whether the checkout is for testing purposes only. Testing is mainly
+     * relevant for in-app purchase flows. When `true`, Wix charges the site
+     * owners an amount of `0.00`.
+     */
+    testCheckout?: boolean;
+    /** Information about the paid plan's billing cycle. */
+    billingCycle?: PaymentCycle;
+    /**
+     * 2-letter country code in
+     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+     * format.
+     *
+     * Default: `"US"`
+     */
+    countryCode?: string | null;
+    /**
+     * 2-letter language code in
+     * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     *
+     * Default: `"EN"`
+     */
+    languageCode?: string | null;
+    /** Coupon code for the paid plan. Available only in case there is a discount. */
+    couponCode?: string | null;
+}
+export interface ChargeOverride {
+    /**
+     * Override price. In case you omit the override price, Wix charges site
+     * owners the app's default price that's configured in the Pricing page of your app's dashboard.
+     */
+    price?: number;
+    /**
+     * Override 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     */
+    currency?: string;
+}
+export interface GetUrlResponse {
+    /**
+     * URL for the Wix checkout page.
+     * @format WEB_URL
+     */
+    checkoutUrl?: string;
+    /**
+     * Token for the Wix checkout page. The token holds all data about the order
+     * you're creating a checkout for.  It is [signed](),
+     * so you can verify that it comes from Wix.
+     */
+    token?: string | null;
+}
+export interface GetPurchaseHistoryRequest {
+}
+export interface GetPurchaseHistoryResponse {
+    /** Retrieved purchases the site owners have completed for you app. */
+    purchases?: PurchasedItem[];
+}
+export interface GetSitePaymentMethodsStatusRequest {
+}
+export interface GetSitePaymentMethodsStatusResponse {
+    /**
+     * Whether the site owners have enabled at least a single online payment method.
+     * Online payment methods include Wix Payments, Stripe, PayPal, and credit
+     * cards.
+     */
+    onlineProviderEnabled?: boolean;
+    /** Whether the site owners accept offline payments. */
+    offlineProviderEnabled?: boolean;
+    /**
+     * Whether the site owners have enabled the
+     * [Wix Point of Sale](https://www.wix.com/pos).
+     * This allows their customers to make electronic payments in person.
+     */
+    wixPosProviderEnabled?: boolean;
+    /**
+     * Whether the site owners have enabled at least one 3rd-party point-of-sale
+     * provider. This allows their customers to make electronic payments in person.
+     */
+    thirdPartyPosProviderEnabled?: boolean;
+}
+export interface GetMeteredBillingChargesRequest {
+    /**
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * @format CURRENCY
+     */
+    currency?: string | null;
+    /**
+     * Start of the period you want to retrieve the custom charges for in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    startDate?: Date | null;
+    /**
+     * End of the period you want to retrieve the custom charges for in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    endDate?: Date | null;
+}
+export interface GetMeteredBillingChargesResponse {
+    /** List of retrieved custom charges. */
+    charges?: Charge[];
+}
+export interface Charge {
+    /** ID of the custom charge. The ID consists of 64 characters. */
+    id?: string | null;
+    /** Description of the custom charge. */
+    description?: string;
+    /**
+     * Charge amount.
+     *
+     * Min: `0.50`
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gt:0.00 }
+     */
+    amount?: string;
+}
+export interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}

package/build/internal/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/internal/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"}