@channelpayments/node-sdk 1.24.0

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

@@ -0,0 +1,198 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import type { PaymentMethodEntity1 } from './PaymentMethodEntity1';
+import type { PaymentsBuyerEntity } from './PaymentsBuyerEntity';
+/**
+ *
+ * @export
+ * @interface TransactionEntity
+ */
+export interface TransactionEntity {
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEntity
+     */
+    transactionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEntity
+     */
+    merchantId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEntity
+     */
+    status: TransactionEntityStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEntity
+     */
+    intent: TransactionEntityIntentEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof TransactionEntity
+     */
+    amount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TransactionEntity
+     */
+    capturedAmount?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TransactionEntity
+     */
+    refundedAmount?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEntity
+     */
+    currency?: TransactionEntityCurrencyEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEntity
+     */
+    country?: string;
+    /**
+     *
+     * @type {PaymentMethodEntity1}
+     * @memberof TransactionEntity
+     */
+    paymentMethod?: PaymentMethodEntity1;
+    /**
+     *
+     * @type {PaymentsBuyerEntity}
+     * @memberof TransactionEntity
+     */
+    buyer?: PaymentsBuyerEntity;
+    /**
+     *
+     * @type {Date}
+     * @memberof TransactionEntity
+     */
+    createdAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof TransactionEntity
+     */
+    updatedAt?: Date;
+    /**
+     *
+     * @type {boolean}
+     * @memberof TransactionEntity
+     */
+    merchantInitiated?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEntity
+     */
+    schemeTransactionId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEntity
+     */
+    rawResponseCode?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEntity
+     */
+    rawResponseDescription?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEntity
+     */
+    avsResponseCode?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEntity
+     */
+    cvvResponseCode?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof TransactionEntity
+     */
+    capturedAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof TransactionEntity
+     */
+    authorizedAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof TransactionEntity
+     */
+    voidedAt?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEntity
+     */
+    externalTransactionId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEntity
+     */
+    buyerId?: string;
+}
+/**
+ * @export
+ */
+export declare const TransactionEntityStatusEnum: {
+    readonly Processing: "processing";
+    readonly BuyerApprovalPending: "buyerApprovalPending";
+    readonly Authorized: "authorized";
+    readonly AuthorizationFailed: "authorizationFailed";
+    readonly Declined: "declined";
+    readonly CapturePending: "capturePending";
+    readonly Captured: "captured";
+    readonly VoidPending: "voidPending";
+    readonly Voided: "voided";
+};
+export type TransactionEntityStatusEnum = typeof TransactionEntityStatusEnum[keyof typeof TransactionEntityStatusEnum];
+/**
+ * @export
+ */
+export declare const TransactionEntityIntentEnum: {
+    readonly Capture: "capture";
+    readonly Authorize: "authorize";
+};
+export type TransactionEntityIntentEnum = typeof TransactionEntityIntentEnum[keyof typeof TransactionEntityIntentEnum];
+/**
+ * @export
+ */
+export declare const TransactionEntityCurrencyEnum: {
+    readonly Usd: "USD";
+    readonly Cad: "CAD";
+    readonly Aud: "AUD";
+};
+export type TransactionEntityCurrencyEnum = typeof TransactionEntityCurrencyEnum[keyof typeof TransactionEntityCurrencyEnum];
+/**
+ * Check if a given object implements the TransactionEntity interface.
+ */
+export declare function instanceOfTransactionEntity(value: object): boolean;
+export declare function TransactionEntityFromJSON(json: any): TransactionEntity;
+export declare function TransactionEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionEntity;
+export declare function TransactionEntityToJSON(value?: TransactionEntity | null): any;

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

