twilio 5.5.0 → 5.5.2

package/lib/rest/video/v1/room/participant/anonymize.d.ts

@@ -1,6 +1,9 @@
 /// <reference types="node" />
 import { inspect, InspectOptions } from "util";
 import V1 from "../../../V1";
+/**
+ * The status of the Participant. Can be: `connected` or `disconnected`.
+ */
 export type AnonymizeStatus = "connected" | "disconnected";
 export interface AnonymizeContext {
     /**

package/lib/rest/video/v1/room/participant/publishedTrack.d.ts

@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
 import Page, { TwilioResponsePayload } from "../../../../../base/Page";
 import Response from "../../../../../http/response";
 import V1 from "../../../V1";
+/**
+ * The track type. Can be: `audio`, `video` or `data`.
+ */
 export type PublishedTrackKind = "audio" | "video" | "data";
 /**
  * Options to pass to each

package/lib/rest/video/v1/room/participant/subscribedTrack.d.ts

@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
 import Page, { TwilioResponsePayload } from "../../../../../base/Page";
 import Response from "../../../../../http/response";
 import V1 from "../../../V1";
+/**
+ * The track type. Can be: `audio`, `video` or `data`.
+ */
 export type SubscribedTrackKind = "audio" | "video" | "data";
 /**
  * Options to pass to each

package/lib/rest/video/v1/room/participant.d.ts

@@ -7,7 +7,10 @@ import { AnonymizeListInstance } from "./participant/anonymize";
 import { PublishedTrackListInstance } from "./participant/publishedTrack";
 import { SubscribeRulesListInstance } from "./participant/subscribeRules";
 import { SubscribedTrackListInstance } from "./participant/subscribedTrack";
-export type ParticipantStatus = "connected" | "disconnected";
+/**
+ * The status of the Participant. Can be: `connected` or `disconnected`.
+ */
+export type ParticipantStatus = "connected" | "disconnected" | "reconnecting";
 /**
  * Options to pass to update a ParticipantInstance
  */

package/lib/rest/video/v1/room/roomRecording.d.ts

@@ -3,9 +3,18 @@ import { inspect, InspectOptions } from "util";
 import Page, { TwilioResponsePayload } from "../../../../base/Page";
 import Response from "../../../../http/response";
 import V1 from "../../V1";
+/**
+ * The codec used for the recording. Can be: `VP8` or `H264`.
+ */
 export type RoomRecordingCodec = "VP8" | "H264" | "OPUS" | "PCMU";
 export type RoomRecordingFormat = "mka" | "mkv";
+/**
+ * The status of the recording. Can be: `processing`, `completed`, or `deleted`. `processing` indicates the Recording is still being captured. `completed` indicates the Recording has been captured and is now available for download. `deleted` means the recording media has been deleted from the system, but its metadata is still available for historical purposes.
+ */
 export type RoomRecordingStatus = "processing" | "completed" | "deleted" | "failed";
+/**
+ * The recording\'s media type. Can be: `audio` or `video`.
+ */
 export type RoomRecordingType = "audio" | "video" | "data";
 /**
  * Options to pass to each

package/lib/rest/wireless/v1/command.d.ts

@@ -3,9 +3,21 @@ import { inspect, InspectOptions } from "util";
 import Page, { TwilioResponsePayload } from "../../../base/Page";
 import Response from "../../../http/response";
 import V1 from "../V1";
+/**
+ * The mode used to send the SMS message. Can be: `text` or `binary`. The default SMS mode is `text`.
+ */
 export type CommandCommandMode = "text" | "binary";
+/**
+ * The direction of the Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`.
+ */
 export type CommandDirection = "from_sim" | "to_sim";
+/**
+ * The status of the Command. Can be: `queued`, `sent`, `delivered`, `received`, or `failed`. See [Status Values](https://www.twilio.com/docs/iot/wireless/api/command-resource#status-values) for a description of each state.
+ */
 export type CommandStatus = "queued" | "sent" | "delivered" | "received" | "failed";
+/**
+ * The type of transport used. Can be: `sms` or `ip`.
+ */
 export type CommandTransport = "sms" | "ip";
 /**
  * Options to pass to create a CommandInstance

package/lib/rest/wireless/v1/ratePlan.d.ts

@@ -3,6 +3,10 @@ import { inspect, InspectOptions } from "util";
 import Page, { TwilioResponsePayload } from "../../../base/Page";
 import Response from "../../../http/response";
 import V1 from "../V1";
+/**
+ * The way the home network (T-Mobile USA) will behave after a SIM\'s usage exceeds its `data_limit`. Can be either `block` or `throttle`. Default is `block`.
+ */
+export type RatePlanDataLimitStrategy = "block" | "throttle";
 /**
  * Options to pass to update a RatePlanInstance
  */
@@ -38,6 +42,8 @@ export interface RatePlanListInstanceCreateOptions {
     nationalRoamingDataLimit?: number;
     /** The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States. Can be up to 2TB. */
     internationalRoamingDataLimit?: number;
+    /**  */
+    dataLimitStrategy?: RatePlanDataLimitStrategy;
 }
 /**
  * Options to pass to each

package/lib/rest/wireless/v1/ratePlan.js

@@ -215,6 +215,8 @@ function RatePlanListInstance(version) {
         if (params["internationalRoamingDataLimit"] !== undefined)
             data["InternationalRoamingDataLimit"] =
                 params["internationalRoamingDataLimit"];
+        if (params["dataLimitStrategy"] !== undefined)
+            data["DataLimitStrategy"] = params["dataLimitStrategy"];
         const headers = {};
         headers["Content-Type"] = "application/x-www-form-urlencoded";
         headers["Accept"] = "application/json";

package/lib/rest/wireless/v1/sim.d.ts

@@ -5,7 +5,13 @@ import Response from "../../../http/response";
 import V1 from "../V1";
 import { DataSessionListInstance } from "./sim/dataSession";
 import { UsageRecordListInstance } from "./sim/usageRecord";
+/**
+ * The connectivity reset status of the SIM. Can be: null or `resetting`. When a connectivity reset is initiated on a SIM, this property is `resetting`. After the reset completes, it is null.
+ */
 export type SimResetStatus = "resetting";
+/**
+ * The status of the Sim resource. Can be: `new`, `ready`, `active`, `deactivated`, `canceled`, `deleted`, `scheduled`, or `updating`. See [Status Values](https://www.twilio.com/docs/iot/wireless/api/sim-resource#status-values) for the description of each status.
+ */
 export type SimStatus = "new" | "ready" | "active" | "suspended" | "deactivated" | "canceled" | "scheduled" | "updating";
 /**
  * Options to pass to update a SimInstance

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "twilio",
   "description": "A Twilio helper library",
-  "version": "5.5.0",
+  "version": "5.5.2",
   "author": "API Team <api@twilio.com>",
   "contributors": [
     {

package/lib/rest/preview/Sync.d.ts

@@ -1,15 +0,0 @@
-import PreviewBase from "../PreviewBase";
-import Version from "../../base/Version";
-import { ServiceListInstance } from "./sync/service";
-export default class Sync extends Version {
-    /**
-     * Initialize the Sync version of Preview
-     *
-     * @param domain - The Twilio (Twilio.Preview) domain
-     */
-    constructor(domain: PreviewBase);
-    /** services - { Twilio.Preview.Sync.ServiceListInstance } resource */
-    protected _services?: ServiceListInstance;
-    /** Getter for services resource */
-    get services(): ServiceListInstance;
-}

