globalpayments-api 3.1.0 → 3.2.0

package/lib/src/Entities/ProFac/UserPersonalData.d.ts

@@ -0,0 +1,26 @@
+import { Address } from "../Address";
+export declare class UserPersonalData {
+    firstName: string;
+    middleInitial: string;
+    lastName: string;
+    dateOfBirth: string;
+    sSN: string;
+    sourceEmail: string;
+    dayPhone: string;
+    eveningPhone: string;
+    notificationEmail: string;
+    currencyCode: string;
+    tier: string;
+    externalID: string;
+    phonePIN: string;
+    userID: string;
+    ipSignup: string;
+    uSCitizen: boolean;
+    bOAttestation: boolean;
+    termsAcceptanceIP: string;
+    termsAcceptanceTimeStamp: string;
+    termsVersion: number;
+    userAddress: Address;
+    mailingAddress: Address;
+    UserPersonalData(): void;
+}

package/lib/src/Entities/ProFac/UserPersonalData.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserPersonalData = void 0;
+const Address_1 = require("../Address");
+class UserPersonalData {
+    /// <summary>
+    /// Merchant/Individual first name
+    /// </summary>
+    firstName;
+    /// <summary>
+    /// Merchant/Individual middle initial
+    /// </summary>
+    middleInitial;
+    /// <summary>
+    /// Merchant/Individual lane name
+    /// </summary>
+    lastName;
+    /// <summary>
+    /// Merchant/Individual date of birth. Must be in 'mm-dd-yyyy' format. Individual must be 18+ to obtain an account. The value 01-01-1981 will give a successul response. All others will return a Status 66 (Failed KYC).
+    /// </summary>
+    dateOfBirth;
+    /// <summary>
+    /// Merchant/Individual social security number. Must be 9 characters without dashes. Required for USA when using personal validation. If business validated, do not pass!
+    /// </summary>
+    sSN;
+    /// <summary>
+    /// Merchant/Individual email address. Must be unique in ProPay system. ProPay's system will send automated emails to the email address on file unless NotificationEmail is provided. This value is truncated beyond 55 characters.
+    /// </summary>
+    sourceEmail;
+    /// <summary>
+    /// Merchant/Individual day phone number. For USA, CAN, NZL, and AUS value must be 10 characters
+    /// </summary>
+    dayPhone;
+    /// <summary>
+    /// Merchant/Individual evening phone number. For USA, CAN, NZL, and AUS value must be 10 characters
+    /// </summary>
+    eveningPhone;
+    /// <summary>
+    /// Communication email address. ProPay's system will send automated emails to the email address on file rather than the source email
+    /// </summary>
+    notificationEmail;
+    /// <summary>
+    /// Required to specify the currency in which funds should be held, if other than USD. An affiliation must be granted permission to create accounts in currencies other than USD. ISO 4217 standard 3 character currency code.
+    /// </summary>
+    currencyCode;
+    /// <summary>
+    /// One of the previously assigned merchant tiers. If not provided, will default to cheapest available tier.
+    /// </summary>
+    tier;
+    /// <summary>
+    /// This is a partner's own unique identifier. Typically used as the distributor or consultant ID
+    /// </summary>
+    externalID;
+    /// <summary>
+    ///  Numeric value which will give a user access to ProPay's IVR system. Can also be used to reset password
+    /// </summary>
+    phonePIN;
+    /// <summary>
+    /// ProPay account username. Must be unique in ProPay system. Username defaults to <sourceEmail> if userId is not provided
+    /// </summary>
+    userID;
+    ipSignup;
+    uSCitizen;
+    bOAttestation;
+    termsAcceptanceIP;
+    termsAcceptanceTimeStamp;
+    termsVersion;
+    /// <summary>
+    /// Merchant/Individual address
+    /// </summary>
+    userAddress;
+    /// <summary>
+    /// Business physical address
+    /// </summary>
+    mailingAddress;
+    UserPersonalData() {
+        this.userAddress = new Address_1.Address();
+        this.mailingAddress = new Address_1.Address();
+    }
+}
+exports.UserPersonalData = UserPersonalData;
+//# sourceMappingURL=UserPersonalData.js.map

