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
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
##
|
|
2
|
+
# This code was generated by
|
|
3
|
+
# \ / _ _ _| _ _
|
|
4
|
+
# | (_)\/(_)(_|\/| |(/_ v1.0.0
|
|
5
|
+
# / /
|
|
6
|
+
|
|
7
|
+
module Twilio
|
|
8
|
+
module REST
|
|
9
|
+
class Preview
|
|
10
|
+
class Proxy < Version
|
|
11
|
+
##
|
|
12
|
+
# Initialize the Proxy version of Preview
|
|
13
|
+
def initialize(domain)
|
|
14
|
+
super
|
|
15
|
+
@version = 'Proxy'
|
|
16
|
+
@services = nil
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
##
|
|
20
|
+
# @param [String] sid A 34 character string that uniquely identifies this Service.
|
|
21
|
+
# @return [Twilio::REST::Preview::Proxy::ServiceInstance] if sid was passed.
|
|
22
|
+
# @return [Twilio::REST::Preview::Proxy::ServiceList]
|
|
23
|
+
def services(sid=:unset)
|
|
24
|
+
if sid.nil?
|
|
25
|
+
raise ArgumentError, 'sid cannot be nil'
|
|
26
|
+
elsif sid == :unset
|
|
27
|
+
@services ||= ServiceList.new self
|
|
28
|
+
else
|
|
29
|
+
ServiceContext.new(self, sid)
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
##
|
|
34
|
+
# Provide a user friendly representation
|
|
35
|
+
def to_s
|
|
36
|
+
'<Twilio::REST::Preview::Proxy>'
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
end
|
|
@@ -0,0 +1,403 @@
|
|
|
1
|
+
##
|
|
2
|
+
# This code was generated by
|
|
3
|
+
# \ / _ _ _| _ _
|
|
4
|
+
# | (_)\/(_)(_|\/| |(/_ v1.0.0
|
|
5
|
+
# / /
|
|
6
|
+
|
|
7
|
+
module Twilio
|
|
8
|
+
module REST
|
|
9
|
+
class Preview < Domain
|
|
10
|
+
class Sync < Version
|
|
11
|
+
class ServiceContext < InstanceContext
|
|
12
|
+
class DocumentContext < InstanceContext
|
|
13
|
+
##
|
|
14
|
+
# PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
15
|
+
class DocumentPermissionList < ListResource
|
|
16
|
+
##
|
|
17
|
+
# Initialize the DocumentPermissionList
|
|
18
|
+
# @param [Version] version Version that contains the resource
|
|
19
|
+
# @param [String] service_sid The unique SID identifier of the Sync Service
|
|
20
|
+
# Instance.
|
|
21
|
+
# @param [String] document_sid The unique SID identifier of the Sync Document to
|
|
22
|
+
# which the Permission applies.
|
|
23
|
+
# @return [DocumentPermissionList] DocumentPermissionList
|
|
24
|
+
def initialize(version, service_sid: nil, document_sid: nil)
|
|
25
|
+
super(version)
|
|
26
|
+
|
|
27
|
+
# Path Solution
|
|
28
|
+
@solution = {
|
|
29
|
+
service_sid: service_sid,
|
|
30
|
+
document_sid: document_sid
|
|
31
|
+
}
|
|
32
|
+
@uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:document_sid]}/Permissions"
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
##
|
|
36
|
+
# Lists DocumentPermissionInstance records from the API as a list.
|
|
37
|
+
# Unlike stream(), this operation is eager and will load `limit` records into
|
|
38
|
+
# memory before returning.
|
|
39
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
40
|
+
# guarantees to never return more than limit. Default is no limit
|
|
41
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
42
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
43
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
44
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
45
|
+
# @return [Array] Array of up to limit results
|
|
46
|
+
def list(limit: nil, page_size: nil)
|
|
47
|
+
self.stream(
|
|
48
|
+
limit: limit,
|
|
49
|
+
page_size: page_size
|
|
50
|
+
).entries
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
##
|
|
54
|
+
# Streams DocumentPermissionInstance records from the API as an Enumerable.
|
|
55
|
+
# This operation lazily loads records as efficiently as possible until the limit
|
|
56
|
+
# is reached.
|
|
57
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
58
|
+
# guarantees to never return more than limit. Default is no limit.
|
|
59
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
|
60
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
|
61
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
|
62
|
+
# efficient page size, i.e. min(limit, 1000)
|
|
63
|
+
# @return [Enumerable] Enumerable that will yield up to limit results
|
|
64
|
+
def stream(limit: nil, page_size: nil)
|
|
65
|
+
limits = @version.read_limits(limit, page_size)
|
|
66
|
+
|
|
67
|
+
page = self.page(
|
|
68
|
+
page_size: limits[:page_size],
|
|
69
|
+
)
|
|
70
|
+
|
|
71
|
+
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
##
|
|
75
|
+
# When passed a block, yields DocumentPermissionInstance records from the API.
|
|
76
|
+
# This operation lazily loads records as efficiently as possible until the limit
|
|
77
|
+
# is reached.
|
|
78
|
+
def each
|
|
79
|
+
limits = @version.read_limits
|
|
80
|
+
|
|
81
|
+
page = self.page(
|
|
82
|
+
page_size: limits[:page_size],
|
|
83
|
+
)
|
|
84
|
+
|
|
85
|
+
@version.stream(page,
|
|
86
|
+
limit: limits[:limit],
|
|
87
|
+
page_limit: limits[:page_limit]).each {|x| yield x}
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
##
|
|
91
|
+
# Retrieve a single page of DocumentPermissionInstance records from the API.
|
|
92
|
+
# Request is executed immediately.
|
|
93
|
+
# @param [String] page_token PageToken provided by the API
|
|
94
|
+
# @param [Integer] page_number Page Number, this value is simply for client state
|
|
95
|
+
# @param [Integer] page_size Number of records to return, defaults to 50
|
|
96
|
+
# @return [Page] Page of DocumentPermissionInstance
|
|
97
|
+
def page(page_token: :unset, page_number: :unset, page_size: :unset)
|
|
98
|
+
params = Twilio::Values.of({
|
|
99
|
+
'PageToken' => page_token,
|
|
100
|
+
'Page' => page_number,
|
|
101
|
+
'PageSize' => page_size,
|
|
102
|
+
})
|
|
103
|
+
response = @version.page(
|
|
104
|
+
'GET',
|
|
105
|
+
@uri,
|
|
106
|
+
params
|
|
107
|
+
)
|
|
108
|
+
DocumentPermissionPage.new(@version, response, @solution)
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
##
|
|
112
|
+
# Retrieve a single page of DocumentPermissionInstance records from the API.
|
|
113
|
+
# Request is executed immediately.
|
|
114
|
+
# @param [String] target_url API-generated URL for the requested results page
|
|
115
|
+
# @return [Page] Page of DocumentPermissionInstance
|
|
116
|
+
def get_page(target_url)
|
|
117
|
+
response = @version.domain.request(
|
|
118
|
+
'GET',
|
|
119
|
+
target_url
|
|
120
|
+
)
|
|
121
|
+
DocumentPermissionPage.new(@version, response, @solution)
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
##
|
|
125
|
+
# Provide a user friendly representation
|
|
126
|
+
def to_s
|
|
127
|
+
'#<Twilio.Preview.Sync.DocumentPermissionList>'
|
|
128
|
+
end
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
##
|
|
132
|
+
# PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
133
|
+
class DocumentPermissionPage < Page
|
|
134
|
+
##
|
|
135
|
+
# Initialize the DocumentPermissionPage
|
|
136
|
+
# @param [Version] version Version that contains the resource
|
|
137
|
+
# @param [Response] response Response from the API
|
|
138
|
+
# @param [Hash] solution Path solution for the resource
|
|
139
|
+
# @return [DocumentPermissionPage] DocumentPermissionPage
|
|
140
|
+
def initialize(version, response, solution)
|
|
141
|
+
super(version, response)
|
|
142
|
+
|
|
143
|
+
# Path Solution
|
|
144
|
+
@solution = solution
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
##
|
|
148
|
+
# Build an instance of DocumentPermissionInstance
|
|
149
|
+
# @param [Hash] payload Payload response from the API
|
|
150
|
+
# @return [DocumentPermissionInstance] DocumentPermissionInstance
|
|
151
|
+
def get_instance(payload)
|
|
152
|
+
DocumentPermissionInstance.new(
|
|
153
|
+
@version,
|
|
154
|
+
payload,
|
|
155
|
+
service_sid: @solution[:service_sid],
|
|
156
|
+
document_sid: @solution[:document_sid],
|
|
157
|
+
)
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
##
|
|
161
|
+
# Provide a user friendly representation
|
|
162
|
+
def to_s
|
|
163
|
+
'<Twilio.Preview.Sync.DocumentPermissionPage>'
|
|
164
|
+
end
|
|
165
|
+
end
|
|
166
|
+
|
|
167
|
+
##
|
|
168
|
+
# PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
169
|
+
class DocumentPermissionContext < InstanceContext
|
|
170
|
+
##
|
|
171
|
+
# Initialize the DocumentPermissionContext
|
|
172
|
+
# @param [Version] version Version that contains the resource
|
|
173
|
+
# @param [String] service_sid The service_sid
|
|
174
|
+
# @param [String] document_sid Identifier of the Sync Document. Either a SID or a
|
|
175
|
+
# unique name.
|
|
176
|
+
# @param [String] identity Arbitrary string identifier representing a user
|
|
177
|
+
# associated with an FPA token, assigned by the developer.
|
|
178
|
+
# @return [DocumentPermissionContext] DocumentPermissionContext
|
|
179
|
+
def initialize(version, service_sid, document_sid, identity)
|
|
180
|
+
super(version)
|
|
181
|
+
|
|
182
|
+
# Path Solution
|
|
183
|
+
@solution = {
|
|
184
|
+
service_sid: service_sid,
|
|
185
|
+
document_sid: document_sid,
|
|
186
|
+
identity: identity,
|
|
187
|
+
}
|
|
188
|
+
@uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:document_sid]}/Permissions/#{@solution[:identity]}"
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
##
|
|
192
|
+
# Fetch a DocumentPermissionInstance
|
|
193
|
+
# @return [DocumentPermissionInstance] Fetched DocumentPermissionInstance
|
|
194
|
+
def fetch
|
|
195
|
+
params = Twilio::Values.of({})
|
|
196
|
+
|
|
197
|
+
payload = @version.fetch(
|
|
198
|
+
'GET',
|
|
199
|
+
@uri,
|
|
200
|
+
params,
|
|
201
|
+
)
|
|
202
|
+
|
|
203
|
+
DocumentPermissionInstance.new(
|
|
204
|
+
@version,
|
|
205
|
+
payload,
|
|
206
|
+
service_sid: @solution[:service_sid],
|
|
207
|
+
document_sid: @solution[:document_sid],
|
|
208
|
+
identity: @solution[:identity],
|
|
209
|
+
)
|
|
210
|
+
end
|
|
211
|
+
|
|
212
|
+
##
|
|
213
|
+
# Deletes the DocumentPermissionInstance
|
|
214
|
+
# @return [Boolean] true if delete succeeds, true otherwise
|
|
215
|
+
def delete
|
|
216
|
+
@version.delete('delete', @uri)
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
##
|
|
220
|
+
# Update the DocumentPermissionInstance
|
|
221
|
+
# @param [Boolean] read Boolean flag specifying whether the identity can read the
|
|
222
|
+
# Sync Document.
|
|
223
|
+
# @param [Boolean] write Boolean flag specifying whether the identity can update
|
|
224
|
+
# the Sync Document.
|
|
225
|
+
# @param [Boolean] manage Boolean flag specifying whether the identity can delete
|
|
226
|
+
# the Sync Document.
|
|
227
|
+
# @return [DocumentPermissionInstance] Updated DocumentPermissionInstance
|
|
228
|
+
def update(read: nil, write: nil, manage: nil)
|
|
229
|
+
data = Twilio::Values.of({
|
|
230
|
+
'Read' => read,
|
|
231
|
+
'Write' => write,
|
|
232
|
+
'Manage' => manage,
|
|
233
|
+
})
|
|
234
|
+
|
|
235
|
+
payload = @version.update(
|
|
236
|
+
'POST',
|
|
237
|
+
@uri,
|
|
238
|
+
data: data,
|
|
239
|
+
)
|
|
240
|
+
|
|
241
|
+
DocumentPermissionInstance.new(
|
|
242
|
+
@version,
|
|
243
|
+
payload,
|
|
244
|
+
service_sid: @solution[:service_sid],
|
|
245
|
+
document_sid: @solution[:document_sid],
|
|
246
|
+
identity: @solution[:identity],
|
|
247
|
+
)
|
|
248
|
+
end
|
|
249
|
+
|
|
250
|
+
##
|
|
251
|
+
# Provide a user friendly representation
|
|
252
|
+
def to_s
|
|
253
|
+
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
|
|
254
|
+
"#<Twilio.Preview.Sync.DocumentPermissionContext #{context}>"
|
|
255
|
+
end
|
|
256
|
+
end
|
|
257
|
+
|
|
258
|
+
##
|
|
259
|
+
# PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
260
|
+
class DocumentPermissionInstance < InstanceResource
|
|
261
|
+
##
|
|
262
|
+
# Initialize the DocumentPermissionInstance
|
|
263
|
+
# @param [Version] version Version that contains the resource
|
|
264
|
+
# @param [Hash] payload payload that contains response from Twilio
|
|
265
|
+
# @param [String] service_sid The unique SID identifier of the Sync Service
|
|
266
|
+
# Instance.
|
|
267
|
+
# @param [String] document_sid The unique SID identifier of the Sync Document to
|
|
268
|
+
# which the Permission applies.
|
|
269
|
+
# @param [String] identity Arbitrary string identifier representing a user
|
|
270
|
+
# associated with an FPA token, assigned by the developer.
|
|
271
|
+
# @return [DocumentPermissionInstance] DocumentPermissionInstance
|
|
272
|
+
def initialize(version, payload, service_sid: nil, document_sid: nil, identity: nil)
|
|
273
|
+
super(version)
|
|
274
|
+
|
|
275
|
+
# Marshaled Properties
|
|
276
|
+
@properties = {
|
|
277
|
+
'account_sid' => payload['account_sid'],
|
|
278
|
+
'service_sid' => payload['service_sid'],
|
|
279
|
+
'document_sid' => payload['document_sid'],
|
|
280
|
+
'identity' => payload['identity'],
|
|
281
|
+
'read' => payload['read'],
|
|
282
|
+
'write' => payload['write'],
|
|
283
|
+
'manage' => payload['manage'],
|
|
284
|
+
'url' => payload['url'],
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
# Context
|
|
288
|
+
@instance_context = nil
|
|
289
|
+
@params = {
|
|
290
|
+
'service_sid' => service_sid,
|
|
291
|
+
'document_sid' => document_sid,
|
|
292
|
+
'identity' => identity || @properties['identity'],
|
|
293
|
+
}
|
|
294
|
+
end
|
|
295
|
+
|
|
296
|
+
##
|
|
297
|
+
# Generate an instance context for the instance, the context is capable of
|
|
298
|
+
# performing various actions. All instance actions are proxied to the context
|
|
299
|
+
# @return [DocumentPermissionContext] DocumentPermissionContext for this DocumentPermissionInstance
|
|
300
|
+
def context
|
|
301
|
+
unless @instance_context
|
|
302
|
+
@instance_context = DocumentPermissionContext.new(
|
|
303
|
+
@version,
|
|
304
|
+
@params['service_sid'],
|
|
305
|
+
@params['document_sid'],
|
|
306
|
+
@params['identity'],
|
|
307
|
+
)
|
|
308
|
+
end
|
|
309
|
+
@instance_context
|
|
310
|
+
end
|
|
311
|
+
|
|
312
|
+
##
|
|
313
|
+
# @return [String] Twilio Account SID.
|
|
314
|
+
def account_sid
|
|
315
|
+
@properties['account_sid']
|
|
316
|
+
end
|
|
317
|
+
|
|
318
|
+
##
|
|
319
|
+
# @return [String] Sync Service Instance SID.
|
|
320
|
+
def service_sid
|
|
321
|
+
@properties['service_sid']
|
|
322
|
+
end
|
|
323
|
+
|
|
324
|
+
##
|
|
325
|
+
# @return [String] Sync Document SID.
|
|
326
|
+
def document_sid
|
|
327
|
+
@properties['document_sid']
|
|
328
|
+
end
|
|
329
|
+
|
|
330
|
+
##
|
|
331
|
+
# @return [String] Identity of the user to whom the Sync Document Permission applies.
|
|
332
|
+
def identity
|
|
333
|
+
@properties['identity']
|
|
334
|
+
end
|
|
335
|
+
|
|
336
|
+
##
|
|
337
|
+
# @return [Boolean] Read access.
|
|
338
|
+
def read
|
|
339
|
+
@properties['read']
|
|
340
|
+
end
|
|
341
|
+
|
|
342
|
+
##
|
|
343
|
+
# @return [Boolean] Write access.
|
|
344
|
+
def write
|
|
345
|
+
@properties['write']
|
|
346
|
+
end
|
|
347
|
+
|
|
348
|
+
##
|
|
349
|
+
# @return [Boolean] Manage access.
|
|
350
|
+
def manage
|
|
351
|
+
@properties['manage']
|
|
352
|
+
end
|
|
353
|
+
|
|
354
|
+
##
|
|
355
|
+
# @return [String] URL of this Sync Document Permission.
|
|
356
|
+
def url
|
|
357
|
+
@properties['url']
|
|
358
|
+
end
|
|
359
|
+
|
|
360
|
+
##
|
|
361
|
+
# Fetch a DocumentPermissionInstance
|
|
362
|
+
# @return [DocumentPermissionInstance] Fetched DocumentPermissionInstance
|
|
363
|
+
def fetch
|
|
364
|
+
context.fetch
|
|
365
|
+
end
|
|
366
|
+
|
|
367
|
+
##
|
|
368
|
+
# Deletes the DocumentPermissionInstance
|
|
369
|
+
# @return [Boolean] true if delete succeeds, true otherwise
|
|
370
|
+
def delete
|
|
371
|
+
context.delete
|
|
372
|
+
end
|
|
373
|
+
|
|
374
|
+
##
|
|
375
|
+
# Update the DocumentPermissionInstance
|
|
376
|
+
# @param [Boolean] read Boolean flag specifying whether the identity can read the
|
|
377
|
+
# Sync Document.
|
|
378
|
+
# @param [Boolean] write Boolean flag specifying whether the identity can update
|
|
379
|
+
# the Sync Document.
|
|
380
|
+
# @param [Boolean] manage Boolean flag specifying whether the identity can delete
|
|
381
|
+
# the Sync Document.
|
|
382
|
+
# @return [DocumentPermissionInstance] Updated DocumentPermissionInstance
|
|
383
|
+
def update(read: nil, write: nil, manage: nil)
|
|
384
|
+
context.update(
|
|
385
|
+
read: read,
|
|
386
|
+
write: write,
|
|
387
|
+
manage: manage,
|
|
388
|
+
)
|
|
389
|
+
end
|
|
390
|
+
|
|
391
|
+
##
|
|
392
|
+
# Provide a user friendly representation
|
|
393
|
+
def to_s
|
|
394
|
+
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
|
|
395
|
+
"<Twilio.Preview.Sync.DocumentPermissionInstance #{values}>"
|
|
396
|
+
end
|
|
397
|
+
end
|
|
398
|
+
end
|
|
399
|
+
end
|
|
400
|
+
end
|
|
401
|
+
end
|
|
402
|
+
end
|
|
403
|
+
end
|
|
@@ -0,0 +1,453 @@
|
|
|
1
|
+
##
|
|
2
|
+
# This code was generated by
|
|
3
|
+
# \ / _ _ _| _ _
|
|
4
|
+
# | (_)\/(_)(_|\/| |(/_ v1.0.0
|
|
5
|
+
# / /
|
|
6
|
+
|
|
7
|
+
module Twilio
|
|
8
|
+
module REST
|
|
9
|
+
class Preview < Domain
|
|
10
|
+
class Sync < Version
|
|
11
|
+
class ServiceContext < InstanceContext
|
|
12
|
+
##
|
|
13
|
+
# PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
14
|
+
class DocumentList < ListResource
|
|
15
|
+
##
|
|
16
|
+
# Initialize the DocumentList
|
|
17
|
+
# @param [Version] version Version that contains the resource
|
|
18
|
+
# @param [String] service_sid The service_sid
|
|
19
|
+
# @return [DocumentList] DocumentList
|
|
20
|
+
def initialize(version, service_sid: nil)
|
|
21
|
+
super(version)
|
|
22
|
+
|
|
23
|
+
# Path Solution
|
|
24
|
+
@solution = {
|
|
25
|
+
service_sid: service_sid
|
|
26
|
+
}
|
|
27
|
+
@uri = "/Services/#{@solution[:service_sid]}/Documents"
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
##
|
|
31
|
+
# Retrieve a single page of DocumentInstance records from the API.
|
|
32
|
+
# Request is executed immediately.
|
|
33
|
+
# @param [String] unique_name The unique_name
|
|
34
|
+
# @param [Hash] data The data
|
|
35
|
+
# @return [DocumentInstance] Newly created DocumentInstance
|
|
36
|
+
def create(unique_name: :unset, data: :unset)
|
|
37
|
+
data = Twilio::Values.of({
|
|
38
|
+
'UniqueName' => unique_name,
|
|
39
|
+
'Data' => Twilio.serialize_object(data),
|
|
40
|
+
})
|
|
41
|
+
|
|
42
|
+
payload = @version.create(
|
|
43
|
+
'POST',
|
|
44
|
+
@uri,
|
|
45
|
+
data: data
|
|
46
|
+
)
|
|
47
|
+
|
|
48
|
+
DocumentInstance.new(
|
|
49
|
+
@version,
|
|
50
|
+
payload,
|
|
51
|
+
service_sid: @solution[:service_sid],
|
|
52
|
+
)
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
##
|
|
56
|
+
# Lists DocumentInstance records from the API as a list.
|
|
57
|
+
# Unlike stream(), this operation is eager and will load `limit` records into
|
|
58
|
+
# memory before returning.
|
|
59
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
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
|
+
# @return [Array] Array of up to limit results
|
|
66
|
+
def list(limit: nil, page_size: nil)
|
|
67
|
+
self.stream(
|
|
68
|
+
limit: limit,
|
|
69
|
+
page_size: page_size
|
|
70
|
+
).entries
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
##
|
|
74
|
+
# Streams DocumentInstance records from the API as an Enumerable.
|
|
75
|
+
# This operation lazily loads records as efficiently as possible until the limit
|
|
76
|
+
# is reached.
|
|
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
|
+
# @return [Enumerable] Enumerable that will yield up to limit results
|
|
84
|
+
def stream(limit: nil, page_size: nil)
|
|
85
|
+
limits = @version.read_limits(limit, page_size)
|
|
86
|
+
|
|
87
|
+
page = self.page(
|
|
88
|
+
page_size: limits[:page_size],
|
|
89
|
+
)
|
|
90
|
+
|
|
91
|
+
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
##
|
|
95
|
+
# When passed a block, yields DocumentInstance records from the API.
|
|
96
|
+
# This operation lazily loads records as efficiently as possible until the limit
|
|
97
|
+
# is reached.
|
|
98
|
+
def each
|
|
99
|
+
limits = @version.read_limits
|
|
100
|
+
|
|
101
|
+
page = self.page(
|
|
102
|
+
page_size: limits[:page_size],
|
|
103
|
+
)
|
|
104
|
+
|
|
105
|
+
@version.stream(page,
|
|
106
|
+
limit: limits[:limit],
|
|
107
|
+
page_limit: limits[:page_limit]).each {|x| yield x}
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
##
|
|
111
|
+
# Retrieve a single page of DocumentInstance records from the API.
|
|
112
|
+
# Request is executed immediately.
|
|
113
|
+
# @param [String] page_token PageToken provided by the API
|
|
114
|
+
# @param [Integer] page_number Page Number, this value is simply for client state
|
|
115
|
+
# @param [Integer] page_size Number of records to return, defaults to 50
|
|
116
|
+
# @return [Page] Page of DocumentInstance
|
|
117
|
+
def page(page_token: :unset, page_number: :unset, page_size: :unset)
|
|
118
|
+
params = Twilio::Values.of({
|
|
119
|
+
'PageToken' => page_token,
|
|
120
|
+
'Page' => page_number,
|
|
121
|
+
'PageSize' => page_size,
|
|
122
|
+
})
|
|
123
|
+
response = @version.page(
|
|
124
|
+
'GET',
|
|
125
|
+
@uri,
|
|
126
|
+
params
|
|
127
|
+
)
|
|
128
|
+
DocumentPage.new(@version, response, @solution)
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
##
|
|
132
|
+
# Retrieve a single page of DocumentInstance records from the API.
|
|
133
|
+
# Request is executed immediately.
|
|
134
|
+
# @param [String] target_url API-generated URL for the requested results page
|
|
135
|
+
# @return [Page] Page of DocumentInstance
|
|
136
|
+
def get_page(target_url)
|
|
137
|
+
response = @version.domain.request(
|
|
138
|
+
'GET',
|
|
139
|
+
target_url
|
|
140
|
+
)
|
|
141
|
+
DocumentPage.new(@version, response, @solution)
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
##
|
|
145
|
+
# Provide a user friendly representation
|
|
146
|
+
def to_s
|
|
147
|
+
'#<Twilio.Preview.Sync.DocumentList>'
|
|
148
|
+
end
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
##
|
|
152
|
+
# PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
153
|
+
class DocumentPage < Page
|
|
154
|
+
##
|
|
155
|
+
# Initialize the DocumentPage
|
|
156
|
+
# @param [Version] version Version that contains the resource
|
|
157
|
+
# @param [Response] response Response from the API
|
|
158
|
+
# @param [Hash] solution Path solution for the resource
|
|
159
|
+
# @return [DocumentPage] DocumentPage
|
|
160
|
+
def initialize(version, response, solution)
|
|
161
|
+
super(version, response)
|
|
162
|
+
|
|
163
|
+
# Path Solution
|
|
164
|
+
@solution = solution
|
|
165
|
+
end
|
|
166
|
+
|
|
167
|
+
##
|
|
168
|
+
# Build an instance of DocumentInstance
|
|
169
|
+
# @param [Hash] payload Payload response from the API
|
|
170
|
+
# @return [DocumentInstance] DocumentInstance
|
|
171
|
+
def get_instance(payload)
|
|
172
|
+
DocumentInstance.new(
|
|
173
|
+
@version,
|
|
174
|
+
payload,
|
|
175
|
+
service_sid: @solution[:service_sid],
|
|
176
|
+
)
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
##
|
|
180
|
+
# Provide a user friendly representation
|
|
181
|
+
def to_s
|
|
182
|
+
'<Twilio.Preview.Sync.DocumentPage>'
|
|
183
|
+
end
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
##
|
|
187
|
+
# PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
188
|
+
class DocumentContext < InstanceContext
|
|
189
|
+
##
|
|
190
|
+
# Initialize the DocumentContext
|
|
191
|
+
# @param [Version] version Version that contains the resource
|
|
192
|
+
# @param [String] service_sid The service_sid
|
|
193
|
+
# @param [String] sid The sid
|
|
194
|
+
# @return [DocumentContext] DocumentContext
|
|
195
|
+
def initialize(version, service_sid, sid)
|
|
196
|
+
super(version)
|
|
197
|
+
|
|
198
|
+
# Path Solution
|
|
199
|
+
@solution = {
|
|
200
|
+
service_sid: service_sid,
|
|
201
|
+
sid: sid,
|
|
202
|
+
}
|
|
203
|
+
@uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:sid]}"
|
|
204
|
+
|
|
205
|
+
# Dependents
|
|
206
|
+
@document_permissions = nil
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
##
|
|
210
|
+
# Fetch a DocumentInstance
|
|
211
|
+
# @return [DocumentInstance] Fetched DocumentInstance
|
|
212
|
+
def fetch
|
|
213
|
+
params = Twilio::Values.of({})
|
|
214
|
+
|
|
215
|
+
payload = @version.fetch(
|
|
216
|
+
'GET',
|
|
217
|
+
@uri,
|
|
218
|
+
params,
|
|
219
|
+
)
|
|
220
|
+
|
|
221
|
+
DocumentInstance.new(
|
|
222
|
+
@version,
|
|
223
|
+
payload,
|
|
224
|
+
service_sid: @solution[:service_sid],
|
|
225
|
+
sid: @solution[:sid],
|
|
226
|
+
)
|
|
227
|
+
end
|
|
228
|
+
|
|
229
|
+
##
|
|
230
|
+
# Deletes the DocumentInstance
|
|
231
|
+
# @return [Boolean] true if delete succeeds, true otherwise
|
|
232
|
+
def delete
|
|
233
|
+
@version.delete('delete', @uri)
|
|
234
|
+
end
|
|
235
|
+
|
|
236
|
+
##
|
|
237
|
+
# Update the DocumentInstance
|
|
238
|
+
# @param [Hash] data The data
|
|
239
|
+
# @return [DocumentInstance] Updated DocumentInstance
|
|
240
|
+
def update(data: nil)
|
|
241
|
+
data = Twilio::Values.of({
|
|
242
|
+
'Data' => Twilio.serialize_object(data),
|
|
243
|
+
})
|
|
244
|
+
|
|
245
|
+
payload = @version.update(
|
|
246
|
+
'POST',
|
|
247
|
+
@uri,
|
|
248
|
+
data: data,
|
|
249
|
+
)
|
|
250
|
+
|
|
251
|
+
DocumentInstance.new(
|
|
252
|
+
@version,
|
|
253
|
+
payload,
|
|
254
|
+
service_sid: @solution[:service_sid],
|
|
255
|
+
sid: @solution[:sid],
|
|
256
|
+
)
|
|
257
|
+
end
|
|
258
|
+
|
|
259
|
+
##
|
|
260
|
+
# Access the document_permissions
|
|
261
|
+
# @return [DocumentPermissionList]
|
|
262
|
+
# @return [DocumentPermissionContext] if identity was passed.
|
|
263
|
+
def document_permissions(identity=:unset)
|
|
264
|
+
raise ArgumentError, 'identity cannot be nil' if identity.nil?
|
|
265
|
+
|
|
266
|
+
if identity != :unset
|
|
267
|
+
return DocumentPermissionContext.new(
|
|
268
|
+
@version,
|
|
269
|
+
@solution[:service_sid],
|
|
270
|
+
@solution[:sid],
|
|
271
|
+
identity,
|
|
272
|
+
)
|
|
273
|
+
end
|
|
274
|
+
|
|
275
|
+
unless @document_permissions
|
|
276
|
+
@document_permissions = DocumentPermissionList.new(
|
|
277
|
+
@version,
|
|
278
|
+
service_sid: @solution[:service_sid],
|
|
279
|
+
document_sid: @solution[:sid],
|
|
280
|
+
)
|
|
281
|
+
end
|
|
282
|
+
|
|
283
|
+
@document_permissions
|
|
284
|
+
end
|
|
285
|
+
|
|
286
|
+
##
|
|
287
|
+
# Provide a user friendly representation
|
|
288
|
+
def to_s
|
|
289
|
+
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
|
|
290
|
+
"#<Twilio.Preview.Sync.DocumentContext #{context}>"
|
|
291
|
+
end
|
|
292
|
+
end
|
|
293
|
+
|
|
294
|
+
##
|
|
295
|
+
# PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
296
|
+
class DocumentInstance < InstanceResource
|
|
297
|
+
##
|
|
298
|
+
# Initialize the DocumentInstance
|
|
299
|
+
# @param [Version] version Version that contains the resource
|
|
300
|
+
# @param [Hash] payload payload that contains response from Twilio
|
|
301
|
+
# @param [String] service_sid The service_sid
|
|
302
|
+
# @param [String] sid The sid
|
|
303
|
+
# @return [DocumentInstance] DocumentInstance
|
|
304
|
+
def initialize(version, payload, service_sid: nil, sid: nil)
|
|
305
|
+
super(version)
|
|
306
|
+
|
|
307
|
+
# Marshaled Properties
|
|
308
|
+
@properties = {
|
|
309
|
+
'sid' => payload['sid'],
|
|
310
|
+
'unique_name' => payload['unique_name'],
|
|
311
|
+
'account_sid' => payload['account_sid'],
|
|
312
|
+
'service_sid' => payload['service_sid'],
|
|
313
|
+
'url' => payload['url'],
|
|
314
|
+
'links' => payload['links'],
|
|
315
|
+
'revision' => payload['revision'],
|
|
316
|
+
'data' => payload['data'],
|
|
317
|
+
'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
|
|
318
|
+
'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
|
|
319
|
+
'created_by' => payload['created_by'],
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
# Context
|
|
323
|
+
@instance_context = nil
|
|
324
|
+
@params = {
|
|
325
|
+
'service_sid' => service_sid,
|
|
326
|
+
'sid' => sid || @properties['sid'],
|
|
327
|
+
}
|
|
328
|
+
end
|
|
329
|
+
|
|
330
|
+
##
|
|
331
|
+
# Generate an instance context for the instance, the context is capable of
|
|
332
|
+
# performing various actions. All instance actions are proxied to the context
|
|
333
|
+
# @return [DocumentContext] DocumentContext for this DocumentInstance
|
|
334
|
+
def context
|
|
335
|
+
unless @instance_context
|
|
336
|
+
@instance_context = DocumentContext.new(
|
|
337
|
+
@version,
|
|
338
|
+
@params['service_sid'],
|
|
339
|
+
@params['sid'],
|
|
340
|
+
)
|
|
341
|
+
end
|
|
342
|
+
@instance_context
|
|
343
|
+
end
|
|
344
|
+
|
|
345
|
+
##
|
|
346
|
+
# @return [String] The sid
|
|
347
|
+
def sid
|
|
348
|
+
@properties['sid']
|
|
349
|
+
end
|
|
350
|
+
|
|
351
|
+
##
|
|
352
|
+
# @return [String] The unique_name
|
|
353
|
+
def unique_name
|
|
354
|
+
@properties['unique_name']
|
|
355
|
+
end
|
|
356
|
+
|
|
357
|
+
##
|
|
358
|
+
# @return [String] The account_sid
|
|
359
|
+
def account_sid
|
|
360
|
+
@properties['account_sid']
|
|
361
|
+
end
|
|
362
|
+
|
|
363
|
+
##
|
|
364
|
+
# @return [String] The service_sid
|
|
365
|
+
def service_sid
|
|
366
|
+
@properties['service_sid']
|
|
367
|
+
end
|
|
368
|
+
|
|
369
|
+
##
|
|
370
|
+
# @return [String] The url
|
|
371
|
+
def url
|
|
372
|
+
@properties['url']
|
|
373
|
+
end
|
|
374
|
+
|
|
375
|
+
##
|
|
376
|
+
# @return [String] The links
|
|
377
|
+
def links
|
|
378
|
+
@properties['links']
|
|
379
|
+
end
|
|
380
|
+
|
|
381
|
+
##
|
|
382
|
+
# @return [String] The revision
|
|
383
|
+
def revision
|
|
384
|
+
@properties['revision']
|
|
385
|
+
end
|
|
386
|
+
|
|
387
|
+
##
|
|
388
|
+
# @return [Hash] The data
|
|
389
|
+
def data
|
|
390
|
+
@properties['data']
|
|
391
|
+
end
|
|
392
|
+
|
|
393
|
+
##
|
|
394
|
+
# @return [Time] The date_created
|
|
395
|
+
def date_created
|
|
396
|
+
@properties['date_created']
|
|
397
|
+
end
|
|
398
|
+
|
|
399
|
+
##
|
|
400
|
+
# @return [Time] The date_updated
|
|
401
|
+
def date_updated
|
|
402
|
+
@properties['date_updated']
|
|
403
|
+
end
|
|
404
|
+
|
|
405
|
+
##
|
|
406
|
+
# @return [String] The created_by
|
|
407
|
+
def created_by
|
|
408
|
+
@properties['created_by']
|
|
409
|
+
end
|
|
410
|
+
|
|
411
|
+
##
|
|
412
|
+
# Fetch a DocumentInstance
|
|
413
|
+
# @return [DocumentInstance] Fetched DocumentInstance
|
|
414
|
+
def fetch
|
|
415
|
+
context.fetch
|
|
416
|
+
end
|
|
417
|
+
|
|
418
|
+
##
|
|
419
|
+
# Deletes the DocumentInstance
|
|
420
|
+
# @return [Boolean] true if delete succeeds, true otherwise
|
|
421
|
+
def delete
|
|
422
|
+
context.delete
|
|
423
|
+
end
|
|
424
|
+
|
|
425
|
+
##
|
|
426
|
+
# Update the DocumentInstance
|
|
427
|
+
# @param [Hash] data The data
|
|
428
|
+
# @return [DocumentInstance] Updated DocumentInstance
|
|
429
|
+
def update(data: nil)
|
|
430
|
+
context.update(
|
|
431
|
+
data: data,
|
|
432
|
+
)
|
|
433
|
+
end
|
|
434
|
+
|
|
435
|
+
##
|
|
436
|
+
# Access the document_permissions
|
|
437
|
+
# @return [document_permissions] document_permissions
|
|
438
|
+
def document_permissions
|
|
439
|
+
context.document_permissions
|
|
440
|
+
end
|
|
441
|
+
|
|
442
|
+
##
|
|
443
|
+
# Provide a user friendly representation
|
|
444
|
+
def to_s
|
|
445
|
+
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
|
|
446
|
+
"<Twilio.Preview.Sync.DocumentInstance #{values}>"
|
|
447
|
+
end
|
|
448
|
+
end
|
|
449
|
+
end
|
|
450
|
+
end
|
|
451
|
+
end
|
|
452
|
+
end
|
|
453
|
+
end
|