@channelpayments/node-sdk 1.96.0 → 1.98.0

package/dist/cjs/models/CreateTransactionRefundDto.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Channel Payments API v1.98.0
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ *
+ * @export
+ * @interface CreateTransactionRefundDto
+ */
+export interface CreateTransactionRefundDto {
+    /**
+     * The amount to refund.
+     * @type {number}
+     * @memberof CreateTransactionRefundDto
+     */
+    refundAmount: number;
+    /**
+     * The transaction id to refund.
+     * @type {string}
+     * @memberof CreateTransactionRefundDto
+     */
+    transactionId: string;
+    /**
+     * The reason for the refund.
+     * @type {string}
+     * @memberof CreateTransactionRefundDto
+     */
+    reason: CreateTransactionRefundDtoReasonEnum;
+    /**
+     * The description for the refund if reason is OTHER.
+     * @type {string}
+     * @memberof CreateTransactionRefundDto
+     */
+    description?: string;
+}
+/**
+ * @export
+ */
+export declare const CreateTransactionRefundDtoReasonEnum: {
+    readonly CustomerDissatisfaction: "CUSTOMER_DISSATISFACTION";
+    readonly ProductReturned: "PRODUCT_RETURNED";
+    readonly ServiceCancelled: "SERVICE_CANCELLED";
+    readonly OrderCancelled: "ORDER_CANCELLED";
+    readonly Overpayment: "OVERPAYMENT";
+    readonly DuplicateCharge: "DUPLICATE_CHARGE";
+    readonly FraudulentCharge: "FRAUDULENT_CHARGE";
+    readonly ProductNotReceived: "PRODUCT_NOT_RECEIVED";
+    readonly ProductDefective: "PRODUCT_DEFECTIVE";
+    readonly IncorrectProductShipped: "INCORRECT_PRODUCT_SHIPPED";
+    readonly BillingError: "BILLING_ERROR";
+    readonly WarrantyClaim: "WARRANTY_CLAIM";
+    readonly PromotionalAdjustment: "PROMOTIONAL_ADJUSTMENT";
+    readonly ComplianceIssue: "COMPLIANCE_ISSUE";
+    readonly GoodwillGesture: "GOODWILL_GESTURE";
+    readonly SubscriptionCancellation: "SUBSCRIPTION_CANCELLATION";
+    readonly LoanRepaymentAdjustment: "LOAN_REPAYMENT_ADJUSTMENT";
+    readonly RegulatoryRequirement: "REGULATORY_REQUIREMENT";
+    readonly Other: "OTHER";
+};
+export type CreateTransactionRefundDtoReasonEnum = typeof CreateTransactionRefundDtoReasonEnum[keyof typeof CreateTransactionRefundDtoReasonEnum];
+/**
+ * Check if a given object implements the CreateTransactionRefundDto interface.
+ */
+export declare function instanceOfCreateTransactionRefundDto(value: object): boolean;
+export declare function CreateTransactionRefundDtoFromJSON(json: any): CreateTransactionRefundDto;
+export declare function CreateTransactionRefundDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateTransactionRefundDto;
+export declare function CreateTransactionRefundDtoToJSON(value?: CreateTransactionRefundDto | null): any;

package/dist/cjs/models/CreateTransactionRefundDto.js

