import { CreatePackageRequest as CreatePackageRequest$1, CreatePackageResponse as CreatePackageResponse$1, CancelPackageRequest as CancelPackageRequest$1, CancelPackageResponse as CancelPackageResponse$1, GetPackageRequest as GetPackageRequest$1, GetPackageResponse as GetPackageResponse$1, QueryPackagesRequest as QueryPackagesRequest$1, QueryPackagesResponse as QueryPackagesResponse$1, AssignProductInstanceToSiteRequest as AssignProductInstanceToSiteRequest$1, AssignProductInstanceToSiteResponse as AssignProductInstanceToSiteResponse$1, UnassignProductInstanceFromSiteRequest as UnassignProductInstanceFromSiteRequest$1, UnassignProductInstanceFromSiteResponse as UnassignProductInstanceFromSiteResponse$1, CancelProductInstanceRequest as CancelProductInstanceRequest$1, CancelProductInstanceResponse as CancelProductInstanceResponse$1, AdjustProductInstanceSpecificationsRequest as AdjustProductInstanceSpecificationsRequest$1, AdjustProductInstanceSpecificationsResponse as AdjustProductInstanceSpecificationsResponse$1, UpdatePackageExternalIdRequest as UpdatePackageExternalIdRequest$1, UpdatePackageExternalIdResponse as UpdatePackageExternalIdResponse$1 } from './index.typings.js'; import '@wix/sdk-types'; /** * A package is group of instances of Wix services that a reseller offers to a * customer as part of a single transaction. */ interface Package { /** * Package ID. * @readonly * @format GUID */ id?: string; /** * Wix account ID. See * [Account Level APIs](https://dev.wix.com/docs/rest/account-level/about-account-level-apis) * for more details. * @readonly * @format GUID */ accountId?: string; /** * External reference. For example, an external subscription ID. * This field isn't validated by Wix. * * Max: 100 characters * @maxLength 100 */ externalId?: string | null; /** * Product instances that are included in the package. * * Min: 1 product instance * Max: 1000 product instances * @maxSize 1000 * @minSize 1 */ productInstances?: ProductInstance[]; /** * Date and time the package was created. * @readonly */ createdDate?: Date | null; /** * Date and time the package was last updated. * @readonly */ updatedDate?: Date | null; } /** * A product instance is a specific instance of a Wix service that a reseller * offers to one of their customers. */ interface ProductInstance extends ProductInstanceContractDetailsOneOf { /** Billing information for the contract between the reseller and Wix. */ billingInfo?: ProductInstanceCycle; /** * ID of the instance of the resold Wix service. **Note:** Differs from the * `catalogProductId`. Allows you to identify different instances of the same * product in a package. * @readonly * @format GUID */ instanceId?: string; /** * ID of the Wix site that the product instance is assigned to. * See the [Query Sites API](https://dev.wix.com/api/rest/account-level-apis/sites/query-sites) * for more information. * @format GUID */ siteId?: string | null; /** * Product ID, as defined in the Wix Premium Product Catalog. * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) * for more details about available Wix services. * @format GUID */ catalogProductId?: string; /** * Status of the product instance. * @readonly */ status?: StatusWithLiterals; /** * Failure object. Only present for status `FAILED`. Describes why the product instance `FAILED`. * @readonly */ failure?: FailureReason; /** * Date and time the product instance was created. * @readonly */ createdDate?: Date | null; /** * Date and time the product instance was last updated. * @readonly */ updatedDate?: Date | null; /** * Two-letter country code in * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) * format. Specifies where customers can claim vouchers that may come with the * product. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) to get more * information about vouchers and supported locations. * @format COUNTRY */ countryCode?: string | null; /** * Date and time the product instance expires in `YYYY-MM-DDThh:mm:ss.sssZ` format. * Used only for instances that don't auto renew at the end of the current billing cycle. * @readonly */ expirationDate?: Date | null; /** * Discount code indicating that the reseller provisioned the product instance * during a sale. Wix doesn't guarantee that a discount code reduces the * price between Wix and the reseller, even when it's valid. Contact the * [Wix B2B sales team](mailto:bizdev@wix.com) for more information. * * Max: 25 characters * @maxLength 25 */ discountCode?: string | null; /** * ID of a different product instance that you can use to offer your customers * time-limited free access to an additional product or service. For example, * Wix offers a 1-year free domain registration to all customers who purchase a * Premium plan. The referenced product instance must have either status `"PENDING"` or * `"ACTIVE"`. You can use each product instance only a single time as reference * instance. * @format GUID */ referenceProductInstanceId?: string | null; } /** @oneof */ interface ProductInstanceContractDetailsOneOf { /** Billing information for the contract between the reseller and Wix. */ billingInfo?: ProductInstanceCycle; } declare enum FailureReasonCode { UNKNOWN = "UNKNOWN", /** The product instance couldn't be created because the Resellers API timed out. */ DELIVERY_TIMEOUT = "DELIVERY_TIMEOUT", /** The product instance couldn't be created because an external process failed. */ EXTERNAL_FAILURE = "EXTERNAL_FAILURE" } /** @enumType */ type FailureReasonCodeWithLiterals = FailureReasonCode | 'UNKNOWN' | 'DELIVERY_TIMEOUT' | 'EXTERNAL_FAILURE'; declare enum IntervalIntervalUnit { /** unknown interval unit */ UNKNOWN = "UNKNOWN", /** Day */ DAY = "DAY", /** Week */ WEEK = "WEEK", /** Month */ MONTH = "MONTH", /** Year */ YEAR = "YEAR" } /** @enumType */ type IntervalIntervalUnitWithLiterals = IntervalIntervalUnit | 'UNKNOWN' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR'; declare enum CycleDescriptorType { /** The payment type hasn't been set. */ UNKNOWN = "UNKNOWN", /** The reseller pays Wix in a single payment. */ ONE_TIME = "ONE_TIME", /** The reseller pays Wix on a recurring schedule. */ RECURRING = "RECURRING" } /** @enumType */ type CycleDescriptorTypeWithLiterals = CycleDescriptorType | 'UNKNOWN' | 'ONE_TIME' | 'RECURRING'; interface CycleInterval { /** Unit of the billing cycle. */ unit?: IntervalIntervalUnitWithLiterals; /** * Count of units that make up the billing cycle. * @min 1 */ count?: number; } declare enum Status { /** The product instance isn't yet available to the customer. */ PENDING = "PENDING", /** The customer can use the product instance. */ ENABLED = "ENABLED", /** The product instance isn't any longer available to the customer. */ CANCELED = "CANCELED", /** The product instance couldn't be delivered successfully and has never been available to the customer. */ FAILED = "FAILED", /** The product instance isn't yet available to the customer, because an external provider or the customer must take an action. */ AWAITING_ACTION = "AWAITING_ACTION" } /** @enumType */ type StatusWithLiterals = Status | 'PENDING' | 'ENABLED' | 'CANCELED' | 'FAILED' | 'AWAITING_ACTION'; interface FailureReason { /** Failure code. */ code?: FailureReasonCodeWithLiterals; /** Failure message. */ message?: string; } interface ProductInstanceCycle { /** Payment type. */ type?: CycleDescriptorTypeWithLiterals; /** Duration of the billing cycle. Available only for `RECURRING` payments. */ cycleDuration?: CycleInterval; } interface CreatePackageRequest { /** * Idempotency key. * @maxLength 100 */ idempotencyKey?: string | null; /** * External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix. * @maxLength 100 */ externalId?: string | null; /** * Wix services that are resold. * @maxSize 1000 * @minSize 1 */ products: ProductInstance[]; } interface CreatePackageResponse { /** * Idempotency key. * @maxLength 100 */ idempotencyKey?: string | null; /** Created package. */ package?: Package; } interface CancelPackageRequest { /** * Idempotency key. * @maxLength 100 */ idempotencyKey?: string | null; /** * ID of the package to cancel. * @format GUID */ id: string; } interface CancelPackageResponse { /** * Idempotency key. * @maxLength 100 */ idempotencyKey?: string | null; /** Canceled package. */ package?: Package; } interface PackageCanceled { /** Canceled package. */ package?: Package; } interface GetPackageRequest { /** * Package ID. * @format GUID */ id: string; } interface GetPackageResponse { /** Retrieved package. */ package?: Package; } interface QueryPackagesRequest { /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */ query: QueryV2; } interface QueryV2 extends QueryV2PagingMethodOneOf { /** Paging options to limit and offset the number of items. */ paging?: Paging; /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging; /** * Filter object. * * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters). */ filter?: Record | null; /** * Sort object. * * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting). */ sort?: Sorting[]; /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */ fields?: string[]; /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */ fieldsets?: string[]; } /** @oneof */ interface QueryV2PagingMethodOneOf { /** Paging options to limit and offset the number of items. */ paging?: Paging; /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging; } interface Sorting { /** * Name of the field to sort by. * @maxLength 512 */ fieldName?: string; /** Sort order. */ order?: SortOrderWithLiterals; } declare enum SortOrder { ASC = "ASC", DESC = "DESC" } /** @enumType */ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC'; interface Paging { /** Number of items to load. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } interface CursorPaging { /** * Maximum number of items to return in the results. * @max 100 */ limit?: number | null; /** * Pointer to the next or previous page in the list of results. * * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. * Not relevant for the first request. * @maxLength 16000 */ cursor?: string | null; } interface QueryPackagesResponse { /** Paging metadata. */ metadata?: PagingMetadataV2; /** * Retrieved packages. * * Max: 1000 packages * @maxSize 1000 */ packages?: Package[]; } interface PagingMetadataV2 { /** Number of items returned in the response. */ count?: number | null; /** Offset that was requested. */ offset?: number | null; /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */ total?: number | null; /** Flag that indicates the server failed to calculate the `total` field. */ tooManyToCount?: boolean | null; /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */ cursors?: Cursors; } interface Cursors { /** * Cursor string pointing to the next page in the list of results. * @maxLength 16000 */ next?: string | null; /** * Cursor pointing to the previous page in the list of results. * @maxLength 16000 */ prev?: string | null; } interface AssignProductInstanceToSiteRequest { /** * Idempotency key. * @maxLength 100 */ idempotencyKey?: string | null; /** * ID of the product instance to assign to a site. * @format GUID */ instanceId: string; /** * ID of the site to which the product instance is assigned. * @format GUID */ siteId: string; } interface AssignProductInstanceToSiteResponse { /** * Idempotency key. * @maxLength 100 */ idempotencyKey?: string | null; /** Updated package that includes the assigned product instance. */ package?: Package; } interface AssignedProductInstanceToSite { /** Updated package. */ package?: Package; /** * ID of the product instance that was assigned to the site. * @readonly * @format GUID */ productInstanceId?: string; /** * ID of the site the product instance was assigned to. * @readonly * @format GUID */ siteId?: string; } interface UnassignProductInstanceFromSiteRequest { /** * Idempotency key. * @maxLength 100 */ idempotencyKey?: string | null; /** * ID of the product instance to unassign from a site. * @format GUID */ instanceId: string; } interface UnassignProductInstanceFromSiteResponse { /** * Idempotency key. * @maxLength 100 */ idempotencyKey?: string | null; /** Updated package that includes the unassigned product instance. */ package?: Package; } interface UnassignedProductInstanceFromSite { /** Updated package. */ package?: Package; /** * ID of the product instance that was unassigned from the site. * @readonly * @format GUID */ productInstanceId?: string; /** * MetasiteId of the site the product instance was unassigned from. * @readonly * @format GUID */ metaSiteId?: string; } interface CancelProductInstanceRequest { /** * Idempotency key. * @maxLength 100 */ idempotencyKey?: string | null; /** * ID of the product instance to cancel. * @format GUID */ instanceId: string; } interface CancelProductInstanceResponse { /** * Idempotency key. * @maxLength 100 */ idempotencyKey?: string | null; /** Updated package that includes the previously included the canceled product instance. */ package?: Package; } interface ProductInstanceCanceled { /** Updated package. */ package?: Package; /** * ID of the product instance that was canceled. * @readonly * @format GUID */ productInstanceId?: string; } interface AdjustProductInstanceSpecificationsRequest { /** * Idempotency key. * @maxLength 100 */ idempotencyKey?: string | null; /** * ID of the product instance to adjust. * @format GUID */ instanceId: string; /** * ID of the product to replace the original instance. Required in case you don't * provide a new `billingInfo` object. * @format GUID */ catalogProductId?: string | null; /** * Information about the billing cycle. Required in case you don't provide a new * `catalogProductId`. The new billing cycle must be supported for the service. * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for * information about a service's supported billing cycles. If * you adjust the billing cycle for a product instance with `RECURRING` * payments, you must also provide `billingInfo.cycleDuration.unit`. */ billingInfo?: ProductInstanceCycle; /** * Discount code indicating that the reseller provisioned the product instance * during a sale. In case you pass a code that isn't valid, the call succeeds and * no discount is applied to the product instance. Wix doesn't guarantee that a * discount code reduces the price between Wix and the reseller, even when it's * valid. You can't add a discount code after you've created the * product instance. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for * more information about supported codes. * * Max: 25 characters * @maxLength 25 */ discountCode?: string | null; } interface AdjustProductInstanceSpecificationsResponse { /** * Idempotency key. * @maxLength 100 */ idempotencyKey?: string | null; /** Updated package that includes the adjusted product instance. */ package?: Package; } interface AdjustedProductInstanceSpecifications { /** Updated package. */ package?: Package; /** * ID of the product instance to adjust. * @readonly * @format GUID */ productInstanceId?: string; } interface SubscriptionEvent extends SubscriptionEventEventOneOf { /** Triggered when a subscription is created. */ created?: SubscriptionCreated; /** * Triggered when a subscription is assigned to a Wix site, including the initial * assignment of a floating subscription or a re-assignement from a different site. */ assigned?: SubscriptionAssigned; /** Triggered when a subscription is canceled. */ cancelled?: SubscriptionCancelled; /** Triggered when the subscription's auto renew is turned on. */ autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn; /** Triggered when the subscription's auto renew is turned off. */ autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff; /** * Triggered when a subscription is unassigned from a Wix site and becomes * floating. */ unassigned?: SubscriptionUnassigned; /** * Triggered when a subscription is transferred from one Wix account to another. * A transfer includes cancelling the original subscription and creating a new * subscription for the target account. The event returns both the original * and the new subscription. */ transferred?: SubscriptionTransferred; /** Triggered when a recurring charge succeeds for a subscription. */ recurringChargeSucceeded?: RecurringChargeSucceeded; /** * Triggered when a subscription was updated including when its product has been * up- or downgraded or the billing cycle is changed. */ contractSwitched?: ContractSwitched; /** * Triggered when a subscription gets close to the end of its billing cycle. * The exact number of days is defined in the billing system. */ nearEndOfPeriod?: SubscriptionNearEndOfPeriod; /** * Triggered when a subscription is updated and the change doesn't happen * immediately but at the end of the current billing cycle. */ pendingChange?: SubscriptionPendingChange; /** Triggered when a recurring charge attempt fails for a subscription. */ recurringChargeAttemptFailed?: RecurringChargeAttemptFailed; /** * ID of the subscription's event. * @format GUID */ eventId?: string | null; /** * Date and time of the event in * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time) * `YYYY-MM-DDThh:mm:ss.sssZ` format. */ eventDate?: Date | null; } /** @oneof */ interface SubscriptionEventEventOneOf { /** Triggered when a subscription is created. */ created?: SubscriptionCreated; /** * Triggered when a subscription is assigned to a Wix site, including the initial * assignment of a floating subscription or a re-assignement from a different site. */ assigned?: SubscriptionAssigned; /** Triggered when a subscription is canceled. */ cancelled?: SubscriptionCancelled; /** Triggered when the subscription's auto renew is turned on. */ autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn; /** Triggered when the subscription's auto renew is turned off. */ autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff; /** * Triggered when a subscription is unassigned from a Wix site and becomes * floating. */ unassigned?: SubscriptionUnassigned; /** * Triggered when a subscription is transferred from one Wix account to another. * A transfer includes cancelling the original subscription and creating a new * subscription for the target account. The event returns both the original * and the new subscription. */ transferred?: SubscriptionTransferred; /** Triggered when a recurring charge succeeds for a subscription. */ recurringChargeSucceeded?: RecurringChargeSucceeded; /** * Triggered when a subscription was updated including when its product has been * up- or downgraded or the billing cycle is changed. */ contractSwitched?: ContractSwitched; /** * Triggered when a subscription gets close to the end of its billing cycle. * The exact number of days is defined in the billing system. */ nearEndOfPeriod?: SubscriptionNearEndOfPeriod; /** * Triggered when a subscription is updated and the change doesn't happen * immediately but at the end of the current billing cycle. */ pendingChange?: SubscriptionPendingChange; /** Triggered when a recurring charge attempt fails for a subscription. */ recurringChargeAttemptFailed?: RecurringChargeAttemptFailed; } /** Triggered when a subscription is created. */ interface SubscriptionCreated { /** Created subscription. */ subscription?: Subscription; /** Metadata for the `created` event. */ metadata?: Record; /** * Subscription reactivation data. * A subscription can be reactivated for example if it was incorrectly canceled because of fraud and then reactivated * by the billing system */ reactivationData?: ReactivationData; } /** * A subscription holds information about a Premium product that a Wix account * owner has purchased including details about the billing. */ interface Subscription { /** * ID of the subscription. * @format GUID */ id?: string; /** * ID of the Wix account that purchased the subscription. * @format GUID */ userId?: string; /** * ID of the [product](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/products/product-object) * for which the subscription was purchased. * @format GUID */ productId?: string; /** * Date and time the subscription was created in * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time) * `YYYY-MM-DDThh:mm:ss.sssZ` format. */ createdAt?: Date | null; /** * Date and time the subscription was last updated in * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time) * `YYYY-MM-DDThh:mm:ss.sssZ` format. */ updatedAt?: Date | null; /** * ID of the metasite that the subscription is assigned to. * Available only when the subscription is assigned to a Wix site. * Subscriptions for account level products can't be assigned to a Wix site. * @format GUID */ metaSiteId?: string | null; /** Information about the system that manages the subscription's billing. */ billingReference?: BillingReference; /** Information about the billing cycle of the subscription. */ cycle?: Cycle; /** * Subscription status. * * + `UNKNOWN`: Default status. * + `AUTO_RENEW_ON`: Subscription is active and automatically renews at the end of the current billing cycle. * + `AUTO_RENEW_OFF`: Subscription is active but expires at the end of the current billing cycle. * + `MANUAL_RECURRING`: Subscription is active and renews at the end of the current billing cycle, in case the customer takes an action related to the payment. * + `CANCELLED`: Subscription isn't active because it has been canceled. * + `TRANSFERRED`: Subscription isn't active because it has been transferred to a different account. A different active subscription was created for the target account. */ status?: SubscriptionStatusWithLiterals; /** * Date and time the subscription was last transferred from one Wix account to * another in * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time) * `YYYY-MM-DDThh:mm:ss.sssZ` format. */ transferredAt?: Date | null; /** * ID of the [product type](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/product-types/product-type-object) * that the product, for which the subscription was purchased, belongs to. * @format GUID */ productTypeId?: string; /** Version number, which increments by 1 each time the subscription is updated. */ version?: number; /** * Whether the subscription is active. Includes the statuses * `"AUTO_RENEW_ON"`, `"AUTO_RENEW_OFF"`, and `"MANUAL_RECURRING"`. */ active?: boolean; /** * Date and time the subscription was originally created in * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time) * `YYYY-MM-DDThh:mm:ss.sssZ` format. * Differs from `createdAt` in case the subscription was originally created for a different Wix account and has been transferred. */ originalCreationDate?: Date | null; /** Custom metadata about the subscription. */ metadata?: Record; /** * 2-letter country code in * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) * format. */ countryCode?: string | null; /** * Seats of the product that the subscription was purchased for. * Will be Null for products that don't support seats. * @min 1 * @max 500 */ seats?: number | null; } interface BillingReference { /** * Name of the billing system that manages the subscription. * * + `"UNKNOWN"`: Default value. * + `"SBS"`: [Wix Billing](https://github.com/wix-p/premium-billing/tree/master/sbs). * + `"LICENSER"`: * + `"BASS"`: [Billing and Subscriptions System](https://dev.wix.com/docs/rest/internal-only/premium/subscriptions-by-billing-by-wix/introduction). * + `"RESELLER"`: [External Reseller](https://dev.wix.com/api/rest/account-level-apis/resellers/introduction). */ providerName?: ProviderNameWithLiterals; /** Current provider reference ID. */ providerReferenceId?: string | null; /** Previous provider reference IDs. Used for when a subscription is extended, specifically for domains. */ previousProviderReferenceIds?: string[]; } declare enum ProviderName { UNKNOWN = "UNKNOWN", SBS = "SBS", LICENSER = "LICENSER", BASS = "BASS", RESELLER = "RESELLER", RECURRING_INVOICES = "RECURRING_INVOICES" } /** @enumType */ type ProviderNameWithLiterals = ProviderName | 'UNKNOWN' | 'SBS' | 'LICENSER' | 'BASS' | 'RESELLER' | 'RECURRING_INVOICES'; interface Cycle extends CycleCycleSelectorOneOf { /** repetitive interval */ interval?: Interval; /** one time */ oneTime?: OneTime; } /** @oneof */ interface CycleCycleSelectorOneOf { /** repetitive interval */ interval?: Interval; /** one time */ oneTime?: OneTime; } interface Interval { /** interval unit of measure */ unit?: IntervalUnitWithLiterals; /** number of interval */ count?: number; } declare enum IntervalUnit { /** unknown interval unit */ UNKNOWN = "UNKNOWN", /** day */ DAY = "DAY", /** week */ WEEK = "WEEK", /** month */ MONTH = "MONTH", /** year */ YEAR = "YEAR" } /** @enumType */ type IntervalUnitWithLiterals = IntervalUnit | 'UNKNOWN' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR'; interface OneTime { } declare enum SubscriptionStatus { UNKNOWN = "UNKNOWN", AUTO_RENEW_ON = "AUTO_RENEW_ON", AUTO_RENEW_OFF = "AUTO_RENEW_OFF", MANUAL_RECURRING = "MANUAL_RECURRING", CANCELLED = "CANCELLED", TRANSFERRED = "TRANSFERRED" } /** @enumType */ type SubscriptionStatusWithLiterals = SubscriptionStatus | 'UNKNOWN' | 'AUTO_RENEW_ON' | 'AUTO_RENEW_OFF' | 'MANUAL_RECURRING' | 'CANCELLED' | 'TRANSFERRED'; /** Triggered when a subscription is reactivated. */ interface ReactivationData { reactivationReason?: ReactivationReasonEnumWithLiterals; /** * In the event of reactivation after chargeback dispute, the subscription may be extended according to the * number of days it was inactive during the time of resolving the dispute */ newEndOfPeriod?: Date | null; /** The original end date, before the inactive period. */ oldEndOfPeriod?: Date | null; /** The difference in days between the new new_end_of_period and old_end_of_period */ differenceInDays?: number | null; } /** Reason for subscription reactivation */ declare enum ReactivationReasonEnum { UNKNOWN = "UNKNOWN", /** * Subscription was reactivated due to billing status change from CANCELED to ACTIVE, for example if it was incorrectly * canceled because of suspicion of fraud */ BILLING_STATUS_CHANGE = "BILLING_STATUS_CHANGE", /** Subscription was reactivated after a chargeback dispute */ REACTIVATED_AFTER_CHARGEBACK = "REACTIVATED_AFTER_CHARGEBACK" } /** @enumType */ type ReactivationReasonEnumWithLiterals = ReactivationReasonEnum | 'UNKNOWN' | 'BILLING_STATUS_CHANGE' | 'REACTIVATED_AFTER_CHARGEBACK'; /** * Triggered when a subscription is assigned to a Wix site, including the initial * assignment of a floating subscription or a re-assignement from a different site. */ interface SubscriptionAssigned { /** Assigned subscription. */ subscription?: Subscription; /** * ID of the metasite that the subscription has been assigned to before the update. * @format GUID */ previousMetaSiteId?: string | null; } /** Triggered when a subscription is canceled. */ interface SubscriptionCancelled { /** Canceled subscription. */ subscription?: Subscription; /** Details about the cancellation including who canceled the subscription and why. */ cancellationDetails?: CancellationDetails; /** * Whether the subscription is canceled immediately or expires at the end of the current billing cycle. * * Default: `false` */ immediateCancel?: boolean; /** Whether the subscription was canceled during the free trial period. */ canceledInFreeTrial?: boolean; /** The type of refund applied to the cancellation. */ refundType?: RefundTypeWithLiterals; } /** Information about the cancellation flow including who canceled the subscription and why it was canceled. */ interface CancellationDetails { /** * Cancellation code. * * Values supported for cancellations on behalf of the billing system: `-1`, `-2`, `-3`, `-4`, `-5`, `-6`, `-7`, `-8`. * For cancellations on behalf of the site owner or the service provider `cancellationCode` * is taken from the request of * [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline). * * + `-1`: The subscription has been cancelled by the billing system but none of the listed cancellation reasons applies. * + `-2`: There were payment problems. * + `-3`: There was a chargeback. * + `-4`: Customer support has canceled the subscription and issued a refund. * + `-5`: The site owner has changed their existing subscription. * + `-6`: The subscription has been transferred to a different Wix account. * + `-7`: The subscription has been canceled because the site owner hasn't manually authenticated the recurring payment during the subscription's grace period. For example, site owners must manually confirm recurring payments within 40 days when paying with boleto. * + `-8`: The Wix account that the subscription belonged to has been deleted. */ cancellationCode?: number | null; /** * Cancellation reason. For cancellations on behalf of the site owner or the service provider `cancellationReason` * is taken from the request of * [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline). * For cancellations on behalf of the billing system `cancellationReason` is `null` or an empty string. */ cancellationReason?: string | null; /** * Initiator of the cancellation. For `"USER_REQUESTED"` and `"APP_MANAGED"`, * `cancellationCode` and `cancellationReason` are taken from the request of * [Cancel Immediately](https://dev.wix.com/docs/rest/account-level/premium/premium-subscriptions-manager/subscription-v1/cancel-immediately) * or [Cancel Immediately Offline](https://dev.wix.com/docs/rest/account-level/premium/premium-subscriptions-manager/subscription-v1/cancel-immediately-offline). * For `"PASSIVE"`, cancellations `cancellationCode` is automatically calculated and `cancellationReason` * is `null` or an empty string. * * + `"UNKNOWN`: Default value. * + `"USER_REQUESTED"`: The Wix account owner has canceled the subscription. * + `"APP_MANAGED"`: The service provider has canceled the subscription. * + `"PASSIVE"`: The billing system has canceled the subscription. For example, in case of payment failure or fraud. */ initiator?: InitiatorWithLiterals; } declare enum Initiator { UNKNOWN = "UNKNOWN", USER_REQUESTED = "USER_REQUESTED", APP_MANAGED = "APP_MANAGED", PASSIVE = "PASSIVE" } /** @enumType */ type InitiatorWithLiterals = Initiator | 'UNKNOWN' | 'USER_REQUESTED' | 'APP_MANAGED' | 'PASSIVE'; declare enum RefundType { UNKNOWN = "UNKNOWN", NO_REFUND = "NO_REFUND", FULL_REFUND = "FULL_REFUND", PRORATED_REFUND = "PRORATED_REFUND" } /** @enumType */ type RefundTypeWithLiterals = RefundType | 'UNKNOWN' | 'NO_REFUND' | 'FULL_REFUND' | 'PRORATED_REFUND'; /** Triggered when the subscription's auto renew is turned on. */ interface SubscriptionAutoRenewTurnedOn { /** Subscription for which auto renew is turned on. */ subscription?: Subscription; /** * Supported values: `USER`, `APP`. * * Information about who turned auto renew on. * + `"USER"`: The site owner who purchased the subscription has turned auto renew on. * + `"APP"`: The service provider has turned auto renew on. */ initiator?: string | null; } /** Triggered when the subscription's auto renew is turned off. */ interface SubscriptionAutoRenewTurnedOff { /** Subscription for which auto renew is turned off. */ subscription?: Subscription; /** Details about the cancellation including who canceled the subscription and why. */ cancellationDetails?: CancellationDetails; /** * Whether the subscription is immediately canceled or expires at the end of the current billing cycle. * * Default: `false` */ immediateCancel?: boolean; } /** * Triggered when a subscription is unassigned from a Wix site and becomes * floating. */ interface SubscriptionUnassigned { /** Unassigned subscription. */ subscription?: Subscription; /** * ID of the metasite that the subscription has been assigned to before the event. * @format GUID */ previousMetaSiteId?: string; /** * Reason why the subscription is unassigned. * * + `"UNKNOWN"`: Default value. * + `"USER_REQUESTED"`: The Wix account owner has unassigned the subscription. * + `"REPLACED_BY_ANOTHER_SUBSCRIPTION"`: A different subscription that replaces this subscription is assigned to the site. */ unassignReason?: UnassignReasonWithLiterals; } declare enum UnassignReason { UNKNOWN = "UNKNOWN", USER_REQUESTED = "USER_REQUESTED", REPLACED_BY_ANOTHER_SUBSCRIPTION = "REPLACED_BY_ANOTHER_SUBSCRIPTION" } /** @enumType */ type UnassignReasonWithLiterals = UnassignReason | 'UNKNOWN' | 'USER_REQUESTED' | 'REPLACED_BY_ANOTHER_SUBSCRIPTION'; /** * Triggered when a subscription is transferred from one Wix account to another. * A transfer includes cancelling the original subscription and creating a new * subscription for the target account. The event returns both the original * and the new subscription. */ interface SubscriptionTransferred { /** Original subscription that was canceled for the transfer. */ originSubscription?: Subscription; /** Newly created subscription for the target account. */ targetSubscription?: Subscription; } /** Triggered when a recurring charge succeeds for a subscription. */ interface RecurringChargeSucceeded { /** Subscription for which the recurring charge has succeeded. */ subscription?: Subscription; /** Indication that there was a successful charge at the end of the free trial period */ freeTrialPeriodEnd?: boolean; } /** * Triggered when a subscription was updated including when its product has been * up- or downgraded or the billing cycle is changed. */ interface ContractSwitched { /** Updated subscription. */ subscription?: Subscription; /** Billing cycle before the update. */ previousCycle?: Cycle; /** * ID of the product belonging to the subscription before the update. * @format GUID */ previousProductId?: string; /** * ID of the product type that the subscription's original product belonged to before the update. * @format GUID */ previousProductTypeId?: string; /** * Update type. __Note__: Doesn't include information about a product adjustment. * For that purpose, see `productAdjustment`. * * + `"NOT_APPLICABLE"`: Default value. * + `"ADDITIONAL_QUANTITY"`: An increased usage quota is added to the subscription. For example, a second mailbox is added to a subscription that previously included a single mailbox. * + `"CREDIT_UNUSED_PERIOD"`: The subscription is upgraded and the new price is less than the regular price. The new price applies to every billing cycle, not just the first cycle. * + `"REFUND_PRICE_DIFF"`: Not implemented. * + `"ADJUST_PERIOD_END"`: Not implemented. * + `"DOWNGRADE_GRACE_PERIOD"`: For downgrades during the grace period. In this situation, the site owner hasn’t paid yet and must immediately pay for the downgraded subscription. * + `"FULL_AMOUNT_PERIOD"`: For upgrades in which the site owner retains unused benefits. For example, site owners upgrading a Facebook Ads subscription retain their unused FB Ads credit. The unused credit is added to the new credit. * + `"END_OF_PERIOD"`: The subscription's billing current cycle is extended because of a downgrade. * + `"PENDING_CHANGES"`: The subscription's billing is updated, but the change doesn't apply immediately. Instead, the update becomes effective at the end of current billing cycle. * + `"DOWNGRADE_RENEWAL"`: The subscription is downgraded because of a declined payment. This prevents subscriptions from churning. */ contractSwitchType?: ContractSwitchTypeWithLiterals; /** * ID of the metasite the subscription has been assigned to previously. * Available only in case the subscription is assigned to a different site. * @format GUID */ previousMetaSiteId?: string | null; /** * Update reason. * * + `"PRICE_INCREASE"`: The subscription's price has been increased. * + `"EXTERNAL_PROVIDER_TRIGGER"`: Any reason other than a price increase. */ contractSwitchReason?: ContractSwitchReasonWithLiterals; /** Information about the price update. Available only for updates with a price increase. */ productPriceIncreaseData?: ProductPriceIncreaseData; /** * Information about a product adjustment. For example, a downgrade. * __Note__: This isn't the same as `contractSwitchType`. * * + `NOT_APPLICABLE`: There is no information about whether the product has been up- or downgraded. * + `DOWNGRADE`: The product has been downgraded. */ productAdjustment?: ProductAdjustmentWithLiterals; /** * Number of seats before the contract switch. * @min 1 * @max 500 */ previousSeats?: number | null; } /** Copied from SBS */ declare enum ContractSwitchType { NOT_APPLICABLE = "NOT_APPLICABLE", ADDITIONAL_QUANTITY = "ADDITIONAL_QUANTITY", CREDIT_UNUSED_PERIOD = "CREDIT_UNUSED_PERIOD", REFUND_PRICE_DIFF = "REFUND_PRICE_DIFF", ADJUST_PERIOD_END = "ADJUST_PERIOD_END", DOWNGRADE_GRACE_PERIOD = "DOWNGRADE_GRACE_PERIOD", FULL_AMOUNT_PERIOD = "FULL_AMOUNT_PERIOD", END_OF_PERIOD = "END_OF_PERIOD", PENDING_CHANGES = "PENDING_CHANGES", DOWNGRADE_RENEWAL = "DOWNGRADE_RENEWAL", FIXED_BILLING_DATE_PRORATION = "FIXED_BILLING_DATE_PRORATION", IMMEDIATE_SWITCH = "IMMEDIATE_SWITCH" } /** @enumType */ type ContractSwitchTypeWithLiterals = ContractSwitchType | 'NOT_APPLICABLE' | 'ADDITIONAL_QUANTITY' | 'CREDIT_UNUSED_PERIOD' | 'REFUND_PRICE_DIFF' | 'ADJUST_PERIOD_END' | 'DOWNGRADE_GRACE_PERIOD' | 'FULL_AMOUNT_PERIOD' | 'END_OF_PERIOD' | 'PENDING_CHANGES' | 'DOWNGRADE_RENEWAL' | 'FIXED_BILLING_DATE_PRORATION' | 'IMMEDIATE_SWITCH'; declare enum ContractSwitchReason { EXTERNAL_PROVIDER_TRIGGER = "EXTERNAL_PROVIDER_TRIGGER", PRICE_INCREASE = "PRICE_INCREASE" } /** @enumType */ type ContractSwitchReasonWithLiterals = ContractSwitchReason | 'EXTERNAL_PROVIDER_TRIGGER' | 'PRICE_INCREASE'; /** Triggered when a subscription's price is increased. */ interface ProductPriceIncreaseData { /** * Price of the subscription before the update. * @format DECIMAL_VALUE */ previousPrice?: string | null; /** A value that is used in order to select the correct email template to send the user regarding the price increase. */ emailTemplateSelector?: string | null; /** Used to differentiate between migration segments. Does not have to be unique per segment. */ segmentName?: string | null; /** Used to determine how the price increase was triggered. */ priceIncreaseTrigger?: PriceIncreaseTriggerWithLiterals; } /** Reason for Price Increase Trigger */ declare enum PriceIncreaseTrigger { NEAR_RENEWAL = "NEAR_RENEWAL", RECURRING_SUCCESS = "RECURRING_SUCCESS", MANUAL = "MANUAL" } /** @enumType */ type PriceIncreaseTriggerWithLiterals = PriceIncreaseTrigger | 'NEAR_RENEWAL' | 'RECURRING_SUCCESS' | 'MANUAL'; /** Triggered when a subscription's product is adusted. */ declare enum ProductAdjustment { /** flag to show that the ContractSwitchedEvent is not applicable / needed */ NOT_APPLICABLE = "NOT_APPLICABLE", /** flag to show that the ContractSwitchedEvent is a Downgrade */ DOWNGRADE = "DOWNGRADE" } /** @enumType */ type ProductAdjustmentWithLiterals = ProductAdjustment | 'NOT_APPLICABLE' | 'DOWNGRADE'; /** * Triggered when a subscription gets close to the end of its billing cycle. * The exact number of days is defined in the billing system. */ interface SubscriptionNearEndOfPeriod { /** Subscription that got close to the end of its billing cycle. */ subscription?: Subscription; /** Whether the subscription is within the free trial period. */ inFreeTrial?: boolean; } /** * Triggered when a subscription is updated and the change doesn't happen * immediately but at the end of the current billing cycle. */ interface SubscriptionPendingChange { /** Subscription for which a pending update is triggered. */ subscription?: Subscription; } /** Triggered when a recurring charge attempt failed for a subscription. */ interface RecurringChargeAttemptFailed { /** Subscription for which the recurring charge attempt has failed. */ subscription?: Subscription; } interface Empty { } interface ProductInstanceUpdated { /** Updated package. */ package?: Package; /** * ID of the product instance that was adjusted. * @readonly * @format GUID */ productInstanceId?: string; } interface FailureReportRequest { /** * ID of the product instance that failed. * @format GUID */ instanceId?: string; /** Failure reason. */ reason?: FailureReason; } interface ProductInstanceFailed { /** Updated package. */ package?: Package; /** * ID of the product instance that `FAILED`. * @readonly * @format GUID */ productInstanceId?: string; /** Failure reason. */ reason?: FailureReason; } interface Task { key?: TaskKey; executeAt?: Date | null; payload?: string | null; } interface TaskKey { appId?: string; instanceId?: string; subjectId?: string | null; } interface TaskAction extends TaskActionActionOneOf { complete?: Complete; cancel?: Cancel; reschedule?: Reschedule; } /** @oneof */ interface TaskActionActionOneOf { complete?: Complete; cancel?: Cancel; reschedule?: Reschedule; } interface Complete { } interface Cancel { } interface Reschedule { executeAt?: Date | null; payload?: string | null; } interface UpdateProductInstanceRequest { /** * ID of the product instance to update. * @format GUID */ instanceId?: string; status?: StatusWithLiterals; /** @format COUNTRY */ countryCode?: string | null; /** Which field to update, currently only status and countryCode are supported. */ fieldToUpdate?: FieldToUpdateWithLiterals; } declare enum FieldToUpdate { STATUS = "STATUS", COUNTRY_CODE = "COUNTRY_CODE" } /** @enumType */ type FieldToUpdateWithLiterals = FieldToUpdate | 'STATUS' | 'COUNTRY_CODE'; interface UpdateProductInstanceResponse { /** Updated Product Instance */ productInstance?: ProductInstance; } interface UpdatePackageExternalIdRequest { /** * ID of the package to update. * @format GUID */ packageId: string; /** * External ID that will be assigned to the package. * @maxLength 100 */ externalId: string; } interface UpdatePackageExternalIdResponse { /** Updated package. */ updatedPackage?: Package; } interface CountPackagesRequest { /** Filter on what packages to count */ filter?: Record | null; } interface CountPackagesResponse { /** Number of packages */ count?: number; } interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** Event ID. With this ID you can easily spot duplicated events and ignore them. */ id?: string; /** * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. */ entityFqdn?: string; /** * Event action name, placed at the top level to make it easier for users to dispatch messages. * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */ eventTime?: Date | null; /** * Whether the event was triggered as a result of a privacy regulation application * (for example, GDPR). */ triggeredByAnonymizeRequest?: boolean | null; /** If present, indicates the action that triggered the event. */ originatedFrom?: string | null; /** * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } interface EntityCreatedEvent { entityAsJson?: string; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo; } interface RestoreInfo { deletedDate?: Date | null; } interface EntityUpdatedEvent { /** * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff. * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects. * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it. */ currentEntityAsJson?: string; } interface EntityDeletedEvent { /** Entity that was deleted. */ deletedEntityAsJson?: string | null; } interface ActionEvent { bodyAsJson?: string; } 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; /** Details related to the account */ accountInfo?: AccountInfo; } 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?: WebhookIdentityTypeWithLiterals; } /** @oneof */ 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; } declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** @enumType */ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP'; interface AccountInfo { /** * ID of the Wix account associated with the event. * @format GUID */ accountId?: string | null; /** * ID of the parent Wix account. Only included when accountId belongs to a child account. * @format GUID */ parentAccountId?: string | null; /** * ID of the Wix site associated with the event. Only included when the event is tied to a specific site. * @format GUID */ siteId?: string | null; } interface MigrateSubscriptionToPackagesRequest { /** Created package. */ productInstance?: ProductInstance; /** * Existing subscriptionId to migrate * @format GUID */ subscriptionId?: string | null; /** * User id of the migration - only for Immigrator * @format GUID */ userId?: string | null; } interface MigrateSubscriptionToPackagesResponse { package?: Package; } interface FixBrokenMigrationRequest { /** * Subscription id of the broken subscription * @format GUID */ subscriptionId?: string; /** * SBS service id that points to the broken subscription * @format GUID */ sbsServiceId?: string; /** * Owner of the broken subscription * @format GUID */ userId?: string; } interface FixBrokenMigrationResponse { } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function createPackage(): __PublicMethodMetaInfo<'POST', {}, CreatePackageRequest$1, CreatePackageRequest, CreatePackageResponse$1, CreatePackageResponse>; declare function createPackageV2(): __PublicMethodMetaInfo<'POST', {}, CreatePackageRequest$1, CreatePackageRequest, CreatePackageResponse$1, CreatePackageResponse>; declare function cancelPackage(): __PublicMethodMetaInfo<'DELETE', { id: string; }, CancelPackageRequest$1, CancelPackageRequest, CancelPackageResponse$1, CancelPackageResponse>; declare function getPackage(): __PublicMethodMetaInfo<'GET', { id: string; }, GetPackageRequest$1, GetPackageRequest, GetPackageResponse$1, GetPackageResponse>; declare function queryPackages(): __PublicMethodMetaInfo<'POST', {}, QueryPackagesRequest$1, QueryPackagesRequest, QueryPackagesResponse$1, QueryPackagesResponse>; declare function assignProductInstanceToSite(): __PublicMethodMetaInfo<'PATCH', { instanceId: string; siteId: string; }, AssignProductInstanceToSiteRequest$1, AssignProductInstanceToSiteRequest, AssignProductInstanceToSiteResponse$1, AssignProductInstanceToSiteResponse>; declare function unassignProductInstanceFromSite(): __PublicMethodMetaInfo<'PATCH', { instanceId: string; }, UnassignProductInstanceFromSiteRequest$1, UnassignProductInstanceFromSiteRequest, UnassignProductInstanceFromSiteResponse$1, UnassignProductInstanceFromSiteResponse>; declare function cancelProductInstance(): __PublicMethodMetaInfo<'DELETE', { instanceId: string; }, CancelProductInstanceRequest$1, CancelProductInstanceRequest, CancelProductInstanceResponse$1, CancelProductInstanceResponse>; declare function adjustProductInstanceSpecifications(): __PublicMethodMetaInfo<'PATCH', { instanceId: string; }, AdjustProductInstanceSpecificationsRequest$1, AdjustProductInstanceSpecificationsRequest, AdjustProductInstanceSpecificationsResponse$1, AdjustProductInstanceSpecificationsResponse>; declare function updatePackageExternalId(): __PublicMethodMetaInfo<'PATCH', { packageId: string; externalId: string; }, UpdatePackageExternalIdRequest$1, UpdatePackageExternalIdRequest, UpdatePackageExternalIdResponse$1, UpdatePackageExternalIdResponse>; export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AdjustProductInstanceSpecificationsRequest as AdjustProductInstanceSpecificationsRequestOriginal, type AdjustProductInstanceSpecificationsResponse as AdjustProductInstanceSpecificationsResponseOriginal, type AdjustedProductInstanceSpecifications as AdjustedProductInstanceSpecificationsOriginal, type AssignProductInstanceToSiteRequest as AssignProductInstanceToSiteRequestOriginal, type AssignProductInstanceToSiteResponse as AssignProductInstanceToSiteResponseOriginal, type AssignedProductInstanceToSite as AssignedProductInstanceToSiteOriginal, type BillingReference as BillingReferenceOriginal, type Cancel as CancelOriginal, type CancelPackageRequest as CancelPackageRequestOriginal, type CancelPackageResponse as CancelPackageResponseOriginal, type CancelProductInstanceRequest as CancelProductInstanceRequestOriginal, type CancelProductInstanceResponse as CancelProductInstanceResponseOriginal, type CancellationDetails as CancellationDetailsOriginal, type Complete as CompleteOriginal, ContractSwitchReason as ContractSwitchReasonOriginal, type ContractSwitchReasonWithLiterals as ContractSwitchReasonWithLiteralsOriginal, ContractSwitchType as ContractSwitchTypeOriginal, type ContractSwitchTypeWithLiterals as ContractSwitchTypeWithLiteralsOriginal, type ContractSwitched as ContractSwitchedOriginal, type CountPackagesRequest as CountPackagesRequestOriginal, type CountPackagesResponse as CountPackagesResponseOriginal, type CreatePackageRequest as CreatePackageRequestOriginal, type CreatePackageResponse as CreatePackageResponseOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type CycleCycleSelectorOneOf as CycleCycleSelectorOneOfOriginal, CycleDescriptorType as CycleDescriptorTypeOriginal, type CycleDescriptorTypeWithLiterals as CycleDescriptorTypeWithLiteralsOriginal, type CycleInterval as CycleIntervalOriginal, type Cycle as CycleOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, FailureReasonCode as FailureReasonCodeOriginal, type FailureReasonCodeWithLiterals as FailureReasonCodeWithLiteralsOriginal, type FailureReason as FailureReasonOriginal, type FailureReportRequest as FailureReportRequestOriginal, FieldToUpdate as FieldToUpdateOriginal, type FieldToUpdateWithLiterals as FieldToUpdateWithLiteralsOriginal, type FixBrokenMigrationRequest as FixBrokenMigrationRequestOriginal, type FixBrokenMigrationResponse as FixBrokenMigrationResponseOriginal, type GetPackageRequest as GetPackageRequestOriginal, type GetPackageResponse as GetPackageResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, Initiator as InitiatorOriginal, type InitiatorWithLiterals as InitiatorWithLiteralsOriginal, IntervalIntervalUnit as IntervalIntervalUnitOriginal, type IntervalIntervalUnitWithLiterals as IntervalIntervalUnitWithLiteralsOriginal, type Interval as IntervalOriginal, IntervalUnit as IntervalUnitOriginal, type IntervalUnitWithLiterals as IntervalUnitWithLiteralsOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MigrateSubscriptionToPackagesRequest as MigrateSubscriptionToPackagesRequestOriginal, type MigrateSubscriptionToPackagesResponse as MigrateSubscriptionToPackagesResponseOriginal, type OneTime as OneTimeOriginal, type PackageCanceled as PackageCanceledOriginal, type Package as PackageOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, PriceIncreaseTrigger as PriceIncreaseTriggerOriginal, type PriceIncreaseTriggerWithLiterals as PriceIncreaseTriggerWithLiteralsOriginal, ProductAdjustment as ProductAdjustmentOriginal, type ProductAdjustmentWithLiterals as ProductAdjustmentWithLiteralsOriginal, type ProductInstanceCanceled as ProductInstanceCanceledOriginal, type ProductInstanceContractDetailsOneOf as ProductInstanceContractDetailsOneOfOriginal, type ProductInstanceCycle as ProductInstanceCycleOriginal, type ProductInstanceFailed as ProductInstanceFailedOriginal, type ProductInstance as ProductInstanceOriginal, type ProductInstanceUpdated as ProductInstanceUpdatedOriginal, type ProductPriceIncreaseData as ProductPriceIncreaseDataOriginal, ProviderName as ProviderNameOriginal, type ProviderNameWithLiterals as ProviderNameWithLiteralsOriginal, type QueryPackagesRequest as QueryPackagesRequestOriginal, type QueryPackagesResponse as QueryPackagesResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type ReactivationData as ReactivationDataOriginal, ReactivationReasonEnum as ReactivationReasonEnumOriginal, type ReactivationReasonEnumWithLiterals as ReactivationReasonEnumWithLiteralsOriginal, type RecurringChargeAttemptFailed as RecurringChargeAttemptFailedOriginal, type RecurringChargeSucceeded as RecurringChargeSucceededOriginal, RefundType as RefundTypeOriginal, type RefundTypeWithLiterals as RefundTypeWithLiteralsOriginal, type Reschedule as RescheduleOriginal, type RestoreInfo as RestoreInfoOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type SubscriptionAssigned as SubscriptionAssignedOriginal, type SubscriptionAutoRenewTurnedOff as SubscriptionAutoRenewTurnedOffOriginal, type SubscriptionAutoRenewTurnedOn as SubscriptionAutoRenewTurnedOnOriginal, type SubscriptionCancelled as SubscriptionCancelledOriginal, type SubscriptionCreated as SubscriptionCreatedOriginal, type SubscriptionEventEventOneOf as SubscriptionEventEventOneOfOriginal, type SubscriptionEvent as SubscriptionEventOriginal, type SubscriptionNearEndOfPeriod as SubscriptionNearEndOfPeriodOriginal, type Subscription as SubscriptionOriginal, type SubscriptionPendingChange as SubscriptionPendingChangeOriginal, SubscriptionStatus as SubscriptionStatusOriginal, type SubscriptionStatusWithLiterals as SubscriptionStatusWithLiteralsOriginal, type SubscriptionTransferred as SubscriptionTransferredOriginal, type SubscriptionUnassigned as SubscriptionUnassignedOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type UnassignProductInstanceFromSiteRequest as UnassignProductInstanceFromSiteRequestOriginal, type UnassignProductInstanceFromSiteResponse as UnassignProductInstanceFromSiteResponseOriginal, UnassignReason as UnassignReasonOriginal, type UnassignReasonWithLiterals as UnassignReasonWithLiteralsOriginal, type UnassignedProductInstanceFromSite as UnassignedProductInstanceFromSiteOriginal, type UpdatePackageExternalIdRequest as UpdatePackageExternalIdRequestOriginal, type UpdatePackageExternalIdResponse as UpdatePackageExternalIdResponseOriginal, type UpdateProductInstanceRequest as UpdateProductInstanceRequestOriginal, type UpdateProductInstanceResponse as UpdateProductInstanceResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, adjustProductInstanceSpecifications, assignProductInstanceToSite, cancelPackage, cancelProductInstance, createPackage, createPackageV2, getPackage, queryPackages, unassignProductInstanceFromSite, updatePackageExternalId };