twilio-ruby 5.22.2 → 5.22.3

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.
@@ -17,7 +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 service_sid
20
+ # @param [String] service_sid The unique SID identifier of the Service for this
21
+ # Environment.
21
22
  # @return [EnvironmentList] EnvironmentList
22
23
  def initialize(version, service_sid: nil)
23
24
  super(version)
@@ -112,8 +113,11 @@ module Twilio
112
113
  ##
113
114
  # Retrieve a single page of EnvironmentInstance records from the API.
114
115
  # Request is executed immediately.
115
- # @param [String] unique_name The unique_name
116
- # @param [String] domain_suffix The domain_suffix
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.
117
121
  # @return [EnvironmentInstance] Newly created EnvironmentInstance
118
122
  def create(unique_name: nil, domain_suffix: :unset)
119
123
  data = Twilio::Values.of({'UniqueName' => unique_name, 'DomainSuffix' => domain_suffix, })
@@ -171,8 +175,9 @@ module Twilio
171
175
  ##
172
176
  # Initialize the EnvironmentContext
173
177
  # @param [Version] version Version that contains the resource
174
- # @param [String] service_sid The service_sid
175
- # @param [String] sid The sid
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.
176
181
  # @return [EnvironmentContext] EnvironmentContext
177
182
  def initialize(version, service_sid, sid)
178
183
  super(version)
@@ -272,8 +277,9 @@ module Twilio
272
277
  # Initialize the EnvironmentInstance
273
278
  # @param [Version] version Version that contains the resource
274
279
  # @param [Hash] payload payload that contains response from Twilio
275
- # @param [String] service_sid The service_sid
276
- # @param [String] sid The sid
280
+ # @param [String] service_sid The unique SID identifier of the Service for this
281
+ # Environment.
282
+ # @param [String] sid The unique SID identifier of this Environment.
277
283
  # @return [EnvironmentInstance] EnvironmentInstance
278
284
  def initialize(version, payload, service_sid: nil, sid: nil)
279
285
  super(version)
@@ -310,67 +316,67 @@ module Twilio
310
316
  end
311
317
 
312
318
  ##
313
- # @return [String] The sid
319
+ # @return [String] Environment Sid.
314
320
  def sid
315
321
  @properties['sid']
316
322
  end
317
323
 
318
324
  ##
319
- # @return [String] The account_sid
325
+ # @return [String] Account Sid.
320
326
  def account_sid
321
327
  @properties['account_sid']
322
328
  end
323
329
 
324
330
  ##
325
- # @return [String] The service_sid
331
+ # @return [String] Service Sid.
326
332
  def service_sid
327
333
  @properties['service_sid']
328
334
  end
329
335
 
330
336
  ##
331
- # @return [String] The build_sid
337
+ # @return [String] Build Sid.
332
338
  def build_sid
333
339
  @properties['build_sid']
334
340
  end
335
341
 
336
342
  ##
337
- # @return [String] The unique_name
343
+ # @return [String] A unique, addressable name of this Environment.
338
344
  def unique_name
339
345
  @properties['unique_name']
340
346
  end
341
347
 
342
348
  ##
343
- # @return [String] The domain_suffix
349
+ # @return [String] A URL-friendly name that represents this Environment.
344
350
  def domain_suffix
345
351
  @properties['domain_suffix']
346
352
  end
347
353
 
348
354
  ##
349
- # @return [String] The domain_name
355
+ # @return [String] The base domain name for all Functions and Assets deployed in this Environment.
350
356
  def domain_name
351
357
  @properties['domain_name']
352
358
  end
353
359
 
354
360
  ##
355
- # @return [Time] The date_created
361
+ # @return [Time] The date that this Environment was created.
356
362
  def date_created
357
363
  @properties['date_created']
358
364
  end
359
365
 
360
366
  ##
361
- # @return [Time] The date_updated
367
+ # @return [Time] The date that this Environment was updated.
362
368
  def date_updated
363
369
  @properties['date_updated']
364
370
  end
365
371
 
366
372
  ##
367
- # @return [String] The url
373
+ # @return [String] The URL of this Environment.
368
374
  def url
369
375
  @properties['url']
370
376
  end
371
377
 
372
378
  ##
373
- # @return [String] The links
379
+ # @return [String] Nested resource URLs.
374
380
  def links
375
381
  @properties['links']
376
382
  end
@@ -18,8 +18,10 @@ 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 service_sid
22
- # @param [String] environment_sid The environment_sid
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.
23
25
  # @return [DeploymentList] DeploymentList
24
26
  def initialize(version, service_sid: nil, environment_sid: nil)
25
27
  super(version)
