@channelpayments/node-sdk 1.28.2 → 1.37.0

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

@@ -0,0 +1,172 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import type { MerchantAccountEntityCFee } from './MerchantAccountEntityCFee';
+import type { MerchantConnectorEntity } from './MerchantConnectorEntity';
+/**
+ *
+ * @export
+ * @interface MerchantAccountEntity
+ */
+export interface MerchantAccountEntity {
+    /**
+     * The alphanumeric document ID
+     * @type {string}
+     * @memberof MerchantAccountEntity
+     */
+    id: string;
+    /**
+     * The alphanumeric ID of the merchant account
+     * @type {string}
+     * @memberof MerchantAccountEntity
+     */
+    merchantAccountId: string;
+    /**
+     * The associated merchant ID
+     * @type {string}
+     * @memberof MerchantAccountEntity
+     */
+    merchantId?: string;
+    /**
+     * The issued MID (Merchant ID)
+     * @type {string}
+     * @memberof MerchantAccountEntity
+     */
+    issuedMid: string;
+    /**
+     * The payment service provider
+     * @type {string}
+     * @memberof MerchantAccountEntity
+     */
+    psp: MerchantAccountEntityPspEnum;
+    /**
+     *
+     * @type {MerchantAccountEntityCFee}
+     * @memberof MerchantAccountEntity
+     */
+    cFee: MerchantAccountEntityCFee;
+    /**
+     * The date the merchant was created
+     * @type {Date}
+     * @memberof MerchantAccountEntity
+     */
+    createdAt: Date;
+    /**
+     * The date the merchant was last updated
+     * @type {Date}
+     * @memberof MerchantAccountEntity
+     */
+    updatedAt: Date;
+    /**
+     * The payment method
+     * @type {string}
+     * @memberof MerchantAccountEntity
+     */
+    method: MerchantAccountEntityMethodEnum;
+    /**
+     * The status of the merchant account
+     * @type {string}
+     * @memberof MerchantAccountEntity
+     */
+    status: MerchantAccountEntityStatusEnum;
+    /**
+     * The card schemes
+     * @type {Array<string>}
+     * @memberof MerchantAccountEntity
+     */
+    cardSchemes: Array<MerchantAccountEntityCardSchemesEnum>;
+    /**
+     * The accepted currencies
+     * @type {Array<string>}
+     * @memberof MerchantAccountEntity
+     */
+    currencies: Array<MerchantAccountEntityCurrenciesEnum>;
+    /**
+     * The accepted card types
+     * @type {Array<string>}
+     * @memberof MerchantAccountEntity
+     */
+    cardTypes: Array<MerchantAccountEntityCardTypesEnum>;
+    /**
+     * The name of the merchant account
+     * @type {string}
+     * @memberof MerchantAccountEntity
+     */
+    name?: string;
+    /**
+     *
+     * @type {Array<MerchantConnectorEntity>}
+     * @memberof MerchantAccountEntity
+     */
+    connectors?: Array<MerchantConnectorEntity>;
+}
+/**
+ * @export
+ */
+export declare const MerchantAccountEntityPspEnum: {
+    readonly Tsys: "TSYS";
+    readonly Nashville: "NASHVILLE";
+    readonly North: "NORTH";
+    readonly ChannelPayments: "CHANNEL_PAYMENTS";
+};
+export type MerchantAccountEntityPspEnum = typeof MerchantAccountEntityPspEnum[keyof typeof MerchantAccountEntityPspEnum];
+/**
+ * @export
+ */
+export declare const MerchantAccountEntityMethodEnum: {
+    readonly Card: "CARD";
+    readonly Ach: "ACH";
+};
+export type MerchantAccountEntityMethodEnum = typeof MerchantAccountEntityMethodEnum[keyof typeof MerchantAccountEntityMethodEnum];
+/**
+ * @export
+ */
+export declare const MerchantAccountEntityStatusEnum: {
+    readonly Pending: "PENDING";
+    readonly Active: "ACTIVE";
+    readonly Inactive: "INACTIVE";
+    readonly Suspended: "SUSPENDED";
+    readonly Closed: "CLOSED";
+};
+export type MerchantAccountEntityStatusEnum = typeof MerchantAccountEntityStatusEnum[keyof typeof MerchantAccountEntityStatusEnum];
+/**
+ * @export
+ */
+export declare const MerchantAccountEntityCardSchemesEnum: {
+    readonly Visa: "VISA";
+    readonly Mastercard: "MASTERCARD";
+    readonly Amex: "AMEX";
+    readonly Discover: "DISCOVER";
+    readonly Jcb: "JCB";
+    readonly DinersClub: "DINERS_CLUB";
+    readonly Maestro: "MAESTRO";
+};
+export type MerchantAccountEntityCardSchemesEnum = typeof MerchantAccountEntityCardSchemesEnum[keyof typeof MerchantAccountEntityCardSchemesEnum];
+/**
+ * @export
+ */
+export declare const MerchantAccountEntityCurrenciesEnum: {
+    readonly Usd: "USD";
+    readonly Aud: "AUD";
+    readonly Cad: "CAD";
+};
+export type MerchantAccountEntityCurrenciesEnum = typeof MerchantAccountEntityCurrenciesEnum[keyof typeof MerchantAccountEntityCurrenciesEnum];
+/**
+ * @export
+ */
+export declare const MerchantAccountEntityCardTypesEnum: {
+    readonly Credit: "CREDIT";
+    readonly Debit: "DEBIT";
+    readonly Prepaid: "PREPAID";
+};
+export type MerchantAccountEntityCardTypesEnum = typeof MerchantAccountEntityCardTypesEnum[keyof typeof MerchantAccountEntityCardTypesEnum];
+/**
+ * Check if a given object implements the MerchantAccountEntity interface.
+ */
+export declare function instanceOfMerchantAccountEntity(value: object): boolean;
+export declare function MerchantAccountEntityFromJSON(json: any): MerchantAccountEntity;
+export declare function MerchantAccountEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): MerchantAccountEntity;
+export declare function MerchantAccountEntityToJSON(value?: MerchantAccountEntity | null): any;

