Module: Twilio

Extended by:
SingleForwardable
Defined in:
lib/twilio-ruby/rest/api.rb,
lib/twilio-ruby.rb,
lib/twilio-ruby/util.rb,
lib/twilio-ruby/jwt/jwt.rb,
lib/twilio-ruby/version.rb,
lib/twilio-ruby/rest/fax.rb,
lib/twilio-ruby/rest/chat.rb,
lib/twilio-ruby/rest/sync.rb,
lib/twilio-ruby/rest/video.rb,
lib/twilio-ruby/rest/client.rb,
lib/twilio-ruby/rest/fax/v1.rb,
lib/twilio-ruby/rest/notify.rb,
lib/twilio-ruby/twiml/twiml.rb,
lib/twilio-ruby/rest/chat/v1.rb,
lib/twilio-ruby/rest/chat/v2.rb,
lib/twilio-ruby/rest/lookups.rb,
lib/twilio-ruby/rest/monitor.rb,
lib/twilio-ruby/rest/preview.rb,
lib/twilio-ruby/rest/pricing.rb,
lib/twilio-ruby/rest/sync/v1.rb,
lib/twilio-ruby/rest/accounts.rb,
lib/twilio-ruby/rest/trunking.rb,
lib/twilio-ruby/rest/video/v1.rb,
lib/twilio-ruby/rest/wireless.rb,
lib/twilio-ruby/framework/page.rb,
lib/twilio-ruby/rest/api/v2010.rb,
lib/twilio-ruby/rest/messaging.rb,
lib/twilio-ruby/rest/notify/v1.rb,
lib/twilio-ruby/framework/error.rb,
lib/twilio-ruby/jwt/task_router.rb,
lib/twilio-ruby/rest/fax/v1/fax.rb,
lib/twilio-ruby/rest/lookups/v1.rb,
lib/twilio-ruby/rest/monitor/v1.rb,
lib/twilio-ruby/rest/pricing/v1.rb,
lib/twilio-ruby/rest/taskrouter.rb,
lib/twilio-ruby/framework/domain.rb,
lib/twilio-ruby/framework/helper.rb,
lib/twilio-ruby/framework/values.rb,
lib/twilio-ruby/http/http_client.rb,
lib/twilio-ruby/jwt/access_token.rb,
lib/twilio-ruby/rest/accounts/v1.rb,
lib/twilio-ruby/rest/trunking/v1.rb,
lib/twilio-ruby/rest/wireless/v1.rb,
lib/twilio-ruby/framework/request.rb,
lib/twilio-ruby/framework/version.rb,
lib/twilio-ruby/rest/ip_messaging.rb,
lib/twilio-ruby/rest/messaging/v1.rb,
lib/twilio-ruby/rest/preview/sync.rb,
lib/twilio-ruby/framework/resource.rb,
lib/twilio-ruby/framework/response.rb,
lib/twilio-ruby/rest/preview/proxy.rb,
lib/twilio-ruby/rest/taskrouter/v1.rb,
lib/twilio-ruby/rest/video/v1/room.rb,
lib/twilio-ruby/twiml/fax_response.rb,
lib/twilio-ruby/util/configuration.rb,
lib/twilio-ruby/framework/serialize.rb,
lib/twilio-ruby/rest/chat/v1/service.rb,
lib/twilio-ruby/rest/chat/v2/service.rb,
lib/twilio-ruby/rest/ip_messaging/v1.rb,
lib/twilio-ruby/rest/ip_messaging/v2.rb,
lib/twilio-ruby/rest/sync/v1/service.rb,
lib/twilio-ruby/rest/wireless/v1/sim.rb,
lib/twilio-ruby/twiml/voice_response.rb,
lib/twilio-ruby/jwt/client_capability.rb,
lib/twilio-ruby/rest/monitor/v1/alert.rb,
lib/twilio-ruby/rest/monitor/v1/event.rb,
lib/twilio-ruby/rest/preview/wireless.rb,
lib/twilio-ruby/rest/pricing/v1/voice.rb,
lib/twilio-ruby/rest/api/v2010/account.rb,
lib/twilio-ruby/rest/notify/v1/service.rb,
lib/twilio-ruby/rest/trunking/v1/trunk.rb,
lib/twilio-ruby/rest/chat/v1/credential.rb,
lib/twilio-ruby/rest/chat/v2/credential.rb,
lib/twilio-ruby/rest/video/v1/recording.rb,
lib/twilio-ruby/rest/preview/marketplace.rb,
lib/twilio-ruby/rest/wireless/v1/command.rb,
lib/twilio-ruby/twiml/messaging_response.rb,
lib/twilio-ruby/framework/twilio_response.rb,
lib/twilio-ruby/rest/chat/v1/service/role.rb,
lib/twilio-ruby/rest/chat/v1/service/user.rb,
lib/twilio-ruby/rest/chat/v2/service/role.rb,
lib/twilio-ruby/rest/chat/v2/service/user.rb,
lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb,
lib/twilio-ruby/rest/messaging/v1/service.rb,
lib/twilio-ruby/rest/notify/v1/credential.rb,
lib/twilio-ruby/rest/preview/bulk_exports.rb,
lib/twilio-ruby/rest/preview/sync/service.rb,
lib/twilio-ruby/rest/preview/wireless/sim.rb,
lib/twilio-ruby/rest/pricing/v1/messaging.rb,
lib/twilio-ruby/rest/api/v2010/account/key.rb,
lib/twilio-ruby/rest/api/v2010/account/sip.rb,
lib/twilio-ruby/rest/preview/proxy/service.rb,
lib/twilio-ruby/rest/wireless/v1/rate_plan.rb,
lib/twilio-ruby/security/request_validator.rb,
lib/twilio-ruby/rest/accounts/v1/credential.rb,
lib/twilio-ruby/rest/api/v2010/account/call.rb,
lib/twilio-ruby/rest/notify/v1/service/user.rb,
lib/twilio-ruby/rest/preview/hosted_numbers.rb,
lib/twilio-ruby/rest/api/v2010/account/queue.rb,
lib/twilio-ruby/rest/api/v2010/account/token.rb,
lib/twilio-ruby/rest/api/v2010/account/usage.rb,
lib/twilio-ruby/rest/chat/v1/service/channel.rb,
lib/twilio-ruby/rest/chat/v2/service/channel.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service.rb,
lib/twilio-ruby/rest/ip_messaging/v2/service.rb,
lib/twilio-ruby/rest/lookups/v1/phone_number.rb,
lib/twilio-ruby/rest/pricing/v1/phone_number.rb,
lib/twilio-ruby/rest/pricing/v1/voice/number.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace.rb,
lib/twilio-ruby/rest/video/v1/room/recording.rb,
lib/twilio-ruby/rest/preview/deployed_devices.rb,
lib/twilio-ruby/rest/preview/wireless/command.rb,
lib/twilio-ruby/rest/pricing/v1/voice/country.rb,
lib/twilio-ruby/rest/sync/v1/service/document.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_map.rb,
lib/twilio-ruby/rest/api/v2010/account/address.rb,
lib/twilio-ruby/rest/api/v2010/account/message.rb,
lib/twilio-ruby/rest/api/v2010/account/new_key.rb,
lib/twilio-ruby/rest/notify/v1/service/binding.rb,
lib/twilio-ruby/rest/notify/v1/service/segment.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_list.rb,
lib/twilio-ruby/rest/ip_messaging/v1/credential.rb,
lib/twilio-ruby/rest/ip_messaging/v2/credential.rb,
lib/twilio-ruby/rest/preview/wireless/rate_plan.rb,
lib/twilio-ruby/rest/preview/wireless/sim/usage.rb,
lib/twilio-ruby/rest/api/v2010/account/recording.rb,
lib/twilio-ruby/rest/preview/bulk_exports/export.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb,
lib/twilio-ruby/rest/api/v2010/account/conference.rb,
lib/twilio-ruby/rest/api/v2010/account/short_code.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb,
lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb,
lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb,
lib/twilio-ruby/rest/pricing/v1/messaging/country.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb,
lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb,
lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb,
lib/twilio-ruby/rest/api/v2010/account/application.rb,
lib/twilio-ruby/rest/api/v2010/account/connect_app.rb,
lib/twilio-ruby/rest/api/v2010/account/signing_key.rb,
lib/twilio-ruby/rest/preview/proxy/service/session.rb,
lib/twilio-ruby/rest/preview/sync/service/document.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_map.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb,
lib/twilio-ruby/rest/api/v2010/account/notification.rb,
lib/twilio-ruby/rest/api/v2010/account/queue/member.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record.rb,
lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb,
lib/twilio-ruby/rest/chat/v1/service/channel/member.rb,
lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb,
lib/twilio-ruby/rest/chat/v2/service/channel/member.rb,
lib/twilio-ruby/rest/notify/v1/service/notification.rb,
lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_list.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb,
lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb,
lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb,
lib/twilio-ruby/rest/api/v2010/account/message/media.rb,
lib/twilio-ruby/rest/api/v2010/account/transcription.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb,
lib/twilio-ruby/rest/chat/v1/service/channel/message.rb,
lib/twilio-ruby/rest/chat/v2/service/channel/message.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb,
lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb,
lib/twilio-ruby/rest/messaging/v1/service/short_code.rb,
lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb,
lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb,
lib/twilio-ruby/rest/api/v2010/account/call/recording.rb,
lib/twilio-ruby/rest/preview/proxy/service/short_code.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb,
lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb,
lib/twilio-ruby/rest/api/v2010/account/new_signing_key.rb,
lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb,
lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb,
lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb,
lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb,
lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb,
lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb,
lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb,
lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb,
lib/twilio-ruby/rest/preview/proxy/service/phone_number.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb,
lib/twilio-ruby/rest/api/v2010/account/call/notification.rb,
lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb,
lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb,
lib/twilio-ruby/rest/api/v2010/account/validation_request.rb,
lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb,
lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb,
lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb,
lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb,
lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb,
lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb,
lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb,
lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb,
lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb,
lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb,
lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb,
lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb,
lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb,
lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb,
lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb,
lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb,
lib/twilio-ruby/rest/preview/proxy/service/session/participant.rb,
lib/twilio-ruby/rest/notify/v1/service/user/segment_memberships.rb,
lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb,
lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb,
lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_statistics.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb,
lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb,
lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb,
lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_permission.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb,
lib/twilio-ruby/rest/preview/proxy/service/session/participant/message_interaction.rb,
lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb,
lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb

