@wix/auto_sdk_payments_disputes 1.0.10 → 1.0.12

package/build/cjs/src/payments-disputes-v1-dispute-disputes.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payments-disputes-v1-dispute-disputes.public.js","sourceRoot":"","sources":["../../../src/payments-disputes-v1-dispute-disputes.public.ts"],"names":[],"mappings":";;;AACA,6HAiB8D;AAEjD,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,gBAAgB;AAChB,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,IAAA,+DAAmB,EACjB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,gCAOC;AAWD,gBAAgB;AAChB,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,GAAG,EAAE,CACV,IAAA,kEAAsB;IACpB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,sCAMC;AASD,gBAAgB;AAChB,SAAgB,iBAAiB,CAC/B,UAAsB;IAEtB,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,IAAA,sEAA0B,EACxB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,8CASC;AAUD,gBAAgB;AAChB,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,IAAA,kEAAsB,EACpB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,sCAOC;AAUD,gBAAgB;AAChB,SAAgB,qBAAqB,CACnC,UAAsB;IAEtB,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,IAAA,0EAA8B,EAC5B,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,sDASC;AAUD,gBAAgB;AAChB,SAAgB,qBAAqB,CACnC,UAAsB;IAEtB,OAAO,CAAC,GAAa,EAAE,OAAsC,EAAE,EAAE,CAC/D,IAAA,0EAA8B,EAC5B,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAVD,sDAUC;AAcD,gBAAgB;AAChB,SAAgB,6BAA6B,CAC3C,UAAsB;IAEtB,OAAO,CACL,MAA2B,EAC3B,OAA8C,EAC9C,EAAE,CACF,IAAA,kFAAsC,EACpC,MAAM,EACN,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,sEAaC;AAeD,2HA0D8D;AAlC5D,uJAAA,iBAAiB,OAAA;AACjB,oJAAA,cAAc,OAAA;AACd,mJAAA,aAAa,OAAA;AACb,kJAAA,YAAY,OAAA;AACZ,mJAAA,aAAa,OAAA;AAqBb,sJAAA,gBAAgB,OAAA;AAChB,+IAAA,SAAS,OAAA;AAOT,yJAAA,mBAAmB,OAAA"}

package/build/cjs/src/payments-disputes-v1-dispute-disputes.types.d.ts

