@wix/auto_sdk_packages_packages 1.0.0 → 1.0.1

package/build/cjs/src/premium-reseller-v1-packages-packages.universal.d.ts

@@ -6,6 +6,7 @@ export interface Package {
     /**
      * Package ID.
      * @readonly
+     * @format GUID
      */
     _id?: string;
     /**
@@ -13,6 +14,7 @@ export interface Package {
      * [Account Level APIs](https://dev.wix.com/docs/rest/account-level/about-account-level-apis)
      * for more details.
      * @readonly
+     * @format GUID
      */
     accountId?: string;
     /**
@@ -20,6 +22,7 @@ export interface Package {
      * This field isn't validated by Wix.
      *
      * Max: 100 characters
+     * @maxLength 100
      */
     externalId?: string | null;
     /**
@@ -27,6 +30,8 @@ export interface Package {
      *
      * Min: 1 product instance
      * Max: 1000 product instances
+     * @maxSize 1000
+     * @minSize 1
      */
     productInstances?: ProductInstance[];
     /**
@@ -52,18 +57,21 @@ export interface ProductInstance extends ProductInstanceContractDetailsOneOf {
      * `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;
     /**
@@ -92,6 +100,7 @@ export interface ProductInstance extends ProductInstanceContractDetailsOneOf {
      * 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;
     /**
@@ -107,6 +116,7 @@ export interface ProductInstance extends ProductInstanceContractDetailsOneOf {
      * [Wix B2B sales team](mailto:bizdev@wix.com) for more information.
      *
      * Max: 25 characters
+     * @maxLength 25
      */
     discountCode?: string | null;
     /**
@@ -116,6 +126,7 @@ export interface ProductInstance extends ProductInstanceContractDetailsOneOf {
      * 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;
 }
@@ -154,7 +165,10 @@ export declare enum CycleDescriptorType {
 export interface CycleInterval {
     /** Unit of the billing cycle. */
     unit?: IntervalIntervalUnit;
-    /** Count of units that make up the billing cycle. */
+    /**
+     * Count of units that make up the billing cycle.
+     * @min 1
+     */
     count?: number;
 }
 export declare enum Status {
@@ -181,49 +195,50 @@ export interface ProductInstanceCycle {
     /** Duration of the billing cycle. Available only for `RECURRING` payments. */
     cycleDuration?: CycleInterval;
 }
-export interface MigrateSubscriptionToPackagesRequest {
-    /** Created package. */
-    productInstance?: ProductInstance;
-    /** Existing subscriptionId to migrate */
-    subscriptionId?: string | null;
-    /** User id of the migration - only for Immigrator */
-    userId?: string | null;
-}
-export interface MigrateSubscriptionToPackagesResponse {
-    package?: Package;
-}
-export interface FixBrokenMigrationRequest {
-    /** Subscription id of the broken subscription */
-    subscriptionId?: string;
-    /** SBS service id that points to the broken subscription */
-    sbsServiceId?: string;
-    /** Owner of the broken subscription */
-    userId?: string;
-}
-export interface FixBrokenMigrationResponse {
-}
 export interface CreatePackageRequest {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
-    /** External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix. */
+    /**
+     * 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. */
+    /**
+     * Wix services that are resold.
+     * @maxSize 1000
+     * @minSize 1
+     */
     products: ProductInstance[];
 }
 export interface CreatePackageResponse {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
     /** Created package. */
     package?: Package;
 }
 export interface CancelPackageRequest {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
-    /** ID of the package to cancel. */
+    /**
+     * ID of the package to cancel.
+     * @format GUID
+     */
     _id: string;
 }
 export interface CancelPackageResponse {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
     /** Canceled package. */
     package?: Package;
@@ -233,7 +248,10 @@ export interface PackageCanceled {
     package?: Package;
 }
 export interface GetPackageRequest {
-    /** Package ID. */
+    /**
+     * Package ID.
+     * @format GUID
+     */
     _id: string;
 }
 export interface GetPackageResponse {
@@ -274,7 +292,10 @@ export interface QueryV2PagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -290,13 +311,17 @@ export interface Paging {
     offset?: number | null;
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * 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;
 }
@@ -307,6 +332,7 @@ export interface QueryPackagesResponse {
      * Retrieved packages.
      *
      * Max: 1000 packages
+     * @maxSize 1000
      */
     packages?: Package[];
 }
@@ -323,21 +349,39 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * 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. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface AssignProductInstanceToSiteRequest {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
-    /** ID of the product instance to assign to a site. */
+    /**
+     * 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. */
+    /**
+     * ID of the site to which the product instance is assigned.
+     * @format GUID
+     */
     siteId: string;
 }
 export interface AssignProductInstanceToSiteResponse {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
     /** Updated package that includes the assigned product instance. */
     package?: Package;
@@ -348,22 +392,33 @@ export interface AssignedProductInstanceToSite {
     /**
      * 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;
 }
 export interface UnassignProductInstanceFromSiteRequest {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
-    /** ID of the product instance to unassign from a site. */
+    /**
+     * ID of the product instance to unassign from a site.
+     * @format GUID
+     */
     instanceId: string;
 }
 export interface UnassignProductInstanceFromSiteResponse {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
     /** Updated package that includes the unassigned product instance. */
     package?: Package;
@@ -374,22 +429,33 @@ export interface UnassignedProductInstanceFromSite {
     /**
      * 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;
 }
 export interface CancelProductInstanceRequest {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
-    /** ID of the product instance to cancel. */
+    /**
+     * ID of the product instance to cancel.
+     * @format GUID
+     */
     instanceId: string;
 }
 export interface CancelProductInstanceResponse {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
     /** Updated package that includes the previously included the canceled product instance. */
     package?: Package;
@@ -400,17 +466,25 @@ export interface ProductInstanceCanceled {
     /**
      * ID of the product instance that was canceled.
      * @readonly
+     * @format GUID
      */
     productInstanceId?: string;
 }
 export interface AdjustProductInstanceSpecificationsRequest {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
-    /** ID of the product instance to adjust. */
+    /**
+     * 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;
     /**
@@ -432,11 +506,15 @@ export interface AdjustProductInstanceSpecificationsRequest {
      * more information about supported codes.
      *
      * Max: 25 characters
+     * @maxLength 25
      */
     discountCode?: string | null;
 }
 export interface AdjustProductInstanceSpecificationsResponse {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
     /** Updated package that includes the adjusted product instance. */
     package?: Package;
@@ -447,6 +525,7 @@ export interface AdjustedProductInstanceSpecifications {
     /**
      * ID of the product instance to adjust.
      * @readonly
+     * @format GUID
      */
     productInstanceId?: string;
 }
@@ -495,7 +574,10 @@ export interface SubscriptionEvent extends SubscriptionEventEventOneOf {
     pendingChange?: SubscriptionPendingChange;
     /** Triggered when a recurring charge attempt fails for a subscription. */
     recurringChargeAttemptFailed?: RecurringChargeAttemptFailed;
-    /** ID of the subscription's event. */
+    /**
+     * ID of the subscription's event.
+     * @format GUID
+     */
     eventId?: string | null;
     /**
      * Date and time of the event in
@@ -569,13 +651,20 @@ export interface SubscriptionCreated {
  * owner has purchased including details about the billing.
  */
 export interface Subscription {
-    /** ID of the subscription. */
+    /**
+     * ID of the subscription.
+     * @format GUID
+     */
     _id?: string;
-    /** ID of the Wix account that purchased the subscription. */
+    /**
+     * 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;
     /**
@@ -594,6 +683,7 @@ export interface Subscription {
      * 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. */
@@ -621,6 +711,7 @@ export interface Subscription {
     /**
      * 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. */
@@ -742,7 +833,10 @@ export declare enum ReactivationReasonEnum {
 export interface SubscriptionAssigned {
     /** Assigned subscription. */
     subscription?: Subscription;
-    /** ID of the metasite that the subscription has been assigned to before the update. */
+    /**
+     * 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. */
@@ -790,8 +884,8 @@ export interface CancellationDetails {
     /**
      * Initiator of the cancellation. For `"USER_REQUESTED"` and `"APP_MANAGED"`,
      * `cancellationCode` and `cancellationReason` are taken from the request of
-     * [Cancel Immediately](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately)
-     * or [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).
+     * [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.
      *
@@ -841,7 +935,10 @@ export interface SubscriptionAutoRenewTurnedOff {
 export interface SubscriptionUnassigned {
     /** Unassigned subscription. */
     subscription?: Subscription;
-    /** ID of the metasite that the subscription has been assigned to before the event. */
+    /**
+     * ID of the metasite that the subscription has been assigned to before the event.
+     * @format GUID
+     */
     previousMetaSiteId?: string;
     /**
      * Reason why the subscription is unassigned.
@@ -885,9 +982,15 @@ export interface ContractSwitched {
     subscription?: Subscription;
     /** Billing cycle before the update. */
     previousCycle?: Cycle;
-    /** ID of the product belonging to the subscription before the update. */
+    /**
+     * 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. */
+    /**
+     * 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.
@@ -908,6 +1011,7 @@ export interface ContractSwitched {
     /**
      * 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;
     /**
@@ -947,7 +1051,10 @@ export declare enum ContractSwitchReason {
 }
 /** Triggered when a subscription's price is increased. */
 export interface ProductPriceIncreaseData {
-    /** Price of the subscription before the update. */
+    /**
+     * 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;
@@ -1000,6 +1107,7 @@ export interface ProductInstanceUpdated {
     /**
      * ID of the product instance that was adjusted.
      * @readonly
+     * @format GUID
      */
     productInstanceId?: string;
 }
@@ -1074,7 +1182,10 @@ export interface ActionEvent {
     body?: string;
 }
 export interface FailureReportRequest {
-    /** ID of the product instance that failed. */
+    /**
+     * ID of the product instance that failed.
+     * @format GUID
+     */
     instanceId?: string;
     /** Failure reason. */
     reason?: FailureReason;
@@ -1085,6 +1196,7 @@ export interface ProductInstanceFailed {
     /**
      * ID of the product instance that `FAILED`.
      * @readonly
+     * @format GUID
      */
     productInstanceId?: string;
     /** Failure reason. */
@@ -1120,9 +1232,13 @@ export interface Reschedule {
     payload?: string | null;
 }
 export interface UpdateProductInstanceRequest {
-    /** ID of the product instance to update. */
+    /**
+     * ID of the product instance to update.
+     * @format GUID
+     */
     instanceId?: string;
     status?: Status;
+    /** @format COUNTRY */
     countryCode?: string | null;
     /** Which field to update, currently only status and countryCode are supported. */
     fieldToUpdate?: FieldToUpdate;
@@ -1136,9 +1252,15 @@ export interface UpdateProductInstanceResponse {
     productInstance?: ProductInstance;
 }
 export interface UpdatePackageExternalIdRequest {
-    /** ID of the package to update. */
+    /**
+     * ID of the package to update.
+     * @format GUID
+     */
     packageId: string;
-    /** External ID that will be assigned to the package. */
+    /**
+     * External ID that will be assigned to the package.
+     * @maxLength 100
+     */
     externalId: string;
 }
 export interface UpdatePackageExternalIdResponse {
@@ -1154,9 +1276,15 @@ export interface CountPackagesResponse {
     count?: number;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -1164,26 +1292,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -1193,6 +1345,42 @@ export declare enum WebhookIdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
+export 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;
+}
+export interface MigrateSubscriptionToPackagesResponse {
+    package?: Package;
+}
+export 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;
+}
+export interface FixBrokenMigrationResponse {
+}
 interface CycleIntervalNonNullableFields {
     unit: IntervalIntervalUnit;
     count: number;
@@ -1275,11 +1463,21 @@ export interface UpdatePackageExternalIdResponseNonNullableFields {
  */
 export declare function createPackage(options?: CreatePackageOptions): Promise<CreatePackageResponse & CreatePackageResponseNonNullableFields>;
 export interface CreatePackageOptions {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
-    /** External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix. */
+    /**
+     * 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. */
+    /**
+     * Wix services that are resold.
+     * @maxSize 1000
+     * @minSize 1
+     */
     products: ProductInstance[];
 }
 /**
@@ -1320,11 +1518,21 @@ export interface CreatePackageOptions {
  */
 export declare function createPackageV2(options?: CreatePackageV2Options): Promise<CreatePackageResponse & CreatePackageResponseNonNullableFields>;
 export interface CreatePackageV2Options {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
-    /** External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix. */
+    /**
+     * 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. */
+    /**
+     * Wix services that are resold.
+     * @maxSize 1000
+     * @minSize 1
+     */
     products: ProductInstance[];
 }
 /**
@@ -1352,7 +1560,10 @@ export interface CreatePackageV2Options {
  */
 export declare function cancelPackage(_id: string, options?: CancelPackageOptions): Promise<CancelPackageResponse & CancelPackageResponseNonNullableFields>;
 export interface CancelPackageOptions {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
 }
 /**
@@ -1473,13 +1684,22 @@ export interface PackagesQueryBuilder {
  */
 export declare function assignProductInstanceToSite(identifiers: AssignProductInstanceToSiteIdentifiers, options?: AssignProductInstanceToSiteOptions): Promise<AssignProductInstanceToSiteResponse & AssignProductInstanceToSiteResponseNonNullableFields>;
 export interface AssignProductInstanceToSiteIdentifiers {
-    /** ID of the product instance to assign to a site. */
+    /**
+     * 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. */
+    /**
+     * ID of the site to which the product instance is assigned.
+     * @format GUID
+     */
     siteId: string;
 }
 export interface AssignProductInstanceToSiteOptions {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
 }
 /**
@@ -1503,7 +1723,10 @@ export interface AssignProductInstanceToSiteOptions {
  */
 export declare function unassignProductInstanceFromSite(instanceId: string, options?: UnassignProductInstanceFromSiteOptions): Promise<UnassignProductInstanceFromSiteResponse & UnassignProductInstanceFromSiteResponseNonNullableFields>;
 export interface UnassignProductInstanceFromSiteOptions {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
 }
 /**
@@ -1535,7 +1758,10 @@ export interface UnassignProductInstanceFromSiteOptions {
  */
 export declare function cancelProductInstance(instanceId: string, options?: CancelProductInstanceOptions): Promise<CancelProductInstanceResponse & CancelProductInstanceResponseNonNullableFields>;
 export interface CancelProductInstanceOptions {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
 }
 /**
@@ -1579,11 +1805,15 @@ export interface CancelProductInstanceOptions {
  */
 export declare function adjustProductInstanceSpecifications(instanceId: string, options?: AdjustProductInstanceSpecificationsOptions): Promise<AdjustProductInstanceSpecificationsResponse & AdjustProductInstanceSpecificationsResponseNonNullableFields>;
 export interface AdjustProductInstanceSpecificationsOptions {
-    /** Idempotency key. */
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
     idempotencyKey?: string | null;
     /**
      * 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;
     /**
@@ -1605,6 +1835,7 @@ export interface AdjustProductInstanceSpecificationsOptions {
      * more information about supported codes.
      *
      * Max: 25 characters
+     * @maxLength 25
      */
     discountCode?: string | null;
 }
@@ -1620,9 +1851,15 @@ export interface AdjustProductInstanceSpecificationsOptions {
  */
 export declare function updatePackageExternalId(identifiers: UpdatePackageExternalIdIdentifiers): Promise<UpdatePackageExternalIdResponse & UpdatePackageExternalIdResponseNonNullableFields>;
 export interface UpdatePackageExternalIdIdentifiers {
-    /** ID of the package to update. */
+    /**
+     * ID of the package to update.
+     * @format GUID
+     */
     packageId: string;
-    /** External ID that will be assigned to the package. */
+    /**
+     * External ID that will be assigned to the package.
+     * @maxLength 100
+     */
     externalId: string;
 }
 export {};