@wix/auto_sdk_payments_dispute-evidence-documents 1.0.6 → 1.0.8

package/build/meta.d.ts

@@ -0,0 +1,390 @@
+import { CreateDisputeEvidenceDocumentRequest as CreateDisputeEvidenceDocumentRequest$1, CreateDisputeEvidenceDocumentResponse as CreateDisputeEvidenceDocumentResponse$1, GenerateDisputeEvidenceDocumentUploadUrlRequest as GenerateDisputeEvidenceDocumentUploadUrlRequest$1, GenerateDisputeEvidenceDocumentUploadUrlResponse as GenerateDisputeEvidenceDocumentUploadUrlResponse$1, AttachDisputeEvidenceDocumentFileRequest as AttachDisputeEvidenceDocumentFileRequest$1, AttachDisputeEvidenceDocumentFileResponse as AttachDisputeEvidenceDocumentFileResponse$1, GetDisputeEvidenceDocumentRequest as GetDisputeEvidenceDocumentRequest$1, GetDisputeEvidenceDocumentResponse as GetDisputeEvidenceDocumentResponse$1, GenerateDisputeEvidenceDocumentDownloadUrlRequest as GenerateDisputeEvidenceDocumentDownloadUrlRequest$1, GenerateDisputeEvidenceDocumentDownloadUrlResponse as GenerateDisputeEvidenceDocumentDownloadUrlResponse$1, MarkDisputeEvidenceDocumentSubmittedRequest as MarkDisputeEvidenceDocumentSubmittedRequest$1, MarkDisputeEvidenceDocumentSubmittedResponse as MarkDisputeEvidenceDocumentSubmittedResponse$1, DeleteDisputeEvidenceDocumentRequest as DeleteDisputeEvidenceDocumentRequest$1, DeleteDisputeEvidenceDocumentResponse as DeleteDisputeEvidenceDocumentResponse$1, QueryDisputeEvidenceDocumentsRequest as QueryDisputeEvidenceDocumentsRequest$1, QueryDisputeEvidenceDocumentsResponse as QueryDisputeEvidenceDocumentsResponse$1, BulkUpdateDisputeEvidenceDocumentTagsRequest as BulkUpdateDisputeEvidenceDocumentTagsRequest$1, BulkUpdateDisputeEvidenceDocumentTagsResponse as BulkUpdateDisputeEvidenceDocumentTagsResponse$1, BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest as BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest$1, BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse as BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse$1 } from './index.js';
+
+/** Dispute Evidence Document */
+interface DisputeEvidenceDocument {
+    /**
+     * DisputeEvidenceDocument ID.
+     * @format GUID
+     * @readonly
+     * @immutable
+     */
+    id?: string | null;
+    /**
+     * Revision number
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the DisputeEvidenceDocument was created.
+     * @readonly
+     * @immutable
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the DisputeEvidenceDocument was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Dispute ID
+     * @format GUID
+     * @immutable
+     */
+    disputeId?: string;
+    /**
+     * Document evidence file if it was uploaded and attached
+     * @readonly
+     */
+    file?: DocumentFile;
+    /**
+     * Submitted date
+     * @readonly
+     */
+    submittedDate?: Date | null;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: Tags;
+}
+interface DocumentFile {
+    /**
+     * Document filename.
+     * @readonly
+     * @maxLength 255
+     */
+    filename?: string | null;
+    /**
+     * Document size in bytes.
+     * @readonly
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Hexadecimal representation of the document's MD5 digest.
+     * @minLength 32
+     * @maxLength 32
+     * @readonly
+     */
+    hexMd5Digest?: string | null;
+}
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+/**
+ * Common object for tags.
+ * Should be use as in this example:
+ * message Foo {
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+interface Tags {
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    tags?: TagList;
+}
+interface TagList {
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+interface CreateDisputeEvidenceDocumentRequest {
+    /** DisputeEvidenceDocument to be created. */
+    disputeEvidenceDocument: DisputeEvidenceDocument;
+}
+interface CreateDisputeEvidenceDocumentResponse {
+    /** The created DisputeEvidenceDocument. */
+    disputeEvidenceDocument?: DisputeEvidenceDocument;
+}
+interface GenerateDisputeEvidenceDocumentUploadUrlRequest {
+    /**
+     * Dispute Evidence Document ID
+     * @format GUID
+     */
+    disputeEvidenceDocumentId: string;
+    /**
+     * Name of the uploaded file
+     * @minLength 1
+     * @maxLength 255
+     */
+    filename?: string;
+}
+interface GenerateDisputeEvidenceDocumentUploadUrlResponse {
+    /**
+     * Evidence Document upload URL
+     * @format WEB_URL
+     */
+    uploadUrl?: string;
+}
+interface AttachDisputeEvidenceDocumentFileRequest {
+    /**
+     * Dispute Evidence Document ID
+     * @format GUID
+     */
+    disputeEvidenceDocumentId: string;
+}
+interface AttachDisputeEvidenceDocumentFileResponse {
+    /** Dispute Evidence Document */
+    disputeEvidenceDocument?: DisputeEvidenceDocument;
+}
+interface GetDisputeEvidenceDocumentRequest {
+    /**
+     * ID of the DisputeEvidenceDocument to retrieve.
+     * @format GUID
+     */
+    disputeEvidenceDocumentId: string;
+}
+interface GetDisputeEvidenceDocumentResponse {
+    /** The requested DisputeEvidenceDocument. */
+    disputeEvidenceDocument?: DisputeEvidenceDocument;
+}
+interface GenerateDisputeEvidenceDocumentDownloadUrlRequest {
+    /**
+     * ID of the DisputeEvidenceDocument to generate Download Url.
+     * @format GUID
+     */
+    disputeEvidenceDocumentId: string;
+}
+interface GenerateDisputeEvidenceDocumentDownloadUrlResponse {
+    /**
+     * Document source URL.
+     * @format WEB_URL
+     */
+    url?: string | null;
+    /** Document source URL expiration date (when relevant). */
+    urlExpirationDate?: Date | null;
+}
+interface MarkDisputeEvidenceDocumentSubmittedRequest {
+    /**
+     * Id of the DisputeEvidenceDocument to mark as submitted.
+     * @format GUID
+     */
+    disputeEvidenceDocumentId: string;
+}
+interface MarkDisputeEvidenceDocumentSubmittedResponse {
+}
+interface DeleteDisputeEvidenceDocumentRequest {
+    /**
+     * Id of the DisputeEvidenceDocument to delete.
+     * @format GUID
+     */
+    disputeEvidenceDocumentId: string;
+}
+interface DeleteDisputeEvidenceDocumentResponse {
+}
+interface QueryDisputeEvidenceDocumentsRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** 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 in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** 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?: SortOrder;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+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 QueryDisputeEvidenceDocumentsResponse {
+    /** List of DisputeEvidenceDocuments. */
+    disputeEvidenceDocuments?: DisputeEvidenceDocument[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+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 BulkUpdateDisputeEvidenceDocumentTagsRequest {
+    /**
+     * List of NileProtoTagsEntities that their tags will update.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    ids: string[];
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdateDisputeEvidenceDocumentTagsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateDisputeEvidenceDocumentTagsResult[];
+    /** Metadata regarding the bulk update operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ItemMetadata {
+    /**
+     * 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;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkUpdateDisputeEvidenceDocumentTagsResult {
+    /** Metadata regarding the specific single update operation */
+    itemMetadata?: ItemMetadata;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest {
+    /** Filter */
+    filter: Record<string, any> | null;
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse {
+    /**
+     * Job ID
+     * @format GUID
+     */
+    jobId?: string;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createDisputeEvidenceDocument(): __PublicMethodMetaInfo<'POST', {}, CreateDisputeEvidenceDocumentRequest$1, CreateDisputeEvidenceDocumentRequest, CreateDisputeEvidenceDocumentResponse$1, CreateDisputeEvidenceDocumentResponse>;
+declare function generateDisputeEvidenceDocumentUploadUrl(): __PublicMethodMetaInfo<'POST', {
+    disputeEvidenceDocumentId: string;
+}, GenerateDisputeEvidenceDocumentUploadUrlRequest$1, GenerateDisputeEvidenceDocumentUploadUrlRequest, GenerateDisputeEvidenceDocumentUploadUrlResponse$1, GenerateDisputeEvidenceDocumentUploadUrlResponse>;
+declare function attachDisputeEvidenceDocumentFile(): __PublicMethodMetaInfo<'POST', {
+    disputeEvidenceDocumentId: string;
+}, AttachDisputeEvidenceDocumentFileRequest$1, AttachDisputeEvidenceDocumentFileRequest, AttachDisputeEvidenceDocumentFileResponse$1, AttachDisputeEvidenceDocumentFileResponse>;
+declare function getDisputeEvidenceDocument(): __PublicMethodMetaInfo<'GET', {
+    disputeEvidenceDocumentId: string;
+}, GetDisputeEvidenceDocumentRequest$1, GetDisputeEvidenceDocumentRequest, GetDisputeEvidenceDocumentResponse$1, GetDisputeEvidenceDocumentResponse>;
+declare function generateDisputeEvidenceDocumentDownloadUrl(): __PublicMethodMetaInfo<'POST', {
+    disputeEvidenceDocumentId: string;
+}, GenerateDisputeEvidenceDocumentDownloadUrlRequest$1, GenerateDisputeEvidenceDocumentDownloadUrlRequest, GenerateDisputeEvidenceDocumentDownloadUrlResponse$1, GenerateDisputeEvidenceDocumentDownloadUrlResponse>;
+declare function markDisputeEvidenceDocumentSubmitted(): __PublicMethodMetaInfo<'POST', {
+    disputeEvidenceDocumentId: string;
+}, MarkDisputeEvidenceDocumentSubmittedRequest$1, MarkDisputeEvidenceDocumentSubmittedRequest, MarkDisputeEvidenceDocumentSubmittedResponse$1, MarkDisputeEvidenceDocumentSubmittedResponse>;
+declare function deleteDisputeEvidenceDocument(): __PublicMethodMetaInfo<'DELETE', {
+    disputeEvidenceDocumentId: string;
+}, DeleteDisputeEvidenceDocumentRequest$1, DeleteDisputeEvidenceDocumentRequest, DeleteDisputeEvidenceDocumentResponse$1, DeleteDisputeEvidenceDocumentResponse>;
+declare function queryDisputeEvidenceDocuments(): __PublicMethodMetaInfo<'GET', {}, QueryDisputeEvidenceDocumentsRequest$1, QueryDisputeEvidenceDocumentsRequest, QueryDisputeEvidenceDocumentsResponse$1, QueryDisputeEvidenceDocumentsResponse>;
+declare function bulkUpdateDisputeEvidenceDocumentTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateDisputeEvidenceDocumentTagsRequest$1, BulkUpdateDisputeEvidenceDocumentTagsRequest, BulkUpdateDisputeEvidenceDocumentTagsResponse$1, BulkUpdateDisputeEvidenceDocumentTagsResponse>;
+declare function bulkUpdateDisputeEvidenceDocumentTagsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest$1, BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest, BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse$1, BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse>;
+
+export { type __PublicMethodMetaInfo, attachDisputeEvidenceDocumentFile, bulkUpdateDisputeEvidenceDocumentTags, bulkUpdateDisputeEvidenceDocumentTagsByFilter, createDisputeEvidenceDocument, deleteDisputeEvidenceDocument, generateDisputeEvidenceDocumentDownloadUrl, generateDisputeEvidenceDocumentUploadUrl, getDisputeEvidenceDocument, markDisputeEvidenceDocumentSubmitted, queryDisputeEvidenceDocuments };