@wix/auto_sdk_payments_dispute-evidence-documents 1.0.1 → 1.0.3

package/build/internal/cjs/src/payments-dispute-evidence-documents-v1-dispute-evidence-document-dispute-evidence-documents.types.d.ts

@@ -2,7 +2,9 @@
 export interface DisputeEvidenceDocument {
     /**
      * DisputeEvidenceDocument ID.
+     * @format GUID
      * @readonly
+     * @immutable
      */
     id?: string;
     /**
@@ -13,6 +15,7 @@ export interface DisputeEvidenceDocument {
     /**
      * Date and time the DisputeEvidenceDocument was created.
      * @readonly
+     * @immutable
      */
     createdDate?: Date | null;
     /**
@@ -20,7 +23,11 @@ export interface DisputeEvidenceDocument {
      * @readonly
      */
     updatedDate?: Date | null;
-    /** Dispute ID */
+    /**
+     * Dispute ID
+     * @format GUID
+     * @immutable
+     */
     disputeId?: string;
     /**
      * Document evidence file if it was uploaded and attached
@@ -28,7 +35,6 @@ export interface DisputeEvidenceDocument {
      */
     file?: DocumentFile;
     /**
-     * TODO we want this to be read only: not allow to create submitted documents
      * Submitted date
      * @readonly
      */
@@ -38,11 +44,11 @@ export interface DisputeEvidenceDocument {
     /** Tags */
     tags?: Tags;
 }
-/** TODO do we need to mark fields here as readOnly if DocumentFile file was marked as readOnly? */
 export interface DocumentFile {
     /**
      * Document filename.
      * @readonly
+     * @maxLength 255
      */
     filename?: string | null;
     /**
@@ -52,6 +58,8 @@ export interface DocumentFile {
     sizeInBytes?: string | null;
     /**
      * Hexadecimal representation of the document's MD5 digest.
+     * @minLength 32
+     * @maxLength 32
      * @readonly
      */
     hexMd5Digest?: string | null;
@@ -94,7 +102,11 @@ export interface Tags {
     tags?: TagList;
 }
 export interface TagList {
-    /** List of tag IDs */
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
     tagIds?: string[];
 }
 export interface CreateDisputeEvidenceDocumentRequest {
@@ -106,17 +118,30 @@ export interface CreateDisputeEvidenceDocumentResponse {
     disputeEvidenceDocument?: DisputeEvidenceDocument;
 }
 export interface GenerateDisputeEvidenceDocumentUploadUrlRequest {
-    /** Dispute Evidence Document ID */
+    /**
+     * Dispute Evidence Document ID
+     * @format GUID
+     */
     disputeEvidenceDocumentId: string;
-    /** Name of the uploaded file */
+    /**
+     * Name of the uploaded file
+     * @minLength 1
+     * @maxLength 255
+     */
     filename?: string;
 }
 export interface GenerateDisputeEvidenceDocumentUploadUrlResponse {
-    /** Evidence Document upload URL */
+    /**
+     * Evidence Document upload URL
+     * @format WEB_URL
+     */
     uploadUrl?: string;
 }
 export interface AttachDisputeEvidenceDocumentFileRequest {
-    /** Dispute Evidence Document ID */
+    /**
+     * Dispute Evidence Document ID
+     * @format GUID
+     */
     disputeEvidenceDocumentId: string;
 }
 export interface AttachDisputeEvidenceDocumentFileResponse {
@@ -124,7 +149,10 @@ export interface AttachDisputeEvidenceDocumentFileResponse {
     disputeEvidenceDocument?: DisputeEvidenceDocument;
 }
 export interface GetDisputeEvidenceDocumentRequest {
-    /** ID of the DisputeEvidenceDocument to retrieve. */
+    /**
+     * ID of the DisputeEvidenceDocument to retrieve.
+     * @format GUID
+     */
     disputeEvidenceDocumentId: string;
 }
 export interface GetDisputeEvidenceDocumentResponse {
@@ -132,23 +160,35 @@ export interface GetDisputeEvidenceDocumentResponse {
     disputeEvidenceDocument?: DisputeEvidenceDocument;
 }
 export interface GenerateDisputeEvidenceDocumentDownloadUrlRequest {
-    /** ID of the DisputeEvidenceDocument to generate Download Url. */
+    /**
+     * ID of the DisputeEvidenceDocument to generate Download Url.
+     * @format GUID
+     */
     disputeEvidenceDocumentId: string;
 }
 export interface GenerateDisputeEvidenceDocumentDownloadUrlResponse {
-    /** Document source URL. */
+    /**
+     * Document source URL.
+     * @format WEB_URL
+     */
     url?: string | null;
     /** Document source URL expiration date (when relevant). */
     urlExpirationDate?: Date | null;
 }
 export interface MarkDisputeEvidenceDocumentSubmittedRequest {
-    /** Id of the DisputeEvidenceDocument to mark as submitted. */
+    /**
+     * Id of the DisputeEvidenceDocument to mark as submitted.
+     * @format GUID
+     */
     disputeEvidenceDocumentId: string;
 }
 export interface MarkDisputeEvidenceDocumentSubmittedResponse {
 }
 export interface DeleteDisputeEvidenceDocumentRequest {
-    /** Id of the DisputeEvidenceDocument to delete. */
+    /**
+     * Id of the DisputeEvidenceDocument to delete.
+     * @format GUID
+     */
     disputeEvidenceDocumentId: string;
 }
 export interface DeleteDisputeEvidenceDocumentResponse {
@@ -172,6 +212,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -181,7 +222,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;
@@ -191,13 +235,17 @@ 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;
 }
@@ -221,13 +269,24 @@ 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 BulkUpdateDisputeEvidenceDocumentTagsRequest {
-    /** List of NileProtoTagsEntities that their tags will update. */
+    /**
+     * List of NileProtoTagsEntities that their tags will update.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
     ids: string[];
     /** List of Tags to assign */
     assignTags?: Tags;
@@ -235,13 +294,20 @@ export interface BulkUpdateDisputeEvidenceDocumentTagsRequest {
     unassignTags?: Tags;
 }
 export interface BulkUpdateDisputeEvidenceDocumentTagsResponse {
-    /** Results */
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
     results?: BulkUpdateDisputeEvidenceDocumentTagsResult[];
     /** Metadata regarding the bulk update operation */
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
     id?: string | null;
     /** Index of the item within the request array. Allows for correlation between request and response items. */
     originalIndex?: number;
@@ -279,7 +345,10 @@ export interface BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest {
     unassignTags?: Tags;
 }
 export interface BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse {
-    /** Job ID */
+    /**
+     * Job ID
+     * @format GUID
+     */
     jobId?: string;
 }
 export interface DomainEvent extends DomainEventBodyOneOf {
@@ -355,9 +424,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 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;
@@ -365,26 +440,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/internal/cjs/src/payments-dispute-evidence-documents-v1-dispute-evidence-document-dispute-evidence-documents.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"payments-dispute-evidence-documents-v1-dispute-evidence-document-dispute-evidence-documents.types.js","sourceRoot":"","sources":["../../../../src/payments-dispute-evidence-documents-v1-dispute-evidence-document-dispute-evidence-documents.types.ts"],"names":[],"mappings":";;;AAiNA,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AA6ND,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":"payments-dispute-evidence-documents-v1-dispute-evidence-document-dispute-evidence-documents.types.js","sourceRoot":"","sources":["../../../../src/payments-dispute-evidence-documents-v1-dispute-evidence-document-dispute-evidence-documents.types.ts"],"names":[],"mappings":";;;AA6PA,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAoRD,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/internal/cjs/src/payments-dispute-evidence-documents-v1-dispute-evidence-document-dispute-evidence-documents.universal.d.ts

@@ -2,7 +2,9 @@
 export interface DisputeEvidenceDocument {
     /**
      * DisputeEvidenceDocument ID.
+     * @format GUID
      * @readonly
+     * @immutable
      */
     _id?: string;
     /**
@@ -13,6 +15,7 @@ export interface DisputeEvidenceDocument {
     /**
      * Date and time the DisputeEvidenceDocument was created.
      * @readonly
+     * @immutable
      */
     _createdDate?: Date | null;
     /**
@@ -20,7 +23,11 @@ export interface DisputeEvidenceDocument {
      * @readonly
      */
     _updatedDate?: Date | null;
-    /** Dispute ID */
+    /**
+     * Dispute ID
+     * @format GUID
+     * @immutable
+     */
     disputeId?: string;
     /**
      * Document evidence file if it was uploaded and attached
@@ -28,7 +35,6 @@ export interface DisputeEvidenceDocument {
      */
     file?: DocumentFile;
     /**
-     * TODO we want this to be read only: not allow to create submitted documents
      * Submitted date
      * @readonly
      */
@@ -38,11 +44,11 @@ export interface DisputeEvidenceDocument {
     /** Tags */
     tags?: Tags;
 }
-/** TODO do we need to mark fields here as readOnly if DocumentFile file was marked as readOnly? */
 export interface DocumentFile {
     /**
      * Document filename.
      * @readonly
+     * @maxLength 255
      */
     filename?: string | null;
     /**
@@ -52,6 +58,8 @@ export interface DocumentFile {
     sizeInBytes?: string | null;
     /**
      * Hexadecimal representation of the document's MD5 digest.
+     * @minLength 32
+     * @maxLength 32
      * @readonly
      */
     hexMd5Digest?: string | null;
@@ -94,7 +102,11 @@ export interface Tags {
     tags?: TagList;
 }
 export interface TagList {
-    /** List of tag IDs */
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
     tagIds?: string[];
 }
 export interface CreateDisputeEvidenceDocumentRequest {
@@ -106,17 +118,30 @@ export interface CreateDisputeEvidenceDocumentResponse {
     disputeEvidenceDocument?: DisputeEvidenceDocument;
 }
 export interface GenerateDisputeEvidenceDocumentUploadUrlRequest {
-    /** Dispute Evidence Document ID */
+    /**
+     * Dispute Evidence Document ID
+     * @format GUID
+     */
     disputeEvidenceDocumentId: string;
-    /** Name of the uploaded file */
+    /**
+     * Name of the uploaded file
+     * @minLength 1
+     * @maxLength 255
+     */
     filename?: string;
 }
 export interface GenerateDisputeEvidenceDocumentUploadUrlResponse {
-    /** Evidence Document upload URL */
+    /**
+     * Evidence Document upload URL
+     * @format WEB_URL
+     */
     uploadUrl?: string;
 }
 export interface AttachDisputeEvidenceDocumentFileRequest {
-    /** Dispute Evidence Document ID */
+    /**
+     * Dispute Evidence Document ID
+     * @format GUID
+     */
     disputeEvidenceDocumentId: string;
 }
 export interface AttachDisputeEvidenceDocumentFileResponse {
@@ -124,7 +149,10 @@ export interface AttachDisputeEvidenceDocumentFileResponse {
     disputeEvidenceDocument?: DisputeEvidenceDocument;
 }
 export interface GetDisputeEvidenceDocumentRequest {
-    /** ID of the DisputeEvidenceDocument to retrieve. */
+    /**
+     * ID of the DisputeEvidenceDocument to retrieve.
+     * @format GUID
+     */
     disputeEvidenceDocumentId: string;
 }
 export interface GetDisputeEvidenceDocumentResponse {
@@ -132,23 +160,35 @@ export interface GetDisputeEvidenceDocumentResponse {
     disputeEvidenceDocument?: DisputeEvidenceDocument;
 }
 export interface GenerateDisputeEvidenceDocumentDownloadUrlRequest {
-    /** ID of the DisputeEvidenceDocument to generate Download Url. */
+    /**
+     * ID of the DisputeEvidenceDocument to generate Download Url.
+     * @format GUID
+     */
     disputeEvidenceDocumentId: string;
 }
 export interface GenerateDisputeEvidenceDocumentDownloadUrlResponse {
-    /** Document source URL. */
+    /**
+     * Document source URL.
+     * @format WEB_URL
+     */
     url?: string | null;
     /** Document source URL expiration date (when relevant). */
     urlExpirationDate?: Date | null;
 }
 export interface MarkDisputeEvidenceDocumentSubmittedRequest {
-    /** Id of the DisputeEvidenceDocument to mark as submitted. */
+    /**
+     * Id of the DisputeEvidenceDocument to mark as submitted.
+     * @format GUID
+     */
     disputeEvidenceDocumentId: string;
 }
 export interface MarkDisputeEvidenceDocumentSubmittedResponse {
 }
 export interface DeleteDisputeEvidenceDocumentRequest {
-    /** Id of the DisputeEvidenceDocument to delete. */
+    /**
+     * Id of the DisputeEvidenceDocument to delete.
+     * @format GUID
+     */
     disputeEvidenceDocumentId: string;
 }
 export interface DeleteDisputeEvidenceDocumentResponse {
@@ -172,6 +212,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -181,7 +222,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;
@@ -191,13 +235,17 @@ 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;
 }
@@ -221,13 +269,24 @@ 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 BulkUpdateDisputeEvidenceDocumentTagsRequest {
-    /** List of NileProtoTagsEntities that their tags will update. */
+    /**
+     * List of NileProtoTagsEntities that their tags will update.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
     ids: string[];
     /** List of Tags to assign */
     assignTags?: Tags;
@@ -235,13 +294,20 @@ export interface BulkUpdateDisputeEvidenceDocumentTagsRequest {
     unassignTags?: Tags;
 }
 export interface BulkUpdateDisputeEvidenceDocumentTagsResponse {
-    /** Results */
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
     results?: BulkUpdateDisputeEvidenceDocumentTagsResult[];
     /** Metadata regarding the bulk update operation */
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
     _id?: string | null;
     /** Index of the item within the request array. Allows for correlation between request and response items. */
     originalIndex?: number;
@@ -279,7 +345,10 @@ export interface BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest {
     unassignTags?: Tags;
 }
 export interface BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse {
-    /** Job ID */
+    /**
+     * Job ID
+     * @format GUID
+     */
     jobId?: string;
 }
 export interface DomainEvent extends DomainEventBodyOneOf {
@@ -353,9 +422,15 @@ export interface ActionEvent {
     body?: string;
 }
 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;
@@ -363,26 +438,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 {
@@ -466,7 +565,11 @@ export declare function createDisputeEvidenceDocument(disputeEvidenceDocument: D
  */
 export declare function generateDisputeEvidenceDocumentUploadUrl(disputeEvidenceDocumentId: string, options?: GenerateDisputeEvidenceDocumentUploadUrlOptions): Promise<GenerateDisputeEvidenceDocumentUploadUrlResponse & GenerateDisputeEvidenceDocumentUploadUrlResponseNonNullableFields>;
 export interface GenerateDisputeEvidenceDocumentUploadUrlOptions {
-    /** Name of the uploaded file */
+    /**
+     * Name of the uploaded file
+     * @minLength 1
+     * @maxLength 255
+     */
     filename?: string;
 }
 /**