/// import { inspect, InspectOptions } from "util"; import Page, { TwilioResponsePayload } from "../../../../base/Page"; import Response from "../../../../http/response"; import V1 from "../../V1"; /** * Options to pass to each */ export interface SchemaVersionListInstanceEachOptions { /** 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: SchemaVersionInstance, 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 SchemaVersionListInstanceOptions { /** 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 SchemaVersionListInstancePageOptions { /** 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 SchemaVersionContext { /** * Fetch a SchemaVersionInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed SchemaVersionInstance */ fetch(callback?: (error: Error | null, item?: SchemaVersionInstance) => any): Promise; /** * Provide a user-friendly representation */ toJSON(): any; [inspect.custom](_depth: any, options: InspectOptions): any; } export interface SchemaVersionContextSolution { id: string; schemaVersion: number; } export declare class SchemaVersionContextImpl implements SchemaVersionContext { protected _version: V1; protected _solution: SchemaVersionContextSolution; protected _uri: string; constructor(_version: V1, id: string, schemaVersion: number); fetch(callback?: (error: Error | null, item?: SchemaVersionInstance) => any): Promise; /** * Provide a user-friendly representation * * @returns Object */ toJSON(): SchemaVersionContextSolution; [inspect.custom](_depth: any, options: InspectOptions): string; } interface SchemaVersionPayload extends TwilioResponsePayload { schema_versions: SchemaVersionResource[]; } interface SchemaVersionResource { id: string; schema_version: number; date_created: Date; url: string; raw: string; } export declare class SchemaVersionInstance { protected _version: V1; protected _solution: SchemaVersionContextSolution; protected _context?: SchemaVersionContext; constructor(_version: V1, payload: SchemaVersionResource, id: string, schemaVersion?: number); /** * The unique identifier of the schema. Each schema can have multiple versions, that share the same id. */ id: string; /** * The version of this schema. */ schemaVersion: number; /** * The date the schema version was created, given in ISO 8601 format. */ dateCreated: Date; /** * The URL of this resource. */ url: string; raw: string; private get _proxy(); /** * Fetch a SchemaVersionInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed SchemaVersionInstance */ fetch(callback?: (error: Error | null, item?: SchemaVersionInstance) => any): Promise; /** * Provide a user-friendly representation * * @returns Object */ toJSON(): { id: string; schemaVersion: number; dateCreated: Date; url: string; raw: string; }; [inspect.custom](_depth: any, options: InspectOptions): string; } export interface SchemaVersionSolution { id: string; } export interface SchemaVersionListInstance { _version: V1; _solution: SchemaVersionSolution; _uri: string; (schemaVersion: number): SchemaVersionContext; get(schemaVersion: number): SchemaVersionContext; /** * Streams SchemaVersionInstance 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 { SchemaVersionListInstanceEachOptions } [params] - Options for request * @param { function } [callback] - Function to process each record */ each(callback?: (item: SchemaVersionInstance, done: (err?: Error) => void) => void): void; each(params: SchemaVersionListInstanceEachOptions, callback?: (item: SchemaVersionInstance, done: (err?: Error) => void) => void): void; /** * Retrieve a single target page of SchemaVersionInstance 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: SchemaVersionPage) => any): Promise; /** * Lists SchemaVersionInstance 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 { SchemaVersionListInstanceOptions } [params] - Options for request * @param { function } [callback] - Callback to handle list of records */ list(callback?: (error: Error | null, items: SchemaVersionInstance[]) => any): Promise; list(params: SchemaVersionListInstanceOptions, callback?: (error: Error | null, items: SchemaVersionInstance[]) => any): Promise; /** * Retrieve a single page of SchemaVersionInstance 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 { SchemaVersionListInstancePageOptions } [params] - Options for request * @param { function } [callback] - Callback to handle list of records */ page(callback?: (error: Error | null, items: SchemaVersionPage) => any): Promise; page(params: SchemaVersionListInstancePageOptions, callback?: (error: Error | null, items: SchemaVersionPage) => any): Promise; /** * Provide a user-friendly representation */ toJSON(): any; [inspect.custom](_depth: any, options: InspectOptions): any; } export declare function SchemaVersionListInstance(version: V1, id: string): SchemaVersionListInstance; export declare class SchemaVersionPage extends Page { /** * Initialize the SchemaVersionPage * * @param version - Version of the resource * @param response - Response from the API * @param solution - Path solution */ constructor(version: V1, response: Response, solution: SchemaVersionSolution); /** * Build an instance of SchemaVersionInstance * * @param payload - Payload response from the API */ getInstance(payload: SchemaVersionResource): SchemaVersionInstance; [inspect.custom](depth: any, options: InspectOptions): string; } export {};