@@ -0,0 +1,121 @@
+/* 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 { PaymentMethodEntity1FromJSON, PaymentMethodEntity1ToJSON, } from './PaymentMethodEntity1';
+import { PaymentsBuyerEntityFromJSON, PaymentsBuyerEntityToJSON, } from './PaymentsBuyerEntity';
+/**
+ * @export
+ */
+export const TransactionEntityStatusEnum = {
+    Processing: 'processing',
+    BuyerApprovalPending: 'buyerApprovalPending',
+    Authorized: 'authorized',
+    AuthorizationFailed: 'authorizationFailed',
+    Declined: 'declined',
+    CapturePending: 'capturePending',
+    Captured: 'captured',
+    VoidPending: 'voidPending',
+    Voided: 'voided'
+};
+/**
+ * @export
+ */
+export const TransactionEntityIntentEnum = {
+    Capture: 'capture',
+    Authorize: 'authorize'
+};
+/**
+ * @export
+ */
+export const TransactionEntityCurrencyEnum = {
+    Usd: 'USD',
+    Cad: 'CAD',
+    Aud: 'AUD'
+};
+/**
+ * Check if a given object implements the TransactionEntity interface.
+ */
+export function instanceOfTransactionEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "transactionId" in value;
+    isInstance = isInstance && "merchantId" in value;
+    isInstance = isInstance && "status" in value;
+    isInstance = isInstance && "intent" in value;
+    isInstance = isInstance && "amount" in value;
+    return isInstance;
+}
+export function TransactionEntityFromJSON(json) {
+    return TransactionEntityFromJSONTyped(json, false);
+}
+export function TransactionEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'transactionId': json['transactionId'],
+        'merchantId': json['merchantId'],
+        'status': json['status'],
+        'intent': json['intent'],
+        'amount': json['amount'],
+        'capturedAmount': !exists(json, 'capturedAmount') ? undefined : json['capturedAmount'],
+        'refundedAmount': !exists(json, 'refundedAmount') ? undefined : json['refundedAmount'],
+        'currency': !exists(json, 'currency') ? undefined : json['currency'],
+        'country': !exists(json, 'country') ? undefined : json['country'],
+        'paymentMethod': !exists(json, 'paymentMethod') ? undefined : PaymentMethodEntity1FromJSON(json['paymentMethod']),
+        'buyer': !exists(json, 'buyer') ? undefined : PaymentsBuyerEntityFromJSON(json['buyer']),
+        'createdAt': !exists(json, 'createdAt') ? undefined : (new Date(json['createdAt'])),
+        'updatedAt': !exists(json, 'updatedAt') ? undefined : (new Date(json['updatedAt'])),
+        'merchantInitiated': !exists(json, 'merchantInitiated') ? undefined : json['merchantInitiated'],
+        'schemeTransactionId': !exists(json, 'schemeTransactionId') ? undefined : json['schemeTransactionId'],
+        'rawResponseCode': !exists(json, 'rawResponseCode') ? undefined : json['rawResponseCode'],
+        'rawResponseDescription': !exists(json, 'rawResponseDescription') ? undefined : json['rawResponseDescription'],
+        'avsResponseCode': !exists(json, 'avsResponseCode') ? undefined : json['avsResponseCode'],
+        'cvvResponseCode': !exists(json, 'cvvResponseCode') ? undefined : json['cvvResponseCode'],
+        'capturedAt': !exists(json, 'capturedAt') ? undefined : (new Date(json['capturedAt'])),
+        'authorizedAt': !exists(json, 'authorizedAt') ? undefined : (new Date(json['authorizedAt'])),
+        'voidedAt': !exists(json, 'voidedAt') ? undefined : (new Date(json['voidedAt'])),
+        'externalTransactionId': !exists(json, 'externalTransactionId') ? undefined : json['externalTransactionId'],
+        'buyerId': !exists(json, 'buyerId') ? undefined : json['buyerId'],
+    };
+    return removeNullUndefined(typed);
+}
+export function TransactionEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'transactionId': value.transactionId,
+        'merchantId': value.merchantId,
+        'status': value.status,
+        'intent': value.intent,
+        'amount': value.amount,
+        'capturedAmount': value.capturedAmount,
+        'refundedAmount': value.refundedAmount,
+        'currency': value.currency,
+        'country': value.country,
+        'paymentMethod': PaymentMethodEntity1ToJSON(value.paymentMethod),
+        'buyer': PaymentsBuyerEntityToJSON(value.buyer),
+        'createdAt': value.createdAt === undefined ? undefined : (value.createdAt.toISOString()),
+        'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt.toISOString()),
+        'merchantInitiated': value.merchantInitiated,
+        'schemeTransactionId': value.schemeTransactionId,
+        'rawResponseCode': value.rawResponseCode,
+        'rawResponseDescription': value.rawResponseDescription,
+        'avsResponseCode': value.avsResponseCode,
+        'cvvResponseCode': value.cvvResponseCode,
+        'capturedAt': value.capturedAt === undefined ? undefined : (value.capturedAt.toISOString()),
+        'authorizedAt': value.authorizedAt === undefined ? undefined : (value.authorizedAt.toISOString()),
+        'voidedAt': value.voidedAt === undefined ? undefined : (value.voidedAt.toISOString()),
+        'externalTransactionId': value.externalTransactionId,
+        'buyerId': value.buyerId,
+    };
+}

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