package/lib/src/Entities/ProFac/UserPersonalData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserPersonalData.js","sourceRoot":"","sources":["../../../../src/Entities/ProFac/UserPersonalData.ts"],"names":[],"mappings":";;;AAAA,wCAAqC;AAErC,MAAa,gBAAgB;IAC3B,aAAa;IACb,kCAAkC;IAClC,cAAc;IACP,SAAS,CAAS;IACzB,aAAa;IACb,sCAAsC;IACtC,cAAc;IACP,aAAa,CAAS;IAC7B,aAAa;IACb,iCAAiC;IACjC,cAAc;IACP,QAAQ,CAAS;IACxB,aAAa;IACb,yNAAyN;IACzN,cAAc;IACP,WAAW,CAAS;IAC3B,aAAa;IACb,yKAAyK;IACzK,cAAc;IACP,GAAG,CAAS;IACnB,aAAa;IACb,mOAAmO;IACnO,cAAc;IACP,WAAW,CAAS;IAC3B,aAAa;IACb,gGAAgG;IAChG,cAAc;IACP,QAAQ,CAAS;IACxB,aAAa;IACb,oGAAoG;IACpG,cAAc;IACP,YAAY,CAAS;IAC5B,aAAa;IACb,qIAAqI;IACrI,cAAc;IACP,iBAAiB,CAAS;IACjC,aAAa;IACb,8NAA8N;IAC9N,cAAc;IACP,YAAY,CAAS;IAC5B,aAAa;IACb,4GAA4G;IAC5G,cAAc;IACP,IAAI,CAAS;IACpB,aAAa;IACb,iGAAiG;IACjG,cAAc;IACP,UAAU,CAAS;IAC1B,aAAa;IACb,2GAA2G;IAC3G,cAAc;IACP,QAAQ,CAAS;IACxB,aAAa;IACb,0HAA0H;IAC1H,cAAc;IACP,MAAM,CAAS;IACf,QAAQ,CAAS;IACjB,SAAS,CAAU;IACnB,aAAa,CAAU;IACvB,iBAAiB,CAAS;IAC1B,wBAAwB,CAAS;IACjC,YAAY,CAAS;IAC5B,aAAa;IACb,+BAA+B;IAC/B,cAAc;IACP,WAAW,CAAU;IAC5B,aAAa;IACb,6BAA6B;IAC7B,cAAc;IACP,cAAc,CAAU;IAExB,gBAAgB;QACrB,IAAI,CAAC,WAAW,GAAG,IAAI,iBAAO,EAAE,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAO,EAAE,CAAC;IACtC,CAAC;CACF;AA5ED,4CA4EC"}

package/lib/src/Entities/RecurringEntity.d.ts

@@ -0,0 +1,14 @@
+export interface IRecurringEntity {
+    id: string;
+    key: string;
+}
+export declare class RecurringEntity<TResult extends IRecurringEntity> implements IRecurringEntity {
+    id: string;
+    key: string;
+    static find<TResult extends IRecurringEntity>(id: string, configName?: string): Promise<TResult | undefined>;
+    static findAll<TResult extends IRecurringEntity>(configName?: string): Promise<TResult>;
+    private static getIdentifierName;
+    create(configName?: string): Promise<TResult>;
+    delete(configName?: string): Promise<TResult>;
+    saveChanges(configName?: string): Promise<TResult>;
+}

