twilio-ruby 5.25.4 → 5.26.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.
Files changed (220) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +1 -3
  3. data/.travis.yml +3 -0
  4. data/CHANGES.md +24 -0
  5. data/README.md +22 -14
  6. data/lib/twilio-ruby/http/http_client.rb +4 -3
  7. data/lib/twilio-ruby/rest/accounts/v1/credential/aws.rb +2 -2
  8. data/lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb +2 -2
  9. data/lib/twilio-ruby/rest/api/v2010/account/address.rb +2 -2
  10. data/lib/twilio-ruby/rest/api/v2010/account/application.rb +2 -2
  11. data/lib/twilio-ruby/rest/api/v2010/account/call.rb +10 -4
  12. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +2 -2
  13. data/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb +2 -2
  14. data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +2 -2
  15. data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +4 -4
  16. data/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb +2 -2
  17. data/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb +2 -2
  18. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb +2 -2
  19. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb +2 -2
  20. data/lib/twilio-ruby/rest/api/v2010/account/key.rb +2 -2
  21. data/lib/twilio-ruby/rest/api/v2010/account/message.rb +2 -2
  22. data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +2 -2
  23. data/lib/twilio-ruby/rest/api/v2010/account/notification.rb +2 -2
  24. data/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb +2 -2
  25. data/lib/twilio-ruby/rest/api/v2010/account/queue.rb +2 -2
  26. data/lib/twilio-ruby/rest/api/v2010/account/recording.rb +2 -2
  27. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb +2 -2
  28. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb +2 -2
  29. data/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb +2 -2
  30. data/lib/twilio-ruby/rest/api/v2010/account/signing_key.rb +2 -2
  31. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb +2 -2
  32. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb +2 -2
  33. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb +2 -2
  34. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_credential_list_mapping.rb +2 -2
  35. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_ip_access_control_list_mapping.rb +2 -2
  36. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping/auth_registrations_credential_list_mapping.rb +2 -2
  37. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +2 -2
  38. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb +2 -2
  39. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +2 -2
  40. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb +2 -2
  41. data/lib/twilio-ruby/rest/api/v2010/account/transcription.rb +2 -2
  42. data/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb +2 -2
  43. data/lib/twilio-ruby/rest/authy/v1/service.rb +2 -2
  44. data/lib/twilio-ruby/rest/authy/v1/service/entity.rb +2 -2
  45. data/lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb +2 -2
  46. data/lib/twilio-ruby/rest/authy/v1/service/entity/factor/challenge.rb +2 -2
  47. data/lib/twilio-ruby/rest/autopilot/v1/assistant.rb +2 -2
  48. data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb +2 -2
  49. data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb +2 -2
  50. data/lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb +2 -2
  51. data/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb +2 -2
  52. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb +2 -2
  53. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb +2 -2
  54. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb +2 -2
  55. data/lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb +2 -2
  56. data/lib/twilio-ruby/rest/chat/v1/credential.rb +2 -2
  57. data/lib/twilio-ruby/rest/chat/v1/service.rb +2 -2
  58. data/lib/twilio-ruby/rest/chat/v1/service/channel.rb +2 -2
  59. data/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb +2 -2
  60. data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb +2 -2
  61. data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb +2 -2
  62. data/lib/twilio-ruby/rest/chat/v1/service/role.rb +2 -2
  63. data/lib/twilio-ruby/rest/chat/v1/service/user.rb +2 -2
  64. data/lib/twilio-ruby/rest/chat/v2.rb +2 -4
  65. data/lib/twilio-ruby/rest/chat/v2/credential.rb +12 -14
  66. data/lib/twilio-ruby/rest/chat/v2/service.rb +35 -43
  67. data/lib/twilio-ruby/rest/chat/v2/service/binding.rb +17 -19
  68. data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +28 -24
  69. data/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +17 -16
  70. data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +43 -44
  71. data/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +38 -37
  72. data/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb +25 -26
  73. data/lib/twilio-ruby/rest/chat/v2/service/role.rb +19 -17
  74. data/lib/twilio-ruby/rest/chat/v2/service/user.rb +17 -17
  75. data/lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb +25 -27
  76. data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb +8 -5
  77. data/lib/twilio-ruby/rest/conversations/v1/conversation.rb +32 -6
  78. data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +30 -6
  79. data/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb +27 -6
  80. data/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb +2 -2
  81. data/lib/twilio-ruby/rest/fax/v1/fax.rb +2 -2
  82. data/lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb +2 -2
  83. data/lib/twilio-ruby/rest/flex_api/v1/channel.rb +2 -2
  84. data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb +14 -0
  85. data/lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb +2 -2
  86. data/lib/twilio-ruby/rest/flex_api/v1/web_channel.rb +2 -2
  87. data/lib/twilio-ruby/rest/ip_messaging/v1/credential.rb +2 -2
  88. data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +2 -2
  89. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +2 -2
  90. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +2 -2
  91. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +2 -2
  92. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb +2 -2
  93. data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +2 -2
  94. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb +2 -2
  95. data/lib/twilio-ruby/rest/ip_messaging/v2.rb +2 -4
  96. data/lib/twilio-ruby/rest/ip_messaging/v2/credential.rb +12 -14
  97. data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +35 -43
  98. data/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb +17 -19
  99. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +28 -24
  100. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +17 -16
  101. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +43 -44
  102. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +38 -37
  103. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb +25 -26
  104. data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +19 -17
  105. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +17 -17
  106. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb +25 -27
  107. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +8 -5
  108. data/lib/twilio-ruby/rest/messaging/v1/service.rb +2 -2
  109. data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +2 -2
  110. data/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb +2 -2
  111. data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +2 -2
  112. data/lib/twilio-ruby/rest/messaging/v1/session.rb +2 -2
  113. data/lib/twilio-ruby/rest/messaging/v1/session/message.rb +2 -2
  114. data/lib/twilio-ruby/rest/messaging/v1/session/participant.rb +2 -2
  115. data/lib/twilio-ruby/rest/messaging/v1/session/webhook.rb +2 -2
  116. data/lib/twilio-ruby/rest/monitor/v1/alert.rb +2 -2
  117. data/lib/twilio-ruby/rest/notify/v1/credential.rb +2 -2
  118. data/lib/twilio-ruby/rest/notify/v1/service.rb +2 -2
  119. data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +2 -2
  120. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb +2 -2
  121. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb +2 -2
  122. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb +2 -2
  123. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb +2 -2
  124. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb +2 -2
  125. data/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb +2 -2
  126. data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb +2 -2
  127. data/lib/twilio-ruby/rest/preview/sync/service.rb +2 -2
  128. data/lib/twilio-ruby/rest/preview/sync/service/document.rb +2 -2
  129. data/lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb +2 -2
  130. data/lib/twilio-ruby/rest/preview/sync/service/sync_list.rb +2 -2
  131. data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb +2 -2
  132. data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_permission.rb +2 -2
  133. data/lib/twilio-ruby/rest/preview/sync/service/sync_map.rb +2 -2
  134. data/lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb +2 -2
  135. data/lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb +2 -2
  136. data/lib/twilio-ruby/rest/preview/trusted_comms/branded_call.rb +10 -2
  137. data/lib/twilio-ruby/rest/preview/understand/assistant.rb +2 -2
  138. data/lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb +2 -2
  139. data/lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb +2 -2
  140. data/lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb +2 -2
  141. data/lib/twilio-ruby/rest/preview/understand/assistant/query.rb +2 -2
  142. data/lib/twilio-ruby/rest/preview/understand/assistant/task.rb +2 -2
  143. data/lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb +2 -2
  144. data/lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb +2 -2
  145. data/lib/twilio-ruby/rest/preview/wireless/rate_plan.rb +2 -2
  146. data/lib/twilio-ruby/rest/proxy/v1/service.rb +2 -2
  147. data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb +2 -2
  148. data/lib/twilio-ruby/rest/proxy/v1/service/session.rb +2 -2
  149. data/lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb +2 -2
  150. data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb +2 -2
  151. data/lib/twilio-ruby/rest/proxy/v1/service/short_code.rb +2 -2
  152. data/lib/twilio-ruby/rest/serverless/v1/service.rb +2 -2
  153. data/lib/twilio-ruby/rest/serverless/v1/service/asset.rb +2 -2
  154. data/lib/twilio-ruby/rest/serverless/v1/service/build.rb +2 -2
  155. data/lib/twilio-ruby/rest/serverless/v1/service/environment.rb +2 -2
  156. data/lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb +2 -2
  157. data/lib/twilio-ruby/rest/serverless/v1/service/function.rb +2 -2
  158. data/lib/twilio-ruby/rest/studio.rb +2 -1
  159. data/lib/twilio-ruby/rest/studio/v1.rb +1 -1
  160. data/lib/twilio-ruby/rest/studio/v1/flow.rb +13 -13
  161. data/lib/twilio-ruby/rest/studio/v1/flow/engagement.rb +25 -24
  162. data/lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb +11 -11
  163. data/lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb +20 -20
  164. data/lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb +15 -17
  165. data/lib/twilio-ruby/rest/studio/v1/flow/execution.rb +44 -38
  166. data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_context.rb +12 -11
  167. data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb +21 -20
  168. data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb +18 -17
  169. data/lib/twilio-ruby/rest/sync.rb +2 -1
  170. data/lib/twilio-ruby/rest/sync/v1.rb +1 -1
  171. data/lib/twilio-ruby/rest/sync/v1/service.rb +90 -93
  172. data/lib/twilio-ruby/rest/sync/v1/service/document.rb +46 -33
  173. data/lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb +36 -38
  174. data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +44 -31
  175. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +94 -76
  176. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb +37 -38
  177. data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +45 -33
  178. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +98 -81
  179. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb +35 -38
  180. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +39 -28
  181. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb +14 -12
  182. data/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb +2 -2
  183. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb +2 -2
  184. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb +2 -2
  185. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb +2 -2
  186. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb +2 -2
  187. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +2 -2
  188. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb +2 -2
  189. data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +2 -2
  190. data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +2 -2
  191. data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +2 -2
  192. data/lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb +2 -2
  193. data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +2 -2
  194. data/lib/twilio-ruby/rest/trunking/v1/trunk/terminating_sip_domain.rb +2 -2
  195. data/lib/twilio-ruby/rest/verify/v2/service.rb +2 -2
  196. data/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb +2 -2
  197. data/lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb +3 -3
  198. data/lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb +2 -2
  199. data/lib/twilio-ruby/rest/video/v1/composition.rb +2 -2
  200. data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +2 -2
  201. data/lib/twilio-ruby/rest/video/v1/recording.rb +2 -2
  202. data/lib/twilio-ruby/rest/video/v1/room/recording.rb +2 -2
  203. data/lib/twilio-ruby/rest/wireless.rb +3 -3
  204. data/lib/twilio-ruby/rest/wireless/v1.rb +3 -6
  205. data/lib/twilio-ruby/rest/wireless/v1/command.rb +54 -52
  206. data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +64 -65
  207. data/lib/twilio-ruby/rest/wireless/v1/sim.rb +147 -141
  208. data/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb +34 -28
  209. data/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb +32 -32
  210. data/lib/twilio-ruby/rest/wireless/v1/usage_record.rb +19 -19
  211. data/lib/twilio-ruby/version.rb +1 -1
  212. data/spec/integration/api/v2010/account/call_spec.rb +45 -0
  213. data/spec/integration/api/v2010/account/message_spec.rb +37 -0
  214. data/spec/integration/conversations/v1/conversation/message_spec.rb +5 -0
  215. data/spec/integration/conversations/v1/conversation/participant_spec.rb +8 -10
  216. data/spec/integration/conversations/v1/conversation_spec.rb +4 -0
  217. data/spec/integration/flex_api/v1/configuration_spec.rb +24 -0
  218. data/spec/integration/preview/trusted_comms/branded_call_spec.rb +1 -0
  219. data/spec/integration/verify/v2/service/verification_spec.rb +1 -1
  220. metadata +2 -2
