@channelpayments/node-sdk 1.24.0

package/dist/mjs/src/models/MerchantEntityAddress.js

@@ -0,0 +1,58 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import { exists, removeNullUndefined } from '../runtime';
+/**
+ * Check if a given object implements the MerchantEntityAddress interface.
+ */
+export function instanceOfMerchantEntityAddress(value) {
+    let isInstance = true;
+    isInstance = isInstance && "country" in value;
+    isInstance = isInstance && "subdivision" in value;
+    isInstance = isInstance && "city" in value;
+    isInstance = isInstance && "streetAddress" in value;
+    isInstance = isInstance && "postalCode" in value;
+    return isInstance;
+}
+export function MerchantEntityAddressFromJSON(json) {
+    return MerchantEntityAddressFromJSONTyped(json, false);
+}
+export function MerchantEntityAddressFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'country': json['country'],
+        'subdivision': json['subdivision'],
+        'city': json['city'],
+        'streetAddress': json['streetAddress'],
+        'postalCode': json['postalCode'],
+        'countryCode': !exists(json, 'countryCode') ? undefined : json['countryCode'],
+        'subdivisionCode': !exists(json, 'subdivisionCode') ? undefined : json['subdivisionCode'],
+        'streetAddress2': !exists(json, 'streetAddress2') ? undefined : json['streetAddress2'],
+    };
+    return removeNullUndefined(typed);
+}
+export function MerchantEntityAddressToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'country': value.country,
+        'subdivision': value.subdivision,
+        'city': value.city,
+        'streetAddress': value.streetAddress,
+        'postalCode': value.postalCode,
+        'countryCode': value.countryCode,
+        'subdivisionCode': value.subdivisionCode,
+        'streetAddress2': value.streetAddress2,
+    };
+}

package/dist/mjs/src/models/MerchantGatewayEntity.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ *
+ * @export
+ * @interface MerchantGatewayEntity
+ */
+export interface MerchantGatewayEntity {
+    /**
+     * The alphanumeric ID of the merchant gateway
+     * @type {string}
+     * @memberof MerchantGatewayEntity
+     */
+    merchantGatewayId: string;
+    /**
+     * The alphanumeric ID of the merchant account
+     * @type {string}
+     * @memberof MerchantGatewayEntity
+     */
+    merchantAccountId: string;
+    /**
+     * The name of the merchant gateway
+     * @type {string}
+     * @memberof MerchantGatewayEntity
+     */
+    name: MerchantGatewayEntityNameEnum;
+    /**
+     * The date the merchant gateway was created
+     * @type {Date}
+     * @memberof MerchantGatewayEntity
+     */
+    createdAt: Date;
+    /**
+     * The date the merchant gateway was last updated
+     * @type {Date}
+     * @memberof MerchantGatewayEntity
+     */
+    updatedAt: Date;
+}
+/**
+ * @export
+ */
+export declare const MerchantGatewayEntityNameEnum: {
+    readonly Epay: "EPAY";
+    readonly Nmi: "NMI";
+    readonly AuthorizeNet: "AUTHORIZE_NET";
+};
+export type MerchantGatewayEntityNameEnum = typeof MerchantGatewayEntityNameEnum[keyof typeof MerchantGatewayEntityNameEnum];
+/**
+ * Check if a given object implements the MerchantGatewayEntity interface.
+ */
+export declare function instanceOfMerchantGatewayEntity(value: object): boolean;
+export declare function MerchantGatewayEntityFromJSON(json: any): MerchantGatewayEntity;
+export declare function MerchantGatewayEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): MerchantGatewayEntity;
+export declare function MerchantGatewayEntityToJSON(value?: MerchantGatewayEntity | null): any;

