twilio 4.6.0 → 4.7.0

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

@@ -0,0 +1,233 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../../base/Page";
+import Response from "../../../../http/response";
+import V1 from "../../V1";
+/**
+ * Options to pass to each
+ */
+export interface DataSessionListInstanceEachOptions {
+    /** 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: DataSessionInstance, 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 DataSessionListInstanceOptions {
+    /** 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 DataSessionListInstancePageOptions {
+    /** 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 DataSessionSolution {
+    simSid: string;
+}
+export interface DataSessionListInstance {
+    _version: V1;
+    _solution: DataSessionSolution;
+    _uri: string;
+    /**
+     * Streams DataSessionInstance 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 { DataSessionListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: DataSessionInstance, done: (err?: Error) => void) => void): void;
+    each(params: DataSessionListInstanceEachOptions, callback?: (item: DataSessionInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of DataSessionInstance 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: DataSessionPage) => any): Promise<DataSessionPage>;
+    /**
+     * Lists DataSessionInstance 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 { DataSessionListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: DataSessionInstance[]) => any): Promise<DataSessionInstance[]>;
+    list(params: DataSessionListInstanceOptions, callback?: (error: Error | null, items: DataSessionInstance[]) => any): Promise<DataSessionInstance[]>;
+    /**
+     * Retrieve a single page of DataSessionInstance 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 { DataSessionListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: DataSessionPage) => any): Promise<DataSessionPage>;
+    page(params: DataSessionListInstancePageOptions, callback?: (error: Error | null, items: DataSessionPage) => any): Promise<DataSessionPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function DataSessionListInstance(version: V1, simSid: string): DataSessionListInstance;
+interface DataSessionPayload extends TwilioResponsePayload {
+    data_sessions: DataSessionResource[];
+}
+interface DataSessionResource {
+    sid: string;
+    sim_sid: string;
+    account_sid: string;
+    radio_link: string;
+    operator_mcc: string;
+    operator_mnc: string;
+    operator_country: string;
+    operator_name: string;
+    cell_id: string;
+    cell_location_estimate: any;
+    packets_uploaded: number;
+    packets_downloaded: number;
+    last_updated: Date;
+    start: Date;
+    end: Date;
+    imei: string;
+}
+export declare class DataSessionInstance {
+    protected _version: V1;
+    constructor(_version: V1, payload: DataSessionResource, simSid: string);
+    /**
+     * The unique string that we created to identify the DataSession resource.
+     */
+    sid: string;
+    /**
+     * The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) that the Data Session is for.
+     */
+    simSid: string;
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the DataSession resource.
+     */
+    accountSid: string;
+    /**
+     * The generation of wireless technology that the device was using.
+     */
+    radioLink: string;
+    /**
+     * The \'mobile country code\' is the unique ID of the home country where the Data Session took place. See: [MCC/MNC lookup](http://mcc-mnc.com/).
+     */
+    operatorMcc: string;
+    /**
+     * The \'mobile network code\' is the unique ID specific to the mobile operator network where the Data Session took place.
+     */
+    operatorMnc: string;
+    /**
+     * The three letter country code representing where the device\'s Data Session took place. This is determined by looking up the `operator_mcc`.
+     */
+    operatorCountry: string;
+    /**
+     * The friendly name of the mobile operator network that the [SIM](https://www.twilio.com/docs/wireless/api/sim-resource)-connected device is attached to. This is determined by looking up the `operator_mnc`.
+     */
+    operatorName: string;
+    /**
+     * The unique ID of the cellular tower that the device was attached to at the moment when the Data Session was last updated.
+     */
+    cellId: string;
+    /**
+     * An object that describes the estimated location in latitude and longitude where the device\'s Data Session took place. The location is derived from the `cell_id` when the Data Session was last updated. See [Cell Location Estimate Object](https://www.twilio.com/docs/wireless/api/datasession-resource#cell-location-estimate-object).
+     */
+    cellLocationEstimate: any;
+    /**
+     * The number of packets uploaded by the device between the `start` time and when the Data Session was last updated.
+     */
+    packetsUploaded: number;
+    /**
+     * The number of packets downloaded by the device between the `start` time and when the Data Session was last updated.
+     */
+    packetsDownloaded: number;
+    /**
+     * The date that the resource was last updated, given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+     */
+    lastUpdated: Date;
+    /**
+     * The date that the Data Session started, given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+     */
+    start: Date;
+    /**
+     * The date that the record ended, given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+     */
+    end: Date;
+    /**
+     * The \'international mobile equipment identity\' is the unique ID of the device using the SIM to connect. An IMEI is a 15-digit string: 14 digits for the device identifier plus a check digit calculated using the Luhn formula.
+     */
+    imei: string;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        sid: string;
+        simSid: string;
+        accountSid: string;
+        radioLink: string;
+        operatorMcc: string;
+        operatorMnc: string;
+        operatorCountry: string;
+        operatorName: string;
+        cellId: string;
+        cellLocationEstimate: any;
+        packetsUploaded: number;
+        packetsDownloaded: number;
+        lastUpdated: Date;
+        start: Date;
+        end: Date;
+        imei: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export declare class DataSessionPage extends Page<V1, DataSessionPayload, DataSessionResource, DataSessionInstance> {
+    /**
+     * Initialize the DataSessionPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: DataSessionSolution);
+    /**
+     * Build an instance of DataSessionInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: DataSessionResource): DataSessionInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

package/lib/rest/wireless/v1/sim/dataSession.js

@@ -0,0 +1,152 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Wireless
+ * 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 });
+exports.DataSessionPage = exports.DataSessionInstance = exports.DataSessionListInstance = void 0;
+const util_1 = require("util");
+const Page_1 = __importDefault(require("../../../../base/Page"));
+const deserialize = require("../../../../base/deserialize");
+const serialize = require("../../../../base/serialize");
+const utility_1 = require("../../../../base/utility");
+function DataSessionListInstance(version, simSid) {
+    if (!(0, utility_1.isValidPathParam)(simSid)) {
+        throw new Error("Parameter 'simSid' is not valid.");
+    }
+    const instance = {};
+    instance._version = version;
+    instance._solution = { simSid };
+    instance._uri = `/Sims/${simSid}/DataSessions`;
+    instance.page = function page(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["pageSize"] !== undefined)
+            data["PageSize"] = params["pageSize"];
+        if (params.pageNumber !== undefined)
+            data["Page"] = params.pageNumber;
+        if (params.pageToken !== undefined)
+            data["PageToken"] = params.pageToken;
+        const headers = {};
+        let operationVersion = version, operationPromise = operationVersion.page({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new DataSessionPage(operationVersion, payload, instance._solution));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.each = instance._version.each;
+    instance.list = instance._version.list;
+    instance.getPage = function getPage(targetUrl, callback) {
+        const operationPromise = instance._version._domain.twilio.request({
+            method: "get",
+            uri: targetUrl,
+        });
+        let pagePromise = operationPromise.then((payload) => new DataSessionPage(instance._version, payload, instance._solution));
+        pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
+        return pagePromise;
+    };
+    instance.toJSON = function toJSON() {
+        return instance._solution;
+    };
+    instance[util_1.inspect.custom] = function inspectImpl(_depth, options) {
+        return (0, util_1.inspect)(instance.toJSON(), options);
+    };
+    return instance;
+}
+exports.DataSessionListInstance = DataSessionListInstance;
+class DataSessionInstance {
+    constructor(_version, payload, simSid) {
+        this._version = _version;
+        this.sid = payload.sid;
+        this.simSid = payload.sim_sid;
+        this.accountSid = payload.account_sid;
+        this.radioLink = payload.radio_link;
+        this.operatorMcc = payload.operator_mcc;
+        this.operatorMnc = payload.operator_mnc;
+        this.operatorCountry = payload.operator_country;
+        this.operatorName = payload.operator_name;
+        this.cellId = payload.cell_id;
+        this.cellLocationEstimate = payload.cell_location_estimate;
+        this.packetsUploaded = deserialize.integer(payload.packets_uploaded);
+        this.packetsDownloaded = deserialize.integer(payload.packets_downloaded);
+        this.lastUpdated = deserialize.iso8601DateTime(payload.last_updated);
+        this.start = deserialize.iso8601DateTime(payload.start);
+        this.end = deserialize.iso8601DateTime(payload.end);
+        this.imei = payload.imei;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            sid: this.sid,
+            simSid: this.simSid,
+            accountSid: this.accountSid,
+            radioLink: this.radioLink,
+            operatorMcc: this.operatorMcc,
+            operatorMnc: this.operatorMnc,
+            operatorCountry: this.operatorCountry,
+            operatorName: this.operatorName,
+            cellId: this.cellId,
+            cellLocationEstimate: this.cellLocationEstimate,
+            packetsUploaded: this.packetsUploaded,
+            packetsDownloaded: this.packetsDownloaded,
+            lastUpdated: this.lastUpdated,
+            start: this.start,
+            end: this.end,
+            imei: this.imei,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.DataSessionInstance = DataSessionInstance;
+class DataSessionPage extends Page_1.default {
+    /**
+     * Initialize the DataSessionPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version, response, solution) {
+        super(version, response, solution);
+    }
+    /**
+     * Build an instance of DataSessionInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new DataSessionInstance(this._version, payload, this._solution.simSid);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.DataSessionPage = DataSessionPage;

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

@@ -0,0 +1,186 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../../base/Page";
+import Response from "../../../../http/response";
+import V1 from "../../V1";
+type UsageRecordGranularity = "hourly" | "daily" | "all";
+/**
+ * Options to pass to each
+ */
+export interface UsageRecordListInstanceEachOptions {
+    /** Only include usage that occurred on or before this date, specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). The default is the current time. */
+    end?: Date;
+    /** Only include usage that has occurred on or after this date, specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). The default is one month before the `end` parameter value. */
+    start?: Date;
+    /** How to summarize the usage by time. Can be: `daily`, `hourly`, or `all`. The default is `all`. A value of `all` returns one Usage Record that describes the usage for the entire period. */
+    granularity?: UsageRecordGranularity;
+    /** 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: UsageRecordInstance, 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 UsageRecordListInstanceOptions {
+    /** Only include usage that occurred on or before this date, specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). The default is the current time. */
+    end?: Date;
+    /** Only include usage that has occurred on or after this date, specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). The default is one month before the `end` parameter value. */
+    start?: Date;
+    /** How to summarize the usage by time. Can be: `daily`, `hourly`, or `all`. The default is `all`. A value of `all` returns one Usage Record that describes the usage for the entire period. */
+    granularity?: UsageRecordGranularity;
+    /** 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 UsageRecordListInstancePageOptions {
+    /** Only include usage that occurred on or before this date, specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). The default is the current time. */
+    end?: Date;
+    /** Only include usage that has occurred on or after this date, specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). The default is one month before the `end` parameter value. */
+    start?: Date;
+    /** How to summarize the usage by time. Can be: `daily`, `hourly`, or `all`. The default is `all`. A value of `all` returns one Usage Record that describes the usage for the entire period. */
+    granularity?: UsageRecordGranularity;
+    /** 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 UsageRecordSolution {
+    simSid: string;
+}
+export interface UsageRecordListInstance {
+    _version: V1;
+    _solution: UsageRecordSolution;
+    _uri: string;
+    /**
+     * Streams UsageRecordInstance 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 { UsageRecordListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: UsageRecordInstance, done: (err?: Error) => void) => void): void;
+    each(params: UsageRecordListInstanceEachOptions, callback?: (item: UsageRecordInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of UsageRecordInstance 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: UsageRecordPage) => any): Promise<UsageRecordPage>;
+    /**
+     * Lists UsageRecordInstance 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 { UsageRecordListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: UsageRecordInstance[]) => any): Promise<UsageRecordInstance[]>;
+    list(params: UsageRecordListInstanceOptions, callback?: (error: Error | null, items: UsageRecordInstance[]) => any): Promise<UsageRecordInstance[]>;
+    /**
+     * Retrieve a single page of UsageRecordInstance 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 { UsageRecordListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: UsageRecordPage) => any): Promise<UsageRecordPage>;
+    page(params: UsageRecordListInstancePageOptions, callback?: (error: Error | null, items: UsageRecordPage) => any): Promise<UsageRecordPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function UsageRecordListInstance(version: V1, simSid: string): UsageRecordListInstance;
+interface UsageRecordPayload extends TwilioResponsePayload {
+    usage_records: UsageRecordResource[];
+}
+interface UsageRecordResource {
+    sim_sid: string;
+    account_sid: string;
+    period: any;
+    commands: any;
+    data: any;
+}
+export declare class UsageRecordInstance {
+    protected _version: V1;
+    constructor(_version: V1, payload: UsageRecordResource, simSid: string);
+    /**
+     * The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) that this Usage Record is for.
+     */
+    simSid: string;
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resource.
+     */
+    accountSid: string;
+    /**
+     * The time period for which the usage is reported. Contains `start` and `end` datetime values given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+     */
+    period: any;
+    /**
+     * An object that describes the SIM\'s usage of Commands during the specified period. See [Commands Usage Object](https://www.twilio.com/docs/wireless/api/sim-usagerecord-resource#commands-usage-object).
+     */
+    commands: any;
+    /**
+     * An object that describes the SIM\'s data usage during the specified period. See [Data Usage Object](https://www.twilio.com/docs/wireless/api/sim-usagerecord-resource#data-usage-object).
+     */
+    data: any;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        simSid: string;
+        accountSid: string;
+        period: any;
+        commands: any;
+        data: any;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export declare class UsageRecordPage extends Page<V1, UsageRecordPayload, UsageRecordResource, UsageRecordInstance> {
+    /**
+     * Initialize the UsageRecordPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: UsageRecordSolution);
+    /**
+     * Build an instance of UsageRecordInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: UsageRecordResource): UsageRecordInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};