twilio 4.0.1 → 4.0.2

package/lib/rest/api/v2010/account/call/feedback.d.ts

@@ -0,0 +1,160 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V2010 from "../../../V2010";
+type CallFeedbackIssues = "audio-latency" | "digits-not-captured" | "dropped-call" | "imperfect-audio" | "incorrect-caller-id" | "one-way-audio" | "post-dial-delay" | "unsolicited-call";
+/**
+ * Options to pass to update a FeedbackInstance
+ */
+export interface FeedbackContextUpdateOptions {
+    /** The call quality expressed as an integer from `1` to `5` where `1` represents very poor call quality and `5` represents a perfect call. */
+    qualityScore?: number;
+    /** One or more issues experienced during the call. The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`, or `one-way-audio`. */
+    issue?: Array<CallFeedbackIssues>;
+}
+export interface FeedbackContext {
+    /**
+     * Fetch a FeedbackInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed FeedbackInstance
+     */
+    fetch(callback?: (error: Error | null, item?: FeedbackInstance) => any): Promise<FeedbackInstance>;
+    /**
+     * Update a FeedbackInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed FeedbackInstance
+     */
+    update(callback?: (error: Error | null, item?: FeedbackInstance) => any): Promise<FeedbackInstance>;
+    /**
+     * Update a FeedbackInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed FeedbackInstance
+     */
+    update(params: FeedbackContextUpdateOptions, callback?: (error: Error | null, item?: FeedbackInstance) => any): Promise<FeedbackInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface FeedbackContextSolution {
+    accountSid: string;
+    callSid: string;
+}
+export declare class FeedbackContextImpl implements FeedbackContext {
+    protected _version: V2010;
+    protected _solution: FeedbackContextSolution;
+    protected _uri: string;
+    constructor(_version: V2010, accountSid: string, callSid: string);
+    fetch(callback?: (error: Error | null, item?: FeedbackInstance) => any): Promise<FeedbackInstance>;
+    update(params?: FeedbackContextUpdateOptions | ((error: Error | null, item?: FeedbackInstance) => any), callback?: (error: Error | null, item?: FeedbackInstance) => any): Promise<FeedbackInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): FeedbackContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface FeedbackResource {
+    account_sid: string;
+    date_created: Date;
+    date_updated: Date;
+    issues: Array<CallFeedbackIssues>;
+    quality_score: number;
+    sid: string;
+}
+export declare class FeedbackInstance {
+    protected _version: V2010;
+    protected _solution: FeedbackContextSolution;
+    protected _context?: FeedbackContext;
+    constructor(_version: V2010, payload: FeedbackResource, accountSid: string, callSid: string);
+    /**
+     * The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.
+     */
+    accountSid: string;
+    /**
+     * The date that this resource was created, given in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.
+     */
+    dateCreated: Date;
+    /**
+     * The date that this resource was last updated, given in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.
+     */
+    dateUpdated: Date;
+    /**
+     * A list of issues experienced during the call. The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`, or `one-way-audio`.
+     */
+    issues: Array<CallFeedbackIssues>;
+    /**
+     * `1` to `5` quality score where `1` represents imperfect experience and `5` represents a perfect call.
+     */
+    qualityScore: number;
+    /**
+     * A 34 character string that uniquely identifies this resource.
+     */
+    sid: string;
+    private get _proxy();
+    /**
+     * Fetch a FeedbackInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed FeedbackInstance
+     */
+    fetch(callback?: (error: Error | null, item?: FeedbackInstance) => any): Promise<FeedbackInstance>;
+    /**
+     * Update a FeedbackInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed FeedbackInstance
+     */
+    update(callback?: (error: Error | null, item?: FeedbackInstance) => any): Promise<FeedbackInstance>;
+    /**
+     * Update a FeedbackInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed FeedbackInstance
+     */
+    update(params: FeedbackContextUpdateOptions, callback?: (error: Error | null, item?: FeedbackInstance) => any): Promise<FeedbackInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        accountSid: string;
+        dateCreated: Date;
+        dateUpdated: Date;
+        issues: CallFeedbackIssues[];
+        qualityScore: number;
+        sid: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface FeedbackSolution {
+    accountSid: string;
+    callSid: string;
+}
+export interface FeedbackListInstance {
+    _version: V2010;
+    _solution: FeedbackSolution;
+    _uri: string;
+    (): FeedbackContext;
+    get(): FeedbackContext;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function FeedbackListInstance(version: V2010, accountSid: string, callSid: string): FeedbackListInstance;
+export {};

package/lib/rest/api/v2010/account/call/feedback.js

@@ -0,0 +1,154 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Api
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeedbackListInstance = exports.FeedbackInstance = exports.FeedbackContextImpl = void 0;
+const util_1 = require("util");
+const deserialize = require("../../../../../base/deserialize");
+const serialize = require("../../../../../base/serialize");
+const utility_1 = require("../../../../../base/utility");
+class FeedbackContextImpl {
+    constructor(_version, accountSid, callSid) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(accountSid)) {
+            throw new Error("Parameter 'accountSid' is not valid.");
+        }
+        if (!(0, utility_1.isValidPathParam)(callSid)) {
+            throw new Error("Parameter 'callSid' is not valid.");
+        }
+        this._solution = { accountSid, callSid };
+        this._uri = `/Accounts/${accountSid}/Calls/${callSid}/Feedback.json`;
+    }
+    fetch(callback) {
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+        });
+        operationPromise = operationPromise.then((payload) => new FeedbackInstance(operationVersion, payload, instance._solution.accountSid, instance._solution.callSid));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    update(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["qualityScore"] !== undefined)
+            data["QualityScore"] = params["qualityScore"];
+        if (params["issue"] !== undefined)
+            data["Issue"] = serialize.map(params["issue"], (e) => e);
+        const headers = {};
+        headers["Content-Type"] = "application/x-www-form-urlencoded";
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.update({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new FeedbackInstance(operationVersion, payload, instance._solution.accountSid, instance._solution.callSid));
+        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.FeedbackContextImpl = FeedbackContextImpl;
+class FeedbackInstance {
+    constructor(_version, payload, accountSid, callSid) {
+        this._version = _version;
+        this.accountSid = payload.account_sid;
+        this.dateCreated = deserialize.rfc2822DateTime(payload.date_created);
+        this.dateUpdated = deserialize.rfc2822DateTime(payload.date_updated);
+        this.issues = payload.issues;
+        this.qualityScore = deserialize.integer(payload.quality_score);
+        this.sid = payload.sid;
+        this._solution = { accountSid, callSid };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new FeedbackContextImpl(this._version, this._solution.accountSid, this._solution.callSid);
+        return this._context;
+    }
+    /**
+     * Fetch a FeedbackInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed FeedbackInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    update(params, callback) {
+        return this._proxy.update(params, callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            accountSid: this.accountSid,
+            dateCreated: this.dateCreated,
+            dateUpdated: this.dateUpdated,
+            issues: this.issues,
+            qualityScore: this.qualityScore,
+            sid: this.sid,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.FeedbackInstance = FeedbackInstance;
+function FeedbackListInstance(version, accountSid, callSid) {
+    if (!(0, utility_1.isValidPathParam)(accountSid)) {
+        throw new Error("Parameter 'accountSid' is not valid.");
+    }
+    if (!(0, utility_1.isValidPathParam)(callSid)) {
+        throw new Error("Parameter 'callSid' is not valid.");
+    }
+    const instance = (() => instance.get());
+    instance.get = function get() {
+        return new FeedbackContextImpl(version, accountSid, callSid);
+    };
+    instance._version = version;
+    instance._solution = { accountSid, callSid };
+    instance._uri = ``;
+    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.FeedbackListInstance = FeedbackListInstance;

package/lib/rest/api/v2010/account/call/feedbackSummary.d.ts

@@ -0,0 +1,201 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V2010 from "../../../V2010";
+type CallFeedbackSummaryStatus = "queued" | "in-progress" | "completed" | "failed";
+/**
+ * Options to pass to create a FeedbackSummaryInstance
+ */
+export interface FeedbackSummaryListInstanceCreateOptions {
+    /** Only include feedback given on or after this date. Format is `YYYY-MM-DD` and specified in UTC. */
+    startDate: Date;
+    /** Only include feedback given on or before this date. Format is `YYYY-MM-DD` and specified in UTC. */
+    endDate: Date;
+    /** Whether to also include Feedback resources from all subaccounts. `true` includes feedback from all subaccounts and `false`, the default, includes feedback from only the specified account. */
+    includeSubaccounts?: boolean;
+    /** The URL that we will request when the feedback summary is complete. */
+    statusCallback?: string;
+    /** The HTTP method (`GET` or `POST`) we use to make the request to the `StatusCallback` URL. */
+    statusCallbackMethod?: string;
+}
+export interface FeedbackSummaryContext {
+    /**
+     * Remove a FeedbackSummaryInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a FeedbackSummaryInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed FeedbackSummaryInstance
+     */
+    fetch(callback?: (error: Error | null, item?: FeedbackSummaryInstance) => any): Promise<FeedbackSummaryInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface FeedbackSummaryContextSolution {
+    accountSid: string;
+    sid: string;
+}
+export declare class FeedbackSummaryContextImpl implements FeedbackSummaryContext {
+    protected _version: V2010;
+    protected _solution: FeedbackSummaryContextSolution;
+    protected _uri: string;
+    constructor(_version: V2010, accountSid: string, sid: string);
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    fetch(callback?: (error: Error | null, item?: FeedbackSummaryInstance) => any): Promise<FeedbackSummaryInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): FeedbackSummaryContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface FeedbackSummaryResource {
+    account_sid: string;
+    call_count: number;
+    call_feedback_count: number;
+    date_created: Date;
+    date_updated: Date;
+    end_date: Date;
+    include_subaccounts: boolean;
+    issues: Array<any>;
+    quality_score_average: number;
+    quality_score_median: number;
+    quality_score_standard_deviation: number;
+    sid: string;
+    start_date: Date;
+    status: CallFeedbackSummaryStatus;
+}
+export declare class FeedbackSummaryInstance {
+    protected _version: V2010;
+    protected _solution: FeedbackSummaryContextSolution;
+    protected _context?: FeedbackSummaryContext;
+    constructor(_version: V2010, payload: FeedbackSummaryResource, accountSid: string, sid?: string);
+    /**
+     * The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.
+     */
+    accountSid: string;
+    /**
+     * The total number of calls.
+     */
+    callCount: number;
+    /**
+     * The total number of calls with a feedback entry.
+     */
+    callFeedbackCount: number;
+    /**
+     * The date that this resource was created, given in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.
+     */
+    dateCreated: Date;
+    /**
+     * The date that this resource was last updated, given in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.
+     */
+    dateUpdated: Date;
+    /**
+     * The last date for which feedback entries are included in this Feedback Summary, formatted as `YYYY-MM-DD` and specified in UTC.
+     */
+    endDate: Date;
+    /**
+     * Whether the feedback summary includes subaccounts; `true` if it does, otherwise `false`.
+     */
+    includeSubaccounts: boolean;
+    /**
+     * A list of issues experienced during the call. The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`, `audio-latency`, or `one-way-audio`.
+     */
+    issues: Array<any>;
+    /**
+     * The average QualityScore of the feedback entries.
+     */
+    qualityScoreAverage: number;
+    /**
+     * The median QualityScore of the feedback entries.
+     */
+    qualityScoreMedian: number;
+    /**
+     * The standard deviation of the quality scores.
+     */
+    qualityScoreStandardDeviation: number;
+    /**
+     * A 34 character string that uniquely identifies this resource.
+     */
+    sid: string;
+    /**
+     * The first date for which feedback entries are included in this feedback summary, formatted as `YYYY-MM-DD` and specified in UTC.
+     */
+    startDate: Date;
+    status: CallFeedbackSummaryStatus;
+    private get _proxy();
+    /**
+     * Remove a FeedbackSummaryInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a FeedbackSummaryInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed FeedbackSummaryInstance
+     */
+    fetch(callback?: (error: Error | null, item?: FeedbackSummaryInstance) => any): Promise<FeedbackSummaryInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        accountSid: string;
+        callCount: number;
+        callFeedbackCount: number;
+        dateCreated: Date;
+        dateUpdated: Date;
+        endDate: Date;
+        includeSubaccounts: boolean;
+        issues: any[];
+        qualityScoreAverage: number;
+        qualityScoreMedian: number;
+        qualityScoreStandardDeviation: number;
+        sid: string;
+        startDate: Date;
+        status: CallFeedbackSummaryStatus;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface FeedbackSummarySolution {
+    accountSid: string;
+}
+export interface FeedbackSummaryListInstance {
+    _version: V2010;
+    _solution: FeedbackSummarySolution;
+    _uri: string;
+    (sid: string): FeedbackSummaryContext;
+    get(sid: string): FeedbackSummaryContext;
+    /**
+     * Create a FeedbackSummaryInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed FeedbackSummaryInstance
+     */
+    create(params: FeedbackSummaryListInstanceCreateOptions, callback?: (error: Error | null, item?: FeedbackSummaryInstance) => any): Promise<FeedbackSummaryInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function FeedbackSummaryListInstance(version: V2010, accountSid: string): FeedbackSummaryListInstance;
+export {};