@wix/auto_sdk_payments_disputes 1.0.31 → 1.0.32

package/build/internal/cjs/index.typings.d.ts

@@ -20,9 +20,15 @@ interface Dispute {
      * @immutable
      */
     providerDisputeId?: string;
-    /** Dispute stage */
+    /**
+     * Dispute stage
+     * @readonly
+     */
     stage?: DisputeStageWithLiterals;
-    /** Dispute reason */
+    /**
+     * Dispute reason
+     * @readonly
+     */
     reason?: DisputeReasonWithLiterals;
     /**
      * Dispute currency. Should be the same as the charge currency.
@@ -36,33 +42,62 @@ interface Dispute {
      * @decimalValue options { gt:0, maxScale:8 }
      */
     amount?: string | null;
-    /** Dispute status based on provider dispute status */
+    /**
+     * Dispute status based on provider dispute status
+     * @readonly
+     */
     status?: DisputeStatusWithLiterals;
     /** True if the merchant can do the refund with the opened dispute, false otherwise */
     chargeRefundable?: boolean | null;
-    /** Seller protection */
+    /**
+     * Seller protection helps protect sellers from financial loss on eligible transactions due to unauthorized payments or claims that items were not received
+     * @readonly
+     */
     sellerProtection?: SellerProtectionWithLiterals;
     /**
      * Dispute Channel
      * Internal - this dispute is created on provider side
      * External - this dispute is created on bank side
+     * @readonly
      */
     channel?: DisputeChannelWithLiterals;
-    /** The latest date and time until which the dispute can remain in its current status */
+    /**
+     * The latest date and time until which the dispute can remain in its current status
+     * @readonly
+     */
     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;
-    /** True if dispute is defendable */
+    /**
+     * True if dispute is defendable
+     * @readonly
+     */
     defendable?: boolean | null;
-    /** True if it is an auto dispute */
+    /**
+     * True if it is an auto dispute
+     * @readonly
+     */
     autoDefended?: boolean | null;
+    /**
+     * The dispute defense date
+     * @readonly
+     */
+    defenseDate?: Date | null;
+    /**
+     * The dispute acceptance date
+     * @readonly
+     */
+    acceptanceDate?: Date | null;
+    /**
+     * The actions that can be perform with the dispute
+     * @readonly
+     * @maxSize 20
+     */
+    actions?: DisputeAction[];
     /**
      * The dispute created date
      * @readonly
@@ -124,7 +159,7 @@ declare enum DisputeStatus {
     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) */
+    /** Dispute is under review by PSP or Bank */
     UNDER_REVIEW = "UNDER_REVIEW",
     /** Waiting for some buyer action */
     WAITING_BUYER = "WAITING_BUYER",
@@ -159,6 +194,22 @@ declare enum DisputeChannel {
 }
 /** @enumType */
 type DisputeChannelWithLiterals = DisputeChannel | 'UNKNOWN_DISPUTE_CHANNEL' | 'INTERNAL' | 'EXTERNAL';
+interface DisputeAction {
+    /** Dispute Action type */
+    type?: DisputeActionTypeWithLiterals;
+    /** The latest date and time until which the action can be performed */
+    dueDate?: Date | null;
+}
+declare enum DisputeActionType {
+    /** Unknown dispute status */
+    UNKNOWN_DISPUTE_ACTION = "UNKNOWN_DISPUTE_ACTION",
+    /** Accept dispute */
+    ACCEPT = "ACCEPT",
+    /** Defend evidence */
+    DEFEND = "DEFEND"
+}
+/** @enumType */
+type DisputeActionTypeWithLiterals = DisputeActionType | 'UNKNOWN_DISPUTE_ACTION' | 'ACCEPT' | 'DEFEND';
 interface ExtendedFields {
     /**
      * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
@@ -282,44 +333,25 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface GetDisputeActionsRequest {
+interface AcceptDisputeRequest {
     /**
      * Dispute ID
      * @format GUID
      */
     disputeId: string;
 }
-interface GetDisputeActionsResponse {
-    /**
-     * Dispute actions
-     * @maxSize 20
-     */
-    actions?: DisputeAction[];
-}
-interface DisputeAction {
-    /** Dispute Action type */
-    type?: DisputeActionTypeWithLiterals;
-    /** The latest date and time until which the action can be performed */
-    dueDate?: Date | null;
-}
-declare enum DisputeActionType {
-    /** Unknown dispute status */
-    UNKNOWN_DISPUTE_ACTION = "UNKNOWN_DISPUTE_ACTION",
-    /** Accept dispute */
-    ACCEPT = "ACCEPT",
-    /** Submit evidence */
-    SUBMIT_EVIDENCE = "SUBMIT_EVIDENCE"
+interface AcceptDisputeResponse {
+    /** Dispute */
+    dispute?: Dispute;
 }
-/** @enumType */
-type DisputeActionTypeWithLiterals = DisputeActionType | 'UNKNOWN_DISPUTE_ACTION' | 'ACCEPT' | 'SUBMIT_EVIDENCE';
-interface AcceptDisputeRequest {
+interface DefendDisputeRequest {
     /**
      * Dispute ID
      * @format GUID
      */
     disputeId: string;
 }
-interface AcceptDisputeResponse {
+interface DefendDisputeResponse {
     /** Dispute */
     dispute?: Dispute;
 }
@@ -359,6 +391,7 @@ interface CreateDisputeManuallyRequest {
     reason?: DisputeReasonWithLiterals;
     /** Dispute status based on provider dispute status */
     status?: DisputeStatusWithLiterals;
+    /** The latest date and time until which the dispute can remain in its current status */
     dueDate?: Date | null;
     /**
      * Dispute currency. Should be the same as the charge currency.
@@ -669,7 +702,7 @@ type BulkUpdateDisputeTagsByFilterApplicationErrors = {
  * @returns The requested Dispute.
  * @fqn wix.payments.disputes.v1.DisputeService.GetDispute
  */
-declare function getDispute(disputeId: string): Promise<NonNullablePaths<Dispute, `_id` | `chargeId` | `providerDisputeId` | `stage` | `reason` | `status` | `sellerProtection` | `channel` | `tags.tags.tagIds`, 4>>;
+declare function getDispute(disputeId: string): Promise<NonNullablePaths<Dispute, `_id` | `chargeId` | `providerDisputeId` | `stage` | `reason` | `status` | `sellerProtection` | `channel` | `actions` | `actions.${number}.type` | `tags.tags.tagIds`, 4>>;
 /**
  * Retrieves a list of Disputes
  * @internal
@@ -756,27 +789,27 @@ interface DisputesQueryBuilder {
     find: () => Promise<DisputesQueryResult>;
 }
 /**
- * Get Dispute Actions
+ * Accept Dispute
  * @param disputeId - Dispute ID
  * @internal
  * @documentationMaturity preview
  * @requiredField disputeId
- * @permissionId PAYMENTS.DISPUTE_GET_ACTIONS
- * @fqn wix.payments.disputes.v1.DisputeService.GetDisputeActions
+ * @permissionId PAYMENTS.DISPUTE_ACCEPT
+ * @fqn wix.payments.disputes.v1.DisputeService.AcceptDispute
  */
-declare function getDisputeActions(disputeId: string): Promise<NonNullablePaths<GetDisputeActionsResponse, `actions` | `actions.${number}.type`, 4>>;
+declare function acceptDispute(disputeId: string): Promise<NonNullablePaths<AcceptDisputeResponse, `dispute._id` | `dispute.chargeId` | `dispute.providerDisputeId` | `dispute.stage` | `dispute.reason` | `dispute.status` | `dispute.sellerProtection` | `dispute.channel` | `dispute.actions` | `dispute.actions.${number}.type` | `dispute.tags.tags.tagIds`, 5>>;
 /**
- * Dispute Accept
+ * Defend Dispute
  * @param disputeId - Dispute ID
  * @internal
  * @documentationMaturity preview
  * @requiredField disputeId
- * @permissionId PAYMENTS.DISPUTE_ACCEPT
- * @fqn wix.payments.disputes.v1.DisputeService.AcceptDispute
+ * @permissionId PAYMENTS.DISPUTE_DEFEND
+ * @fqn wix.payments.disputes.v1.DisputeService.DefendDispute
  */
-declare function acceptDispute(disputeId: string): Promise<NonNullablePaths<AcceptDisputeResponse, `dispute._id` | `dispute.chargeId` | `dispute.providerDisputeId` | `dispute.stage` | `dispute.reason` | `dispute.status` | `dispute.sellerProtection` | `dispute.channel` | `dispute.tags.tags.tagIds`, 5>>;
+declare function defendDispute(disputeId: string): Promise<NonNullablePaths<DefendDisputeResponse, `dispute._id` | `dispute.chargeId` | `dispute.providerDisputeId` | `dispute.stage` | `dispute.reason` | `dispute.status` | `dispute.sellerProtection` | `dispute.channel` | `dispute.actions` | `dispute.actions.${number}.type` | `dispute.tags.tags.tagIds`, 5>>;
 /**
- * Dispute Submit Evidence
+ * Dispute Submit Evidence // TODO will be removed in next PR (after removing usage in transaction-service)
  * @param disputeId - Dispute ID
  * @internal
  * @documentationMaturity preview
@@ -784,7 +817,7 @@ declare function acceptDispute(disputeId: string): Promise<NonNullablePaths<Acce
  * @permissionId PAYMENTS.DISPUTE_SUBMIT_EVIDENCE
  * @fqn wix.payments.disputes.v1.DisputeService.SubmitDisputeEvidence
  */
-declare function submitDisputeEvidence(disputeId: string): Promise<NonNullablePaths<SubmitDisputeEvidenceResponse, `dispute._id` | `dispute.chargeId` | `dispute.providerDisputeId` | `dispute.stage` | `dispute.reason` | `dispute.status` | `dispute.sellerProtection` | `dispute.channel` | `dispute.tags.tags.tagIds`, 5>>;
+declare function submitDisputeEvidence(disputeId: string): Promise<NonNullablePaths<SubmitDisputeEvidenceResponse, `dispute._id` | `dispute.chargeId` | `dispute.providerDisputeId` | `dispute.stage` | `dispute.reason` | `dispute.status` | `dispute.sellerProtection` | `dispute.channel` | `dispute.actions` | `dispute.actions.${number}.type` | `dispute.tags.tags.tagIds`, 5>>;
 /**
  * Synchronously update tags on multiple Disputes, by list of Disputes ids
  * A tag that appears both in the list of assign and unassign tags, will be assigned
@@ -825,4 +858,4 @@ interface BulkUpdateDisputeTagsByFilterOptions {
     unassignTags?: Tags;
 }
 
-export { type AcceptDisputeRequest, type AcceptDisputeResponse, type ActionEvent, type ApplicationError, type BulkActionMetadata, type BulkUpdateDisputeTagsApplicationErrors, type BulkUpdateDisputeTagsByFilterApplicationErrors, type BulkUpdateDisputeTagsByFilterOptions, type BulkUpdateDisputeTagsByFilterRequest, type BulkUpdateDisputeTagsByFilterResponse, type BulkUpdateDisputeTagsOptions, type BulkUpdateDisputeTagsRequest, type BulkUpdateDisputeTagsResponse, type BulkUpdateDisputeTagsResult, type ChangeDisputeStatusManuallyRequest, type ChangeDisputeStatusManuallyResponse, type CreateDisputeManuallyRequest, type CreateDisputeManuallyResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type Dispute, type DisputeAction, DisputeActionType, type DisputeActionTypeWithLiterals, DisputeChannel, type DisputeChannelWithLiterals, DisputeReason, type DisputeReasonWithLiterals, DisputeStage, type DisputeStageWithLiterals, DisputeStatus, type DisputeStatusWithLiterals, type DisputesQueryBuilder, type DisputesQueryResult, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetDisputeActionsRequest, type GetDisputeActionsResponse, type GetDisputeRequest, type GetDisputeResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type PublicTags, type QueryDisputesRequest, type QueryDisputesResponse, type RestoreInfo, SellerProtection, type SellerProtectionWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SubmitDisputeEvidenceRequest, type SubmitDisputeEvidenceResponse, type TagList, type Tags, type TagsTagList, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, acceptDispute, bulkUpdateDisputeTags, bulkUpdateDisputeTagsByFilter, getDispute, getDisputeActions, queryDisputes, submitDisputeEvidence };
+export { type AcceptDisputeRequest, type AcceptDisputeResponse, type ActionEvent, type ApplicationError, type BulkActionMetadata, type BulkUpdateDisputeTagsApplicationErrors, type BulkUpdateDisputeTagsByFilterApplicationErrors, type BulkUpdateDisputeTagsByFilterOptions, type BulkUpdateDisputeTagsByFilterRequest, type BulkUpdateDisputeTagsByFilterResponse, type BulkUpdateDisputeTagsOptions, type BulkUpdateDisputeTagsRequest, type BulkUpdateDisputeTagsResponse, type BulkUpdateDisputeTagsResult, type ChangeDisputeStatusManuallyRequest, type ChangeDisputeStatusManuallyResponse, type CreateDisputeManuallyRequest, type CreateDisputeManuallyResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DefendDisputeRequest, type DefendDisputeResponse, type Dispute, type DisputeAction, DisputeActionType, type DisputeActionTypeWithLiterals, DisputeChannel, type DisputeChannelWithLiterals, DisputeReason, type DisputeReasonWithLiterals, DisputeStage, type DisputeStageWithLiterals, DisputeStatus, type DisputeStatusWithLiterals, type DisputesQueryBuilder, type DisputesQueryResult, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetDisputeRequest, type GetDisputeResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type PublicTags, type QueryDisputesRequest, type QueryDisputesResponse, type RestoreInfo, SellerProtection, type SellerProtectionWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SubmitDisputeEvidenceRequest, type SubmitDisputeEvidenceResponse, type TagList, type Tags, type TagsTagList, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, acceptDispute, bulkUpdateDisputeTags, bulkUpdateDisputeTagsByFilter, defendDispute, getDispute, queryDisputes, submitDisputeEvidence };

package/build/internal/cjs/index.typings.js

@@ -31,8 +31,8 @@ __export(index_typings_exports, {
   acceptDispute: () => acceptDispute2,
   bulkUpdateDisputeTags: () => bulkUpdateDisputeTags2,
   bulkUpdateDisputeTagsByFilter: () => bulkUpdateDisputeTagsByFilter2,
+  defendDispute: () => defendDispute2,
   getDispute: () => getDispute2,
-  getDisputeActions: () => getDisputeActions2,
   queryDisputes: () => queryDisputes2,
   submitDisputeEvidence: () => submitDisputeEvidence2
 });
@@ -71,8 +71,11 @@ function getDispute(payload) {
           transformFn: import_timestamp.transformRESTTimestampToSDKTimestamp,
           paths: [
             { path: "dispute.dueDate" },
+            { path: "dispute.defenseDate" },
+            { path: "dispute.acceptanceDate" },
             { path: "dispute.createdDate" },
-            { path: "dispute.updatedDate" }
+            { path: "dispute.updatedDate" },
+            { path: "dispute.actions.dueDate" }
           ]
         }
       ])
@@ -99,8 +102,11 @@ function queryDisputes(payload) {
           transformFn: import_timestamp.transformRESTTimestampToSDKTimestamp,
           paths: [
             { path: "disputes.dueDate" },
+            { path: "disputes.defenseDate" },
+            { path: "disputes.acceptanceDate" },
             { path: "disputes.createdDate" },
-            { path: "disputes.updatedDate" }
+            { path: "disputes.updatedDate" },
+            { path: "disputes.actions.dueDate" }
           ]
         }
       ]),
@@ -120,39 +126,46 @@ function queryDisputes(payload) {
   }
   return __queryDisputes;
 }
-function getDisputeActions(payload) {
-  function __getDisputeActions({ host }) {
+function acceptDispute(payload) {
+  function __acceptDispute({ host }) {
     const metadata = {
       entityFqdn: "wix.payments.disputes.v1.dispute",
-      method: "GET",
-      methodFqn: "wix.payments.disputes.v1.DisputeService.GetDisputeActions",
+      method: "POST",
+      methodFqn: "wix.payments.disputes.v1.DisputeService.AcceptDispute",
       packageName: PACKAGE_NAME,
       url: resolveWixPaymentsDisputesV1DisputeServiceUrl({
-        protoPath: "/v1/disputes/{disputeId}/actions",
+        protoPath: "/v1/disputes/{disputeId}/accept",
         data: payload,
         host
       }),
-      params: (0, import_rest_modules.toURLSearchParams)(payload),
+      data: payload,
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_timestamp.transformRESTTimestampToSDKTimestamp,
-          paths: [{ path: "actions.dueDate" }]
+          paths: [
+            { path: "dispute.dueDate" },
+            { path: "dispute.defenseDate" },
+            { path: "dispute.acceptanceDate" },
+            { path: "dispute.createdDate" },
+            { path: "dispute.updatedDate" },
+            { path: "dispute.actions.dueDate" }
+          ]
         }
       ])
     };
     return metadata;
   }
-  return __getDisputeActions;
+  return __acceptDispute;
 }
-function acceptDispute(payload) {
-  function __acceptDispute({ host }) {
+function defendDispute(payload) {
+  function __defendDispute({ host }) {
     const metadata = {
       entityFqdn: "wix.payments.disputes.v1.dispute",
       method: "POST",
-      methodFqn: "wix.payments.disputes.v1.DisputeService.AcceptDispute",
+      methodFqn: "wix.payments.disputes.v1.DisputeService.DefendDispute",
       packageName: PACKAGE_NAME,
       url: resolveWixPaymentsDisputesV1DisputeServiceUrl({
-        protoPath: "/v1/disputes/{disputeId}/accept",
+        protoPath: "/v1/disputes/{disputeId}/defend",
         data: payload,
         host
       }),
@@ -162,15 +175,18 @@ function acceptDispute(payload) {
           transformFn: import_timestamp.transformRESTTimestampToSDKTimestamp,
           paths: [
             { path: "dispute.dueDate" },
+            { path: "dispute.defenseDate" },
+            { path: "dispute.acceptanceDate" },
             { path: "dispute.createdDate" },
-            { path: "dispute.updatedDate" }
+            { path: "dispute.updatedDate" },
+            { path: "dispute.actions.dueDate" }
           ]
         }
       ])
     };
     return metadata;
   }
-  return __acceptDispute;
+  return __defendDispute;
 }
 function submitDisputeEvidence(payload) {
   function __submitDisputeEvidence({ host }) {
@@ -190,8 +206,11 @@ function submitDisputeEvidence(payload) {
           transformFn: import_timestamp.transformRESTTimestampToSDKTimestamp,
           paths: [
             { path: "dispute.dueDate" },
+            { path: "dispute.defenseDate" },
+            { path: "dispute.acceptanceDate" },
             { path: "dispute.createdDate" },
-            { path: "dispute.updatedDate" }
+            { path: "dispute.updatedDate" },
+            { path: "dispute.actions.dueDate" }
           ]
         }
       ])
@@ -283,17 +302,17 @@ var DisputeChannel = /* @__PURE__ */ ((DisputeChannel2) => {
   DisputeChannel2["EXTERNAL"] = "EXTERNAL";
   return DisputeChannel2;
 })(DisputeChannel || {});
-var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
-  SortOrder2["ASC"] = "ASC";
-  SortOrder2["DESC"] = "DESC";
-  return SortOrder2;
-})(SortOrder || {});
 var DisputeActionType = /* @__PURE__ */ ((DisputeActionType2) => {
   DisputeActionType2["UNKNOWN_DISPUTE_ACTION"] = "UNKNOWN_DISPUTE_ACTION";
   DisputeActionType2["ACCEPT"] = "ACCEPT";
-  DisputeActionType2["SUBMIT_EVIDENCE"] = "SUBMIT_EVIDENCE";
+  DisputeActionType2["DEFEND"] = "DEFEND";
   return DisputeActionType2;
 })(DisputeActionType || {});
+var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
+  SortOrder2["ASC"] = "ASC";
+  SortOrder2["DESC"] = "DESC";
+  return SortOrder2;
+})(SortOrder || {});
 var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
   WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
   WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
@@ -370,12 +389,12 @@ function queryDisputes2() {
     transformationPaths: {}
   });
 }
-async function getDisputeActions2(disputeId) {
+async function acceptDispute2(disputeId) {
   const { httpClient, sideEffects } = arguments[1];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     disputeId
   });
-  const reqOpts = getDisputeActions(payload);
+  const reqOpts = acceptDispute(payload);
   sideEffects?.onSiteCall?.();
   try {
     const result = await httpClient.request(reqOpts);
@@ -395,12 +414,12 @@ async function getDisputeActions2(disputeId) {
     throw transformedError;
   }
 }
-async function acceptDispute2(disputeId) {
+async function defendDispute2(disputeId) {
   const { httpClient, sideEffects } = arguments[1];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     disputeId
   });
-  const reqOpts = acceptDispute(payload);
+  const reqOpts = defendDispute(payload);
   sideEffects?.onSiteCall?.();
   try {
     const result = await httpClient.request(reqOpts);
@@ -522,8 +541,8 @@ async function bulkUpdateDisputeTagsByFilter2(filter, options) {
   acceptDispute,
   bulkUpdateDisputeTags,
   bulkUpdateDisputeTagsByFilter,
+  defendDispute,
   getDispute,
-  getDisputeActions,
   queryDisputes,
   submitDisputeEvidence
 });