package/dist/mjs/models/MerchantAccountEntity.js

@@ -0,0 +1,135 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import { exists, removeNullUndefined } from '../runtime';
+import { MerchantAccountEntityCFeeFromJSON, MerchantAccountEntityCFeeToJSON, } from './MerchantAccountEntityCFee';
+import { MerchantConnectorEntityFromJSON, MerchantConnectorEntityToJSON, } from './MerchantConnectorEntity';
+/**
+ * @export
+ */
+export const MerchantAccountEntityPspEnum = {
+    Tsys: 'TSYS',
+    Nashville: 'NASHVILLE',
+    North: 'NORTH',
+    ChannelPayments: 'CHANNEL_PAYMENTS'
+};
+/**
+ * @export
+ */
+export const MerchantAccountEntityMethodEnum = {
+    Card: 'CARD',
+    Ach: 'ACH'
+};
+/**
+ * @export
+ */
+export const MerchantAccountEntityStatusEnum = {
+    Pending: 'PENDING',
+    Active: 'ACTIVE',
+    Inactive: 'INACTIVE',
+    Suspended: 'SUSPENDED',
+    Closed: 'CLOSED'
+};
+/**
+ * @export
+ */
+export const MerchantAccountEntityCardSchemesEnum = {
+    Visa: 'VISA',
+    Mastercard: 'MASTERCARD',
+    Amex: 'AMEX',
+    Discover: 'DISCOVER',
+    Jcb: 'JCB',
+    DinersClub: 'DINERS_CLUB',
+    Maestro: 'MAESTRO'
+};
+/**
+ * @export
+ */
+export const MerchantAccountEntityCurrenciesEnum = {
+    Usd: 'USD',
+    Aud: 'AUD',
+    Cad: 'CAD'
+};
+/**
+ * @export
+ */
+export const MerchantAccountEntityCardTypesEnum = {
+    Credit: 'CREDIT',
+    Debit: 'DEBIT',
+    Prepaid: 'PREPAID'
+};
+/**
+ * Check if a given object implements the MerchantAccountEntity interface.
+ */
+export function instanceOfMerchantAccountEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "merchantAccountId" in value;
+    isInstance = isInstance && "issuedMid" in value;
+    isInstance = isInstance && "psp" in value;
+    isInstance = isInstance && "cFee" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "updatedAt" in value;
+    isInstance = isInstance && "method" in value;
+    isInstance = isInstance && "status" in value;
+    isInstance = isInstance && "cardSchemes" in value;
+    isInstance = isInstance && "currencies" in value;
+    isInstance = isInstance && "cardTypes" in value;
+    return isInstance;
+}
+export function MerchantAccountEntityFromJSON(json) {
+    return MerchantAccountEntityFromJSONTyped(json, false);
+}
+export function MerchantAccountEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'id': json['id'],
+        'merchantAccountId': json['merchantAccountId'],
+        'merchantId': !exists(json, 'merchantId') ? undefined : json['merchantId'],
+        'issuedMid': json['issuedMid'],
+        'psp': json['psp'],
+        'cFee': MerchantAccountEntityCFeeFromJSON(json['cFee']),
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+        'method': json['method'],
+        'status': json['status'],
+        'cardSchemes': json['cardSchemes'],
+        'currencies': json['currencies'],
+        'cardTypes': json['cardTypes'],
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'connectors': !exists(json, 'connectors') ? undefined : (json['connectors'].map(MerchantConnectorEntityFromJSON)),
+    };
+    return removeNullUndefined(typed);
+}
+export function MerchantAccountEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'merchantAccountId': value.merchantAccountId,
+        'merchantId': value.merchantId,
+        'issuedMid': value.issuedMid,
+        'psp': value.psp,
+        'cFee': MerchantAccountEntityCFeeToJSON(value.cFee),
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+        'method': value.method,
+        'status': value.status,
+        'cardSchemes': value.cardSchemes,
+        'currencies': value.currencies,
+        'cardTypes': value.cardTypes,
+        'name': value.name,
+        'connectors': value.connectors === undefined ? undefined : (value.connectors.map(MerchantConnectorEntityToJSON)),
+    };
+}

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

