@wix/auto_sdk_app-management_billing 1.0.14 → 1.0.16

package/build/{es/src/devcenter-checkout-v1-purchased-item-billing.types.d.ts → internal/devcenter-checkout-v1-purchased-item-billing.universal-0VctJpJS.d.ts}

@@ -1,4 +1,4 @@
-export interface PurchasedItem {
+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 @@ export interface PurchasedItem {
      */
     dateCreated?: Date | null;
 }
-export declare enum PaymentCycle {
+declare enum PaymentCycle {
     NO_CYCLE = "NO_CYCLE",
     MONTHLY = "MONTHLY",
     YEARLY = "YEARLY",
@@ -27,8 +27,8 @@ export declare enum PaymentCycle {
     FIVE_YEARS = "FIVE_YEARS"
 }
 /** @enumType */
-export type PaymentCycleWithLiterals = PaymentCycle | 'NO_CYCLE' | 'MONTHLY' | 'YEARLY' | 'ONE_TIME' | 'TWO_YEARS' | 'THREE_YEARS' | 'FOUR_YEARS' | 'FIVE_YEARS';
-export interface InvoiceStatusUpdated {
+type PaymentCycleWithLiterals = PaymentCycle | 'NO_CYCLE' | 'MONTHLY' | 'YEARLY' | 'ONE_TIME' | 'TWO_YEARS' | 'THREE_YEARS' | 'FOUR_YEARS' | 'FIVE_YEARS';
+interface InvoiceStatusUpdated {
     /** Invoice payment status. */
     status?: InvoiceStatusWithLiterals;
     /**
@@ -44,7 +44,7 @@ export interface InvoiceStatusUpdated {
     /** Whether the invoice is for a single payment or for multiple, recurring payments. */
     recurring?: boolean;
 }
-export declare enum InvoiceStatus {
+declare enum InvoiceStatus {
     UNKNOWN_INVOICE_STATUS = "UNKNOWN_INVOICE_STATUS",
     PAYMENT_FAILED = "PAYMENT_FAILED",
     PAID = "PAID",
@@ -53,8 +53,8 @@ export declare enum InvoiceStatus {
     CHARGEDBACK = "CHARGEDBACK"
 }
 /** @enumType */
-export type InvoiceStatusWithLiterals = InvoiceStatus | 'UNKNOWN_INVOICE_STATUS' | 'PAYMENT_FAILED' | 'PAID' | 'REFUNDED' | 'VOIDED' | 'CHARGEDBACK';
-export interface GetUrlRequest {
+type InvoiceStatusWithLiterals = InvoiceStatus | 'UNKNOWN_INVOICE_STATUS' | 'PAYMENT_FAILED' | 'PAID' | 'REFUNDED' | 'VOIDED' | 'CHARGEDBACK';
+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.
@@ -92,7 +92,7 @@ export interface GetUrlRequest {
     /** Coupon code for the paid plan. Available only in case there is a discount. */
     couponCode?: string | null;
 }
-export interface ChargeOverride {
+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.
@@ -104,7 +104,7 @@ export interface ChargeOverride {
      */
     currency?: string;
 }
-export interface GetUrlResponse {
+interface GetUrlResponse {
     /**
      * URL for the Wix checkout page.
      * @format WEB_URL
@@ -117,15 +117,15 @@ export interface GetUrlResponse {
      */
     token?: string | null;
 }
-export interface GetPurchaseHistoryRequest {
+interface GetPurchaseHistoryRequest {
 }
-export interface GetPurchaseHistoryResponse {
+interface GetPurchaseHistoryResponse {
     /** Retrieved purchases the site owners have completed for you app. */
     purchases?: PurchasedItem[];
 }
-export interface GetSitePaymentMethodsStatusRequest {
+interface GetSitePaymentMethodsStatusRequest {
 }
-export interface GetSitePaymentMethodsStatusResponse {
+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
@@ -146,7 +146,7 @@ export interface GetSitePaymentMethodsStatusResponse {
      */
     thirdPartyPosProviderEnabled?: boolean;
 }
-export interface GetMeteredBillingChargesRequest {
+interface GetMeteredBillingChargesRequest {
     /**
      * 3-letter currency code in
      * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
@@ -164,13 +164,13 @@ export interface GetMeteredBillingChargesRequest {
      */
     endDate?: Date | null;
 }
-export interface GetMeteredBillingChargesResponse {
+interface GetMeteredBillingChargesResponse {
     /** List of retrieved custom charges. */
     charges?: Charge[];
 }
-export interface Charge {
+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;
     /**
@@ -182,7 +182,7 @@ export interface Charge {
      */
     amount?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -198,7 +198,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -223,7 +223,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -245,7 +245,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -253,4 +253,75 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | '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?: PaymentCycleWithLiterals;
+    /**
+     * 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, type PurchasedItemInvoiceStatusUpdatedEnvelope as P, WebhookIdentityType as W, type GetUrlResponse as a, type GetPurchaseHistoryResponse as b, type GetMeteredBillingChargesOptions as c, type GetMeteredBillingChargesResponse as d, PaymentCycle as e, type PurchasedItem as f, type InvoiceStatusUpdated as g, type GetUrlRequest as h, type GetPurchaseHistoryRequest as i, type GetSitePaymentMethodsStatusRequest as j, type GetSitePaymentMethodsStatusResponse as k, type GetMeteredBillingChargesRequest as l, type Charge as m, type IdentificationData as n, type IdentificationDataIdOneOf as o };

package/build/internal/index.d.mts

@@ -0,0 +1,64 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { G as GetUrlOptions, a as GetUrlResponse, b as GetPurchaseHistoryResponse, c as GetMeteredBillingChargesOptions, d as GetMeteredBillingChargesResponse, P as PurchasedItemInvoiceStatusUpdatedEnvelope } from './devcenter-checkout-v1-purchased-item-billing.universal-0VctJpJS.mjs';
+export { B as BaseEventMetadata, m as Charge, C as ChargeOverride, l as GetMeteredBillingChargesRequest, i as GetPurchaseHistoryRequest, j as GetSitePaymentMethodsStatusRequest, k as GetSitePaymentMethodsStatusResponse, h as GetUrlRequest, n as IdentificationData, o as IdentificationDataIdOneOf, I as InvoiceStatus, g as InvoiceStatusUpdated, M as MessageEnvelope, e as PaymentCycle, f as PurchasedItem, W as WebhookIdentityType } from './devcenter-checkout-v1-purchased-item-billing.universal-0VctJpJS.mjs';
+
+declare function getUrl$1(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>;
+}
+declare function getPurchaseHistory$1(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 */
+declare function getMeteredBillingCharges$1(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>;
+}
+declare const onPurchasedItemInvoiceStatusUpdated$1: EventDefinition<PurchasedItemInvoiceStatusUpdatedEnvelope, "InvoiceStatusUpdated">;
+
+declare const getUrl: MaybeContext<BuildRESTFunction<typeof getUrl$1> & typeof getUrl$1>;
+declare const getPurchaseHistory: MaybeContext<BuildRESTFunction<typeof getPurchaseHistory$1> & typeof getPurchaseHistory$1>;
+/** @internal */
+declare const getMeteredBillingCharges: MaybeContext<BuildRESTFunction<typeof getMeteredBillingCharges$1> & typeof getMeteredBillingCharges$1>;
+/**
+ * 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).
+ */
+declare const onPurchasedItemInvoiceStatusUpdated: BuildEventDefinition<typeof onPurchasedItemInvoiceStatusUpdated$1>;
+
+export { GetMeteredBillingChargesOptions, GetMeteredBillingChargesResponse, GetPurchaseHistoryResponse, GetUrlOptions, GetUrlResponse, PurchasedItemInvoiceStatusUpdatedEnvelope, getMeteredBillingCharges, getPurchaseHistory, getUrl, onPurchasedItemInvoiceStatusUpdated };

package/build/internal/index.d.ts

@@ -0,0 +1,64 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { G as GetUrlOptions, a as GetUrlResponse, b as GetPurchaseHistoryResponse, c as GetMeteredBillingChargesOptions, d as GetMeteredBillingChargesResponse, P as PurchasedItemInvoiceStatusUpdatedEnvelope } from './devcenter-checkout-v1-purchased-item-billing.universal-0VctJpJS.js';
+export { B as BaseEventMetadata, m as Charge, C as ChargeOverride, l as GetMeteredBillingChargesRequest, i as GetPurchaseHistoryRequest, j as GetSitePaymentMethodsStatusRequest, k as GetSitePaymentMethodsStatusResponse, h as GetUrlRequest, n as IdentificationData, o as IdentificationDataIdOneOf, I as InvoiceStatus, g as InvoiceStatusUpdated, M as MessageEnvelope, e as PaymentCycle, f as PurchasedItem, W as WebhookIdentityType } from './devcenter-checkout-v1-purchased-item-billing.universal-0VctJpJS.js';
+
+declare function getUrl$1(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>;
+}
+declare function getPurchaseHistory$1(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 */
+declare function getMeteredBillingCharges$1(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>;
+}
+declare const onPurchasedItemInvoiceStatusUpdated$1: EventDefinition<PurchasedItemInvoiceStatusUpdatedEnvelope, "InvoiceStatusUpdated">;
+
+declare const getUrl: MaybeContext<BuildRESTFunction<typeof getUrl$1> & typeof getUrl$1>;
+declare const getPurchaseHistory: MaybeContext<BuildRESTFunction<typeof getPurchaseHistory$1> & typeof getPurchaseHistory$1>;
+/** @internal */
+declare const getMeteredBillingCharges: MaybeContext<BuildRESTFunction<typeof getMeteredBillingCharges$1> & typeof getMeteredBillingCharges$1>;
+/**
+ * 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).
+ */
+declare const onPurchasedItemInvoiceStatusUpdated: BuildEventDefinition<typeof onPurchasedItemInvoiceStatusUpdated$1>;
+
+export { GetMeteredBillingChargesOptions, GetMeteredBillingChargesResponse, GetPurchaseHistoryResponse, GetUrlOptions, GetUrlResponse, PurchasedItemInvoiceStatusUpdatedEnvelope, getMeteredBillingCharges, getPurchaseHistory, getUrl, onPurchasedItemInvoiceStatusUpdated };