rcs-js 1.0.8 → 1.0.10

package/dist/serialization/types/index.d.ts

@@ -1,43 +1,8 @@
-export * from "./CheckRcsCapabilityResponse";
 export * from "./BadRequestErrorBody";
 export * from "./UnauthorizedErrorBody";
 export * from "./InternalServerErrorBody";
-export * from "./UpdateSettingsResponse";
-export * from "./GetAccountNumberResponse";
-export * from "./SendMessageRequest";
-export * from "./SendMessageResponse";
-export * from "./NotFoundErrorBody";
-export * from "./RegisterCompanyResponseBrand";
-export * from "./RegisterCompanyResponse";
-export * from "./BadRequestErrorBodyError";
-export * from "./UpdateCompanyResponseBrand";
-export * from "./UpdateCompanyResponse";
-export * from "./PhoneNumber";
-export * from "./Url";
-export * from "./Call";
-export * from "./Postback";
-export * from "./ShareLocation";
-export * from "./LatLng";
-export * from "./ViewLocation";
-export * from "./Event";
-export * from "./Action";
-export * from "./SmsMessage";
-export * from "./Sms";
-export * from "./BasicRcsMessage";
-export * from "./BasicRcs";
-export * from "./MediaType";
-export * from "./MediaRcsMessage";
-export * from "./MediaRcs";
-export * from "./CardStyleImageAlignment";
-export * from "./CardStyleMediaHeight";
-export * from "./CardStyleWidth";
-export * from "./CardStyleOrientation";
-export * from "./CardStyle";
-export * from "./Card";
-export * from "./CardRcsMessage";
-export * from "./CardRcs";
-export * from "./CarouselRcsMessage";
-export * from "./CarouselRcs";
+export * from "./ForbiddenErrorBody";
+export * from "./RcsFunctionalities";
 export * from "./CompanyAdditionalWebsitesItem";
 export * from "./CompanyAdditionalEmailsItem";
 export * from "./CompanyAdditionalPhoneNumbersItem";
@@ -49,3 +14,7 @@ export * from "./AdditionalWebsite";
 export * from "./AdditionalPhoneNumber";
 export * from "./AdditionalEmail";
 export * from "./Optionals";
+export * from "./Card";
+export * from "./ActionType";
+export * from "./ActionLatLong";
+export * from "./Action";

package/dist/serialization/types/index.js

@@ -14,46 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./CheckRcsCapabilityResponse"), exports);
 __exportStar(require("./BadRequestErrorBody"), exports);
 __exportStar(require("./UnauthorizedErrorBody"), exports);
 __exportStar(require("./InternalServerErrorBody"), exports);
-__exportStar(require("./UpdateSettingsResponse"), exports);
-__exportStar(require("./GetAccountNumberResponse"), exports);
-__exportStar(require("./SendMessageRequest"), exports);
-__exportStar(require("./SendMessageResponse"), exports);
-__exportStar(require("./NotFoundErrorBody"), exports);
-__exportStar(require("./RegisterCompanyResponseBrand"), exports);
-__exportStar(require("./RegisterCompanyResponse"), exports);
-__exportStar(require("./BadRequestErrorBodyError"), exports);
-__exportStar(require("./UpdateCompanyResponseBrand"), exports);
-__exportStar(require("./UpdateCompanyResponse"), exports);
-__exportStar(require("./PhoneNumber"), exports);
-__exportStar(require("./Url"), exports);
-__exportStar(require("./Call"), exports);
-__exportStar(require("./Postback"), exports);
-__exportStar(require("./ShareLocation"), exports);
-__exportStar(require("./LatLng"), exports);
-__exportStar(require("./ViewLocation"), exports);
-__exportStar(require("./Event"), exports);
-__exportStar(require("./Action"), exports);
-__exportStar(require("./SmsMessage"), exports);
-__exportStar(require("./Sms"), exports);
-__exportStar(require("./BasicRcsMessage"), exports);
-__exportStar(require("./BasicRcs"), exports);
-__exportStar(require("./MediaType"), exports);
-__exportStar(require("./MediaRcsMessage"), exports);
-__exportStar(require("./MediaRcs"), exports);
-__exportStar(require("./CardStyleImageAlignment"), exports);
-__exportStar(require("./CardStyleMediaHeight"), exports);
-__exportStar(require("./CardStyleWidth"), exports);
-__exportStar(require("./CardStyleOrientation"), exports);
-__exportStar(require("./CardStyle"), exports);
-__exportStar(require("./Card"), exports);
-__exportStar(require("./CardRcsMessage"), exports);
-__exportStar(require("./CardRcs"), exports);
-__exportStar(require("./CarouselRcsMessage"), exports);
-__exportStar(require("./CarouselRcs"), exports);
+__exportStar(require("./ForbiddenErrorBody"), exports);
+__exportStar(require("./RcsFunctionalities"), exports);
 __exportStar(require("./CompanyAdditionalWebsitesItem"), exports);
 __exportStar(require("./CompanyAdditionalEmailsItem"), exports);
 __exportStar(require("./CompanyAdditionalPhoneNumbersItem"), exports);
