@channelpayments/node-sdk 1.24.0

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

@@ -0,0 +1,62 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ * The address
+ * @export
+ * @interface BuyerEntityAddress
+ */
+export interface BuyerEntityAddress {
+    /**
+     * The city of the address
+     * @type {string}
+     * @memberof BuyerEntityAddress
+     */
+    city: string;
+    /**
+     * The country code of the address
+     * @type {string}
+     * @memberof BuyerEntityAddress
+     */
+    countryCode: string;
+    /**
+     * The postal code of the address
+     * @type {string}
+     * @memberof BuyerEntityAddress
+     */
+    postalCode: string;
+    /**
+     * The subdivision (state, province, or region) of the address
+     * @type {string}
+     * @memberof BuyerEntityAddress
+     */
+    subdivision: string;
+    /**
+     * The street address of the address
+     * @type {string}
+     * @memberof BuyerEntityAddress
+     */
+    streetAddress: string;
+    /**
+     * The optional second line of the street address
+     * @type {string}
+     * @memberof BuyerEntityAddress
+     */
+    streetAddress2?: string;
+    /**
+     * The optional subdivision code of the address
+     * @type {string}
+     * @memberof BuyerEntityAddress
+     */
+    subdivisionCode?: string;
+}
+/**
+ * Check if a given object implements the BuyerEntityAddress interface.
+ */
+export declare function instanceOfBuyerEntityAddress(value: object): boolean;
+export declare function BuyerEntityAddressFromJSON(json: any): BuyerEntityAddress;
+export declare function BuyerEntityAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): BuyerEntityAddress;
+export declare function BuyerEntityAddressToJSON(value?: BuyerEntityAddress | null): any;

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

@@ -0,0 +1,56 @@
+/* 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 BuyerEntityAddress interface.
+ */
+export function instanceOfBuyerEntityAddress(value) {
+    let isInstance = true;
+    isInstance = isInstance && "city" in value;
+    isInstance = isInstance && "countryCode" in value;
+    isInstance = isInstance && "postalCode" in value;
+    isInstance = isInstance && "subdivision" in value;
+    isInstance = isInstance && "streetAddress" in value;
+    return isInstance;
+}
+export function BuyerEntityAddressFromJSON(json) {
+    return BuyerEntityAddressFromJSONTyped(json, false);
+}
+export function BuyerEntityAddressFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'city': json['city'],
+        'countryCode': json['countryCode'],
+        'postalCode': json['postalCode'],
+        'subdivision': json['subdivision'],
+        'streetAddress': json['streetAddress'],
+        'streetAddress2': !exists(json, 'streetAddress2') ? undefined : json['streetAddress2'],
+        'subdivisionCode': !exists(json, 'subdivisionCode') ? undefined : json['subdivisionCode'],
+    };
+    return removeNullUndefined(typed);
+}
+export function BuyerEntityAddressToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'city': value.city,
+        'countryCode': value.countryCode,
+        'postalCode': value.postalCode,
+        'subdivision': value.subdivision,
+        'streetAddress': value.streetAddress,
+        'streetAddress2': value.streetAddress2,
+        'subdivisionCode': value.subdivisionCode,
+    };
+}

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

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

package/dist/mjs/src/models/BuyersSearchEntity.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 { BuyerEntityFromJSON, BuyerEntityToJSON, } from './BuyerEntity';
+/**
+ * Check if a given object implements the BuyersSearchEntity interface.
+ */
+export function instanceOfBuyersSearchEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "prevCursor" in value;
+    isInstance = isInstance && "buyers" in value;
+    isInstance = isInstance && "limit" in value;
+    return isInstance;
+}
+export function BuyersSearchEntityFromJSON(json) {
+    return BuyersSearchEntityFromJSONTyped(json, false);
+}
+export function BuyersSearchEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'prevCursor': json['prevCursor'],
+        'buyers': (json['buyers'].map(BuyerEntityFromJSON)),
+        'limit': json['limit'],
+        'nextCursor': !exists(json, 'nextCursor') ? undefined : json['nextCursor'],
+        'page': !exists(json, 'page') ? undefined : json['page'],
+    };
+    return removeNullUndefined(typed);
+}
+export function BuyersSearchEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'prevCursor': value.prevCursor,
+        'buyers': (value.buyers.map(BuyerEntityToJSON)),
+        'limit': value.limit,
+        'nextCursor': value.nextCursor,
+        'page': value.page,
+    };
+}

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

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

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