Overview

This code was generated by \ / _ _ _| _ _

| (_)\/(_)(_|\/| |(/_  v1.0.0
     /       /

Defined Under Namespace

Modules: HTTP, JWT, REST, Security, TwiML, Util Classes: Request, Response, TwilioResponse, Values

Constant Summary collapse

VERSION = 
'5.2.1'

Class Method Summary collapse

Class Method Details

.configure {|configuration| ... } ⇒ Object

Pre-configure with account SID and auth token so that you don’t need to pass them to various initializers each time.

Yields:

  • (configuration) 


51
52
53
 
# File 'lib/twilio-ruby.rb', line 51

def self.configure(&block)
  yield configuration
end

.deserialize_iso8601_date(date) ⇒ Object 



30
31
32
 
# File 'lib/twilio-ruby/framework/serialize.rb', line 30

def self.deserialize_iso8601_date(date)
  Date.parse(date) unless date.nil?
end

.deserialize_iso8601_datetime(date) ⇒ Object 



34
35
36
 
# File 'lib/twilio-ruby/framework/serialize.rb', line 34

def self.deserialize_iso8601_datetime(date)
  Time.parse(date) unless date.nil?
end

.deserialize_rfc2822(date) ⇒ Object 



26
27
28
 
# File 'lib/twilio-ruby/framework/serialize.rb', line 26

def self.deserialize_rfc2822(date)
  Time.rfc2822(date) unless date.nil?
end

.flatten(map, result = {}, previous = []) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/twilio-ruby/framework/serialize.rb', line 46

def self.flatten(map, result = {}, previous = [])
  map.each do |key, value|
    if value.is_a? Hash
      self.flatten(value, result, previous + [key])
    else
      result[(previous + [key]).join('.')] = value
    end
  end

  result
end

.prefixed_collapsible_map(map, prefix) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/twilio-ruby/framework/serialize.rb', line 58

def self.prefixed_collapsible_map(map, prefix)
  result = {}
  if map.is_a? Hash
    flattened = self.flatten(map)
    result = {}
    flattened.each do |key, value|
      result[prefix + '.' + key] = value
    end
  end

  result
end

.serialize_iso8601_date(date) ⇒ Object 



2
3
4
5
6
7
8
9
10
11
12
 
# File 'lib/twilio-ruby/framework/serialize.rb', line 2

def self.serialize_iso8601_date(date)
  if date.eql?(:unset)
    date
  elsif date.is_a?(Date)
    date.iso8601
  elsif date.is_a?(Time)
    date.strftime('%Y-%m-%d')
  elsif date.is_a?(String)
    date
  end
end

.serialize_iso8601_datetime(date) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/framework/serialize.rb', line 14

def self.serialize_iso8601_datetime(date)
  if date.eql?(:unset)
    date
  elsif date.is_a?(Date)
    Time.new(date.year, date.month, date.day).utc.iso8601
  elsif date.is_a?(Time)
    date.utc.iso8601
  elsif date.is_a?(String)
    date
  end
end

.serialize_object(object) ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/twilio-ruby/framework/serialize.rb', line 38

def self.serialize_object(object)
  if object.is_a?(Hash) || object.is_a?(Array)
    JSON.generate(object)
  else
    object
  end
end