@@ -65,3 +30,7 @@ __exportStar(require("./AdditionalWebsite"), exports);
 __exportStar(require("./AdditionalPhoneNumber"), exports);
 __exportStar(require("./AdditionalEmail"), exports);
 __exportStar(require("./Optionals"), exports);
+__exportStar(require("./Card"), exports);
+__exportStar(require("./ActionType"), exports);
+__exportStar(require("./ActionLatLong"), exports);
+__exportStar(require("./Action"), exports);

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.8";
+export declare const SDK_VERSION = "1.0.10";

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.0.8";
+exports.SDK_VERSION = "1.0.10";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rcs-js",
-    "version": "1.0.8",
+    "version": "1.0.10",
     "private": false,
     "repository": "https://github.com/pinnacle-dev/rcs-js",
     "main": "./index.js",

package/reference.md

@@ -1,6 +1,224 @@
 # Reference
 
-<details><summary><code>client.<a href="/src/Client.ts">updateCompany</a>({ ...params }) -> Pinnacle.UpdateCompanyResponse</code></summary>
+<details><summary><code>client.<a href="/src/Client.ts">getRcsFunctionality</a>({ ...params }) -> Pinnacle.RcsFunctionalities</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve the RCS functionality of a phone number. For example checks if a phone number can receive RCS message and if it can receive RCS carousels.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.getRcsFunctionality();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.GetRcsFunctionalityRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PinnacleClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+##
+
+## Company
+
+<details><summary><code>client.company.<a href="/src/api/resources/company/client/Client.ts">get</a>({ ...params }) -> Pinnacle.Company[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve the company's information (i.e. approval status, company name, etc.). Search by company ID or company name.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.company.get();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.CompanyGetRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Company.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.company.<a href="/src/api/resources/company/client/Client.ts">register</a>({ ...params }) -> Pinnacle.CompanyRegisterResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Register a company for RCS with the Pinnacle platform
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+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",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.CompanyRegisterRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Company.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.company.<a href="/src/api/resources/company/client/Client.ts">update</a>({ ...params }) -> Pinnacle.CompanyUpdateResponse</code></summary>
 <dl>
 <dd>
 
@@ -28,7 +246,7 @@ Update a company on the Pinnacle platform
 <dd>
 
 ```typescript
-await client.updateCompany({
+await client.company.update({
     companyId: "companyId",
 });
 ```
@@ -46,7 +264,7 @@ await client.updateCompany({
 <dl>
 <dd>
 
-**request:** `Pinnacle.UpdateCompanyRequest`
+**request:** `Pinnacle.CompanyUpdateRequest`
 
 </dd>
 </dl>
@@ -54,7 +272,7 @@ await client.updateCompany({
 <dl>
 <dd>
 
-**requestOptions:** `PinnacleClient.RequestOptions`
+**requestOptions:** `Company.RequestOptions`
 
 </dd>
 </dl>
@@ -65,4 +283,207 @@ await client.updateCompany({
 </dl>
 </details>
 
-##
+## Send
+
+<details><summary><code>client.send.<a href="/src/api/resources/send/client/Client.ts">rcs</a>({ ...params }) -> Pinnacle.SendRcsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Send an interactive RCS message with text, media, or cards. Each message can only contain either text, media, or card(s).
+
+Quick replies can also be added to the message.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.send.rcs({
+    from: "from",
+    to: "to",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.Rcs`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Send.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.send.<a href="/src/api/resources/send/client/Client.ts">sms</a>({ ...params }) -> Pinnacle.SendSmsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Send an SMS message to a recipient.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.send.sms({
+    to: "to",
+    from: "from",
+    text: "text",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.SendSmsRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Send.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.send.<a href="/src/api/resources/send/client/Client.ts">mms</a>({ ...params }) -> Pinnacle.SendMmsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Send an MMS message with media attachments.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.send.mms({
+    to: "to",
+    from: "from",
+    text: "text",
+    mediaUrls: ["https://example.com/image1.jpg", "https://example.com/video.mp4"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.SendMmsRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Send.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>

package/serialization/index.d.ts

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

package/serialization/index.js

@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./resources"), exports);
 __exportStar(require("./types"), exports);
-__exportStar(require("./client"), exports);

package/serialization/resources/company/client/get.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../index";
+import * as Pinnacle from "../../../../api/index";
+import * as core from "../../../../core";
+import { Company } from "../../../types/Company";
+export declare const Response: core.serialization.Schema<serializers.company.get.Response.Raw, Pinnacle.Company[]>;
+export declare namespace Response {
+    type Raw = Company.Raw[];
+}

package/serialization/{client/getCompany.js → resources/company/client/get.js}

@@ -27,6 +27,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Response = void 0;
-const core = __importStar(require("../../core"));
-const Company_1 = require("../types/Company");
+const core = __importStar(require("../../../../core"));
+const Company_1 = require("../../../types/Company");
 exports.Response = core.serialization.list(Company_1.Company);

package/serialization/resources/company/client/index.d.ts

@@ -0,0 +1,2 @@
+export * as get from "./get";
+export * from "./requests";

package/{dist/serialization → serialization/resources/company}/client/index.js

@@ -26,6 +26,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCompany = void 0;
-exports.getCompany = __importStar(require("./getCompany"));
+exports.get = void 0;
+exports.get = __importStar(require("./get"));
 __exportStar(require("./requests"), exports);

package/serialization/resources/company/client/requests/CompanyRegisterRequest.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../index";
+import * as Pinnacle from "../../../../../api/index";
+import * as core from "../../../../../core";
+import { CompanyDetails } from "../../../../types/CompanyDetails";
+import { CompanyContact } from "../../../../types/CompanyContact";
+import { PointOfContact } from "../../../../types/PointOfContact";
+import { Optionals } from "../../../../types/Optionals";
+export declare const CompanyRegisterRequest: core.serialization.Schema<serializers.CompanyRegisterRequest.Raw, Pinnacle.CompanyRegisterRequest>;
+export declare namespace CompanyRegisterRequest {
+    interface Raw {
+        company: CompanyDetails.Raw;
+        companyContact: CompanyContact.Raw;
+        pointOfContact: PointOfContact.Raw;
+        optionals?: Optionals.Raw | null;
+    }
+}

package/{dist/serialization/client/requests/RegisterCompanyRequest.js → serialization/resources/company/client/requests/CompanyRegisterRequest.js}

@@ -26,13 +26,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegisterCompanyRequest = void 0;
-const core = __importStar(require("../../../core"));
-const CompanyDetails_1 = require("../../types/CompanyDetails");
-const CompanyContact_1 = require("../../types/CompanyContact");
-const PointOfContact_1 = require("../../types/PointOfContact");
-const Optionals_1 = require("../../types/Optionals");
-exports.RegisterCompanyRequest = core.serialization.object({
+exports.CompanyRegisterRequest = void 0;
+const core = __importStar(require("../../../../../core"));
+const CompanyDetails_1 = require("../../../../types/CompanyDetails");
+const CompanyContact_1 = require("../../../../types/CompanyContact");
+const PointOfContact_1 = require("../../../../types/PointOfContact");
+const Optionals_1 = require("../../../../types/Optionals");
+exports.CompanyRegisterRequest = core.serialization.object({
     company: CompanyDetails_1.CompanyDetails,
     companyContact: CompanyContact_1.CompanyContact,
     pointOfContact: PointOfContact_1.PointOfContact,