twilio-ruby 5.0.0.alpha1 → 5.0.0.rc2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.travis.yml +11 -2
- data/AUTHORS.md +32 -46
- data/CHANGES.md +1 -124
- data/Gemfile +2 -2
- data/LICENSE.md +12 -12
- data/Makefile +2 -15
- data/README.md +37 -29
- data/Rakefile +0 -54
- data/examples/examples.rb +57 -46
- data/examples/{print_call_log.rb → print-call-log.rb} +7 -7
- data/lib/rack/twilio_webhook_authentication.rb +6 -5
- data/lib/twilio-ruby.rb +16 -17
- data/lib/twilio-ruby/compatibility/v2010/account/call/feedback.rb +15 -0
- data/lib/twilio-ruby/compatibility/v2010/account/queue/member.rb +23 -0
- data/lib/twilio-ruby/framework/domain.rb +2 -2
- data/lib/twilio-ruby/framework/exception.rb +14 -0
- data/lib/twilio-ruby/framework/helper.rb +1 -1
- data/lib/twilio-ruby/framework/page.rb +30 -28
- data/lib/twilio-ruby/framework/resource.rb +2 -2
- data/lib/twilio-ruby/framework/serialize.rb +7 -58
- data/lib/twilio-ruby/framework/twilio_response.rb +1 -1
- data/lib/twilio-ruby/framework/version.rb +48 -43
- data/lib/twilio-ruby/http/http_client.rb +8 -8
- data/lib/twilio-ruby/rest/api.rb +33 -141
- data/lib/twilio-ruby/rest/api/v2010.rb +31 -50
- data/lib/twilio-ruby/rest/api/v2010/account.rb +239 -389
- data/lib/twilio-ruby/rest/api/v2010/account/address.rb +122 -145
- data/lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb +56 -76
- data/lib/twilio-ruby/rest/api/v2010/account/application.rb +127 -144
- data/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb +83 -85
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb +97 -92
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb +77 -142
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb +77 -142
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb +77 -142
- data/lib/twilio-ruby/rest/api/v2010/account/call.rb +184 -232
- data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +84 -73
- data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +80 -85
- data/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb +115 -126
- data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +99 -114
- data/lib/twilio-ruby/rest/api/v2010/account/conference.rb +112 -150
- data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +109 -228
- data/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb +98 -101
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb +164 -287
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb +90 -152
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb +90 -152
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb +90 -152
- data/lib/twilio-ruby/rest/api/v2010/account/message.rb +138 -195
- data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +100 -90
- data/lib/twilio-ruby/rest/api/v2010/account/notification.rb +106 -118
- data/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb +105 -96
- data/lib/twilio-ruby/rest/api/v2010/account/queue.rb +117 -119
- data/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb +95 -84
- data/lib/twilio-ruby/rest/api/v2010/account/recording.rb +103 -194
- data/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb +93 -100
- data/lib/twilio-ruby/rest/api/v2010/account/sandbox.rb +304 -0
- data/lib/twilio-ruby/rest/api/v2010/account/sip.rb +30 -42
- data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb +113 -111
- data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb +115 -104
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb +133 -159
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +96 -94
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb +96 -94
- data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +114 -111
- data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb +113 -108
- data/lib/twilio-ruby/rest/api/v2010/account/sms.rb +140 -0
- data/lib/twilio-ruby/rest/api/v2010/account/sms/short_code.rb +431 -0
- data/lib/twilio-ruby/rest/api/v2010/account/sms/sms_message.rb +467 -0
- data/lib/twilio-ruby/rest/api/v2010/account/token.rb +34 -41
- data/lib/twilio-ruby/rest/api/v2010/account/transcription.rb +90 -98
- data/lib/twilio-ruby/rest/api/v2010/account/usage.rb +24 -21
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb +118 -139
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb +62 -106
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb +62 -106
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +62 -106
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb +62 -106
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb +62 -106
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb +62 -106
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb +62 -106
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb +62 -106
- data/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb +124 -130
- data/lib/twilio-ruby/rest/api/v2010/account/validation_request.rb +31 -35
- data/lib/twilio-ruby/rest/client.rb +88 -249
- data/lib/twilio-ruby/rest/{accounts.rb → conversations.rb} +14 -16
- data/lib/twilio-ruby/rest/conversations/v1.rb +35 -0
- data/lib/twilio-ruby/rest/conversations/v1/conversation.rb +270 -0
- data/lib/twilio-ruby/rest/{notify/v1/service/segment.rb → conversations/v1/conversation/completed.rb} +101 -101
- data/lib/twilio-ruby/rest/{preview/bulk_exports/export/day.rb → conversations/v1/conversation/in_progress.rb} +109 -95
- data/lib/twilio-ruby/rest/{messaging/v1/service/phone_number.rb → conversations/v1/conversation/participant.rb} +171 -178
- data/lib/twilio-ruby/rest/ip_messaging.rb +11 -26
- data/lib/twilio-ruby/rest/ip_messaging/v1.rb +7 -19
- data/lib/twilio-ruby/rest/ip_messaging/v1/credential.rb +112 -113
- data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +131 -542
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +132 -194
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +103 -159
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb +102 -183
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +112 -107
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb +113 -186
- data/lib/twilio-ruby/rest/lookups.rb +8 -12
- data/lib/twilio-ruby/rest/lookups/v1.rb +7 -13
- data/lib/twilio-ruby/rest/lookups/v1/phone_number.rb +54 -71
- data/lib/twilio-ruby/rest/monitor.rb +11 -19
- data/lib/twilio-ruby/rest/monitor/v1.rb +7 -19
- data/lib/twilio-ruby/rest/monitor/v1/alert.rb +133 -121
- data/lib/twilio-ruby/rest/monitor/v1/event.rb +127 -116
- data/lib/twilio-ruby/rest/pricing.rb +11 -17
- data/lib/twilio-ruby/rest/pricing/v1.rb +9 -21
- data/lib/twilio-ruby/rest/pricing/v1/messaging.rb +23 -27
- data/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb +74 -71
- data/lib/twilio-ruby/rest/pricing/v1/phone_number.rb +23 -27
- data/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb +79 -69
- data/lib/twilio-ruby/rest/pricing/v1/voice.rb +27 -33
- data/lib/twilio-ruby/rest/pricing/v1/voice/country.rb +74 -71
- data/lib/twilio-ruby/rest/pricing/v1/voice/number.rb +52 -47
- data/lib/twilio-ruby/rest/taskrouter.rb +8 -12
- data/lib/twilio-ruby/rest/taskrouter/v1.rb +5 -11
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb +153 -260
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb +114 -115
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb +101 -105
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb +139 -216
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb +106 -194
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb +145 -187
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb +65 -57
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb +57 -62
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +135 -217
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb +60 -54
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb +56 -52
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb +123 -140
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb +61 -57
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_statistics.rb +72 -52
- data/lib/twilio-ruby/rest/trunking.rb +8 -12
- data/lib/twilio-ruby/rest/trunking/v1.rb +5 -11
- data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +134 -157
- data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +93 -89
- data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +93 -89
- data/lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb +111 -114
- data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +112 -146
- data/lib/twilio-ruby/task_router.rb +0 -0
- data/lib/twilio-ruby/task_router/capability.rb +87 -0
- data/lib/twilio-ruby/twiml/response.rb +16 -0
- data/lib/twilio-ruby/util.rb +1 -1
- data/lib/twilio-ruby/util/access_token.rb +70 -0
- data/lib/twilio-ruby/util/capability.rb +64 -0
- data/lib/twilio-ruby/util/client_config.rb +29 -0
- data/lib/twilio-ruby/{security → util}/request_validator.rb +4 -21
- data/lib/twilio-ruby/version.rb +1 -1
- data/spec/holodeck/holodeck.rb +6 -6
- data/spec/holodeck/hologram.rb +1 -0
- data/spec/integration/api/v2010/account/address/dependent_phone_number_spec.rb +8 -8
- data/spec/integration/api/v2010/account/address_spec.rb +29 -37
- data/spec/integration/api/v2010/account/application_spec.rb +29 -29
- data/spec/integration/api/v2010/account/authorized_connect_app_spec.rb +13 -13
- data/spec/integration/api/v2010/account/available_phone_number/local_spec.rb +8 -9
- data/spec/integration/api/v2010/account/available_phone_number/mobile_spec.rb +8 -9
- data/spec/integration/api/v2010/account/available_phone_number/toll_free_spec.rb +8 -9
- data/spec/integration/api/v2010/account/available_phone_number_spec.rb +13 -13
- data/spec/integration/api/v2010/account/call/feedback_spec.rb +17 -17
- data/spec/integration/api/v2010/account/call/feedback_summary_spec.rb +19 -19
- data/spec/integration/api/v2010/account/call/notification_spec.rb +18 -18
- data/spec/integration/api/v2010/account/call/recording_spec.rb +20 -32
- data/spec/integration/api/v2010/account/call_spec.rb +29 -29
- data/spec/integration/api/v2010/account/conference/participant_spec.rb +35 -107
- data/spec/integration/api/v2010/account/conference_spec.rb +19 -58
- data/spec/integration/api/v2010/account/connect_app_spec.rb +18 -18
- data/spec/integration/api/v2010/account/incoming_phone_number/local_spec.rb +14 -16
- data/spec/integration/api/v2010/account/incoming_phone_number/mobile_spec.rb +14 -16
- data/spec/integration/api/v2010/account/incoming_phone_number/toll_free_spec.rb +14 -16
- data/spec/integration/api/v2010/account/incoming_phone_number_spec.rb +29 -41
- data/spec/integration/api/v2010/account/message/media_spec.rb +18 -18
- data/spec/integration/api/v2010/account/message_spec.rb +35 -41
- data/spec/integration/api/v2010/account/notification_spec.rb +18 -18
- data/spec/integration/api/v2010/account/outgoing_caller_id_spec.rb +23 -23
- data/spec/integration/api/v2010/account/queue/member_spec.rb +18 -18
- data/spec/integration/api/v2010/account/queue_spec.rb +32 -35
- data/spec/integration/api/v2010/account/recording/transcription_spec.rb +18 -18
- data/spec/integration/api/v2010/account/recording_spec.rb +21 -42
- data/spec/integration/api/v2010/account/sandbox_spec.rb +99 -0
- data/spec/integration/api/v2010/account/sip/credential_list/credential_spec.rb +36 -32
- data/spec/integration/api/v2010/account/sip/credential_list_spec.rb +29 -29
- data/spec/integration/api/v2010/account/sip/domain/credential_list_mapping_spec.rb +24 -24
- data/spec/integration/api/v2010/account/sip/domain/ip_access_control_list_mapping_spec.rb +24 -24
- data/spec/integration/api/v2010/account/sip/domain_spec.rb +29 -29
- data/spec/integration/api/v2010/account/sip/ip_access_control_list/ip_address_spec.rb +36 -32
- data/spec/integration/api/v2010/account/sip/ip_access_control_list_spec.rb +29 -29
- data/spec/integration/api/v2010/account/sip_spec.rb +1 -1
- data/spec/integration/api/v2010/account/{short_code_spec.rb → sms/short_code_spec.rb} +25 -18
- data/spec/integration/api/v2010/account/sms/sms_message_spec.rb +275 -0
- data/spec/integration/{accounts/v1/credential_spec.rb → api/v2010/account/sms_spec.rb} +2 -2
- data/spec/integration/api/v2010/account/token_spec.rb +7 -7
- data/spec/integration/api/v2010/account/transcription_spec.rb +18 -18
- data/spec/integration/api/v2010/account/usage/record/all_time_spec.rb +8 -8
- data/spec/integration/api/v2010/account/usage/record/daily_spec.rb +8 -8
- data/spec/integration/api/v2010/account/usage/record/last_month_spec.rb +8 -8
- data/spec/integration/api/v2010/account/usage/record/monthly_spec.rb +8 -8
- data/spec/integration/api/v2010/account/usage/record/this_month_spec.rb +8 -8
- data/spec/integration/api/v2010/account/usage/record/today_spec.rb +8 -8
- data/spec/integration/api/v2010/account/usage/record/yearly_spec.rb +8 -8
- data/spec/integration/api/v2010/account/usage/record/yesterday_spec.rb +8 -8
- data/spec/integration/api/v2010/account/usage/record_spec.rb +8 -8
- data/spec/integration/api/v2010/account/usage/trigger_spec.rb +32 -32
- data/spec/integration/api/v2010/account/usage_spec.rb +1 -1
- data/spec/integration/api/v2010/account/validation_request_spec.rb +4 -24
- data/spec/integration/api/v2010/account_spec.rb +28 -24
- data/spec/integration/conversations/v1/conversation/completed_spec.rb +89 -0
- data/spec/integration/conversations/v1/conversation/in_progress_spec.rb +89 -0
- data/spec/integration/conversations/v1/conversation/participant_spec.rb +174 -0
- data/spec/integration/conversations/v1/conversation_spec.rb +49 -0
- data/spec/integration/ip_messaging/v1/credential_spec.rb +24 -155
- data/spec/integration/ip_messaging/v1/service/channel/member_spec.rb +13 -217
- data/spec/integration/ip_messaging/v1/service/channel/message_spec.rb +10 -241
- data/spec/integration/ip_messaging/v1/service/channel_spec.rb +23 -205
- data/spec/integration/ip_messaging/v1/service/role_spec.rb +19 -184
- data/spec/integration/ip_messaging/v1/service/user_spec.rb +24 -194
- data/spec/integration/ip_messaging/v1/service_spec.rb +17 -229
- data/spec/integration/lookups/v1/phone_number_spec.rb +6 -17
- data/spec/integration/monitor/v1/alert_spec.rb +60 -60
- data/spec/integration/monitor/v1/event_spec.rb +13 -13
- data/spec/integration/pricing/v1/messaging/country_spec.rb +7 -103
- data/spec/integration/pricing/v1/messaging_spec.rb +1 -1
- data/spec/integration/pricing/v1/phone_number/country_spec.rb +13 -13
- data/spec/integration/pricing/v1/phone_number_spec.rb +1 -1
- data/spec/integration/pricing/v1/voice/country_spec.rb +13 -13
- data/spec/integration/pricing/v1/voice/number_spec.rb +6 -6
- data/spec/integration/pricing/v1/voice_spec.rb +1 -1
- data/spec/integration/taskrouter/v1/workspace/activity_spec.rb +38 -34
- data/spec/integration/taskrouter/v1/workspace/event_spec.rb +13 -13
- data/spec/integration/taskrouter/v1/workspace/task/reservation_spec.rb +24 -21
- data/spec/integration/taskrouter/v1/workspace/task_queue/task_queue_statistics_spec.rb +11 -13
- data/spec/integration/taskrouter/v1/workspace/task_queue/task_queues_statistics_spec.rb +17 -18
- data/spec/integration/taskrouter/v1/workspace/task_queue_spec.rb +41 -57
- data/spec/integration/taskrouter/v1/workspace/task_spec.rb +50 -113
- data/spec/integration/taskrouter/v1/workspace/worker/worker_statistics_spec.rb +6 -7
- data/spec/integration/taskrouter/v1/workspace/worker/workers_statistics_spec.rb +6 -7
- data/spec/integration/taskrouter/v1/workspace/worker_spec.rb +68 -96
- data/spec/integration/taskrouter/v1/workspace/workflow/workflow_statistics_spec.rb +12 -14
- data/spec/integration/taskrouter/v1/workspace/workflow_spec.rb +43 -54
- data/spec/integration/taskrouter/v1/workspace/workspace_statistics_spec.rb +9 -11
- data/spec/integration/taskrouter/v1/workspace_spec.rb +51 -71
- data/spec/integration/trunking/v1/trunk/credential_list_spec.rb +24 -24
- data/spec/integration/trunking/v1/trunk/ip_access_control_list_spec.rb +66 -66
- data/spec/integration/trunking/v1/trunk/origination_url_spec.rb +28 -28
- data/spec/integration/trunking/v1/trunk/phone_number_spec.rb +23 -23
- data/spec/integration/trunking/v1/trunk_spec.rb +28 -28
- data/spec/rack/twilio_webhook_authentication_spec.rb +23 -19
- data/spec/spec_helper.rb +2 -2
- data/spec/support/fakeweb.rb +1 -1
- data/spec/task_router_spec.rb +114 -0
- data/spec/util/access_token_spec.rb +103 -0
- data/spec/util/capability_spec.rb +186 -0
- data/spec/util/client_config_spec.rb +21 -0
- data/spec/{security → util}/request_validator_spec.rb +5 -5
- data/twilio-ruby.gemspec +8 -12
- metadata +90 -416
- data/.rubocop.yml +0 -21
- data/.rubocop_todo.yml +0 -187
- data/VERSIONS.md +0 -64
- data/lib/twilio-ruby/framework/error.rb +0 -30
- data/lib/twilio-ruby/framework/values.rb +0 -7
- data/lib/twilio-ruby/jwt/access_token.rb +0 -232
- data/lib/twilio-ruby/jwt/client_capability.rb +0 -102
- data/lib/twilio-ruby/jwt/jwt.rb +0 -50
- data/lib/twilio-ruby/jwt/task_router.rb +0 -174
- data/lib/twilio-ruby/rest/accounts/v1.rb +0 -39
- data/lib/twilio-ruby/rest/accounts/v1/credential.rb +0 -105
- data/lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb +0 -370
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb +0 -431
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb +0 -350
- data/lib/twilio-ruby/rest/api/v2010/account/key.rb +0 -336
- data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb +0 -165
- data/lib/twilio-ruby/rest/api/v2010/account/new_key.rb +0 -153
- data/lib/twilio-ruby/rest/api/v2010/account/new_signing_key.rb +0 -153
- data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb +0 -397
- data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb +0 -378
- data/lib/twilio-ruby/rest/api/v2010/account/short_code.rb +0 -430
- data/lib/twilio-ruby/rest/api/v2010/account/signing_key.rb +0 -336
- data/lib/twilio-ruby/rest/chat.rb +0 -59
- data/lib/twilio-ruby/rest/chat/v1.rb +0 -56
- data/lib/twilio-ruby/rest/chat/v1/credential.rb +0 -403
- data/lib/twilio-ruby/rest/chat/v1/service.rb +0 -935
- data/lib/twilio-ruby/rest/chat/v1/service/channel.rb +0 -554
- data/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb +0 -386
- data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb +0 -431
- data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb +0 -447
- data/lib/twilio-ruby/rest/chat/v1/service/role.rb +0 -396
- data/lib/twilio-ruby/rest/chat/v1/service/user.rb +0 -467
- data/lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb +0 -244
- data/lib/twilio-ruby/rest/chat/v2.rb +0 -56
- data/lib/twilio-ruby/rest/chat/v2/credential.rb +0 -403
- data/lib/twilio-ruby/rest/chat/v2/service.rb +0 -688
- data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +0 -554
- data/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +0 -386
- data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +0 -431
- data/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +0 -447
- data/lib/twilio-ruby/rest/chat/v2/service/role.rb +0 -396
- data/lib/twilio-ruby/rest/chat/v2/service/user.rb +0 -467
- data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb +0 -244
- data/lib/twilio-ruby/rest/fax.rb +0 -44
- data/lib/twilio-ruby/rest/fax/v1.rb +0 -41
- data/lib/twilio-ruby/rest/fax/v1/fax.rb +0 -541
- data/lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb +0 -326
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +0 -386
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb +0 -244
- data/lib/twilio-ruby/rest/ip_messaging/v2.rb +0 -56
- data/lib/twilio-ruby/rest/ip_messaging/v2/credential.rb +0 -403
- data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +0 -688
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +0 -554
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +0 -386
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +0 -431
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +0 -447
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +0 -396
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +0 -467
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +0 -244
- data/lib/twilio-ruby/rest/messaging.rb +0 -44
- data/lib/twilio-ruby/rest/messaging/v1.rb +0 -41
- data/lib/twilio-ruby/rest/messaging/v1/service.rb +0 -637
- data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +0 -352
- data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +0 -359
- data/lib/twilio-ruby/rest/notify.rb +0 -52
- data/lib/twilio-ruby/rest/notify/v1.rb +0 -56
- data/lib/twilio-ruby/rest/notify/v1/credential.rb +0 -403
- data/lib/twilio-ruby/rest/notify/v1/service.rb +0 -639
- data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +0 -430
- data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +0 -288
- data/lib/twilio-ruby/rest/notify/v1/service/user.rb +0 -445
- data/lib/twilio-ruby/rest/notify/v1/service/user/segment_memberships.rb +0 -254
- data/lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb +0 -434
- data/lib/twilio-ruby/rest/preview.rb +0 -145
- data/lib/twilio-ruby/rest/preview/bulk_exports.rb +0 -56
- data/lib/twilio-ruby/rest/preview/bulk_exports/export.rb +0 -203
- data/lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb +0 -243
- data/lib/twilio-ruby/rest/preview/hosted_numbers.rb +0 -42
- data/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb +0 -557
- data/lib/twilio-ruby/rest/preview/marketplace.rb +0 -58
- data/lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb +0 -333
- data/lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb +0 -301
- data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb +0 -440
- data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb +0 -341
- data/lib/twilio-ruby/rest/preview/proxy.rb +0 -41
- data/lib/twilio-ruby/rest/preview/proxy/service.rb +0 -500
- data/lib/twilio-ruby/rest/preview/proxy/service/phone_number.rb +0 -359
- data/lib/twilio-ruby/rest/preview/proxy/service/session.rb +0 -536
- data/lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb +0 -429
- data/lib/twilio-ruby/rest/preview/proxy/service/session/participant.rb +0 -506
- data/lib/twilio-ruby/rest/preview/proxy/service/session/participant/message_interaction.rb +0 -452
- data/lib/twilio-ruby/rest/preview/proxy/service/short_code.rb +0 -359
- data/lib/twilio-ruby/rest/preview/sync.rb +0 -41
- data/lib/twilio-ruby/rest/preview/sync/service.rb +0 -504
- data/lib/twilio-ruby/rest/preview/sync/service/document.rb +0 -445
- data/lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb +0 -395
- data/lib/twilio-ruby/rest/preview/sync/service/sync_list.rb +0 -438
- data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb +0 -430
- data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_permission.rb +0 -395
- data/lib/twilio-ruby/rest/preview/sync/service/sync_map.rb +0 -438
- data/lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb +0 -432
- data/lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb +0 -395
- data/lib/twilio-ruby/rest/preview/wireless.rb +0 -71
- data/lib/twilio-ruby/rest/preview/wireless/command.rb +0 -382
- data/lib/twilio-ruby/rest/preview/wireless/rate_plan.rb +0 -435
- data/lib/twilio-ruby/rest/preview/wireless/sim.rb +0 -544
- data/lib/twilio-ruby/rest/preview/wireless/sim/usage.rb +0 -236
- data/lib/twilio-ruby/rest/sync.rb +0 -44
- data/lib/twilio-ruby/rest/sync/v1.rb +0 -41
- data/lib/twilio-ruby/rest/sync/v1/service.rb +0 -504
- data/lib/twilio-ruby/rest/sync/v1/service/document.rb +0 -445
- data/lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb +0 -395
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +0 -438
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +0 -430
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb +0 -395
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +0 -438
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +0 -432
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb +0 -395
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb +0 -315
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb +0 -461
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb +0 -406
- data/lib/twilio-ruby/rest/video.rb +0 -52
- data/lib/twilio-ruby/rest/video/v1.rb +0 -56
- data/lib/twilio-ruby/rest/video/v1/recording.rb +0 -382
- data/lib/twilio-ruby/rest/video/v1/room.rb +0 -485
- data/lib/twilio-ruby/rest/video/v1/room/recording.rb +0 -381
- data/lib/twilio-ruby/rest/wireless.rb +0 -60
- data/lib/twilio-ruby/rest/wireless/v1.rb +0 -71
- data/lib/twilio-ruby/rest/wireless/v1/command.rb +0 -367
- data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +0 -452
- data/lib/twilio-ruby/rest/wireless/v1/sim.rb +0 -548
- data/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb +0 -235
- data/lib/twilio-ruby/twiml/messaging_response.rb +0 -141
- data/lib/twilio-ruby/twiml/twiml.rb +0 -69
- data/lib/twilio-ruby/twiml/voice_response.rb +0 -916
- data/spec/framework/serialize_spec.rb +0 -59
- data/spec/integration/accounts/v1/credential/public_key_spec.rb +0 -226
- data/spec/integration/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension_spec.rb +0 -135
- data/spec/integration/api/v2010/account/incoming_phone_number/assigned_add_on_spec.rb +0 -223
- data/spec/integration/api/v2010/account/key_spec.rb +0 -178
- data/spec/integration/api/v2010/account/message/feedback_spec.rb +0 -48
- data/spec/integration/api/v2010/account/new_key_spec.rb +0 -45
- data/spec/integration/api/v2010/account/new_signing_key_spec.rb +0 -45
- data/spec/integration/api/v2010/account/recording/add_on_result/payload_spec.rb +0 -175
- data/spec/integration/api/v2010/account/recording/add_on_result_spec.rb +0 -166
- data/spec/integration/api/v2010/account/signing_key_spec.rb +0 -178
- data/spec/integration/chat/v1/credential_spec.rb +0 -223
- data/spec/integration/chat/v1/service/channel/invite_spec.rb +0 -210
- data/spec/integration/chat/v1/service/channel/member_spec.rb +0 -284
- data/spec/integration/chat/v1/service/channel/message_spec.rb +0 -294
- data/spec/integration/chat/v1/service/channel_spec.rb +0 -275
- data/spec/integration/chat/v1/service/role_spec.rb +0 -263
- data/spec/integration/chat/v1/service/user/user_channel_spec.rb +0 -92
- data/spec/integration/chat/v1/service/user_spec.rb +0 -266
- data/spec/integration/chat/v1/service_spec.rb +0 -299
- data/spec/integration/chat/v2/credential_spec.rb +0 -223
- data/spec/integration/chat/v2/service/channel/invite_spec.rb +0 -210
- data/spec/integration/chat/v2/service/channel/member_spec.rb +0 -284
- data/spec/integration/chat/v2/service/channel/message_spec.rb +0 -294
- data/spec/integration/chat/v2/service/channel_spec.rb +0 -275
- data/spec/integration/chat/v2/service/role_spec.rb +0 -263
- data/spec/integration/chat/v2/service/user/user_channel_spec.rb +0 -92
- data/spec/integration/chat/v2/service/user_spec.rb +0 -266
- data/spec/integration/chat/v2/service_spec.rb +0 -325
- data/spec/integration/fax/v1/fax/fax_media_spec.rb +0 -126
- data/spec/integration/fax/v1/fax_spec.rb +0 -272
- data/spec/integration/ip_messaging/v1/service/channel/invite_spec.rb +0 -210
- data/spec/integration/ip_messaging/v1/service/user/user_channel_spec.rb +0 -92
- data/spec/integration/ip_messaging/v2/credential_spec.rb +0 -223
- data/spec/integration/ip_messaging/v2/service/channel/invite_spec.rb +0 -210
- data/spec/integration/ip_messaging/v2/service/channel/member_spec.rb +0 -284
- data/spec/integration/ip_messaging/v2/service/channel/message_spec.rb +0 -294
- data/spec/integration/ip_messaging/v2/service/channel_spec.rb +0 -275
- data/spec/integration/ip_messaging/v2/service/role_spec.rb +0 -263
- data/spec/integration/ip_messaging/v2/service/user/user_channel_spec.rb +0 -92
- data/spec/integration/ip_messaging/v2/service/user_spec.rb +0 -266
- data/spec/integration/ip_messaging/v2/service_spec.rb +0 -325
- data/spec/integration/messaging/v1/service/alpha_sender_spec.rb +0 -170
- data/spec/integration/messaging/v1/service/phone_number_spec.rb +0 -201
- data/spec/integration/messaging/v1/service/short_code_spec.rb +0 -173
- data/spec/integration/messaging/v1/service_spec.rb +0 -263
- data/spec/integration/notify/v1/credential_spec.rb +0 -223
- data/spec/integration/notify/v1/service/binding_spec.rb +0 -227
- data/spec/integration/notify/v1/service/notification_spec.rb +0 -97
- data/spec/integration/notify/v1/service/segment_spec.rb +0 -84
- data/spec/integration/notify/v1/service/user/segment_memberships_spec.rb +0 -118
- data/spec/integration/notify/v1/service/user/user_binding_spec.rb +0 -269
- data/spec/integration/notify/v1/service/user_spec.rb +0 -213
- data/spec/integration/notify/v1/service_spec.rb +0 -280
- data/spec/integration/preview/bulk_exports/export/day_spec.rb +0 -56
- data/spec/integration/preview/bulk_exports/export_configuration_spec.rb +0 -79
- data/spec/integration/preview/bulk_exports/export_spec.rb +0 -43
- data/spec/integration/preview/hosted_numbers/hosted_number_order_spec.rb +0 -280
- data/spec/integration/preview/marketplace/available_add_on/available_add_on_extension_spec.rb +0 -121
- data/spec/integration/preview/marketplace/available_add_on_spec.rb +0 -142
- data/spec/integration/preview/marketplace/installed_add_on/installed_add_on_extension_spec.rb +0 -164
- data/spec/integration/preview/marketplace/installed_add_on_spec.rb +0 -252
- data/spec/integration/preview/proxy/service/phone_number_spec.rb +0 -173
- data/spec/integration/preview/proxy/service/session/interaction_spec.rb +0 -104
- data/spec/integration/preview/proxy/service/session/participant/message_interaction_spec.rb +0 -164
- data/spec/integration/preview/proxy/service/session/participant_spec.rb +0 -226
- data/spec/integration/preview/proxy/service/session_spec.rb +0 -216
- data/spec/integration/preview/proxy/service/short_code_spec.rb +0 -173
- data/spec/integration/preview/proxy/service_spec.rb +0 -200
- data/spec/integration/preview/sync/service/document/document_permission_spec.rb +0 -206
- data/spec/integration/preview/sync/service/document_spec.rb +0 -254
- data/spec/integration/preview/sync/service/sync_list/sync_list_item_spec.rb +0 -256
- data/spec/integration/preview/sync/service/sync_list/sync_list_permission_spec.rb +0 -206
- data/spec/integration/preview/sync/service/sync_list_spec.rb +0 -207
- data/spec/integration/preview/sync/service/sync_map/sync_map_item_spec.rb +0 -257
- data/spec/integration/preview/sync/service/sync_map/sync_map_permission_spec.rb +0 -206
- data/spec/integration/preview/sync/service/sync_map_spec.rb +0 -207
- data/spec/integration/preview/sync/service_spec.rb +0 -244
- data/spec/integration/preview/wireless/command_spec.rb +0 -169
- data/spec/integration/preview/wireless/rate_plan_spec.rb +0 -260
- data/spec/integration/preview/wireless/sim/usage_spec.rb +0 -49
- data/spec/integration/preview/wireless/sim_spec.rb +0 -208
- data/spec/integration/sync/v1/service/document/document_permission_spec.rb +0 -206
- data/spec/integration/sync/v1/service/document_spec.rb +0 -254
- data/spec/integration/sync/v1/service/sync_list/sync_list_item_spec.rb +0 -256
- data/spec/integration/sync/v1/service/sync_list/sync_list_permission_spec.rb +0 -206
- data/spec/integration/sync/v1/service/sync_list_spec.rb +0 -207
- data/spec/integration/sync/v1/service/sync_map/sync_map_item_spec.rb +0 -257
- data/spec/integration/sync/v1/service/sync_map/sync_map_permission_spec.rb +0 -206
- data/spec/integration/sync/v1/service/sync_map_spec.rb +0 -207
- data/spec/integration/sync/v1/service_spec.rb +0 -244
- data/spec/integration/taskrouter/v1/workspace/task_channel_spec.rb +0 -127
- data/spec/integration/taskrouter/v1/workspace/worker/reservation_spec.rb +0 -192
- data/spec/integration/taskrouter/v1/workspace/worker/worker_channel_spec.rb +0 -201
- data/spec/integration/video/v1/recording_spec.rb +0 -165
- data/spec/integration/video/v1/room/recording_spec.rb +0 -146
- data/spec/integration/video/v1/room_spec.rb +0 -237
- data/spec/integration/wireless/v1/command_spec.rb +0 -166
- data/spec/integration/wireless/v1/rate_plan_spec.rb +0 -268
- data/spec/integration/wireless/v1/sim/usage_record_spec.rb +0 -65
- data/spec/integration/wireless/v1/sim_spec.rb +0 -208
- data/spec/jwt/access_token_spec.rb +0 -130
- data/spec/jwt/client_capability_spec.rb +0 -104
- data/spec/jwt/task_router_spec.rb +0 -172
- data/spec/twiml/messaging_response_spec.rb +0 -90
- data/spec/twiml/voice_response_spec.rb +0 -474
@@ -1,244 +0,0 @@
|
|
1
|
-
##
|
2
|
-
# This code was generated by
|
3
|
-
# \ / _ _ _| _ _
|
4
|
-
# | (_)\/(_)(_|\/| |(/_ v1.0.0
|
5
|
-
# / /
|
6
|
-
|
7
|
-
module Twilio
|
8
|
-
module REST
|
9
|
-
class Chat < Domain
|
10
|
-
class V2 < Version
|
11
|
-
class ServiceContext < InstanceContext
|
12
|
-
class UserContext < InstanceContext
|
13
|
-
class UserChannelList < ListResource
|
14
|
-
##
|
15
|
-
# Initialize the UserChannelList
|
16
|
-
# @param [Version] version Version that contains the resource
|
17
|
-
# @param [String] service_sid The service_sid
|
18
|
-
# @param [String] user_sid The sid
|
19
|
-
# @return [UserChannelList] UserChannelList
|
20
|
-
def initialize(version, service_sid: nil, user_sid: nil)
|
21
|
-
super(version)
|
22
|
-
|
23
|
-
# Path Solution
|
24
|
-
@solution = {
|
25
|
-
service_sid: service_sid,
|
26
|
-
user_sid: user_sid
|
27
|
-
}
|
28
|
-
@uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:user_sid]}/Channels"
|
29
|
-
end
|
30
|
-
|
31
|
-
##
|
32
|
-
# Lists UserChannelInstance records from the API as a list.
|
33
|
-
# Unlike stream(), this operation is eager and will load `limit` records into
|
34
|
-
# memory before returning.
|
35
|
-
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
36
|
-
# guarantees to never return more than limit. Default is no limit
|
37
|
-
# @param [Integer] page_size Number of records to fetch per request, when not set will use
|
38
|
-
# the default value of 50 records. If no page_size is defined
|
39
|
-
# but a limit is defined, stream() will attempt to read the
|
40
|
-
# limit with the most efficient page size, i.e. min(limit, 1000)
|
41
|
-
# @return [Array] Array of up to limit results
|
42
|
-
def list(limit: nil, page_size: nil)
|
43
|
-
self.stream(
|
44
|
-
limit: limit,
|
45
|
-
page_size: page_size
|
46
|
-
).entries
|
47
|
-
end
|
48
|
-
|
49
|
-
##
|
50
|
-
# Streams UserChannelInstance records from the API as an Enumerable.
|
51
|
-
# This operation lazily loads records as efficiently as possible until the limit
|
52
|
-
# is reached.
|
53
|
-
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
54
|
-
# guarantees to never return more than limit. Default is no limit
|
55
|
-
# @param [Integer] page_size Number of records to fetch per request, when not set will use
|
56
|
-
# the default value of 50 records. If no page_size is defined
|
57
|
-
# but a limit is defined, stream() will attempt to read the
|
58
|
-
# limit with the most efficient page size, i.e. min(limit, 1000)
|
59
|
-
# @return [Enumerable] Enumerable that will yield up to limit results
|
60
|
-
def stream(limit: nil, page_size: nil)
|
61
|
-
limits = @version.read_limits(limit, page_size)
|
62
|
-
|
63
|
-
page = self.page(
|
64
|
-
page_size: limits[:page_size],
|
65
|
-
)
|
66
|
-
|
67
|
-
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
68
|
-
end
|
69
|
-
|
70
|
-
##
|
71
|
-
# When passed a block, yields UserChannelInstance records from the API.
|
72
|
-
# This operation lazily loads records as efficiently as possible until the limit
|
73
|
-
# is reached.
|
74
|
-
def each
|
75
|
-
limits = @version.read_limits
|
76
|
-
|
77
|
-
page = self.page(
|
78
|
-
page_size: limits[:page_size],
|
79
|
-
)
|
80
|
-
|
81
|
-
@version.stream(page,
|
82
|
-
limit: limits[:limit],
|
83
|
-
page_limit: limits[:page_limit]).each {|x| yield x}
|
84
|
-
end
|
85
|
-
|
86
|
-
##
|
87
|
-
# Retrieve a single page of UserChannelInstance records from the API.
|
88
|
-
# Request is executed immediately.
|
89
|
-
# @param [String] page_token PageToken provided by the API
|
90
|
-
# @param [Integer] page_number Page Number, this value is simply for client state
|
91
|
-
# @param [Integer] page_size Number of records to return, defaults to 50
|
92
|
-
# @return [Page] Page of UserChannelInstance
|
93
|
-
def page(page_token: :unset, page_number: :unset, page_size: :unset)
|
94
|
-
params = Twilio::Values.of({
|
95
|
-
'PageToken' => page_token,
|
96
|
-
'Page' => page_number,
|
97
|
-
'PageSize' => page_size,
|
98
|
-
})
|
99
|
-
response = @version.page(
|
100
|
-
'GET',
|
101
|
-
@uri,
|
102
|
-
params
|
103
|
-
)
|
104
|
-
UserChannelPage.new(@version, response, @solution)
|
105
|
-
end
|
106
|
-
|
107
|
-
##
|
108
|
-
# Retrieve a single page of UserChannelInstance records from the API.
|
109
|
-
# Request is executed immediately.
|
110
|
-
# @param [String] target_url API-generated URL for the requested results page
|
111
|
-
# @return [Page] Page of UserChannelInstance
|
112
|
-
def get_page(target_url)
|
113
|
-
response = @version.domain.request(
|
114
|
-
'GET',
|
115
|
-
target_url
|
116
|
-
)
|
117
|
-
UserChannelPage.new(@version, response, @solution)
|
118
|
-
end
|
119
|
-
|
120
|
-
##
|
121
|
-
# Provide a user friendly representation
|
122
|
-
def to_s
|
123
|
-
'#<Twilio.Chat.V2.UserChannelList>'
|
124
|
-
end
|
125
|
-
end
|
126
|
-
|
127
|
-
class UserChannelPage < Page
|
128
|
-
##
|
129
|
-
# Initialize the UserChannelPage
|
130
|
-
# @param [Version] version Version that contains the resource
|
131
|
-
# @param [Response] response Response from the API
|
132
|
-
# @param [Hash] solution Path solution for the resource
|
133
|
-
# @return [UserChannelPage] UserChannelPage
|
134
|
-
def initialize(version, response, solution)
|
135
|
-
super(version, response)
|
136
|
-
|
137
|
-
# Path Solution
|
138
|
-
@solution = solution
|
139
|
-
end
|
140
|
-
|
141
|
-
##
|
142
|
-
# Build an instance of UserChannelInstance
|
143
|
-
# @param [Hash] payload Payload response from the API
|
144
|
-
# @return [UserChannelInstance] UserChannelInstance
|
145
|
-
def get_instance(payload)
|
146
|
-
UserChannelInstance.new(
|
147
|
-
@version,
|
148
|
-
payload,
|
149
|
-
service_sid: @solution[:service_sid],
|
150
|
-
user_sid: @solution[:user_sid],
|
151
|
-
)
|
152
|
-
end
|
153
|
-
|
154
|
-
##
|
155
|
-
# Provide a user friendly representation
|
156
|
-
def to_s
|
157
|
-
'<Twilio.Chat.V2.UserChannelPage>'
|
158
|
-
end
|
159
|
-
end
|
160
|
-
|
161
|
-
class UserChannelInstance < InstanceResource
|
162
|
-
##
|
163
|
-
# Initialize the UserChannelInstance
|
164
|
-
# @param [Version] version Version that contains the resource
|
165
|
-
# @param [Hash] payload payload that contains response from Twilio
|
166
|
-
# @param [String] service_sid The service_sid
|
167
|
-
# @param [String] user_sid The sid
|
168
|
-
# @return [UserChannelInstance] UserChannelInstance
|
169
|
-
def initialize(version, payload, service_sid: nil, user_sid: nil)
|
170
|
-
super(version)
|
171
|
-
|
172
|
-
# Marshaled Properties
|
173
|
-
@properties = {
|
174
|
-
'account_sid' => payload['account_sid'],
|
175
|
-
'service_sid' => payload['service_sid'],
|
176
|
-
'channel_sid' => payload['channel_sid'],
|
177
|
-
'member_sid' => payload['member_sid'],
|
178
|
-
'status' => payload['status'],
|
179
|
-
'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i,
|
180
|
-
'unread_messages_count' => payload['unread_messages_count'] == nil ? payload['unread_messages_count'] : payload['unread_messages_count'].to_i,
|
181
|
-
'links' => payload['links'],
|
182
|
-
}
|
183
|
-
end
|
184
|
-
|
185
|
-
##
|
186
|
-
# @return [String] The account_sid
|
187
|
-
def account_sid
|
188
|
-
@properties['account_sid']
|
189
|
-
end
|
190
|
-
|
191
|
-
##
|
192
|
-
# @return [String] The service_sid
|
193
|
-
def service_sid
|
194
|
-
@properties['service_sid']
|
195
|
-
end
|
196
|
-
|
197
|
-
##
|
198
|
-
# @return [String] The channel_sid
|
199
|
-
def channel_sid
|
200
|
-
@properties['channel_sid']
|
201
|
-
end
|
202
|
-
|
203
|
-
##
|
204
|
-
# @return [String] The member_sid
|
205
|
-
def member_sid
|
206
|
-
@properties['member_sid']
|
207
|
-
end
|
208
|
-
|
209
|
-
##
|
210
|
-
# @return [user_channel.ChannelStatus] The status
|
211
|
-
def status
|
212
|
-
@properties['status']
|
213
|
-
end
|
214
|
-
|
215
|
-
##
|
216
|
-
# @return [String] The last_consumed_message_index
|
217
|
-
def last_consumed_message_index
|
218
|
-
@properties['last_consumed_message_index']
|
219
|
-
end
|
220
|
-
|
221
|
-
##
|
222
|
-
# @return [String] The unread_messages_count
|
223
|
-
def unread_messages_count
|
224
|
-
@properties['unread_messages_count']
|
225
|
-
end
|
226
|
-
|
227
|
-
##
|
228
|
-
# @return [String] The links
|
229
|
-
def links
|
230
|
-
@properties['links']
|
231
|
-
end
|
232
|
-
|
233
|
-
##
|
234
|
-
# Provide a user friendly representation
|
235
|
-
def to_s
|
236
|
-
"<Twilio.Chat.V2.UserChannelInstance>"
|
237
|
-
end
|
238
|
-
end
|
239
|
-
end
|
240
|
-
end
|
241
|
-
end
|
242
|
-
end
|
243
|
-
end
|
244
|
-
end
|
data/lib/twilio-ruby/rest/fax.rb
DELETED
@@ -1,44 +0,0 @@
|
|
1
|
-
##
|
2
|
-
# This code was generated by
|
3
|
-
# \ / _ _ _| _ _
|
4
|
-
# | (_)\/(_)(_|\/| |(/_ v1.0.0
|
5
|
-
# / /
|
6
|
-
|
7
|
-
module Twilio
|
8
|
-
module REST
|
9
|
-
class Fax < Domain
|
10
|
-
##
|
11
|
-
# Initialize the Fax Domain
|
12
|
-
def initialize(twilio)
|
13
|
-
super
|
14
|
-
|
15
|
-
@base_url = 'https://fax.twilio.com'
|
16
|
-
@host = 'fax.twilio.com'
|
17
|
-
@port = 443
|
18
|
-
|
19
|
-
# Versions
|
20
|
-
@v1 = nil
|
21
|
-
end
|
22
|
-
|
23
|
-
##
|
24
|
-
# Version v1 of fax
|
25
|
-
def v1
|
26
|
-
@v1 ||= V1.new self
|
27
|
-
end
|
28
|
-
|
29
|
-
##
|
30
|
-
# @param [String] sid A 34 character string that uniquely identifies this fax.
|
31
|
-
# @return [Twilio::REST::Fax::V1::FaxInstance] if sid was passed.
|
32
|
-
# @return [Twilio::REST::Fax::V1::FaxList]
|
33
|
-
def faxes(sid=:unset)
|
34
|
-
self.v1.faxes(sid)
|
35
|
-
end
|
36
|
-
|
37
|
-
##
|
38
|
-
# Provide a user friendly representation
|
39
|
-
def to_s
|
40
|
-
'#<Twilio::REST::Fax>'
|
41
|
-
end
|
42
|
-
end
|
43
|
-
end
|
44
|
-
end
|
@@ -1,41 +0,0 @@
|
|
1
|
-
##
|
2
|
-
# This code was generated by
|
3
|
-
# \ / _ _ _| _ _
|
4
|
-
# | (_)\/(_)(_|\/| |(/_ v1.0.0
|
5
|
-
# / /
|
6
|
-
|
7
|
-
module Twilio
|
8
|
-
module REST
|
9
|
-
class Fax
|
10
|
-
class V1 < Version
|
11
|
-
##
|
12
|
-
# Initialize the V1 version of Fax
|
13
|
-
def initialize(domain)
|
14
|
-
super
|
15
|
-
@version = 'v1'
|
16
|
-
@faxes = nil
|
17
|
-
end
|
18
|
-
|
19
|
-
##
|
20
|
-
# @param [String] sid A 34 character string that uniquely identifies this fax.
|
21
|
-
# @return [Twilio::REST::Fax::V1::FaxInstance] if sid was passed.
|
22
|
-
# @return [Twilio::REST::Fax::V1::FaxList]
|
23
|
-
def faxes(sid=:unset)
|
24
|
-
if sid.nil?
|
25
|
-
raise ArgumentError, 'sid cannot be nil'
|
26
|
-
elsif sid == :unset
|
27
|
-
@faxes ||= FaxList.new self
|
28
|
-
else
|
29
|
-
FaxContext.new(self, sid)
|
30
|
-
end
|
31
|
-
end
|
32
|
-
|
33
|
-
##
|
34
|
-
# Provide a user friendly representation
|
35
|
-
def to_s
|
36
|
-
'<Twilio::REST::Fax::V1>'
|
37
|
-
end
|
38
|
-
end
|
39
|
-
end
|
40
|
-
end
|
41
|
-
end
|
@@ -1,541 +0,0 @@
|
|
1
|
-
##
|
2
|
-
# This code was generated by
|
3
|
-
# \ / _ _ _| _ _
|
4
|
-
# | (_)\/(_)(_|\/| |(/_ v1.0.0
|
5
|
-
# / /
|
6
|
-
|
7
|
-
module Twilio
|
8
|
-
module REST
|
9
|
-
class Fax < Domain
|
10
|
-
class V1 < Version
|
11
|
-
class FaxList < ListResource
|
12
|
-
##
|
13
|
-
# Initialize the FaxList
|
14
|
-
# @param [Version] version Version that contains the resource
|
15
|
-
# @return [FaxList] FaxList
|
16
|
-
def initialize(version)
|
17
|
-
super(version)
|
18
|
-
|
19
|
-
# Path Solution
|
20
|
-
@solution = {}
|
21
|
-
@uri = "/Faxes"
|
22
|
-
end
|
23
|
-
|
24
|
-
##
|
25
|
-
# Lists FaxInstance records from the API as a list.
|
26
|
-
# Unlike stream(), this operation is eager and will load `limit` records into
|
27
|
-
# memory before returning.
|
28
|
-
# @param [String] from Filters the returned list to only include faxes sent from
|
29
|
-
# the supplied number, given in E.164 format.
|
30
|
-
# @param [String] to Filters the returned list to only include faxes sent to the
|
31
|
-
# supplied number, given in E.164 format.
|
32
|
-
# @param [Time] date_created_on_or_before Filters the returned list to only
|
33
|
-
# include faxes created on or before the supplied date, given in ISO 8601 format.
|
34
|
-
# @param [Time] date_created_after Filters the returned list to only include faxes
|
35
|
-
# created after the supplied date, given in ISO 8601 format.
|
36
|
-
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
37
|
-
# guarantees to never return more than limit. Default is no limit
|
38
|
-
# @param [Integer] page_size Number of records to fetch per request, when not set will use
|
39
|
-
# the default value of 50 records. If no page_size is defined
|
40
|
-
# but a limit is defined, stream() will attempt to read the
|
41
|
-
# limit with the most efficient page size, i.e. min(limit, 1000)
|
42
|
-
# @return [Array] Array of up to limit results
|
43
|
-
def list(from: :unset, to: :unset, date_created_on_or_before: :unset, date_created_after: :unset, limit: nil, page_size: nil)
|
44
|
-
self.stream(
|
45
|
-
from: from,
|
46
|
-
to: to,
|
47
|
-
date_created_on_or_before: date_created_on_or_before,
|
48
|
-
date_created_after: date_created_after,
|
49
|
-
limit: limit,
|
50
|
-
page_size: page_size
|
51
|
-
).entries
|
52
|
-
end
|
53
|
-
|
54
|
-
##
|
55
|
-
# Streams FaxInstance records from the API as an Enumerable.
|
56
|
-
# This operation lazily loads records as efficiently as possible until the limit
|
57
|
-
# is reached.
|
58
|
-
# @param [String] from Filters the returned list to only include faxes sent from
|
59
|
-
# the supplied number, given in E.164 format.
|
60
|
-
# @param [String] to Filters the returned list to only include faxes sent to the
|
61
|
-
# supplied number, given in E.164 format.
|
62
|
-
# @param [Time] date_created_on_or_before Filters the returned list to only
|
63
|
-
# include faxes created on or before the supplied date, given in ISO 8601 format.
|
64
|
-
# @param [Time] date_created_after Filters the returned list to only include faxes
|
65
|
-
# created after the supplied date, given in ISO 8601 format.
|
66
|
-
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
67
|
-
# guarantees to never return more than limit. Default is no limit
|
68
|
-
# @param [Integer] page_size Number of records to fetch per request, when not set will use
|
69
|
-
# the default value of 50 records. If no page_size is defined
|
70
|
-
# but a limit is defined, stream() will attempt to read the
|
71
|
-
# limit with the most efficient page size, i.e. min(limit, 1000)
|
72
|
-
# @return [Enumerable] Enumerable that will yield up to limit results
|
73
|
-
def stream(from: :unset, to: :unset, date_created_on_or_before: :unset, date_created_after: :unset, limit: nil, page_size: nil)
|
74
|
-
limits = @version.read_limits(limit, page_size)
|
75
|
-
|
76
|
-
page = self.page(
|
77
|
-
from: from,
|
78
|
-
to: to,
|
79
|
-
date_created_on_or_before: date_created_on_or_before,
|
80
|
-
date_created_after: date_created_after,
|
81
|
-
page_size: limits[:page_size],
|
82
|
-
)
|
83
|
-
|
84
|
-
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
85
|
-
end
|
86
|
-
|
87
|
-
##
|
88
|
-
# When passed a block, yields FaxInstance records from the API.
|
89
|
-
# This operation lazily loads records as efficiently as possible until the limit
|
90
|
-
# is reached.
|
91
|
-
def each
|
92
|
-
limits = @version.read_limits
|
93
|
-
|
94
|
-
page = self.page(
|
95
|
-
page_size: limits[:page_size],
|
96
|
-
)
|
97
|
-
|
98
|
-
@version.stream(page,
|
99
|
-
limit: limits[:limit],
|
100
|
-
page_limit: limits[:page_limit]).each {|x| yield x}
|
101
|
-
end
|
102
|
-
|
103
|
-
##
|
104
|
-
# Retrieve a single page of FaxInstance records from the API.
|
105
|
-
# Request is executed immediately.
|
106
|
-
# @param [String] from Filters the returned list to only include faxes sent from
|
107
|
-
# the supplied number, given in E.164 format.
|
108
|
-
# @param [String] to Filters the returned list to only include faxes sent to the
|
109
|
-
# supplied number, given in E.164 format.
|
110
|
-
# @param [Time] date_created_on_or_before Filters the returned list to only
|
111
|
-
# include faxes created on or before the supplied date, given in ISO 8601 format.
|
112
|
-
# @param [Time] date_created_after Filters the returned list to only include faxes
|
113
|
-
# created after the supplied date, given in ISO 8601 format.
|
114
|
-
# @param [String] page_token PageToken provided by the API
|
115
|
-
# @param [Integer] page_number Page Number, this value is simply for client state
|
116
|
-
# @param [Integer] page_size Number of records to return, defaults to 50
|
117
|
-
# @return [Page] Page of FaxInstance
|
118
|
-
def page(from: :unset, to: :unset, date_created_on_or_before: :unset, date_created_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
|
119
|
-
params = Twilio::Values.of({
|
120
|
-
'From' => from,
|
121
|
-
'To' => to,
|
122
|
-
'DateCreatedOnOrBefore' => Twilio.serialize_iso8601_datetime(date_created_on_or_before),
|
123
|
-
'DateCreatedAfter' => Twilio.serialize_iso8601_datetime(date_created_after),
|
124
|
-
'PageToken' => page_token,
|
125
|
-
'Page' => page_number,
|
126
|
-
'PageSize' => page_size,
|
127
|
-
})
|
128
|
-
response = @version.page(
|
129
|
-
'GET',
|
130
|
-
@uri,
|
131
|
-
params
|
132
|
-
)
|
133
|
-
FaxPage.new(@version, response, @solution)
|
134
|
-
end
|
135
|
-
|
136
|
-
##
|
137
|
-
# Retrieve a single page of FaxInstance records from the API.
|
138
|
-
# Request is executed immediately.
|
139
|
-
# @param [String] target_url API-generated URL for the requested results page
|
140
|
-
# @return [Page] Page of FaxInstance
|
141
|
-
def get_page(target_url)
|
142
|
-
response = @version.domain.request(
|
143
|
-
'GET',
|
144
|
-
target_url
|
145
|
-
)
|
146
|
-
FaxPage.new(@version, response, @solution)
|
147
|
-
end
|
148
|
-
|
149
|
-
##
|
150
|
-
# Retrieve a single page of FaxInstance records from the API.
|
151
|
-
# Request is executed immediately.
|
152
|
-
# @param [String] to The phone number or SIP address to send the fax to,
|
153
|
-
# E.164-formatted.
|
154
|
-
# @param [String] media_url The URL that Twilio will request to obtain the fax
|
155
|
-
# media to send, which must be a PDF file.
|
156
|
-
# @param [fax.Quality] quality The quality setting to use for this fax. One of
|
157
|
-
# `standard`, `fine` or `superfine`.
|
158
|
-
# @param [String] status_callback The URL that Twilio will request when the status
|
159
|
-
# of the fax changes.
|
160
|
-
# @param [String] from The phone number to use as the caller id, E.164-formatted.
|
161
|
-
# If using a phone number, it must be a Twilio number or a verified outgoing
|
162
|
-
# caller id for your account. If sending to a SIP address, this can be any
|
163
|
-
# alphanumeric string (plus the characters `+`, `_`, `.`, and `-`) to use in the
|
164
|
-
# From header of the SIP request.
|
165
|
-
# @param [String] sip_auth_username The username to use for authentication when
|
166
|
-
# sending to a SIP address.
|
167
|
-
# @param [String] sip_auth_password The password to use for authentication when
|
168
|
-
# sending to a SIP address.
|
169
|
-
# @param [Boolean] store_media Whether or not to store a copy of the sent media on
|
170
|
-
# Twilio's servers for later retrieval (defaults to `true`)
|
171
|
-
# @return [FaxInstance] Newly created FaxInstance
|
172
|
-
def create(to: nil, media_url: nil, quality: :unset, status_callback: :unset, from: :unset, sip_auth_username: :unset, sip_auth_password: :unset, store_media: :unset)
|
173
|
-
data = Twilio::Values.of({
|
174
|
-
'To' => to,
|
175
|
-
'MediaUrl' => media_url,
|
176
|
-
'Quality' => quality,
|
177
|
-
'StatusCallback' => status_callback,
|
178
|
-
'From' => from,
|
179
|
-
'SipAuthUsername' => sip_auth_username,
|
180
|
-
'SipAuthPassword' => sip_auth_password,
|
181
|
-
'StoreMedia' => store_media,
|
182
|
-
})
|
183
|
-
|
184
|
-
payload = @version.create(
|
185
|
-
'POST',
|
186
|
-
@uri,
|
187
|
-
data: data
|
188
|
-
)
|
189
|
-
|
190
|
-
FaxInstance.new(
|
191
|
-
@version,
|
192
|
-
payload,
|
193
|
-
)
|
194
|
-
end
|
195
|
-
|
196
|
-
##
|
197
|
-
# Provide a user friendly representation
|
198
|
-
def to_s
|
199
|
-
'#<Twilio.Fax.V1.FaxList>'
|
200
|
-
end
|
201
|
-
end
|
202
|
-
|
203
|
-
class FaxPage < Page
|
204
|
-
##
|
205
|
-
# Initialize the FaxPage
|
206
|
-
# @param [Version] version Version that contains the resource
|
207
|
-
# @param [Response] response Response from the API
|
208
|
-
# @param [Hash] solution Path solution for the resource
|
209
|
-
# @return [FaxPage] FaxPage
|
210
|
-
def initialize(version, response, solution)
|
211
|
-
super(version, response)
|
212
|
-
|
213
|
-
# Path Solution
|
214
|
-
@solution = solution
|
215
|
-
end
|
216
|
-
|
217
|
-
##
|
218
|
-
# Build an instance of FaxInstance
|
219
|
-
# @param [Hash] payload Payload response from the API
|
220
|
-
# @return [FaxInstance] FaxInstance
|
221
|
-
def get_instance(payload)
|
222
|
-
FaxInstance.new(
|
223
|
-
@version,
|
224
|
-
payload,
|
225
|
-
)
|
226
|
-
end
|
227
|
-
|
228
|
-
##
|
229
|
-
# Provide a user friendly representation
|
230
|
-
def to_s
|
231
|
-
'<Twilio.Fax.V1.FaxPage>'
|
232
|
-
end
|
233
|
-
end
|
234
|
-
|
235
|
-
class FaxContext < InstanceContext
|
236
|
-
##
|
237
|
-
# Initialize the FaxContext
|
238
|
-
# @param [Version] version Version that contains the resource
|
239
|
-
# @param [String] sid A 34 character string that uniquely identifies this fax.
|
240
|
-
# @return [FaxContext] FaxContext
|
241
|
-
def initialize(version, sid)
|
242
|
-
super(version)
|
243
|
-
|
244
|
-
# Path Solution
|
245
|
-
@solution = {
|
246
|
-
sid: sid,
|
247
|
-
}
|
248
|
-
@uri = "/Faxes/#{@solution[:sid]}"
|
249
|
-
|
250
|
-
# Dependents
|
251
|
-
@media = nil
|
252
|
-
end
|
253
|
-
|
254
|
-
##
|
255
|
-
# Fetch a FaxInstance
|
256
|
-
# @return [FaxInstance] Fetched FaxInstance
|
257
|
-
def fetch
|
258
|
-
params = Twilio::Values.of({})
|
259
|
-
|
260
|
-
payload = @version.fetch(
|
261
|
-
'GET',
|
262
|
-
@uri,
|
263
|
-
params,
|
264
|
-
)
|
265
|
-
|
266
|
-
FaxInstance.new(
|
267
|
-
@version,
|
268
|
-
payload,
|
269
|
-
sid: @solution[:sid],
|
270
|
-
)
|
271
|
-
end
|
272
|
-
|
273
|
-
##
|
274
|
-
# Update the FaxInstance
|
275
|
-
# @param [fax.UpdateStatus] status The updated status of this fax. The only valid
|
276
|
-
# option is `canceled`. This may fail if the status has already started
|
277
|
-
# transmission.
|
278
|
-
# @return [FaxInstance] Updated FaxInstance
|
279
|
-
def update(status: :unset)
|
280
|
-
data = Twilio::Values.of({
|
281
|
-
'Status' => status,
|
282
|
-
})
|
283
|
-
|
284
|
-
payload = @version.update(
|
285
|
-
'POST',
|
286
|
-
@uri,
|
287
|
-
data: data,
|
288
|
-
)
|
289
|
-
|
290
|
-
FaxInstance.new(
|
291
|
-
@version,
|
292
|
-
payload,
|
293
|
-
sid: @solution[:sid],
|
294
|
-
)
|
295
|
-
end
|
296
|
-
|
297
|
-
##
|
298
|
-
# Deletes the FaxInstance
|
299
|
-
# @return [Boolean] true if delete succeeds, true otherwise
|
300
|
-
def delete
|
301
|
-
@version.delete('delete', @uri)
|
302
|
-
end
|
303
|
-
|
304
|
-
##
|
305
|
-
# Access the media
|
306
|
-
# @return [FaxMediaList]
|
307
|
-
# @return [FaxMediaContext] if sid was passed.
|
308
|
-
def media(sid=:unset)
|
309
|
-
raise ArgumentError, 'sid cannot be nil' if sid.nil?
|
310
|
-
|
311
|
-
if sid != :unset
|
312
|
-
return FaxMediaContext.new(
|
313
|
-
@version,
|
314
|
-
@solution[:sid],
|
315
|
-
sid,
|
316
|
-
)
|
317
|
-
end
|
318
|
-
|
319
|
-
unless @media
|
320
|
-
@media = FaxMediaList.new(
|
321
|
-
@version,
|
322
|
-
fax_sid: @solution[:sid],
|
323
|
-
)
|
324
|
-
end
|
325
|
-
|
326
|
-
@media
|
327
|
-
end
|
328
|
-
|
329
|
-
##
|
330
|
-
# Provide a user friendly representation
|
331
|
-
def to_s
|
332
|
-
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
|
333
|
-
"#<Twilio.Fax.V1.FaxContext #{context}>"
|
334
|
-
end
|
335
|
-
end
|
336
|
-
|
337
|
-
class FaxInstance < InstanceResource
|
338
|
-
##
|
339
|
-
# Initialize the FaxInstance
|
340
|
-
# @param [Version] version Version that contains the resource
|
341
|
-
# @param [Hash] payload payload that contains response from Twilio
|
342
|
-
# @param [String] sid A 34 character string that uniquely identifies this fax.
|
343
|
-
# @return [FaxInstance] FaxInstance
|
344
|
-
def initialize(version, payload, sid: nil)
|
345
|
-
super(version)
|
346
|
-
|
347
|
-
# Marshaled Properties
|
348
|
-
@properties = {
|
349
|
-
'sid' => payload['sid'],
|
350
|
-
'account_sid' => payload['account_sid'],
|
351
|
-
'from' => payload['from'],
|
352
|
-
'to' => payload['to'],
|
353
|
-
'quality' => payload['quality'],
|
354
|
-
'media_sid' => payload['media_sid'],
|
355
|
-
'media_url' => payload['media_url'],
|
356
|
-
'num_pages' => payload['num_pages'] == nil ? payload['num_pages'] : payload['num_pages'].to_i,
|
357
|
-
'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
|
358
|
-
'status' => payload['status'],
|
359
|
-
'direction' => payload['direction'],
|
360
|
-
'api_version' => payload['api_version'],
|
361
|
-
'price' => payload['price'].to_f,
|
362
|
-
'price_unit' => payload['price_unit'],
|
363
|
-
'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
|
364
|
-
'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
|
365
|
-
'links' => payload['links'],
|
366
|
-
'url' => payload['url'],
|
367
|
-
}
|
368
|
-
|
369
|
-
# Context
|
370
|
-
@instance_context = nil
|
371
|
-
@params = {
|
372
|
-
'sid' => sid || @properties['sid'],
|
373
|
-
}
|
374
|
-
end
|
375
|
-
|
376
|
-
##
|
377
|
-
# Generate an instance context for the instance, the context is capable of
|
378
|
-
# performing various actions. All instance actions are proxied to the context
|
379
|
-
# @return [FaxContext] FaxContext for this FaxInstance
|
380
|
-
def context
|
381
|
-
unless @instance_context
|
382
|
-
@instance_context = FaxContext.new(
|
383
|
-
@version,
|
384
|
-
@params['sid'],
|
385
|
-
)
|
386
|
-
end
|
387
|
-
@instance_context
|
388
|
-
end
|
389
|
-
|
390
|
-
##
|
391
|
-
# @return [String] A string that uniquely identifies this fax.
|
392
|
-
def sid
|
393
|
-
@properties['sid']
|
394
|
-
end
|
395
|
-
|
396
|
-
##
|
397
|
-
# @return [String] Account SID
|
398
|
-
def account_sid
|
399
|
-
@properties['account_sid']
|
400
|
-
end
|
401
|
-
|
402
|
-
##
|
403
|
-
# @return [String] The party that sent the fax
|
404
|
-
def from
|
405
|
-
@properties['from']
|
406
|
-
end
|
407
|
-
|
408
|
-
##
|
409
|
-
# @return [String] The party that received the fax
|
410
|
-
def to
|
411
|
-
@properties['to']
|
412
|
-
end
|
413
|
-
|
414
|
-
##
|
415
|
-
# @return [fax.Quality] The quality of this fax
|
416
|
-
def quality
|
417
|
-
@properties['quality']
|
418
|
-
end
|
419
|
-
|
420
|
-
##
|
421
|
-
# @return [String] Media SID
|
422
|
-
def media_sid
|
423
|
-
@properties['media_sid']
|
424
|
-
end
|
425
|
-
|
426
|
-
##
|
427
|
-
# @return [String] URL pointing to fax media
|
428
|
-
def media_url
|
429
|
-
@properties['media_url']
|
430
|
-
end
|
431
|
-
|
432
|
-
##
|
433
|
-
# @return [String] Number of pages
|
434
|
-
def num_pages
|
435
|
-
@properties['num_pages']
|
436
|
-
end
|
437
|
-
|
438
|
-
##
|
439
|
-
# @return [String] The time taken to transmit the fax
|
440
|
-
def duration
|
441
|
-
@properties['duration']
|
442
|
-
end
|
443
|
-
|
444
|
-
##
|
445
|
-
# @return [fax.Status] The status of this fax
|
446
|
-
def status
|
447
|
-
@properties['status']
|
448
|
-
end
|
449
|
-
|
450
|
-
##
|
451
|
-
# @return [fax.Direction] The direction of this fax
|
452
|
-
def direction
|
453
|
-
@properties['direction']
|
454
|
-
end
|
455
|
-
|
456
|
-
##
|
457
|
-
# @return [String] The API version used
|
458
|
-
def api_version
|
459
|
-
@properties['api_version']
|
460
|
-
end
|
461
|
-
|
462
|
-
##
|
463
|
-
# @return [String] Fax transmission price
|
464
|
-
def price
|
465
|
-
@properties['price']
|
466
|
-
end
|
467
|
-
|
468
|
-
##
|
469
|
-
# @return [String] Currency used for billing
|
470
|
-
def price_unit
|
471
|
-
@properties['price_unit']
|
472
|
-
end
|
473
|
-
|
474
|
-
##
|
475
|
-
# @return [Time] The date this fax was created
|
476
|
-
def date_created
|
477
|
-
@properties['date_created']
|
478
|
-
end
|
479
|
-
|
480
|
-
##
|
481
|
-
# @return [Time] The date this fax was updated
|
482
|
-
def date_updated
|
483
|
-
@properties['date_updated']
|
484
|
-
end
|
485
|
-
|
486
|
-
##
|
487
|
-
# @return [String] Nested resource URLs
|
488
|
-
def links
|
489
|
-
@properties['links']
|
490
|
-
end
|
491
|
-
|
492
|
-
##
|
493
|
-
# @return [String] The URL of this resource
|
494
|
-
def url
|
495
|
-
@properties['url']
|
496
|
-
end
|
497
|
-
|
498
|
-
##
|
499
|
-
# Fetch a FaxInstance
|
500
|
-
# @return [FaxInstance] Fetched FaxInstance
|
501
|
-
def fetch
|
502
|
-
context.fetch
|
503
|
-
end
|
504
|
-
|
505
|
-
##
|
506
|
-
# Update the FaxInstance
|
507
|
-
# @param [fax.UpdateStatus] status The updated status of this fax. The only valid
|
508
|
-
# option is `canceled`. This may fail if the status has already started
|
509
|
-
# transmission.
|
510
|
-
# @return [FaxInstance] Updated FaxInstance
|
511
|
-
def update(status: :unset)
|
512
|
-
context.update(
|
513
|
-
status: status,
|
514
|
-
)
|
515
|
-
end
|
516
|
-
|
517
|
-
##
|
518
|
-
# Deletes the FaxInstance
|
519
|
-
# @return [Boolean] true if delete succeeds, true otherwise
|
520
|
-
def delete
|
521
|
-
context.delete
|
522
|
-
end
|
523
|
-
|
524
|
-
##
|
525
|
-
# Access the media
|
526
|
-
# @return [media] media
|
527
|
-
def media
|
528
|
-
context.media
|
529
|
-
end
|
530
|
-
|
531
|
-
##
|
532
|
-
# Provide a user friendly representation
|
533
|
-
def to_s
|
534
|
-
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
|
535
|
-
"<Twilio.Fax.V1.FaxInstance #{values}>"
|
536
|
-
end
|
537
|
-
end
|
538
|
-
end
|
539
|
-
end
|
540
|
-
end
|
541
|
-
end
|