twilio-ruby 5.27.0 → 5.27.1

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 (115) hide show
  1. checksums.yaml +5 -5
  2. data/.dockerignore +1 -0
  3. data/CHANGES.md +13 -0
  4. data/CONTRIBUTING.md +2 -0
  5. data/Dockerfile +2 -2
  6. data/README.md +2 -2
  7. data/lib/twilio-ruby/http/http_client.rb +1 -1
  8. data/lib/twilio-ruby/rest/api/v2010/account/call.rb +18 -18
  9. data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +9 -9
  10. data/lib/twilio-ruby/rest/api/v2010/account/recording.rb +9 -9
  11. data/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb +5 -5
  12. data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +10 -1
  13. data/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb +1 -1
  14. data/lib/twilio-ruby/rest/fax/v1/fax.rb +12 -12
  15. data/lib/twilio-ruby/rest/flex_api.rb +6 -3
  16. data/lib/twilio-ruby/rest/flex_api/v1.rb +3 -3
  17. data/lib/twilio-ruby/rest/flex_api/v1/channel.rb +23 -23
  18. data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb +39 -37
  19. data/lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb +102 -96
  20. data/lib/twilio-ruby/rest/flex_api/v1/web_channel.rb +20 -20
  21. data/lib/twilio-ruby/rest/messaging.rb +3 -2
  22. data/lib/twilio-ruby/rest/messaging/v1.rb +2 -3
  23. data/lib/twilio-ruby/rest/messaging/v1/service.rb +124 -91
  24. data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +22 -18
  25. data/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb +22 -16
  26. data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +18 -20
  27. data/lib/twilio-ruby/rest/messaging/v1/session.rb +48 -44
  28. data/lib/twilio-ruby/rest/messaging/v1/session/message.rb +46 -48
  29. data/lib/twilio-ruby/rest/messaging/v1/session/participant.rb +55 -62
  30. data/lib/twilio-ruby/rest/messaging/v1/session/webhook.rb +61 -65
  31. data/lib/twilio-ruby/rest/messaging/v1/webhook.rb +30 -36
  32. data/lib/twilio-ruby/rest/monitor.rb +4 -2
  33. data/lib/twilio-ruby/rest/monitor/v1.rb +2 -2
  34. data/lib/twilio-ruby/rest/monitor/v1/alert.rb +45 -57
  35. data/lib/twilio-ruby/rest/monitor/v1/event.rb +47 -50
  36. data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +8 -8
  37. data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +3 -3
  38. data/lib/twilio-ruby/rest/preview/trusted_comms/branded_call.rb +6 -6
  39. data/lib/twilio-ruby/rest/preview/trusted_comms/device.rb +1 -1
  40. data/lib/twilio-ruby/rest/preview/trusted_comms/phone_call.rb +55 -55
  41. data/lib/twilio-ruby/rest/pricing/v2/voice.rb +2 -2
  42. data/lib/twilio-ruby/rest/pricing/v2/voice/country.rb +4 -4
  43. data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb +1 -1
  44. data/lib/twilio-ruby/rest/serverless.rb +2 -1
  45. data/lib/twilio-ruby/rest/serverless/v1.rb +1 -2
  46. data/lib/twilio-ruby/rest/serverless/v1/service.rb +27 -28
  47. data/lib/twilio-ruby/rest/serverless/v1/service/asset.rb +22 -22
  48. data/lib/twilio-ruby/rest/serverless/v1/service/asset/asset_version.rb +22 -22
  49. data/lib/twilio-ruby/rest/serverless/v1/service/build.rb +25 -24
  50. data/lib/twilio-ruby/rest/serverless/v1/service/environment.rb +26 -24
  51. data/lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb +21 -24
  52. data/lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb +31 -31
  53. data/lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb +35 -35
  54. data/lib/twilio-ruby/rest/serverless/v1/service/function.rb +22 -22
  55. data/lib/twilio-ruby/rest/serverless/v1/service/function/function_version.rb +22 -22
  56. data/lib/twilio-ruby/rest/studio/v1/flow/execution.rb +12 -12
  57. data/lib/twilio-ruby/rest/sync/v1/service/document.rb +7 -4
  58. data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +6 -3
  59. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +15 -9
  60. data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +6 -3
  61. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +15 -9
  62. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +9 -6
  63. data/lib/twilio-ruby/rest/taskrouter.rb +2 -1
  64. data/lib/twilio-ruby/rest/taskrouter/v1.rb +1 -1
  65. data/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb +102 -95
  66. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb +52 -44
  67. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb +90 -81
  68. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb +152 -136
  69. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb +35 -29
  70. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb +96 -89
  71. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb +61 -61
  72. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb +27 -21
  73. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb +46 -46
  74. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb +57 -64
  75. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +98 -79
  76. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb +41 -39
  77. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb +39 -33
  78. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb +32 -31
  79. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb +16 -11
  80. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb +42 -42
  81. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb +75 -72
  82. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb +59 -51
  83. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb +24 -18
  84. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb +54 -46
  85. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb +48 -46
  86. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb +17 -17
  87. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_statistics.rb +44 -42
  88. data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +24 -18
  89. data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +3 -3
  90. data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +1 -2
  91. data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +1 -2
  92. data/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb +12 -12
  93. data/lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb +6 -6
  94. data/lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb +6 -6
  95. data/lib/twilio-ruby/rest/verify/v2/service/verification.rb +2 -1
  96. data/lib/twilio-ruby/rest/verify/v2/service/verification_check.rb +2 -1
  97. data/lib/twilio-ruby/rest/video.rb +8 -8
  98. data/lib/twilio-ruby/rest/video/v1.rb +4 -7
  99. data/lib/twilio-ruby/rest/video/v1/composition.rb +89 -98
  100. data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +224 -195
  101. data/lib/twilio-ruby/rest/video/v1/composition_settings.rb +34 -34
  102. data/lib/twilio-ruby/rest/video/v1/recording.rb +53 -55
  103. data/lib/twilio-ruby/rest/video/v1/recording_settings.rb +32 -32
  104. data/lib/twilio-ruby/rest/video/v1/room.rb +71 -61
  105. data/lib/twilio-ruby/rest/video/v1/room/recording.rb +45 -33
  106. data/lib/twilio-ruby/rest/video/v1/room/room_participant.rb +56 -57
  107. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_published_track.rb +25 -22
  108. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb +10 -10
  109. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb +24 -23
  110. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions.rb +1 -1
  111. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb +5 -5
  112. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country/highrisk_special_prefix.rb +2 -2
  113. data/lib/twilio-ruby/version.rb +1 -1
  114. data/spec/integration/conversations/v1/conversation/message_spec.rb +58 -0
  115. metadata +4 -4