@@ -108,42 +108,41 @@ module Twilio
108
108
  ##
109
109
  # Retrieve a single page of RatePlanInstance records from the API.
110
110
  # Request is executed immediately.
111
- # @param [String] unique_name A user-provided string that uniquely identifies this
112
- # resource as an alternative to the Sid.
113
- # @param [String] friendly_name A user-provided string that identifies this
114
- # resource. Non-unique.
115
- # @param [Boolean] data_enabled Defines whether SIMs are capable of using
116
- # GPRS/3G/LTE data connectivity.
117
- # @param [String] data_limit Network-enforced limit specifying the total Megabytes
118
- # of data usage (download and upload combined) allowed during one month on the
119
- # 'home' (T-Mobile USA) network. Metering begins on the day of activation and ends
120
- # on the same day of the following month. Max value is 2TB. Default value is
111
+ # @param [String] unique_name An application-defined string that uniquely
112
+ # identifies the resource. It can be used in place of the resource's `sid` in the
113
+ # URL to address the resource.
114
+ # @param [String] friendly_name A descriptive string that you create to describe
115
+ # the resource. It does not have to be unique.
116
+ # @param [Boolean] data_enabled Whether SIMs can use GPRS/3G/4G/LTE data
117
+ # connectivity.
118
+ # @param [String] data_limit The total data usage (download and upload combined)
119
+ # in Megabytes that the Network allows during one month on the home network
120
+ # (T-Mobile USA). The metering period begins the day of activation and ends on the
121
+ # same day in the following month. Can be up to 2TB and the default value is
121
122
  # `1000`.