@@ -0,0 +1,50 @@
+/* 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 CFeeDtoTypeEnum = {
+    Percentage: 'PERCENTAGE',
+    Fixed: 'FIXED'
+};
+/**
+ * Check if a given object implements the CFeeDto interface.
+ */
+export function instanceOfCFeeDto(value) {
+    let isInstance = true;
+    isInstance = isInstance && "type" in value;
+    isInstance = isInstance && "rate" in value;
+    return isInstance;
+}
+export function CFeeDtoFromJSON(json) {
+    return CFeeDtoFromJSONTyped(json, false);
+}
+export function CFeeDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'type': json['type'],
+        'rate': json['rate'],
+    };
+    return removeNullUndefined(typed);
+}
+export function CFeeDtoToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'type': value.type,
+        'rate': value.rate,
+    };
+}

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

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

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

@@ -0,0 +1,50 @@
+/* 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 CFeeEntityTypeEnum = {
+    Percentage: 'PERCENTAGE',
+    Fixed: 'FIXED'
+};
+/**
+ * Check if a given object implements the CFeeEntity interface.
+ */
+export function instanceOfCFeeEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "type" in value;
+    isInstance = isInstance && "rate" in value;
+    return isInstance;
+}
+export function CFeeEntityFromJSON(json) {
+    return CFeeEntityFromJSONTyped(json, false);
+}
+export function CFeeEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'type': json['type'],
+        'rate': json['rate'],
+    };
+    return removeNullUndefined(typed);
+}
+export function CFeeEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'type': value.type,
+        'rate': value.rate,
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ *
+ * @export
+ * @interface CaptureTransactionDto
+ */
+export interface CaptureTransactionDto {
+    /**
+     * The transaction ID.
+     * @type {string}
+     * @memberof CaptureTransactionDto
+     */
+    transactionId: string;
+    /**
+     * The transaction amount.
+     * @type {number}
+     * @memberof CaptureTransactionDto
+     */
+    amount: number;
+}
+/**
+ * Check if a given object implements the CaptureTransactionDto interface.
+ */
+export declare function instanceOfCaptureTransactionDto(value: object): boolean;
+export declare function CaptureTransactionDtoFromJSON(json: any): CaptureTransactionDto;
+export declare function CaptureTransactionDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CaptureTransactionDto;
+export declare function CaptureTransactionDtoToJSON(value?: CaptureTransactionDto | null): any;

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

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import { removeNullUndefined } from '../runtime';
+/**
+ * Check if a given object implements the CaptureTransactionDto interface.
+ */
+export function instanceOfCaptureTransactionDto(value) {
+    let isInstance = true;
+    isInstance = isInstance && "transactionId" in value;
+    isInstance = isInstance && "amount" in value;
+    return isInstance;
+}
+export function CaptureTransactionDtoFromJSON(json) {
+    return CaptureTransactionDtoFromJSONTyped(json, false);
+}
+export function CaptureTransactionDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'transactionId': json['transactionId'],
+        'amount': json['amount'],
+    };
+    return removeNullUndefined(typed);
+}
+export function CaptureTransactionDtoToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'transactionId': value.transactionId,
+        'amount': value.amount,
+    };
+}

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