@@ -0,0 +1,40 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ * The CFee details
+ * @export
+ * @interface MerchantAccountEntityCFee
+ */
+export interface MerchantAccountEntityCFee {
+    /**
+     * The type of the CFee
+     * @type {string}
+     * @memberof MerchantAccountEntityCFee
+     */
+    type: MerchantAccountEntityCFeeTypeEnum;
+    /**
+     * The rate of the CFee as an integer
+     * @type {number}
+     * @memberof MerchantAccountEntityCFee
+     */
+    rate: number;
+}
+/**
+ * @export
+ */
+export declare const MerchantAccountEntityCFeeTypeEnum: {
+    readonly Percentage: "PERCENTAGE";
+    readonly Fixed: "FIXED";
+};
+export type MerchantAccountEntityCFeeTypeEnum = typeof MerchantAccountEntityCFeeTypeEnum[keyof typeof MerchantAccountEntityCFeeTypeEnum];
+/**
+ * Check if a given object implements the MerchantAccountEntityCFee interface.
+ */
+export declare function instanceOfMerchantAccountEntityCFee(value: object): boolean;
+export declare function MerchantAccountEntityCFeeFromJSON(json: any): MerchantAccountEntityCFee;
+export declare function MerchantAccountEntityCFeeFromJSONTyped(json: any, ignoreDiscriminator: boolean): MerchantAccountEntityCFee;
+export declare function MerchantAccountEntityCFeeToJSON(value?: MerchantAccountEntityCFee | null): any;

package/dist/mjs/{src/models/MerchantAccountEntityCfee.js → models/MerchantAccountEntityCFee.js}

@@ -10,23 +10,23 @@ import { removeNullUndefined } from '../runtime';
 /**
  * @export
  */