122
- # @param [String] data_metering The model by which to meter data usage, in
123
- # accordance with the available [data metering
124
- # models](https://www.twilio.com/docs/wireless/api/rate-plan#payg-vs-quota-data-plans). Valid options are `payg` and `quota-1`, `quota-10`, and `quota-50`. Defaults to `payg`.
125
- # @param [Boolean] messaging_enabled Defines whether SIMs are capable of making
126
- # and sending and receiving SMS messages via either
127
- # [Commands](https://www.twilio.com/docs/wireless/api/commands) or Programmable
128
- # SMS APIs.
129
- # @param [Boolean] voice_enabled Defines whether SIMs are capable of making and
130
- # receiving voice calls.
131
- # @param [Boolean] national_roaming_enabled Defines whether SIMs can roam onto
132
- # networks other than the 'home' (T-Mobile USA) network in the United States. See
133
- # ['national'
134
- # roaming](https://www.twilio.com/docs/api/wireless/rest-api/rate-plan#national-roaming).
135
- # @param [String] international_roaming Defines whether SIMs are capable of using
136
- # GPRS/3G/4G/LTE data connectivity and messaging outside of the United States.
137
- # Acceptable values are `data` and `messaging`.
138
- # @param [String] national_roaming_data_limit Network-enforced limit specifying
139
- # the total Megabytes of national roaming data usage (download and upload
140
- # combined) allowed during one month on networks in the United States other than
141
- # the 'home' (T-Mobile USA) network. See ['national'
142
- # roaming](https://www.twilio.com/docs/api/wireless/rest-api/rate-plan#national-roaming). Max value is 2TB.
143
- # @param [String] international_roaming_data_limit Network-enforced limit
144
- # specifying the total Megabytes of international roaming (non-US) data usage
145
- # (download and upload combined) allowed during one month. Max value is 2TB.
146
- # Default value is the lesser of `DataLimit` and `1000`MB.
123
+ # @param [String] data_metering The model used to meter data usage. Can be: `payg`
124
+ # and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data
125
+ # metering
126
+ # models](https://www.twilio.com/docs/wireless/api/rate-plan#payg-vs-quota-data-plans).
127
+ # @param [Boolean] messaging_enabled Whether SIMs can make, send, and receive SMS
128
+ # using [Commands](https://www.twilio.com/docs/wireless/api/commands).
129
+ # @param [Boolean] voice_enabled Whether SIMs can make and receive voice calls.
130
+ # @param [Boolean] national_roaming_enabled Whether SIMs can roam on networks
131
+ # other than the home network (T-Mobile USA) in the United States. See [national
132
+ # roaming](https://www.twilio.com/docs/wireless/api/rate-plan#national-roaming).
133
+ # @param [String] international_roaming The list of services that SIMs capable of
134
+ # using GPRS/3G/4G/LTE data connectivity can use outside of the United States. Can
135
+ # be: `data`, `voice`, and `messaging`.
136
+ # @param [String] national_roaming_data_limit The total data usage (download and
137
+ # upload combined) in Megabytes that the Network allows during one month on
138
+ # non-home networks in the United States. The metering period begins the day of
139
+ # activation and ends on the same day in the following month. Can be up to 2TB.
140
+ # See [national
141
+ # roaming](https://www.twilio.com/docs/wireless/api/rate-plan#national-roaming)
142
+ # for more info.
143
+ # @param [String] international_roaming_data_limit The total data usage (download
144
+ # and upload combined) in Megabytes that the Network allows during one month when
145
+ # roaming outside the United States. Can be up to 2TB.
147
146
  # @return [RatePlanInstance] Newly created RatePlanInstance
148
147
  def create(unique_name: :unset, friendly_name: :unset, data_enabled: :unset, data_limit: :unset, data_metering: :unset, messaging_enabled: :unset, voice_enabled: :unset, national_roaming_enabled: :unset, international_roaming: :unset, national_roaming_data_limit: :unset, international_roaming_data_limit: :unset)
