@channelpayments/node-sdk 1.192.0 → 1.194.0

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

@@ -0,0 +1,303 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ *
+ * @export
+ * @interface TransactionsRecordEntity
+ */
+export interface TransactionsRecordEntity {
+    /**
+     * The merchant ID for this transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    merchantId: string;
+    /**
+     * The transaction creation date.
+     * @type {Date}
+     * @memberof TransactionsRecordEntity
+     */
+    createdAt: Date;
+    /**
+     * The transaction ID.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    transactionId: string;
+    /**
+     * Indicate the current status for this transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    status: TransactionsRecordEntityStatusEnum;
+    /**
+     * The transaction amount in cents.
+     * @type {number}
+     * @memberof TransactionsRecordEntity
+     */
+    amount: number;
+    /**
+     * Indicate the payment method used for this transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    paymentMethod: TransactionsRecordEntityPaymentMethodEnum;
+    /**
+     * Indicate the account type used for this transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    accountType?: TransactionsRecordEntityAccountTypeEnum;
+    /**
+     * The external transaction ID of the transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    externalTransactionId?: string;
+    /**
+     * The net amount of the transaction.
+     * @type {number}
+     * @memberof TransactionsRecordEntity
+     */
+    netAmount: number;
+    /**
+     * The fee of the transaction.
+     * @type {number}
+     * @memberof TransactionsRecordEntity
+     */
+    fee: number;
+    /**
+     * The intent of the transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    intent: TransactionsRecordEntityIntentEnum;
+    /**
+     * The captured date of the transaction.
+     * @type {Date}
+     * @memberof TransactionsRecordEntity
+     */
+    capturedAt?: Date;
+    /**
+     * The authorized date of the card transaction.
+     * @type {Date}
+     * @memberof TransactionsRecordEntity
+     */
+    authorizedAt?: Date;
+    /**
+     * The rejected date of the ACH transaction.
+     * @type {Date}
+     * @memberof TransactionsRecordEntity
+     */
+    rejectedAt?: Date;
+    /**
+     * The returned date of the ACH transaction.
+     * @type {Date}
+     * @memberof TransactionsRecordEntity
+     */
+    returnedAt?: Date;
+    /**
+     * The settled date of the ACH transaction.
+     * @type {Date}
+     * @memberof TransactionsRecordEntity
+     */
+    settledAt?: Date;
+    /**
+     * The updated date of the transaction.
+     * @type {Date}
+     * @memberof TransactionsRecordEntity
+     */
+    updatedAt?: Date;
+    /**
+     * The voided date of the card or ACH transaction.
+     * @type {Date}
+     * @memberof TransactionsRecordEntity
+     */
+    voidedAt?: Date;
+    /**
+     * The captured amount of the transaction.
+     * @type {number}
+     * @memberof TransactionsRecordEntity
+     */
+    capturedAmount?: number;
+    /**
+     * The refunded amount of the transaction.
+     * @type {number}
+     * @memberof TransactionsRecordEntity
+     */
+    refundedAmount?: number;
+    /**
+     * The currency of the transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    currency: TransactionsRecordEntityCurrencyEnum;
+    /**
+     * The country of the transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    country: string;
+    /**
+     * The buyer ID of the transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    buyerId?: string;
+    /**
+     * The external buyer ID of the transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    externalBuyerId?: string;
+    /**
+     * The card type.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    cardType?: TransactionsRecordEntityCardTypeEnum;
+    /**
+     * The last 4 of the card number.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    label?: string;
+    /**
+     * The scheme of the payment method.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    scheme?: string;
+    /**
+     * The expiration date of the payment method.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    expirationDate?: string;
+    /**
+     * The account holder name of the payment method.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    accountHolderName?: string;
+    /**
+     * The raw response code of the transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    rawResponseCode?: string;
+    /**
+     * The raw response description of the transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    rawResponseDescription?: string;
+    /**
+     * The AVS response code of the transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    avsResponseCode?: string;
+    /**
+     * The CVV response code of the transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    cvvResponseCode?: string;
+    /**
+     * The session ID.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    sessionId?: string;
+    /**
+     * The account number last digits.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    accountEnding?: string;
+    /**
+     * Descriptive labels or keywords that can be assigned to the transaction.
+     * @type {string}
+     * @memberof TransactionsRecordEntity
+     */
+    tags?: string;
+}
+/**
+ * @export
+ */
+export declare const TransactionsRecordEntityStatusEnum: {
+    readonly Processing: "processing";
+    readonly BuyerApprovalPending: "buyerApprovalPending";
+    readonly Authorized: "authorized";
+    readonly AuthorizationFailed: "authorizationFailed";
+    readonly CaptureFailed: "captureFailed";
+    readonly Declined: "declined";
+    readonly CapturePending: "capturePending";
+    readonly Captured: "captured";
+    readonly VoidPending: "voidPending";
+    readonly Voided: "voided";
+    readonly Hold: "hold";
+    readonly Submitted: "submitted";
+    readonly Transmitted: "transmitted";
+    readonly Settled: "settled";
+    readonly Returned: "returned";
+    readonly Rejected: "rejected";
+};
+export type TransactionsRecordEntityStatusEnum = typeof TransactionsRecordEntityStatusEnum[keyof typeof TransactionsRecordEntityStatusEnum];
+/**
+ * @export
+ */
+export declare const TransactionsRecordEntityPaymentMethodEnum: {
+    readonly Ach: "ACH";
+    readonly Bank: "BANK";
+    readonly Card: "CARD";
+};
+export type TransactionsRecordEntityPaymentMethodEnum = typeof TransactionsRecordEntityPaymentMethodEnum[keyof typeof TransactionsRecordEntityPaymentMethodEnum];
+/**
+ * @export
+ */
+export declare const TransactionsRecordEntityAccountTypeEnum: {
+    readonly Checking: "CHECKING";
+    readonly Savings: "SAVINGS";
+};
+export type TransactionsRecordEntityAccountTypeEnum = typeof TransactionsRecordEntityAccountTypeEnum[keyof typeof TransactionsRecordEntityAccountTypeEnum];
+/**
+ * @export
+ */
+export declare const TransactionsRecordEntityIntentEnum: {
+    readonly Capture: "capture";
+    readonly Authorize: "authorize";
+    readonly Debit: "debit";
+    readonly Credit: "credit";
+};
+export type TransactionsRecordEntityIntentEnum = typeof TransactionsRecordEntityIntentEnum[keyof typeof TransactionsRecordEntityIntentEnum];
+/**
+ * @export
+ */
+export declare const TransactionsRecordEntityCurrencyEnum: {
+    readonly Usd: "USD";
+    readonly Cad: "CAD";
+    readonly Aud: "AUD";
+};
+export type TransactionsRecordEntityCurrencyEnum = typeof TransactionsRecordEntityCurrencyEnum[keyof typeof TransactionsRecordEntityCurrencyEnum];
+/**
+ * @export
+ */
+export declare const TransactionsRecordEntityCardTypeEnum: {
+    readonly Credit: "CREDIT";
+    readonly Debit: "DEBIT";
+    readonly Prepaid: "PREPAID";
+};
+export type TransactionsRecordEntityCardTypeEnum = typeof TransactionsRecordEntityCardTypeEnum[keyof typeof TransactionsRecordEntityCardTypeEnum];
+/**
+ * Check if a given object implements the TransactionsRecordEntity interface.
+ */
+export declare function instanceOfTransactionsRecordEntity(value: object): boolean;
+export declare function TransactionsRecordEntityFromJSON(json: any): TransactionsRecordEntity;
+export declare function TransactionsRecordEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionsRecordEntity;
+export declare function TransactionsRecordEntityToJSON(value?: TransactionsRecordEntity | null): any;