package/lib/src/Entities/RecurringEntity.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecurringEntity = void 0;
+/* eslint-disable indent */
+const __1 = require("../");
+class RecurringEntity {
+    /// <summary>
+    /// All resource should be supplied a merchant-/application-defined ID.
+    /// </summary>
+    id;
+    /// <summary>
+    /// All resources should be supplied a gateway-defined ID.
+    /// </summary>
+    key;
+    /// <summary>
+    /// Searches for a specific record by `id`.
+    /// </summary>
+    /// <param name="id">The ID of the record to find</summary>
+    /// <returns>`TResult` or `null` if the record cannot be found.</returns>
+    /// <exception cref="UnsupportedTransactionError">
+    /// Thrown when gateway does not support retrieving recurring records.
+    /// </exception>
+    static find(id, configName = "default") {
+        const client = __1.ServicesContainer.instance().getRecurringClient(configName);
+        if (!client.supportsRetrieval) {
+            throw new __1.UnsupportedTransactionError();
+        }
+        const identifier = RecurringEntity.getIdentifierName(this);
+        return __1.RecurringService.search(this)
+            .addSearchCriteria(identifier, id)
+            .execute(configName)
+            .then((response) => {
+            if (!response) {
+                return;
+            }
+            const entity = response[0] || response;
+            if (entity && entity?.length) {
+                return __1.RecurringService.get(entity, configName);
+            }
+            return;
+        });
+    }
+    /// <summary>
+    /// Lists all records of type `TResult`.
+    /// </summary>
+    /// <exception cref="UnsupportedTransactionError">
+    /// Thrown when gateway does not support retrieving recurring records.
+    /// </exception>
+    static findAll(configName = "default") {
+        const client = __1.ServicesContainer.instance().getRecurringClient();
+        if (client.supportsRetrieval) {
+            return __1.RecurringService.search(this).execute(configName);
+        }
+        throw new __1.UnsupportedTransactionError();
+    }
+    static getIdentifierName(fn) {
+        if (fn.name === "Customer") {
+            return "customerIdentifier";
+        }
+        else if (fn.name === "RecurringPaymentMethod") {
+            return "paymentMethodIdentifier";
+        }
+        return "scheduleIdentifier";
+    }
+    /// <summary>
+    /// Creates a resource
+    /// </summary>
+    /// <returns>TResult</returns>
+    create(configName = "default") {
+        return __1.RecurringService.create(this, configName);
+    }
+    /// <summary>
+    /// Delete a record from the gateway.
+    /// </summary>
+    /// <param name="force">Indicates if the deletion should be forced</summary>
+    /// <exception cref="ApiException">Thrown when the record cannot be deleted.</exception>
+    delete(configName = "default") {
+        return __1.RecurringService.delete(this, configName);
+    }
+    /// <summary>
+    /// The current record should be updated.
+    /// </summary>
+    /// <remarks>
+    /// Any modified properties will be persisted with the gateway.
+    /// </remarks>
+    /// <exception cref="ApiException">Thrown when the record cannot be updated.</exception>
+    saveChanges(configName = "default") {
+        return __1.RecurringService.edit(this, configName);
+    }
+}
+exports.RecurringEntity = RecurringEntity;
+//# sourceMappingURL=RecurringEntity.js.map