package/dist/mjs/src/models/MerchantGatewayEntity.js

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import { removeNullUndefined } from '../runtime';
+/**
+ * @export
+ */
+export const MerchantGatewayEntityNameEnum = {
+    Epay: 'EPAY',
+    Nmi: 'NMI',
+    AuthorizeNet: 'AUTHORIZE_NET'
+};
+/**
+ * Check if a given object implements the MerchantGatewayEntity interface.
+ */
+export function instanceOfMerchantGatewayEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "merchantGatewayId" in value;
+    isInstance = isInstance && "merchantAccountId" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "updatedAt" in value;
+    return isInstance;
+}
+export function MerchantGatewayEntityFromJSON(json) {
+    return MerchantGatewayEntityFromJSONTyped(json, false);
+}
+export function MerchantGatewayEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'merchantGatewayId': json['merchantGatewayId'],
+        'merchantAccountId': json['merchantAccountId'],
+        'name': json['name'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+    return removeNullUndefined(typed);
+}
+export function MerchantGatewayEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'merchantGatewayId': value.merchantGatewayId,
+        'merchantAccountId': value.merchantAccountId,
+        'name': value.name,
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+    };
+}

package/dist/mjs/src/models/PaymentMethodDto.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ *
+ * @export
+ * @interface PaymentMethodDto
+ */
+export interface PaymentMethodDto {
+    /**
+     * The payment method.
+     * @type {string}
+     * @memberof PaymentMethodDto
+     */
+    method: PaymentMethodDtoMethodEnum;
+    /**
+     * The 13 - 19 digit card number. Must be unset is method is not CARD.
+     * @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.
+     * @type {string}
+     * @memberof PaymentMethodDto
+     */
+    securityCode?: string;
+    /**
+     * The expiration date of the card, formatted MM/YY. Must be unset if method is not CARD.
+     * @type {string}
+     * @memberof PaymentMethodDto
+     */
+    expirationDate?: string;
+    /**
+     * The id of the buyer to associate the payment to. Must be unset if method is ID.
+     * @type {string}
+     * @memberof PaymentMethodDto
+     */
+    externalBuyerId?: string;
+    /**
+     * The id of the buyer to associate the payment to. Must be unset if method is ID.
+     * @type {string}
+     * @memberof PaymentMethodDto
+     */
+    buyerId?: string;
+    /**
+     * The id of the stored payment method to use. Must be unset if method is not ID.
+     * @type {string}
+     * @memberof PaymentMethodDto
+     */
+    paymentMethodId?: string;
+    /**
+     * Whether or not to also try and store the payment method for future use
+     * @type {boolean}
+     * @memberof PaymentMethodDto
+     */
+    store?: boolean;
+}
+/**
+ * @export
+ */
+export declare const PaymentMethodDtoMethodEnum: {
+    readonly Card: "CARD";
+    readonly Id: "ID";
+};
+export type PaymentMethodDtoMethodEnum = typeof PaymentMethodDtoMethodEnum[keyof typeof PaymentMethodDtoMethodEnum];
+/**
+ * Check if a given object implements the PaymentMethodDto interface.
+ */
+export declare function instanceOfPaymentMethodDto(value: object): boolean;
+export declare function PaymentMethodDtoFromJSON(json: any): PaymentMethodDto;
+export declare function PaymentMethodDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaymentMethodDto;
+export declare function PaymentMethodDtoToJSON(value?: PaymentMethodDto | null): any;

package/dist/mjs/src/models/PaymentMethodDto.js

