@twilio-labs/serverless-api
Version:
API-wrapper for the Twilio Serverless API
32 lines (31 loc) • 1.38 kB
TypeScript
/** @module @twilio-labs/serverless-api/dist/api */
import { TwilioServerlessApiClient } from '../client';
import { ServiceResource, Sid } from '../types';
/**
* Creates a new service given a service name
*
* @export
* @param {string} serviceName the unique name for the service
* @param {TwilioServerlessApiClient} client API client
* @param {boolean} uiEditable Whether the Service's properties and subresources can be edited via the UI. The default value is false.
* @returns {Promise<string>}
*/
export declare function createService(serviceName: string, client: TwilioServerlessApiClient, uiEditable?: boolean): Promise<string>;
/**
* Lists all services attached to an account
*
* @export
* @param {TwilioServerlessApiClient} client API client
* @returns {Promise<ServiceResource[]>}
*/
export declare function listServices(client: TwilioServerlessApiClient): Promise<ServiceResource[]>;
/**
* Tries to find the service SID associated to a service name
*
* @export
* @param {string} uniqueName the unique name of the service
* @param {TwilioServerlessApiClient} client API client
* @returns {(Promise<string | undefined>)}
*/
export declare function findServiceSid(uniqueName: string, client: TwilioServerlessApiClient): Promise<string | undefined>;
export declare function getService(sid: Sid, client: TwilioServerlessApiClient): Promise<ServiceResource>;