package/lib/src/Entities/RecurringEntity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecurringEntity.js","sourceRoot":"","sources":["../../../src/Entities/RecurringEntity.ts"],"names":[],"mappings":";;;AAAA,2BAA2B;AAC3B,2BAIa;AAOb,MAAa,eAAe;IAG1B,aAAa;IACb,uEAAuE;IACvE,cAAc;IACP,EAAE,CAAS;IAElB,aAAa;IACb,0DAA0D;IAC1D,cAAc;IACP,GAAG,CAAS;IAEnB,aAAa;IACb,2CAA2C;IAC3C,cAAc;IACd,2DAA2D;IAC3D,yEAAyE;IACzE,kDAAkD;IAClD,sEAAsE;IACtE,gBAAgB;IACT,MAAM,CAAC,IAAI,CAChB,EAAU,EACV,aAAqB,SAAS;QAE9B,MAAM,MAAM,GAAG,qBAAiB,CAAC,QAAQ,EAAE,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC3E,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;YAC7B,MAAM,IAAI,+BAA2B,EAAE,CAAC;SACzC;QAED,MAAM,UAAU,GAAG,eAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC3D,OAAO,oBAAgB,CAAC,MAAM,CAAU,IAAI,CAAC;aAC1C,iBAAiB,CAAC,UAAU,EAAE,EAAE,CAAC;aACjC,OAAO,CAAC,UAAU,CAAC;aACnB,IAAI,CAAC,CAAC,QAAyB,EAAE,EAAE;YAClC,IAAI,CAAC,QAAQ,EAAE;gBACb,OAAO;aACR;YACD,MAAM,MAAM,GAAI,QAAgB,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC;YAChD,IAAI,MAAM,IAAI,MAAM,EAAE,MAAM,EAAE;gBAC5B,OAAO,oBAAgB,CAAC,GAAG,CAAU,MAAM,EAAE,UAAU,CAAC,CAAC;aAC1D;YACD,OAAO;QACT,CAAC,CAAC,CAAC;IACP,CAAC;IAED,aAAa;IACb,wCAAwC;IACxC,cAAc;IACd,kDAAkD;IAClD,sEAAsE;IACtE,gBAAgB;IACT,MAAM,CAAC,OAAO,CACnB,aAAqB,SAAS;QAE9B,MAAM,MAAM,GAAG,qBAAiB,CAAC,QAAQ,EAAE,CAAC,kBAAkB,EAAE,CAAC;QACjE,IAAI,MAAM,CAAC,iBAAiB,EAAE;YAC5B,OAAO,oBAAgB,CAAC,MAAM,CAAU,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;SACnE;QACD,MAAM,IAAI,+BAA2B,EAAE,CAAC;IAC1C,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,EAAO;QACtC,IAAI,EAAE,CAAC,IAAI,KAAK,UAAU,EAAE;YAC1B,OAAO,oBAAoB,CAAC;SAC7B;aAAM,IAAI,EAAE,CAAC,IAAI,KAAK,wBAAwB,EAAE;YAC/C,OAAO,yBAAyB,CAAC;SAClC;QAED,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED,aAAa;IACb,sBAAsB;IACtB,cAAc;IACd,8BAA8B;IACvB,MAAM,CAAC,aAAqB,SAAS;QAC1C,OAAO,oBAAgB,CAAC,MAAM,CAAC,IAAsB,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC;IAED,aAAa;IACb,qCAAqC;IACrC,cAAc;IACd,4EAA4E;IAC5E,wFAAwF;IACjF,MAAM,CAAC,aAAqB,SAAS;QAC1C,OAAO,oBAAgB,CAAC,MAAM,CAAC,IAA0B,EAAE,UAAU,CAAC,CAAC;IACzE,CAAC;IAED,aAAa;IACb,yCAAyC;IACzC,cAAc;IACd,aAAa;IACb,+DAA+D;IAC/D,cAAc;IACd,wFAAwF;IACjF,WAAW,CAAC,aAAqB,SAAS;QAC/C,OAAO,oBAAgB,CAAC,IAAI,CAAC,IAAsB,EAAE,UAAU,CAAC,CAAC;IACnE,CAAC;CACF;AAnGD,0CAmGC"}

package/lib/src/Entities/Request.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+import { ParsedUrlQuery } from "querystring";
+export declare class Request {
+    endpoint: string;
+    httpVerb: string;
+    requestBody: string;
+    queryParams: ParsedUrlQuery | undefined;
+    static maskedValues: string[];
+    constructor(endpoint: string, httpVerb: string, requestBody?: string, queryParams?: ParsedUrlQuery);
+}

package/lib/src/Entities/Request.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Request = void 0;
+class Request {
+    endpoint;
+    httpVerb;
+    requestBody;
+    queryParams;
+    static maskedValues;
+    constructor(endpoint, httpVerb, requestBody = "", queryParams) {
+        this.endpoint = endpoint;
+        this.httpVerb = httpVerb;
+        this.requestBody = requestBody;
+        this.queryParams = queryParams;
+    }
+}
+exports.Request = Request;
+//# sourceMappingURL=Request.js.map

