@payabli/sdk-node 0.0.147 → 1.0.1

package/dist/cjs/api/resources/customer/client/Client.js

@@ -42,6 +42,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomerClient = void 0;
 const BaseClient_js_1 = require("../../../../BaseClient.js");
@@ -51,15 +62,18 @@ const environments = __importStar(require("../../../../environments.js"));
 const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatusCodeError.js");
 const errors = __importStar(require("../../../../errors/index.js"));
 const Payabli = __importStar(require("../../../index.js"));
+/**
+ * The Customer service provides comprehensive customer relationship management and identity tracking for payment operations. It handles creation, retrieval, updating, and deletion of customer records with flexible identifier configurations to match business requirements. The service manages customer contact information, billing and shipping addresses, and maintains customer status tracking. Customers can be linked to transactions, store multiple payment methods, manage subscriptions, and track consent preferences for communications. The service supports custom fields for additional data storage and integrates with stored payment methods and transaction history.
+ */
 class CustomerClient {
-    constructor(options = {}) {
+    constructor(options) {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
      * Creates a customer in an entrypoint. An identifier is required to create customer records. Change your identifier settings in Settings > Custom Fields in PartnerHub.
      * If you don't include an identifier, the record is rejected.
      *
-     * @param {Payabli.Entrypointfield} entry
+     * @param {Payabli.Entrypointfield} entry - The entrypoint identifier.
      * @param {Payabli.AddCustomerRequest} request
      * @param {CustomerClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -70,19 +84,17 @@ class CustomerClient {
      *
      * @example
      *     await client.customer.addCustomer("8cfec329267", {
-     *         body: {
-     *             customerNumber: "12356ACB",
-     *             firstname: "Irene",
-     *             lastname: "Canizales",
-     *             address1: "123 Bishop's Trail",
-     *             city: "Mountain City",
-     *             state: "TN",
-     *             zip: "37612",
-     *             country: "US",
-     *             email: "irene@canizalesconcrete.com",
-     *             identifierFields: ["email"],
-     *             timeZone: -5
-     *         }
+     *         customerNumber: "C-90010",
+     *         firstname: "Irene",
+     *         lastname: "Canizales",
+     *         address1: "123 Bishop's Trail",
+     *         city: "Mountain City",
+     *         state: "TN",
+     *         zip: "37612",
+     *         country: "US",
+     *         email: "irene@canizalesconcrete.com",
+     *         identifierFields: ["email"],
+     *         timeZone: -5
      *     })
      */
     addCustomer(entry, request, requestOptions) {
@@ -91,7 +103,7 @@ class CustomerClient {
     __addCustomer(entry, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { forceCustomerCreation, replaceExisting, idempotencyKey, body: _body } = request;
+            const { forceCustomerCreation, replaceExisting, idempotencyKey } = request, _body = __rest(request, ["forceCustomerCreation", "replaceExisting", "idempotencyKey"]);
             const _queryParams = {
                 forceCustomerCreation,
                 replaceExisting,
@@ -144,7 +156,7 @@ class CustomerClient {
         });
     }
     /**
-     * Delete a customer record.
+     * Retrieves a customer's record and details.
      *
      * @param {number} customerId - Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
      * @param {CustomerClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -155,19 +167,19 @@ class CustomerClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.customer.deleteCustomer(998)
+     *     await client.customer.getCustomer(4440)
      */
-    deleteCustomer(customerId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__deleteCustomer(customerId, requestOptions));
+    getCustomer(customerId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getCustomer(customerId, requestOptions));
     }
-    __deleteCustomer(customerId, requestOptions) {
+    __getCustomer(customerId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `Customer/${core.url.encodePathParam(customerId)}`),
-                method: "DELETE",
+                method: "GET",
                 headers: _headers,
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -177,10 +189,7 @@ class CustomerClient {
                 logging: this._options.logging,
             });
             if (_response.ok) {
-                return {
-                    data: _response.body,
-                    rawResponse: _response.rawResponse,
-                };
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -200,13 +209,14 @@ class CustomerClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/Customer/{customerId}");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Customer/{customerId}");
         });
     }
     /**
-     * Retrieves a customer's record and details.
+     * Update a customer record. Include only the fields you want to change.
      *
      * @param {number} customerId - Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
+     * @param {Payabli.CustomerData} request
      * @param {CustomerClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
@@ -215,21 +225,32 @@ class CustomerClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.customer.getCustomer(998)
+     *     await client.customer.updateCustomer(4440, {
+     *         firstname: "Irene",
+     *         lastname: "Canizales",
+     *         address1: "145 Bishop's Trail",
+     *         city: "Mountain City",
+     *         state: "TN",
+     *         zip: "37612",
+     *         country: "US"
+     *     })
      */
-    getCustomer(customerId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getCustomer(customerId, requestOptions));
+    updateCustomer(customerId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__updateCustomer(customerId, request, requestOptions));
     }
-    __getCustomer(customerId, requestOptions) {
+    __updateCustomer(customerId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `Customer/${core.url.encodePathParam(customerId)}`),
-                method: "GET",
+                method: "PUT",
                 headers: _headers,
+                contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "json",
+                body: request,
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -237,7 +258,10 @@ class CustomerClient {
                 logging: this._options.logging,
             });
             if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -257,14 +281,13 @@ class CustomerClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Customer/{customerId}");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PUT", "/Customer/{customerId}");
         });
     }
     /**
-     * Links a customer to a transaction by ID.
+     * Delete a customer record.
      *
      * @param {number} customerId - Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
-     * @param {string} transId - ReferenceId for the transaction (PaymentId).
      * @param {CustomerClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
@@ -273,19 +296,19 @@ class CustomerClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.customer.linkCustomerTransaction(998, "45-as456777hhhhhhhhhh77777777-324")
+     *     await client.customer.deleteCustomer(4440)
      */