@@ -18,10 +18,10 @@ module Twilio
18
18
  ##
19
19
  # Initialize the AssetVersionList
20
20
  # @param [Version] version Version that contains the resource
21
- # @param [String] service_sid The unique SID identifier of the Service for this
22
- # Asset Version.
23
- # @param [String] asset_sid The unique SID identifier of the Asset that is the
24
- # parent for this Asset Version.
21
+ # @param [String] service_sid The SID of the Service that the AssetVersion
22
+ # resource is associated with.
23
+ # @param [String] asset_sid The SID of the Asset resource that is the parent of
24
+ # the asset version.
25
25
  # @return [AssetVersionList] AssetVersionList
26
26
  def initialize(version, service_sid: nil, asset_sid: nil)
27
27
  super(version)
@@ -162,11 +162,11 @@ module Twilio
162
162
  ##
163
163
  # Initialize the AssetVersionContext
164
164
  # @param [Version] version Version that contains the resource
165
- # @param [String] service_sid The unique SID identifier of the Service for this
166
- # Asset Version.
167
- # @param [String] asset_sid The unique SID identifier of the Asset that is the
168
- # parent for this Asset Version.
169
- # @param [String] sid The unique SID identifier of this Asset Version.
165
+ # @param [String] service_sid The SID of the Service to fetch the AssetVersion
166
+ # resource from.
167
+ # @param [String] asset_sid The SID of the Asset resource that is the parent of
168
+ # the AssetVersion resource to fetch.
169
+ # @param [String] sid The SID of the AssetVersion resource to fetch.
170
170
  # @return [AssetVersionContext] AssetVersionContext
