@payabli/sdk-node 0.0.147 → 1.0.1

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

@@ -62,8 +62,11 @@ 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 Organization service provides multi-tenant organization hierarchy management and configuration. It handles creation and management of organizations and sub-organizations, maintaining parent-child relationships for partner and merchant structures. The service manages organization-level settings including branding with logos, contact information, timezone and localization preferences, and billing configurations. It provides user management within organizations, service cost configurations for residual calculations, and organization-wide settings that cascade to child entities. The service supports organization summaries with transaction and subscription metrics, and enables comprehensive organization search and filtering capabilities.
+ */
 class OrganizationClient {
-    constructor(options = {}) {
+    constructor(options) {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
@@ -166,9 +169,10 @@ class OrganizationClient {
         });
     }
     /**
-     * Delete an organization by ID.
+     * Updates an organization's details by ID.
      *
      * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
+     * @param {Payabli.OrganizationData} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
@@ -177,21 +181,42 @@ class OrganizationClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.organization.deleteOrganization(123)
+     *     await client.organization.editOrganization(123, {
+     *         contacts: [{
+     *                 contactEmail: "herman@hermanscoatings.com",
+     *                 contactName: "Herman Martinez",
+     *                 contactPhone: "3055550000",
+     *                 contactTitle: "Owner"
+     *             }],
+     *         orgAddress: "123 Walnut Street",
+     *         orgCity: "Johnson City",
+     *         orgCountry: "US",
+     *         orgEntryName: "pilgrim-planner",
+     *         orgId: "123",
+     *         orgName: "Pilgrim Planner",
+     *         orgState: "TN",
+     *         orgTimezone: -5,
+     *         orgType: 0,
+     *         orgWebsite: "www.pilgrimageplanner.com",
+     *         orgZip: "37615"
+     *     })
      */
-    deleteOrganization(orgId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__deleteOrganization(orgId, requestOptions));
+    editOrganization(orgId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__editOrganization(orgId, request, requestOptions));
     }
-    __deleteOrganization(orgId, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
+    __editOrganization(orgId_1) {
+        return __awaiter(this, arguments, void 0, function* (orgId, request = {}, requestOptions) {
             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, `Organization/${core.url.encodePathParam(orgId)}`),
-                method: "DELETE",
+                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,
@@ -219,14 +244,13 @@ class OrganizationClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/Organization/{orgId}");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PUT", "/Organization/{orgId}");
         });
     }
     /**
-     * Updates an organization's details by ID.
+     * Delete an organization by ID.
      *
      * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
-     * @param {Payabli.OrganizationData} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
@@ -235,42 +259,21 @@ class OrganizationClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.organization.editOrganization(123, {
-     *         contacts: [{
-     *                 contactEmail: "herman@hermanscoatings.com",
-     *                 contactName: "Herman Martinez",
-     *                 contactPhone: "3055550000",
-     *                 contactTitle: "Owner"
-     *             }],
-     *         orgAddress: "123 Walnut Street",
-     *         orgCity: "Johnson City",
-     *         orgCountry: "US",
-     *         orgEntryName: "pilgrim-planner",
-     *         orgId: "123",
-     *         orgName: "Pilgrim Planner",
-     *         orgState: "TN",
-     *         orgTimezone: -5,
-     *         orgType: 0,
-     *         orgWebsite: "www.pilgrimageplanner.com",
-     *         orgZip: "37615"
-     *     })
+     *     await client.organization.deleteOrganization(123)
      */
-    editOrganization(orgId, request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__editOrganization(orgId, request, requestOptions));
+    deleteOrganization(orgId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__deleteOrganization(orgId, requestOptions));
     }
-    __editOrganization(orgId_1) {
-        return __awaiter(this, arguments, void 0, function* (orgId, request = {}, requestOptions) {
+    __deleteOrganization(orgId, 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, `Organization/${core.url.encodePathParam(orgId)}`),
-                method: "PUT",
+                method: "DELETE",
                 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,
@@ -298,7 +301,7 @@ class OrganizationClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PUT", "/Organization/{orgId}");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/Organization/{orgId}");
         });
     }
     /**
@@ -359,7 +362,7 @@ class OrganizationClient {
         });
     }
     /**
-     * Gets an organizations basic details by org ID.
+     * Gets an organization's basic details by org ID.
      *
      * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -478,6 +481,11 @@ class OrganizationClient {
      * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
      * @example
      *     await client.organization.getSettingsOrganization(123)
      */
@@ -504,11 +512,22 @@ class OrganizationClient {
                 return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
-                throw new errors.PayabliError({
-                    statusCode: _response.error.statusCode,
-                    body: _response.error.body,
-                    rawResponse: _response.rawResponse,
-                });
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 503:
+                        throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PayabliError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
             }
             return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Organization/settings/{orgId}");
         });

package/dist/cjs/api/resources/organization/client/requests/AddOrganizationRequest.d.ts

@@ -42,6 +42,7 @@ import type * as Payabli from "../../../../index.js";
  *     }
  */
 export interface AddOrganizationRequest {
+    /** _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;
     services?: Payabli.ServiceCost[];
     billingInfo?: Payabli.Instrument;

package/dist/cjs/api/resources/organization/index.d.ts

@@ -1,2 +1 @@
 export * from "./client/index.js";
-export * from "./types/index.js";

package/dist/cjs/api/resources/organization/index.js

@@ -15,4 +15,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./client/index.js"), exports);
-__exportStar(require("./types/index.js"), exports);