/** * This code was generated by * \ / _ _ _| _ _ * | (_)\/(_)(_|\/| |(/_ v1.0.0 * / / */ import Page = require('../../../../../base/Page'); import Response = require('../../../../../http/response'); import V2010 = require('../../../V2010'); import { SerializableClass } from '../../../../../interfaces'; type TriggerRecurring = 'daily'|'monthly'|'yearly'|'alltime'; type TriggerTriggerField = 'count'|'usage'|'price'; type TriggerUsageCategory = 'a2p-registration-fees'|'agent-conference'|'amazon-polly'|'answering-machine-detection'|'authy-authentications'|'authy-calls-outbound'|'authy-monthly-fees'|'authy-phone-intelligence'|'authy-phone-verifications'|'authy-sms-outbound'|'call-progess-events'|'calleridlookups'|'calls'|'calls-client'|'calls-globalconference'|'calls-inbound'|'calls-inbound-local'|'calls-inbound-mobile'|'calls-inbound-tollfree'|'calls-outbound'|'calls-pay-verb-transactions'|'calls-recordings'|'calls-sip'|'calls-sip-inbound'|'calls-sip-outbound'|'calls-transfers'|'carrier-lookups'|'conversations'|'conversations-api-requests'|'conversations-conversation-events'|'conversations-endpoint-connectivity'|'conversations-events'|'conversations-participant-events'|'conversations-participants'|'cps'|'flex-usage'|'fraud-lookups'|'group-rooms'|'group-rooms-data-track'|'group-rooms-encrypted-media-recorded'|'group-rooms-media-downloaded'|'group-rooms-media-recorded'|'group-rooms-media-routed'|'group-rooms-media-stored'|'group-rooms-participant-minutes'|'group-rooms-recorded-minutes'|'imp-v1-usage'|'lookups'|'marketplace'|'marketplace-algorithmia-named-entity-recognition'|'marketplace-cadence-transcription'|'marketplace-cadence-translation'|'marketplace-capio-speech-to-text'|'marketplace-convriza-ababa'|'marketplace-deepgram-phrase-detector'|'marketplace-digital-segment-business-info'|'marketplace-facebook-offline-conversions'|'marketplace-google-speech-to-text'|'marketplace-ibm-watson-message-insights'|'marketplace-ibm-watson-message-sentiment'|'marketplace-ibm-watson-recording-analysis'|'marketplace-ibm-watson-tone-analyzer'|'marketplace-icehook-systems-scout'|'marketplace-infogroup-dataaxle-bizinfo'|'marketplace-keen-io-contact-center-analytics'|'marketplace-marchex-cleancall'|'marketplace-marchex-sentiment-analysis-for-sms'|'marketplace-marketplace-nextcaller-social-id'|'marketplace-mobile-commons-opt-out-classifier'|'marketplace-nexiwave-voicemail-to-text'|'marketplace-nextcaller-advanced-caller-identification'|'marketplace-nomorobo-spam-score'|'marketplace-payfone-tcpa-compliance'|'marketplace-remeeting-automatic-speech-recognition'|'marketplace-tcpa-defense-solutions-blacklist-feed'|'marketplace-telo-opencnam'|'marketplace-truecnam-true-spam'|'marketplace-twilio-caller-name-lookup-us'|'marketplace-twilio-carrier-information-lookup'|'marketplace-voicebase-pci'|'marketplace-voicebase-transcription'|'marketplace-voicebase-transcription-custom-vocabulary'|'marketplace-whitepages-pro-caller-identification'|'marketplace-whitepages-pro-phone-intelligence'|'marketplace-whitepages-pro-phone-reputation'|'marketplace-wolfarm-spoken-results'|'marketplace-wolfram-short-answer'|'marketplace-ytica-contact-center-reporting-analytics'|'mediastorage'|'mms'|'mms-inbound'|'mms-inbound-longcode'|'mms-inbound-shortcode'|'mms-messages-carrierfees'|'mms-outbound'|'mms-outbound-longcode'|'mms-outbound-shortcode'|'monitor-reads'|'monitor-storage'|'monitor-writes'|'notify'|'notify-actions-attempts'|'notify-channels'|'number-format-lookups'|'pchat'|'pchat-users'|'peer-to-peer-rooms-participant-minutes'|'pfax'|'pfax-minutes'|'pfax-minutes-inbound'|'pfax-minutes-outbound'|'pfax-pages'|'phonenumbers'|'phonenumbers-cps'|'phonenumbers-emergency'|'phonenumbers-local'|'phonenumbers-mobile'|'phonenumbers-setups'|'phonenumbers-tollfree'|'premiumsupport'|'proxy'|'proxy-active-sessions'|'pstnconnectivity'|'pv'|'pv-composition-media-downloaded'|'pv-composition-media-encrypted'|'pv-composition-media-stored'|'pv-composition-minutes'|'pv-recording-compositions'|'pv-room-participants'|'pv-room-participants-au1'|'pv-room-participants-br1'|'pv-room-participants-ie1'|'pv-room-participants-jp1'|'pv-room-participants-sg1'|'pv-room-participants-us1'|'pv-room-participants-us2'|'pv-rooms'|'pv-sip-endpoint-registrations'|'recordings'|'recordingstorage'|'rooms-group-bandwidth'|'rooms-group-minutes'|'rooms-peer-to-peer-minutes'|'shortcodes'|'shortcodes-customerowned'|'shortcodes-mms-enablement'|'shortcodes-mps'|'shortcodes-random'|'shortcodes-uk'|'shortcodes-vanity'|'small-group-rooms'|'small-group-rooms-data-track'|'small-group-rooms-participant-minutes'|'sms'|'sms-inbound'|'sms-inbound-longcode'|'sms-inbound-shortcode'|'sms-messages-carrierfees'|'sms-messages-features'|'sms-messages-features-senderid'|'sms-outbound'|'sms-outbound-content-inspection'|'sms-outbound-longcode'|'sms-outbound-shortcode'|'speech-recognition'|'studio-engagements'|'sync'|'sync-actions'|'sync-endpoint-hours'|'sync-endpoint-hours-above-daily-cap'|'taskrouter-tasks'|'totalprice'|'transcriptions'|'trunking-cps'|'trunking-emergency-calls'|'trunking-origination'|'trunking-origination-local'|'trunking-origination-mobile'|'trunking-origination-tollfree'|'trunking-recordings'|'trunking-secure'|'trunking-termination'|'turnmegabytes'|'turnmegabytes-australia'|'turnmegabytes-brasil'|'turnmegabytes-germany'|'turnmegabytes-india'|'turnmegabytes-ireland'|'turnmegabytes-japan'|'turnmegabytes-singapore'|'turnmegabytes-useast'|'turnmegabytes-uswest'|'twilio-interconnect'|'verify-push'|'verify-totp'|'verify-whatsapp-conversations-business-initiated'|'video-recordings'|'virtual-agent'|'voice-insights'|'voice-insights-client-insights-on-demand-minute'|'voice-insights-ptsn-insights-on-demand-minute'|'voice-insights-sip-interface-insights-on-demand-minute'|'voice-insights-sip-trunking-insights-on-demand-minute'|'wireless'|'wireless-orders'|'wireless-orders-artwork'|'wireless-orders-bulk'|'wireless-orders-esim'|'wireless-orders-starter'|'wireless-usage'|'wireless-usage-commands'|'wireless-usage-commands-africa'|'wireless-usage-commands-asia'|'wireless-usage-commands-centralandsouthamerica'|'wireless-usage-commands-europe'|'wireless-usage-commands-home'|'wireless-usage-commands-northamerica'|'wireless-usage-commands-oceania'|'wireless-usage-commands-roaming'|'wireless-usage-data'|'wireless-usage-data-africa'|'wireless-usage-data-asia'|'wireless-usage-data-centralandsouthamerica'|'wireless-usage-data-custom-additionalmb'|'wireless-usage-data-custom-first5mb'|'wireless-usage-data-domestic-roaming'|'wireless-usage-data-europe'|'wireless-usage-data-individual-additionalgb'|'wireless-usage-data-individual-firstgb'|'wireless-usage-data-international-roaming-canada'|'wireless-usage-data-international-roaming-india'|'wireless-usage-data-international-roaming-mexico'|'wireless-usage-data-northamerica'|'wireless-usage-data-oceania'|'wireless-usage-data-pooled'|'wireless-usage-data-pooled-downlink'|'wireless-usage-data-pooled-uplink'|'wireless-usage-mrc'|'wireless-usage-mrc-custom'|'wireless-usage-mrc-individual'|'wireless-usage-mrc-pooled'|'wireless-usage-mrc-suspended'|'wireless-usage-sms'|'wireless-usage-voice'; /** * Initialize the TriggerList * * @param version - Version of the resource * @param accountSid - A 34 character string that uniquely identifies this resource. */ declare function TriggerList(version: V2010, accountSid: string): TriggerListInstance; /** * Options to pass to update * * @property callbackMethod - The HTTP method to use to call callback_url * @property callbackUrl - The URL we call when the trigger fires * @property friendlyName - A string to describe the resource */ interface TriggerInstanceUpdateOptions { callbackMethod?: string; callbackUrl?: string; friendlyName?: string; } interface TriggerListInstance { /** * @param sid - sid of instance */ (sid: string): TriggerContext; /** * create a TriggerInstance * * @param opts - Options for request * @param callback - Callback to handle processed record */ create(opts: TriggerListInstanceCreateOptions, callback?: (error: Error | null, item: TriggerInstance) => any): Promise; /** * Streams TriggerInstance 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 callback - Function to process each record */ each(callback?: (item: TriggerInstance, done: (err?: Error) => void) => void): void; /** * Streams TriggerInstance 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 opts - Options for request * @param callback - Function to process each record */ each(opts?: TriggerListInstanceEachOptions, callback?: (item: TriggerInstance, done: (err?: Error) => void) => void): void; /** * Constructs a trigger * * @param sid - The unique string that identifies the resource */ get(sid: string): TriggerContext; /** * Retrieve a single target page of TriggerInstance 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 callback - Callback to handle list of records */ getPage(callback?: (error: Error | null, items: TriggerPage) => any): Promise; /** * Retrieve a single target page of TriggerInstance 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 targetUrl - API-generated URL for the requested results page * @param callback - Callback to handle list of records */ getPage(targetUrl?: string, callback?: (error: Error | null, items: TriggerPage) => any): Promise; /** * Lists TriggerInstance 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 callback - Callback to handle list of records */ list(callback?: (error: Error | null, items: TriggerInstance[]) => any): Promise; /** * Lists TriggerInstance 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 opts - Options for request * @param callback - Callback to handle list of records */ list(opts?: TriggerListInstanceOptions, callback?: (error: Error | null, items: TriggerInstance[]) => any): Promise; /** * Retrieve a single page of TriggerInstance 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 callback - Callback to handle list of records */ page(callback?: (error: Error | null, items: TriggerPage) => any): Promise; /** * Retrieve a single page of TriggerInstance 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 opts - Options for request * @param callback - Callback to handle list of records */ page(opts?: TriggerListInstancePageOptions, callback?: (error: Error | null, items: TriggerPage) => any): Promise; /** * Provide a user-friendly representation */ toJSON(): any; } /** * Options to pass to create * * @property callbackMethod - The HTTP method to use to call callback_url * @property callbackUrl - The URL we call when the trigger fires * @property friendlyName - A string to describe the resource * @property recurring - The frequency of a recurring UsageTrigger * @property triggerBy - The field in the UsageRecord resource that fires the trigger * @property triggerValue - The usage value at which the trigger should fire * @property usageCategory - The usage category the trigger watches */ interface TriggerListInstanceCreateOptions { callbackMethod?: string; callbackUrl: string; friendlyName?: string; recurring?: TriggerRecurring; triggerBy?: TriggerTriggerField; triggerValue: string; usageCategory: TriggerUsageCategory; } /** * Options to pass to each * * @property callback - * Function to process each record. If this and a positional * callback are passed, this one will be used * @property done - Function to be called upon completion of streaming * @property limit - * Upper limit for the number of records to return. * each() guarantees never to return more than limit. * Default is no limit * @property pageSize - * Number of records to fetch per request, * when not set will use the default value of 50 records. * If no pageSize is defined but a limit is defined, * each() will attempt to read the limit with the most efficient * page size, i.e. min(limit, 1000) * @property recurring - The frequency of recurring UsageTriggers to read * @property triggerBy - The trigger field of the UsageTriggers to read * @property usageCategory - The usage category of the UsageTriggers to read */ interface TriggerListInstanceEachOptions { callback?: (item: TriggerInstance, done: (err?: Error) => void) => void; done?: Function; limit?: number; pageSize?: number; recurring?: TriggerRecurring; triggerBy?: TriggerTriggerField; usageCategory?: TriggerUsageCategory; } /** * Options to pass to list * * @property limit - * Upper limit for the number of records to return. * list() guarantees never to return more than limit. * Default is no limit * @property pageSize - * Number of records to fetch per request, * when not set will use the default value of 50 records. * If no page_size is defined but a limit is defined, * list() will attempt to read the limit with the most * efficient page size, i.e. min(limit, 1000) * @property recurring - The frequency of recurring UsageTriggers to read * @property triggerBy - The trigger field of the UsageTriggers to read * @property usageCategory - The usage category of the UsageTriggers to read */ interface TriggerListInstanceOptions { limit?: number; pageSize?: number; recurring?: TriggerRecurring; triggerBy?: TriggerTriggerField; usageCategory?: TriggerUsageCategory; } /** * Options to pass to page * * @property pageNumber - Page Number, this value is simply for client state * @property pageSize - Number of records to return, defaults to 50 * @property pageToken - PageToken provided by the API * @property recurring - The frequency of recurring UsageTriggers to read * @property triggerBy - The trigger field of the UsageTriggers to read * @property usageCategory - The usage category of the UsageTriggers to read */ interface TriggerListInstancePageOptions { pageNumber?: number; pageSize?: number; pageToken?: string; recurring?: TriggerRecurring; triggerBy?: TriggerTriggerField; usageCategory?: TriggerUsageCategory; } interface TriggerPayload extends TriggerResource, Page.TwilioResponsePayload { } interface TriggerResource { account_sid: string; api_version: string; callback_method: string; callback_url: string; current_value: string; date_created: Date; date_fired: Date; date_updated: Date; friendly_name: string; recurring: TriggerRecurring; sid: string; trigger_by: TriggerTriggerField; trigger_value: string; uri: string; usage_category: TriggerUsageCategory; usage_record_uri: string; } interface TriggerSolution { accountSid?: string; } declare class TriggerContext { /** * Initialize the TriggerContext * * @param version - Version of the resource * @param accountSid - The SID of the Account that created the resource to fetch * @param sid - The unique string that identifies the resource */ constructor(version: V2010, accountSid: string, sid: string); /** * fetch a TriggerInstance * * @param callback - Callback to handle processed record */ fetch(callback?: (error: Error | null, items: TriggerInstance) => any): Promise; /** * remove a TriggerInstance * * @param callback - Callback to handle processed record */ remove(callback?: (error: Error | null, items: TriggerInstance) => any): Promise; /** * Provide a user-friendly representation */ toJSON(): any; /** * update a TriggerInstance * * @param callback - Callback to handle processed record */ update(callback?: (error: Error | null, items: TriggerInstance) => any): Promise; /** * update a TriggerInstance * * @param opts - Options for request * @param callback - Callback to handle processed record */ update(opts?: TriggerInstanceUpdateOptions, callback?: (error: Error | null, items: TriggerInstance) => any): Promise; } declare class TriggerInstance extends SerializableClass { /** * Initialize the TriggerContext * * @param version - Version of the resource * @param payload - The instance payload * @param accountSid - A 34 character string that uniquely identifies this resource. * @param sid - The unique string that identifies the resource */ constructor(version: V2010, payload: TriggerPayload, accountSid: string, sid: string); private _proxy: TriggerContext; accountSid: string; apiVersion: string; callbackMethod: string; callbackUrl: string; currentValue: string; dateCreated: Date; dateFired: Date; dateUpdated: Date; /** * fetch a TriggerInstance * * @param callback - Callback to handle processed record */ fetch(callback?: (error: Error | null, items: TriggerInstance) => any): Promise; friendlyName: string; recurring: TriggerRecurring; /** * remove a TriggerInstance * * @param callback - Callback to handle processed record */ remove(callback?: (error: Error | null, items: TriggerInstance) => any): Promise; sid: string; /** * Provide a user-friendly representation */ toJSON(): any; triggerBy: TriggerTriggerField; triggerValue: string; /** * update a TriggerInstance * * @param callback - Callback to handle processed record */ update(callback?: (error: Error | null, items: TriggerInstance) => any): Promise; /** * update a TriggerInstance * * @param opts - Options for request * @param callback - Callback to handle processed record */ update(opts?: TriggerInstanceUpdateOptions, callback?: (error: Error | null, items: TriggerInstance) => any): Promise; uri: string; usageCategory: TriggerUsageCategory; usageRecordUri: string; } declare class TriggerPage extends Page { /** * Initialize the TriggerPage * * @param version - Version of the resource * @param response - Response from the API * @param solution - Path solution */ constructor(version: V2010, response: Response, solution: TriggerSolution); /** * Build an instance of TriggerInstance * * @param payload - Payload response from the API */ getInstance(payload: TriggerPayload): TriggerInstance; /** * Provide a user-friendly representation */ toJSON(): any; } export { TriggerContext, TriggerInstance, TriggerInstanceUpdateOptions, TriggerList, TriggerListInstance, TriggerListInstanceCreateOptions, TriggerListInstanceEachOptions, TriggerListInstanceOptions, TriggerListInstancePageOptions, TriggerPage, TriggerPayload, TriggerRecurring, TriggerResource, TriggerSolution, TriggerTriggerField, TriggerUsageCategory }