package/lib/src/Entities/Request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Request.js","sourceRoot":"","sources":["../../../src/Entities/Request.ts"],"names":[],"mappings":";;;AAEA,MAAa,OAAO;IACX,QAAQ,CAAS;IAEjB,QAAQ,CAAS;IAEjB,WAAW,CAAS;IAEpB,WAAW,CAA6B;IAE/C,MAAM,CAAC,YAAY,CAAW;IAE9B,YACE,QAAgB,EAChB,QAAgB,EAChB,cAAsB,EAAE,EACxB,WAA4B;QAE5B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;CACF;AAtBD,0BAsBC"}

package/lib/src/Entities/SSORequestData.d.ts

@@ -0,0 +1,5 @@
+export declare class SSORequestData {
+    referrerURL: string;
+    iPAddress: string;
+    iPSubnetMask: string;
+}

package/lib/src/Entities/SSORequestData.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SSORequestData = void 0;
+class SSORequestData {
+    /// <summary>
+    /// The ProPay system requires that your single-sign-on originate from the URL originally provided here
+    /// </summary>
+    referrerURL;
+    /// <summary>
+    /// The ProPay system requires that your single-sign-on originate from the URL originally provided here. Can supply a range of class c or more restrictive
+    /// </summary>
+    iPAddress;
+    /// <summary>
+    /// The ProPay system requires that your single-sign-on originate from the URL originally provided here. Can supply a range of class c or more restrictive
+    /// </summary>
+    iPSubnetMask;
+}
+exports.SSORequestData = SSORequestData;
+//# sourceMappingURL=SSORequestData.js.map

package/lib/src/Entities/SSORequestData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SSORequestData.js","sourceRoot":"","sources":["../../../src/Entities/SSORequestData.ts"],"names":[],"mappings":";;;AAAA,MAAa,cAAc;IACzB,aAAa;IACb,uGAAuG;IACvG,cAAc;IACP,WAAW,CAAS;IAC3B,aAAa;IACb,0JAA0J;IAC1J,cAAc;IACP,SAAS,CAAS;IACzB,aAAa;IACb,0JAA0J;IAC1J,cAAc;IACP,YAAY,CAAS;CAC7B;AAbD,wCAaC"}

package/lib/src/Entities/Schedule.d.ts

@@ -0,0 +1,47 @@
+import { EmailReceipt, PaymentSchedule, ScheduleFrequency } from "../";
+import { RecurringEntity } from "./";
+export declare class Schedule extends RecurringEntity<Schedule> {
+    amount: number | string;
+    cancellationDate: Date;
+    currency: string;
+    customerKey: string;
+    description: string;
+    deviceId: number | string;
+    emailNotification: boolean;
+    emailReceipt: EmailReceipt;
+    endDate: Date;
+    frequency: ScheduleFrequency;
+    hasStarted: boolean;
+    invoiceNumber: string;
+    name: string;
+    nextProcessingDate: Date;
+    numberOfPayments: number | string;
+    poNumber: string;
+    paymentKey: string;
+    paymentSchedule: PaymentSchedule;
+    reprocessingCount: number | string;
+    startDate: Date;
+    status: string;
+    taxAmount: number | string;
+    get totalAmount(): number;
+    constructor(customerKey?: string, paymentKey?: string);
+    withAmount(value?: number | string): this;
+    withCurrency(value?: string): this;
+    withCustomerKey(value?: string): this;
+    withDescription(value?: string): this;
+    withDeviceId(value?: number | string): this;
+    withEmailNotification(value?: boolean): this;
+    withEmailReceipt(value?: EmailReceipt): this;
+    withEndDate(value?: Date): this;
+    withFrequency(value?: ScheduleFrequency): this;
+    withInvoiceNumber(value?: string): this;
+    withName(value?: string): this;
+    withNumberOfPayments(value?: number | string): this;
+    withPoNumber(value?: string): this;
+    withPaymentKey(value?: string): this;
+    withPaymentSchedule(value?: PaymentSchedule): this;
+    withReprocessingCount(value?: number | string): this;
+    withStartDate(value?: Date): this;
+    withStatus(value?: string): this;
+    withTaxAmount(value?: number | string): this;
+}