@@ -0,0 +1,79 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API v1.98.0
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateTransactionRefundDtoToJSON = exports.CreateTransactionRefundDtoFromJSONTyped = exports.CreateTransactionRefundDtoFromJSON = exports.instanceOfCreateTransactionRefundDto = exports.CreateTransactionRefundDtoReasonEnum = void 0;
+const runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.CreateTransactionRefundDtoReasonEnum = {
+    CustomerDissatisfaction: 'CUSTOMER_DISSATISFACTION',
+    ProductReturned: 'PRODUCT_RETURNED',
+    ServiceCancelled: 'SERVICE_CANCELLED',
+    OrderCancelled: 'ORDER_CANCELLED',
+    Overpayment: 'OVERPAYMENT',
+    DuplicateCharge: 'DUPLICATE_CHARGE',
+    FraudulentCharge: 'FRAUDULENT_CHARGE',
+    ProductNotReceived: 'PRODUCT_NOT_RECEIVED',
+    ProductDefective: 'PRODUCT_DEFECTIVE',
+    IncorrectProductShipped: 'INCORRECT_PRODUCT_SHIPPED',
+    BillingError: 'BILLING_ERROR',
+    WarrantyClaim: 'WARRANTY_CLAIM',
+    PromotionalAdjustment: 'PROMOTIONAL_ADJUSTMENT',
+    ComplianceIssue: 'COMPLIANCE_ISSUE',
+    GoodwillGesture: 'GOODWILL_GESTURE',
+    SubscriptionCancellation: 'SUBSCRIPTION_CANCELLATION',
+    LoanRepaymentAdjustment: 'LOAN_REPAYMENT_ADJUSTMENT',
+    RegulatoryRequirement: 'REGULATORY_REQUIREMENT',
+    Other: 'OTHER'
+};
+/**
+ * Check if a given object implements the CreateTransactionRefundDto interface.
+ */
+function instanceOfCreateTransactionRefundDto(value) {
+    let isInstance = true;
+    isInstance = isInstance && "refundAmount" in value;
+    isInstance = isInstance && "transactionId" in value;
+    isInstance = isInstance && "reason" in value;
+    return isInstance;
+}
+exports.instanceOfCreateTransactionRefundDto = instanceOfCreateTransactionRefundDto;
+function CreateTransactionRefundDtoFromJSON(json) {
+    return CreateTransactionRefundDtoFromJSONTyped(json, false);
+}
+exports.CreateTransactionRefundDtoFromJSON = CreateTransactionRefundDtoFromJSON;
+function CreateTransactionRefundDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'refundAmount': json['refundAmount'],
+        'transactionId': json['transactionId'],
+        'reason': json['reason'],
+        'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
+    };
+    return (0, runtime_1.removeNullUndefined)(typed);
+}
+exports.CreateTransactionRefundDtoFromJSONTyped = CreateTransactionRefundDtoFromJSONTyped;
+function CreateTransactionRefundDtoToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'refundAmount': value.refundAmount,
+        'transactionId': value.transactionId,
+        'reason': value.reason,
+        'description': value.description,
+    };
+}
+exports.CreateTransactionRefundDtoToJSON = CreateTransactionRefundDtoToJSON;

package/dist/cjs/models/CreateUserDto.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/CreateUserDto.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/CreateWebhookDto.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/CreateWebhookDto.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/CreateWebhookDtoEventDomains.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/CreateWebhookDtoEventDomains.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/ErrorEntity.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/ErrorEntity.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/ErrorEntity1.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Channel Payments API v1.98.0
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ *
+ * @export
+ * @interface ErrorEntity1
+ */
+export interface ErrorEntity1 {
+    /**
+     *
+     * @type {number}
+     * @memberof ErrorEntity1
+     */
+    statusCode?: number;
+    /**
+     *
+     * @type {object}
+     * @memberof ErrorEntity1
+     */
+    message?: object;
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEntity1
+     */
+    path?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof ErrorEntity1
+     */
+    timestamp?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEntity1
+     */
+    method?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEntity1
+     */
+    requestId?: string;
+}
+/**
+ * Check if a given object implements the ErrorEntity1 interface.
+ */
+export declare function instanceOfErrorEntity1(value: object): boolean;
+export declare function ErrorEntity1FromJSON(json: any): ErrorEntity1;
+export declare function ErrorEntity1FromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEntity1;
+export declare function ErrorEntity1ToJSON(value?: ErrorEntity1 | null): any;

package/dist/cjs/models/ErrorEntity1.js

@@ -0,0 +1,56 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API v1.98.0
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorEntity1ToJSON = exports.ErrorEntity1FromJSONTyped = exports.ErrorEntity1FromJSON = exports.instanceOfErrorEntity1 = void 0;
+const runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the ErrorEntity1 interface.
+ */
+function instanceOfErrorEntity1(value) {
+    let isInstance = true;
+    return isInstance;
+}
+exports.instanceOfErrorEntity1 = instanceOfErrorEntity1;
+function ErrorEntity1FromJSON(json) {
+    return ErrorEntity1FromJSONTyped(json, false);
+}
+exports.ErrorEntity1FromJSON = ErrorEntity1FromJSON;
+function ErrorEntity1FromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'statusCode': !(0, runtime_1.exists)(json, 'statusCode') ? undefined : json['statusCode'],
+        'message': !(0, runtime_1.exists)(json, 'message') ? undefined : json['message'],
+        'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
+        'timestamp': !(0, runtime_1.exists)(json, 'timestamp') ? undefined : (new Date(json['timestamp'])),
+        'method': !(0, runtime_1.exists)(json, 'method') ? undefined : json['method'],
+        'requestId': !(0, runtime_1.exists)(json, 'requestId') ? undefined : json['requestId'],
+    };
+    return (0, runtime_1.removeNullUndefined)(typed);
+}
+exports.ErrorEntity1FromJSONTyped = ErrorEntity1FromJSONTyped;
+function ErrorEntity1ToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'statusCode': value.statusCode,
+        'message': value.message,
+        'path': value.path,
+        'timestamp': value.timestamp === undefined ? undefined : (value.timestamp.toISOString()),
+        'method': value.method,
+        'requestId': value.requestId,
+    };
+}
+exports.ErrorEntity1ToJSON = ErrorEntity1ToJSON;

