rcs-js 2.0.0-rc.9 → 2.0.1-rc.1

package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Get {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,11 +28,11 @@ export declare namespace Get {
 }
 export declare class Get {
     protected readonly _options: Get.Options;
-    constructor(_options: Get.Options);
+    constructor(_options?: Get.Options);
     /**
      * Retrieve a brand's status.
      *
-     * @param {number} brandId - ID of the brand.
+     * @param {string} brandId - The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -42,14 +42,14 @@ export declare class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.brand(28)
+     *     await client.status.get.brand("b_1234567890")
      */
-    brand(brandId: number, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.BrandStatus>;
+    brand(brandId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.BrandStatus>;
     private __brand;
     /**
      * Retrieve a toll-free campaign's status.
      *
-     * @param {number} campaignId - ID of the toll-free campaign.
+     * @param {string} campaignId - The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -59,14 +59,14 @@ export declare class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.tollFree(28)
+     *     await client.status.get.tollFree("tf_1234567890")
      */
-    tollFree(campaignId: number, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignStatus>;
+    tollFree(campaignId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignStatus>;
     private __tollFree;
     /**
-     * Retrieve a DLC campaign's status.
+     * Retrieve a 10DLC campaign's status.
      *
-     * @param {number} campaignId - ID of the DLC campaign.
+     * @param {string} campaignId - The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -76,14 +76,14 @@ export declare class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.dlc(28)
+     *     await client.status.get.dlc("dlc_1234567890")
      */
-    dlc(campaignId: number, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignStatus>;
+    dlc(campaignId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignStatus>;
     private __dlc;
     /**
      * Retrieve a RCS campaign's status.
      *
-     * @param {number} campaignId - ID of the campaign.
+     * @param {string} campaignId - The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -93,9 +93,9 @@ export declare class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.rcs(28)
+     *     await client.status.get.rcs("rcs_1234567890")
      */
-    rcs(campaignId: number, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsCampaignStatus>;
+    rcs(campaignId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsCampaignStatus>;
     private __rcs;
     /**
      * Retrieve a phone number's order status and campaign attachment status. <br>
@@ -117,6 +117,6 @@ export declare class Get {
     phoneNumber(phoneNumber: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.PhoneNumberStatus>;
     private __phoneNumber;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/cjs/api/resources/status/resources/get/client/Client.js

@@ -52,13 +52,13 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
 const headers_js_1 = require("../../../../../../core/headers.js");
 const errors = __importStar(require("../../../../../../errors/index.js"));
 class Get {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
      * Retrieve a brand's status.
      *
-     * @param {number} brandId - ID of the brand.
+     * @param {string} brandId - The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -68,7 +68,7 @@ class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.brand(28)
+     *     await client.status.get.brand("b_1234567890")
      */
     brand(brandId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__brand(brandId, requestOptions));
@@ -129,7 +129,7 @@ class Get {
     /**
      * Retrieve a toll-free campaign's status.
      *
-     * @param {number} campaignId - ID of the toll-free campaign.
+     * @param {string} campaignId - The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -139,7 +139,7 @@ class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.tollFree(28)
+     *     await client.status.get.tollFree("tf_1234567890")
      */
     tollFree(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__tollFree(campaignId, requestOptions));
@@ -198,9 +198,9 @@ class Get {
         });
     }
     /**
-     * Retrieve a DLC campaign's status.
+     * Retrieve a 10DLC campaign's status.
      *
-     * @param {number} campaignId - ID of the DLC campaign.
+     * @param {string} campaignId - The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -210,7 +210,7 @@ class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.dlc(28)
+     *     await client.status.get.dlc("dlc_1234567890")
      */
     dlc(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__dlc(campaignId, requestOptions));
@@ -271,7 +271,7 @@ class Get {
     /**
      * Retrieve a RCS campaign's status.
      *
-     * @param {number} campaignId - ID of the campaign.
+     * @param {string} campaignId - The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -281,7 +281,7 @@ class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.rcs(28)
+     *     await client.status.get.rcs("rcs_1234567890")
      */
     rcs(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__rcs(campaignId, requestOptions));

package/dist/cjs/api/resources/tools/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare namespace Tools {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -21,7 +21,7 @@ export declare class Tools {
     protected _url: Url | undefined;
     protected _file: File_ | undefined;
     protected _contactCard: ContactCard | undefined;
-    constructor(_options: Tools.Options);
+    constructor(_options?: Tools.Options);
     get url(): Url;
     get file(): File_;
     get contactCard(): ContactCard;

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

@@ -8,7 +8,7 @@ const Client_js_1 = require("../resources/url/client/Client.js");
 const Client_js_2 = require("../resources/file/client/Client.js");
 const Client_js_3 = require("../resources/contactCard/client/Client.js");
 class Tools {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     get url() {

package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace ContactCard {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,9 +28,9 @@ export declare namespace ContactCard {
 }
 export declare class ContactCard {
     protected readonly _options: ContactCard.Options;
-    constructor(_options: ContactCard.Options);
+    constructor(_options?: ContactCard.Options);
     /**
-     * Retrieve contact information as a vCard and get a presigned URL to download the file.
+     * Retrieve contact information as a vCard and get a presigned URL to download the file. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media file.
      *
      * @param {Pinnacle.tools.GetVcardParams} request
      * @param {ContactCard.RequestOptions} requestOptions - Request-specific configuration.
@@ -41,13 +41,13 @@ export declare class ContactCard {
      *
      * @example
      *     await client.tools.contactCard.get({
-     *         id: 33
+     *         id: "cc_1234567890"
      *     })
      */
     get(request: Pinnacle.tools.GetVcardParams, requestOptions?: ContactCard.RequestOptions): core.HttpResponsePromise<Pinnacle.VCardData>;
     private __get;
     /**
-     * Create a new contact card or updates an existing one with full vCard data.
+     * Create a new contact card or updates an existing one with full vCard data. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media file.
      *
      * @param {Pinnacle.tools.UpsertVcardParams} request
      * @param {ContactCard.RequestOptions} requestOptions - Request-specific configuration.
@@ -58,7 +58,7 @@ export declare class ContactCard {
      *
      * @example
      *     await client.tools.contactCard.upsert({
-     *         id: 34,
+     *         id: "cc_1234567890",
      *         formattedName: "Jane Smith",
      *         name: {
      *             familyName: "Smith",
@@ -107,6 +107,6 @@ export declare class ContactCard {
     upsert(request?: Pinnacle.tools.UpsertVcardParams, requestOptions?: ContactCard.RequestOptions): core.HttpResponsePromise<Pinnacle.VcardResource>;
     private __upsert;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.js

@@ -52,11 +52,11 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
 const headers_js_1 = require("../../../../../../core/headers.js");
 const errors = __importStar(require("../../../../../../errors/index.js"));
 class ContactCard {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
-     * Retrieve contact information as a vCard and get a presigned URL to download the file.
+     * Retrieve contact information as a vCard and get a presigned URL to download the file. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media file.
      *
      * @param {Pinnacle.tools.GetVcardParams} request
      * @param {ContactCard.RequestOptions} requestOptions - Request-specific configuration.
@@ -67,7 +67,7 @@ class ContactCard {
      *
      * @example
      *     await client.tools.contactCard.get({
-     *         id: 33
+     *         id: "cc_1234567890"
      *     })
      */
     get(request, requestOptions) {
@@ -126,7 +126,7 @@ class ContactCard {
         });
     }
     /**
-     * Create a new contact card or updates an existing one with full vCard data.
+     * Create a new contact card or updates an existing one with full vCard data. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media file.
      *
      * @param {Pinnacle.tools.UpsertVcardParams} request
      * @param {ContactCard.RequestOptions} requestOptions - Request-specific configuration.
@@ -137,7 +137,7 @@ class ContactCard {
      *
      * @example
      *     await client.tools.contactCard.upsert({
-     *         id: 34,
+     *         id: "cc_1234567890",
      *         formattedName: "Jane Smith",
      *         name: {
      *             familyName: "Smith",

package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.ts

@@ -4,12 +4,12 @@
 /**
  * @example
  *     {
- *         id: 33
+ *         id: "cc_1234567890"
  *     }
  */
 export interface GetVcardParams {
-    /** ID of your contact. */
-    id: number;
+    /** The unique identifier of the contact. This identifier is a string that always begins with the prefix `cc_`, for example: `cc_1234567890`. */
+    id: string;
     options?: GetVcardParams.Options;
 }
 export declare namespace GetVcardParams {

package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.ts

@@ -5,7 +5,7 @@ import * as Pinnacle from "../../../../../../index.js";
 /**
  * @example
  *     {
- *         id: 34,
+ *         id: "cc_1234567890",
  *         formattedName: "Jane Smith",
  *         name: {
  *             familyName: "Smith",

package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace File_ {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,7 +28,7 @@ export declare namespace File_ {
 }
 export declare class File_ {
     protected readonly _options: File_.Options;
-    constructor(_options: File_.Options);
+    constructor(_options?: File_.Options);
     /**
      * Generate presigned URLs that let you upload files directly to our storage and allow your users to download them securely.
      *
@@ -53,7 +53,28 @@ export declare class File_ {
      */
     upload(request: Pinnacle.tools.UploadFileParams, requestOptions?: File_.RequestOptions): core.HttpResponsePromise<Pinnacle.UploadResults>;
     private __upload;
+    /**
+     * Refresh expiring presigned URLs for Pinnacle-hosted files to extend their access time.
+     *
+     * <Callout type="info">
+     *   This only works for presigned download URLs. At this moment, you cannot refresh a presigned upload URL, generate a new one instead.
+     * </Callout>
+     *
+     * @param {Pinnacle.tools.RefreshFileParams} request
+     * @param {File_.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.tools.file.refresh({
+     *         urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"]
+     *     })
+     */
+    refresh(request: Pinnacle.tools.RefreshFileParams, requestOptions?: File_.RequestOptions): core.HttpResponsePromise<Pinnacle.RefreshedFile[]>;
+    private __refresh;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/cjs/api/resources/tools/resources/file/client/Client.js

@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
 const headers_js_1 = require("../../../../../../core/headers.js");
 const errors = __importStar(require("../../../../../../errors/index.js"));
 class File_ {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -132,6 +132,80 @@ class File_ {
             }
         });
     }
+    /**
+     * Refresh expiring presigned URLs for Pinnacle-hosted files to extend their access time.
+     *
+     * <Callout type="info">
+     *   This only works for presigned download URLs. At this moment, you cannot refresh a presigned upload URL, generate a new one instead.
+     * </Callout>
+     *
+     * @param {Pinnacle.tools.RefreshFileParams} request
+     * @param {File_.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.tools.file.refresh({
+     *         urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"]
+     *     })
+     */
+    refresh(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__refresh(request, requestOptions));
+    }
+    __refresh(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), 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.PinnacleEnvironment.Default, "tools/files/refresh"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                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 { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PinnacleError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PinnacleError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /tools/files/refresh.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     _getCustomAuthorizationHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
             const apiKeyValue = yield core.Supplier.get(this._options.apiKey);

package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"]
+ *     }
+ */
+export interface RefreshFileParams {
+    /** Array of file URLs to refresh for extended access. Provided URLs must be presigned URLs (i.e. `https://server.trypinnacle.app/storage/v1/object/sign/...`). Invalid or external URLs will be returned unchanged in the response. */
+    urls: string[];
+}

package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/tools/resources/file/client/requests/index.d.ts

@@ -1 +1,2 @@
 export { type UploadFileParams } from "./UploadFileParams.js";
+export { type RefreshFileParams } from "./RefreshFileParams.js";

package/dist/cjs/api/resources/tools/resources/url/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Url {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,7 +28,7 @@ export declare namespace Url {
 }
 export declare class Url {
     protected readonly _options: Url.Options;
-    constructor(_options: Url.Options);
+    constructor(_options?: Url.Options);
     /**
      * Create a shortened URL that redirects visitors to the provided destination URL.
      *
@@ -67,7 +67,7 @@ export declare class Url {
     get(linkId: string, requestOptions?: Url.RequestOptions): core.HttpResponsePromise<Pinnacle.ShortenedUrlWithClickData>;
     private __get;
     /**
-     * Update the destination or configuration of an existing shortened URL.
+     * Update the destination or expiration date of an existing shortened URL. Expiring links cannot be updated into a permalink.
      *
      * @param {string} linkId - Unique identifier from your shortened URL. For example, for `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`. <br>
      *
@@ -87,6 +87,6 @@ export declare class Url {
     update(linkId: string, request?: Pinnacle.tools.UpdateUrlParams, requestOptions?: Url.RequestOptions): core.HttpResponsePromise<Pinnacle.ShortenedUrl>;
     private __update;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/cjs/api/resources/tools/resources/url/client/Client.js

@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
 const headers_js_1 = require("../../../../../../core/headers.js");
 const errors = __importStar(require("../../../../../../errors/index.js"));
 class Url {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -196,7 +196,7 @@ class Url {
         });
     }
     /**
-     * Update the destination or configuration of an existing shortened URL.
+     * Update the destination or expiration date of an existing shortened URL. Expiring links cannot be updated into a permalink.
      *
      * @param {string} linkId - Unique identifier from your shortened URL. For example, for `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`. <br>
      *

package/dist/cjs/api/resources/webhooks/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Webhooks {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,7 +28,7 @@ export declare namespace Webhooks {
 }
 export declare class Webhooks {
     protected readonly _options: Webhooks.Options;
-    constructor(_options: Webhooks.Options);
+    constructor(_options?: Webhooks.Options);
     /**
      * Retrieve all webhook that are set up to receive events for specific URLs or phone numbers.
      *
@@ -47,6 +47,6 @@ export declare class Webhooks {
     get(request: Pinnacle.GetWebhookParams, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<Pinnacle.WebhookResult>;
     private __get;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

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

@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../index.js"));
 const headers_js_1 = require("../../../../core/headers.js");
 const errors = __importStar(require("../../../../errors/index.js"));
 class Webhooks {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**

package/dist/cjs/api/types/AdvancedPhoneInformation.d.ts

@@ -22,7 +22,7 @@ export interface AdvancedPhoneInformation {
     /** Detailed carrier information. */
     carrier: AdvancedPhoneInformation.Carrier;
     /** Enhanced contact information associated with the phone number. */
-    contact?: AdvancedPhoneInformation.Contact | null;
+    contact: AdvancedPhoneInformation.Contact | null;
 }
 export declare namespace AdvancedPhoneInformation {
     /**
@@ -68,25 +68,25 @@ export declare namespace AdvancedPhoneInformation {
         /** Complete country identification and metadata. */
         country: Location.Country;
         /** Primary city or municipality associated with the phone number. */
-        city?: string | null;
+        city: string | null;
         /**
          * State, province, or primary administrative division code.
          * Uses standard 2-letter abbreviations where applicable.
          */
-        state?: string | null;
+        state: string | null;
         /** Postal or ZIP code for the phone number's registered location. */
-        zip?: string | null;
+        zip: string | null;
         /**
          * Primary Metropolitan Statistical Area (PMSA) code for US numbers.
          * Used for demographic and market analysis purposes.
          */
-        metroCode?: string | null;
+        metroCode: string | null;
         /** County or secondary administrative division name. */
-        county?: string | null;
+        county: string | null;
         /** Coordinates provide the precise latitude and longitude values for the phone number’s registered location. */
         coordinates: Location.Coordinates;
         /** IANA timezone identifier for the number’s location. */
-        timeZone?: string | null;
+        timeZone: string | null;
     }
     namespace Location {
         /**
@@ -105,9 +105,9 @@ export declare namespace AdvancedPhoneInformation {
          */
         interface Coordinates {
             /** Decimal degrees latitude coordinate. */
-            latitude?: number | null;
+            latitude: number | null;
             /** Decimal degrees longitude coordinate. */
-            longitude?: number | null;
+            longitude: number | null;
         }
     }
     /**

package/dist/cjs/api/types/AttachWebhookParams.d.ts

@@ -10,13 +10,13 @@ export type AttachWebhookParams =
 /**
  * Attach a webhook you’ve already created in your account to this phone number. */
 {
-    webhookId: number;
-    event?: (Pinnacle.WebhookEventEnum | null) | undefined;
+    webhookId: string;
+    event: Pinnacle.WebhookEventEnum | null;
 }
 /**
  * Create a new webhook and immediately attach it to your phone number. */
  | {
     name: string;
     url: string;
-    event?: (Pinnacle.WebhookEventEnum | null) | undefined;
+    event: Pinnacle.WebhookEventEnum | null;
 };