twilio 4.6.0 → 4.7.0

package/lib/rest/bulkexports/v1/export/day.d.ts

@@ -0,0 +1,216 @@
+/// <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 DayListInstanceEachOptions {
+    /** 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: DayInstance, 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 DayListInstanceOptions {
+    /** 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 DayListInstancePageOptions {
+    /** 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 DayContext {
+    /**
+     * Fetch a DayInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed DayInstance
+     */
+    fetch(callback?: (error: Error | null, item?: DayInstance) => any): Promise<DayInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface DayContextSolution {
+    resourceType: string;
+    day: string;
+}
+export declare class DayContextImpl implements DayContext {
+    protected _version: V1;
+    protected _solution: DayContextSolution;
+    protected _uri: string;
+    constructor(_version: V1, resourceType: string, day: string);
+    fetch(callback?: (error: Error | null, item?: DayInstance) => any): Promise<DayInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): DayContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface DayPayload extends TwilioResponsePayload {
+    days: DayResource[];
+}
+interface DayResource {
+    redirect_to: string;
+    day: string;
+    size: number;
+    create_date: string;
+    friendly_name: string;
+    resource_type: string;
+}
+export declare class DayInstance {
+    protected _version: V1;
+    protected _solution: DayContextSolution;
+    protected _context?: DayContext;
+    constructor(_version: V1, payload: DayResource, resourceType: string, day?: string);
+    redirectTo: string;
+    /**
+     * The ISO 8601 format date of the resources in the file, for a UTC day
+     */
+    day: string;
+    /**
+     * The size of the day\'s data file in bytes
+     */
+    size: number;
+    /**
+     * The ISO 8601 format date when resources is created
+     */
+    createDate: string;
+    /**
+     * The friendly name specified when creating the job
+     */
+    friendlyName: string;
+    /**
+     * The type of communication – Messages, Calls, Conferences, and Participants
+     */
+    resourceType: string;
+    private get _proxy();
+    /**
+     * Fetch a DayInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed DayInstance
+     */
+    fetch(callback?: (error: Error | null, item?: DayInstance) => any): Promise<DayInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        redirectTo: string;
+        day: string;
+        size: number;
+        createDate: string;
+        friendlyName: string;
+        resourceType: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface DaySolution {
+    resourceType: string;
+}
+export interface DayListInstance {
+    _version: V1;
+    _solution: DaySolution;
+    _uri: string;
+    (day: string): DayContext;
+    get(day: string): DayContext;
+    /**
+     * Streams DayInstance 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 { DayListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: DayInstance, done: (err?: Error) => void) => void): void;
+    each(params: DayListInstanceEachOptions, callback?: (item: DayInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of DayInstance 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: DayPage) => any): Promise<DayPage>;
+    /**
+     * Lists DayInstance 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 { DayListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: DayInstance[]) => any): Promise<DayInstance[]>;
+    list(params: DayListInstanceOptions, callback?: (error: Error | null, items: DayInstance[]) => any): Promise<DayInstance[]>;
+    /**
+     * Retrieve a single page of DayInstance 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 { DayListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: DayPage) => any): Promise<DayPage>;
+    page(params: DayListInstancePageOptions, callback?: (error: Error | null, items: DayPage) => any): Promise<DayPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function DayListInstance(version: V1, resourceType: string): DayListInstance;
+export declare class DayPage extends Page<V1, DayPayload, DayResource, DayInstance> {
+    /**
+     * Initialize the DayPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: DaySolution);
+    /**
+     * Build an instance of DayInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: DayResource): DayInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

package/lib/rest/bulkexports/v1/export/day.js

@@ -0,0 +1,187 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Bulkexports
+ * 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.DayPage = exports.DayListInstance = exports.DayInstance = exports.DayContextImpl = 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");
+class DayContextImpl {
+    constructor(_version, resourceType, day) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(resourceType)) {
+            throw new Error("Parameter 'resourceType' is not valid.");
+        }
+        if (!(0, utility_1.isValidPathParam)(day)) {
+            throw new Error("Parameter 'day' is not valid.");
+        }
+        this._solution = { resourceType, day };
+        this._uri = `/Exports/${resourceType}/Days/${day}`;
+    }
+    fetch(callback) {
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+        });
+        operationPromise = operationPromise.then((payload) => new DayInstance(operationVersion, payload, instance._solution.resourceType, instance._solution.day));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return this._solution;
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.DayContextImpl = DayContextImpl;
+class DayInstance {
+    constructor(_version, payload, resourceType, day) {
+        this._version = _version;
+        this.redirectTo = payload.redirect_to;
+        this.day = payload.day;
+        this.size = deserialize.integer(payload.size);
+        this.createDate = payload.create_date;
+        this.friendlyName = payload.friendly_name;
+        this.resourceType = payload.resource_type;
+        this._solution = { resourceType, day: day || this.day };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new DayContextImpl(this._version, this._solution.resourceType, this._solution.day);
+        return this._context;
+    }
+    /**
+     * Fetch a DayInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed DayInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            redirectTo: this.redirectTo,
+            day: this.day,
+            size: this.size,
+            createDate: this.createDate,
+            friendlyName: this.friendlyName,
+            resourceType: this.resourceType,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.DayInstance = DayInstance;
+function DayListInstance(version, resourceType) {
+    if (!(0, utility_1.isValidPathParam)(resourceType)) {
+        throw new Error("Parameter 'resourceType' is not valid.");
+    }
+    const instance = ((day) => instance.get(day));
+    instance.get = function get(day) {
+        return new DayContextImpl(version, resourceType, day);
+    };
+    instance._version = version;
+    instance._solution = { resourceType };
+    instance._uri = `/Exports/${resourceType}/Days`;
+    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 DayPage(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 DayPage(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.DayListInstance = DayListInstance;
+class DayPage extends Page_1.default {
+    /**
+     * Initialize the DayPage
+     *
+     * @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 DayInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new DayInstance(this._version, payload, this._solution.resourceType);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.DayPage = DayPage;

package/lib/rest/bulkexports/v1/export/exportCustomJob.d.ts

@@ -0,0 +1,229 @@
+/// <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 create a ExportCustomJobInstance
+ */
+export interface ExportCustomJobListInstanceCreateOptions {
+    /** The start day for the custom export specified as a string in the format of yyyy-mm-dd */
+    startDay: string;
+    /** The end day for the custom export specified as a string in the format of yyyy-mm-dd. End day is inclusive and must be 2 days earlier than the current UTC day. */
+    endDay: string;
+    /** The friendly name specified when creating the job */
+    friendlyName: string;
+    /** The optional webhook url called on completion of the job. If this is supplied, `WebhookMethod` must also be supplied. If you set neither webhook nor email, you will have to check your job\\\'s status manually. */
+    webhookUrl?: string;
+    /** This is the method used to call the webhook on completion of the job. If this is supplied, `WebhookUrl` must also be supplied. */
+    webhookMethod?: string;
+    /** The optional email to send the completion notification to. You can set both webhook, and email, or one or the other. If you set neither, the job will run but you will have to query to determine your job\\\'s status. */
+    email?: string;
+}
+/**
+ * Options to pass to each
+ */
+export interface ExportCustomJobListInstanceEachOptions {
+    /** 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: ExportCustomJobInstance, 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 ExportCustomJobListInstanceOptions {
+    /** 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 ExportCustomJobListInstancePageOptions {
+    /** 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 ExportCustomJobSolution {
+    resourceType: string;
+}
+export interface ExportCustomJobListInstance {
+    _version: V1;
+    _solution: ExportCustomJobSolution;
+    _uri: string;
+    /**
+     * Create a ExportCustomJobInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed ExportCustomJobInstance
+     */
+    create(params: ExportCustomJobListInstanceCreateOptions, callback?: (error: Error | null, item?: ExportCustomJobInstance) => any): Promise<ExportCustomJobInstance>;
+    /**
+     * Streams ExportCustomJobInstance 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 { ExportCustomJobListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: ExportCustomJobInstance, done: (err?: Error) => void) => void): void;
+    each(params: ExportCustomJobListInstanceEachOptions, callback?: (item: ExportCustomJobInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of ExportCustomJobInstance 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: ExportCustomJobPage) => any): Promise<ExportCustomJobPage>;
+    /**
+     * Lists ExportCustomJobInstance 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 { ExportCustomJobListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: ExportCustomJobInstance[]) => any): Promise<ExportCustomJobInstance[]>;
+    list(params: ExportCustomJobListInstanceOptions, callback?: (error: Error | null, items: ExportCustomJobInstance[]) => any): Promise<ExportCustomJobInstance[]>;
+    /**
+     * Retrieve a single page of ExportCustomJobInstance 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 { ExportCustomJobListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: ExportCustomJobPage) => any): Promise<ExportCustomJobPage>;
+    page(params: ExportCustomJobListInstancePageOptions, callback?: (error: Error | null, items: ExportCustomJobPage) => any): Promise<ExportCustomJobPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function ExportCustomJobListInstance(version: V1, resourceType: string): ExportCustomJobListInstance;
+interface ExportCustomJobPayload extends TwilioResponsePayload {
+    jobs: ExportCustomJobResource[];
+}
+interface ExportCustomJobResource {
+    friendly_name: string;
+    resource_type: string;
+    start_day: string;
+    end_day: string;
+    webhook_url: string;
+    webhook_method: string;
+    email: string;
+    job_sid: string;
+    details: any;
+    job_queue_position: string;
+    estimated_completion_time: string;
+}
+export declare class ExportCustomJobInstance {
+    protected _version: V1;
+    constructor(_version: V1, payload: ExportCustomJobResource, resourceType: string);
+    /**
+     * The friendly name specified when creating the job
+     */
+    friendlyName: string;
+    /**
+     * The type of communication – Messages, Calls, Conferences, and Participants
+     */
+    resourceType: string;
+    /**
+     * The start day for the custom export specified when creating the job
+     */
+    startDay: string;
+    /**
+     * The end day for the export specified when creating the job
+     */
+    endDay: string;
+    /**
+     * The optional webhook url called on completion of the job. If this is supplied, `WebhookMethod` must also be supplied.
+     */
+    webhookUrl: string;
+    /**
+     * This is the method used to call the webhook on completion of the job. If this is supplied, `WebhookUrl` must also be supplied.
+     */
+    webhookMethod: string;
+    /**
+     * The optional email to send the completion notification to
+     */
+    email: string;
+    /**
+     * The unique job_sid returned when the custom export was created
+     */
+    jobSid: string;
+    /**
+     * The details of a job which is an object that contains an array of status grouped by `status` state.  Each `status` object has a `status` string, a count which is the number of days in that `status`, and list of days in that `status`. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a `status` object for SUBMITTED each with its own count and list of days.
+     */
+    details: any;
+    /**
+     * This is the job position from the 1st in line. Your queue position will never increase. As jobs ahead of yours in the queue are processed, the queue position number will decrease
+     */
+    jobQueuePosition: string;
+    /**
+     * this is the time estimated until your job is complete. This is calculated each time you request the job list. The time is calculated based on the current rate of job completion (which may vary) and your job queue position
+     */
+    estimatedCompletionTime: string;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        friendlyName: string;
+        resourceType: string;
+        startDay: string;
+        endDay: string;
+        webhookUrl: string;
+        webhookMethod: string;
+        email: string;
+        jobSid: string;
+        details: any;
+        jobQueuePosition: string;
+        estimatedCompletionTime: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export declare class ExportCustomJobPage extends Page<V1, ExportCustomJobPayload, ExportCustomJobResource, ExportCustomJobInstance> {
+    /**
+     * Initialize the ExportCustomJobPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: ExportCustomJobSolution);
+    /**
+     * Build an instance of ExportCustomJobInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: ExportCustomJobResource): ExportCustomJobInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};