twilio 6.0.0 → 6.0.2

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

@@ -0,0 +1,233 @@
+import { inspect, InspectOptions } from "util";
+import TokenPage, { TokenPaginationPayload } from "../../../base/TokenPage";
+import Response from "../../../http/response";
+import V1 from "../V1";
+import { ApiResponse } from "../../../base/ApiResponse";
+/**
+ * Options to pass to each
+ */
+export interface TraitListInstanceEachOptions {
+    /** The maximum number of items to return per page, maximum of 1000. */
+    pageSize?: number;
+    /** The token for the page of results to retrieve. */
+    pageToken?: string;
+    /** Either \'ASC\' or \'DESC\' to sort results ascending or descending respectively. */
+    orderBy?: "ASC" | "DESC";
+    /** Comma separated list of trait group names to include. */
+    traitGroups?: string;
+    /** Function to process each record. If this and a positional callback are passed, this one will be used */
+    callback?: (item: TraitInstance, 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 TraitListInstanceOptions {
+    /** The maximum number of items to return per page, maximum of 1000. */
+    pageSize?: number;
+    /** The token for the page of results to retrieve. */
+    pageToken?: string;
+    /** Either \'ASC\' or \'DESC\' to sort results ascending or descending respectively. */
+    orderBy?: "ASC" | "DESC";
+    /** Comma separated list of trait group names to include. */
+    traitGroups?: string;
+    /** 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 TraitListInstancePageOptions {
+    /** The maximum number of items to return per page, maximum of 1000. */
+    pageSize?: number;
+    /** The token for the page of results to retrieve. */
+    pageToken?: string;
+    /** Either \'ASC\' or \'DESC\' to sort results ascending or descending respectively. */
+    orderBy?: "ASC" | "DESC";
+    /** Comma separated list of trait group names to include. */
+    traitGroups?: string;
+}
+export interface TraitSolution {
+    storeId: string;
+    profileId: string;
+}
+export interface TraitListInstance {
+    _version: V1;
+    _solution: TraitSolution;
+    _uri: string;
+    /**
+     * Streams TraitInstance 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 { TraitListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: TraitInstance, done: (err?: Error) => void) => void): void;
+    each(params: TraitListInstanceEachOptions, callback?: (item: TraitInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Streams TraitInstance records from the API with HTTP metadata captured per page.
+     *
+     * This operation lazily loads records as efficiently as possible until the limit
+     * is reached. HTTP metadata (status code, headers) is captured for each page request.
+     *
+     * 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 { TraitListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    eachWithHttpInfo(callback?: (item: TraitInstance, done: (err?: Error) => void) => void): void;
+    eachWithHttpInfo(params: TraitListInstanceEachOptions, callback?: (item: TraitInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of TraitInstance 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: TraitPage) => any): Promise<TraitPage>;
+    /**
+     * Retrieve a single target page of TraitInstance records from the API with HTTP metadata.
+     *
+     * 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 with metadata
+     */
+    getPageWithHttpInfo(targetUrl: string, callback?: (error: Error | null, items: ApiResponse<TraitPage>) => any): Promise<ApiResponse<TraitPage>>;
+    /**
+     * Lists TraitInstance 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 { TraitListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: TraitInstance[]) => any): Promise<TraitInstance[]>;
+    list(params: TraitListInstanceOptions, callback?: (error: Error | null, items: TraitInstance[]) => any): Promise<TraitInstance[]>;
+    /**
+     * Lists TraitInstance 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 { TraitListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records with metadata
+     */
+    listWithHttpInfo(callback?: (error: Error | null, items: ApiResponse<TraitInstance[]>) => any): Promise<ApiResponse<TraitInstance[]>>;
+    listWithHttpInfo(params: TraitListInstanceOptions, callback?: (error: Error | null, items: ApiResponse<TraitInstance[]>) => any): Promise<ApiResponse<TraitInstance[]>>;
+    /**
+     * Retrieve a single page of TraitInstance 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 { TraitListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: TraitPage) => any): Promise<TraitPage>;
+    page(params: TraitListInstancePageOptions, callback?: (error: Error | null, items: TraitPage) => any): Promise<TraitPage>;
+    /**
+     * Retrieve a single page of TraitInstance records from the API with HTTP metadata.
+     *
+     * The request is executed immediately.
+     *
+     * If a function is passed as the first argument, it will be used as the callback
+     * function.
+     *
+     * @param { TraitListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records with metadata
+     */
+    pageWithHttpInfo(callback?: (error: Error | null, items: ApiResponse<TraitPage>) => any): Promise<ApiResponse<TraitPage>>;
+    pageWithHttpInfo(params: TraitListInstancePageOptions, callback?: (error: Error | null, items: ApiResponse<TraitPage>) => any): Promise<ApiResponse<TraitPage>>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function TraitListInstance(version: V1, storeId: string, profileId: string): TraitListInstance;
+interface TraitPayload extends TokenPaginationPayload {
+    traits: TraitResource[];
+}
+interface TraitResource {
+    name: string;
+    value: any;
+    traitGroup: string;
+    timestamp: Date;
+}
+/**
+ * Full metadata about a trait, beyond the name value pair.
+ */
+export declare class TraitInstance {
+    protected _version: V1;
+    constructor(_version: V1, _payload: TraitResource, storeId: string, profileId: string);
+    /**
+     * The name of the trait.
+     */
+    name: string;
+    /**
+     * The value of a trait. Can be a string, integer, boolean, or an array of these types (arrays cannot contain nested arrays).
+     */
+    value: any;
+    /**
+     * The trait group name to which this trait belongs.
+     */
+    traitGroup: string;
+    /**
+     * The time the trait was created or last updated.
+     */
+    timestamp: Date;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        name: string;
+        value: any;
+        traitGroup: string;
+        timestamp: Date;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export declare class TraitPage extends TokenPage<V1, TraitPayload, TraitResource, TraitInstance> {
+    /**
+     * Initialize the TraitPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param uri - URI of the resource
+     * @param params - Query parameters
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, uri: string, params: any, solution: TraitSolution);
+    /**
+     * Build an instance of TraitInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: TraitResource): TraitInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

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

@@ -0,0 +1,190 @@
+"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.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TraitPage = exports.TraitInstance = void 0;
+exports.TraitListInstance = TraitListInstance;
+const util_1 = require("util");
+const TokenPage_1 = __importDefault(require("../../../base/TokenPage"));
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+function TraitListInstance(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}/Traits`;
+    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["pageToken"] !== undefined)
+            data["pageToken"] = params["pageToken"];
+        if (params["orderBy"] !== undefined)
+            data["orderBy"] = params["orderBy"];
+        if (params["traitGroups"] !== undefined)
+            data["traitGroups"] = params["traitGroups"];
+        const headers = {};
+        headers["Accept"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.page({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new TraitPage(operationVersion, payload, instance._uri, data, 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 TraitPage(instance._version, payload, instance._uri, {}, instance._solution));
+        pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
+        return pagePromise;
+    };
+    instance.pageWithHttpInfo = function pageWithHttpInfo(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["pageSize"] !== undefined)
+            data["pageSize"] = params["pageSize"];
+        if (params["pageToken"] !== undefined)
+            data["pageToken"] = params["pageToken"];
+        if (params["orderBy"] !== undefined)
+            data["orderBy"] = params["orderBy"];
+        if (params["traitGroups"] !== undefined)
+            data["traitGroups"] = params["traitGroups"];
+        const headers = {};
+        headers["Accept"] = "application/json";
+        let operationVersion = version;
+        // For page operations, use page() directly as it already returns { statusCode, body, headers }
+        // IMPORTANT: Pass full response to Page constructor, not response.body
+        let operationPromise = operationVersion
+            .page({ uri: instance._uri, method: "get", params: data, headers })
+            .then((response) => ({
+            statusCode: response.statusCode,
+            headers: response.headers,
+            body: new TraitPage(operationVersion, response, instance._uri, data, instance._solution),
+        }));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.each = instance._version.each;
+    instance.eachWithHttpInfo = instance._version.eachWithHttpInfo;
+    instance.list = instance._version.list;
+    instance.listWithHttpInfo = instance._version.listWithHttpInfo;
+    instance.getPageWithHttpInfo = function getPageWithHttpInfo(targetUrl, callback) {
+        // Use request() directly as it already returns { statusCode, body, headers }
+        const operationPromise = instance._version._domain.twilio.request({
+            method: "get",
+            uri: targetUrl,
+        });
+        let pagePromise = operationPromise.then((response) => ({
+            statusCode: response.statusCode,
+            headers: response.headers,
+            body: new TraitPage(instance._version, response, instance._uri, {}, 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;
+}
+/**
+ * Full metadata about a trait, beyond the name value pair.
+ */
+class TraitInstance {
+    constructor(_version, _payload, storeId, profileId) {
+        this._version = _version;
+        const payload = _payload;
+        this.name = payload.name;
+        this.value = payload.value;
+        this.traitGroup = payload.traitGroup;
+        this.timestamp = deserialize.iso8601DateTime(payload.timestamp);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            name: this.name,
+            value: this.value,
+            traitGroup: this.traitGroup,
+            timestamp: this.timestamp,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.TraitInstance = TraitInstance;
+class TraitPage extends TokenPage_1.default {
+    /**
+     * Initialize the TraitPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param uri - URI of the resource
+     * @param params - Query parameters
+     * @param solution - Path solution
+     */
+    constructor(version, response, uri, params, solution) {
+        super(version, response, uri, params, solution);
+    }
+    /**
+     * Build an instance of TraitInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new TraitInstance(this._version, payload, this._solution.storeId, this._solution.profileId);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.TraitPage = TraitPage;