package/dist/mjs/models/TransactionsRecordEntity.js

@@ -0,0 +1,181 @@
+/* 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 TransactionsRecordEntityStatusEnum = {
+    Processing: 'processing',
+    BuyerApprovalPending: 'buyerApprovalPending',
+    Authorized: 'authorized',
+    AuthorizationFailed: 'authorizationFailed',
+    CaptureFailed: 'captureFailed',
+    Declined: 'declined',
+    CapturePending: 'capturePending',
+    Captured: 'captured',
+    VoidPending: 'voidPending',
+    Voided: 'voided',
+    Hold: 'hold',
+    Submitted: 'submitted',
+    Transmitted: 'transmitted',
+    Settled: 'settled',
+    Returned: 'returned',
+    Rejected: 'rejected'
+};
+/**
+ * @export
+ */
+export const TransactionsRecordEntityPaymentMethodEnum = {
+    Ach: 'ACH',
+    Bank: 'BANK',
+    Card: 'CARD'
+};
+/**
+ * @export
+ */
+export const TransactionsRecordEntityAccountTypeEnum = {
+    Checking: 'CHECKING',
+    Savings: 'SAVINGS'
+};
+/**
+ * @export
+ */
+export const TransactionsRecordEntityIntentEnum = {
+    Capture: 'capture',
+    Authorize: 'authorize',
+    Debit: 'debit',
+    Credit: 'credit'
+};
+/**
+ * @export
+ */
+export const TransactionsRecordEntityCurrencyEnum = {
+    Usd: 'USD',
+    Cad: 'CAD',
+    Aud: 'AUD'
+};
+/**
+ * @export
+ */
+export const TransactionsRecordEntityCardTypeEnum = {
+    Credit: 'CREDIT',
+    Debit: 'DEBIT',
+    Prepaid: 'PREPAID'
+};
+/**
+ * Check if a given object implements the TransactionsRecordEntity interface.
+ */
+export function instanceOfTransactionsRecordEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "merchantId" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "transactionId" in value;
+    isInstance = isInstance && "status" in value;
+    isInstance = isInstance && "amount" in value;
+    isInstance = isInstance && "paymentMethod" in value;
+    isInstance = isInstance && "netAmount" in value;
+    isInstance = isInstance && "fee" in value;
+    isInstance = isInstance && "intent" in value;
+    isInstance = isInstance && "currency" in value;
+    isInstance = isInstance && "country" in value;
+    return isInstance;
+}
+export function TransactionsRecordEntityFromJSON(json) {
+    return TransactionsRecordEntityFromJSONTyped(json, false);
+}
+export function TransactionsRecordEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'merchantId': json['merchantId'],
+        'createdAt': (new Date(json['createdAt'])),
+        'transactionId': json['transactionId'],
+        'status': json['status'],
+        'amount': json['amount'],
+        'paymentMethod': json['paymentMethod'],
+        'accountType': !exists(json, 'accountType') ? undefined : json['accountType'],
+        'externalTransactionId': !exists(json, 'externalTransactionId') ? undefined : json['externalTransactionId'],
+        'netAmount': json['netAmount'],
+        'fee': json['fee'],
+        'intent': json['intent'],
+        'capturedAt': !exists(json, 'capturedAt') ? undefined : (new Date(json['capturedAt'])),
+        'authorizedAt': !exists(json, 'authorizedAt') ? undefined : (new Date(json['authorizedAt'])),
+        'rejectedAt': !exists(json, 'rejectedAt') ? undefined : (new Date(json['rejectedAt'])),
+        'returnedAt': !exists(json, 'returnedAt') ? undefined : (new Date(json['returnedAt'])),
+        'settledAt': !exists(json, 'settledAt') ? undefined : (new Date(json['settledAt'])),
+        'updatedAt': !exists(json, 'updatedAt') ? undefined : (new Date(json['updatedAt'])),
+        'voidedAt': !exists(json, 'voidedAt') ? undefined : (new Date(json['voidedAt'])),
+        'capturedAmount': !exists(json, 'capturedAmount') ? undefined : json['capturedAmount'],
+        'refundedAmount': !exists(json, 'refundedAmount') ? undefined : json['refundedAmount'],
+        'currency': json['currency'],
+        'country': json['country'],
+        'buyerId': !exists(json, 'buyerId') ? undefined : json['buyerId'],
+        'externalBuyerId': !exists(json, 'externalBuyerId') ? undefined : json['externalBuyerId'],
+        'cardType': !exists(json, 'cardType') ? undefined : json['cardType'],
+        'label': !exists(json, 'label') ? undefined : json['label'],
+        'scheme': !exists(json, 'scheme') ? undefined : json['scheme'],
+        'expirationDate': !exists(json, 'expirationDate') ? undefined : json['expirationDate'],
+        'accountHolderName': !exists(json, 'accountHolderName') ? undefined : json['accountHolderName'],
+        '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'],
+        'sessionId': !exists(json, 'sessionId') ? undefined : json['sessionId'],
+        'accountEnding': !exists(json, 'accountEnding') ? undefined : json['accountEnding'],
+        'tags': !exists(json, 'tags') ? undefined : json['tags'],
+    };
+    return removeNullUndefined(typed);
+}
+export function TransactionsRecordEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'merchantId': value.merchantId,
+        'createdAt': (value.createdAt.toISOString()),
+        'transactionId': value.transactionId,
+        'status': value.status,
+        'amount': value.amount,
+        'paymentMethod': value.paymentMethod,
+        'accountType': value.accountType,
+        'externalTransactionId': value.externalTransactionId,
+        'netAmount': value.netAmount,
+        'fee': value.fee,
+        'intent': value.intent,
+        'capturedAt': value.capturedAt === undefined ? undefined : (value.capturedAt.toISOString()),
+        'authorizedAt': value.authorizedAt === undefined ? undefined : (value.authorizedAt.toISOString()),
+        'rejectedAt': value.rejectedAt === undefined ? undefined : (value.rejectedAt.toISOString()),
+        'returnedAt': value.returnedAt === undefined ? undefined : (value.returnedAt.toISOString()),
+        'settledAt': value.settledAt === undefined ? undefined : (value.settledAt.toISOString()),
+        'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt.toISOString()),
+        'voidedAt': value.voidedAt === undefined ? undefined : (value.voidedAt.toISOString()),
+        'capturedAmount': value.capturedAmount,
+        'refundedAmount': value.refundedAmount,
+        'currency': value.currency,
+        'country': value.country,
+        'buyerId': value.buyerId,
+        'externalBuyerId': value.externalBuyerId,
+        'cardType': value.cardType,
+        'label': value.label,
+        'scheme': value.scheme,
+        'expirationDate': value.expirationDate,
+        'accountHolderName': value.accountHolderName,
+        'rawResponseCode': value.rawResponseCode,
+        'rawResponseDescription': value.rawResponseDescription,
+        'avsResponseCode': value.avsResponseCode,
+        'cvvResponseCode': value.cvvResponseCode,
+        'sessionId': value.sessionId,
+        'accountEnding': value.accountEnding,
+        'tags': value.tags,
+    };
+}

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

