twilio 5.3.2 → 5.3.4

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

@@ -26,21 +26,21 @@ export interface RoomListInstanceCreateOptions {
     type?: RoomRoomType;
     /** An application-defined string that uniquely identifies the resource. It can be used as a `room_sid` in place of the resource\\\'s `sid` in the URL to address the resource, assuming it does not contain any [reserved characters](https://tools.ietf.org/html/rfc3986#section-2.2) that would need to be URL encoded. This value is unique for `in-progress` rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is `in-progress`. */
     uniqueName?: string;
-    /** The URL we should call using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info. */
+    /** The URL Twilio should call using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info. */
     statusCallback?: string;
-    /** The HTTP method we should use to call `status_callback`. Can be `POST` or `GET`. */
+    /** The HTTP method Twilio should use to call `status_callback`. Can be `POST` or `GET`. */
     statusCallbackMethod?: string;
-    /** The maximum number of concurrent Participants allowed in the room. Peer-to-peer rooms can have up to 10 Participants. Small Group rooms can have up to 4 Participants. Group rooms can have up to 50 Participants. */
+    /** The maximum number of concurrent Participants allowed in the room. The maximum allowed value is 50. */
     maxParticipants?: number;
-    /** Whether to start recording when Participants connect. ***This feature is not available in `peer-to-peer` rooms.*** */
+    /** Whether to start recording when Participants connect. */
     recordParticipantsOnConnect?: boolean;
-    /** An array of the video codecs that are supported when publishing a track in the room.  Can be: `VP8` and `H264`.  ***This feature is not available in `peer-to-peer` rooms*** */
+    /** An array of the video codecs that are supported when publishing a track in the room.  Can be: `VP8` and `H264`. */
     videoCodecs?: Array<RoomVideoCodec>;
-    /** The region for the media server in Group Rooms.  Can be: one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#group-rooms-media-servers). ***This feature is not available in `peer-to-peer` rooms.*** */
+    /** The region for the Room\\\'s media server.  Can be one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#group-rooms-media-servers). */
     mediaRegion?: string;
     /** A collection of Recording Rules that describe how to include or exclude matching tracks for recording */
     recordingRules?: any;
-    /** When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed. Group rooms only. */
+    /** When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed. */
     audioOnly?: boolean;
     /** The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours). The default is 14400 seconds (4 hours). */
     maxParticipantDuration?: number;
@@ -194,7 +194,7 @@ export declare class RoomInstance {
     protected _context?: RoomContext;
     constructor(_version: V1, payload: RoomResource, sid?: string);
     /**
-     * The unique string that we created to identify the Room resource.
+     * The unique string that Twilio created to identify the Room resource.
      */
     sid: string;
     status: RoomRoomStatus;
@@ -219,11 +219,11 @@ export declare class RoomInstance {
      */
     uniqueName: string;
     /**
-     * The URL we call using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info.
+     * The URL Twilio calls using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info.
      */
     statusCallback: string;
     /**
-     * The HTTP method we use to call `status_callback`. Can be `POST` or `GET` and defaults to `POST`.
+     * The HTTP method Twilio uses to call `status_callback`. Can be `POST` or `GET` and defaults to `POST`.
      */
     statusCallbackMethod: string;
     /**
@@ -248,19 +248,19 @@ export declare class RoomInstance {
      */
     maxConcurrentPublishedTracks: number;
     /**
-     * Whether to start recording when Participants connect. ***This feature is not available in `peer-to-peer` rooms.***
+     * Whether to start recording when Participants connect.
      */
     recordParticipantsOnConnect: boolean;
     /**
-     * An array of the video codecs that are supported when publishing a track in the room.  Can be: `VP8` and `H264`.  ***This feature is not available in `peer-to-peer` rooms***
+     * An array of the video codecs that are supported when publishing a track in the room.  Can be: `VP8` and `H264`.
      */
     videoCodecs: Array<RoomVideoCodec>;
     /**
-     * The region for the media server in Group Rooms.  Can be: one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#media-servers). ***This feature is not available in `peer-to-peer` rooms.***
+     * The region for the Room\'s media server.  Can be one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#media-servers).
      */
     mediaRegion: string;
     /**
-     * When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed. Group rooms only.
+     * When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed.
      */
     audioOnly: boolean;
     /**

package/lib/webhooks/webhooks.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import { IncomingHttpHeaders } from "http2";
 export interface Request {
     protocol: string;

package/package.json

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

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

@@ -1,15 +0,0 @@
-import PreviewBase from "../PreviewBase";
-import Version from "../../base/Version";
-import { FleetListInstance } from "./deployed_devices/fleet";
-export default class DeployedDevices extends Version {
-    /**
-     * Initialize the DeployedDevices version of Preview
-     *
-     * @param domain - The Twilio (Twilio.Preview) domain
-     */
-    constructor(domain: PreviewBase);
-    /** fleets - { Twilio.Preview.DeployedDevices.FleetListInstance } resource */
-    protected _fleets?: FleetListInstance;
-    /** Getter for fleets resource */
-    get fleets(): FleetListInstance;
-}

package/lib/rest/preview/DeployedDevices.js

@@ -1,36 +0,0 @@
-"use strict";
-/*
- * This code was generated by
- * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
- *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
- *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
- *
- * Twilio - Preview
- * This is the public Twilio REST API.
- *
- * NOTE: This class is auto generated by OpenAPI Generator.
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const Version_1 = __importDefault(require("../../base/Version"));
-const fleet_1 = require("./deployed_devices/fleet");
-class DeployedDevices extends Version_1.default {
-    /**
-     * Initialize the DeployedDevices version of Preview
-     *
-     * @param domain - The Twilio (Twilio.Preview) domain
-     */
-    constructor(domain) {
-        super(domain, "DeployedDevices");
-    }
-    /** Getter for fleets resource */
-    get fleets() {
-        this._fleets = this._fleets || (0, fleet_1.FleetListInstance)(this);
-        return this._fleets;
-    }
-}
-exports.default = DeployedDevices;

package/lib/rest/preview/deployed_devices/fleet/certificate.d.ts

@@ -1,324 +0,0 @@
-/// <reference types="node" />
-import { inspect, InspectOptions } from "util";
-import Page, { TwilioResponsePayload } from "../../../../base/Page";
-import Response from "../../../../http/response";
-import DeployedDevices from "../../DeployedDevices";
-/**
- * Options to pass to update a CertificateInstance
- */
-export interface CertificateContextUpdateOptions {
-    /** Provides a human readable descriptive text for this Certificate credential, up to 256 characters long. */
-    friendlyName?: string;
-    /** Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential. */
-    deviceSid?: string;
-}
-/**
- * Options to pass to create a CertificateInstance
- */
-export interface CertificateListInstanceCreateOptions {
-    /** Provides a URL encoded representation of the public certificate in PEM format. */
-    certificateData: string;
-    /** Provides a human readable descriptive text for this Certificate credential, up to 256 characters long. */
-    friendlyName?: string;
-    /** Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential. */
-    deviceSid?: string;
-}
-/**
- * Options to pass to each
- */
-export interface CertificateListInstanceEachOptions {
-    /** Filters the resulting list of Certificates by a unique string identifier of an authenticated Device. */
-    deviceSid?: string;
-    /** 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: CertificateInstance, 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 CertificateListInstanceOptions {
-    /** Filters the resulting list of Certificates by a unique string identifier of an authenticated Device. */
-    deviceSid?: string;
-    /** 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 CertificateListInstancePageOptions {
-    /** Filters the resulting list of Certificates by a unique string identifier of an authenticated Device. */
-    deviceSid?: string;
-    /** 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 CertificateContext {
-    /**
-     * Remove a CertificateInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a CertificateInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed CertificateInstance
-     */
-    fetch(callback?: (error: Error | null, item?: CertificateInstance) => any): Promise<CertificateInstance>;
-    /**
-     * Update a CertificateInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed CertificateInstance
-     */
-    update(callback?: (error: Error | null, item?: CertificateInstance) => any): Promise<CertificateInstance>;
-    /**
-     * Update a CertificateInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed CertificateInstance
-     */
-    update(params: CertificateContextUpdateOptions, callback?: (error: Error | null, item?: CertificateInstance) => any): Promise<CertificateInstance>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export interface CertificateContextSolution {
-    fleetSid: string;
-    sid: string;
-}
-export declare class CertificateContextImpl implements CertificateContext {
-    protected _version: DeployedDevices;
-    protected _solution: CertificateContextSolution;
-    protected _uri: string;
-    constructor(_version: DeployedDevices, fleetSid: string, sid: string);
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    fetch(callback?: (error: Error | null, item?: CertificateInstance) => any): Promise<CertificateInstance>;
-    update(params?: CertificateContextUpdateOptions | ((error: Error | null, item?: CertificateInstance) => any), callback?: (error: Error | null, item?: CertificateInstance) => any): Promise<CertificateInstance>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): CertificateContextSolution;
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-interface CertificatePayload extends TwilioResponsePayload {
-    certificates: CertificateResource[];
-}
-interface CertificateResource {
-    sid: string;
-    url: string;
-    friendly_name: string;
-    fleet_sid: string;
-    account_sid: string;
-    device_sid: string;
-    thumbprint: string;
-    date_created: Date;
-    date_updated: Date;
-}
-export declare class CertificateInstance {
-    protected _version: DeployedDevices;
-    protected _solution: CertificateContextSolution;
-    protected _context?: CertificateContext;
-    constructor(_version: DeployedDevices, payload: CertificateResource, fleetSid: string, sid?: string);
-    /**
-     * Contains a 34 character string that uniquely identifies this Certificate credential resource.
-     */
-    sid: string;
-    /**
-     * Contains an absolute URL for this Certificate credential resource.
-     */
-    url: string;
-    /**
-     * Contains a human readable descriptive text for this Certificate credential, up to 256 characters long.
-     */
-    friendlyName: string;
-    /**
-     * Specifies the unique string identifier of the Fleet that the given Certificate credential belongs to.
-     */
-    fleetSid: string;
-    /**
-     * Specifies the unique string identifier of the Account responsible for this Certificate credential.
-     */
-    accountSid: string;
-    /**
-     * Specifies the unique string identifier of a Device authenticated with this Certificate credential.
-     */
-    deviceSid: string;
-    /**
-     * Contains a unique hash of the payload of this Certificate credential, used to authenticate the Device.
-     */
-    thumbprint: string;
-    /**
-     * Specifies the date this Certificate credential was created, given in UTC ISO 8601 format.
-     */
-    dateCreated: Date;
-    /**
-     * Specifies the date this Certificate credential was last updated, given in UTC ISO 8601 format.
-     */
-    dateUpdated: Date;
-    private get _proxy();
-    /**
-     * Remove a CertificateInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a CertificateInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed CertificateInstance
-     */
-    fetch(callback?: (error: Error | null, item?: CertificateInstance) => any): Promise<CertificateInstance>;
-    /**
-     * Update a CertificateInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed CertificateInstance
-     */
-    update(callback?: (error: Error | null, item?: CertificateInstance) => any): Promise<CertificateInstance>;
-    /**
-     * Update a CertificateInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed CertificateInstance
-     */
-    update(params: CertificateContextUpdateOptions, callback?: (error: Error | null, item?: CertificateInstance) => any): Promise<CertificateInstance>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): {
-        sid: string;
-        url: string;
-        friendlyName: string;
-        fleetSid: string;
-        accountSid: string;
-        deviceSid: string;
-        thumbprint: string;
-        dateCreated: Date;
-        dateUpdated: Date;
-    };
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-export interface CertificateSolution {
-    fleetSid: string;
-}
-export interface CertificateListInstance {
-    _version: DeployedDevices;
-    _solution: CertificateSolution;
-    _uri: string;
-    (sid: string): CertificateContext;
-    get(sid: string): CertificateContext;
-    /**
-     * Create a CertificateInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed CertificateInstance
-     */
-    create(params: CertificateListInstanceCreateOptions, callback?: (error: Error | null, item?: CertificateInstance) => any): Promise<CertificateInstance>;
-    /**
-     * Streams CertificateInstance 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 { CertificateListInstanceEachOptions } [params] - Options for request
-     * @param { function } [callback] - Function to process each record
-     */
-    each(callback?: (item: CertificateInstance, done: (err?: Error) => void) => void): void;
-    each(params: CertificateListInstanceEachOptions, callback?: (item: CertificateInstance, done: (err?: Error) => void) => void): void;
-    /**
-     * Retrieve a single target page of CertificateInstance 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: CertificatePage) => any): Promise<CertificatePage>;
-    /**
-     * Lists CertificateInstance 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 { CertificateListInstanceOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    list(callback?: (error: Error | null, items: CertificateInstance[]) => any): Promise<CertificateInstance[]>;
-    list(params: CertificateListInstanceOptions, callback?: (error: Error | null, items: CertificateInstance[]) => any): Promise<CertificateInstance[]>;
-    /**
-     * Retrieve a single page of CertificateInstance 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 { CertificateListInstancePageOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    page(callback?: (error: Error | null, items: CertificatePage) => any): Promise<CertificatePage>;
-    page(params: CertificateListInstancePageOptions, callback?: (error: Error | null, items: CertificatePage) => any): Promise<CertificatePage>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export declare function CertificateListInstance(version: DeployedDevices, fleetSid: string): CertificateListInstance;
-export declare class CertificatePage extends Page<DeployedDevices, CertificatePayload, CertificateResource, CertificateInstance> {
-    /**
-     * Initialize the CertificatePage
-     *
-     * @param version - Version of the resource
-     * @param response - Response from the API
-     * @param solution - Path solution
-     */
-    constructor(version: DeployedDevices, response: Response<string>, solution: CertificateSolution);
-    /**
-     * Build an instance of CertificateInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload: CertificateResource): CertificateInstance;
-    [inspect.custom](depth: any, options: InspectOptions): string;
-}
-export {};