interactionChannelInvite.ts

/*
 * This code was generated by
 * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
 *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
 *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
 *
 * Twilio - Flex
 * 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.
 */

import { inspect, InspectOptions } from "util";
import Page, { TwilioResponsePayload } from "../../../../../base/Page";
import Response from "../../../../../http/response";
import V1 from "../../../V1";
const deserialize = require("../../../../../base/deserialize");
const serialize = require("../../../../../base/serialize");
import { isValidPathParam } from "../../../../../base/utility";

/**
 * Options to pass to create a InteractionChannelInviteInstance
 */
export interface InteractionChannelInviteListInstanceCreateOptions {
  /** The Interaction\\\'s routing logic. */
  routing: any;
}
/**
 * Options to pass to each
 */
export interface InteractionChannelInviteListInstanceEachOptions {
  /** 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: InteractionChannelInviteInstance,
    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 InteractionChannelInviteListInstanceOptions {
  /** 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 InteractionChannelInviteListInstancePageOptions {
  /** 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 InteractionChannelInviteSolution {
  interactionSid: string;
  channelSid: string;
}

export interface InteractionChannelInviteListInstance {
  _version: V1;
  _solution: InteractionChannelInviteSolution;
  _uri: string;

  /**
   * Create a InteractionChannelInviteInstance
   *
   * @param params - Parameter for request
   * @param callback - Callback to handle processed record
   *
   * @returns Resolves to processed InteractionChannelInviteInstance
   */
  create(
    params: InteractionChannelInviteListInstanceCreateOptions,
    callback?: (
      error: Error | null,
      item?: InteractionChannelInviteInstance
    ) => any
  ): Promise<InteractionChannelInviteInstance>;

  /**
   * Streams InteractionChannelInviteInstance 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 { InteractionChannelInviteListInstanceEachOptions } [params] - Options for request
   * @param { function } [callback] - Function to process each record
   */
  each(
    callback?: (
      item: InteractionChannelInviteInstance,
      done: (err?: Error) => void
    ) => void
  ): void;
  each(
    params: InteractionChannelInviteListInstanceEachOptions,
    callback?: (
      item: InteractionChannelInviteInstance,
      done: (err?: Error) => void
    ) => void
  ): void;
  /**
   * Retrieve a single target page of InteractionChannelInviteInstance 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: InteractionChannelInvitePage) => any
  ): Promise<InteractionChannelInvitePage>;
  /**
   * Lists InteractionChannelInviteInstance 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 { InteractionChannelInviteListInstanceOptions } [params] - Options for request
   * @param { function } [callback] - Callback to handle list of records
   */
  list(
    callback?: (
      error: Error | null,
      items: InteractionChannelInviteInstance[]
    ) => any
  ): Promise<InteractionChannelInviteInstance[]>;
  list(
    params: InteractionChannelInviteListInstanceOptions,
    callback?: (
      error: Error | null,
      items: InteractionChannelInviteInstance[]
    ) => any
  ): Promise<InteractionChannelInviteInstance[]>;
  /**
   * Retrieve a single page of InteractionChannelInviteInstance 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 { InteractionChannelInviteListInstancePageOptions } [params] - Options for request
   * @param { function } [callback] - Callback to handle list of records
   */
  page(
    callback?: (error: Error | null, items: InteractionChannelInvitePage) => any
  ): Promise<InteractionChannelInvitePage>;
  page(
    params: InteractionChannelInviteListInstancePageOptions,
    callback?: (error: Error | null, items: InteractionChannelInvitePage) => any
  ): Promise<InteractionChannelInvitePage>;

  /**
   * Provide a user-friendly representation
   */
  toJSON(): any;
  [inspect.custom](_depth: any, options: InspectOptions): any;
}