package/lib/rest/preview/sync/service/document/documentPermission.d.ts

@@ -1,280 +0,0 @@
-/// <reference types="node" />
-import { inspect, InspectOptions } from "util";
-import Page, { TwilioResponsePayload } from "../../../../../base/Page";
-import Response from "../../../../../http/response";
-import Sync from "../../../Sync";
-/**
- * Options to pass to update a DocumentPermissionInstance
- */
-export interface DocumentPermissionContextUpdateOptions {
-    /** Boolean flag specifying whether the identity can read the Sync Document. */
-    read: boolean;
-    /** Boolean flag specifying whether the identity can update the Sync Document. */
-    write: boolean;
-    /** Boolean flag specifying whether the identity can delete the Sync Document. */
-    manage: boolean;
-}
-/**
- * Options to pass to each
- */
-export interface DocumentPermissionListInstanceEachOptions {
-    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
-    pageSize?: number;
-    /** Function to process each record. If this and a positional callback are passed, this one will be used */
-    callback?: (item: DocumentPermissionInstance, done: (err?: Error) => void) => void;
-    /** Function to be called upon completion of streaming */
-    done?: Function;
-    /** Upper limit for the number of records to return. each() guarantees never to return more than limit. Default is no limit */
-    limit?: number;
-}
-/**
- * Options to pass to list
- */
-export interface DocumentPermissionListInstanceOptions {
-    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
-    pageSize?: number;
-    /** Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit */
-    limit?: number;
-}
-/**
- * Options to pass to page
- */
-export interface DocumentPermissionListInstancePageOptions {
-    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
-    pageSize?: number;
-    /** Page Number, this value is simply for client state */
-    pageNumber?: number;
-    /** PageToken provided by the API */
-    pageToken?: string;
-}
-export interface DocumentPermissionContext {
-    /**
-     * Remove a DocumentPermissionInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a DocumentPermissionInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DocumentPermissionInstance
-     */
-    fetch(callback?: (error: Error | null, item?: DocumentPermissionInstance) => any): Promise<DocumentPermissionInstance>;
-    /**
-     * Update a DocumentPermissionInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DocumentPermissionInstance
-     */
-    update(params: DocumentPermissionContextUpdateOptions, callback?: (error: Error | null, item?: DocumentPermissionInstance) => any): Promise<DocumentPermissionInstance>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export interface DocumentPermissionContextSolution {
-    serviceSid: string;
-    documentSid: string;
-    identity: string;
-}
-export declare class DocumentPermissionContextImpl implements DocumentPermissionContext {
-    protected _version: Sync;
-    protected _solution: DocumentPermissionContextSolution;
-    protected _uri: string;
-    constructor(_version: Sync, serviceSid: string, documentSid: string, identity: string);
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    fetch(callback?: (error: Error | null, item?: DocumentPermissionInstance) => any): Promise<DocumentPermissionInstance>;
-    update(params: DocumentPermissionContextUpdateOptions, callback?: (error: Error | null, item?: DocumentPermissionInstance) => any): Promise<DocumentPermissionInstance>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): DocumentPermissionContextSolution;
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-interface DocumentPermissionPayload extends TwilioResponsePayload {
-    permissions: DocumentPermissionResource[];
-}
-interface DocumentPermissionResource {
-    account_sid: string;
-    service_sid: string;
-    document_sid: string;
-    identity: string;
-    read: boolean;
-    write: boolean;
-    manage: boolean;
-    url: string;
-}
-export declare class DocumentPermissionInstance {
-    protected _version: Sync;
-    protected _solution: DocumentPermissionContextSolution;
-    protected _context?: DocumentPermissionContext;
-    constructor(_version: Sync, payload: DocumentPermissionResource, serviceSid: string, documentSid: string, identity?: string);
-    /**
-     * The unique SID identifier of the Twilio Account.
-     */
-    accountSid: string;
-    /**
-     * The unique SID identifier of the Sync Service Instance.
-     */
-    serviceSid: string;
-    /**
-     * The unique SID identifier of the Sync Document to which the Permission applies.
-     */
-    documentSid: string;
-    /**
-     * Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.
-     */
-    identity: string;
-    /**
-     * Boolean flag specifying whether the identity can read the Sync Document.
-     */
-    read: boolean;
-    /**
-     * Boolean flag specifying whether the identity can update the Sync Document.
-     */
-    write: boolean;
-    /**
-     * Boolean flag specifying whether the identity can delete the Sync Document.
-     */
-    manage: boolean;
-    /**
-     * Contains an absolute URL for this Sync Document Permission.
-     */
-    url: string;
-    private get _proxy();
-    /**
-     * Remove a DocumentPermissionInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a DocumentPermissionInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DocumentPermissionInstance
-     */
-    fetch(callback?: (error: Error | null, item?: DocumentPermissionInstance) => any): Promise<DocumentPermissionInstance>;
-    /**
-     * Update a DocumentPermissionInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DocumentPermissionInstance
-     */
-    update(params: DocumentPermissionContextUpdateOptions, callback?: (error: Error | null, item?: DocumentPermissionInstance) => any): Promise<DocumentPermissionInstance>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): {
-        accountSid: string;
-        serviceSid: string;
-        documentSid: string;
-        identity: string;
-        read: boolean;
-        write: boolean;
-        manage: boolean;
-        url: string;
-    };
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-export interface DocumentPermissionSolution {
-    serviceSid: string;
-    documentSid: string;
-}
-export interface DocumentPermissionListInstance {
-    _version: Sync;
-    _solution: DocumentPermissionSolution;
-    _uri: string;
-    (identity: string): DocumentPermissionContext;
-    get(identity: string): DocumentPermissionContext;
-    /**
-     * Streams DocumentPermissionInstance records from the API.
-     *
-     * This operation lazily loads records as efficiently as possible until the limit
-     * is reached.
-     *
-     * The results are passed into the callback function, so this operation is memory
-     * efficient.
-     *
-     * If a function is passed as the first argument, it will be used as the callback
-     * function.
-     *
-     * @param { DocumentPermissionListInstanceEachOptions } [params] - Options for request
-     * @param { function } [callback] - Function to process each record
-     */
-    each(callback?: (item: DocumentPermissionInstance, done: (err?: Error) => void) => void): void;
-    each(params: DocumentPermissionListInstanceEachOptions, callback?: (item: DocumentPermissionInstance, done: (err?: Error) => void) => void): void;
-    /**
-     * Retrieve a single target page of DocumentPermissionInstance records from the API.
-     *
-     * The request is executed immediately.
-     *
-     * @param { string } [targetUrl] - API-generated URL for the requested results page
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    getPage(targetUrl: string, callback?: (error: Error | null, items: DocumentPermissionPage) => any): Promise<DocumentPermissionPage>;
-    /**
-     * Lists DocumentPermissionInstance records from the API as a list.
-     *
-     * If a function is passed as the first argument, it will be used as the callback
-     * function.
-     *
-     * @param { DocumentPermissionListInstanceOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    list(callback?: (error: Error | null, items: DocumentPermissionInstance[]) => any): Promise<DocumentPermissionInstance[]>;
-    list(params: DocumentPermissionListInstanceOptions, callback?: (error: Error | null, items: DocumentPermissionInstance[]) => any): Promise<DocumentPermissionInstance[]>;
-    /**
-     * Retrieve a single page of DocumentPermissionInstance records from the API.
-     *
-     * The request is executed immediately.
-     *
-     * If a function is passed as the first argument, it will be used as the callback
-     * function.
-     *
-     * @param { DocumentPermissionListInstancePageOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    page(callback?: (error: Error | null, items: DocumentPermissionPage) => any): Promise<DocumentPermissionPage>;
-    page(params: DocumentPermissionListInstancePageOptions, callback?: (error: Error | null, items: DocumentPermissionPage) => any): Promise<DocumentPermissionPage>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export declare function DocumentPermissionListInstance(version: Sync, serviceSid: string, documentSid: string): DocumentPermissionListInstance;
-export declare class DocumentPermissionPage extends Page<Sync, DocumentPermissionPayload, DocumentPermissionResource, DocumentPermissionInstance> {
-    /**
-     * Initialize the DocumentPermissionPage
-     *
-     * @param version - Version of the resource
-     * @param response - Response from the API
-     * @param solution - Path solution
-     */
-    constructor(version: Sync, response: Response<string>, solution: DocumentPermissionSolution);
-    /**
-     * Build an instance of DocumentPermissionInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload: DocumentPermissionResource): DocumentPermissionInstance;
-    [inspect.custom](depth: any, options: InspectOptions): string;
-}
-export {};