-    linkCustomerTransaction(customerId, transId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__linkCustomerTransaction(customerId, transId, requestOptions));
+    deleteCustomer(customerId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__deleteCustomer(customerId, requestOptions));
     }
-    __linkCustomerTransaction(customerId, transId, requestOptions) {
+    __deleteCustomer(customerId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `Customer/link/${core.url.encodePathParam(customerId)}/${core.url.encodePathParam(transId)}`),
-                method: "GET",
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `Customer/${core.url.encodePathParam(customerId)}`),
+                method: "DELETE",
                 headers: _headers,
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -318,7 +341,7 @@ class CustomerClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Customer/link/{customerId}/{transId}");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/Customer/{customerId}");
         });
     }
     /**
@@ -333,7 +356,7 @@ class CustomerClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.customer.requestConsent(998)
+     *     await client.customer.requestConsent(4440)
      */
     requestConsent(customerId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__requestConsent(customerId, requestOptions));
@@ -382,10 +405,10 @@ class CustomerClient {
         });
     }
     /**
-     * Update a customer record. Include only the fields you want to change.
+     * Links a customer to a transaction by ID.
      *
      * @param {number} customerId - Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
-     * @param {Payabli.CustomerData} request
+     * @param {string} transId - ReferenceId for the transaction (PaymentId).
      * @param {CustomerClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
@@ -394,32 +417,21 @@ class CustomerClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.customer.updateCustomer(998, {
-     *         firstname: "Irene",
-     *         lastname: "Canizales",
-     *         address1: "145 Bishop's Trail",
-     *         city: "Mountain City",
-     *         state: "TN",
-     *         zip: "37612",
-     *         country: "US"
-     *     })
+     *     await client.customer.linkCustomerTransaction(4440, "45-as456777hhhhhhhhhh77777777-324")
      */
-    updateCustomer(customerId, request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__updateCustomer(customerId, request, requestOptions));
+    linkCustomerTransaction(customerId, transId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__linkCustomerTransaction(customerId, transId, requestOptions));
     }
-    __updateCustomer(customerId, request, requestOptions) {
+    __linkCustomerTransaction(customerId, transId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `Customer/${core.url.encodePathParam(customerId)}`),
-                method: "PUT",
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `Customer/link/${core.url.encodePathParam(customerId)}/${core.url.encodePathParam(transId)}`),
+                method: "GET",
                 headers: _headers,
-                contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
-                requestType: "json",
-                body: request,
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -450,7 +462,7 @@ class CustomerClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PUT", "/Customer/{customerId}");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Customer/link/{customerId}/{transId}");
         });
     }
 }

package/dist/cjs/api/resources/customer/client/requests/AddCustomerRequest.d.ts

@@ -2,19 +2,17 @@ import type * as Payabli from "../../../../index.js";
 /**
  * @example
  *     {
- *         body: {
- *             customerNumber: "12356ACB",
- *             firstname: "Irene",
- *             lastname: "Canizales",
- *             address1: "123 Bishop's Trail",
- *             city: "Mountain City",
- *             state: "TN",
- *             zip: "37612",
- *             country: "US",
- *             email: "irene@canizalesconcrete.com",
- *             identifierFields: ["email"],
- *             timeZone: -5
- *         }
+ *         customerNumber: "C-90010",
+ *         firstname: "Irene",
+ *         lastname: "Canizales",
+ *         address1: "123 Bishop's Trail",
+ *         city: "Mountain City",
+ *         state: "TN",
+ *         zip: "37612",
+ *         country: "US",
+ *         email: "irene@canizalesconcrete.com",
+ *         identifierFields: ["email"],
+ *         timeZone: -5
  *     }
  */
 export interface AddCustomerRequest {
@@ -22,6 +20,47 @@ export interface AddCustomerRequest {
     forceCustomerCreation?: boolean;
     /** Flag indicating to replace existing customer with a new record. Possible values: 0 (don't replace), 1 (replace). Default is `0`. */
     replaceExisting?: number;
+    /** _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed. */
     idempotencyKey?: Payabli.IdempotencyKey;
-    body: Payabli.CustomerData;
+    customerNumber?: Payabli.CustomerNumberNullable;
+    /** Customer username for customer portal */
+    customerUsername?: string;
+    /** Customer password for customer portal */
+    customerPsw?: string;
+    customerStatus?: Payabli.CustomerStatus;
+    /** Company name */
+    company?: string;
+    /** Customer first name */
+    firstname?: string;
+    /** Customer last name */
+    lastname?: string;
+    /** Customer phone number */
+    phone?: string;
+    /** Customer email address. */
+    email?: Payabli.Email;
+    /** Customer address */
+    address?: string;
+    /** Additional customer address */
+    address1?: string;
+    /** Customer city */
+    city?: string;
+    /** Customer State */
+    state?: string;
+    /** Customer postal code */
+    zip?: string;
+    /** Customer country in ISO-3166-1 alpha 2 format. See https://en.wikipedia.org/wiki/ISO_3166-1 for reference. */
+    country?: string;
+    shippingAddress?: Payabli.Shippingaddress;
+    shippingAddress1?: Payabli.Shippingaddressadditional;
+    shippingCity?: Payabli.Shippingcity;
+    shippingState?: Payabli.Shippingstate;
+    shippingZip?: Payabli.Shippingzip;
+    shippingCountry?: Payabli.Shippingcountry;
+    /** Customer balance. */
+    balance?: number;
+    timeZone?: Payabli.Timezone;
+    /** Additional Custom fields in format "key":"value". */
+    additionalFields?: Record<string, string>;
+    identifierFields?: Payabli.Identifierfields;
+    createdAt?: Payabli.CreatedAt;
 }