@@ -0,0 +1,631 @@
+/** Dispute. A dispute occurs when an account owner contacts their PSP or bank to contest a payment to you for a number of possible reasons. */
+export interface Dispute {
+    /**
+     * Dispute ID
+     * @format GUID
+     * @immutable
+     */
+    id?: string;
+    /**
+     * Charge ID
+     * @format GUID
+     * @immutable
+     */
+    chargeId?: string;
+    /**
+     * Provider Dispute ID
+     * @format GUID
+     * @immutable
+     */
+    providerDisputeId?: string;
+    /** Dispute stage */
+    stage?: DisputeStage;
+    /** Dispute reason */
+    reason?: DisputeReason;
+    /**
+     * Dispute currency. Should be the same as the charge currency.
+     * @immutable
+     * @format CURRENCY
+     */
+    currencyCode?: string | null;
+    /**
+     * Dispute Amount in currency's main units (such as dollars or euros). For example, `"12.95"`.
+     * @immutable
+     * @decimalValue options { gt:0, maxScale:8 }
+     */
+    amount?: string | null;
+    /** Dispute status based on provider dispute status */
+    status?: DisputeStatus;
+    /** True if the merchant can do the refund with the opened dispute, false otherwise */
+    chargeRefundable?: boolean | null;
+    /** Seller protection */
+    sellerProtection?: SellerProtection;
+    /**
+     * Dispute Channel
+     * Internal - this dispute is created on provider side
+     * External - this dispute is created on bank side
+     */
+    channel?: DisputeChannel;
+    /** The latest date and time until which the dispute can remain in its current status */
+    dueDate?: Date | null;
+    /**
+     * Network reason code
+     * https://docs.stripe.com/disputes/reason-codes-defense-requirements?card-network=visa
+     * https://docs.stripe.com/disputes/reason-codes-defense-requirements?card-network=mastercard
+     * https://docs.stripe.com/disputes/reason-codes-defense-requirements?card-network=amex
+     * @minLength 1
+     * @maxLength 64
+     */
+    networkReasonCode?: string | null;
+    /**
+     * The dispute created date
+     * @readonly
+     * @immutable
+     */
+    createdDate?: Date | null;
+    /**
+     * The dispute updated date
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Revision number, which increments by 1 each time the Dispute is updated.
+     * @readonly
+     */
+    revision?: string | null;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: PublicTags;
+}
+export declare enum DisputeStage {
+    UNKNOWN_DISPUTE_STAGE = "UNKNOWN_DISPUTE_STAGE",
+    /** Notification of Fraud, Pre-chargeback, Early Fraud Warning */
+    NOTIFICATION_OF_FRAUD = "NOTIFICATION_OF_FRAUD",
+    /** Request for Information / Inquiry */
+    RFI = "RFI",
+    /** Chargeback */
+    CHARGEBACK = "CHARGEBACK"
+}
+export declare enum DisputeReason {
+    /** Unknown reason */
+    UNKNOWN_DISPUTE_REASON = "UNKNOWN_DISPUTE_REASON",
+    /** Fraud card */
+    FRAUD_CARD_PRESENT = "FRAUD_CARD_PRESENT",
+    /** Card absent */
+    FRAUD_CARD_ABSENT = "FRAUD_CARD_ABSENT",
+    /** DUPLICATE */
+    DUPLICATE_PROCESSING = "DUPLICATE_PROCESSING",
+    /** Service not provided */
+    SERVICES_NOT_PROVIDED = "SERVICES_NOT_PROVIDED",
+    /** Canceled Recurring */
+    CANCELED_RECURRING = "CANCELED_RECURRING",
+    /** Item not as describe */
+    NOT_AS_DESCRIBED = "NOT_AS_DESCRIBED",
+    /** Counterfeit */
+    COUNTERFEIT = "COUNTERFEIT",
+    /** Misrepresentation */
+    MISREPRESENTATION = "MISREPRESENTATION",
+    /** Canceled */
+    CANCELED = "CANCELED",
+    /** Other reason */
+    OTHER = "OTHER"
+}
+export declare enum DisputeStatus {
+    /** Unknown status */
+    UNKNOWN_DISPUTE_STATUS = "UNKNOWN_DISPUTE_STATUS",
+    /** Waiting for some merchant action */
+    WAITING_MERCHANT = "WAITING_MERCHANT",
+    /** Dispute is under review by PSP (internal channel) or Bank (external channel) */
+    UNDER_REVIEW = "UNDER_REVIEW",
+    /** Waiting for some buyer action */
+    WAITING_BUYER = "WAITING_BUYER",
+    /** Dispute won */
+    WON = "WON",
+    /** Dispute lost */
+    LOST = "LOST"
+}
+export declare enum SellerProtection {
+    UNKNOWN_SELLER_PROTECTION = "UNKNOWN_SELLER_PROTECTION",
+    /** Not Eligible */
+    NOT_ELIGIBLE = "NOT_ELIGIBLE",
+    /** Eligible */
+    ELIGIBLE = "ELIGIBLE",
+    /** Extended seller protection */
+    EXTENDED = "EXTENDED"
+}
+export declare enum DisputeChannel {
+    UNKNOWN_DISPUTE_CHANNEL = "UNKNOWN_DISPUTE_CHANNEL",
+    /** Internal, the dispute is reviewed by PSP */
+    INTERNAL = "INTERNAL",
+    /** External, the dispute is reviewed by bank (or other financial institution) */
+    EXTERNAL = "EXTERNAL"
+}
+export 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>>;
+}
+export interface PublicTags {
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    tags?: TagList;
+}
+export interface TagList {
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+export interface GetDisputeRequest {
+    /**
+     * ID of the Dispute to retrieve.
+     * @format GUID
+     */
+    disputeId: string;
+}
+export interface GetDisputeResponse {
+    /** The requested Dispute. */
+    dispute?: Dispute;
+}
+export interface QueryDisputesRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+export 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 */
+export 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;
+}
+export interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export 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;
+}
+export interface QueryDisputesResponse {
+    /** List of Disputes. */
+    disputes?: Dispute[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export 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;
+}
+export 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;
+}
+export interface GetDisputeActionsRequest {
+    /**
+     * Dispute ID
+     * @format GUID
+     */
+    disputeId: string;
+}
+export interface GetDisputeActionsResponse {
+    /**
+     * Dispute actions
+     * @maxSize 20
+     */
+    actions?: DisputeAction[];
+}
+export interface DisputeAction {
+    /** Dispute Action type */
+    type?: DisputeActionType;
+    /** The latest date and time until which the action can be performed */
+    dueDate?: Date | null;
+}
+export declare enum DisputeActionType {
+    /** Unknown dispute status */
+    UNKNOWN_DISPUTE_ACTION = "UNKNOWN_DISPUTE_ACTION",
+    /** Accept dispute */
+    ACCEPT = "ACCEPT",
+    /** Submit evidence */
+    SUBMIT_EVIDENCE = "SUBMIT_EVIDENCE"
+}
+export interface AcceptDisputeRequest {
+    /**
+     * Dispute ID
+     * @format GUID
+     */
+    disputeId: string;
+}
+export interface AcceptDisputeResponse {
+    /** Dispute */
+    dispute?: Dispute;
+}
+export interface SubmitDisputeEvidenceRequest {
+    /**
+     * Dispute ID
+     * @format GUID
+     */
+    disputeId: string;
+}
+export interface SubmitDisputeEvidenceResponse {
+    /** Dispute */
+    dispute?: Dispute;
+}
+export interface CreateDisputeManuallyRequest {
+    /**
+     * Dispute Id
+     * @format GUID
+     */
+    disputeId?: string;
+    /**
+     * Charge Id
+     * @format GUID
+     */
+    chargeId?: string;
+    /** Open date */
+    openDate?: Date | null;
+    /**
+     * Provider Dispute Id
+     * @minLength 1
+     * @maxLength 100
+     */
+    providerDisputeId?: string;
+    /** Dispute stage */
+    stage?: DisputeStage;
+    /** Dispute reason */
+    reason?: DisputeReason;
+    /** Dispute status based on provider dispute status */
+    status?: DisputeStatus;
+    dueDate?: Date | null;
+    /**
+     * Dispute currency. Should be the same as the charge currency.
+     * @immutable
+     * @format CURRENCY
+     */
+    currencyCode?: string | null;
+    /**
+     * Dispute Amount in currency's main units (such as dollars or euros). For example, `"12.95"`.
+     * @immutable
+     * @decimalValue options { gt:0, maxScale:8 }
+     */
+    amount?: string | null;
+    /**
+     * Network reason code
+     * @minLength 1
+     * @maxLength 64
+     */
+    networkReasonCode?: string | null;
+    /** External or Internal */
+    external?: boolean | null;
+    /**
+     * Seller protection
+     * @minLength 1
+     * @maxLength 64
+     */
+    sellerProtection?: string | null;
+    /** Is charge refundable */
+    chargeRefundable?: boolean | null;
+}
+export interface CreateDisputeManuallyResponse {
+}
+export interface ChangeDisputeStatusManuallyRequest {
+    /**
+     * Dispute ID
+     * @format GUID
+     */
+    disputeId?: string;
+    /** Changed date */
+    changedDate?: Date | null;
+    /** Dispute status based on provider dispute status */
+    status?: DisputeStatus;
+}
+export interface ChangeDisputeStatusManuallyResponse {
+}
+export interface BulkUpdateDisputeTagsRequest {
+    /**
+     * 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;
+}
+/**
+ * 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"]
+ * }
+ * }
+ * }
+ */
+export interface Tags {
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    tags?: TagsTagList;
+}
+export interface TagsTagList {
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+export interface BulkUpdateDisputeTagsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateDisputeTagsResult[];
+    /** 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).
+     * @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;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkUpdateDisputeTagsResult {
+    /** Metadata regarding the specific single update operation */
+    itemMetadata?: ItemMetadata;
+}
+export 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;
+}
+export interface BulkUpdateDisputeTagsByFilterRequest {
+    /** Filter */
+    filter: Record<string, any> | null;
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+export interface BulkUpdateDisputeTagsByFilterResponse {
+    /**
+     * Job ID
+     * @format GUID
+     */
+    jobId?: string;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * 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 defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export 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;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export 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;
+}
+export 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?: WebhookIdentityType;
+}
+/** @oneof */
+export 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;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}