twilio 6.0.0 → 6.0.2

package/lib/rest/memory/v1/event.js

@@ -0,0 +1,159 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio Memory API
+ * APIs for managing memory stores, profiles, events, and conversational intelligence capabilities.
+ *
+ * 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.EventInstance = exports.ProfileEventRequestEvents = exports.ProfileEventRequest = exports.CommunicationLifecycleEventSender = exports.CommunicationLifecycleEventRecipient = void 0;
+exports.EventListInstance = EventListInstance;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+class CommunicationLifecycleEventRecipient {
+    constructor(payload) {
+        this.address = payload["address"];
+        this.participantId = payload["participantId"];
+    }
+}
+exports.CommunicationLifecycleEventRecipient = CommunicationLifecycleEventRecipient;
+class CommunicationLifecycleEventSender {
+    constructor(payload) {
+        this.address = payload["address"];
+        this.participantId = payload["participantId"];
+    }
+}
+exports.CommunicationLifecycleEventSender = CommunicationLifecycleEventSender;
+/**
+ * Request body for adding events to a specific profile. This request can contain multiple events.
+ */
+class ProfileEventRequest {
+    constructor(payload) {
+        this.type = payload["type"];
+        this.events = payload["events"];
+    }
+}
+exports.ProfileEventRequest = ProfileEventRequest;
+class ProfileEventRequestEvents {
+    constructor(payload) {
+        this.timestamp = payload["timestamp"];
+        this.lifecycle = payload["lifecycle"];
+        this.conversationId = payload["conversationId"];
+        this.communicationId = payload["communicationId"];
+        this.communicationType = payload["communicationType"];
+        this.communicationStatus = payload["communicationStatus"];
+        this.direction = payload["direction"];
+        this.sender = payload["sender"];
+        this.recipient = payload["recipient"];
+        this.errorCode = payload["errorCode"];
+        this.errorMessage = payload["errorMessage"];
+    }
+}
+exports.ProfileEventRequestEvents = ProfileEventRequestEvents;
+function EventListInstance(version, storeId, profileId) {
+    if (!(0, utility_1.isValidPathParam)(storeId)) {
+        throw new Error("Parameter 'storeId' is not valid.");
+    }
+    if (!(0, utility_1.isValidPathParam)(profileId)) {
+        throw new Error("Parameter 'profileId' is not valid.");
+    }
+    const instance = {};
+    instance._version = version;
+    instance._solution = { storeId, profileId };
+    instance._uri = `/Stores/${storeId}/Profiles/${profileId}/Events`;
+    instance.create = function create(params, headers, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params =
+                params || {};
+        }
+        let data = {};
+        data = params;
+        if (headers === null || headers === undefined) {
+            headers = {};
+        }
+        headers["Content-Type"] = "application/json";
+        headers["Accept"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new EventInstance(operationVersion, payload, instance._solution.storeId, instance._solution.profileId));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.createWithHttpInfo = function createWithHttpInfo(params, headers, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params =
+                params || {};
+        }
+        let data = {};
+        data = params;
+        if (headers === null || headers === undefined) {
+            headers = {};
+        }
+        headers["Content-Type"] = "application/json";
+        headers["Accept"] = "application/json";
+        let operationVersion = version;
+        // CREATE, FETCH, UPDATE operations
+        let operationPromise = operationVersion
+            .createWithResponseInfo({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        })
+            .then((response) => ({
+            ...response,
+            body: new EventInstance(operationVersion, response.body, instance._solution.storeId, instance._solution.profileId),
+        }));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    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;
+}
+class EventInstance {
+    constructor(_version, _payload, storeId, profileId) {
+        this._version = _version;
+        const payload = _payload;
+        this.message = payload.message;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            message: this.message,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.EventInstance = EventInstance;

package/lib/rest/memory/v1/identifier.d.ts

@@ -0,0 +1,362 @@
+import { inspect, InspectOptions } from "util";
+import V1 from "../V1";
+import { ApiResponse } from "../../../base/ApiResponse";
+/**
+ * Represents a single identifier value paired with its `idType`. Write operations obey limits, uniqueness, and normalization rules configured via identifier settings.
+ */
+export declare class Identifier {
+    /**
+     * Identifier type as configured in the service\'s Identity Resolution Settings.
+     */
+    "idType": string;
+    /**
+     * Raw value captured for the identifier. The service may normalize this value according to the `normalization` rule defined in the identifier settings before storage or matching (for example E.164 formatting for phone numbers).
+     */
+    "value": string;
+    constructor(payload: any);
+}
+export declare class IdentifierUpdate {
+    /**
+     * The identifier type to update (e.g., email, phone).
+     */
+    "idType": string;
+    /**
+     * Existing stored value to replace.
+     */
+    "oldValue": string;
+    /**
+     * New value to store for the identifier. Normalization rules from the corresponding identifier settings apply.
+     */
+    "newValue": string;
+    constructor(payload: any);
+}
+/**
+ * Options to pass to remove a IdentifierInstance
+ */
+export interface IdentifierContextRemoveOptions {
+    /** When true, removes every stored value for the identifier type in a single operation. Defaults to false. */
+    removeAll?: boolean;
+}
+/**
+ * Options to pass to patch a IdentifierInstance
+ */
+export interface IdentifierContextPatchOptions {
+    /**  */
+    identifierUpdate: IdentifierUpdate;
+}
+/**
+ * Options to pass to create a IdentifierInstance
+ */
+export interface IdentifierListInstanceCreateOptions {
+    /**  */
+    identifier: Identifier;
+}
+/**
+ * Options to pass to list
+ */
+export interface IdentifierListInstanceOptions {
+    /** Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit */
+    limit?: number;
+}
+export interface IdentifierContext {
+    /**
+     * Remove a IdentifierInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance
+     */
+    remove(callback?: (error: Error | null, item?: IdentifierInstance) => any): Promise<IdentifierInstance>;
+    /**
+     * Remove a IdentifierInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance
+     */
+    remove(params: IdentifierContextRemoveOptions, callback?: (error: Error | null, item?: IdentifierInstance) => any): Promise<IdentifierInstance>;
+    /**
+     * Remove a IdentifierInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance with HTTP metadata
+     */
+    removeWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<IdentifierInstance>) => any): Promise<ApiResponse<IdentifierInstance>>;
+    /**
+     * Remove a IdentifierInstance and return HTTP info
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance with HTTP metadata
+     */
+    removeWithHttpInfo(params: IdentifierContextRemoveOptions, callback?: (error: Error | null, item?: ApiResponse<IdentifierInstance>) => any): Promise<ApiResponse<IdentifierInstance>>;
+    /**
+     * Fetch a IdentifierInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance
+     */
+    fetch(callback?: (error: Error | null, item?: IdentifierInstance) => any): Promise<IdentifierInstance>;
+    /**
+     * Fetch a IdentifierInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance with HTTP metadata
+     */
+    fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<IdentifierInstance>) => any): Promise<ApiResponse<IdentifierInstance>>;
+    /**
+     * Patch a IdentifierInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance
+     */
+    patch(params: IdentifierUpdate, headers?: any, callback?: (error: Error | null, item?: IdentifierInstance) => any): Promise<IdentifierInstance>;
+    /**
+     * Patch a IdentifierInstance and return HTTP info
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance with HTTP metadata
+     */
+    patchWithHttpInfo(params: IdentifierUpdate, headers?: any, callback?: (error: Error | null, item?: ApiResponse<IdentifierInstance>) => any): Promise<ApiResponse<IdentifierInstance>>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface IdentifierContextSolution {
+    storeId: string;
+    profileId: string;
+    idType: string;
+}
+export declare class IdentifierContextImpl implements IdentifierContext {
+    protected _version: V1;
+    protected _solution: IdentifierContextSolution;
+    protected _uri: string;
+    constructor(_version: V1, storeId: string, profileId: string, idType: string);
+    remove(params?: IdentifierContextRemoveOptions | ((error: Error | null, item?: IdentifierInstance) => any), callback?: (error: Error | null, item?: IdentifierInstance) => any): Promise<IdentifierInstance>;
+    removeWithHttpInfo(params?: IdentifierContextRemoveOptions | ((error: Error | null, item?: ApiResponse<IdentifierInstance>) => any), callback?: (error: Error | null, item?: ApiResponse<IdentifierInstance>) => any): Promise<ApiResponse<IdentifierInstance>>;
+    fetch(callback?: (error: Error | null, item?: IdentifierInstance) => any): Promise<IdentifierInstance>;
+    fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<IdentifierInstance>) => any): Promise<ApiResponse<IdentifierInstance>>;
+    patch(params: IdentifierUpdate, headers?: any, callback?: (error: Error | null, item?: IdentifierInstance) => any): Promise<IdentifierInstance>;
+    patchWithHttpInfo(params: IdentifierUpdate, headers?: any, callback?: (error: Error | null, item?: ApiResponse<IdentifierInstance>) => any): Promise<ApiResponse<IdentifierInstance>>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): IdentifierContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+/**
+ * Nested model for Identifier
+ */
+export interface Identifier {
+    idType: string;
+    value: string;
+}
+/**
+ * Nested model for IdentifierUpdate
+ */
+export interface IdentifierUpdate {
+    idType: string;
+    oldValue: string;
+    newValue: string;
+}
+/**
+ * Response model for CreateProfileIdentifier202Response operations
+ */
+interface CreateProfileIdentifier202Response_ResponseResource {
+    message: string;
+}
+/**
+ * Response model for IdentifierSet operations
+ */
+interface IdentifierSet_ResponseResource {
+    idType: string;
+    values: Array<string>;
+}
+/**
+ * Response model for DeleteProfileIdentifier202Response operations
+ */
+interface DeleteProfileIdentifier202Response_ResponseResource {
+    message: string;
+}
+/**
+ * Response model for PatchProfileIdentifier202Response operations
+ */
+interface PatchProfileIdentifier202Response_ResponseResource {
+    message: string;
+}
+/**
+ * Union type for all possible response models
+ */
+type IdentifierResource = CreateProfileIdentifier202Response_ResponseResource | IdentifierSet_ResponseResource | DeleteProfileIdentifier202Response_ResponseResource | PatchProfileIdentifier202Response_ResponseResource;
+export declare class IdentifierInstance {
+    protected _version: V1;
+    protected _solution: IdentifierContextSolution;
+    protected _context?: IdentifierContext;
+    constructor(_version: V1, _payload: IdentifierResource, storeId: string, profileId: string, idType?: string);
+    message?: string;
+    /**
+     * Identifier type defined in Identity Resolution Settings.
+     */
+    idType?: string;
+    /**
+     * Server managed collection of stored values for the identifier type.  Identifier values are normalized according to the corresponding identifier settings and ordered chronologically.
+     */
+    values?: Array<string>;
+    private get _proxy();
+    /**
+     * Remove a IdentifierInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance
+     */
+    remove(callback?: (error: Error | null, item?: IdentifierInstance) => any): Promise<IdentifierInstance>;
+    /**
+     * Remove a IdentifierInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance
+     */
+    remove(params: IdentifierContextRemoveOptions, callback?: (error: Error | null, item?: IdentifierInstance) => any): Promise<IdentifierInstance>;
+    /**
+     * Remove a IdentifierInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance with HTTP metadata
+     */
+    removeWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<IdentifierInstance>) => any): Promise<ApiResponse<IdentifierInstance>>;
+    /**
+     * Remove a IdentifierInstance and return HTTP info
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance with HTTP metadata
+     */
+    removeWithHttpInfo(params: IdentifierContextRemoveOptions, callback?: (error: Error | null, item?: ApiResponse<IdentifierInstance>) => any): Promise<ApiResponse<IdentifierInstance>>;
+    /**
+     * Fetch a IdentifierInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance
+     */
+    fetch(callback?: (error: Error | null, item?: IdentifierInstance) => any): Promise<IdentifierInstance>;
+    /**
+     * Fetch a IdentifierInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance with HTTP metadata
+     */
+    fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<IdentifierInstance>) => any): Promise<ApiResponse<IdentifierInstance>>;
+    /**
+     * Patch a IdentifierInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance
+     */
+    patch(params: IdentifierUpdate, headers?: any, callback?: (error: Error | null, item?: IdentifierInstance) => any): Promise<IdentifierInstance>;
+    /**
+     * Patch a IdentifierInstance and return HTTP info
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance with HTTP metadata
+     */
+    patchWithHttpInfo(params: IdentifierUpdate, headers?: any, callback?: (error: Error | null, item?: ApiResponse<IdentifierInstance>) => any): Promise<ApiResponse<IdentifierInstance>>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        message: string;
+        idType: string;
+        values: string[];
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface IdentifierSolution {
+    storeId: string;
+    profileId: string;
+}
+export interface IdentifierListInstance {
+    _version: V1;
+    _solution: IdentifierSolution;
+    _uri: string;
+    (idType: string): IdentifierContext;
+    get(idType: string): IdentifierContext;
+    /**
+     * Create a IdentifierInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance
+     */
+    create(params: Identifier, headers?: any, callback?: (error: Error | null, item?: IdentifierInstance) => any): Promise<IdentifierInstance>;
+    /**
+     * Create a IdentifierInstance and return HTTP info
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed IdentifierInstance with HTTP metadata
+     */
+    createWithHttpInfo(params: Identifier, headers?: any, callback?: (error: Error | null, item?: ApiResponse<IdentifierInstance>) => any): Promise<ApiResponse<IdentifierInstance>>;
+    /**
+     * Lists IdentifierInstance 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 { IdentifierListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: IdentifierInstance[]) => any): Promise<IdentifierInstance[]>;
+    /**
+     * Lists IdentifierInstance records from the API as a list with HTTP metadata.
+     *
+     * Returns all records along with HTTP metadata from the first page fetched.
+     *
+     * If a function is passed as the first argument, it will be used as the callback
+     * function.
+     *
+     * @param { IdentifierListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records with metadata
+     */
+    listWithHttpInfo(callback?: (error: Error | null, items: ApiResponse<IdentifierInstance[]>) => any): Promise<ApiResponse<IdentifierInstance[]>>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function IdentifierListInstance(version: V1, storeId: string, profileId: string): IdentifierListInstance;
+export {};