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