twilio-ruby 5.0.0 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGES.md +30 -2
- data/CONTRIBUTING.md +159 -0
- data/ISSUE_TEMPLATE.md +26 -0
- data/LICENSE.md +1 -1
- data/README.md +6 -7
- data/VERSIONS.md +21 -49
- data/lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/address.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/application.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +11 -18
- data/lib/twilio-ruby/rest/api/v2010/account/call.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/conference.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb +358 -0
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb +439 -0
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb +48 -11
- data/lib/twilio-ruby/rest/api/v2010/account/key.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/message.rb +22 -12
- data/lib/twilio-ruby/rest/api/v2010/account/notification.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/queue.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/recording.rb +11 -18
- data/lib/twilio-ruby/rest/api/v2010/account/short_code.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/signing_key.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/transcription.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb +11 -11
- data/lib/twilio-ruby/rest/api/v2010/account.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v1/credential.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v1/service/channel.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v1/service/role.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v1/service/user.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v1/service.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v2/credential.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v2/service/role.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v2/service/user.rb +11 -11
- data/lib/twilio-ruby/rest/chat/v2/service.rb +11 -11
- data/lib/twilio-ruby/rest/client.rb +42 -0
- data/lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb +334 -0
- data/lib/twilio-ruby/rest/fax/v1/fax.rb +549 -0
- data/lib/twilio-ruby/rest/fax/v1.rb +41 -0
- data/lib/twilio-ruby/rest/fax.rb +44 -0
- data/lib/twilio-ruby/rest/ip_messaging/v1/credential.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v2/credential.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +11 -11
- data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +11 -11
- data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +360 -0
- data/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb +367 -0
- data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +367 -0
- data/lib/twilio-ruby/rest/messaging/v1/service.rb +645 -0
- data/lib/twilio-ruby/rest/messaging/v1.rb +41 -0
- data/lib/twilio-ruby/rest/messaging.rb +44 -0
- data/lib/twilio-ruby/rest/monitor/v1/alert.rb +11 -11
- data/lib/twilio-ruby/rest/monitor/v1/event.rb +11 -11
- data/lib/twilio-ruby/rest/notify/v1/credential.rb +411 -0
- data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +438 -0
- data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +294 -0
- data/lib/twilio-ruby/rest/notify/v1/service/segment.rb +230 -0
- data/lib/twilio-ruby/rest/notify/v1/service/user/segment_memberships.rb +262 -0
- data/lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb +442 -0
- data/lib/twilio-ruby/rest/notify/v1/service/user.rb +453 -0
- data/lib/twilio-ruby/rest/notify/v1/service.rb +647 -0
- data/lib/twilio-ruby/rest/notify/v1.rb +56 -0
- data/lib/twilio-ruby/rest/notify.rb +52 -0
- data/lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb +216 -0
- data/lib/twilio-ruby/rest/preview/bulk_exports/export.rb +211 -0
- data/lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb +251 -0
- data/lib/twilio-ruby/rest/preview/bulk_exports.rb +56 -0
- data/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb +570 -0
- data/lib/twilio-ruby/rest/preview/hosted_numbers.rb +42 -0
- data/lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb +309 -0
- data/lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb +341 -0
- data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb +349 -0
- data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb +448 -0
- data/lib/twilio-ruby/rest/preview/marketplace.rb +58 -0
- data/lib/twilio-ruby/rest/preview/proxy/service/phone_number.rb +367 -0
- data/lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb +437 -0
- data/lib/twilio-ruby/rest/preview/proxy/service/session/participant/message_interaction.rb +460 -0
- data/lib/twilio-ruby/rest/preview/proxy/service/session/participant.rb +514 -0
- data/lib/twilio-ruby/rest/preview/proxy/service/session.rb +544 -0
- data/lib/twilio-ruby/rest/preview/proxy/service/short_code.rb +367 -0
- data/lib/twilio-ruby/rest/preview/proxy/service.rb +508 -0
- data/lib/twilio-ruby/rest/preview/proxy.rb +41 -0
- data/lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb +403 -0
- data/lib/twilio-ruby/rest/preview/sync/service/document.rb +453 -0
- data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb +438 -0
- data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_permission.rb +403 -0
- data/lib/twilio-ruby/rest/preview/sync/service/sync_list.rb +446 -0
- data/lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb +440 -0
- data/lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb +403 -0
- data/lib/twilio-ruby/rest/preview/sync/service/sync_map.rb +446 -0
- data/lib/twilio-ruby/rest/preview/sync/service.rb +512 -0
- data/lib/twilio-ruby/rest/preview/sync.rb +41 -0
- data/lib/twilio-ruby/rest/preview/wireless/command.rb +390 -0
- data/lib/twilio-ruby/rest/preview/wireless/rate_plan.rb +443 -0
- data/lib/twilio-ruby/rest/preview/wireless/sim/usage.rb +244 -0
- data/lib/twilio-ruby/rest/preview/wireless/sim.rb +552 -0
- data/lib/twilio-ruby/rest/preview/wireless.rb +71 -0
- data/lib/twilio-ruby/rest/preview.rb +145 -0
- data/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb +11 -11
- data/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb +11 -11
- data/lib/twilio-ruby/rest/pricing/v1/voice/country.rb +11 -11
- data/lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb +403 -0
- data/lib/twilio-ruby/rest/sync/v1/service/document.rb +453 -0
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +438 -0
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb +403 -0
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +446 -0
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +440 -0
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb +403 -0
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +446 -0
- data/lib/twilio-ruby/rest/sync/v1/service.rb +512 -0
- data/lib/twilio-ruby/rest/sync/v1.rb +41 -0
- data/lib/twilio-ruby/rest/sync.rb +44 -0
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb +11 -11
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb +11 -11
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb +143 -13
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb +11 -11
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb +11 -11
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb +11 -11
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb +11 -11
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb +143 -13
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb +11 -11
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +11 -11
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb +11 -11
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb +11 -11
- data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +11 -11
- data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +11 -11
- data/lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb +11 -11
- data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +11 -11
- data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +11 -11
- data/lib/twilio-ruby/rest/video/v1/recording.rb +11 -11
- data/lib/twilio-ruby/rest/video/v1/room/recording.rb +11 -11
- data/lib/twilio-ruby/rest/video/v1/room.rb +11 -11
- data/lib/twilio-ruby/rest/wireless/v1/command.rb +375 -0
- data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +460 -0
- data/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb +241 -0
- data/lib/twilio-ruby/rest/wireless/v1/sim.rb +556 -0
- data/lib/twilio-ruby/rest/wireless/v1.rb +71 -0
- data/lib/twilio-ruby/rest/wireless.rb +60 -0
- data/lib/twilio-ruby/version.rb +1 -1
- data/spec/integration/api/v2010/account/call/recording_spec.rb +0 -2
- data/spec/integration/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension_spec.rb +135 -0
- data/spec/integration/api/v2010/account/incoming_phone_number/assigned_add_on_spec.rb +223 -0
- data/spec/integration/api/v2010/account/recording_spec.rb +0 -2
- data/spec/integration/fax/v1/fax/fax_media_spec.rb +126 -0
- data/spec/integration/fax/v1/fax_spec.rb +272 -0
- data/spec/integration/messaging/v1/service/alpha_sender_spec.rb +170 -0
- data/spec/integration/messaging/v1/service/phone_number_spec.rb +201 -0
- data/spec/integration/messaging/v1/service/short_code_spec.rb +173 -0
- data/spec/integration/messaging/v1/service_spec.rb +263 -0
- data/spec/integration/notify/v1/credential_spec.rb +223 -0
- data/spec/integration/notify/v1/service/binding_spec.rb +227 -0
- data/spec/integration/notify/v1/service/notification_spec.rb +97 -0
- data/spec/integration/notify/v1/service/segment_spec.rb +84 -0
- data/spec/integration/notify/v1/service/user/segment_memberships_spec.rb +118 -0
- data/spec/integration/notify/v1/service/user/user_binding_spec.rb +269 -0
- data/spec/integration/notify/v1/service/user_spec.rb +213 -0
- data/spec/integration/notify/v1/service_spec.rb +280 -0
- data/spec/integration/preview/bulk_exports/export/day_spec.rb +56 -0
- data/spec/integration/preview/bulk_exports/export_configuration_spec.rb +79 -0
- data/spec/integration/preview/bulk_exports/export_spec.rb +43 -0
- data/spec/integration/preview/hosted_numbers/hosted_number_order_spec.rb +280 -0
- data/spec/integration/preview/marketplace/available_add_on/available_add_on_extension_spec.rb +121 -0
- data/spec/integration/preview/marketplace/available_add_on_spec.rb +142 -0
- data/spec/integration/preview/marketplace/installed_add_on/installed_add_on_extension_spec.rb +164 -0
- data/spec/integration/preview/marketplace/installed_add_on_spec.rb +252 -0
- data/spec/integration/preview/proxy/service/phone_number_spec.rb +173 -0
- data/spec/integration/preview/proxy/service/session/interaction_spec.rb +104 -0
- data/spec/integration/preview/proxy/service/session/participant/message_interaction_spec.rb +164 -0
- data/spec/integration/preview/proxy/service/session/participant_spec.rb +226 -0
- data/spec/integration/preview/proxy/service/session_spec.rb +216 -0
- data/spec/integration/preview/proxy/service/short_code_spec.rb +173 -0
- data/spec/integration/preview/proxy/service_spec.rb +200 -0
- data/spec/integration/preview/sync/service/document/document_permission_spec.rb +206 -0
- data/spec/integration/preview/sync/service/document_spec.rb +254 -0
- data/spec/integration/preview/sync/service/sync_list/sync_list_item_spec.rb +256 -0
- data/spec/integration/preview/sync/service/sync_list/sync_list_permission_spec.rb +206 -0
- data/spec/integration/preview/sync/service/sync_list_spec.rb +207 -0
- data/spec/integration/preview/sync/service/sync_map/sync_map_item_spec.rb +257 -0
- data/spec/integration/preview/sync/service/sync_map/sync_map_permission_spec.rb +206 -0
- data/spec/integration/preview/sync/service/sync_map_spec.rb +207 -0
- data/spec/integration/preview/sync/service_spec.rb +244 -0
- data/spec/integration/preview/wireless/command_spec.rb +169 -0
- data/spec/integration/preview/wireless/rate_plan_spec.rb +260 -0
- data/spec/integration/preview/wireless/sim/usage_spec.rb +49 -0
- data/spec/integration/preview/wireless/sim_spec.rb +208 -0
- data/spec/integration/sync/v1/service/document/document_permission_spec.rb +206 -0
- data/spec/integration/sync/v1/service/document_spec.rb +254 -0
- data/spec/integration/sync/v1/service/sync_list/sync_list_item_spec.rb +256 -0
- data/spec/integration/sync/v1/service/sync_list/sync_list_permission_spec.rb +206 -0
- data/spec/integration/sync/v1/service/sync_list_spec.rb +207 -0
- data/spec/integration/sync/v1/service/sync_map/sync_map_item_spec.rb +257 -0
- data/spec/integration/sync/v1/service/sync_map/sync_map_permission_spec.rb +206 -0
- data/spec/integration/sync/v1/service/sync_map_spec.rb +207 -0
- data/spec/integration/sync/v1/service_spec.rb +244 -0
- data/spec/integration/taskrouter/v1/workspace/task/reservation_spec.rb +5 -5
- data/spec/integration/taskrouter/v1/workspace/worker/reservation_spec.rb +5 -5
- data/spec/integration/wireless/v1/command_spec.rb +166 -0
- data/spec/integration/wireless/v1/rate_plan_spec.rb +268 -0
- data/spec/integration/wireless/v1/sim/usage_record_spec.rb +65 -0
- data/spec/integration/wireless/v1/sim_spec.rb +208 -0
- data/twilio-ruby.gemspec +1 -3
- metadata +192 -2
|
@@ -62,11 +62,11 @@ module Twilio
|
|
|
62
62
|
# memory before returning.
|
|
63
63
|
# @param [message.OrderType] order The order
|
|
64
64
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
65
|
-
#
|
|
66
|
-
# @param [Integer] page_size Number of records to fetch per request, when
|
|
67
|
-
#
|
|
68
|
-
#
|
|
69
|
-
#
|
|
65
|
+
# guarantees to never return more than limit. Default is no limit
|
|
66
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
67
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
68
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
69
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
70
70
|
# @return [Array] Array of up to limit results
|
|
71
71
|
def list(order: :unset, limit: nil, page_size: nil)
|
|
72
72
|
self.stream(
|
|
@@ -81,12 +81,12 @@ module Twilio
|
|
|
81
81
|
# This operation lazily loads records as efficiently as possible until the limit
|
|
82
82
|
# is reached.
|
|
83
83
|
# @param [message.OrderType] order The order
|
|
84
|
-
# @param [Integer] limit Upper limit for the number of records to return.
|
|
85
|
-
#
|
|
86
|
-
# @param [Integer] page_size Number of records to fetch per request, when
|
|
87
|
-
#
|
|
88
|
-
#
|
|
89
|
-
#
|
|
84
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
85
|
+
# guarantees to never return more than limit. Default is no limit.
|
|
86
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
87
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
88
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
89
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
90
90
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
|
91
91
|
def stream(order: :unset, limit: nil, page_size: nil)
|
|
92
92
|
limits = @version.read_limits(limit, page_size)
|
|
@@ -60,11 +60,11 @@ module Twilio
|
|
|
60
60
|
# memory before returning.
|
|
61
61
|
# @param [channel.ChannelType] type The type
|
|
62
62
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
63
|
-
#
|
|
64
|
-
# @param [Integer] page_size Number of records to fetch per request, when
|
|
65
|
-
#
|
|
66
|
-
#
|
|
67
|
-
#
|
|
63
|
+
# guarantees to never return more than limit. Default is no limit
|
|
64
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
65
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
66
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
67
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
68
68
|
# @return [Array] Array of up to limit results
|
|
69
69
|
def list(type: :unset, limit: nil, page_size: nil)
|
|
70
70
|
self.stream(
|
|
@@ -79,12 +79,12 @@ module Twilio
|
|
|
79
79
|
# This operation lazily loads records as efficiently as possible until the limit
|
|
80
80
|
# is reached.
|
|
81
81
|
# @param [channel.ChannelType] type The type
|
|
82
|
-
# @param [Integer] limit Upper limit for the number of records to return.
|
|
83
|
-
#
|
|
84
|
-
# @param [Integer] page_size Number of records to fetch per request, when
|
|
85
|
-
#
|
|
86
|
-
#
|
|
87
|
-
#
|
|
82
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
83
|
+
# guarantees to never return more than limit. Default is no limit.
|
|
84
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
85
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
86
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
87
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
88
88
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
|
89
89
|
def stream(type: :unset, limit: nil, page_size: nil)
|
|
90
90
|
limits = @version.read_limits(limit, page_size)
|
|
@@ -57,11 +57,11 @@ module Twilio
|
|
|
57
57
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
|
58
58
|
# memory before returning.
|
|
59
59
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
60
|
-
#
|
|
61
|
-
# @param [Integer] page_size Number of records to fetch per request, when
|
|
62
|
-
#
|
|
63
|
-
#
|
|
64
|
-
#
|
|
60
|
+
# guarantees to never return more than limit. Default is no limit
|
|
61
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
62
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
63
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
64
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
65
65
|
# @return [Array] Array of up to limit results
|
|
66
66
|
def list(limit: nil, page_size: nil)
|
|
67
67
|
self.stream(
|
|
@@ -74,12 +74,12 @@ module Twilio
|
|
|
74
74
|
# Streams RoleInstance records from the API as an Enumerable.
|
|
75
75
|
# This operation lazily loads records as efficiently as possible until the limit
|
|
76
76
|
# is reached.
|
|
77
|
-
# @param [Integer] limit Upper limit for the number of records to return.
|
|
78
|
-
#
|
|
79
|
-
# @param [Integer] page_size Number of records to fetch per request, when
|
|
80
|
-
#
|
|
81
|
-
#
|
|
82
|
-
#
|
|
77
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
78
|
+
# guarantees to never return more than limit. Default is no limit.
|
|
79
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
80
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
81
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
82
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
83
83
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
|
84
84
|
def stream(limit: nil, page_size: nil)
|
|
85
85
|
limits = @version.read_limits(limit, page_size)
|
|
@@ -33,11 +33,11 @@ module Twilio
|
|
|
33
33
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
|
34
34
|
# memory before returning.
|
|
35
35
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
36
|
-
#
|
|
37
|
-
# @param [Integer] page_size Number of records to fetch per request, when
|
|
38
|
-
#
|
|
39
|
-
#
|
|
40
|
-
#
|
|
36
|
+
# guarantees to never return more than limit. Default is no limit
|
|
37
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
38
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
39
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
40
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
41
41
|
# @return [Array] Array of up to limit results
|
|
42
42
|
def list(limit: nil, page_size: nil)
|
|
43
43
|
self.stream(
|
|
@@ -50,12 +50,12 @@ module Twilio
|
|
|
50
50
|
# Streams UserChannelInstance records from the API as an Enumerable.
|
|
51
51
|
# This operation lazily loads records as efficiently as possible until the limit
|
|
52
52
|
# is reached.
|
|
53
|
-
# @param [Integer] limit Upper limit for the number of records to return.
|
|
54
|
-
#
|
|
55
|
-
# @param [Integer] page_size Number of records to fetch per request, when
|
|
56
|
-
#
|
|
57
|
-
#
|
|
58
|
-
#
|
|
53
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
54
|
+
# guarantees to never return more than limit. Default is no limit.
|
|
55
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
56
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
57
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
58
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
59
59
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
|
60
60
|
def stream(limit: nil, page_size: nil)
|
|
61
61
|
limits = @version.read_limits(limit, page_size)
|
|
@@ -59,11 +59,11 @@ module Twilio
|
|
|
59
59
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
|
60
60
|
# memory before returning.
|
|
61
61
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
62
|
-
#
|
|
63
|
-
# @param [Integer] page_size Number of records to fetch per request, when
|
|
64
|
-
#
|
|
65
|
-
#
|
|
66
|
-
#
|
|
62
|
+
# guarantees to never return more than limit. Default is no limit
|
|
63
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
64
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
65
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
66
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
67
67
|
# @return [Array] Array of up to limit results
|
|
68
68
|
def list(limit: nil, page_size: nil)
|
|
69
69
|
self.stream(
|
|
@@ -76,12 +76,12 @@ module Twilio
|
|
|
76
76
|
# Streams UserInstance records from the API as an Enumerable.
|
|
77
77
|
# This operation lazily loads records as efficiently as possible until the limit
|
|
78
78
|
# is reached.
|
|
79
|
-
# @param [Integer] limit Upper limit for the number of records to return.
|
|
80
|
-
#
|
|
81
|
-
# @param [Integer] page_size Number of records to fetch per request, when
|
|
82
|
-
#
|
|
83
|
-
#
|
|
84
|
-
#
|
|
79
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
80
|
+
# guarantees to never return more than limit. Default is no limit.
|
|
81
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
82
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
83
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
84
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
85
85
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
|
86
86
|
def stream(limit: nil, page_size: nil)
|
|
87
87
|
limits = @version.read_limits(limit, page_size)
|
|
@@ -48,11 +48,11 @@ module Twilio
|
|
|
48
48
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
|
49
49
|
# memory before returning.
|
|
50
50
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
51
|
-
#
|
|
52
|
-
# @param [Integer] page_size Number of records to fetch per request, when
|
|
53
|
-
#
|
|
54
|
-
#
|
|
55
|
-
#
|
|
51
|
+
# guarantees to never return more than limit. Default is no limit
|
|
52
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
53
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
54
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
55
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
56
56
|
# @return [Array] Array of up to limit results
|
|
57
57
|
def list(limit: nil, page_size: nil)
|
|
58
58
|
self.stream(
|
|
@@ -65,12 +65,12 @@ module Twilio
|
|
|
65
65
|
# Streams ServiceInstance records from the API as an Enumerable.
|
|
66
66
|
# This operation lazily loads records as efficiently as possible until the limit
|
|
67
67
|
# is reached.
|
|
68
|
-
# @param [Integer] limit Upper limit for the number of records to return.
|
|
69
|
-
#
|
|
70
|
-
# @param [Integer] page_size Number of records to fetch per request, when
|
|
71
|
-
#
|
|
72
|
-
#
|
|
73
|
-
#
|
|
68
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
69
|
+
# guarantees to never return more than limit. Default is no limit.
|
|
70
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
71
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
72
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
73
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
74
74
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
|
75
75
|
def stream(limit: nil, page_size: nil)
|
|
76
76
|
limits = @version.read_limits(limit, page_size)
|
|
@@ -26,13 +26,19 @@ module Twilio
|
|
|
26
26
|
@accounts = nil
|
|
27
27
|
@api = nil
|
|
28
28
|
@chat = nil
|
|
29
|
+
@fax = nil
|
|
29
30
|
@ip_messaging = nil
|
|
30
31
|
@lookups = nil
|
|
31
32
|
@monitor = nil
|
|
33
|
+
@notify = nil
|
|
34
|
+
@preview = nil
|
|
32
35
|
@pricing = nil
|
|
33
36
|
@taskrouter = nil
|
|
34
37
|
@trunking = nil
|
|
35
38
|
@video = nil
|
|
39
|
+
@messaging = nil
|
|
40
|
+
@wireless = nil
|
|
41
|
+
@sync = nil
|
|
36
42
|
end
|
|
37
43
|
|
|
38
44
|
##
|
|
@@ -92,6 +98,12 @@ module Twilio
|
|
|
92
98
|
@chat ||= Chat.new self
|
|
93
99
|
end
|
|
94
100
|
|
|
101
|
+
##
|
|
102
|
+
# Access the Fax Twilio Domain
|
|
103
|
+
def fax
|
|
104
|
+
@fax ||= Fax.new self
|
|
105
|
+
end
|
|
106
|
+
|
|
95
107
|
##
|
|
96
108
|
# Access the IpMessaging Twilio Domain
|
|
97
109
|
def ip_messaging
|
|
@@ -110,6 +122,18 @@ module Twilio
|
|
|
110
122
|
@monitor ||= Monitor.new self
|
|
111
123
|
end
|
|
112
124
|
|
|
125
|
+
##
|
|
126
|
+
# Access the Notify Twilio Domain
|
|
127
|
+
def notify
|
|
128
|
+
@notify ||= Notify.new self
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
##
|
|
132
|
+
# Access the Preview Twilio Domain
|
|
133
|
+
def preview
|
|
134
|
+
@preview ||= Preview.new self
|
|
135
|
+
end
|
|
136
|
+
|
|
113
137
|
##
|
|
114
138
|
# Access the Pricing Twilio Domain
|
|
115
139
|
def pricing
|
|
@@ -134,6 +158,24 @@ module Twilio
|
|
|
134
158
|
@video ||= Video.new self
|
|
135
159
|
end
|
|
136
160
|
|
|
161
|
+
##
|
|
162
|
+
# Access the Messaging Twilio Domain
|
|
163
|
+
def messaging
|
|
164
|
+
@messaging ||= Messaging.new self
|
|
165
|
+
end
|
|
166
|
+
|
|
167
|
+
##
|
|
168
|
+
# Access the Wireless Twilio Domain
|
|
169
|
+
def wireless
|
|
170
|
+
@wireless ||= Wireless.new self
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
##
|
|
174
|
+
# Access the Sync Twilio Domain
|
|
175
|
+
def sync
|
|
176
|
+
@sync ||= Sync.new self
|
|
177
|
+
end
|
|
178
|
+
|
|
137
179
|
##
|
|
138
180
|
# @param [String] sid The sid
|
|
139
181
|
# @return [Twilio::REST::Api::V2010::AccountContext::AddressInstance] if sid was passed.
|
|
@@ -0,0 +1,334 @@
|
|
|
1
|
+
##
|
|
2
|
+
# This code was generated by
|
|
3
|
+
# \ / _ _ _| _ _
|
|
4
|
+
# | (_)\/(_)(_|\/| |(/_ v1.0.0
|
|
5
|
+
# / /
|
|
6
|
+
|
|
7
|
+
module Twilio
|
|
8
|
+
module REST
|
|
9
|
+
class Fax < Domain
|
|
10
|
+
class V1 < Version
|
|
11
|
+
class FaxContext < InstanceContext
|
|
12
|
+
##
|
|
13
|
+
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
|
14
|
+
class FaxMediaList < ListResource
|
|
15
|
+
##
|
|
16
|
+
# Initialize the FaxMediaList
|
|
17
|
+
# @param [Version] version Version that contains the resource
|
|
18
|
+
# @param [String] fax_sid The unique SID identifier of the fax for which this
|
|
19
|
+
# media is associated.
|
|
20
|
+
# @return [FaxMediaList] FaxMediaList
|
|
21
|
+
def initialize(version, fax_sid: nil)
|
|
22
|
+
super(version)
|
|
23
|
+
|
|
24
|
+
# Path Solution
|
|
25
|
+
@solution = {
|
|
26
|
+
fax_sid: fax_sid
|
|
27
|
+
}
|
|
28
|
+
@uri = "/Faxes/#{@solution[:fax_sid]}/Media"
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
##
|
|
32
|
+
# Lists FaxMediaInstance records from the API as a list.
|
|
33
|
+
# Unlike stream(), this operation is eager and will load `limit` records into
|
|
34
|
+
# memory before returning.
|
|
35
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
36
|
+
# guarantees to never return more than limit. Default is no limit
|
|
37
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
38
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
39
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
40
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
41
|
+
# @return [Array] Array of up to limit results
|
|
42
|
+
def list(limit: nil, page_size: nil)
|
|
43
|
+
self.stream(
|
|
44
|
+
limit: limit,
|
|
45
|
+
page_size: page_size
|
|
46
|
+
).entries
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
##
|
|
50
|
+
# Streams FaxMediaInstance records from the API as an Enumerable.
|
|
51
|
+
# This operation lazily loads records as efficiently as possible until the limit
|
|
52
|
+
# is reached.
|
|
53
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
54
|
+
# guarantees to never return more than limit. Default is no limit.
|
|
55
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
56
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
57
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
58
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
59
|
+
# @return [Enumerable] Enumerable that will yield up to limit results
|
|
60
|
+
def stream(limit: nil, page_size: nil)
|
|
61
|
+
limits = @version.read_limits(limit, page_size)
|
|
62
|
+
|
|
63
|
+
page = self.page(
|
|
64
|
+
page_size: limits[:page_size],
|
|
65
|
+
)
|
|
66
|
+
|
|
67
|
+
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
##
|
|
71
|
+
# When passed a block, yields FaxMediaInstance records from the API.
|
|
72
|
+
# This operation lazily loads records as efficiently as possible until the limit
|
|
73
|
+
# is reached.
|
|
74
|
+
def each
|
|
75
|
+
limits = @version.read_limits
|
|
76
|
+
|
|
77
|
+
page = self.page(
|
|
78
|
+
page_size: limits[:page_size],
|
|
79
|
+
)
|
|
80
|
+
|
|
81
|
+
@version.stream(page,
|
|
82
|
+
limit: limits[:limit],
|
|
83
|
+
page_limit: limits[:page_limit]).each {|x| yield x}
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
##
|
|
87
|
+
# Retrieve a single page of FaxMediaInstance records from the API.
|
|
88
|
+
# Request is executed immediately.
|
|
89
|
+
# @param [String] page_token PageToken provided by the API
|
|
90
|
+
# @param [Integer] page_number Page Number, this value is simply for client state
|
|
91
|
+
# @param [Integer] page_size Number of records to return, defaults to 50
|
|
92
|
+
# @return [Page] Page of FaxMediaInstance
|
|
93
|
+
def page(page_token: :unset, page_number: :unset, page_size: :unset)
|
|
94
|
+
params = Twilio::Values.of({
|
|
95
|
+
'PageToken' => page_token,
|
|
96
|
+
'Page' => page_number,
|
|
97
|
+
'PageSize' => page_size,
|
|
98
|
+
})
|
|
99
|
+
response = @version.page(
|
|
100
|
+
'GET',
|
|
101
|
+
@uri,
|
|
102
|
+
params
|
|
103
|
+
)
|
|
104
|
+
FaxMediaPage.new(@version, response, @solution)
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
##
|
|
108
|
+
# Retrieve a single page of FaxMediaInstance records from the API.
|
|
109
|
+
# Request is executed immediately.
|
|
110
|
+
# @param [String] target_url API-generated URL for the requested results page
|
|
111
|
+
# @return [Page] Page of FaxMediaInstance
|
|
112
|
+
def get_page(target_url)
|
|
113
|
+
response = @version.domain.request(
|
|
114
|
+
'GET',
|
|
115
|
+
target_url
|
|
116
|
+
)
|
|
117
|
+
FaxMediaPage.new(@version, response, @solution)
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
##
|
|
121
|
+
# Provide a user friendly representation
|
|
122
|
+
def to_s
|
|
123
|
+
'#<Twilio.Fax.V1.FaxMediaList>'
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
##
|
|
128
|
+
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
|
129
|
+
class FaxMediaPage < Page
|
|
130
|
+
##
|
|
131
|
+
# Initialize the FaxMediaPage
|
|
132
|
+
# @param [Version] version Version that contains the resource
|
|
133
|
+
# @param [Response] response Response from the API
|
|
134
|
+
# @param [Hash] solution Path solution for the resource
|
|
135
|
+
# @return [FaxMediaPage] FaxMediaPage
|
|
136
|
+
def initialize(version, response, solution)
|
|
137
|
+
super(version, response)
|
|
138
|
+
|
|
139
|
+
# Path Solution
|
|
140
|
+
@solution = solution
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
##
|
|
144
|
+
# Build an instance of FaxMediaInstance
|
|
145
|
+
# @param [Hash] payload Payload response from the API
|
|
146
|
+
# @return [FaxMediaInstance] FaxMediaInstance
|
|
147
|
+
def get_instance(payload)
|
|
148
|
+
FaxMediaInstance.new(
|
|
149
|
+
@version,
|
|
150
|
+
payload,
|
|
151
|
+
fax_sid: @solution[:fax_sid],
|
|
152
|
+
)
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
##
|
|
156
|
+
# Provide a user friendly representation
|
|
157
|
+
def to_s
|
|
158
|
+
'<Twilio.Fax.V1.FaxMediaPage>'
|
|
159
|
+
end
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
##
|
|
163
|
+
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
|
164
|
+
class FaxMediaContext < InstanceContext
|
|
165
|
+
##
|
|
166
|
+
# Initialize the FaxMediaContext
|
|
167
|
+
# @param [Version] version Version that contains the resource
|
|
168
|
+
# @param [String] fax_sid The unique SID identifier of the fax.
|
|
169
|
+
# @param [String] sid A 34 character string that uniquely identifies this fax
|
|
170
|
+
# media.
|
|
171
|
+
# @return [FaxMediaContext] FaxMediaContext
|
|
172
|
+
def initialize(version, fax_sid, sid)
|
|
173
|
+
super(version)
|
|
174
|
+
|
|
175
|
+
# Path Solution
|
|
176
|
+
@solution = {
|
|
177
|
+
fax_sid: fax_sid,
|
|
178
|
+
sid: sid,
|
|
179
|
+
}
|
|
180
|
+
@uri = "/Faxes/#{@solution[:fax_sid]}/Media/#{@solution[:sid]}"
|
|
181
|
+
end
|
|
182
|
+
|
|
183
|
+
##
|
|
184
|
+
# Fetch a FaxMediaInstance
|
|
185
|
+
# @return [FaxMediaInstance] Fetched FaxMediaInstance
|
|
186
|
+
def fetch
|
|
187
|
+
params = Twilio::Values.of({})
|
|
188
|
+
|
|
189
|
+
payload = @version.fetch(
|
|
190
|
+
'GET',
|
|
191
|
+
@uri,
|
|
192
|
+
params,
|
|
193
|
+
)
|
|
194
|
+
|
|
195
|
+
FaxMediaInstance.new(
|
|
196
|
+
@version,
|
|
197
|
+
payload,
|
|
198
|
+
fax_sid: @solution[:fax_sid],
|
|
199
|
+
sid: @solution[:sid],
|
|
200
|
+
)
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
##
|
|
204
|
+
# Deletes the FaxMediaInstance
|
|
205
|
+
# @return [Boolean] true if delete succeeds, true otherwise
|
|
206
|
+
def delete
|
|
207
|
+
@version.delete('delete', @uri)
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
##
|
|
211
|
+
# Provide a user friendly representation
|
|
212
|
+
def to_s
|
|
213
|
+
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
|
|
214
|
+
"#<Twilio.Fax.V1.FaxMediaContext #{context}>"
|
|
215
|
+
end
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
##
|
|
219
|
+
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
|
220
|
+
class FaxMediaInstance < InstanceResource
|
|
221
|
+
##
|
|
222
|
+
# Initialize the FaxMediaInstance
|
|
223
|
+
# @param [Version] version Version that contains the resource
|
|
224
|
+
# @param [Hash] payload payload that contains response from Twilio
|
|
225
|
+
# @param [String] fax_sid The unique SID identifier of the fax for which this
|
|
226
|
+
# media is associated.
|
|
227
|
+
# @param [String] sid A 34 character string that uniquely identifies this fax
|
|
228
|
+
# media.
|
|
229
|
+
# @return [FaxMediaInstance] FaxMediaInstance
|
|
230
|
+
def initialize(version, payload, fax_sid: nil, sid: nil)
|
|
231
|
+
super(version)
|
|
232
|
+
|
|
233
|
+
# Marshaled Properties
|
|
234
|
+
@properties = {
|
|
235
|
+
'sid' => payload['sid'],
|
|
236
|
+
'account_sid' => payload['account_sid'],
|
|
237
|
+
'fax_sid' => payload['fax_sid'],
|
|
238
|
+
'content_type' => payload['content_type'],
|
|
239
|
+
'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
|
|
240
|
+
'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
|
|
241
|
+
'url' => payload['url'],
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
# Context
|
|
245
|
+
@instance_context = nil
|
|
246
|
+
@params = {
|
|
247
|
+
'fax_sid' => fax_sid,
|
|
248
|
+
'sid' => sid || @properties['sid'],
|
|
249
|
+
}
|
|
250
|
+
end
|
|
251
|
+
|
|
252
|
+
##
|
|
253
|
+
# Generate an instance context for the instance, the context is capable of
|
|
254
|
+
# performing various actions. All instance actions are proxied to the context
|
|
255
|
+
# @return [FaxMediaContext] FaxMediaContext for this FaxMediaInstance
|
|
256
|
+
def context
|
|
257
|
+
unless @instance_context
|
|
258
|
+
@instance_context = FaxMediaContext.new(
|
|
259
|
+
@version,
|
|
260
|
+
@params['fax_sid'],
|
|
261
|
+
@params['sid'],
|
|
262
|
+
)
|
|
263
|
+
end
|
|
264
|
+
@instance_context
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
##
|
|
268
|
+
# @return [String] A string that uniquely identifies this fax media
|
|
269
|
+
def sid
|
|
270
|
+
@properties['sid']
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
##
|
|
274
|
+
# @return [String] Account SID
|
|
275
|
+
def account_sid
|
|
276
|
+
@properties['account_sid']
|
|
277
|
+
end
|
|
278
|
+
|
|
279
|
+
##
|
|
280
|
+
# @return [String] Fax SID
|
|
281
|
+
def fax_sid
|
|
282
|
+
@properties['fax_sid']
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
##
|
|
286
|
+
# @return [String] Media content type
|
|
287
|
+
def content_type
|
|
288
|
+
@properties['content_type']
|
|
289
|
+
end
|
|
290
|
+
|
|
291
|
+
##
|
|
292
|
+
# @return [Time] The date this fax media was created
|
|
293
|
+
def date_created
|
|
294
|
+
@properties['date_created']
|
|
295
|
+
end
|
|
296
|
+
|
|
297
|
+
##
|
|
298
|
+
# @return [Time] The date this fax media was updated
|
|
299
|
+
def date_updated
|
|
300
|
+
@properties['date_updated']
|
|
301
|
+
end
|
|
302
|
+
|
|
303
|
+
##
|
|
304
|
+
# @return [String] The URL of this resource
|
|
305
|
+
def url
|
|
306
|
+
@properties['url']
|
|
307
|
+
end
|
|
308
|
+
|
|
309
|
+
##
|
|
310
|
+
# Fetch a FaxMediaInstance
|
|
311
|
+
# @return [FaxMediaInstance] Fetched FaxMediaInstance
|
|
312
|
+
def fetch
|
|
313
|
+
context.fetch
|
|
314
|
+
end
|
|
315
|
+
|
|
316
|
+
##
|
|
317
|
+
# Deletes the FaxMediaInstance
|
|
318
|
+
# @return [Boolean] true if delete succeeds, true otherwise
|
|
319
|
+
def delete
|
|
320
|
+
context.delete
|
|
321
|
+
end
|
|
322
|
+
|
|
323
|
+
##
|
|
324
|
+
# Provide a user friendly representation
|
|
325
|
+
def to_s
|
|
326
|
+
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
|
|
327
|
+
"<Twilio.Fax.V1.FaxMediaInstance #{values}>"
|
|
328
|
+
end
|
|
329
|
+
end
|
|
330
|
+
end
|
|
331
|
+
end
|
|
332
|
+
end
|
|
333
|
+
end
|
|
334
|
+
end
|