-export const MerchantAccountEntityCfeeTypeEnum = {
+export const MerchantAccountEntityCFeeTypeEnum = {
     Percentage: 'PERCENTAGE',
     Fixed: 'FIXED'
 };
 /**
- * Check if a given object implements the MerchantAccountEntityCfee interface.
+ * Check if a given object implements the MerchantAccountEntityCFee interface.
  */
-export function instanceOfMerchantAccountEntityCfee(value) {
+export function instanceOfMerchantAccountEntityCFee(value) {
     let isInstance = true;
     isInstance = isInstance && "type" in value;
     isInstance = isInstance && "rate" in value;
     return isInstance;
 }
-export function MerchantAccountEntityCfeeFromJSON(json) {
-    return MerchantAccountEntityCfeeFromJSONTyped(json, false);
+export function MerchantAccountEntityCFeeFromJSON(json) {
+    return MerchantAccountEntityCFeeFromJSONTyped(json, false);
 }
-export function MerchantAccountEntityCfeeFromJSONTyped(json, ignoreDiscriminator) {
+export function MerchantAccountEntityCFeeFromJSONTyped(json, ignoreDiscriminator) {
     if ((json === undefined) || (json === null)) {
         return json;
     }
@@ -36,7 +36,7 @@ export function MerchantAccountEntityCfeeFromJSONTyped(json, ignoreDiscriminator
     };
     return removeNullUndefined(typed);
 }
-export function MerchantAccountEntityCfeeToJSON(value) {
+export function MerchantAccountEntityCFeeToJSON(value) {
     if (value === undefined) {
         return undefined;
     }

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

@@ -0,0 +1,92 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ *
+ * @export
+ * @interface MerchantConnectorEntity
+ */
+export interface MerchantConnectorEntity {
+    /**
+     * The alphanumeric document ID
+     * @type {string}
+     * @memberof MerchantConnectorEntity
+     */
+    id: string;
+    /**
+     * The alphanumeric ID of the merchant connector
+     * @type {string}
+     * @memberof MerchantConnectorEntity
+     */
+    connectorId: string;
+    /**
+     * The connector issued ID
+     * @type {string}
+     * @memberof MerchantConnectorEntity
+     */
+    issuedConnectorId: string;
+    /**
+     * The alphanumeric ID of the merchant account
+     * @type {string}
+     * @memberof MerchantConnectorEntity
+     */
+    merchantAccountId: string;
+    /**
+     * The name of the connector
+     * @type {string}
+     * @memberof MerchantConnectorEntity
+     */
+    connector: MerchantConnectorEntityConnectorEnum;
+    /**
+     * The date the merchant connector was created
+     * @type {Date}
+     * @memberof MerchantConnectorEntity
+     */
+    createdAt: Date;
+    /**
+     * The date the merchant connector was last updated
+     * @type {Date}
+     * @memberof MerchantConnectorEntity
+     */
+    updatedAt: Date;
+    /**
+     * The type of the merchant connector
+     * @type {string}
+     * @memberof MerchantConnectorEntity
+     */
+    type: MerchantConnectorEntityTypeEnum;
+    /**
+     * The name of the merchant connector
+     * @type {string}
+     * @memberof MerchantConnectorEntity
+     */
+    name?: string;
+}
+/**
+ * @export
+ */
+export declare const MerchantConnectorEntityConnectorEnum: {
+    readonly Epay: "EPAY";
+    readonly Nmi: "NMI";
+    readonly AuthorizeNet: "AUTHORIZE_NET";
+    readonly ChannelPayments: "CHANNEL_PAYMENTS";
+};
+export type MerchantConnectorEntityConnectorEnum = typeof MerchantConnectorEntityConnectorEnum[keyof typeof MerchantConnectorEntityConnectorEnum];
+/**
+ * @export
+ */
+export declare const MerchantConnectorEntityTypeEnum: {
+    readonly Gateway: "GATEWAY";
+    readonly Terminal: "TERMINAL";
+};
+export type MerchantConnectorEntityTypeEnum = typeof MerchantConnectorEntityTypeEnum[keyof typeof MerchantConnectorEntityTypeEnum];
+/**
+ * Check if a given object implements the MerchantConnectorEntity interface.
+ */
+export declare function instanceOfMerchantConnectorEntity(value: object): boolean;
+export declare function MerchantConnectorEntityFromJSON(json: any): MerchantConnectorEntity;
+export declare function MerchantConnectorEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): MerchantConnectorEntity;
+export declare function MerchantConnectorEntityToJSON(value?: MerchantConnectorEntity | null): any;

package/dist/mjs/models/MerchantConnectorEntity.js

@@ -0,0 +1,79 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import { exists, removeNullUndefined } from '../runtime';
+/**
+ * @export
+ */
+export const MerchantConnectorEntityConnectorEnum = {
+    Epay: 'EPAY',
+    Nmi: 'NMI',
+    AuthorizeNet: 'AUTHORIZE_NET',
+    ChannelPayments: 'CHANNEL_PAYMENTS'
+};
+/**
+ * @export
+ */
+export const MerchantConnectorEntityTypeEnum = {
+    Gateway: 'GATEWAY',
+    Terminal: 'TERMINAL'
+};
+/**
+ * Check if a given object implements the MerchantConnectorEntity interface.
+ */
+export function instanceOfMerchantConnectorEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "connectorId" in value;
+    isInstance = isInstance && "issuedConnectorId" in value;
+    isInstance = isInstance && "merchantAccountId" in value;
+    isInstance = isInstance && "connector" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "updatedAt" in value;
+    isInstance = isInstance && "type" in value;
+    return isInstance;
+}
+export function MerchantConnectorEntityFromJSON(json) {
+    return MerchantConnectorEntityFromJSONTyped(json, false);
+}
+export function MerchantConnectorEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'id': json['id'],
+        'connectorId': json['connectorId'],
+        'issuedConnectorId': json['issuedConnectorId'],
+        'merchantAccountId': json['merchantAccountId'],
+        'connector': json['connector'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+        'type': json['type'],
+        'name': !exists(json, 'name') ? undefined : json['name'],
+    };
+    return removeNullUndefined(typed);
+}
+export function MerchantConnectorEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'connectorId': value.connectorId,
+        'issuedConnectorId': value.issuedConnectorId,
+        'merchantAccountId': value.merchantAccountId,
+        'connector': value.connector,
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+        'type': value.type,
+        'name': value.name,
+    };
+}

package/dist/mjs/{src/models → models}/MerchantEntity.d.ts

@@ -12,6 +12,12 @@ import type { MerchantEntityAddress } from './MerchantEntityAddress';
  * @interface MerchantEntity
  */
 export interface MerchantEntity {
+    /**
+     * The alphanumeric document ID
+     * @type {string}
+     * @memberof MerchantEntity
+     */
+    id: string;
     /**
      * The alphanumeric merchant ID
      * @type {string}

package/dist/mjs/{src/models → models}/MerchantEntity.js

@@ -14,6 +14,7 @@ import { MerchantEntityAddressFromJSON, MerchantEntityAddressToJSON, } from './M
  */
 export function instanceOfMerchantEntity(value) {
     let isInstance = true;
+    isInstance = isInstance && "id" in value;
     isInstance = isInstance && "merchantId" in value;
     isInstance = isInstance && "name" in value;
     isInstance = isInstance && "address" in value;
@@ -31,6 +32,7 @@ export function MerchantEntityFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     const typed = {
+        'id': json['id'],
         'merchantId': json['merchantId'],
         'name': json['name'],
         'address': MerchantEntityAddressFromJSON(json['address']),
@@ -53,6 +55,7 @@ export function MerchantEntityToJSON(value) {
         return null;
     }
     return {
+        'id': value.id,
         'merchantId': value.merchantId,
         'name': value.name,
         'address': MerchantEntityAddressToJSON(value.address),

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

@@ -0,0 +1,65 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import type { MerchantRoutingFlowRuleEntity } from './MerchantRoutingFlowRuleEntity';
+/**
+ *
+ * @export
+ * @interface MerchantRoutingFlowEntity
+ */
+export interface MerchantRoutingFlowEntity {
+    /**
+     * The id of the routing flow
+     * @type {string}
+     * @memberof MerchantRoutingFlowEntity
+     */
+    routingFlowId: string;
+    /**
+     * The id of the merchant
+     * @type {string}
+     * @memberof MerchantRoutingFlowEntity
+     */
+    merchantId: string;
+    /**
+     * The payment method of the routing flow
+     * @type {string}
+     * @memberof MerchantRoutingFlowEntity
+     */
+    method: MerchantRoutingFlowEntityMethodEnum;
+    /**
+     * The rules for the routing flow
+     * @type {Array<MerchantRoutingFlowRuleEntity>}
+     * @memberof MerchantRoutingFlowEntity
+     */
+    routingFlowRules: Array<MerchantRoutingFlowRuleEntity>;
+    /**
+     * The date the record was created
+     * @type {Date}
+     * @memberof MerchantRoutingFlowEntity
+     */
+    createdAt: Date;
+    /**
+     * The date the record was updated
+     * @type {Date}
+     * @memberof MerchantRoutingFlowEntity
+     */
+    updatedAt: Date;
+}
+/**
+ * @export
+ */
+export declare const MerchantRoutingFlowEntityMethodEnum: {
+    readonly Card: "CARD";
+    readonly Ach: "ACH";
+};
+export type MerchantRoutingFlowEntityMethodEnum = typeof MerchantRoutingFlowEntityMethodEnum[keyof typeof MerchantRoutingFlowEntityMethodEnum];
+/**
+ * Check if a given object implements the MerchantRoutingFlowEntity interface.
+ */
+export declare function instanceOfMerchantRoutingFlowEntity(value: object): boolean;
+export declare function MerchantRoutingFlowEntityFromJSON(json: any): MerchantRoutingFlowEntity;
+export declare function MerchantRoutingFlowEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): MerchantRoutingFlowEntity;
+export declare function MerchantRoutingFlowEntityToJSON(value?: MerchantRoutingFlowEntity | null): any;