149
148
  data = Twilio::Values.of({
@@ -209,8 +208,7 @@ module Twilio
209
208
  ##
210
209
  # Initialize the RatePlanContext
211
210
  # @param [Version] version Version that contains the resource
212
- # @param [String] sid A 34 character string that uniquely identifies this
213
- # resource.
211
+ # @param [String] sid The SID of the RatePlan resource to fetch.
214
212
  # @return [RatePlanContext] RatePlanContext
215
213
  def initialize(version, sid)
216
214
  super(version)
@@ -237,10 +235,11 @@ module Twilio
237
235
 
238
236
  ##
239
237
  # Update the RatePlanInstance
240
- # @param [String] unique_name A user-provided string that uniquely identifies this
241
- # resource as an alternative to the Sid.
242
- # @param [String] friendly_name A user-provided string that identifies this
243
- # resource. Non-unique.
238
+ # @param [String] unique_name An application-defined string that uniquely
239
+ # identifies the resource. It can be used in place of the resource's `sid` in the
240
+ # URL to address the resource.
241
+ # @param [String] friendly_name A descriptive string that you create to describe
242
+ # the resource. It does not have to be unique.
244
243
  # @return [RatePlanInstance] Updated RatePlanInstance
245
244
  def update(unique_name: :unset, friendly_name: :unset)
246
245
  data = Twilio::Values.of({'UniqueName' => unique_name, 'FriendlyName' => friendly_name, })
@@ -256,7 +255,7 @@ module Twilio
256
255
 
257
256
  ##
258
257
  # Deletes the RatePlanInstance
259
- # @return [Boolean] true if delete succeeds, true otherwise
258
+ # @return [Boolean] true if delete succeeds, false otherwise
260
259
  def delete
261
260
  @version.delete('delete', @uri)
262
261
  end
@@ -281,8 +280,7 @@ module Twilio
281
280
  # Initialize the RatePlanInstance
282
281
  # @param [Version] version Version that contains the resource
283
282
  # @param [Hash] payload payload that contains response from Twilio
284
- # @param [String] sid A 34 character string that uniquely identifies this
285
- # resource.
283
+ # @param [String] sid The SID of the RatePlan resource to fetch.
286
284
  # @return [RatePlanInstance] RatePlanInstance
287
285
  def initialize(version, payload, sid: nil)
288
286
  super(version)
@@ -324,97 +322,97 @@ module Twilio
324
322
  end
325
323
 
326
324
  ##
327
- # @return [String] A 34 character string that uniquely identifies this resource.
325
+ # @return [String] The unique string that identifies the resource
328
326
  def sid
329
327
  @properties['sid']
330
328
  end
331
329
 
332
330
  ##
333
- # @return [String] A user-provided string that uniquely identifies this resource as an alternative to the sid.
331
+ # @return [String] An application-defined string that uniquely identifies the resource
334
332
  def unique_name
335
333
  @properties['unique_name']
336
334
  end
337
335
 
338
336
  ##
339
- # @return [String] The unique id of the Account that this Rate Plan belongs to.
337
+ # @return [String] The SID of the Account that created the resource
340
338
  def account_sid
341
339
  @properties['account_sid']
342
340
  end
343
341
 
344
342
  ##
345
- # @return [String] A user-provided string that identifies this resource.
343
+ # @return [String] The string that you assigned to describe the resource
346
344
  def friendly_name
347
345
  @properties['friendly_name']
348
346
  end
349
347
 
350
348
  ##
351
- # @return [Boolean] Defines whether SIMs are capable of using GPRS/3G/4G/LTE data connectivity.
349
+ # @return [Boolean] Whether SIMs can use GPRS/3G/4G/LTE data connectivity
352
350
  def data_enabled
353
351
  @properties['data_enabled']
354
352
  end
355
353
 
356
354
  ##
357
- # @return [String] The model by which to meter data usage, in accordance with the available data metering models.
355
+ # @return [String] The model used to meter data usage
358
356
  def data_metering
359
357
  @properties['data_metering']
360
358
  end
361
359
 
362
360
  ##
363
- # @return [String] Network-enforced limit specifying the total Megabytes of data usage allowed during one month on the 'home' (T-Mobile USA) network.
361
+ # @return [String] The total data usage in Megabytes that the Network allows during one month on the home network
364
362
  def data_limit
365
363
  @properties['data_limit']
366
364
  end
367
365
 
368
366
  ##
369
- # @return [Boolean] Defines whether SIMs are capable of making and sending and receiving SMS via Commands.
367
+ # @return [Boolean] Whether SIMs can make, send, and receive SMS using Commands
370
368
  def messaging_enabled
371
369
  @properties['messaging_enabled']
372
370
  end
373
371
 
374
372
  ##
375
- # @return [Boolean] Defines whether SIMs are capable of making and receiving voice calls.
373
+ # @return [Boolean] Whether SIMs can make and receive voice calls
376
374
  def voice_enabled
377
375
  @properties['voice_enabled']
378
376
  end
379
377
 
380
378
  ##
381
- # @return [Boolean] Defines whether SIMs can roam onto networks other than the 'home' (T-Mobile USA) network in the United States.
379
+ # @return [Boolean] Whether SIMs can roam on networks other than the home network in the United States
382
380
  def national_roaming_enabled
383
381
  @properties['national_roaming_enabled']
384
382
  end
385
383
 
386
384
  ##
387
- # @return [String] Network-enforced limit specifying the total Megabytes of 'national roaming' data usage allowed during one month on networks in the United States other than the 'home' (T-Mobile USA) network.
385
+ # @return [String] The total data usage in Megabytes that the Network allows during one month on non-home networks in the United States
388
386
  def national_roaming_data_limit
389
387
  @properties['national_roaming_data_limit']
390
388
  end
391
389
 
392
390
  ##
393
- # @return [String] Defines whether SIMs are capable of using GPRS/3G/4G/LTE data connectivity and messaging outside of the United States.
391
+ # @return [String] The services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States
394
392
  def international_roaming
395
393
  @properties['international_roaming']
396
394
  end
397
395
 
398
396
  ##
399
- # @return [String] Network-enforced limit specifying the total Megabytes of 'international roaming' (non-US) data usage (download and upload combined) allowed during one month.
397
+ # @return [String] The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States
400
398
  def international_roaming_data_limit
401
399
  @properties['international_roaming_data_limit']
402
400
  end
403
401
 
404
402
  ##
405
- # @return [Time] The date that this resource was created, given as GMT in ISO 8601 format.
403
+ # @return [Time] The date when the resource was created, given as GMT in ISO 8601 format
406
404
  def date_created
407
405
  @properties['date_created']
408
406
  end
409
407
 
410
408
  ##
411
- # @return [Time] The date that this resource was last updated, given as GMT in ISO 8601 format.
409
+ # @return [Time] The date when the resource was last updated, given as GMT in ISO 8601 format
412
410
  def date_updated
413
411
  @properties['date_updated']
414
412
  end
415
413
 
416
414
  ##
417
- # @return [String] The URL for this resource.
415
+ # @return [String] The absolute URL of the resource
418
416
  def url
419
417
  @properties['url']
420
418
  end
@@ -428,10 +426,11 @@ module Twilio
428
426
 
429
427
  ##
430
428
  # Update the RatePlanInstance
431
- # @param [String] unique_name A user-provided string that uniquely identifies this
432
- # resource as an alternative to the Sid.
433
- # @param [String] friendly_name A user-provided string that identifies this
434
- # resource. Non-unique.
429
+ # @param [String] unique_name An application-defined string that uniquely
430
+ # identifies the resource. It can be used in place of the resource's `sid` in the
431
+ # URL to address the resource.
432
+ # @param [String] friendly_name A descriptive string that you create to describe
433
+ # the resource. It does not have to be unique.
435
434
  # @return [RatePlanInstance] Updated RatePlanInstance
436
435
  def update(unique_name: :unset, friendly_name: :unset)
437
436
  context.update(unique_name: unique_name, friendly_name: friendly_name, )
@@ -439,7 +438,7 @@ module Twilio
439
438
 
440
439
  ##
441
440
  # Deletes the RatePlanInstance
442
- # @return [Boolean] true if delete succeeds, true otherwise
441
+ # @return [Boolean] true if delete succeeds, false otherwise
443
442
  def delete
444
443
  context.delete
445
444
  end
@@ -27,13 +27,15 @@ module Twilio
27
27
  # Lists SimInstance records from the API as a list.
28
28
  # Unlike stream(), this operation is eager and will load `limit` records into
29
29
  # memory before returning.
30
- # @param [sim.Status] status Only return Sims with this status.
31
- # @param [String] iccid Return Sims with this Iccid. Currently this should be a
32
- # list with maximum size 1.
33
- # @param [String] rate_plan Only return Sims with this Rate Plan.
34
- # @param [String] e_id Only return Sims with this EID.
35
- # @param [String] sim_registration_code Only return Sims with this registration
36
- # code.
30
+ # @param [sim.Status] status Only return Sim resources with this status.
31
+ # @param [String] iccid Only return Sim resources with this ICCID. Currently this
32
+ # should be a list with maximum size 1.
33
+ # @param [String] rate_plan The `sid` or `unique_name` of the [RatePlan
34
+ # resource](https://www.twilio.com/docs/wireless/api/rate-plan) used by the Sim
35
+ # resources to read.
36
+ # @param [String] e_id Deprecated.
37
+ # @param [String] sim_registration_code Only return Sim resources with this
38
+ # registration code.
37
39
  # @param [Integer] limit Upper limit for the number of records to return. stream()
38
40
  # guarantees to never return more than limit. Default is no limit
39
41
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -57,13 +59,15 @@ module Twilio
57
59
  # Streams SimInstance records from the API as an Enumerable.
58
60
  # This operation lazily loads records as efficiently as possible until the limit
59
61
  # is reached.
60
- # @param [sim.Status] status Only return Sims with this status.
61
- # @param [String] iccid Return Sims with this Iccid. Currently this should be a
62
- # list with maximum size 1.
63
- # @param [String] rate_plan Only return Sims with this Rate Plan.
64
- # @param [String] e_id Only return Sims with this EID.
65
- # @param [String] sim_registration_code Only return Sims with this registration
66
- # code.
62
+ # @param [sim.Status] status Only return Sim resources with this status.
63
+ # @param [String] iccid Only return Sim resources with this ICCID. Currently this
64
+ # should be a list with maximum size 1.
65
+ # @param [String] rate_plan The `sid` or `unique_name` of the [RatePlan
66
+ # resource](https://www.twilio.com/docs/wireless/api/rate-plan) used by the Sim
67
+ # resources to read.
68
+ # @param [String] e_id Deprecated.
69
+ # @param [String] sim_registration_code Only return Sim resources with this
70
+ # registration code.
67
71
  # @param [Integer] limit Upper limit for the number of records to return. stream()
68
72
  # guarantees to never return more than limit. Default is no limit.
69
73
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -103,13 +107,15 @@ module Twilio
103
107
  ##
104
108
  # Retrieve a single page of SimInstance records from the API.
105
109
  # Request is executed immediately.
106
- # @param [sim.Status] status Only return Sims with this status.
107
- # @param [String] iccid Return Sims with this Iccid. Currently this should be a
108
- # list with maximum size 1.
109
- # @param [String] rate_plan Only return Sims with this Rate Plan.
110
- # @param [String] e_id Only return Sims with this EID.
111
- # @param [String] sim_registration_code Only return Sims with this registration
112
- # code.
110
+ # @param [sim.Status] status Only return Sim resources with this status.
111
+ # @param [String] iccid Only return Sim resources with this ICCID. Currently this
112
+ # should be a list with maximum size 1.
113
+ # @param [String] rate_plan The `sid` or `unique_name` of the [RatePlan
114
+ # resource](https://www.twilio.com/docs/wireless/api/rate-plan) used by the Sim
115
+ # resources to read.
116
+ # @param [String] e_id Deprecated.
117
+ # @param [String] sim_registration_code Only return Sim resources with this
118
+ # registration code.
113
119
  # @param [String] page_token PageToken provided by the API
114
120
  # @param [Integer] page_number Page Number, this value is simply for client state
115
121
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -186,8 +192,7 @@ module Twilio
186
192
  ##
187
193
  # Initialize the SimContext
188
194
  # @param [Version] version Version that contains the resource
189
- # @param [String] sid A 34 character string that uniquely identifies this
190
- # resource.
195
+ # @param [String] sid The SID of the Sim resource to fetch.
191
196
  # @return [SimContext] SimContext
192
197
  def initialize(version, sid)
193
198
  super(version)
@@ -218,51 +223,52 @@ module Twilio
218
223
 
219
224
  ##
220
225
  # Update the SimInstance
221
- # @param [String] unique_name A user-provided string that uniquely identifies this
222
- # resource as an alternative to the `Sid`.
223
- # @param [String] callback_method The HTTP method Twilio will use when making a
224
- # request to the callback URL (valid options are GET or POST). Defaults to POST.
225
- # @param [String] callback_url Twilio will make a request to this URL when the Sim
226
- # has finished updating. In the case of a transition from the Sim's `new` status
227
- # to its `ready` status, or from any status to its `deactivated` status, you will
228
- # receive two callbacks. One when the Sim moves to its intermediary status
229
- # (`ready` or `deactivated`), and a second when it transitions to its final status
230
- # (`active` or `canceled`).
231
- # @param [String] friendly_name A user-provided string that identifies this
232
- # resource. Non-unique.
233
- # @param [String] rate_plan The Sid or UniqueName of the
234
- # [RatePlan](https://www.twilio.com/docs/api/wireless/rest-api/rate-plan) that
235
- # this Sim should use.
236
- # @param [sim.Status] status A string representing the status of the Sim. Valid
237
- # options depend on the current state of the Sim, but may include `ready`,
238
- # `active`, `suspended` or `deactivated`.
239
- # @param [String] commands_callback_method A string representing the HTTP method
240
- # to use when making a request to `CommandsCallbackUrl`. Can be one of `POST` or
241
- # `GET`. Defaults to `POST`.
242
- # @param [String] commands_callback_url The URL that will receive a webhook when
243
- # this Sim originates a
244
- # [Command](https://www.twilio.com/docs/api/wireless/rest-api/command). Your
245
- # server should respond with an HTTP status code in the 200 range; any response
246
- # body will be ignored.
247
- # @param [String] sms_fallback_method The HTTP method Twilio will use when
248
- # requesting the sms_fallback_url. Either `GET` or `POST`.
249
- # @param [String] sms_fallback_url The URL that Twilio will request if an error
250
- # occurs retrieving or executing the TwiML requested by `sms_url`.
251
- # @param [String] sms_method The HTTP method Twilio will use when requesting the
252
- # above Url. Either `GET` or `POST`.
253
- # @param [String] sms_url The URL Twilio will request when the SIM-connected
254
- # device sends an SMS message that is not a
255
- # [Command](https://www.twilio.com/docs/api/wireless/rest-api/command).
256
- # @param [String] voice_fallback_method The HTTP method Twilio will use when
257
- # requesting the voice_fallback_url. Either `GET` or `POST`.
258
- # @param [String] voice_fallback_url The URL that Twilio will request if an error
259
- # occurs retrieving or executing the TwiML requested by `voice_url`.
260
- # @param [String] voice_method The HTTP method Twilio will use when requesting the
261
- # above Url. Either `GET` or `POST`.
262
- # @param [String] voice_url The URL Twilio will request when the SIM-connected
263
- # device makes a call.
264
- # @param [sim.ResetStatus] reset_status Pass `resetting` to initiate a
265
- # connectivity reset on a Sim, this is the only valid value for this parameter.
226
+ # @param [String] unique_name An application-defined string that uniquely
227
+ # identifies the resource. It can be used in place of the `sid` in the URL path to
228
+ # address the resource.
229
+ # @param [String] callback_method The HTTP method we use to call `callback_url`.
230
+ # Can be: `POST` or `GET`, and the default is `POST`.
231
+ # @param [String] callback_url The URL we call using the `callback_url` when the
232
+ # SIM has finished updating. When the SIM transitions from `new` to `ready` or
233
+ # from any status to `deactivated`, we call this URL when the status changes to an
234
+ # intermediate status (`ready` or `deactivated`) and again when the status changes
235
+ # to its final status (`active` or `canceled`).
236
+ # @param [String] friendly_name A descriptive string that you create to describe
237
+ # the resource. It does not need to be unique.
238
+ # @param [String] rate_plan The `sid` or `unique_name` of the [RatePlan
239
+ # resource](https://www.twilio.com/docs/wireless/api/rate-plan) that this SIM
240
+ # should use.
241
+ # @param [sim.Status] status The new status of the resource. Can be: `ready`,
242
+ # `active`, `suspended` or `deactivated`; however the SIM might support additional
243
+ # values.
244
+ # @param [String] commands_callback_method The HTTP method we use to call
245
+ # `commands_callback_url`. Can be: `POST` or `GET`, and the default is `POST`.
246
+ # @param [String] commands_callback_url The URL we call using the
247
+ # `commands_callback_method` when the SIM originates a
248
+ # [Command](https://www.twilio.com/docs/wireless/api/commands). Your server should
249
+ # respond with an HTTP status code in the 200 range; any response body is ignored.
250
+ # @param [String] sms_fallback_method The HTTP method we use to call
251
+ # `sms_fallback_url`. Can be: `GET` or `POST`.
252
+ # @param [String] sms_fallback_url The URL we call using the `sms_fallback_method`
253
+ # when an error occurs while retrieving or executing the TwiML requested from
254
+ # `sms_url`.
255
+ # @param [String] sms_method The HTTP method we use to call `sms_url`. Can be:
256
+ # `GET` or `POST`.
257
+ # @param [String] sms_url The URL we call using the `sms_method` when the
258
+ # SIM-connected device sends an SMS message that is not a
259
+ # [Command](https://www.twilio.com/docs/wireless/api/commands).
260
+ # @param [String] voice_fallback_method The HTTP method we use to call
261
+ # `voice_fallback_url`. Can be: `GET` or `POST`.
262
+ # @param [String] voice_fallback_url The URL we call using the
263
+ # `voice_fallback_method` when an error occurs while retrieving or executing the
264
+ # TwiML requested from `voice_url`.
265
+ # @param [String] voice_method The HTTP method we use when we call `voice_url`.
266
+ # Can be: `GET` or `POST`.
267
+ # @param [String] voice_url The URL we call using the `voice_method` when the
268
+ # SIM-connected device makes a voice call.
269
+ # @param [sim.ResetStatus] reset_status Initiate a connectivity reset on the SIM.
270
+ # Set to `resetting` to initiate a connectivity reset on the SIM. No other value
271
+ # is valid.
266
272
  # @return [SimInstance] Updated SimInstance
267
273
  def update(unique_name: :unset, callback_method: :unset, callback_url: :unset, friendly_name: :unset, rate_plan: :unset, status: :unset, commands_callback_method: :unset, commands_callback_url: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, reset_status: :unset)
268
274
  data = Twilio::Values.of({
@@ -296,7 +302,7 @@ module Twilio
296
302
 
297
303
  ##
298
304
  # Deletes the SimInstance
299
- # @return [Boolean] true if delete succeeds, true otherwise
305
+ # @return [Boolean] true if delete succeeds, false otherwise
300
306
  def delete
301
307
  @version.delete('delete', @uri)
302
308
  end
@@ -345,8 +351,7 @@ module Twilio
345
351
  # Initialize the SimInstance
346
352
  # @param [Version] version Version that contains the resource
347
353
  # @param [Hash] payload payload that contains response from Twilio
348
- # @param [String] sid A 34 character string that uniquely identifies this
349
- # resource.
354
+ # @param [String] sid The SID of the Sim resource to fetch.
350
355
  # @return [SimInstance] SimInstance
351
356
  def initialize(version, payload, sid: nil)
352
357
  super(version)
@@ -396,145 +401,145 @@ module Twilio
396
401
  end
397
402
 
398
403
  ##
399
- # @return [String] A 34 character string that uniquely identifies this resource.
404
+ # @return [String] The unique string that identifies the resource
400
405
  def sid
401
406
  @properties['sid']
402
407
  end
403
408
 
404
409
  ##
405
- # @return [String] A user-provided string that uniquely identifies this resource as an alternative to the sid.
410
+ # @return [String] An application-defined string that uniquely identifies the resource
406
411
  def unique_name
407
412
  @properties['unique_name']
408
413
  end
409
414
 
410
415
  ##
411
- # @return [String] The unique id of the Account that this Sim belongs to.
416
+ # @return [String] The SID of the Account that created the resource
412
417
  def account_sid
413
418
  @properties['account_sid']
414
419
  end
415
420
 
416
421
  ##
417
- # @return [String] The unique ID of the Rate Plan configured for this Sim.
422
+ # @return [String] The SID of the RatePlan resource configured for this SIM
418
423
  def rate_plan_sid
419
424
  @properties['rate_plan_sid']
420
425
  end
421
426
 
422
427
  ##
423
- # @return [String] A user-provided string that identifies this resource.
428
+ # @return [String] The string that you assigned to describe the resource
424
429
  def friendly_name
425
430
  @properties['friendly_name']
426
431
  end
427
432
 
428
433
  ##
429
- # @return [String] The ICCID associated with the SIM.
434
+ # @return [String] The ICCID associated with the SIM
430
435
  def iccid
431
436
  @properties['iccid']
432
437
  end
433
438
 
434
439
  ##
435
- # @return [String] The e_id
440
+ # @return [String] Deprecated
436
441
  def e_id
437
442
  @properties['e_id']
438
443
  end
439
444
 
440
445
  ##
441
- # @return [sim.Status] A string representing the status of the Sim.
446
+ # @return [sim.Status] The status of the SIM
442
447
  def status
443
448
  @properties['status']
444
449
  end
445
450
 
446
451
  ##
447
- # @return [sim.ResetStatus] A string representing the connectivity reset status of the Sim.
452
+ # @return [sim.ResetStatus] The connectivity reset status of the SIM
448
453
  def reset_status
449
454
  @properties['reset_status']
450
455
  end
451
456
 
452
457
  ##
453
- # @return [String] The URL that will receive a webhook when this Sim originates a machine-to-machine Command.
458
+ # @return [String] The URL we call when the SIM originates a machine-to-machine Command
454
459
  def commands_callback_url
455
460
  @properties['commands_callback_url']
456
461
  end
457
462
 
458
463
  ##
459
- # @return [String] A string representing the HTTP method to use when making a request to commands_callback_url.
464
+ # @return [String] The HTTP method we use to call commands_callback_url
460
465
  def commands_callback_method
461
466
  @properties['commands_callback_method']
462
467
  end
463
468
 
464
469
  ##
465
- # @return [String] The HTTP method Twilio will use when requesting the sms_fallback_url.
470
+ # @return [String] The HTTP method we use to call sms_fallback_url
466
471
  def sms_fallback_method
467
472
  @properties['sms_fallback_method']
468
473
  end
469
474
 
470
475
  ##
471
- # @return [String] The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by sms_url.
476
+ # @return [String] The URL we call when an error occurs while retrieving or executing the TwiML requested from the sms_url
472
477
  def sms_fallback_url
473
478
  @properties['sms_fallback_url']
474
479
  end
475
480
 
476
481
  ##
477
- # @return [String] The HTTP method Twilio will use when requesting the above Url.
482
+ # @return [String] The HTTP method we use to call sms_url
478
483
  def sms_method
479
484
  @properties['sms_method']
480
485
  end
481
486
 
482
487
  ##
483
- # @return [String] The URL Twilio will request when the SIM-connected device send an SMS that is not a Command.
488
+ # @return [String] The URL we call when the SIM-connected device sends an SMS message that is not a Command
484
489
  def sms_url
485
490
  @properties['sms_url']
486
491
  end
487
492
 
488
493
  ##
489
- # @return [String] The HTTP method Twilio will use when requesting the voice_fallback_url.
494
+ # @return [String] The HTTP method we use to call voice_fallback_url
490
495
  def voice_fallback_method
491
496
  @properties['voice_fallback_method']
492
497
  end
493
498
 
494
499
  ##
495
- # @return [String] The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by voice_url.
500
+ # @return [String] The URL we call when an error occurs while retrieving or executing the TwiML requested from voice_url
496
501
  def voice_fallback_url
497
502
  @properties['voice_fallback_url']
498
503
  end
499
504
 
500
505
  ##
501
- # @return [String] The HTTP method Twilio will use when requesting the above Url.
506
+ # @return [String] The HTTP method we use to call voice_url
502
507
  def voice_method
503
508
  @properties['voice_method']
504
509
  end
505
510
 
506
511
  ##
507
- # @return [String] The URL Twilio will request when the SIM-connected device makes a call.
512
+ # @return [String] The URL we call when the SIM-connected device makes a voice call
508
513
  def voice_url
509
514
  @properties['voice_url']
510
515
  end
511
516
 
512
517
  ##
513
- # @return [Time] The date that this resource was created, given as GMT in ISO 8601 format.
518
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was created
514
519
  def date_created
515
520
  @properties['date_created']
516
521
  end
517
522
 
518
523
  ##
519
- # @return [Time] The date that this resource was last updated, given as GMT in ISO 8601 format.
524
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
520
525
  def date_updated
521
526
  @properties['date_updated']
522
527
  end
523
528
 
524
529
  ##
525
- # @return [String] The URL for this resource.
530
+ # @return [String] The absolute URL of the resource
526
531
  def url
527
532
  @properties['url']
528
533
  end
529
534
 
530
535
  ##
531
- # @return [String] Each Sim instance resource supports a few subresources, listed here for convenience.
536
+ # @return [String] The URLs of related subresources
532
537
  def links
533
538
  @properties['links']
534
539
  end
535
540
 
536
541
  ##
537
- # @return [String] The ip_address
542
+ # @return [String] Deprecated
538
543
  def ip_address
539
544
  @properties['ip_address']
540
545
  end
@@ -548,51 +553,52 @@ module Twilio
548
553
 
549
554
  ##
550
555
  # Update the SimInstance
551
- # @param [String] unique_name A user-provided string that uniquely identifies this
552
- # resource as an alternative to the `Sid`.
553
- # @param [String] callback_method The HTTP method Twilio will use when making a
554
- # request to the callback URL (valid options are GET or POST). Defaults to POST.
555
- # @param [String] callback_url Twilio will make a request to this URL when the Sim
556
- # has finished updating. In the case of a transition from the Sim's `new` status
557
- # to its `ready` status, or from any status to its `deactivated` status, you will
558
- # receive two callbacks. One when the Sim moves to its intermediary status
559
- # (`ready` or `deactivated`), and a second when it transitions to its final status
560
- # (`active` or `canceled`).
561
- # @param [String] friendly_name A user-provided string that identifies this
562
- # resource. Non-unique.
563
- # @param [String] rate_plan The Sid or UniqueName of the
564
- # [RatePlan](https://www.twilio.com/docs/api/wireless/rest-api/rate-plan) that
565
- # this Sim should use.
566
- # @param [sim.Status] status A string representing the status of the Sim. Valid
567
- # options depend on the current state of the Sim, but may include `ready`,
568
- # `active`, `suspended` or `deactivated`.
569
- # @param [String] commands_callback_method A string representing the HTTP method
570
- # to use when making a request to `CommandsCallbackUrl`. Can be one of `POST` or
571
- # `GET`. Defaults to `POST`.
572
- # @param [String] commands_callback_url The URL that will receive a webhook when
573
- # this Sim originates a
574
- # [Command](https://www.twilio.com/docs/api/wireless/rest-api/command). Your
575
- # server should respond with an HTTP status code in the 200 range; any response
576
- # body will be ignored.
577
- # @param [String] sms_fallback_method The HTTP method Twilio will use when
578
- # requesting the sms_fallback_url. Either `GET` or `POST`.
579
- # @param [String] sms_fallback_url The URL that Twilio will request if an error
580
- # occurs retrieving or executing the TwiML requested by `sms_url`.
581
- # @param [String] sms_method The HTTP method Twilio will use when requesting the
582
- # above Url. Either `GET` or `POST`.
583
- # @param [String] sms_url The URL Twilio will request when the SIM-connected
584
- # device sends an SMS message that is not a
585
- # [Command](https://www.twilio.com/docs/api/wireless/rest-api/command).
586
- # @param [String] voice_fallback_method The HTTP method Twilio will use when
587
- # requesting the voice_fallback_url. Either `GET` or `POST`.
588
- # @param [String] voice_fallback_url The URL that Twilio will request if an error
589
- # occurs retrieving or executing the TwiML requested by `voice_url`.
590
- # @param [String] voice_method The HTTP method Twilio will use when requesting the
591
- # above Url. Either `GET` or `POST`.
592
- # @param [String] voice_url The URL Twilio will request when the SIM-connected
593
- # device makes a call.
594
- # @param [sim.ResetStatus] reset_status Pass `resetting` to initiate a
595
- # connectivity reset on a Sim, this is the only valid value for this parameter.
556
+ # @param [String] unique_name An application-defined string that uniquely
557
+ # identifies the resource. It can be used in place of the `sid` in the URL path to
558
+ # address the resource.
559
+ # @param [String] callback_method The HTTP method we use to call `callback_url`.
560
+ # Can be: `POST` or `GET`, and the default is `POST`.
561
+ # @param [String] callback_url The URL we call using the `callback_url` when the
562
+ # SIM has finished updating. When the SIM transitions from `new` to `ready` or
563
+ # from any status to `deactivated`, we call this URL when the status changes to an
564
+ # intermediate status (`ready` or `deactivated`) and again when the status changes
565
+ # to its final status (`active` or `canceled`).
566
+ # @param [String] friendly_name A descriptive string that you create to describe
567
+ # the resource. It does not need to be unique.
568
+ # @param [String] rate_plan The `sid` or `unique_name` of the [RatePlan
569
+ # resource](https://www.twilio.com/docs/wireless/api/rate-plan) that this SIM
570
+ # should use.
571
+ # @param [sim.Status] status The new status of the resource. Can be: `ready`,
572
+ # `active`, `suspended` or `deactivated`; however the SIM might support additional
573
+ # values.
574
+ # @param [String] commands_callback_method The HTTP method we use to call
575
+ # `commands_callback_url`. Can be: `POST` or `GET`, and the default is `POST`.
576
+ # @param [String] commands_callback_url The URL we call using the
577
+ # `commands_callback_method` when the SIM originates a
578
+ # [Command](https://www.twilio.com/docs/wireless/api/commands). Your server should
579
+ # respond with an HTTP status code in the 200 range; any response body is ignored.
580
+ # @param [String] sms_fallback_method The HTTP method we use to call
581
+ # `sms_fallback_url`. Can be: `GET` or `POST`.
582
+ # @param [String] sms_fallback_url The URL we call using the `sms_fallback_method`
583
+ # when an error occurs while retrieving or executing the TwiML requested from
584
+ # `sms_url`.
585
+ # @param [String] sms_method The HTTP method we use to call `sms_url`. Can be:
586
+ # `GET` or `POST`.
587
+ # @param [String] sms_url The URL we call using the `sms_method` when the
588
+ # SIM-connected device sends an SMS message that is not a
589
+ # [Command](https://www.twilio.com/docs/wireless/api/commands).
590
+ # @param [String] voice_fallback_method The HTTP method we use to call
591
+ # `voice_fallback_url`. Can be: `GET` or `POST`.
592
+ # @param [String] voice_fallback_url The URL we call using the
593
+ # `voice_fallback_method` when an error occurs while retrieving or executing the
594
+ # TwiML requested from `voice_url`.
595
+ # @param [String] voice_method The HTTP method we use when we call `voice_url`.
596
+ # Can be: `GET` or `POST`.
597
+ # @param [String] voice_url The URL we call using the `voice_method` when the
598
+ # SIM-connected device makes a voice call.
599
+ # @param [sim.ResetStatus] reset_status Initiate a connectivity reset on the SIM.
600
+ # Set to `resetting` to initiate a connectivity reset on the SIM. No other value
601
+ # is valid.
596
602
  # @return [SimInstance] Updated SimInstance
597
603
  def update(unique_name: :unset, callback_method: :unset, callback_url: :unset, friendly_name: :unset, rate_plan: :unset, status: :unset, commands_callback_method: :unset, commands_callback_url: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, reset_status: :unset)
598
604
  context.update(
@@ -618,7 +624,7 @@ module Twilio
618
624
 
619
625
  ##
620
626
  # Deletes the SimInstance
621
- # @return [Boolean] true if delete succeeds, true otherwise
627
+ # @return [Boolean] true if delete succeeds, false otherwise
622
628
  def delete
623
629
  context.delete
624
630
  end