@signalwire/compatibility-api/lib/rest/sync/v1/service/syncStream/streamMessage.d.ts

SignalWire Compatibility API

/**
 * This code was generated by
 * \ / _    _  _|   _  _
 *  | (_)\/(_)(_|\/| |(/_  v1.0.0
 *       /       /
 */

import Page = require('../../../../../base/Page');
import Response = require('../../../../../http/response');
import V1 = require('../../../V1');
import { SerializableClass } from '../../../../../interfaces';

/**
 * Initialize the StreamMessageList
 *
 * @param version - Version of the resource
 * @param serviceSid - The SID of the Sync Service that the resource is associated with
 * @param streamSid - The unique string that identifies the resource
 */
declare function StreamMessageList(version: V1, serviceSid: string, streamSid: string): StreamMessageListInstance;

interface StreamMessageListInstance {
  /**
   * create a StreamMessageInstance
   *
   * @param opts - Options for request
   * @param callback - Callback to handle processed record
   */
  create(opts: StreamMessageListInstanceCreateOptions, callback?: (error: Error | null, item: StreamMessageInstance) => any): Promise<StreamMessageInstance>;
  /**
   * Provide a user-friendly representation
   */
  toJSON(): any;
}

/**
 * Options to pass to create
 *
 * @property data - A JSON string that represents an arbitrary, schema-less object that makes up the Stream Message body
 */
interface StreamMessageListInstanceCreateOptions {
  data: object;
}

interface StreamMessagePayload extends StreamMessageResource, Page.TwilioResponsePayload {
}

interface StreamMessageResource {
  data: object;
  sid: string;
}

interface StreamMessageSolution {
  serviceSid?: string;
  streamSid?: string;
}


declare class StreamMessageInstance extends SerializableClass {
  /**
   * Initialize the StreamMessageContext
   *
   * @param version - Version of the resource
   * @param payload - The instance payload
   * @param serviceSid - The SID of the Sync Service that the resource is associated with
   * @param streamSid - The unique string that identifies the resource
   */
  constructor(version: V1, payload: StreamMessagePayload, serviceSid: string, streamSid: string);

  data: any;
  sid: string;
  /**
   * Provide a user-friendly representation
   */
  toJSON(): any;
}


declare class StreamMessagePage extends Page<V1, StreamMessagePayload, StreamMessageResource, StreamMessageInstance> {
  /**
   * Initialize the StreamMessagePage
   *
   * @param version - Version of the resource
   * @param response - Response from the API
   * @param solution - Path solution
   */
  constructor(version: V1, response: Response<string>, solution: StreamMessageSolution);

  /**
   * Build an instance of StreamMessageInstance
   *
   * @param payload - Payload response from the API
   */
  getInstance(payload: StreamMessagePayload): StreamMessageInstance;
  /**
   * Provide a user-friendly representation
   */
  toJSON(): any;
}

export { StreamMessageInstance, StreamMessageList, StreamMessageListInstance, StreamMessageListInstanceCreateOptions, StreamMessagePage, StreamMessagePayload, StreamMessageResource, StreamMessageSolution }