171
171
  def initialize(version, service_sid, asset_sid, sid)
172
172
  super(version)
@@ -219,11 +219,11 @@ module Twilio
219
219
  # Initialize the AssetVersionInstance
220
220
  # @param [Version] version Version that contains the resource
221
221
  # @param [Hash] payload payload that contains response from Twilio
222
- # @param [String] service_sid The unique SID identifier of the Service for this
223
- # Asset Version.
224
- # @param [String] asset_sid The unique SID identifier of the Asset that is the
225
- # parent for this Asset Version.
226
- # @param [String] sid The unique SID identifier of this Asset Version.
222
+ # @param [String] service_sid The SID of the Service that the AssetVersion
223
+ # resource is associated with.
224
+ # @param [String] asset_sid The SID of the Asset resource that is the parent of
225
+ # the asset version.
226
+ # @param [String] sid The SID of the AssetVersion resource to fetch.
227
227
  # @return [AssetVersionInstance] AssetVersionInstance
228
228
  def initialize(version, payload, service_sid: nil, asset_sid: nil, sid: nil)
229
229
  super(version)
@@ -266,49 +266,49 @@ module Twilio
266
266
  end
267
267
 
268
268
  ##
269
- # @return [String] Asset Version Sid.
269
+ # @return [String] The unique string that identifies the AssetVersion resource
270
270
  def sid
271
271
  @properties['sid']
272
272
  end
273
273
 
274
274
  ##
275
- # @return [String] Account Sid.
275
+ # @return [String] The SID of the Account that created the AssetVersion resource
276
276
  def account_sid
277
277
  @properties['account_sid']
278
278
  end
279
279
 
280
280
  ##
281
- # @return [String] Service Sid.
281
+ # @return [String] The SID of the Service that the AssetVersion resource is associated with
282
282
  def service_sid
283
283
  @properties['service_sid']
284
284
  end
285
285
 
286
286
  ##
287
- # @return [String] Asset Sid.
287
+ # @return [String] The SID of the Asset resource that is the parent of the asset version
288
288
  def asset_sid
289
289
  @properties['asset_sid']
290
290
  end
291
291
 
292
292
  ##
293
- # @return [String] The URL-friendly string by which this Asset Version can be referenced.
293
+ # @return [String] The URL-friendly string by which the asset version can be referenced
294
294
  def path
295
295
  @properties['path']
296
296
  end
297
297
 
298
298
  ##
299
- # @return [asset_version.Visibility] The access control which determines how the Asset Version can be accessed.
299
+ # @return [asset_version.Visibility] The access control that determines how the asset version can be accessed
300
300
  def visibility
301
301
  @properties['visibility']
302
302
  end
303
303
 
304
304
  ##
305
- # @return [Time] The date that this Asset Version was created.
305
+ # @return [Time] The ISO 8601 date and time in GMT when the AssetVersion resource was created
306
306
  def date_created
307
307
  @properties['date_created']
308
308
  end
309
309
 
310
310
  ##
311
- # @return [String] The URL of this Asset Version.
311
+ # @return [String] The absolute URL of the AssetVersion resource
312
312
  def url
313
313
  @properties['url']
314
314
  end
@@ -17,8 +17,8 @@ module Twilio
17
17
  ##
18
18
  # Initialize the BuildList
19
19
  # @param [Version] version Version that contains the resource
20
- # @param [String] service_sid The unique SID identifier of the Service for this
21
- # Build.
20
+ # @param [String] service_sid The SID of the Service that the Build resource is
21
+ # associated with.
22
22
  # @return [BuildList] BuildList