export function InteractionChannelInviteListInstance(
  version: V1,
  interactionSid: string,
  channelSid: string
): InteractionChannelInviteListInstance {
  if (!isValidPathParam(interactionSid)) {
    throw new Error("Parameter 'interactionSid' is not valid.");
  }

  if (!isValidPathParam(channelSid)) {
    throw new Error("Parameter 'channelSid' is not valid.");
  }

  const instance = {} as InteractionChannelInviteListInstance;

  instance._version = version;
  instance._solution = { interactionSid, channelSid };
  instance._uri = `/Interactions/${interactionSid}/Channels/${channelSid}/Invites`;

  instance.create = function create(
    params: InteractionChannelInviteListInstanceCreateOptions,
    callback?: (
      error: Error | null,
      items: InteractionChannelInviteInstance
    ) => any
  ): Promise<InteractionChannelInviteInstance> {
    if (params === null || params === undefined) {
      throw new Error('Required parameter "params" missing.');
    }

    if (params["routing"] === null || params["routing"] === undefined) {
      throw new Error("Required parameter \"params['routing']\" missing.");
    }

    let data: any = {};

    data["Routing"] = serialize.object(params["routing"]);

    const headers: any = {};
    headers["Content-Type"] = "application/x-www-form-urlencoded";

    let operationVersion = version,
      operationPromise = operationVersion.create({
        uri: instance._uri,
        method: "post",
        data,
        headers,
      });

    operationPromise = operationPromise.then(
      (payload) =>
        new InteractionChannelInviteInstance(
          operationVersion,
          payload,
          instance._solution.interactionSid,
          instance._solution.channelSid
        )
    );

    operationPromise = instance._version.setPromiseCallback(
      operationPromise,
      callback
    );
    return operationPromise;
  };

  instance.page = function page(
    params?:
      | InteractionChannelInviteListInstancePageOptions
      | ((error: Error | null, items: InteractionChannelInvitePage) => any),
    callback?: (error: Error | null, items: InteractionChannelInvitePage) => any
  ): Promise<InteractionChannelInvitePage> {
    if (params instanceof Function) {
      callback = params;
      params = {};
    } else {
      params = params || {};
    }

    let data: any = {};

    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: any = {};

    let operationVersion = version,
      operationPromise = operationVersion.page({
        uri: instance._uri,
        method: "get",
        params: data,
        headers,
      });

    operationPromise = operationPromise.then(
      (payload) =>
        new InteractionChannelInvitePage(
          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: string,
    callback?: (error: Error | null, items: InteractionChannelInvitePage) => any
  ): Promise<InteractionChannelInvitePage> {
    const operationPromise = instance._version._domain.twilio.request({
      method: "get",
      uri: targetUrl,
    });

    let pagePromise = operationPromise.then(
      (payload) =>
        new InteractionChannelInvitePage(
          instance._version,
          payload,
          instance._solution
        )
    );
    pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
    return pagePromise;
  };

  instance.toJSON = function toJSON() {
    return instance._solution;
  };

  instance[inspect.custom] = function inspectImpl(
    _depth: any,
    options: InspectOptions
  ) {
    return inspect(instance.toJSON(), options);
  };

  return instance;
}

interface InteractionChannelInvitePayload extends TwilioResponsePayload {
  invites: InteractionChannelInviteResource[];
}

interface InteractionChannelInviteResource {
  sid: string;
  interaction_sid: string;
  channel_sid: string;
  routing: any;
  url: string;
}

export class InteractionChannelInviteInstance {
  constructor(
    protected _version: V1,
    payload: InteractionChannelInviteResource,
    interactionSid: string,
    channelSid: string
  ) {
    this.sid = payload.sid;
    this.interactionSid = payload.interaction_sid;
    this.channelSid = payload.channel_sid;
    this.routing = payload.routing;
    this.url = payload.url;
  }

  /**
   * The unique string created by Twilio to identify an Interaction Channel Invite resource.
   */
  sid: string;
  /**
   * The Interaction SID for this Channel.
   */
  interactionSid: string;
  /**
   * The Channel SID for this Invite.
   */
  channelSid: string;
  /**
   * A JSON object representing the routing rules for the Interaction Channel. See [Outbound SMS Example](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) for an example Routing object. The Interactions resource uses TaskRouter for all routing functionality.   All attributes in the Routing object on your Interaction request body are added “as is” to the task. For a list of known attributes consumed by the Flex UI and/or Flex Insights, see [Known Task Attributes](https://www.twilio.com/docs/flex/developer/conversations/interactions-api#task-attributes).
   */
  routing: any;
  url: string;

  /**
   * Provide a user-friendly representation
   *
   * @returns Object
   */
  toJSON() {
    return {
      sid: this.sid,
      interactionSid: this.interactionSid,
      channelSid: this.channelSid,
      routing: this.routing,
      url: this.url,
    };
  }

  [inspect.custom](_depth: any, options: InspectOptions) {
    return inspect(this.toJSON(), options);
  }
}

export class InteractionChannelInvitePage extends Page<
  V1,
  InteractionChannelInvitePayload,
  InteractionChannelInviteResource,
  InteractionChannelInviteInstance
> {
  /**
   * Initialize the InteractionChannelInvitePage
   *
   * @param version - Version of the resource
   * @param response - Response from the API
   * @param solution - Path solution
   */
  constructor(
    version: V1,
    response: Response<string>,
    solution: InteractionChannelInviteSolution
  ) {
    super(version, response, solution);
  }

  /**
   * Build an instance of InteractionChannelInviteInstance
   *
   * @param payload - Payload response from the API
   */
  getInstance(
    payload: InteractionChannelInviteResource
  ): InteractionChannelInviteInstance {
    return new InteractionChannelInviteInstance(
      this._version,
      payload,
      this._solution.interactionSid,
      this._solution.channelSid
    );
  }

  [inspect.custom](depth: any, options: InspectOptions) {
    return inspect(this.toJSON(), options);
  }
}