@wix/auto_sdk_ecom_order-payment-requests 1.0.0 → 1.0.2

package/build/cjs/src/ecom-v1-order-payment-request-order-payment-requests.types.d.ts

@@ -1,45 +1,68 @@
 export interface OrderPaymentRequest {
     /**
      * Order payment request ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
-    /** Additional parameters to identify the source of the order payment request. */
+    /**
+     * Additional parameters to identify the source of the order payment request.
+     * @immutable
+     */
     source?: Source;
     /**
      * status.
      * @readonly
      */
     status?: Status;
-    /** Order ID. */
+    /**
+     * Order ID.
+     * @format GUID
+     * @immutable
+     */
     orderId?: string;
     /**
      * Order number.
      * @readonly
+     * @maxLength 100
      */
     orderNumber?: string | null;
     /**
      * Amount to collect.
      * > **Note:** The amount can only be set once.
+     * @immutable
      */
     amount?: Price;
     /**
      * Currency code. The value will always match the currency used in the order.
+     * @format CURRENCY
      * @readonly
      */
     currency?: string;
     /**
      * Payment gateway order id which is associated with this payment request
      * @readonly
+     * @minLength 1
+     * @maxLength 100
      */
     paymentGatewayOrderId?: string | null;
-    /** Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for. */
+    /**
+     * Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for.
+     * @minLength 1
+     * @maxLength 200
+     */
     title?: string;
-    /** Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for. */
+    /**
+     * Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for.
+     * @maxLength 300
+     */
     description?: string | null;
     /** Image to be displayed to the customer on the payment page. */
     image?: Image;
-    /** Time and date the order payment request expires. */
+    /**
+     * Time and date the order payment request expires.
+     * @immutable
+     */
     expirationDate?: Date | null;
     /** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls. */
     extendedFields?: ExtendedFields;
@@ -55,9 +78,20 @@ export interface OrderPaymentRequest {
     updatedDate?: Date | null;
 }
 export interface Source {
-    /** App Def ID that created the order payment request. */
+    /**
+     * App Def ID that created the order payment request.
+     * @format GUID
+     * @minLength 1
+     * @maxLength 100
+     * @immutable
+     */
     appId?: string | null;
-    /** Reference to an ID from an external system, indicating the original source of the order payment request. */
+    /**
+     * Reference to an ID from an external system, indicating the original source of the order payment request.
+     * @minLength 1
+     * @maxLength 100
+     * @immutable
+     */
     externalId?: string;
 }
 export declare enum Status {
@@ -67,7 +101,10 @@ export declare enum Status {
     EXPIRED = "EXPIRED"
 }
 export interface Price {
-    /** Amount. */
+    /**
+     * Amount.
+     * @decimalValue options { gte:0, lte:1000000000000000 }
+     */
     amount?: string;
     /**
      * Amount formatted with currency symbol.
@@ -76,7 +113,10 @@ export interface Price {
     formattedAmount?: string;
 }
 export interface Image {
-    /** WixMedia image ID. */
+    /**
+     * WixMedia image ID.
+     * @maxLength 200
+     */
     id?: string;
     /**
      * Original image height.
@@ -88,11 +128,15 @@ export interface Image {
      * @readonly
      */
     width?: number;
-    /** Image alt text. */
+    /**
+     * Image alt text.
+     * @maxLength 200
+     */
     altText?: string | null;
     /**
      * Image filename.
      * @readonly
+     * @maxLength 200
      */
     filename?: string | null;
 }
@@ -124,11 +168,18 @@ export interface CreateOrderPaymentRequestRequest {
 export interface CreateOrderPaymentRequestResponse {
     /** The created OrderPaymentRequest. */
     orderPaymentRequest?: OrderPaymentRequest;
-    /** Order payment request URL. */
+    /**
+     * Order payment request URL.
+     * @minLength 1
+     * @maxLength 100
+     */
     orderPaymentRequestUrl?: string;
 }
 export interface GetOrderPaymentRequestRequest {
-    /** ID of the OrderPaymentRequest to retrieve. */
+    /**
+     * ID of the OrderPaymentRequest to retrieve.
+     * @format GUID
+     */
     orderPaymentRequestId: string;
 }
 export interface GetOrderPaymentRequestResponse {
@@ -144,7 +195,10 @@ export interface UpdateOrderPaymentRequestResponse {
     orderPaymentRequest?: OrderPaymentRequest;
 }
 export interface DeleteOrderPaymentRequestRequest {
-    /** Id of the OrderPaymentRequest to delete. */
+    /**
+     * Id of the OrderPaymentRequest to delete.
+     * @format GUID
+     */
     orderPaymentRequestId: string;
 }
 export interface DeleteOrderPaymentRequestResponse {
@@ -168,6 +222,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -177,7 +232,10 @@ export interface CursorQueryPagingMethodOneOf {
     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;
@@ -187,18 +245,25 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 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;
 }
 export interface QueryOrderPaymentRequestsResponse {
-    /** List of payment requests. */
+    /**
+     * List of payment requests.
+     * @maxSize 1000
+     */
     orderPaymentRequests?: OrderPaymentRequest[];
     /** Paging metadata */
     pagingMetadata?: CursorPagingMetadata;
@@ -217,17 +282,30 @@ export interface CursorPagingMetadata {
     hasNext?: boolean | null;
 }
 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 GetOrderPaymentRequestURLRequest {
-    /** Order Payment Request ID. */
+    /**
+     * Order Payment Request ID.
+     * @format GUID
+     */
     orderPaymentRequestId: string;
 }
 export interface GetOrderPaymentRequestURLResponse {
-    /** Order Payment Request URL. */
+    /**
+     * Order Payment Request URL.
+     * @minLength 1
+     * @maxLength 100
+     */
     orderPaymentRequestUrl?: string;
 }
 export interface UpdateExtendedFieldsRequest {
@@ -317,9 +395,15 @@ export interface ActionEvent {
 export interface Empty {
 }
 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;
@@ -327,26 +411,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 {

package/build/cjs/src/ecom-v1-order-payment-request-order-payment-requests.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"ecom-v1-order-payment-request-order-payment-requests.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-order-payment-request-order-payment-requests.types.ts"],"names":[],"mappings":";;;AAgEA,IAAY,MAKX;AALD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,2BAAiB,CAAA;IACjB,uBAAa,CAAA;IACb,6BAAmB,CAAA;AACrB,CAAC,EALW,MAAM,sBAAN,MAAM,QAKjB;AAsID,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAuLD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"ecom-v1-order-payment-request-order-payment-requests.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-order-payment-request-order-payment-requests.types.ts"],"names":[],"mappings":";;;AAkGA,IAAY,MAKX;AALD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,2BAAiB,CAAA;IACjB,uBAAa,CAAA;IACb,6BAAmB,CAAA;AACrB,CAAC,EALW,MAAM,sBAAN,MAAM,QAKjB;AA8JD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAyOD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}

package/build/cjs/src/ecom-v1-order-payment-request-order-payment-requests.universal.d.ts

@@ -1,45 +1,68 @@
 export interface OrderPaymentRequest {
     /**
      * Order payment request ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
-    /** Additional parameters to identify the source of the order payment request. */
+    /**
+     * Additional parameters to identify the source of the order payment request.
+     * @immutable
+     */
     source?: Source;
     /**
      * status.
      * @readonly
      */
     status?: Status;
-    /** Order ID. */
+    /**
+     * Order ID.
+     * @format GUID
+     * @immutable
+     */
     orderId?: string;
     /**
      * Order number.
      * @readonly
+     * @maxLength 100
      */
     orderNumber?: string | null;
     /**
      * Amount to collect.
      * > **Note:** The amount can only be set once.
+     * @immutable
      */
     amount?: Price;
     /**
      * Currency code. The value will always match the currency used in the order.
+     * @format CURRENCY
      * @readonly
      */
     currency?: string;
     /**
      * Payment gateway order id which is associated with this payment request
      * @readonly
+     * @minLength 1
+     * @maxLength 100
      */
     paymentGatewayOrderId?: string | null;
-    /** Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for. */
+    /**
+     * Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for.
+     * @minLength 1
+     * @maxLength 200
+     */
     title?: string;
-    /** Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for. */
+    /**
+     * Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for.
+     * @maxLength 300
+     */
     description?: string | null;
     /** Image to be displayed to the customer on the payment page. */
     image?: string;
-    /** Time and date the order payment request expires. */
+    /**
+     * Time and date the order payment request expires.
+     * @immutable
+     */
     expirationDate?: Date | null;
     /** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls. */
     extendedFields?: ExtendedFields;
@@ -55,9 +78,20 @@ export interface OrderPaymentRequest {
     _updatedDate?: Date | null;
 }
 export interface Source {
-    /** App Def ID that created the order payment request. */
+    /**
+     * App Def ID that created the order payment request.
+     * @format GUID
+     * @minLength 1
+     * @maxLength 100
+     * @immutable
+     */
     appId?: string | null;
-    /** Reference to an ID from an external system, indicating the original source of the order payment request. */
+    /**
+     * Reference to an ID from an external system, indicating the original source of the order payment request.
+     * @minLength 1
+     * @maxLength 100
+     * @immutable
+     */
     externalId?: string;
 }
 export declare enum Status {
@@ -67,7 +101,10 @@ export declare enum Status {
     EXPIRED = "EXPIRED"
 }
 export interface Price {
-    /** Amount. */
+    /**
+     * Amount.
+     * @decimalValue options { gte:0, lte:1000000000000000 }
+     */
     amount?: string;
     /**
      * Amount formatted with currency symbol.
@@ -103,11 +140,18 @@ export interface CreateOrderPaymentRequestRequest {
 export interface CreateOrderPaymentRequestResponse {
     /** The created OrderPaymentRequest. */
     orderPaymentRequest?: OrderPaymentRequest;
-    /** Order payment request URL. */
+    /**
+     * Order payment request URL.
+     * @minLength 1
+     * @maxLength 100
+     */
     orderPaymentRequestUrl?: string;
 }
 export interface GetOrderPaymentRequestRequest {
-    /** ID of the OrderPaymentRequest to retrieve. */
+    /**
+     * ID of the OrderPaymentRequest to retrieve.
+     * @format GUID
+     */
     orderPaymentRequestId: string;
 }
 export interface GetOrderPaymentRequestResponse {
@@ -123,7 +167,10 @@ export interface UpdateOrderPaymentRequestResponse {
     orderPaymentRequest?: OrderPaymentRequest;
 }
 export interface DeleteOrderPaymentRequestRequest {
-    /** Id of the OrderPaymentRequest to delete. */
+    /**
+     * Id of the OrderPaymentRequest to delete.
+     * @format GUID
+     */
     orderPaymentRequestId: string;
 }
 export interface DeleteOrderPaymentRequestResponse {
@@ -147,6 +194,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -156,7 +204,10 @@ export interface CursorQueryPagingMethodOneOf {
     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;
@@ -166,18 +217,25 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 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;
 }
 export interface QueryOrderPaymentRequestsResponse {
-    /** List of payment requests. */
+    /**
+     * List of payment requests.
+     * @maxSize 1000
+     */
     orderPaymentRequests?: OrderPaymentRequest[];
     /** Paging metadata */
     pagingMetadata?: CursorPagingMetadata;
@@ -196,17 +254,30 @@ export interface CursorPagingMetadata {
     hasNext?: boolean | null;
 }
 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 GetOrderPaymentRequestURLRequest {
-    /** Order Payment Request ID. */
+    /**
+     * Order Payment Request ID.
+     * @format GUID
+     */
     orderPaymentRequestId: string;
 }
 export interface GetOrderPaymentRequestURLResponse {
-    /** Order Payment Request URL. */
+    /**
+     * Order Payment Request URL.
+     * @minLength 1
+     * @maxLength 100
+     */
     orderPaymentRequestUrl?: string;
 }
 export interface UpdateExtendedFieldsRequest {
@@ -294,9 +365,15 @@ export interface ActionEvent {
 export interface Empty {
 }
 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;
@@ -304,26 +381,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 {
@@ -428,45 +529,68 @@ export declare function updateOrderPaymentRequest(_id: string | null, orderPayme
 export interface UpdateOrderPaymentRequest {
     /**
      * Order payment request ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
-    /** Additional parameters to identify the source of the order payment request. */
+    /**
+     * Additional parameters to identify the source of the order payment request.
+     * @immutable
+     */
     source?: Source;
     /**
      * status.
      * @readonly
      */
     status?: Status;
-    /** Order ID. */
+    /**
+     * Order ID.
+     * @format GUID
+     * @immutable
+     */
     orderId?: string;
     /**
      * Order number.
      * @readonly
+     * @maxLength 100
      */
     orderNumber?: string | null;
     /**
      * Amount to collect.
      * > **Note:** The amount can only be set once.
+     * @immutable
      */
     amount?: Price;
     /**
      * Currency code. The value will always match the currency used in the order.
+     * @format CURRENCY
      * @readonly
      */
     currency?: string;
     /**
      * Payment gateway order id which is associated with this payment request
      * @readonly
+     * @minLength 1
+     * @maxLength 100
      */
     paymentGatewayOrderId?: string | null;
-    /** Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for. */
+    /**
+     * Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for.
+     * @minLength 1
+     * @maxLength 200
+     */
     title?: string;
-    /** Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for. */
+    /**
+     * Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for.
+     * @maxLength 300
+     */
     description?: string | null;
     /** Image to be displayed to the customer on the payment page. */
     image?: string;
-    /** Time and date the order payment request expires. */
+    /**
+     * Time and date the order payment request expires.
+     * @immutable
+     */
     expirationDate?: Date | null;
     /** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls. */
     extendedFields?: ExtendedFields;