twilio 6.0.0 → 6.0.2

package/lib/rest/conversations/v2/operation.d.ts

@@ -0,0 +1,167 @@
+import { inspect, InspectOptions } from "util";
+import V2 from "../V2";
+import { ApiResponse } from "../../../base/ApiResponse";
+/**
+ * Error details if the operation failed. Follows RFC 9457 Problem Details.
+ */
+export declare class FetchOperationStatus200ResponseError {
+    /**
+     * A URI reference that identifies the problem type.
+     */
+    "type"?: string;
+    /**
+     * A short, human-readable summary of the problem type.
+     */
+    "title"?: string;
+    /**
+     * The HTTP status code for this occurrence of the problem.
+     */
+    "status"?: number;
+    /**
+     * A human-readable explanation specific to this occurrence.
+     */
+    "detail"?: string;
+    /**
+     * A URI reference that identifies the specific occurrence of the problem.
+     */
+    "instance"?: string;
+    constructor(payload: any);
+}
+export interface OperationContext {
+    /**
+     * Fetch a OperationInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed OperationInstance
+     */
+    fetch(callback?: (error: Error | null, item?: OperationInstance) => any): Promise<OperationInstance>;
+    /**
+     * Fetch a OperationInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed OperationInstance with HTTP metadata
+     */
+    fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<OperationInstance>) => any): Promise<ApiResponse<OperationInstance>>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface OperationContextSolution {
+    sid: string;
+}
+export declare class OperationContextImpl implements OperationContext {
+    protected _version: V2;
+    protected _solution: OperationContextSolution;
+    protected _uri: string;
+    constructor(_version: V2, sid: string);
+    fetch(callback?: (error: Error | null, item?: OperationInstance) => any): Promise<OperationInstance>;
+    fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<OperationInstance>) => any): Promise<ApiResponse<OperationInstance>>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): OperationContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface OperationResource {
+    operationId: string;
+    status: string;
+    createdAt: Date;
+    completedAt: Date;
+    statusUrl: string;
+    error: FetchOperationStatus200ResponseError;
+    related: {
+        [key: string]: string;
+    };
+}
+/**
+ * Status of a long-running operation.
+ */
+export declare class OperationInstance {
+    protected _version: V2;
+    protected _solution: OperationContextSolution;
+    protected _context?: OperationContext;
+    constructor(_version: V2, _payload: OperationResource, sid?: string);
+    /**
+     * Unique identifier for the long-running operation.
+     */
+    operationId: string;
+    /**
+     * Current status of the operation.
+     */
+    status: string;
+    /**
+     * Timestamp when the operation was created.
+     */
+    createdAt: Date;
+    /**
+     * Timestamp when the operation completed. Only present for completed or failed operations.
+     */
+    completedAt: Date;
+    /**
+     * URL to poll for operation status.
+     */
+    statusUrl: string;
+    error: FetchOperationStatus200ResponseError;
+    /**
+     * Named resource identifiers associated with this operation. Keys depend on the operation type: - config-create, config-update, config-delete: configurationId - conversation-delete: conversationId
+     */
+    related: {
+        [key: string]: string;
+    };
+    private get _proxy();
+    /**
+     * Fetch a OperationInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed OperationInstance
+     */
+    fetch(callback?: (error: Error | null, item?: OperationInstance) => any): Promise<OperationInstance>;
+    /**
+     * Fetch a OperationInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed OperationInstance with HTTP metadata
+     */
+    fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<OperationInstance>) => any): Promise<ApiResponse<OperationInstance>>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        operationId: string;
+        status: string;
+        createdAt: Date;
+        completedAt: Date;
+        statusUrl: string;
+        error: FetchOperationStatus200ResponseError;
+        related: {
+            [key: string]: string;
+        };
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface OperationSolution {
+}
+export interface OperationListInstance {
+    _version: V2;
+    _solution: OperationSolution;
+    _uri: string;
+    (sid: string): OperationContext;
+    get(sid: string): OperationContext;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function OperationListInstance(version: V2): OperationListInstance;
+export {};

package/lib/rest/conversations/v2/operation.js

@@ -0,0 +1,170 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Conversation Orchestrator
+ * Manage configurations, conversations, participants, and communications. Create configurations to define capture rules and channel settings, then use conversations to group related communications.
+ *
+ * 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.OperationInstance = exports.OperationContextImpl = exports.FetchOperationStatus200ResponseError = void 0;
+exports.OperationListInstance = OperationListInstance;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+/**
+ * Error details if the operation failed. Follows RFC 9457 Problem Details.
+ */
+class FetchOperationStatus200ResponseError {
+    constructor(payload) {
+        this.type = payload["type"];
+        this.title = payload["title"];
+        this.status = payload["status"];
+        this.detail = payload["detail"];
+        this.instance = payload["instance"];
+    }
+}
+exports.FetchOperationStatus200ResponseError = FetchOperationStatus200ResponseError;
+class OperationContextImpl {
+    constructor(_version, sid) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(sid)) {
+            throw new Error("Parameter 'sid' is not valid.");
+        }
+        this._solution = { sid };
+        this._uri = `/ControlPlane/Operations/${sid}`;
+    }
+    fetch(callback) {
+        const headers = {};
+        headers["Accept"] = "application/json";
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new OperationInstance(operationVersion, payload, instance._solution.sid));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    fetchWithHttpInfo(callback) {
+        const headers = {};
+        headers["Accept"] = "application/json";
+        const instance = this;
+        let operationVersion = instance._version;
+        // CREATE, FETCH, UPDATE operations
+        let operationPromise = operationVersion
+            .fetchWithResponseInfo({
+            uri: instance._uri,
+            method: "get",
+            headers,
+        })
+            .then((response) => ({
+            ...response,
+            body: new OperationInstance(operationVersion, response.body, instance._solution.sid),
+        }));
+        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.OperationContextImpl = OperationContextImpl;
+/**
+ * Status of a long-running operation.
+ */
+class OperationInstance {
+    constructor(_version, _payload, sid) {
+        this._version = _version;
+        const payload = _payload;
+        this.operationId = payload.operationId;
+        this.status = payload.status;
+        this.createdAt = deserialize.iso8601DateTime(payload.createdAt);
+        this.completedAt = deserialize.iso8601DateTime(payload.completedAt);
+        this.statusUrl = payload.statusUrl;
+        this.error =
+            payload.error !== null && payload.error !== undefined
+                ? new FetchOperationStatus200ResponseError(payload.error)
+                : null;
+        this.related = payload.related;
+        this._solution = { sid: sid };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new OperationContextImpl(this._version, this._solution.sid);
+        return this._context;
+    }
+    /**
+     * Fetch a OperationInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed OperationInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    /**
+     * Fetch a OperationInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed OperationInstance with HTTP metadata
+     */
+    fetchWithHttpInfo(callback) {
+        return this._proxy.fetchWithHttpInfo(callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            operationId: this.operationId,
+            status: this.status,
+            createdAt: this.createdAt,
+            completedAt: this.completedAt,
+            statusUrl: this.statusUrl,
+            error: this.error,
+            related: this.related,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.OperationInstance = OperationInstance;
+function OperationListInstance(version) {
+    const instance = ((sid) => instance.get(sid));
+    instance.get = function get(sid) {
+        return new OperationContextImpl(version, sid);
+    };
+    instance._version = version;
+    instance._solution = {};
+    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;
+}