@@ -114,7 +116,8 @@ module Twilio
114
116
  ##
115
117
  # Retrieve a single page of DeploymentInstance records from the API.
116
118
  # Request is executed immediately.
117
- # @param [String] build_sid The build_sid
119
+ # @param [String] build_sid The unique SID identifier of the Build to be deployed
120
+ # for this Deployment. Required.
118
121
  # @return [DeploymentInstance] Newly created DeploymentInstance
119
122
  def create(build_sid: nil)
120
123
  data = Twilio::Values.of({'BuildSid' => build_sid, })
@@ -182,9 +185,11 @@ module Twilio
182
185
  ##
183
186
  # Initialize the DeploymentContext
184
187
  # @param [Version] version Version that contains the resource
185
- # @param [String] service_sid The service_sid
186
- # @param [String] environment_sid The environment_sid
187
- # @param [String] sid The sid
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.
188
193
  # @return [DeploymentContext] DeploymentContext
189
194
  def initialize(version, service_sid, environment_sid, sid)
190
195
  super(version)
@@ -237,9 +242,11 @@ module Twilio
237
242
  # Initialize the DeploymentInstance
238
243
  # @param [Version] version Version that contains the resource
239
244
  # @param [Hash] payload payload that contains response from Twilio
240
- # @param [String] service_sid The service_sid
241
- # @param [String] environment_sid The environment_sid
242
- # @param [String] sid The sid
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
250
  # @return [DeploymentInstance] DeploymentInstance
244
251
  def initialize(version, payload, service_sid: nil, environment_sid: nil, sid: nil)
245
252
  super(version)
@@ -282,49 +289,49 @@ module Twilio
282
289
  end
283
290
 
284
291
  ##
285
- # @return [String] The sid
292
+ # @return [String] Deployment Sid.
286
293
  def sid
287
294
  @properties['sid']
288
295
  end
289
296
 
290
297
  ##
291
- # @return [String] The account_sid
298
+ # @return [String] Account Sid.
292
299
  def account_sid
293
300
  @properties['account_sid']
294
301
  end
295
302
 
296
303
  ##
297
- # @return [String] The service_sid
304
+ # @return [String] Service Sid.
298
305
  def service_sid
299
306
  @properties['service_sid']
300
307
  end
301
308
 
302
309
  ##
303
- # @return [String] The environment_sid
310
+ # @return [String] Environment Sid.
304
311
  def environment_sid
305
312
  @properties['environment_sid']
306
313
  end
307
314
 
308
315
  ##
309
- # @return [String] The build_sid
316
+ # @return [String] Build Sid.
310
317
  def build_sid
311
318
  @properties['build_sid']
312
319
  end
313
320
 
314
321
  ##
315
- # @return [Time] The date_created
322
+ # @return [Time] The date that this Deployment was created.
316
323
  def date_created
317
324
  @properties['date_created']
318
325
  end
319
326
 
320
327
  ##
321
- # @return [Time] The date_updated
328
+ # @return [Time] The date that this Deployment was updated.
322
329
  def date_updated
323
330
  @properties['date_updated']
324
331
  end
325
332
 
326
333
  ##
327
- # @return [String] The url
334
+ # @return [String] The URL of this Deployment.
328
335
  def url
329
336
  @properties['url']
330
337
  end
@@ -18,8 +18,10 @@ module Twilio
18
18
  ##
19
19
  # Initialize the VariableList
20
20
  # @param [Version] version Version that contains the resource
21
- # @param [String] service_sid The service_sid
22
- # @param [String] environment_sid The environment_sid
21
+ # @param [String] service_sid The unique SID identifier of the Service for this
22
+ # Variable.
23
+ # @param [String] environment_sid The unique SID identifier of the Environment in
24
+ # which this Variable exists.
23
25
  # @return [VariableList] VariableList
24
26
  def initialize(version, service_sid: nil, environment_sid: nil)
25
27
  super(version)
@@ -114,8 +116,10 @@ module Twilio
114
116
  ##
115
117
  # Retrieve a single page of VariableInstance records from the API.
116
118
  # Request is executed immediately.
117
- # @param [String] key The key
118
- # @param [String] value The value
119
+ # @param [String] key A string by which this Variable can be referenced, fewer
120
+ # than 128 characters. Required.
121
+ # @param [String] value A string that contains the actual value of this Variable,
122
+ # less than 450 bytes. Required.
119
123
  # @return [VariableInstance] Newly created VariableInstance
120
124
  def create(key: nil, value: nil)
121
125
  data = Twilio::Values.of({'Key' => key, 'Value' => value, })
@@ -183,9 +187,11 @@ module Twilio
183
187
  ##
