rcs-js 1.0.9 → 1.0.11

package/Client.d.ts

@@ -4,6 +4,7 @@
 import * as environments from "./environments";
 import * as core from "./core";
 import * as Pinnacle from "./api/index";
+import { Company } from "./api/resources/company/client/Client";
 import { Send } from "./api/resources/send/client/Client";
 export declare namespace PinnacleClient {
     interface Options {
@@ -36,75 +37,8 @@ export declare class PinnacleClient {
      *     await client.getRcsFunctionality()
      */
     getRcsFunctionality(request?: Pinnacle.GetRcsFunctionalityRequest, requestOptions?: PinnacleClient.RequestOptions): Promise<Pinnacle.RcsFunctionalities>;
-    /**
-     * Retrieve the company's information (i.e. approval status, company name, etc.). Search by company ID or company name.
-     *
-     * @param {Pinnacle.GetCompanyRequest} request
-     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.getCompany()
-     */
-    getCompany(request?: Pinnacle.GetCompanyRequest, requestOptions?: PinnacleClient.RequestOptions): Promise<Pinnacle.Company[]>;
-    /**
-     * Register a company for RCS with the Pinnacle platform
-     *
-     * @param {Pinnacle.RegisterCompanyRequest} request
-     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.registerCompany({
-     *         company: {
-     *             name: "name",
-     *             address: "address",
-     *             ein: "ein",
-     *             description: "description",
-     *             brandColor: "brandColor",
-     *             logoUrl: "logoUrl",
-     *             heroUrl: "heroUrl"
-     *         },
-     *         companyContact: {
-     *             primaryWebsiteUrl: "primaryWebsiteUrl",
-     *             primaryWebsiteLabel: "primaryWebsiteLabel",
-     *             primaryPhone: "primaryPhone",
-     *             primaryPhoneLabel: "primaryPhoneLabel",
-     *             primaryEmail: "primaryEmail",
-     *             primaryEmailLabel: "primaryEmailLabel",
-     *             privacyPolicyUrl: "privacyPolicyUrl",
-     *             tosUrl: "tosUrl"
-     *         },
-     *         pointOfContact: {
-     *             pocName: "pocName",
-     *             pocTitle: "pocTitle",
-     *             pocEmail: "pocEmail"
-     *         }
-     *     })
-     */
-    registerCompany(request: Pinnacle.RegisterCompanyRequest, requestOptions?: PinnacleClient.RequestOptions): Promise<Pinnacle.RegisterCompanyResponse>;
-    /**
-     * Update a company on the Pinnacle platform
-     *
-     * @param {Pinnacle.UpdateCompanyRequest} request
-     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.updateCompany({
-     *         companyId: "companyId"
-     *     })
-     */
-    updateCompany(request: Pinnacle.UpdateCompanyRequest, requestOptions?: PinnacleClient.RequestOptions): Promise<Pinnacle.UpdateCompanyResponse>;
+    protected _company: Company | undefined;
+    get company(): Company;
     protected _send: Send | undefined;
     get send(): Send;
     protected _getCustomAuthorizationHeaders(): Promise<{

package/Client.js

@@ -45,7 +45,8 @@ const Pinnacle = __importStar(require("./api/index"));
 const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("./serialization/index"));
 const errors = __importStar(require("./errors/index"));
-const Client_1 = require("./api/resources/send/client/Client");
+const Client_1 = require("./api/resources/company/client/Client");
+const Client_2 = require("./api/resources/send/client/Client");
 class PinnacleClient {
     constructor(_options) {
         this._options = _options;
@@ -74,7 +75,7 @@ class PinnacleClient {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "rcs_functionality"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.9", "User-Agent": "rcs-js/1.0.9", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -120,239 +121,13 @@ class PinnacleClient {
             }
         });
     }
-    /**
-     * Retrieve the company's information (i.e. approval status, company name, etc.). Search by company ID or company name.
-     *
-     * @param {Pinnacle.GetCompanyRequest} request
-     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.getCompany()
-     */
-    getCompany(request = {}, requestOptions) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const { companyId, companyName } = request;
-            const _queryParams = {};
-            if (companyId != null) {
-                _queryParams["companyId"] = companyId.toString();
-            }
-            if (companyName != null) {
-                _queryParams["companyName"] = companyName;
-            }
-            const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "company"),
-                method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.9", "User-Agent": "rcs-js/1.0.9", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
-                contentType: "application/json",
-                queryParameters: _queryParams,
-                requestType: "json",
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return serializers.getCompany.Response.parseOrThrow(_response.body, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    breadcrumbsPrefix: ["response"],
-                });
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 400:
-                        throw new Pinnacle.BadRequestError(_response.error.body);
-                    case 401:
-                        throw new Pinnacle.UnauthorizedError(_response.error.body);
-                    case 500:
-                        throw new Pinnacle.InternalServerError(_response.error.body);
-                    default:
-                        throw new errors.PinnacleError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.PinnacleError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                    });
-                case "timeout":
-                    throw new errors.PinnacleTimeoutError();
-                case "unknown":
-                    throw new errors.PinnacleError({
-                        message: _response.error.errorMessage,
-                    });
-            }
-        });
-    }
-    /**
-     * Register a company for RCS with the Pinnacle platform
-     *
-     * @param {Pinnacle.RegisterCompanyRequest} request
-     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.registerCompany({
-     *         company: {
-     *             name: "name",
-     *             address: "address",
-     *             ein: "ein",
-     *             description: "description",
-     *             brandColor: "brandColor",
-     *             logoUrl: "logoUrl",
-     *             heroUrl: "heroUrl"
-     *         },
-     *         companyContact: {
-     *             primaryWebsiteUrl: "primaryWebsiteUrl",
-     *             primaryWebsiteLabel: "primaryWebsiteLabel",
-     *             primaryPhone: "primaryPhone",
-     *             primaryPhoneLabel: "primaryPhoneLabel",
-     *             primaryEmail: "primaryEmail",
-     *             primaryEmailLabel: "primaryEmailLabel",
-     *             privacyPolicyUrl: "privacyPolicyUrl",
-     *             tosUrl: "tosUrl"
-     *         },
-     *         pointOfContact: {
-     *             pocName: "pocName",
-     *             pocTitle: "pocTitle",
-     *             pocEmail: "pocEmail"
-     *         }
-     *     })
-     */
-    registerCompany(request, requestOptions) {
+    get company() {
         var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "company/register"),
-                method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.9", "User-Agent": "rcs-js/1.0.9", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
-                contentType: "application/json",
-                requestType: "json",
-                body: serializers.RegisterCompanyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return serializers.RegisterCompanyResponse.parseOrThrow(_response.body, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    breadcrumbsPrefix: ["response"],
-                });
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 400:
-                        throw new Pinnacle.BadRequestError(_response.error.body);
-                    case 401:
-                        throw new Pinnacle.UnauthorizedError(_response.error.body);
-                    case 500:
-                        throw new Pinnacle.InternalServerError(_response.error.body);
-                    default:
-                        throw new errors.PinnacleError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.PinnacleError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                    });
-                case "timeout":
-                    throw new errors.PinnacleTimeoutError();
-                case "unknown":
-                    throw new errors.PinnacleError({
-                        message: _response.error.errorMessage,
-                    });
-            }
-        });
-    }
-    /**
-     * Update a company on the Pinnacle platform
-     *
-     * @param {Pinnacle.UpdateCompanyRequest} request
-     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.updateCompany({
-     *         companyId: "companyId"
-     *     })
-     */
-    updateCompany(request, requestOptions) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "company/update"),
-                method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.9", "User-Agent": "rcs-js/1.0.9", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
-                contentType: "application/json",
-                requestType: "json",
-                body: serializers.UpdateCompanyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return serializers.UpdateCompanyResponse.parseOrThrow(_response.body, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    breadcrumbsPrefix: ["response"],
-                });
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 400:
-                        throw new Pinnacle.BadRequestError(_response.error.body);
-                    case 401:
-                        throw new Pinnacle.UnauthorizedError(_response.error.body);
-                    case 500:
-                        throw new Pinnacle.InternalServerError(_response.error.body);
-                    default:
-                        throw new errors.PinnacleError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.PinnacleError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                    });
-                case "timeout":
-                    throw new errors.PinnacleTimeoutError();
-                case "unknown":
-                    throw new errors.PinnacleError({
-                        message: _response.error.errorMessage,
-                    });
-            }
-        });
+        return ((_a = this._company) !== null && _a !== void 0 ? _a : (this._company = new Client_1.Company(this._options)));
     }
     get send() {
         var _a;
-        return ((_a = this._send) !== null && _a !== void 0 ? _a : (this._send = new Client_1.Send(this._options)));
+        return ((_a = this._send) !== null && _a !== void 0 ? _a : (this._send = new Client_2.Send(this._options)));
     }
     _getCustomAuthorizationHeaders() {
         return __awaiter(this, void 0, void 0, function* () {

package/README.md

@@ -19,7 +19,7 @@ Instantiate and use the client with the following:
 import { PinnacleClient } from "rcs-js";
 
 const client = new PinnacleClient({ apiKey: "YOUR_API_KEY" });
-await client.registerCompany({
+await client.company.register({
     company: {
         name: "name",
         address: "address",
@@ -55,7 +55,7 @@ following namespace:
 ```typescript
 import { Pinnacle } from "rcs-js";
 
-const request: Pinnacle.Rcs = {
+const request: Pinnacle.CompanyGetRequest = {
     ...
 };
 ```
@@ -69,7 +69,7 @@ will be thrown.
 import { PinnacleError } from "rcs-js";
 
 try {
-    await client.registerCompany(...);
+    await client.company.register(...);
 } catch (err) {
     if (err instanceof PinnacleError) {
         console.log(err.statusCode);
@@ -96,7 +96,7 @@ A request is deemed retriable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.registerCompany(..., {
+const response = await client.company.register(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -106,7 +106,7 @@ const response = await client.registerCompany(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.registerCompany(..., {
+const response = await client.company.register(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -117,7 +117,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
 
 ```typescript
 const controller = new AbortController();
-const response = await client.registerCompany(..., {
+const response = await client.company.register(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request

package/api/client/requests/index.d.ts

@@ -1,4 +1 @@
 export { type GetRcsFunctionalityRequest } from "./GetRcsFunctionalityRequest";
-export { type GetCompanyRequest } from "./GetCompanyRequest";
-export { type RegisterCompanyRequest } from "./RegisterCompanyRequest";
-export { type UpdateCompanyRequest } from "./UpdateCompanyRequest";

package/api/resources/company/client/Client.d.ts

@@ -0,0 +1,96 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Pinnacle from "../../../index";
+export declare namespace Company {
+    interface Options {
+        environment?: core.Supplier<environments.PinnacleEnvironment | string>;
+        apiKey: core.Supplier<string>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class Company {
+    protected readonly _options: Company.Options;
+    constructor(_options: Company.Options);
+    /**
+     * Retrieve the company's information (i.e. approval status, company name, etc.). Search by company ID or company name.
+     *
+     * @param {Pinnacle.CompanyGetRequest} request
+     * @param {Company.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.company.get()
+     */
+    get(request?: Pinnacle.CompanyGetRequest, requestOptions?: Company.RequestOptions): Promise<Pinnacle.Company[]>;
+    /**
+     * Register a company for RCS with the Pinnacle platform
+     *
+     * @param {Pinnacle.CompanyRegisterRequest} request
+     * @param {Company.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.company.register({
+     *         company: {
+     *             name: "name",
+     *             address: "address",
+     *             ein: "ein",
+     *             description: "description",
+     *             brandColor: "brandColor",
+     *             logoUrl: "logoUrl",
+     *             heroUrl: "heroUrl"
+     *         },
+     *         companyContact: {
+     *             primaryWebsiteUrl: "primaryWebsiteUrl",
+     *             primaryWebsiteLabel: "primaryWebsiteLabel",
+     *             primaryPhone: "primaryPhone",
+     *             primaryPhoneLabel: "primaryPhoneLabel",
+     *             primaryEmail: "primaryEmail",
+     *             primaryEmailLabel: "primaryEmailLabel",
+     *             privacyPolicyUrl: "privacyPolicyUrl",
+     *             tosUrl: "tosUrl"
+     *         },
+     *         pointOfContact: {
+     *             pocName: "pocName",
+     *             pocTitle: "pocTitle",
+     *             pocEmail: "pocEmail"
+     *         }
+     *     })
+     */
+    register(request: Pinnacle.CompanyRegisterRequest, requestOptions?: Company.RequestOptions): Promise<Pinnacle.CompanyRegisterResponse>;
+    /**
+     * Update a company on the Pinnacle platform
+     *
+     * @param {Pinnacle.CompanyUpdateRequest} request
+     * @param {Company.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.company.update({
+     *         companyId: "companyId"
+     *     })
+     */
+    update(request: Pinnacle.CompanyUpdateRequest, requestOptions?: Company.RequestOptions): Promise<Pinnacle.CompanyUpdateResponse>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "PINNACLE-API-Key": string;
+    }>;
+}