twilio-ruby 5.40.1 → 5.40.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGES.md +27 -0
- data/README.md +2 -2
- data/lib/twilio-ruby/framework/version.rb +2 -7
- data/lib/twilio-ruby/rest/conversations.rb +52 -0
- data/lib/twilio-ruby/rest/conversations/v1.rb +88 -1
- data/lib/twilio-ruby/rest/conversations/v1/configuration.rb +258 -0
- data/lib/twilio-ruby/rest/conversations/v1/conversation.rb +15 -4
- data/lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb +19 -10
- data/lib/twilio-ruby/rest/conversations/v1/credential.rb +427 -0
- data/lib/twilio-ruby/rest/conversations/v1/notification.rb +310 -0
- data/lib/twilio-ruby/rest/conversations/v1/role.rb +372 -0
- data/lib/twilio-ruby/rest/conversations/v1/service.rb +442 -0
- data/lib/twilio-ruby/rest/conversations/v1/service/binding.rb +385 -0
- data/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb +259 -0
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb +586 -0
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb +546 -0
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb +388 -0
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb +513 -0
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb +454 -0
- data/lib/twilio-ruby/rest/conversations/v1/service/role.rb +393 -0
- data/lib/twilio-ruby/rest/conversations/v1/service/user.rb +419 -0
- data/lib/twilio-ruby/rest/conversations/v1/user.rb +398 -0
- data/lib/twilio-ruby/rest/events.rb +8 -0
- data/lib/twilio-ruby/rest/events/v1.rb +15 -0
- data/lib/twilio-ruby/rest/events/v1/event_type.rb +291 -0
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance.rb +2 -2
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb +18 -4
- data/lib/twilio-ruby/rest/proxy/v1/service/session.rb +27 -24
- data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb +12 -11
- data/lib/twilio-ruby/rest/serverless/v1/service.rb +13 -13
- data/lib/twilio-ruby/rest/serverless/v1/service/asset.rb +6 -6
- data/lib/twilio-ruby/rest/serverless/v1/service/asset/asset_version.rb +5 -5
- data/lib/twilio-ruby/rest/serverless/v1/service/build.rb +8 -8
- data/lib/twilio-ruby/rest/serverless/v1/service/environment.rb +6 -8
- data/lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb +8 -8
- data/lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb +14 -14
- data/lib/twilio-ruby/rest/serverless/v1/service/function.rb +4 -4
- data/lib/twilio-ruby/rest/serverless/v1/service/function/function_version.rb +7 -7
- data/lib/twilio-ruby/rest/serverless/v1/service/function/function_version/function_version_content.rb +1 -1
- data/lib/twilio-ruby/rest/supersim/v1/sim.rb +17 -7
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb +2 -1
- data/lib/twilio-ruby/version.rb +1 -1
- data/spec/framework/version_spec.rb +42 -0
- data/spec/holodeck/holodeck.rb +3 -3
- data/spec/integration/conversations/v1/configuration_spec.rb +85 -0
- data/spec/integration/conversations/v1/conversation/message/delivery_receipt_spec.rb +4 -0
- data/spec/integration/conversations/v1/conversation/participant_spec.rb +6 -6
- data/spec/integration/conversations/v1/conversation_spec.rb +5 -0
- data/spec/integration/conversations/v1/credential_spec.rb +219 -0
- data/spec/integration/conversations/v1/notification_spec.rb +107 -0
- data/spec/integration/conversations/v1/role_spec.rb +249 -0
- data/spec/integration/conversations/v1/service/binding_spec.rb +166 -0
- data/spec/integration/conversations/v1/service/configuration_spec.rb +87 -0
- data/spec/integration/conversations/v1/service/conversation/message/delivery_receipt_spec.rb +144 -0
- data/spec/integration/conversations/v1/service/conversation/message_spec.rb +429 -0
- data/spec/integration/conversations/v1/service/conversation/participant_spec.rb +407 -0
- data/spec/integration/conversations/v1/service/conversation/webhook_spec.rb +299 -0
- data/spec/integration/conversations/v1/service/conversation_spec.rb +289 -0
- data/spec/integration/conversations/v1/service/role_spec.rb +260 -0
- data/spec/integration/conversations/v1/service/user_spec.rb +230 -0
- data/spec/integration/conversations/v1/service_spec.rb +174 -0
- data/spec/integration/conversations/v1/user_spec.rb +220 -0
- data/spec/integration/events/v1/event_type_spec.rb +133 -0
- data/spec/integration/numbers/v2/regulatory_compliance/supporting_document_spec.rb +27 -0
- data/spec/integration/supersim/v1/sim_spec.rb +23 -0
- metadata +50 -2
@@ -95,8 +95,8 @@ module Twilio
|
|
95
95
|
|
96
96
|
##
|
97
97
|
# Access the supporting_documents
|
98
|
-
# @param [String] sid The unique string
|
99
|
-
# Document resource.
|
98
|
+
# @param [String] sid The unique string created by Twilio to identify the
|
99
|
+
# Supporting Document resource.
|
100
100
|
# @return [SupportingDocumentList]
|
101
101
|
# @return [SupportingDocumentContext] if sid was passed.
|
102
102
|
def supporting_documents(sid=:unset)
|
@@ -164,8 +164,8 @@ module Twilio
|
|
164
164
|
##
|
165
165
|
# Initialize the SupportingDocumentContext
|
166
166
|
# @param [Version] version Version that contains the resource
|
167
|
-
# @param [String] sid The unique string
|
168
|
-
# Document resource.
|
167
|
+
# @param [String] sid The unique string created by Twilio to identify the
|
168
|
+
# Supporting Document resource.
|
169
169
|
# @return [SupportingDocumentContext] SupportingDocumentContext
|
170
170
|
def initialize(version, sid)
|
171
171
|
super(version)
|
@@ -202,6 +202,13 @@ module Twilio
|
|
202
202
|
SupportingDocumentInstance.new(@version, payload, sid: @solution[:sid], )
|
203
203
|
end
|
204
204
|
|
205
|
+
##
|
206
|
+
# Delete the SupportingDocumentInstance
|
207
|
+
# @return [Boolean] true if delete succeeds, false otherwise
|
208
|
+
def delete
|
209
|
+
@version.delete('DELETE', @uri)
|
210
|
+
end
|
211
|
+
|
205
212
|
##
|
206
213
|
# Provide a user friendly representation
|
207
214
|
def to_s
|
@@ -222,8 +229,8 @@ module Twilio
|
|
222
229
|
# Initialize the SupportingDocumentInstance
|
223
230
|
# @param [Version] version Version that contains the resource
|
224
231
|
# @param [Hash] payload payload that contains response from Twilio
|
225
|
-
# @param [String] sid The unique string
|
226
|
-
# Document resource.
|
232
|
+
# @param [String] sid The unique string created by Twilio to identify the
|
233
|
+
# Supporting Document resource.
|
227
234
|
# @return [SupportingDocumentInstance] SupportingDocumentInstance
|
228
235
|
def initialize(version, payload, sid: nil)
|
229
236
|
super(version)
|
@@ -336,6 +343,13 @@ module Twilio
|
|
336
343
|
context.update(friendly_name: friendly_name, attributes: attributes, )
|
337
344
|
end
|
338
345
|
|
346
|
+
##
|
347
|
+
# Delete the SupportingDocumentInstance
|
348
|
+
# @return [Boolean] true if delete succeeds, false otherwise
|
349
|
+
def delete
|
350
|
+
context.delete
|
351
|
+
end
|
352
|
+
|
339
353
|
##
|
340
354
|
# Provide a user friendly representation
|
341
355
|
def to_s
|
@@ -127,17 +127,18 @@ module Twilio
|
|
127
127
|
# on create.
|
128
128
|
# @param [Hash] participants The Participant objects to include in the new
|
129
129
|
# session.
|
130
|
-
# @param [Boolean] fail_on_participant_conflict [Experimental]
|
131
|
-
#
|
130
|
+
# @param [Boolean] fail_on_participant_conflict [Experimental] For accounts with
|
131
|
+
# the ProxyAllowParticipantConflict account flag, setting to true enables
|
132
|
+
# per-request opt-in to allowing Proxy to reject a Session create (with
|
132
133
|
# Participants) request that could cause the same Identifier/ProxyIdentifier pair
|
133
134
|
# to be active in multiple Sessions. Depending on the context, this could be a 409
|
134
135
|
# error (Twilio error code 80623) or a 400 error (Twilio error code 80604). If not
|
135
|
-
# provided,
|
136
|
-
#
|
137
|
-
#
|
138
|
-
# Participants to be routed incorrectly. Please note,
|
139
|
-
#
|
140
|
-
#
|
136
|
+
# provided, requests will be allowed to succeed and a Debugger notification
|
137
|
+
# (80802) will be emitted. Having multiple, active Participants with the same
|
138
|
+
# Identifier/ProxyIdentifier pair causes calls and messages from affected
|
139
|
+
# Participants to be routed incorrectly. Please note, the default behavior for
|
140
|
+
# accounts without the ProxyAllowParticipantConflict flag is to reject the request
|
141
|
+
# as described. This will eventually be the default for all accounts.
|
141
142
|
# @return [SessionInstance] Created SessionInstance
|
142
143
|
def create(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset, fail_on_participant_conflict: :unset)
|
143
144
|
data = Twilio::Values.of({
|
@@ -242,16 +243,17 @@ module Twilio
|
|
242
243
|
# is measured from the last Session create or the Session's last Interaction.
|
243
244
|
# @param [session.Status] status The new status of the resource. Can be:
|
244
245
|
# `in-progress` to re-open a session or `closed` to close a session.
|
245
|
-
# @param [Boolean] fail_on_participant_conflict [Experimental]
|
246
|
-
#
|
246
|
+
# @param [Boolean] fail_on_participant_conflict [Experimental] For accounts with
|
247
|
+
# the ProxyAllowParticipantConflict account flag, setting to true enables
|
248
|
+
# per-request opt-in to allowing Proxy to return a 400 error (Twilio error code
|
247
249
|
# 80604) when a request to set a Session to in-progress would cause Participants
|
248
250
|
# with the same Identifier/ProxyIdentifier pair to be active in multiple Sessions.
|
249
|
-
# If not provided,
|
250
|
-
#
|
251
|
-
#
|
252
|
-
#
|
253
|
-
#
|
254
|
-
#
|
251
|
+
# If not provided, requests will be allowed to succeed, and a Debugger
|
252
|
+
# notification (80801) will be emitted. Having multiple, active Participants with
|
253
|
+
# the same Identifier/ProxyIdentifier pair causes calls and messages from affected
|
254
|
+
# Participants to be routed incorrectly. Please note, the default behavior for
|
255
|
+
# accounts without the ProxyAllowParticipantConflict flag is to reject the request
|
256
|
+
# as described. This will eventually be the default for all accounts.
|
255
257
|
# @return [SessionInstance] Updated SessionInstance
|
256
258
|
def update(date_expiry: :unset, ttl: :unset, status: :unset, fail_on_participant_conflict: :unset)
|
257
259
|
data = Twilio::Values.of({
|
@@ -496,16 +498,17 @@ module Twilio
|
|
496
498
|
# is measured from the last Session create or the Session's last Interaction.
|
497
499
|
# @param [session.Status] status The new status of the resource. Can be:
|
498
500
|
# `in-progress` to re-open a session or `closed` to close a session.
|
499
|
-
# @param [Boolean] fail_on_participant_conflict [Experimental]
|
500
|
-
#
|
501
|
+
# @param [Boolean] fail_on_participant_conflict [Experimental] For accounts with
|
502
|
+
# the ProxyAllowParticipantConflict account flag, setting to true enables
|
503
|
+
# per-request opt-in to allowing Proxy to return a 400 error (Twilio error code
|
501
504
|
# 80604) when a request to set a Session to in-progress would cause Participants
|
502
505
|
# with the same Identifier/ProxyIdentifier pair to be active in multiple Sessions.
|
503
|
-
# If not provided,
|
504
|
-
#
|
505
|
-
#
|
506
|
-
#
|
507
|
-
#
|
508
|
-
#
|
506
|
+
# If not provided, requests will be allowed to succeed, and a Debugger
|
507
|
+
# notification (80801) will be emitted. Having multiple, active Participants with
|
508
|
+
# the same Identifier/ProxyIdentifier pair causes calls and messages from affected
|
509
|
+
# Participants to be routed incorrectly. Please note, the default behavior for
|
510
|
+
# accounts without the ProxyAllowParticipantConflict flag is to reject the request
|
511
|
+
# as described. This will eventually be the default for all accounts.
|
509
512
|
# @return [SessionInstance] Updated SessionInstance
|
510
513
|
def update(date_expiry: :unset, ttl: :unset, status: :unset, fail_on_participant_conflict: :unset)
|
511
514
|
context.update(
|
@@ -121,17 +121,18 @@ module Twilio
|
|
121
121
|
# Participant. If not specified, Proxy will select a number from the pool.
|
122
122
|
# @param [String] proxy_identifier_sid The SID of the Proxy Identifier to assign
|
123
123
|
# to the Participant.
|
124
|
-
# @param [Boolean] fail_on_participant_conflict [Experimental]
|
125
|
-
#
|
126
|
-
#
|
127
|
-
#
|
128
|
-
#
|
129
|
-
#
|
130
|
-
# (80802) will be emitted.
|
131
|
-
#
|
132
|
-
#
|
133
|
-
#
|
134
|
-
#
|
124
|
+
# @param [Boolean] fail_on_participant_conflict [Experimental] For accounts with
|
125
|
+
# the ProxyAllowParticipantConflict account flag, setting to true enables
|
126
|
+
# per-request opt-in to allowing Proxy to reject a Participant create request that
|
127
|
+
# could cause the same Identifier/ProxyIdentifier pair to be active in multiple
|
128
|
+
# Sessions. Depending on the context, this could be a 409 error (Twilio error code
|
129
|
+
# 80623) or a 400 error (Twilio error code 80604). If not provided, requests will
|
130
|
+
# be allowed to succeed and a Debugger notification (80802) will be emitted.
|
131
|
+
# Having multiple, active Participants with the same Identifier/ProxyIdentifier
|
132
|
+
# pair causes calls and messages from affected Participants to be routed
|
133
|
+
# incorrectly. Please note, the default behavior for accounts without the
|
134
|
+
# ProxyAllowParticipantConflict flag is to reject the request as described. This
|
135
|
+
# will eventually be the default for all accounts.
|
135
136
|
# @return [ParticipantInstance] Created ParticipantInstance
|
136
137
|
def create(identifier: nil, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset, fail_on_participant_conflict: :unset)
|
137
138
|
data = Twilio::Values.of({
|
@@ -107,12 +107,12 @@ module Twilio
|
|
107
107
|
|
108
108
|
##
|
109
109
|
# Create the ServiceInstance
|
110
|
-
# @param [String] unique_name
|
111
|
-
#
|
112
|
-
#
|
113
|
-
#
|
110
|
+
# @param [String] unique_name A user-defined string that uniquely identifies the
|
111
|
+
# Service resource. It can be used as an alternative to the `sid` in the URL path
|
112
|
+
# to address the Service resource. This value must be 50 characters or less in
|
113
|
+
# length and be unique.
|
114
114
|
# @param [String] friendly_name A descriptive string that you create to describe
|
115
|
-
# the Service resource. It can be
|
115
|
+
# the Service resource. It can be a maximum of 255 characters.
|
116
116
|
# @param [Boolean] include_credentials Whether to inject Account credentials into
|
117
117
|
# a function invocation context. The default value is `false`.
|
118
118
|
# @param [Boolean] ui_editable Whether the Service's properties and subresources
|
@@ -212,9 +212,9 @@ module Twilio
|
|
212
212
|
# @param [Boolean] include_credentials Whether to inject Account credentials into
|
213
213
|
# a function invocation context.
|
214
214
|
# @param [String] friendly_name A descriptive string that you create to describe
|
215
|
-
# the Service resource. It can be
|
216
|
-
# @param [Boolean] ui_editable Whether the Service's properties and
|
217
|
-
# can be edited via the UI. The default value is `false`.
|
215
|
+
# the Service resource. It can be a maximum of 255 characters.
|
216
|
+
# @param [Boolean] ui_editable Whether the Service resource's properties and
|
217
|
+
# subresources can be edited via the UI. The default value is `false`.
|
218
218
|
# @return [ServiceInstance] Updated ServiceInstance
|
219
219
|
def update(include_credentials: :unset, friendly_name: :unset, ui_editable: :unset)
|
220
220
|
data = Twilio::Values.of({
|
@@ -376,7 +376,7 @@ module Twilio
|
|
376
376
|
end
|
377
377
|
|
378
378
|
##
|
379
|
-
# @return [String]
|
379
|
+
# @return [String] A user-defined string that uniquely identifies the Service resource
|
380
380
|
def unique_name
|
381
381
|
@properties['unique_name']
|
382
382
|
end
|
@@ -388,7 +388,7 @@ module Twilio
|
|
388
388
|
end
|
389
389
|
|
390
390
|
##
|
391
|
-
# @return [Boolean] Whether the Service's properties and subresources can be edited via the UI
|
391
|
+
# @return [Boolean] Whether the Service resource's properties and subresources can be edited via the UI
|
392
392
|
def ui_editable
|
393
393
|
@properties['ui_editable']
|
394
394
|
end
|
@@ -436,9 +436,9 @@ module Twilio
|
|
436
436
|
# @param [Boolean] include_credentials Whether to inject Account credentials into
|
437
437
|
# a function invocation context.
|
438
438
|
# @param [String] friendly_name A descriptive string that you create to describe
|
439
|
-
# the Service resource. It can be
|
440
|
-
# @param [Boolean] ui_editable Whether the Service's properties and
|
441
|
-
# can be edited via the UI. The default value is `false`.
|
439
|
+
# the Service resource. It can be a maximum of 255 characters.
|
440
|
+
# @param [Boolean] ui_editable Whether the Service resource's properties and
|
441
|
+
# subresources can be edited via the UI. The default value is `false`.
|
442
442
|
# @return [ServiceInstance] Updated ServiceInstance
|
443
443
|
def update(include_credentials: :unset, friendly_name: :unset, ui_editable: :unset)
|
444
444
|
context.update(
|
@@ -111,7 +111,7 @@ module Twilio
|
|
111
111
|
##
|
112
112
|
# Create the AssetInstance
|
113
113
|
# @param [String] friendly_name A descriptive string that you create to describe
|
114
|
-
# the Asset resource. It can be
|
114
|
+
# the Asset resource. It can be a maximum of 255 characters.
|
115
115
|
# @return [AssetInstance] Created AssetInstance
|
116
116
|
def create(friendly_name: nil)
|
117
117
|
data = Twilio::Values.of({'FriendlyName' => friendly_name, })
|
@@ -167,7 +167,7 @@ module Twilio
|
|
167
167
|
# @param [Version] version Version that contains the resource
|
168
168
|
# @param [String] service_sid The SID of the Service to fetch the Asset resource
|
169
169
|
# from.
|
170
|
-
# @param [String] sid The SID
|
170
|
+
# @param [String] sid The SID that identifies the Asset resource to fetch.
|
171
171
|
# @return [AssetContext] AssetContext
|
172
172
|
def initialize(version, service_sid, sid)
|
173
173
|
super(version)
|
@@ -199,7 +199,7 @@ module Twilio
|
|
199
199
|
##
|
200
200
|
# Update the AssetInstance
|
201
201
|
# @param [String] friendly_name A descriptive string that you create to describe
|
202
|
-
# the Asset resource. It can be
|
202
|
+
# the Asset resource. It can be a maximum of 255 characters.
|
203
203
|
# @return [AssetInstance] Updated AssetInstance
|
204
204
|
def update(friendly_name: nil)
|
205
205
|
data = Twilio::Values.of({'FriendlyName' => friendly_name, })
|
@@ -255,7 +255,7 @@ module Twilio
|
|
255
255
|
# @param [Hash] payload payload that contains response from Twilio
|
256
256
|
# @param [String] service_sid The SID of the Service that the Asset resource is
|
257
257
|
# associated with.
|
258
|
-
# @param [String] sid The SID
|
258
|
+
# @param [String] sid The SID that identifies the Asset resource to fetch.
|
259
259
|
# @return [AssetInstance] AssetInstance
|
260
260
|
def initialize(version, payload, service_sid: nil, sid: nil)
|
261
261
|
super(version)
|
@@ -331,7 +331,7 @@ module Twilio
|
|
331
331
|
end
|
332
332
|
|
333
333
|
##
|
334
|
-
# @return [String] The
|
334
|
+
# @return [String] The URLs of the Asset resource's nested resources
|
335
335
|
def links
|
336
336
|
@properties['links']
|
337
337
|
end
|
@@ -353,7 +353,7 @@ module Twilio
|
|
353
353
|
##
|
354
354
|
# Update the AssetInstance
|
355
355
|
# @param [String] friendly_name A descriptive string that you create to describe
|
356
|
-
# the Asset resource. It can be
|
356
|
+
# the Asset resource. It can be a maximum of 255 characters.
|
357
357
|
# @return [AssetInstance] Updated AssetInstance
|
358
358
|
def update(friendly_name: nil)
|
359
359
|
context.update(friendly_name: friendly_name, )
|
@@ -21,7 +21,7 @@ module Twilio
|
|
21
21
|
# @param [String] service_sid The SID of the Service that the Asset Version
|
22
22
|
# resource is associated with.
|
23
23
|
# @param [String] asset_sid The SID of the Asset resource that is the parent of
|
24
|
-
# the
|
24
|
+
# the Asset Version.
|
25
25
|
# @return [AssetVersionList] AssetVersionList
|
26
26
|
def initialize(version, service_sid: nil, asset_sid: nil)
|
27
27
|
super(version)
|
@@ -214,7 +214,7 @@ module Twilio
|
|
214
214
|
# @param [String] service_sid The SID of the Service that the Asset Version
|
215
215
|
# resource is associated with.
|
216
216
|
# @param [String] asset_sid The SID of the Asset resource that is the parent of
|
217
|
-
# the
|
217
|
+
# the Asset Version.
|
218
218
|
# @param [String] sid The SID of the Asset Version resource to fetch.
|
219
219
|
# @return [AssetVersionInstance] AssetVersionInstance
|
220
220
|
def initialize(version, payload, service_sid: nil, asset_sid: nil, sid: nil)
|
@@ -276,19 +276,19 @@ module Twilio
|
|
276
276
|
end
|
277
277
|
|
278
278
|
##
|
279
|
-
# @return [String] The SID of the Asset resource that is the parent of the
|
279
|
+
# @return [String] The SID of the Asset resource that is the parent of the Asset Version
|
280
280
|
def asset_sid
|
281
281
|
@properties['asset_sid']
|
282
282
|
end
|
283
283
|
|
284
284
|
##
|
285
|
-
# @return [String] The URL-friendly string by which the
|
285
|
+
# @return [String] The URL-friendly string by which the Asset Version can be referenced
|
286
286
|
def path
|
287
287
|
@properties['path']
|
288
288
|
end
|
289
289
|
|
290
290
|
##
|
291
|
-
# @return [asset_version.Visibility] The access control that determines how the
|
291
|
+
# @return [asset_version.Visibility] The access control that determines how the Asset Version can be accessed
|
292
292
|
def visibility
|
293
293
|
@properties['visibility']
|
294
294
|
end
|
@@ -111,11 +111,11 @@ module Twilio
|
|
111
111
|
##
|
112
112
|
# Create the BuildInstance
|
113
113
|
# @param [String] asset_versions The list of Asset Version resource SIDs to
|
114
|
-
# include in the
|
115
|
-
# @param [String] function_versions The list of the
|
116
|
-
# include in the
|
114
|
+
# include in the Build.
|
115
|
+
# @param [String] function_versions The list of the Function Version resource SIDs
|
116
|
+
# to include in the Build.
|
117
117
|
# @param [String] dependencies A list of objects that describe the Dependencies
|
118
|
-
# included in the
|
118
|
+
# included in the Build. Each object contains the `name` and `version` of the
|
119
119
|
# dependency.
|
120
120
|
# @return [BuildInstance] Created BuildInstance
|
121
121
|
def create(asset_versions: :unset, function_versions: :unset, dependencies: :unset)
|
@@ -280,25 +280,25 @@ module Twilio
|
|
280
280
|
end
|
281
281
|
|
282
282
|
##
|
283
|
-
# @return [build.Status] The status of the
|
283
|
+
# @return [build.Status] The status of the Build
|
284
284
|
def status
|
285
285
|
@properties['status']
|
286
286
|
end
|
287
287
|
|
288
288
|
##
|
289
|
-
# @return [Hash] The list of Asset Version resource SIDs that are included in the
|
289
|
+
# @return [Hash] The list of Asset Version resource SIDs that are included in the Build
|
290
290
|
def asset_versions
|
291
291
|
@properties['asset_versions']
|
292
292
|
end
|
293
293
|
|
294
294
|
##
|
295
|
-
# @return [Hash] The list of Function Version resource SIDs that are included in the
|
295
|
+
# @return [Hash] The list of Function Version resource SIDs that are included in the Build
|
296
296
|
def function_versions
|
297
297
|
@properties['function_versions']
|
298
298
|
end
|
299
299
|
|
300
300
|
##
|
301
|
-
# @return [Hash] A list of objects that describe the Dependencies included in the
|
301
|
+
# @return [Hash] A list of objects that describe the Dependencies included in the Build
|
302
302
|
def dependencies
|
303
303
|
@properties['dependencies']
|
304
304
|
end
|
@@ -110,12 +110,10 @@ module Twilio
|
|
110
110
|
|
111
111
|
##
|
112
112
|
# Create the EnvironmentInstance
|
113
|
-
# @param [String] unique_name
|
114
|
-
#
|
115
|
-
# `sid` in the URL path to address the Environment resource. This value must have
|
116
|
-
# fewer than 256 characters.
|
113
|
+
# @param [String] unique_name A user-defined string that uniquely identifies the
|
114
|
+
# Environment resource. It can be a maximum of 100 characters.
|
117
115
|
# @param [String] domain_suffix A URL-friendly name that represents the
|
118
|
-
# environment and forms part of the domain name.
|
116
|
+
# environment and forms part of the domain name. It can be a maximum of 16
|
119
117
|
# characters.
|
120
118
|
# @return [EnvironmentInstance] Created EnvironmentInstance
|
121
119
|
def create(unique_name: nil, domain_suffix: :unset)
|
@@ -359,7 +357,7 @@ module Twilio
|
|
359
357
|
end
|
360
358
|
|
361
359
|
##
|
362
|
-
# @return [String]
|
360
|
+
# @return [String] A user-defined string that uniquely identifies the Environment resource
|
363
361
|
def unique_name
|
364
362
|
@properties['unique_name']
|
365
363
|
end
|
@@ -371,7 +369,7 @@ module Twilio
|
|
371
369
|
end
|
372
370
|
|
373
371
|
##
|
374
|
-
# @return [String] The base domain name for all Functions and Assets deployed in the
|
372
|
+
# @return [String] The base domain name for all Functions and Assets deployed in the Environment
|
375
373
|
def domain_name
|
376
374
|
@properties['domain_name']
|
377
375
|
end
|
@@ -395,7 +393,7 @@ module Twilio
|
|
395
393
|
end
|
396
394
|
|
397
395
|
##
|
398
|
-
# @return [String] The URLs of the
|
396
|
+
# @return [String] The URLs of the Environment resource's nested resources
|
399
397
|
def links
|
400
398
|
@properties['links']
|
401
399
|
end
|
@@ -20,7 +20,7 @@ module Twilio
|
|
20
20
|
# @param [Version] version Version that contains the resource
|
21
21
|
# @param [String] service_sid The SID of the Service that the Deployment resource
|
22
22
|
# is associated with.
|
23
|
-
# @param [String] environment_sid The SID of the
|
23
|
+
# @param [String] environment_sid The SID of the Environment for the Deployment.
|
24
24
|
# @return [DeploymentList] DeploymentList
|
25
25
|
def initialize(version, service_sid: nil, environment_sid: nil)
|
26
26
|
super(version)
|
@@ -112,7 +112,7 @@ module Twilio
|
|
112
112
|
|
113
113
|
##
|
114
114
|
# Create the DeploymentInstance
|
115
|
-
# @param [String] build_sid The SID of the
|
115
|
+
# @param [String] build_sid The SID of the Build for the Deployment.
|
116
116
|
# @return [DeploymentInstance] Created DeploymentInstance
|
117
117
|
def create(build_sid: :unset)
|
118
118
|
data = Twilio::Values.of({'BuildSid' => build_sid, })
|
@@ -178,9 +178,9 @@ module Twilio
|
|
178
178
|
# @param [Version] version Version that contains the resource
|
179
179
|
# @param [String] service_sid The SID of the Service to fetch the Deployment
|
180
180
|
# resource from.
|
181
|
-
# @param [String] environment_sid The SID of the
|
181
|
+
# @param [String] environment_sid The SID of the Environment used by the
|
182
182
|
# Deployment to fetch.
|
183
|
-
# @param [String] sid The SID
|
183
|
+
# @param [String] sid The SID that identifies the Deployment resource to fetch.
|
184
184
|
# @return [DeploymentContext] DeploymentContext
|
185
185
|
def initialize(version, service_sid, environment_sid, sid)
|
186
186
|
super(version)
|
@@ -229,8 +229,8 @@ module Twilio
|
|
229
229
|
# @param [Hash] payload payload that contains response from Twilio
|
230
230
|
# @param [String] service_sid The SID of the Service that the Deployment resource
|
231
231
|
# is associated with.
|
232
|
-
# @param [String] environment_sid The SID of the
|
233
|
-
# @param [String] sid The SID
|
232
|
+
# @param [String] environment_sid The SID of the Environment for the Deployment.
|
233
|
+
# @param [String] sid The SID that identifies the Deployment resource to fetch.
|
234
234
|
# @return [DeploymentInstance] DeploymentInstance
|
235
235
|
def initialize(version, payload, service_sid: nil, environment_sid: nil, sid: nil)
|
236
236
|
super(version)
|
@@ -291,13 +291,13 @@ module Twilio
|
|
291
291
|
end
|
292
292
|
|
293
293
|
##
|
294
|
-
# @return [String] The SID of the
|
294
|
+
# @return [String] The SID of the Environment for the Deployment
|
295
295
|
def environment_sid
|
296
296
|
@properties['environment_sid']
|
297
297
|
end
|
298
298
|
|
299
299
|
##
|
300
|
-
# @return [String] The SID of the
|
300
|
+
# @return [String] The SID of the Build for the deployment
|
301
301
|
def build_sid
|
302
302
|
@properties['build_sid']
|
303
303
|
end
|