@@ -0,0 +1,85 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ *
+ * @export
+ * @interface TransactionRefundEntity
+ */
+export interface TransactionRefundEntity {
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionRefundEntity
+     */
+    refundRecordId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionRefundEntity
+     */
+    merchantId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionRefundEntity
+     */
+    refundId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionRefundEntity
+     */
+    transactionId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof TransactionRefundEntity
+     */
+    refundedAmount: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof TransactionRefundEntity
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof TransactionRefundEntity
+     */
+    updatedAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionRefundEntity
+     */
+    status: TransactionRefundEntityStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionRefundEntity
+     */
+    currency?: string;
+}
+/**
+ * @export
+ */
+export declare const TransactionRefundEntityStatusEnum: {
+    readonly Processing: "processing";
+    readonly Succeeded: "succeeded";
+    readonly Declined: "declined";
+    readonly Failed: "failed";
+    readonly Voided: "voided";
+};
+export type TransactionRefundEntityStatusEnum = typeof TransactionRefundEntityStatusEnum[keyof typeof TransactionRefundEntityStatusEnum];
+/**
+ * Check if a given object implements the TransactionRefundEntity interface.
+ */
+export declare function instanceOfTransactionRefundEntity(value: object): boolean;
+export declare function TransactionRefundEntityFromJSON(json: any): TransactionRefundEntity;
+export declare function TransactionRefundEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionRefundEntity;
+export declare function TransactionRefundEntityToJSON(value?: TransactionRefundEntity | null): any;

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

@@ -0,0 +1,73 @@
+/* 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 TransactionRefundEntityStatusEnum = {
+    Processing: 'processing',
+    Succeeded: 'succeeded',
+    Declined: 'declined',
+    Failed: 'failed',
+    Voided: 'voided'
+};
+/**
+ * Check if a given object implements the TransactionRefundEntity interface.
+ */
+export function instanceOfTransactionRefundEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "refundRecordId" in value;
+    isInstance = isInstance && "merchantId" in value;
+    isInstance = isInstance && "refundId" in value;
+    isInstance = isInstance && "transactionId" in value;
+    isInstance = isInstance && "refundedAmount" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "updatedAt" in value;
+    isInstance = isInstance && "status" in value;
+    return isInstance;
+}
+export function TransactionRefundEntityFromJSON(json) {
+    return TransactionRefundEntityFromJSONTyped(json, false);
+}
+export function TransactionRefundEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'refundRecordId': json['refundRecordId'],
+        'merchantId': json['merchantId'],
+        'refundId': json['refundId'],
+        'transactionId': json['transactionId'],
+        'refundedAmount': json['refundedAmount'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+        'status': json['status'],
+        'currency': !exists(json, 'currency') ? undefined : json['currency'],
+    };
+    return removeNullUndefined(typed);
+}
+export function TransactionRefundEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'refundRecordId': value.refundRecordId,
+        'merchantId': value.merchantId,
+        'refundId': value.refundId,
+        'transactionId': value.transactionId,
+        'refundedAmount': value.refundedAmount,
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+        'status': value.status,
+        'currency': value.currency,
+    };
+}

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

@@ -0,0 +1,51 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import type { TransactionRefundEntity } from './TransactionRefundEntity';
+/**
+ *
+ * @export
+ * @interface TransactionRefundsSearchEntity
+ */
+export interface TransactionRefundsSearchEntity {
+    /**
+     * The previous cursor
+     * @type {string}
+     * @memberof TransactionRefundsSearchEntity
+     */
+    prevCursor: string;
+    /**
+     * The list of queried transactions
+     * @type {Array<TransactionRefundEntity>}
+     * @memberof TransactionRefundsSearchEntity
+     */
+    refunds: Array<TransactionRefundEntity>;
+    /**
+     * The number of records returned
+     * @type {number}
+     * @memberof TransactionRefundsSearchEntity
+     */
+    limit: number;
+    /**
+     * The next cursor
+     * @type {string}
+     * @memberof TransactionRefundsSearchEntity
+     */
+    nextCursor?: string;
+    /**
+     * The page number
+     * @type {number}
+     * @memberof TransactionRefundsSearchEntity
+     */
+    page?: number;
+}
+/**
+ * Check if a given object implements the TransactionRefundsSearchEntity interface.
+ */
+export declare function instanceOfTransactionRefundsSearchEntity(value: object): boolean;
+export declare function TransactionRefundsSearchEntityFromJSON(json: any): TransactionRefundsSearchEntity;
+export declare function TransactionRefundsSearchEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionRefundsSearchEntity;
+export declare function TransactionRefundsSearchEntityToJSON(value?: TransactionRefundsSearchEntity | null): any;

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