package/lib/src/Entities/Schedule.js

@@ -0,0 +1,325 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schedule = void 0;
+const _1 = require("./");
+class Schedule extends _1.RecurringEntity {
+    /// <summary>
+    /// The schedule's amount
+    /// </summary>
+    amount;
+    /// <summary>
+    /// The date/time the schedule was cancelled.
+    /// </summary>
+    cancellationDate;
+    /// <summary>
+    /// The schedule's currency.
+    /// </summary>
+    currency;
+    /// <summary>
+    /// The identifier of the customer associated
+    /// with the schedule.
+    /// </summary>
+    customerKey;
+    /// <summary>
+    /// The description of the schedule.
+    /// </summary>
+    description;
+    /// <summary>
+    /// The device ID associated with a schedule's
+    /// transactions.
+    /// </summary>
+    deviceId;
+    /// <summary>
+    /// Indicates if email notifications should be sent.
+    /// </summary>
+    emailNotification;
+    /// <summary>
+    /// Indicates when email notifications should be sent.
+    /// </summary>
+    emailReceipt;
+    /// <summary>
+    /// The end date of a schedule, if any.
+    /// </summary>
+    endDate;
+    /// <summary>
+    /// The schedule's frequency.
+    /// </summary>
+    /// <seealso>ScheduleFrequency</seealso>
+    frequency;
+    /// <summary>
+    /// Indicates if the schedule has started processing.
+    /// </summary>
+    hasStarted;
+    /// <summary>
+    /// The invoice number associated with the schedule.
+    /// </summary>
+    invoiceNumber;
+    /// <summary>
+    /// The schedule's name.
+    /// </summary>
+    name;
+    /// <summary>
+    /// The date/time when the schedule should process next.
+    /// </summary>
+    nextProcessingDate;
+    /// <summary>
+    /// The number of payments made to date on the schedule.
+    /// </summary>
+    numberOfPayments;
+    /// <summary>
+    /// The purchase order (PO) number associated with the schedule.
+    /// </summary>
+    poNumber;
+    /// <summary>
+    /// The identifier of the payment method associated with
+    /// the schedule.
+    /// </summary>
+    paymentKey;
+    /// <summary>
+    /// Indicates when in the month a recurring schedule should run.
+    /// </summary>
+    paymentSchedule;
+    /// <summary>
+    /// The number of times a failed schedule payment should be
+    /// reprocessed.
+    /// </summary>
+    reprocessingCount;
+    /// <summary>
+    /// The start date of a schedule.
+    /// </summary>
+    startDate;
+    /// <summary>
+    /// The schedule's status.
+    /// </summary>
+    status;
+    /// <summary>
+    /// The schedule's tax amount.
+    /// </summary>
+    taxAmount;
+    /// <summary>
+    /// The total amount for the schedule (`Amount` + `TaxAmount`).
+    /// </summary>
+    get totalAmount() {
+        return (parseFloat(this.amount.toString()) + parseFloat(this.taxAmount.toString()));
+    }
+    constructor(customerKey, paymentKey) {
+        super();
+        if (customerKey) {
+            this.customerKey = customerKey;
+        }
+        if (paymentKey) {
+            this.paymentKey = paymentKey;
+        }
+    }
+    /// <summary>
+    /// Sets the schedule's amount.
+    /// </summary>
+    /// <param name="value">The amount</param>
+    /// <returns>Schedule</returns>
+    withAmount(value) {
+        if (value) {
+            this.amount = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's currency.
+    /// </summary>
+    /// <param name="value">The currency</param>
+    /// <returns>Schedule</returns>
+    withCurrency(value) {
+        if (value) {
+            this.currency = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's customer.
+    /// </summary>
+    /// <param name="value">The customer's key</param>
+    /// <returns>Schedule</returns>
+    withCustomerKey(value) {
+        if (value) {
+            this.customerKey = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's description.
+    /// </summary>
+    /// <param name="value">The description</param>
+    /// <returns>Schedule</returns>
+    withDescription(value) {
+        if (value) {
+            this.description = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's device ID.
+    /// </summary>
+    /// <param name="value">The device ID</param>
+    /// <returns>Schedule</returns>
+    withDeviceId(value) {
+        if (value) {
+            this.deviceId = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets whether the schedule should send email notifications.
+    /// </summary>
+    /// <param name="value">The email notification flag</param>
+    /// <returns>Schedule</returns>
+    withEmailNotification(value) {
+        if (value) {
+            this.emailNotification = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets when the schedule should email receipts.
+    /// </summary>
+    /// <param name="value">When the schedule should email receipts</param>
+    /// <returns>Schedule</returns>
+    withEmailReceipt(value) {
+        if (value) {
+            this.emailReceipt = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's end date.
+    /// </summary>
+    /// <param name="value">The end date</param>
+    /// <returns>Schedule</returns>
+    withEndDate(value) {
+        if (value) {
+            this.endDate = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's frequency.
+    /// </summary>
+    /// <param name="value">The frequency</param>
+    /// <returns>Schedule</returns>
+    withFrequency(value) {
+        if (value) {
+            this.frequency = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's invoice number.
+    /// </summary>
+    /// <param name="value">The invoice number</param>
+    /// <returns>Schedule</returns>
+    withInvoiceNumber(value) {
+        if (value) {
+            this.invoiceNumber = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's name.
+    /// </summary>
+    /// <param name="value">The name</param>
+    /// <returns>Schedule</returns>
+    withName(value) {
+        if (value) {
+            this.name = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's number of payments.
+    /// </summary>
+    /// <param name="value">The number of payments</param>
+    /// <returns>Schedule</returns>
+    withNumberOfPayments(value) {
+        if (value) {
+            this.numberOfPayments = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's purchase order (PO) number.
+    /// </summary>
+    /// <param name="value">The purchase order (PO) number</param>
+    /// <returns>Schedule</returns>
+    withPoNumber(value) {
+        if (value) {
+            this.poNumber = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's payment method.
+    /// </summary>
+    /// <param name="value">The payment method's key</param>
+    /// <returns>Schedule</returns>
+    withPaymentKey(value) {
+        if (value) {
+            this.paymentKey = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's recurring schedule.
+    /// </summary>
+    /// <param name="value">The recurring schedule</param>
+    /// <returns>Schedule</returns>
+    withPaymentSchedule(value) {
+        if (value) {
+            this.paymentSchedule = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's reprocessing count.
+    /// </summary>
+    /// <param name="value">The reprocessing count</param>
+    /// <returns>Schedule</returns>
+    withReprocessingCount(value) {
+        if (value) {
+            this.reprocessingCount = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's start date.
+    /// </summary>
+    /// <param name="value">The start date</param>
+    /// <returns>Schedule</returns>
+    withStartDate(value) {
+        if (value) {
+            this.startDate = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's status.
+    /// </summary>
+    /// <param name="value">The new status</param>
+    /// <returns>Schedule</returns>
+    withStatus(value) {
+        if (value) {
+            this.status = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's tax amount.
+    /// </summary>
+    /// <param name="value">The tax amount</param>
+    /// <returns>Schedule</returns>
+    withTaxAmount(value) {
+        if (value) {
+            this.taxAmount = value;
+        }
+        return this;
+    }
+}
+exports.Schedule = Schedule;
+//# sourceMappingURL=Schedule.js.map