@@ -0,0 +1,61 @@
+/* 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 PaymentMethodDtoMethodEnum = {
+    Card: 'CARD',
+    Id: 'ID'
+};
+/**
+ * Check if a given object implements the PaymentMethodDto interface.
+ */
+export function instanceOfPaymentMethodDto(value) {
+    let isInstance = true;
+    isInstance = isInstance && "method" in value;
+    return isInstance;
+}
+export function PaymentMethodDtoFromJSON(json) {
+    return PaymentMethodDtoFromJSONTyped(json, false);
+}
+export function PaymentMethodDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'method': json['method'],
+        'number': !exists(json, 'number') ? undefined : json['number'],
+        'securityCode': !exists(json, 'securityCode') ? undefined : json['securityCode'],
+        'expirationDate': !exists(json, 'expirationDate') ? undefined : json['expirationDate'],
+        'externalBuyerId': !exists(json, 'externalBuyerId') ? undefined : json['externalBuyerId'],
+        'buyerId': !exists(json, 'buyerId') ? undefined : json['buyerId'],
+        'paymentMethodId': !exists(json, 'paymentMethodId') ? undefined : json['paymentMethodId'],
+        'store': !exists(json, 'store') ? undefined : json['store'],
+    };
+    return removeNullUndefined(typed);
+}
+export function PaymentMethodDtoToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'method': value.method,
+        'number': value.number,
+        'securityCode': value.securityCode,
+        'expirationDate': value.expirationDate,
+        'externalBuyerId': value.externalBuyerId,
+        'buyerId': value.buyerId,
+        'paymentMethodId': value.paymentMethodId,
+        'store': value.store,
+    };
+}

package/dist/mjs/src/models/PaymentMethodEntity.d.ts

@@ -0,0 +1,124 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import type { PaymentMethodEntityBuyer } from './PaymentMethodEntityBuyer';
+import type { PaymentMethodEntityDetails } from './PaymentMethodEntityDetails';
+/**
+ *
+ * @export
+ * @interface PaymentMethodEntity
+ */
+export interface PaymentMethodEntity {
+    /**
+     * The payment method ID
+     * @type {string}
+     * @memberof PaymentMethodEntity
+     */
+    paymentMethodId: string;
+    /**
+     * The merchant ID
+     * @type {string}
+     * @memberof PaymentMethodEntity
+     */
+    merchantId: string;
+    /**
+     * The payment method status
+     * @type {string}
+     * @memberof PaymentMethodEntity
+     */
+    status: PaymentMethodEntityStatusEnum;
+    /**
+     * The external payment method ID to associate with your records
+     * @type {string}
+     * @memberof PaymentMethodEntity
+     */
+    externalPaymentMethodId?: string;
+    /**
+     * The payment method type
+     * @type {string}
+     * @memberof PaymentMethodEntity
+     */
+    method: PaymentMethodEntityMethodEnum;
+    /**
+     * The currency to use with this payment method
+     * @type {string}
+     * @memberof PaymentMethodEntity
+     */
+    currency?: PaymentMethodEntityCurrencyEnum;
+    /**
+     * The 2-letter ISO country code to use with this payment method. The payment method may be used in multiple countries if not specified
+     * @type {string}
+     * @memberof PaymentMethodEntity
+     */
+    countryCode?: string;
+    /**
+     *
+     * @type {PaymentMethodEntityDetails}
+     * @memberof PaymentMethodEntity
+     */
+    details?: PaymentMethodEntityDetails;
+    /**
+     *
+     * @type {PaymentMethodEntityBuyer}
+     * @memberof PaymentMethodEntity
+     */
+    buyer?: PaymentMethodEntityBuyer;
+    /**
+     * The buyer ID
+     * @type {string}
+     * @memberof PaymentMethodEntity
+     */
+    buyerId?: string;
+    /**
+     * The external buyer ID
+     * @type {string}
+     * @memberof PaymentMethodEntity
+     */
+    externalBuyerId?: string;
+    /**
+     * The payment method creation date
+     * @type {Date}
+     * @memberof PaymentMethodEntity
+     */
+    createdAt?: Date;
+    /**
+     * The payment method update date
+     * @type {Date}
+     * @memberof PaymentMethodEntity
+     */
+    updatedAt?: Date;
+}
+/**
+ * @export
+ */
+export declare const PaymentMethodEntityStatusEnum: {
+    readonly Processing: "processing";
+    readonly ApprovalRequired: "approvalRequired";
+    readonly Succeeded: "succeeded";
+    readonly Failed: "failed";
+};
+export type PaymentMethodEntityStatusEnum = typeof PaymentMethodEntityStatusEnum[keyof typeof PaymentMethodEntityStatusEnum];
+/**
+ * @export
+ */
+export declare const PaymentMethodEntityMethodEnum: {
+    readonly Card: "card";
+};
+export type PaymentMethodEntityMethodEnum = typeof PaymentMethodEntityMethodEnum[keyof typeof PaymentMethodEntityMethodEnum];
+/**
+ * @export
+ */
+export declare const PaymentMethodEntityCurrencyEnum: {
+    readonly Usd: "USD";
+};
+export type PaymentMethodEntityCurrencyEnum = typeof PaymentMethodEntityCurrencyEnum[keyof typeof PaymentMethodEntityCurrencyEnum];
+/**
+ * Check if a given object implements the PaymentMethodEntity interface.
+ */
+export declare function instanceOfPaymentMethodEntity(value: object): boolean;
+export declare function PaymentMethodEntityFromJSON(json: any): PaymentMethodEntity;
+export declare function PaymentMethodEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaymentMethodEntity;
+export declare function PaymentMethodEntityToJSON(value?: PaymentMethodEntity | null): any;

