@wix/app-management 1.0.13 → 1.0.14

package/type-bundles/service-plugins-context.bundle.d.ts

@@ -0,0 +1,363 @@
+interface GetChargeLimitRequest {
+    /**
+     * ID of the subscription for which Wix retrieves the charge limit. Equals
+     * `null` in case Wix hasn't created the subscription when retrieving an
+     * initial charge limit. To track usage and billing for apps, we recommend to
+     * use `instanceId` instead of the `subscriptionId`.
+     */
+    subscriptionId?: string | null;
+    /**
+     * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.
+     *
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
+     * format of the charge limit. Wix may add supported currencies in the future.
+     */
+    currency?: string;
+}
+interface GetChargeLimitResponse {
+    /**
+     * Retrieved charge limit for the app instance. You can't update the
+     * charge limit after you've set an initial value. Site owners can increase the
+     * limit in their site's dashboard, currently they aren't allowed to decrease it.
+     */
+    chargeLimit?: string | null;
+}
+interface ListChargesRequest {
+    /**
+     * ID of the subscription for which Wix retrieves your custom charges.
+     * To track usage and billing for apps, we recommend to use `instanceId` instead
+     * of the `subscriptionId`.
+     */
+    subscriptionId?: string;
+    /**
+     * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.
+     *
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
+     * format of your charges to return. Wix may add supported currencies in the future.
+     */
+    currency?: string;
+    /**
+     * Begin of the period Wix retrieves the app instance's charges for in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    periodStart?: Date;
+    /**
+     * End of the period Wix retrieves the app instance's charges for in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    periodEnd?: Date;
+    /**
+     * Information about what Wix intends to do with the retrieved charges.
+     *
+     * + `"DISPLAY_ONLY"`: Inform the customer about how much your app would charge them at the moment. Wix doesn't create an invoice.
+     * + `"CREATE_INVOICE"`: Create an invoice for the customer.
+     */
+    intent?: Intent;
+}
+declare enum Intent {
+    /** retrieving the current charges for display purposes only */
+    DISPLAY_ONLY = "DISPLAY_ONLY",
+    /** retrieving the current charges with the intention of creating an invoice and billing the user */
+    CREATE_INVOICE = "CREATE_INVOICE"
+}
+interface ListChargesResponse {
+    /**
+     * Retrieved charges.
+     *
+     * Max: 5 charges
+     */
+    charges?: 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](https://dev.wix.com/docs/rest/api-reference/app-management/apps/custom-charges-spi/custom-charges-provider-v1/invoice-created-event).
+     *
+     * Max: 64 characters
+     */
+    _id?: string | null;
+    /** Charge description. */
+    description?: string;
+    /**
+     * Charge amount in the currency that's specified in the request. Use a whole number
+     * or separate major and minor units with a dot. For example, `10` or `1.99`. If
+     * you return an amount with more minor units than supported according to
+     * [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes),
+     * Wix truncates the additional minor units.
+     *
+     * Min: `0.50`
+     */
+    amount?: string;
+}
+interface ChargesRejectedRequest {
+    /**
+     * ID of the subscription for which Wix hasn't accepted your custom charges.
+     * To track usage and billing for apps, we recommend to use `instanceId` instead
+     * of the `subscriptionId`.
+     */
+    subscriptionId?: string;
+    /**
+     * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.
+     *
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
+     * format of the charges. Wix may add supported currencies in the future.
+     */
+    currency?: string;
+    /**
+     * IDs of the rejected charges.
+     *
+     * Max: 5 charges
+     */
+    chargeIds?: string[] | null;
+    /**
+     * Maximum amount that your app may charge the customer per billing cycle.
+     *
+     * Min: `0.50`
+     */
+    chargeLimit?: string | null;
+    /**
+     * Information about why Wix has rejected your app's charges.
+     *
+     * + `"UNKNOWN_REASON"`: There is no information about why Wix has rejected the charges.
+     * + `"CHARGE_LIMIT_EXCEEDED"`: The sum of the charges is higher than the limit that you may charge the customer per billing cycle.
+     * + `"TOO_MANY_CHARGES"`: You can't provide more than 5 charges per invoice.
+     * + `"INVALID_FORMAT"`: 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.
+     *
+     * Max: 20 reasons
+     */
+    reasons?: ChargesRejectedReason[];
+}
+declare enum ChargesRejectedReason {
+    UNKNOWN = "UNKNOWN",
+    CHARGE_LIMIT_EXCEEDED = "CHARGE_LIMIT_EXCEEDED",
+    TOO_MANY_CHARGES = "TOO_MANY_CHARGES",
+    INVALID_FORMAT = "INVALID_FORMAT"
+}
+interface ChargesRejectedResponse {
+}
+interface InvoiceCreatedRequest {
+    /**
+     * ID of the subscription for which Wix has created an invoice that includes
+     * your custom charges. To track usage and billing for apps, we recommend to use
+     * `instanceId` instead of the `subscriptionId`.
+     */
+    subscriptionId?: string;
+    /**
+     * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.
+     *
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
+     * format of the charges. Wix may add supported currencies in the future.
+     */
+    currency?: string;
+    /** ID of the created invoice. */
+    invoiceId?: string;
+    /** Line items included in the invoice. */
+    lineItems?: InvoiceLineItem[];
+}
+interface InvoiceLineItem {
+    /**
+     * ID of the charge as returned in
+     * [List Charges](https://dev.wix.com/docs/rest/api-reference/app-management/apps/custom-charges-spi/custom-charges-provider-v1/list-charges).
+     *
+     * Max: 64 characters
+     */
+    chargeId?: string | null;
+    /** Charge amount. */
+    amount?: string;
+    /** ID of the line item in the invoice that Wix sends to the customer. */
+    _id?: string;
+}
+interface InvoiceCreatedResponse {
+}
+interface ChargeLimitUpdatedRequest {
+    /**
+     * ID of the subscription for which the charge limit has been updated.
+     * To track usage and billing for apps, we recommend to use `instanceId` instead
+     * of the `subscriptionId`.
+     */
+    subscriptionId?: string;
+    /**
+     * Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`.
+     *
+     * 3-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
+     * format of the charges. Wix may add supported currencies in the future.
+     */
+    currency?: string;
+    /** Updated charge limit. */
+    chargeLimit?: string | null;
+}
+interface ChargeLimitUpdatedResponse {
+}
+interface CustomChargesConfig {
+    /**
+     * Base part of your integration's deployment URI for the Custom Charges SPI.
+     * For example `"https://provider.example.com"`, if Wix should call your
+     * integration at `https://provider.example.com/v1/charge-limit` for the
+     * [Get Charge Limit]https://dev.wix.com/docs/rest/api-reference/app-management/apps/custom-charges-spi/custom-charges-provider-v1/get-charge-limit)
+     * endpoint.
+     */
+    baseUri?: SpiBaseUri;
+}
+interface SpiBaseUri {
+    /** URI that will be used by the host to call the implementer. The path-suffix defined on the method will be appended to it */
+    baseUri?: string;
+    /** override method mappings per method */
+    alternativeUris?: AlternativeUri[];
+}
+interface AlternativeUri {
+    /** name of the method as it appears in the proto */
+    methodName?: string;
+    /** absolute uri that will be used by the host to call that method. The path-suffix mapped from the method http option will NOT be appended to this URI. For TPAs. it must be https */
+    absoluteUri?: string;
+}
+/**
+ * this message is not directly used by any service,
+ * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
+ * e.g. SPIs, event-handlers, etc..
+ * NOTE: this context object MUST be provided as the last argument in each Velo method signature.
+ *
+ * Example:
+ * ```typescript
+ * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {
+ * ...
+ * }
+ * ```
+ */
+interface Context {
+    /** A unique identifier for each request. Can be used for logging / troubleshooting */
+    requestId?: string | null;
+    /** 3 capital letters string representing a currency according to ISO-4217 */
+    currency?: string | null;
+    /** The identification type and identity data */
+    identity?: IdentificationData;
+    /** A string representing a language and region in the format of "xx-XX". First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2 */
+    languages?: string[];
+    /** App instance ID of SPI in context */
+    instanceId?: string | null;
+}
+declare enum IdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: IdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+
+type ServicePluginMethodInput = {
+    request: any;
+    metadata: any;
+};
+type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
+type ServicePluginMethodMetadata = {
+    name: string;
+    primaryHttpMappingPath: string;
+    transformations: {
+        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
+        toREST: (...args: unknown[]) => unknown;
+    };
+};
+type ServicePluginDefinition<Contract extends ServicePluginContract> = {
+    __type: 'service-plugin-definition';
+    componentType: string;
+    methods: ServicePluginMethodMetadata[];
+    __contract: Contract;
+};
+declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
+type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+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<{
+    getChargeLimit(payload: GetChargeLimitEnvelope): GetChargeLimitResponse | Promise<GetChargeLimitResponse>;
+    listCharges(payload: ListChargesEnvelope): ListChargesResponse | Promise<ListChargesResponse>;
+    chargesRejectedEvent(payload: ChargesRejectedEventEnvelope): ChargesRejectedResponse | Promise<ChargesRejectedResponse>;
+    invoiceCreatedEvent(payload: InvoiceCreatedEventEnvelope): InvoiceCreatedResponse | Promise<InvoiceCreatedResponse>;
+    chargeLimitUpdatedEvent(payload: ChargeLimitUpdatedEventEnvelope): ChargeLimitUpdatedResponse | Promise<ChargeLimitUpdatedResponse>;
+}>;
+
+declare const provideHandlers: BuildServicePluginDefinition<typeof provideHandlers$1>;
+
+type context_AlternativeUri = AlternativeUri;
+type context_ChargeLimitUpdatedRequest = ChargeLimitUpdatedRequest;
+type context_ChargeLimitUpdatedResponse = ChargeLimitUpdatedResponse;
+type context_ChargeLineItem = ChargeLineItem;
+type context_ChargesRejectedReason = ChargesRejectedReason;
+declare const context_ChargesRejectedReason: typeof ChargesRejectedReason;
+type context_ChargesRejectedRequest = ChargesRejectedRequest;
+type context_ChargesRejectedResponse = ChargesRejectedResponse;
+type context_Context = Context;
+type context_CustomChargesConfig = CustomChargesConfig;
+type context_GetChargeLimitRequest = GetChargeLimitRequest;
+type context_GetChargeLimitResponse = GetChargeLimitResponse;
+type context_IdentificationData = IdentificationData;
+type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type context_IdentityType = IdentityType;
+declare const context_IdentityType: typeof IdentityType;
+type context_Intent = Intent;
+declare const context_Intent: typeof Intent;
+type context_InvoiceCreatedRequest = InvoiceCreatedRequest;
+type context_InvoiceCreatedResponse = InvoiceCreatedResponse;
+type context_InvoiceLineItem = InvoiceLineItem;
+type context_ListChargesRequest = ListChargesRequest;
+type context_ListChargesResponse = ListChargesResponse;
+type context_SpiBaseUri = SpiBaseUri;
+declare const context_provideHandlers: typeof provideHandlers;
+declare namespace context {
+  export { type context_AlternativeUri as AlternativeUri, type context_ChargeLimitUpdatedRequest as ChargeLimitUpdatedRequest, type context_ChargeLimitUpdatedResponse as ChargeLimitUpdatedResponse, type context_ChargeLineItem as ChargeLineItem, context_ChargesRejectedReason as ChargesRejectedReason, type context_ChargesRejectedRequest as ChargesRejectedRequest, type context_ChargesRejectedResponse as ChargesRejectedResponse, type context_Context as Context, type context_CustomChargesConfig as CustomChargesConfig, type context_GetChargeLimitRequest as GetChargeLimitRequest, type context_GetChargeLimitResponse as GetChargeLimitResponse, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context_IdentityType as IdentityType, context_Intent as Intent, type context_InvoiceCreatedRequest as InvoiceCreatedRequest, type context_InvoiceCreatedResponse as InvoiceCreatedResponse, type context_InvoiceLineItem as InvoiceLineItem, type context_ListChargesRequest as ListChargesRequest, type context_ListChargesResponse as ListChargesResponse, type context_SpiBaseUri as SpiBaseUri, context_provideHandlers as provideHandlers };
+}
+
+export { context as customCharges };