23
23
  def initialize(version, service_sid: nil)
24
24
  super(version)
@@ -113,12 +113,13 @@ module Twilio
113
113
  ##
114
114
  # Retrieve a single page of BuildInstance records from the API.
115
115
  # Request is executed immediately.
116
- # @param [String] asset_versions The list of Asset Version Sids that are included
117
- # in this Build. Optional.
118
- # @param [String] function_versions The list of Function Version Sids that are
119
- # included in this Build. Optional.
120
- # @param [String] dependencies The list of Dependencies that are included in this
121
- # Build, each described by a `name` and a `version` in a JSON object. Optional.
116
+ # @param [String] asset_versions The list of AssetVersion resource SIDs to include
117
+ # in the build.
118
+ # @param [String] function_versions The list of the Variable resource SIDs to
119
+ # include in the build.
120
+ # @param [String] dependencies A list of objects that describe the Dependencies
121
+ # included in the build. Each object contains the `name` and `version` of the
122
+ # dependency.
122
123
  # @return [BuildInstance] Newly created BuildInstance
123
124
  def create(asset_versions: :unset, function_versions: :unset, dependencies: :unset)
124
125
  data = Twilio::Values.of({
@@ -180,9 +181,9 @@ module Twilio
180
181
  ##
181
182
  # Initialize the BuildContext
182
183
  # @param [Version] version Version that contains the resource
183
- # @param [String] service_sid The unique SID identifier of the Service for this
184
- # Build.
185
- # @param [String] sid The unique SID identifier of this Build.
184
+ # @param [String] service_sid The SID of the Service to fetch the Build resource
185
+ # from.
186
+ # @param [String] sid The SID of the Build resource to fetch.
186
187
  # @return [BuildContext] BuildContext
187
188
  def initialize(version, service_sid, sid)
188
189
  super(version)
@@ -236,9 +237,9 @@ module Twilio
236
237
  # Initialize the BuildInstance
237
238
  # @param [Version] version Version that contains the resource
238
239
  # @param [Hash] payload payload that contains response from Twilio
239
- # @param [String] service_sid The unique SID identifier of the Service for this
240
- # Build.
241
- # @param [String] sid The unique SID identifier of this Build.
240
+ # @param [String] service_sid The SID of the Service that the Build resource is
241
+ # associated with.
242
+ # @param [String] sid The SID of the Build resource to fetch.
242
243
  # @return [BuildInstance] BuildInstance
243
244
  def initialize(version, payload, service_sid: nil, sid: nil)
244
245
  super(version)
@@ -274,61 +275,61 @@ module Twilio
274
275
  end
275
276
 
276
277
  ##
277
- # @return [String] Build Sid.
278
+ # @return [String] The unique string that identifies the Build resource
278
279
  def sid
279
280
  @properties['sid']
280
281
  end
281
282
 
282
283
  ##
283
- # @return [String] Account Sid.
284
+ # @return [String] The SID of the Account that created the Build resource
284
285
  def account_sid
285
286
  @properties['account_sid']
286
287
  end
287
288
 
288
289
  ##
289
- # @return [String] Service Sid.
290
+ # @return [String] The SID of the Service that the Build resource is associated with
290
291
  def service_sid
291
292
  @properties['service_sid']
292
293
  end
293
294
 
294
295
  ##
295
- # @return [build.Status] The current state of the Build.
296
+ # @return [build.Status] The status of the build
296
297
  def status
297
298
  @properties['status']
298
299
  end
299
300
 
300
301
  ##
301
- # @return [Hash] List of Asset Version Sids.
302
+ # @return [Hash] The list of AssetVersion resource SIDs that are included in the build
302
303
  def asset_versions
303
304
  @properties['asset_versions']
304
305
  end
305
306
 
306
307
  ##
307
- # @return [Hash] List of Function Version Sids.
308
+ # @return [Hash] List of the Variable resource SIDs
308
309
  def function_versions
309
310
  @properties['function_versions']
310
311
  end
311
312
 
312
313
  ##
313
- # @return [Hash] List of Dependencies.
314
+ # @return [Hash] A list of objects that describe the Dependencies included in the build
314
315
  def dependencies
315
316
  @properties['dependencies']
316
317
  end
317
318
 
318
319
  ##
319
- # @return [Time] The date that this Build was created.
320
+ # @return [Time] The ISO 8601 date and time in GMT when the Build resource was created
320
321
  def date_created
321
322
  @properties['date_created']
322
323
  end
323
324
 
324
325
  ##
325
- # @return [Time] The date that this Build was updated.
326
+ # @return [Time] The ISO 8601 date and time in GMT when the Build resource was last updated
326
327
  def date_updated
327
328
  @properties['date_updated']
328
329
  end
329
330
 
330
331
  ##
331
- # @return [String] The URL of this Build.
332
+ # @return [String] The absolute URL of the Build resource
332
333
  def url
333
334
  @properties['url']
334
335
  end
@@ -17,8 +17,8 @@ module Twilio
17
17
  ##
18
18
  # Initialize the EnvironmentList
19
19
  # @param [Version] version Version that contains the resource
20
- # @param [String] service_sid The unique SID identifier of the Service for this
21
- # Environment.
20
+ # @param [String] service_sid The SID of the Service that the Environment resource
21
+ # is associated with.
22
22
  # @return [EnvironmentList] EnvironmentList
23
23
  def initialize(version, service_sid: nil)
24
24
  super(version)
@@ -113,11 +113,13 @@ module Twilio
113
113
  ##
114
114
  # Retrieve a single page of EnvironmentInstance records from the API.
115
115
  # Request is executed immediately.
116
- # @param [String] unique_name A unique, addressable name of this Environment,
117
- # fewer than 256 characters. Required.
118
- # @param [String] domain_suffix A URL-friendly name that represents this
119
- # Environment and forms part of the domain name, fewer than 32 characters.
120
- # Required.
116
+ # @param [String] unique_name An application-defined string that uniquely
117
+ # identifies the Environment resource. It can be used as an alternative to the
118
+ # `sid` in the URL path to address the Environment resource. This value must have
119
+ # fewer than 256 characters.
120
+ # @param [String] domain_suffix A URL-friendly name that represents the
121
+ # environment and forms part of the domain name. Must have fewer than 32
122
+ # characters.
121
123
  # @return [EnvironmentInstance] Newly created EnvironmentInstance
122
124
  def create(unique_name: nil, domain_suffix: :unset)
123
125
  data = Twilio::Values.of({'UniqueName' => unique_name, 'DomainSuffix' => domain_suffix, })
@@ -175,9 +177,9 @@ module Twilio
175
177
  ##
176
178
  # Initialize the EnvironmentContext
177
179
  # @param [Version] version Version that contains the resource
178
- # @param [String] service_sid The unique SID identifier of the Service for this
179
- # Environment.
180
- # @param [String] sid The unique SID identifier of this Environment.
180
+ # @param [String] service_sid The SID of the Service to fetch the Environment
181
+ # resource from.
182
+ # @param [String] sid The SID of the Environment resource to fetch.
181
183
  # @return [EnvironmentContext] EnvironmentContext
182
184
  def initialize(version, service_sid, sid)
183
185
  super(version)
@@ -307,9 +309,9 @@ module Twilio
307
309
  # Initialize the EnvironmentInstance
308
310
  # @param [Version] version Version that contains the resource
309
311
  # @param [Hash] payload payload that contains response from Twilio
310
- # @param [String] service_sid The unique SID identifier of the Service for this
311
- # Environment.
312
- # @param [String] sid The unique SID identifier of this Environment.
312
+ # @param [String] service_sid The SID of the Service that the Environment resource
313
+ # is associated with.
314
+ # @param [String] sid The SID of the Environment resource to fetch.
313
315
  # @return [EnvironmentInstance] EnvironmentInstance
314
316
  def initialize(version, payload, service_sid: nil, sid: nil)
315
317
  super(version)
@@ -346,67 +348,67 @@ module Twilio
346
348
  end
347
349
 
348
350
  ##
349
- # @return [String] Environment Sid.
351
+ # @return [String] The unique string that identifies the Environment resource
350
352
  def sid
351
353
  @properties['sid']
352
354
  end
353
355
 
354
356
  ##
355
- # @return [String] Account Sid.
357
+ # @return [String] The SID of the Account that created the Environment resource
356
358
  def account_sid
357
359
  @properties['account_sid']
358
360
  end
359
361
 
360
362
  ##
361
- # @return [String] Service Sid.
363
+ # @return [String] The SID of the Service that the Environment resource is associated with
362
364
  def service_sid
363
365
  @properties['service_sid']
364
366
  end
365
367
 
366
368
  ##
367
- # @return [String] Build Sid.
369
+ # @return [String] The SID of the build deployed in the environment
368
370
  def build_sid
369
371
  @properties['build_sid']
370
372
  end
371
373
 
372
374
  ##
373
- # @return [String] A unique, addressable name of this Environment.
375
+ # @return [String] An application-defined string that uniquely identifies the Environment resource
374
376
  def unique_name
375
377
  @properties['unique_name']
376
378
  end
377
379
 
378
380
  ##
379
- # @return [String] A URL-friendly name that represents this Environment.
381
+ # @return [String] A URL-friendly name that represents the environment
380
382
  def domain_suffix
381
383
  @properties['domain_suffix']
382
384
  end
383
385
 
384
386
  ##
385
- # @return [String] The base domain name for all Functions and Assets deployed in this Environment.
387
+ # @return [String] The base domain name for all Functions and Assets deployed in the environment
386
388
  def domain_name
387
389
  @properties['domain_name']
388
390
  end
389
391
 
390
392
  ##
391
- # @return [Time] The date that this Environment was created.
393
+ # @return [Time] The ISO 8601 date and time in GMT when the Environment resource was created
392
394
  def date_created
393
395
  @properties['date_created']
394
396
  end
395
397
 
396
398
  ##
397
- # @return [Time] The date that this Environment was updated.
399
+ # @return [Time] The ISO 8601 date and time in GMT when the Environment resource was last updated
398
400
  def date_updated
399
401
  @properties['date_updated']
400
402
  end
401
403
 
402
404
  ##
403
- # @return [String] The URL of this Environment.
405
+ # @return [String] The absolute URL of the Environment resource
404
406
  def url
405
407
  @properties['url']
406
408
  end
407
409
 
408
410
  ##
409
- # @return [String] Nested resource URLs.
411
+ # @return [String] The URLs of the environment's nested resources
410
412
  def links
411
413
  @properties['links']
412
414
  end
@@ -18,10 +18,9 @@ module Twilio
18
18
  ##
19
19
  # Initialize the DeploymentList
20
20
  # @param [Version] version Version that contains the resource
21
- # @param [String] service_sid The unique SID identifier of the Service for this
22
- # Deployment.
23
- # @param [String] environment_sid The unique SID identifier of the Environment for
24
- # this Deployment.
21
+ # @param [String] service_sid The SID of the Service that the Deployment resource
22
+ # is associated with.
23
+ # @param [String] environment_sid The SID of the environment for the deployment.
25
24
  # @return [DeploymentList] DeploymentList
26
25
  def initialize(version, service_sid: nil, environment_sid: nil)
27
26
  super(version)
@@ -116,8 +115,7 @@ module Twilio
116
115
  ##
117
116
  # Retrieve a single page of DeploymentInstance records from the API.
118
117
  # Request is executed immediately.
119
- # @param [String] build_sid The unique SID identifier of the Build to be deployed
120
- # for this Deployment. Required.
118
+ # @param [String] build_sid The SID of the build for the deployment.
121
119
  # @return [DeploymentInstance] Newly created DeploymentInstance
122
120
  def create(build_sid: nil)
123
121
  data = Twilio::Values.of({'BuildSid' => build_sid, })
@@ -185,11 +183,11 @@ module Twilio
185
183
  ##
186
184
  # Initialize the DeploymentContext
187
185
  # @param [Version] version Version that contains the resource
188
- # @param [String] service_sid The unique SID identifier of the Service for this
189
- # Deployment.
190
- # @param [String] environment_sid The unique SID identifier of the Environment for
191
- # this Deployment.
192
- # @param [String] sid The unique SID identifier of this Deployment.
186
+ # @param [String] service_sid The SID of the Service to fetch the Deployment
187
+ # resource from.
188
+ # @param [String] environment_sid The SID of the environment used by the
189
+ # Deployment to fetch.
190
+ # @param [String] sid The SID of the Deployment resource to fetch.
193
191
  # @return [DeploymentContext] DeploymentContext
194
192
  def initialize(version, service_sid, environment_sid, sid)
195
193
  super(version)
@@ -242,11 +240,10 @@ module Twilio
242
240
  # Initialize the DeploymentInstance
243
241
  # @param [Version] version Version that contains the resource
244
242
  # @param [Hash] payload payload that contains response from Twilio
245
- # @param [String] service_sid The unique SID identifier of the Service for this
246
- # Deployment.
247
- # @param [String] environment_sid The unique SID identifier of the Environment for
248
- # this Deployment.
249
- # @param [String] sid The unique SID identifier of this Deployment.
243
+ # @param [String] service_sid The SID of the Service that the Deployment resource
244
+ # is associated with.
245
+ # @param [String] environment_sid The SID of the environment for the deployment.
246
+ # @param [String] sid The SID of the Deployment resource to fetch.
250
247
  # @return [DeploymentInstance] DeploymentInstance
251
248
  def initialize(version, payload, service_sid: nil, environment_sid: nil, sid: nil)
252
249
  super(version)
@@ -289,49 +286,49 @@ module Twilio
289
286
  end
290
287
 
291
288
  ##
292
- # @return [String] Deployment Sid.
289
+ # @return [String] The unique string that identifies the Deployment resource
293
290
  def sid
294
291
  @properties['sid']
295
292
  end
296
293
 
297
294
  ##
298
- # @return [String] Account Sid.
295
+ # @return [String] The SID of the Account that created the Deployment resource
299
296
  def account_sid
300
297
  @properties['account_sid']
301
298
  end
302
299
 
303
300
  ##
304
- # @return [String] Service Sid.
301
+ # @return [String] The SID of the Service that the Deployment resource is associated with
305
302
  def service_sid
306
303
  @properties['service_sid']
307
304
  end
308
305
 
309
306
  ##
310
- # @return [String] Environment Sid.
307
+ # @return [String] The SID of the environment for the deployment
311
308
  def environment_sid
312
309
  @properties['environment_sid']
313
310
  end
314
311
 
315
312
  ##
316
- # @return [String] Build Sid.
313
+ # @return [String] The SID of the build for the deployment
317
314
  def build_sid
318
315
  @properties['build_sid']
319
316
  end
320
317
 
321
318
  ##
322
- # @return [Time] The date that this Deployment was created.
319
+ # @return [Time] The ISO 8601 date and time in GMT when the Deployment resource was created
323
320
  def date_created
324
321
  @properties['date_created']
325
322
  end
326
323
 
327
324
  ##
328
- # @return [Time] The date that this Deployment was updated.
325
+ # @return [Time] The ISO 8601 date and time in GMT when the Deployment resource was last updated
329
326
  def date_updated
330
327
  @properties['date_updated']
331
328
  end
332
329
 
333
330
  ##
334
- # @return [String] The URL of this Deployment.
331
+ # @return [String] The absolute URL of the Deployment resource
335
332
  def url
336
333
  @properties['url']
337
334
  end