package/dist/mjs/src/models/PaymentMethodEntity.js

@@ -0,0 +1,90 @@
+/* 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 { PaymentMethodEntityBuyerFromJSON, PaymentMethodEntityBuyerToJSON, } from './PaymentMethodEntityBuyer';
+import { PaymentMethodEntityDetailsFromJSON, PaymentMethodEntityDetailsToJSON, } from './PaymentMethodEntityDetails';
+/**
+ * @export
+ */
+export const PaymentMethodEntityStatusEnum = {
+    Processing: 'processing',
+    ApprovalRequired: 'approvalRequired',
+    Succeeded: 'succeeded',
+    Failed: 'failed'
+};
+/**
+ * @export
+ */
+export const PaymentMethodEntityMethodEnum = {
+    Card: 'card'
+};
+/**
+ * @export
+ */
+export const PaymentMethodEntityCurrencyEnum = {
+    Usd: 'USD'
+};
+/**
+ * Check if a given object implements the PaymentMethodEntity interface.
+ */
+export function instanceOfPaymentMethodEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "paymentMethodId" in value;
+    isInstance = isInstance && "merchantId" in value;
+    isInstance = isInstance && "status" in value;
+    isInstance = isInstance && "method" in value;
+    return isInstance;
+}
+export function PaymentMethodEntityFromJSON(json) {
+    return PaymentMethodEntityFromJSONTyped(json, false);
+}
+export function PaymentMethodEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'paymentMethodId': json['paymentMethodId'],
+        'merchantId': json['merchantId'],
+        'status': json['status'],
+        'externalPaymentMethodId': !exists(json, 'externalPaymentMethodId') ? undefined : json['externalPaymentMethodId'],
+        'method': json['method'],
+        'currency': !exists(json, 'currency') ? undefined : json['currency'],
+        'countryCode': !exists(json, 'countryCode') ? undefined : json['countryCode'],
+        'details': !exists(json, 'details') ? undefined : PaymentMethodEntityDetailsFromJSON(json['details']),
+        'buyer': !exists(json, 'buyer') ? undefined : PaymentMethodEntityBuyerFromJSON(json['buyer']),
+        'buyerId': !exists(json, 'buyerId') ? undefined : json['buyerId'],
+        'externalBuyerId': !exists(json, 'externalBuyerId') ? undefined : json['externalBuyerId'],
+        'createdAt': !exists(json, 'createdAt') ? undefined : (new Date(json['createdAt'])),
+        'updatedAt': !exists(json, 'updatedAt') ? undefined : (new Date(json['updatedAt'])),
+    };
+    return removeNullUndefined(typed);
+}
+export function PaymentMethodEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'paymentMethodId': value.paymentMethodId,
+        'merchantId': value.merchantId,
+        'status': value.status,
+        'externalPaymentMethodId': value.externalPaymentMethodId,
+        'method': value.method,
+        'currency': value.currency,
+        'countryCode': value.countryCode,
+        'details': PaymentMethodEntityDetailsToJSON(value.details),
+        'buyer': PaymentMethodEntityBuyerToJSON(value.buyer),
+        'buyerId': value.buyerId,
+        'externalBuyerId': value.externalBuyerId,
+        'createdAt': value.createdAt === undefined ? undefined : (value.createdAt.toISOString()),
+        'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt.toISOString()),
+    };
+}