@@ -0,0 +1,59 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ *
+ * @export
+ * @interface CardDetails
+ */
+export interface CardDetails {
+    /**
+     * The card type
+     * @type {string}
+     * @memberof CardDetails
+     */
+    type: CardDetailsTypeEnum;
+    /**
+     * The card BIN
+     * @type {string}
+     * @memberof CardDetails
+     */
+    bin: string;
+    /**
+     * The card scheme
+     * @type {string}
+     * @memberof CardDetails
+     */
+    scheme: string;
+    /**
+     * The last 4 digits of the card
+     * @type {string}
+     * @memberof CardDetails
+     */
+    label: string;
+    /**
+     * The card expiration date
+     * @type {string}
+     * @memberof CardDetails
+     */
+    expirationDate: string;
+}
+/**
+ * @export
+ */
+export declare const CardDetailsTypeEnum: {
+    readonly Credit: "credit";
+    readonly Debit: "debit";
+    readonly Prepaid: "prepaid";
+};
+export type CardDetailsTypeEnum = typeof CardDetailsTypeEnum[keyof typeof CardDetailsTypeEnum];
+/**
+ * Check if a given object implements the CardDetails interface.
+ */
+export declare function instanceOfCardDetails(value: object): boolean;
+export declare function CardDetailsFromJSON(json: any): CardDetails;
+export declare function CardDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CardDetails;
+export declare function CardDetailsToJSON(value?: CardDetails | null): any;

package/dist/mjs/src/models/CardDetails.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 CardDetailsTypeEnum = {
+    Credit: 'credit',
+    Debit: 'debit',
+    Prepaid: 'prepaid'
+};
+/**
+ * Check if a given object implements the CardDetails interface.
+ */
+export function instanceOfCardDetails(value) {
+    let isInstance = true;
+    isInstance = isInstance && "type" in value;
+    isInstance = isInstance && "bin" in value;
+    isInstance = isInstance && "scheme" in value;
+    isInstance = isInstance && "label" in value;
+    isInstance = isInstance && "expirationDate" in value;
+    return isInstance;
+}
+export function CardDetailsFromJSON(json) {
+    return CardDetailsFromJSONTyped(json, false);
+}
+export function CardDetailsFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'type': json['type'],
+        'bin': json['bin'],
+        'scheme': json['scheme'],
+        'label': json['label'],
+        'expirationDate': json['expirationDate'],
+    };
+    return removeNullUndefined(typed);
+}
+export function CardDetailsToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'type': value.type,
+        'bin': value.bin,
+        'scheme': value.scheme,
+        'label': value.label,
+        'expirationDate': value.expirationDate,
+    };
+}

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

@@ -0,0 +1,57 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import type { CreateBuyerDtoAddress } from './CreateBuyerDtoAddress';
+/**
+ *
+ * @export
+ * @interface CreateBuyerDto
+ */
+export interface CreateBuyerDto {
+    /**
+     * The given name of the buyer
+     * @type {string}
+     * @memberof CreateBuyerDto
+     */
+    givenName: string;
+    /**
+     * The family name of the buyer
+     * @type {string}
+     * @memberof CreateBuyerDto
+     */
+    familyName: string;
+    /**
+     * The email address of the buyer
+     * @type {string}
+     * @memberof CreateBuyerDto
+     */
+    email: string;
+    /**
+     *
+     * @type {CreateBuyerDtoAddress}
+     * @memberof CreateBuyerDto
+     */
+    address: CreateBuyerDtoAddress;
+    /**
+     * The phone number of the buyer
+     * @type {string}
+     * @memberof CreateBuyerDto
+     */
+    phoneNumber?: string;
+    /**
+     * The merchant-issued ID for the buyer. Must be unique to the buyer
+     * @type {string}
+     * @memberof CreateBuyerDto
+     */
+    externalBuyerId?: string;
+}
+/**
+ * Check if a given object implements the CreateBuyerDto interface.
+ */
+export declare function instanceOfCreateBuyerDto(value: object): boolean;
+export declare function CreateBuyerDtoFromJSON(json: any): CreateBuyerDto;
+export declare function CreateBuyerDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateBuyerDto;
+export declare function CreateBuyerDtoToJSON(value?: CreateBuyerDto | null): any;