184
188
  # Initialize the VariableContext
185
189
  # @param [Version] version Version that contains the resource
186
- # @param [String] service_sid The service_sid
187
- # @param [String] environment_sid The environment_sid
188
- # @param [String] sid The sid
190
+ # @param [String] service_sid The unique SID identifier of the Service for this
191
+ # Variable.
192
+ # @param [String] environment_sid The unique SID identifier of the Environment in
193
+ # which this Variable exists.
194
+ # @param [String] sid The unique SID identifier of this Variable.
189
195
  # @return [VariableContext] VariableContext
190
196
  def initialize(version, service_sid, environment_sid, sid)
191
197
  super(version)
@@ -218,8 +224,10 @@ module Twilio
218
224
 
219
225
  ##
220
226
  # Update the VariableInstance
221
- # @param [String] key The key
222
- # @param [String] value The value
227
+ # @param [String] key A string by which this Variable can be referenced, fewer
228
+ # than 128 characters. Optional.
229
+ # @param [String] value A string that contains the actual value of this Variable,
230
+ # less than 450 bytes. Optional.
223
231
  # @return [VariableInstance] Updated VariableInstance
224
232
  def update(key: :unset, value: :unset)
225
233
  data = Twilio::Values.of({'Key' => key, 'Value' => value, })
@@ -261,9 +269,11 @@ module Twilio
261
269
  # Initialize the VariableInstance
262
270
  # @param [Version] version Version that contains the resource
263
271
  # @param [Hash] payload payload that contains response from Twilio
264
- # @param [String] service_sid The service_sid
265
- # @param [String] environment_sid The environment_sid
266
- # @param [String] sid The sid
272
+ # @param [String] service_sid The unique SID identifier of the Service for this
273
+ # Variable.
274
+ # @param [String] environment_sid The unique SID identifier of the Environment in
275
+ # which this Variable exists.
276
+ # @param [String] sid The unique SID identifier of this Variable.
267
277
  # @return [VariableInstance] VariableInstance
268
278
  def initialize(version, payload, service_sid: nil, environment_sid: nil, sid: nil)
269
279
  super(version)
@@ -307,55 +317,55 @@ module Twilio
307
317
  end
308
318
 
309
319
  ##
310
- # @return [String] The sid
320
+ # @return [String] Variable Sid.
311
321
  def sid
312
322
  @properties['sid']
313
323
  end
314
324
 
315
325
  ##
316
- # @return [String] The account_sid
326
+ # @return [String] Account Sid.
317
327
  def account_sid
318
328
  @properties['account_sid']
319
329
  end
320
330
 
321
331
  ##
322
- # @return [String] The service_sid
332
+ # @return [String] Service Sid.
323
333
  def service_sid
324
334
  @properties['service_sid']
325
335
  end
326
336
 
327
337
  ##
328
- # @return [String] The environment_sid
338
+ # @return [String] Environment Sid.
329
339
  def environment_sid
330
340
  @properties['environment_sid']
331
341
  end
332
342
 
333
343
  ##
334
- # @return [String] The key
344
+ # @return [String] A string by which this Variable can be referenced.
335
345
  def key
336
346
  @properties['key']
337
347
  end
338
348
 
339
349
  ##
340
- # @return [String] The value
350
+ # @return [String] A string that contains the actual value of this Variable.
341
351
  def value
342
352
  @properties['value']
343
353
  end
344
354
 
345
355
  ##
346
- # @return [Time] The date_created
356
+ # @return [Time] The date that this Variable was created.
347
357
  def date_created
348
358
  @properties['date_created']
349
359
  end
350
360
 
351
361
  ##
352
- # @return [Time] The date_updated
362
+ # @return [Time] The date that this Variable was updated.
353
363
  def date_updated
354
364
  @properties['date_updated']
355
365
  end
356
366
 
357
367
  ##
358
- # @return [String] The url
368
+ # @return [String] The URL of this Variable.
359
369
  def url
360
370
  @properties['url']
361
371
  end
@@ -369,8 +379,10 @@ module Twilio
369
379
 
370
380
  ##
371
381
  # Update the VariableInstance
372
- # @param [String] key The key
373
- # @param [String] value The value
382
+ # @param [String] key A string by which this Variable can be referenced, fewer
383
+ # than 128 characters. Optional.
384
+ # @param [String] value A string that contains the actual value of this Variable,
385
+ # less than 450 bytes. Optional.
374
386
  # @return [VariableInstance] Updated VariableInstance
375
387
  def update(key: :unset, value: :unset)
376
388
  context.update(key: key, value: value, )
@@ -17,7 +17,8 @@ module Twilio
17
17
  ##