package/dist/mjs/src/models/PaymentMethodEntity1.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ *
+ * @export
+ * @interface PaymentMethodEntity1
+ */
+export interface PaymentMethodEntity1 {
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentMethodEntity1
+     */
+    paymentMethodId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentMethodEntity1
+     */
+    method: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentMethodEntity1
+     */
+    externalPaymentMethodId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentMethodEntity1
+     */
+    label?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentMethodEntity1
+     */
+    scheme?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentMethodEntity1
+     */
+    expirationDate?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentMethodEntity1
+     */
+    currency?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentMethodEntity1
+     */
+    country?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentMethodEntity1
+     */
+    bin?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentMethodEntity1
+     */
+    cardType?: PaymentMethodEntity1CardTypeEnum;
+}
+/**
+ * @export
+ */
+export declare const PaymentMethodEntity1CardTypeEnum: {
+    readonly Credit: "credit";
+    readonly Debit: "debit";
+    readonly Prepaid: "prepaid";
+};
+export type PaymentMethodEntity1CardTypeEnum = typeof PaymentMethodEntity1CardTypeEnum[keyof typeof PaymentMethodEntity1CardTypeEnum];
+/**
+ * Check if a given object implements the PaymentMethodEntity1 interface.
+ */
+export declare function instanceOfPaymentMethodEntity1(value: object): boolean;
+export declare function PaymentMethodEntity1FromJSON(json: any): PaymentMethodEntity1;
+export declare function PaymentMethodEntity1FromJSONTyped(json: any, ignoreDiscriminator: boolean): PaymentMethodEntity1;
+export declare function PaymentMethodEntity1ToJSON(value?: PaymentMethodEntity1 | null): any;

package/dist/mjs/src/models/PaymentMethodEntity1.js

@@ -0,0 +1,67 @@
+/* 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 PaymentMethodEntity1CardTypeEnum = {
+    Credit: 'credit',
+    Debit: 'debit',
+    Prepaid: 'prepaid'
+};
+/**
+ * Check if a given object implements the PaymentMethodEntity1 interface.
+ */
+export function instanceOfPaymentMethodEntity1(value) {
+    let isInstance = true;
+    isInstance = isInstance && "paymentMethodId" in value;
+    isInstance = isInstance && "method" in value;
+    return isInstance;
+}
+export function PaymentMethodEntity1FromJSON(json) {
+    return PaymentMethodEntity1FromJSONTyped(json, false);
+}
+export function PaymentMethodEntity1FromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'paymentMethodId': json['paymentMethodId'],
+        'method': json['method'],
+        'externalPaymentMethodId': !exists(json, 'externalPaymentMethodId') ? undefined : json['externalPaymentMethodId'],
+        'label': !exists(json, 'label') ? undefined : json['label'],
+        'scheme': !exists(json, 'scheme') ? undefined : json['scheme'],
+        'expirationDate': !exists(json, 'expirationDate') ? undefined : json['expirationDate'],
+        'currency': !exists(json, 'currency') ? undefined : json['currency'],
+        'country': !exists(json, 'country') ? undefined : json['country'],
+        'bin': !exists(json, 'bin') ? undefined : json['bin'],
+        'cardType': !exists(json, 'cardType') ? undefined : json['cardType'],
+    };
+    return removeNullUndefined(typed);
+}
+export function PaymentMethodEntity1ToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'paymentMethodId': value.paymentMethodId,
+        'method': value.method,
+        'externalPaymentMethodId': value.externalPaymentMethodId,
+        'label': value.label,
+        'scheme': value.scheme,
+        'expirationDate': value.expirationDate,
+        'currency': value.currency,
+        'country': value.country,
+        'bin': value.bin,
+        'cardType': value.cardType,
+    };
+}