@@ -0,0 +1,171 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import type { ReportCreatorEntity } from './ReportCreatorEntity';
+import type { TransactionsReportsFiltersEntity } from './TransactionsReportsFiltersEntity';
+/**
+ *
+ * @export
+ * @interface TransactionsReportEntity
+ */
+export interface TransactionsReportEntity {
+    /**
+     * The report ID.
+     * @type {string}
+     * @memberof TransactionsReportEntity
+     */
+    reportId: string;
+    /**
+     * The name of the report.
+     * @type {string}
+     * @memberof TransactionsReportEntity
+     */
+    name: string;
+    /**
+     * The description of the report.
+     * @type {string}
+     * @memberof TransactionsReportEntity
+     */
+    description?: string;
+    /**
+     * The merchant ID that stores this report template.
+     * @type {string}
+     * @memberof TransactionsReportEntity
+     */
+    merchantId: string;
+    /**
+     * The ID of the user who created the report.
+     * @type {ReportCreatorEntity}
+     * @memberof TransactionsReportEntity
+     */
+    createdBy: ReportCreatorEntity;
+    /**
+     * The report created date.
+     * @type {Date}
+     * @memberof TransactionsReportEntity
+     */
+    createdAt: Date;
+    /**
+     * The report last updated date.
+     * @type {Date}
+     * @memberof TransactionsReportEntity
+     */
+    updatedAt: Date;
+    /**
+     * The report deleted date.
+     * @type {Date}
+     * @memberof TransactionsReportEntity
+     */
+    deletedAt: Date;
+    /**
+     * Whether the report record is deleted or not.
+     * @type {boolean}
+     * @memberof TransactionsReportEntity
+     */
+    deleted?: boolean;
+    /**
+     * The start date for the date filter.
+     * @type {string}
+     * @memberof TransactionsReportEntity
+     */
+    startDate: string;
+    /**
+     * The end date for the date filter.
+     * @type {string}
+     * @memberof TransactionsReportEntity
+     */
+    endDate: string;
+    /**
+     * The status of the report.
+     * @type {string}
+     * @memberof TransactionsReportEntity
+     */
+    status: TransactionsReportEntityStatusEnum;
+    /**
+     * The sorting order of the report.
+     * @type {string}
+     * @memberof TransactionsReportEntity
+     */
+    order: TransactionsReportEntityOrderEnum;
+    /**
+     * The recipients of this report.
+     * @type {Array<string>}
+     * @memberof TransactionsReportEntity
+     */
+    recipients: Array<string>;
+    /**
+     * The date range applied for this report.
+     * @type {string}
+     * @memberof TransactionsReportEntity
+     */
+    dateRange: TransactionsReportEntityDateRangeEnum;
+    /**
+     * The start time for this report.
+     * @type {string}
+     * @memberof TransactionsReportEntity
+     */
+    startTime: string;
+    /**
+     * The end time for this report.
+     * @type {string}
+     * @memberof TransactionsReportEntity
+     */
+    endTime: string;
+    /**
+     * The columns associated to this report.
+     * @type {Array<string>}
+     * @memberof TransactionsReportEntity
+     */
+    columns: Array<string>;
+    /**
+     * The filters associated to this report.
+     * @type {TransactionsReportsFiltersEntity}
+     * @memberof TransactionsReportEntity
+     */
+    transactionsFilters: TransactionsReportsFiltersEntity;
+}
+/**
+ * @export
+ */
+export declare const TransactionsReportEntityStatusEnum: {
+    readonly Pending: "PENDING";
+    readonly Processing: "PROCESSING";
+    readonly Generated: "GENERATED";
+    readonly Failed: "FAILED";
+};
+export type TransactionsReportEntityStatusEnum = typeof TransactionsReportEntityStatusEnum[keyof typeof TransactionsReportEntityStatusEnum];
+/**
+ * @export
+ */
+export declare const TransactionsReportEntityOrderEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type TransactionsReportEntityOrderEnum = typeof TransactionsReportEntityOrderEnum[keyof typeof TransactionsReportEntityOrderEnum];
+/**
+ * @export
+ */
+export declare const TransactionsReportEntityDateRangeEnum: {
+    readonly Today: "TODAY";
+    readonly Yesterday: "YESTERDAY";
+    readonly Last7Days: "LAST_7_DAYS";
+    readonly Last30Days: "LAST_30_DAYS";
+    readonly Last60Days: "LAST_60_DAYS";
+    readonly Last90Days: "LAST_90_DAYS";
+    readonly LastWeek: "LAST_WEEK";
+    readonly LastMonth: "LAST_MONTH";
+    readonly LastQuarter: "LAST_QUARTER";
+    readonly LastYear: "LAST_YEAR";
+    readonly Custom: "CUSTOM";
+};
+export type TransactionsReportEntityDateRangeEnum = typeof TransactionsReportEntityDateRangeEnum[keyof typeof TransactionsReportEntityDateRangeEnum];
+/**
+ * Check if a given object implements the TransactionsReportEntity interface.
+ */
+export declare function instanceOfTransactionsReportEntity(value: object): boolean;
+export declare function TransactionsReportEntityFromJSON(json: any): TransactionsReportEntity;
+export declare function TransactionsReportEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionsReportEntity;
+export declare function TransactionsReportEntityToJSON(value?: TransactionsReportEntity | null): any;