18
18
  # Initialize the FunctionList
19
19
  # @param [Version] version Version that contains the resource
20
- # @param [String] service_sid The service_sid
20
+ # @param [String] service_sid The unique SID identifier of the Service for this
21
+ # Function.
21
22
  # @return [FunctionList] FunctionList
22
23
  def initialize(version, service_sid: nil)
23
24
  super(version)
@@ -112,7 +113,8 @@ module Twilio
112
113
  ##
113
114
  # Retrieve a single page of FunctionInstance records from the API.
114
115
  # Request is executed immediately.
115
- # @param [String] friendly_name The friendly_name
116
+ # @param [String] friendly_name A human-readable description of this Function,
117
+ # fewer than 256 characters. Required.
116
118
  # @return [FunctionInstance] Newly created FunctionInstance
117
119
  def create(friendly_name: nil)
118
120
  data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -170,8 +172,9 @@ module Twilio
170
172
  ##
171
173
  # Initialize the FunctionContext
172
174
  # @param [Version] version Version that contains the resource
173
- # @param [String] service_sid The service_sid
174
- # @param [String] sid The sid
175
+ # @param [String] service_sid The unique SID identifier of the Service for this
176
+ # Function.
177
+ # @param [String] sid The unique SID identifier of this Function.
175
178
  # @return [FunctionContext] FunctionContext
176
179
  def initialize(version, service_sid, sid)
177
180
  super(version)
@@ -201,7 +204,8 @@ module Twilio
201
204
 
202
205
  ##
203
206
  # Update the FunctionInstance
204
- # @param [String] friendly_name The friendly_name
207
+ # @param [String] friendly_name A human-readable description of this Function,
208
+ # fewer than 256 characters. Required.
205
209
  # @return [FunctionInstance] Updated FunctionInstance
206
210
  def update(friendly_name: nil)
207
211
  data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -259,8 +263,9 @@ module Twilio
259
263
  # Initialize the FunctionInstance
260
264
  # @param [Version] version Version that contains the resource
261
265
  # @param [Hash] payload payload that contains response from Twilio
262
- # @param [String] service_sid The service_sid
263
- # @param [String] sid The sid
266
+ # @param [String] service_sid The unique SID identifier of the Service for this
267
+ # Function.
268
+ # @param [String] sid The unique SID identifier of this Function.
264
269
  # @return [FunctionInstance] FunctionInstance
265
270
  def initialize(version, payload, service_sid: nil, sid: nil)
266
271
  super(version)
@@ -294,49 +299,49 @@ module Twilio
294
299
  end
295
300
 
296
301
  ##
297
- # @return [String] The sid
302
+ # @return [String] Function Sid.
298
303
  def sid
299
304
  @properties['sid']
300
305
  end
301
306
 
302
307
  ##
303
- # @return [String] The account_sid
308
+ # @return [String] Account Sid.
304
309
  def account_sid
305
310
  @properties['account_sid']
306
311
  end
307
312
 
308
313
  ##
309
- # @return [String] The service_sid
314
+ # @return [String] Service Sid.
310
315
  def service_sid
311
316
  @properties['service_sid']
312
317
  end
313
318
 
314
319
  ##
315
- # @return [String] The friendly_name
320
+ # @return [String] A human-readable description of this Function.
316
321
  def friendly_name
317
322
  @properties['friendly_name']
318
323
  end
319
324
 
320
325
  ##
321
- # @return [Time] The date_created
326
+ # @return [Time] The date that this Function was created.
322
327
  def date_created
323
328
  @properties['date_created']
324
329
  end
325
330
 
326
331
  ##
327
- # @return [Time] The date_updated
332
+ # @return [Time] The date that this Function was updated.
328
333
  def date_updated
329
334
  @properties['date_updated']
330
335
  end
331
336
 
332
337
  ##
333
- # @return [String] The url
338
+ # @return [String] The URL of this Function.
334
339
  def url
335
340
  @properties['url']
336
341
  end
337
342
 
338
343
  ##
339
- # @return [String] The links
344
+ # @return [String] Nested resource URLs.
340
345
  def links
341
346
  @properties['links']
342
347
  end
@@ -350,7 +355,8 @@ module Twilio
350
355
 
351
356
  ##
352
357
  # Update the FunctionInstance
353
- # @param [String] friendly_name The friendly_name
358
+ # @param [String] friendly_name A human-readable description of this Function,
359
+ # fewer than 256 characters. Required.
354
360
  # @return [FunctionInstance] Updated FunctionInstance
355
361
  def update(friendly_name: nil)
356
362
  context.update(friendly_name: friendly_name, )