@@ -0,0 +1,51 @@
+/* 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 { TransactionRefundEntityFromJSON, TransactionRefundEntityToJSON, } from './TransactionRefundEntity';
+/**
+ * Check if a given object implements the TransactionRefundsSearchEntity interface.
+ */
+export function instanceOfTransactionRefundsSearchEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "prevCursor" in value;
+    isInstance = isInstance && "refunds" in value;
+    isInstance = isInstance && "limit" in value;
+    return isInstance;
+}
+export function TransactionRefundsSearchEntityFromJSON(json) {
+    return TransactionRefundsSearchEntityFromJSONTyped(json, false);
+}
+export function TransactionRefundsSearchEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'prevCursor': json['prevCursor'],
+        'refunds': (json['refunds'].map(TransactionRefundEntityFromJSON)),
+        'limit': json['limit'],
+        'nextCursor': !exists(json, 'nextCursor') ? undefined : json['nextCursor'],
+        'page': !exists(json, 'page') ? undefined : json['page'],
+    };
+    return removeNullUndefined(typed);
+}
+export function TransactionRefundsSearchEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'prevCursor': value.prevCursor,
+        'refunds': (value.refunds.map(TransactionRefundEntityToJSON)),
+        'limit': value.limit,
+        'nextCursor': value.nextCursor,
+        'page': value.page,
+    };
+}

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

@@ -0,0 +1,51 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import type { TransactionEntity } from './TransactionEntity';
+/**
+ *
+ * @export
+ * @interface TransactionsSearchEntity
+ */
+export interface TransactionsSearchEntity {
+    /**
+     * The previous cursor
+     * @type {string}
+     * @memberof TransactionsSearchEntity
+     */
+    prevCursor: string;
+    /**
+     * The list of queried transactions
+     * @type {Array<TransactionEntity>}
+     * @memberof TransactionsSearchEntity
+     */
+    transactions: Array<TransactionEntity>;
+    /**
+     * The number of records returned
+     * @type {number}
+     * @memberof TransactionsSearchEntity
+     */
+    limit: number;
+    /**
+     * The next cursor
+     * @type {string}
+     * @memberof TransactionsSearchEntity
+     */
+    nextCursor?: string;
+    /**
+     * The page number
+     * @type {number}
+     * @memberof TransactionsSearchEntity
+     */
+    page?: number;
+}
+/**
+ * Check if a given object implements the TransactionsSearchEntity interface.
+ */
+export declare function instanceOfTransactionsSearchEntity(value: object): boolean;
+export declare function TransactionsSearchEntityFromJSON(json: any): TransactionsSearchEntity;
+export declare function TransactionsSearchEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionsSearchEntity;
+export declare function TransactionsSearchEntityToJSON(value?: TransactionsSearchEntity | null): any;

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

@@ -0,0 +1,51 @@
+/* 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 { TransactionEntityFromJSON, TransactionEntityToJSON, } from './TransactionEntity';
+/**
+ * Check if a given object implements the TransactionsSearchEntity interface.
+ */
+export function instanceOfTransactionsSearchEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "prevCursor" in value;
+    isInstance = isInstance && "transactions" in value;
+    isInstance = isInstance && "limit" in value;
+    return isInstance;
+}
+export function TransactionsSearchEntityFromJSON(json) {
+    return TransactionsSearchEntityFromJSONTyped(json, false);
+}
+export function TransactionsSearchEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'prevCursor': json['prevCursor'],
+        'transactions': (json['transactions'].map(TransactionEntityFromJSON)),
+        'limit': json['limit'],
+        'nextCursor': !exists(json, 'nextCursor') ? undefined : json['nextCursor'],
+        'page': !exists(json, 'page') ? undefined : json['page'],
+    };
+    return removeNullUndefined(typed);
+}
+export function TransactionsSearchEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'prevCursor': value.prevCursor,
+        'transactions': (value.transactions.map(TransactionEntityToJSON)),
+        'limit': value.limit,
+        'nextCursor': value.nextCursor,
+        'page': value.page,
+    };
+}