package/dist/cjs/models/FeatureEntity.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/FeatureEntity.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantAccountEntity.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantAccountEntity.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantAccountEntityCFee.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantAccountEntityCFee.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantAddressEntity.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantAddressEntity.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantConnectorCredentialsEntity.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantConnectorCredentialsEntity.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantConnectorEntity.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantConnectorEntity.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantCredentialsEntity.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantCredentialsEntity.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantEntity.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantEntity.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantEntityAddress.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantEntityAddress.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantRoutingFlowEntity.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantRoutingFlowEntity.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantRoutingFlowRuleEntity.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantRoutingFlowRuleEntity.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantRoutingFlowRuleEntityConditions.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantRoutingFlowRuleEntityConditions.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantRoutingFlowRuleEntityConnectors.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MerchantRoutingFlowRuleEntityConnectors.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MetadataRuleConditionEntity.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/MetadataRuleConditionEntity.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *

package/dist/cjs/models/PaymentMethodDto.d.ts

@@ -1,5 +1,5 @@
 /**
- * Channel Payments API v1.96.0
+ * Channel Payments API v1.98.0
  *
  * NOTE: This class is auto generated. Do not edit the class manually.
  *
@@ -17,13 +17,13 @@ export interface PaymentMethodDto {
      */
     method: PaymentMethodDtoMethodEnum;
     /**
-     * The 13 - 19 digit card number. Must be unset if stored paymentMethodId is used.
+     * The 13 - 19 digit card number. Must be unset if stored paymentMethodId is used. Mus be unset if method is ACH.
      * @type {string}
      * @memberof PaymentMethodDto
      */
     number?: string;
     /**
-     * The 3 or 4 digit code often found on the back of the card. Often referred to as the CVV or CVD.
+     * The 3 or 4 digit code often found on the back of the card. Often referred to as the CVV or CVD. Must be unset if method is ACH.
      * @type {string}
      * @memberof PaymentMethodDto
      */
@@ -47,37 +47,37 @@ export interface PaymentMethodDto {
      */
     buyerId?: string;
     /**
-     * The ID of the stored payment method to use. Must be unset if number, expirationDate and securityCode are provided.
+     * The ID of the stored payment method to use. Must be unset if number, expirationDate, and securityCode are provided.
      * @type {string}
      * @memberof PaymentMethodDto
      */
     paymentMethodId?: string;
     /**
-     * Whether or not to store the payment method for future use
+     * Whether or not to store the payment method for future use.
      * @type {boolean}
      * @memberof PaymentMethodDto
      */
     store?: boolean;
     /**
-     * The routing number of the ACH transaction. Must be unset if method is not BANK.
+     * The routing number of the ACH transaction. Must be unset if method is CARD.
      * @type {string}
      * @memberof PaymentMethodDto
      */
     abaNumber?: string;
     /**
-     * The account number of the ACH transaction. Must be unset if method is not BANK.
+     * The account number of the ACH transaction. Must be unset if method is CARD.
      * @type {string}
      * @memberof PaymentMethodDto
      */
     accountNumber?: string;
     /**
-     * The account type of the ACH transaction. Must be unset if method is not BANK.
+     * The account type of the ACH transaction. Must be unset if method is CARD.
      * @type {string}
      * @memberof PaymentMethodDto
      */
     accountType?: PaymentMethodDtoAccountTypeEnum;
     /**
-     * The name of the account holder. Must be unset if method is not BANK.
+     * The name of the account holder. Must be unset if method is CARD.
      * @type {string}
      * @memberof PaymentMethodDto
      */