twilio-ruby 5.9.0 → 5.10.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 (112) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES.md +12 -0
  3. data/README.md +2 -2
  4. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb +36 -24
  5. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb +34 -25
  6. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb +30 -21
  7. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb +1 -1
  8. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +10 -4
  9. data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +2 -2
  10. data/lib/twilio-ruby/rest/api/v2010/account/key.rb +2 -4
  11. data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb +1 -1
  12. data/lib/twilio-ruby/rest/api/v2010/account/message.rb +6 -4
  13. data/lib/twilio-ruby/rest/api/v2010/account/new_key.rb +6 -7
  14. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb +1 -1
  15. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb +1 -1
  16. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb +12 -4
  17. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb +11 -6
  18. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +10 -8
  19. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb +10 -8
  20. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb +11 -9
  21. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +0 -1
  22. data/lib/twilio-ruby/rest/api/v2010/account/sip.rb +2 -1
  23. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +9 -6
  24. data/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb +9 -3
  25. data/lib/twilio-ruby/rest/api/v2010/account.rb +13 -9
  26. data/lib/twilio-ruby/rest/chat/v1/credential.rb +42 -24
  27. data/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb +38 -18
  28. data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb +60 -24
  29. data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb +28 -18
  30. data/lib/twilio-ruby/rest/chat/v1/service/channel.rb +33 -24
  31. data/lib/twilio-ruby/rest/chat/v1/service/role.rb +26 -16
  32. data/lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb +4 -2
  33. data/lib/twilio-ruby/rest/chat/v1/service/user.rb +43 -24
  34. data/lib/twilio-ruby/rest/chat/v1/service.rb +74 -44
  35. data/lib/twilio-ruby/rest/chat/v2/credential.rb +61 -27
  36. data/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +41 -18
  37. data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +43 -25
  38. data/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +76 -37
  39. data/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb +432 -0
  40. data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +90 -35
  41. data/lib/twilio-ruby/rest/chat/v2/service/role.rb +23 -16
  42. data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb +4 -2
  43. data/lib/twilio-ruby/rest/chat/v2/service/user.rb +43 -25
  44. data/lib/twilio-ruby/rest/chat/v2/service.rb +93 -53
  45. data/lib/twilio-ruby/rest/chat.rb +4 -2
  46. data/lib/twilio-ruby/rest/ip_messaging/v1/credential.rb +42 -24
  47. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +38 -18
  48. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +60 -24
  49. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb +28 -18
  50. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +33 -24
  51. data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +26 -16
  52. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb +4 -2
  53. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb +43 -24
  54. data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +74 -44
  55. data/lib/twilio-ruby/rest/ip_messaging/v2/credential.rb +61 -27
  56. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +41 -18
  57. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +43 -25
  58. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +76 -37
  59. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb +432 -0
  60. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +90 -35
  61. data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +23 -16
  62. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +4 -2
  63. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +43 -25
  64. data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +93 -53
  65. data/lib/twilio-ruby/rest/ip_messaging.rb +4 -2
  66. data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +12 -11
  67. data/lib/twilio-ruby/rest/monitor/v1/event.rb +11 -11
  68. data/lib/twilio-ruby/rest/monitor.rb +1 -1
  69. data/lib/twilio-ruby/rest/notify/v1/credential.rb +47 -22
  70. data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +59 -26
  71. data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +104 -29
  72. data/lib/twilio-ruby/rest/notify/v1/service.rb +86 -48
  73. data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb +2 -2
  74. data/lib/twilio-ruby/rest/preview/marketplace.rb +13 -13
  75. data/lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb +22 -16
  76. data/lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb +21 -15
  77. data/lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb +17 -14
  78. data/lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb +36 -25
  79. data/lib/twilio-ruby/rest/preview/understand/assistant/intent.rb +21 -15
  80. data/lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb +19 -13
  81. data/lib/twilio-ruby/rest/preview/understand/assistant/query.rb +42 -28
  82. data/lib/twilio-ruby/rest/preview/understand/assistant.rb +39 -21
  83. data/lib/twilio-ruby/rest/preview.rb +10 -9
  84. data/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb +5 -5
  85. data/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb +4 -4
  86. data/lib/twilio-ruby/rest/pricing/v1/voice/country.rb +3 -3
  87. data/lib/twilio-ruby/rest/pricing/v1/voice/number.rb +5 -5
  88. data/lib/twilio-ruby/rest/sync/v1/service/document.rb +12 -13
  89. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +28 -22
  90. data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +7 -5
  91. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +31 -14
  92. data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +3 -3
  93. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +2 -2
  94. data/lib/twilio-ruby/rest/sync/v1/service.rb +24 -27
  95. data/lib/twilio-ruby/rest/video/v1/composition.rb +1 -1
  96. data/lib/twilio-ruby/rest/video/v1/recording.rb +45 -31
  97. data/lib/twilio-ruby/rest/video/v1/room/recording.rb +1 -1
  98. data/lib/twilio-ruby/rest/video/v1/room/room_participant.rb +18 -6
  99. data/lib/twilio-ruby/rest/video/v1.rb +13 -12
  100. data/lib/twilio-ruby/rest/video.rb +9 -8
  101. data/lib/twilio-ruby/rest/wireless/v1/command.rb +43 -33
  102. data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +48 -35
  103. data/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb +21 -23
  104. data/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb +32 -22
  105. data/lib/twilio-ruby/rest/wireless/v1/sim.rb +121 -70
  106. data/lib/twilio-ruby/rest/wireless.rb +6 -3
  107. data/lib/twilio-ruby/version.rb +1 -1
  108. data/spec/integration/chat/v2/service/channel/webhook_spec.rb +307 -0
  109. data/spec/integration/chat/v2/service/channel_spec.rb +4 -0
  110. data/spec/integration/ip_messaging/v2/service/channel/webhook_spec.rb +307 -0
  111. data/spec/integration/ip_messaging/v2/service/channel_spec.rb +4 -0
  112. metadata +9 -3
@@ -51,6 +51,7 @@ module Twilio
51
51
  # date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can
52
52
  # also specify offsets to today. For example, `EndDate=+30days` will make
53
53
  # `EndDate` be 30 days from today.
54
+ # @param [Boolean] include_subaccounts The include_subaccounts
54
55
  # @param [Integer] limit Upper limit for the number of records to return. stream()
55
56
  # guarantees to never return more than limit. Default is no limit
56
57
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -58,11 +59,12 @@ module Twilio
58
59
  # but a limit is defined, stream() will attempt to read the limit with the most
59
60
  # efficient page size, i.e. min(limit, 1000)
60
61
  # @return [Array] Array of up to limit results
61
- def list(category: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil)
62
+ def list(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, limit: nil, page_size: nil)
62
63
  self.stream(
63
64
  category: category,
64
65
  start_date: start_date,
65
66
  end_date: end_date,
67
+ include_subaccounts: include_subaccounts,
66
68
  limit: limit,
67
69
  page_size: page_size
68
70
  ).entries
@@ -82,6 +84,7 @@ module Twilio
82
84
  # date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can
83
85
  # also specify offsets to today. For example, `EndDate=+30days` will make
84
86
  # `EndDate` be 30 days from today.
87
+ # @param [Boolean] include_subaccounts The include_subaccounts
85
88
  # @param [Integer] limit Upper limit for the number of records to return. stream()
86
89
  # guarantees to never return more than limit. Default is no limit.
87
90
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -89,13 +92,14 @@ module Twilio
89
92
  # but a limit is defined, stream() will attempt to read the limit with the most
90
93
  # efficient page size, i.e. min(limit, 1000)
91
94
  # @return [Enumerable] Enumerable that will yield up to limit results
92
- def stream(category: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil)
95
+ def stream(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, limit: nil, page_size: nil)
93
96
  limits = @version.read_limits(limit, page_size)
94
97
 
95
98
  page = self.page(
96
99
  category: category,
97
100
  start_date: start_date,
98
101
  end_date: end_date,
102
+ include_subaccounts: include_subaccounts,
99
103
  page_size: limits[:page_size],
100
104
  )
101
105
 
@@ -129,15 +133,17 @@ module Twilio
129
133
  # date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can
130
134
  # also specify offsets to today. For example, `EndDate=+30days` will make
131
135
  # `EndDate` be 30 days from today.
136
+ # @param [Boolean] include_subaccounts The include_subaccounts
132
137
  # @param [String] page_token PageToken provided by the API
133
138
  # @param [Integer] page_number Page Number, this value is simply for client state
134
139
  # @param [Integer] page_size Number of records to return, defaults to 50
135
140
  # @return [Page] Page of RecordInstance
136
- def page(category: :unset, start_date: :unset, end_date: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
141
+ def page(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
137
142
  params = Twilio::Values.of({
138
143
  'Category' => category,
139
144
  'StartDate' => Twilio.serialize_iso8601_date(start_date),
140
145
  'EndDate' => Twilio.serialize_iso8601_date(end_date),
146
+ 'IncludeSubaccounts' => include_subaccounts,
141
147
  'PageToken' => page_token,
142
148
  'Page' => page_number,
143
149
  'PageSize' => page_size,
@@ -47,8 +47,8 @@ module Twilio
47
47
  # memory before returning.
48
48
  # @param [String] friendly_name Only return the Account resources with friendly
49
49
  # names that exactly match this name.
50
- # @param [String] status Only return Account resources with the given status. Can
51
- # be `closed`, `suspended` or `active`.
50
+ # @param [account.Status] status Only return Account resources with the given
51
+ # status. Can be `closed`, `suspended` or `active`.
52
52
  # @param [Integer] limit Upper limit for the number of records to return. stream()
53
53
  # guarantees to never return more than limit. Default is no limit
54
54
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -71,8 +71,8 @@ module Twilio
71
71
  # is reached.
72
72
  # @param [String] friendly_name Only return the Account resources with friendly
73
73
  # names that exactly match this name.
74
- # @param [String] status Only return Account resources with the given status. Can
75
- # be `closed`, `suspended` or `active`.
74
+ # @param [account.Status] status Only return Account resources with the given
75
+ # status. Can be `closed`, `suspended` or `active`.
76
76
  # @param [Integer] limit Upper limit for the number of records to return. stream()
77
77
  # guarantees to never return more than limit. Default is no limit.
78
78
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -107,8 +107,8 @@ module Twilio
107
107
  # Request is executed immediately.
108
108
  # @param [String] friendly_name Only return the Account resources with friendly
109
109
  # names that exactly match this name.
110
- # @param [String] status Only return Account resources with the given status. Can
111
- # be `closed`, `suspended` or `active`.
110
+ # @param [account.Status] status Only return Account resources with the given
111
+ # status. Can be `closed`, `suspended` or `active`.
112
112
  # @param [String] page_token PageToken provided by the API
113
113
  # @param [Integer] page_number Page Number, this value is simply for client state
114
114
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -237,7 +237,9 @@ module Twilio
237
237
  # Update the AccountInstance
238
238
  # @param [String] friendly_name Update the human-readable description of this
239
239
  # Account
240
- # @param [String] status Alter the status of this account with a given Status
240
+ # @param [account.Status] status Alter the status of this account: use `closed` to
241
+ # irreversibly close this account, `suspended` to temporarily suspend it, or
242
+ # `active` to reactivate it.
241
243
  # @return [AccountInstance] Updated AccountInstance
242
244
  def update(friendly_name: :unset, status: :unset)
243
245
  data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Status' => status, })
@@ -718,7 +720,7 @@ module Twilio
718
720
  end
719
721
 
720
722
  ##
721
- # @return [String] The status of this account
723
+ # @return [account.Status] The status of this account
722
724
  def status
723
725
  @properties['status']
724
726
  end
@@ -752,7 +754,9 @@ module Twilio
752
754
  # Update the AccountInstance
753
755
  # @param [String] friendly_name Update the human-readable description of this
754
756
  # Account
755
- # @param [String] status Alter the status of this account with a given Status
757
+ # @param [account.Status] status Alter the status of this account: use `closed` to
758
+ # irreversibly close this account, `suspended` to temporarily suspend it, or
759
+ # `active` to reactivate it.
756
760
  # @return [AccountInstance] Updated AccountInstance
757
761
  def update(friendly_name: :unset, status: :unset)
758
762
  context.update(friendly_name: friendly_name, status: status, )
@@ -108,12 +108,18 @@ module Twilio
108
108
  ##
109
109
  # Retrieve a single page of CredentialInstance records from the API.
110
110
  # Request is executed immediately.
111
- # @param [credential.PushService] type The type
112
- # @param [String] friendly_name The friendly_name
113
- # @param [String] certificate The certificate
114
- # @param [String] private_key The private_key
115
- # @param [Boolean] sandbox The sandbox
116
- # @param [String] api_key The api_key
111
+ # @param [credential.PushService] type Credential type, one of "gcm" or "apn"
112
+ # @param [String] friendly_name Friendly name for stored credential
113
+ # @param [String] certificate [APN only] URL encoded representation of the
114
+ # certificate, e.g. `-----BEGIN
115
+ # CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
116
+ # @param [String] private_key [APN only] URL encoded representation of the private
117
+ # key, e.g. `-----BEGIN RSA PRIVATE
118
+ # KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
119
+ # @param [Boolean] sandbox [APN only] use this credential for sending to
120
+ # production or sandbox APNs (string `true` or `false`)
121
+ # @param [String] api_key [GCM only] This is the "API key" for project from Google
122
+ # Developer console for your GCM Service application credential
117
123
  # @param [String] secret The secret
118
124
  # @return [CredentialInstance] Newly created CredentialInstance
119
125
  def create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
@@ -203,11 +209,17 @@ module Twilio
203
209
 
204
210
  ##
205
211
  # Update the CredentialInstance
206
- # @param [String] friendly_name The friendly_name
207
- # @param [String] certificate The certificate
208
- # @param [String] private_key The private_key
209
- # @param [Boolean] sandbox The sandbox
210
- # @param [String] api_key The api_key
212
+ # @param [String] friendly_name Friendly name for stored credential
213
+ # @param [String] certificate [APN only] URL encoded representation of the
214
+ # certificate, e.g. `-----BEGIN
215
+ # CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
216
+ # @param [String] private_key [APN only] URL encoded representation of the private
217
+ # key, e.g. `-----BEGIN RSA PRIVATE
218
+ # KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
219
+ # @param [Boolean] sandbox [APN only] use this credential for sending to
220
+ # production or sandbox APNs (string `true` or `false`)
221
+ # @param [String] api_key [GCM only] This is the "API key" for project from Google
222
+ # Developer console for your GCM Service application credential
211
223
  # @param [String] secret The secret
212
224
  # @return [CredentialInstance] Updated CredentialInstance
213
225
  def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
@@ -283,49 +295,49 @@ module Twilio
283
295
  end
284
296
 
285
297
  ##
286
- # @return [String] The sid
298
+ # @return [String] A 34 character string that uniquely identifies this resource.
287
299
  def sid
288
300
  @properties['sid']
289
301
  end
290
302
 
291
303
  ##
292
- # @return [String] The account_sid
304
+ # @return [String] The unique id of the Account[/console] responsible for this resource.
293
305
  def account_sid
294
306
  @properties['account_sid']
295
307
  end
296
308
 
297
309
  ##
298
- # @return [String] The friendly_name
310
+ # @return [String] The human-readable name of this resource.
299
311
  def friendly_name
300
312
  @properties['friendly_name']
301
313
  end
302
314
 
303
315
  ##
304
- # @return [credential.PushService] The type
316
+ # @return [credential.PushService] Indicates which push notifications service this credential is for - either gcm or apn
305
317
  def type
306
318
  @properties['type']
307
319
  end
308
320
 
309
321
  ##
310
- # @return [String] The sandbox
322
+ # @return [String] [APN only] true when this resource should use the sandbox APN service.
311
323
  def sandbox
312
324
  @properties['sandbox']
313
325
  end
314
326
 
315
327
  ##
316
- # @return [Time] The date_created
328
+ # @return [Time] The date that this resource was created.
317
329
  def date_created
318
330
  @properties['date_created']
319
331
  end
320
332
 
321
333
  ##
322
- # @return [Time] The date_updated
334
+ # @return [Time] The date that this resource was last updated.
323
335
  def date_updated
324
336
  @properties['date_updated']
325
337
  end
326
338
 
327
339
  ##
328
- # @return [String] The url
340
+ # @return [String] An absolute URL for this credential resource.
329
341
  def url
330
342
  @properties['url']
331
343
  end
@@ -339,11 +351,17 @@ module Twilio
339
351
 
340
352
  ##
341
353
  # Update the CredentialInstance
342
- # @param [String] friendly_name The friendly_name
343
- # @param [String] certificate The certificate
344
- # @param [String] private_key The private_key
345
- # @param [Boolean] sandbox The sandbox
346
- # @param [String] api_key The api_key
354
+ # @param [String] friendly_name Friendly name for stored credential
355
+ # @param [String] certificate [APN only] URL encoded representation of the
356
+ # certificate, e.g. `-----BEGIN
357
+ # CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
358
+ # @param [String] private_key [APN only] URL encoded representation of the private
359
+ # key, e.g. `-----BEGIN RSA PRIVATE
360
+ # KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
361
+ # @param [Boolean] sandbox [APN only] use this credential for sending to
362
+ # production or sandbox APNs (string `true` or `false`)
363
+ # @param [String] api_key [GCM only] This is the "API key" for project from Google
364
+ # Developer console for your GCM Service application credential
347
365
  # @param [String] secret The secret
348
366
  # @return [CredentialInstance] Updated CredentialInstance
349
367
  def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
@@ -16,8 +16,11 @@ module Twilio
16
16
  ##
17
17
  # Initialize the InviteList
18
18
  # @param [Version] version Version that contains the resource
19
- # @param [String] service_sid The service_sid
20
- # @param [String] channel_sid The channel_sid
19
+ # @param [String] service_sid The unique id of the
20
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service) this member
21
+ # belongs to.
22
+ # @param [String] channel_sid The unique id of the
23
+ # [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channel) for this member.
21
24
  # @return [InviteList] InviteList
22
25
  def initialize(version, service_sid: nil, channel_sid: nil)
23
26
  super(version)
@@ -30,8 +33,13 @@ module Twilio
30
33
  ##
31
34
  # Retrieve a single page of InviteInstance records from the API.
32
35
  # Request is executed immediately.
33
- # @param [String] identity The identity
34
- # @param [String] role_sid The role_sid
36
+ # @param [String] identity A unique string identifier for this
37
+ # [User](https://www.twilio.com/docs/api/chat/rest/v1/user) in this
38
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See the [access
39
+ # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
40
+ # @param [String] role_sid The
41
+ # [Role](https://www.twilio.com/docs/api/chat/rest/v1/role) assigned to this
42
+ # member.
35
43
  # @return [InviteInstance] Newly created InviteInstance
36
44
  def create(identity: nil, role_sid: :unset)
37
45
  data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, })
@@ -54,7 +62,10 @@ module Twilio
54
62
  # Lists InviteInstance records from the API as a list.
55
63
  # Unlike stream(), this operation is eager and will load `limit` records into
56
64
  # memory before returning.
57
- # @param [String] identity The identity
65
+ # @param [String] identity A unique string identifier for this
66
+ # [User](https://www.twilio.com/docs/api/chat/rest/v1/user) in this
67
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See the [access
68
+ # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
58
69
  # @param [Integer] limit Upper limit for the number of records to return. stream()
59
70
  # guarantees to never return more than limit. Default is no limit
60
71
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -70,7 +81,10 @@ module Twilio
70
81
  # Streams InviteInstance records from the API as an Enumerable.
71
82
  # This operation lazily loads records as efficiently as possible until the limit
72
83
  # is reached.
73
- # @param [String] identity The identity
84
+ # @param [String] identity A unique string identifier for this
85
+ # [User](https://www.twilio.com/docs/api/chat/rest/v1/user) in this
86
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See the [access
87
+ # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
74
88
  # @param [Integer] limit Upper limit for the number of records to return. stream()
75
89
  # guarantees to never return more than limit. Default is no limit.
76
90
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -103,7 +117,10 @@ module Twilio
103
117
  ##
104
118
  # Retrieve a single page of InviteInstance records from the API.
105
119
  # Request is executed immediately.
106
- # @param [String] identity The identity
120
+ # @param [String] identity A unique string identifier for this
121
+ # [User](https://www.twilio.com/docs/api/chat/rest/v1/user) in this
122
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See the [access
123
+ # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
107
124
  # @param [String] page_token PageToken provided by the API
108
125
  # @param [Integer] page_number Page Number, this value is simply for client state
109
126
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -234,8 +251,11 @@ module Twilio
234
251
  # Initialize the InviteInstance
235
252
  # @param [Version] version Version that contains the resource
236
253
  # @param [Hash] payload payload that contains response from Twilio
237
- # @param [String] service_sid The service_sid
238
- # @param [String] channel_sid The channel_sid
254
+ # @param [String] service_sid The unique id of the
255
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service) this member
256
+ # belongs to.
257
+ # @param [String] channel_sid The unique id of the
258
+ # [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channel) for this member.
239
259
  # @param [String] sid The sid
240
260
  # @return [InviteInstance] InviteInstance
241
261
  def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
@@ -281,49 +301,49 @@ module Twilio
281
301
  end
282
302
 
283
303
  ##
284
- # @return [String] The sid
304
+ # @return [String] A 34 character string that uniquely identifies this resource.
285
305
  def sid
286
306
  @properties['sid']
287
307
  end
288
308
 
289
309
  ##
290
- # @return [String] The account_sid
310
+ # @return [String] The unique id of the Account[/console] responsible for this member.
291
311
  def account_sid
292
312
  @properties['account_sid']
293
313
  end
294
314
 
295
315
  ##
296
- # @return [String] The channel_sid
316
+ # @return [String] The unique id of the Channel for this member.
297
317
  def channel_sid
298
318
  @properties['channel_sid']
299
319
  end
300
320
 
301
321
  ##
302
- # @return [String] The service_sid
322
+ # @return [String] The unique id of the Service this member belongs to.
303
323
  def service_sid
304
324
  @properties['service_sid']
305
325
  end
306
326
 
307
327
  ##
308
- # @return [String] The identity
328
+ # @return [String] A unique string identifier for this User in this Service.
309
329
  def identity
310
330
  @properties['identity']
311
331
  end
312
332
 
313
333
  ##
314
- # @return [Time] The date_created
334
+ # @return [Time] The date that this resource was created.
315
335
  def date_created
316
336
  @properties['date_created']
317
337
  end
318
338
 
319
339
  ##
320
- # @return [Time] The date_updated
340
+ # @return [Time] The date that this resource was last updated.
321
341
  def date_updated
322
342
  @properties['date_updated']
323
343
  end
324
344
 
325
345
  ##
326
- # @return [String] The role_sid
346
+ # @return [String] The Role assigned to this member.
327
347
  def role_sid
328
348
  @properties['role_sid']
329
349
  end
@@ -335,7 +355,7 @@ module Twilio
335
355
  end
336
356
 
337
357
  ##
338
- # @return [String] The url
358
+ # @return [String] An absolute URL for this member.
339
359
  def url
340
360
  @properties['url']
341
361
  end
@@ -16,8 +16,12 @@ module Twilio
16
16
  ##
17
17
  # Initialize the MemberList
18
18
  # @param [Version] version Version that contains the resource
19
- # @param [String] service_sid The service_sid
20
- # @param [String] channel_sid The channel_sid
19
+ # @param [String] service_sid The unique id of the
20
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) this member
21
+ # belongs to.
22
+ # @param [String] channel_sid The unique id of the
23
+ # [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channels) for this
24
+ # member.
21
25
  # @return [MemberList] MemberList
22
26
  def initialize(version, service_sid: nil, channel_sid: nil)
23
27
  super(version)
@@ -30,8 +34,14 @@ module Twilio
30
34
  ##
31
35
  # Retrieve a single page of MemberInstance records from the API.
32
36
  # Request is executed immediately.
33
- # @param [String] identity The identity
34
- # @param [String] role_sid The role_sid
37
+ # @param [String] identity A unique string identifier for this
38
+ # [User](https://www.twilio.com/docs/api/chat/rest/v1/users) in this
39
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/services). See the
40
+ # [access
41
+ # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
42
+ # @param [String] role_sid The
43
+ # [Role](https://www.twilio.com/docs/api/chat/rest/v1/roles) assigned to this
44
+ # member.
35
45
  # @return [MemberInstance] Newly created MemberInstance
36
46
  def create(identity: nil, role_sid: :unset)
37
47
  data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, })
@@ -54,7 +64,11 @@ module Twilio
54
64
  # Lists MemberInstance records from the API as a list.
55
65
  # Unlike stream(), this operation is eager and will load `limit` records into
56
66
  # memory before returning.
57
- # @param [String] identity The identity
67
+ # @param [String] identity A unique string identifier for this
68
+ # [User](https://www.twilio.com/docs/api/chat/rest/v1/users) in this
69
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/services). See the
70
+ # [access
71
+ # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
58
72
  # @param [Integer] limit Upper limit for the number of records to return. stream()
59
73
  # guarantees to never return more than limit. Default is no limit
60
74
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -70,7 +84,11 @@ module Twilio
70
84
  # Streams MemberInstance records from the API as an Enumerable.
71
85
  # This operation lazily loads records as efficiently as possible until the limit
72
86
  # is reached.
73
- # @param [String] identity The identity
87
+ # @param [String] identity A unique string identifier for this
88
+ # [User](https://www.twilio.com/docs/api/chat/rest/v1/users) in this
89
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/services). See the
90
+ # [access
91
+ # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
74
92
  # @param [Integer] limit Upper limit for the number of records to return. stream()
75
93
  # guarantees to never return more than limit. Default is no limit.
76
94
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -103,7 +121,11 @@ module Twilio
103
121
  ##
104
122
  # Retrieve a single page of MemberInstance records from the API.
105
123
  # Request is executed immediately.
106
- # @param [String] identity The identity
124
+ # @param [String] identity A unique string identifier for this
125
+ # [User](https://www.twilio.com/docs/api/chat/rest/v1/users) in this
126
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/services). See the
127
+ # [access
128
+ # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
107
129
  # @param [String] page_token PageToken provided by the API
108
130
  # @param [Integer] page_number Page Number, this value is simply for client state
109
131
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -223,8 +245,13 @@ module Twilio
223
245
 
224
246
  ##
225
247
  # Update the MemberInstance
226
- # @param [String] role_sid The role_sid
227
- # @param [String] last_consumed_message_index The last_consumed_message_index
248
+ # @param [String] role_sid The
249
+ # [Role](https://www.twilio.com/docs/api/chat/rest/v1/roles) assigned to this
250
+ # member.
251
+ # @param [String] last_consumed_message_index An Integer representing index of the
252
+ # last [Message](https://www.twilio.com/docs/api/chat/rest/v1/messages) this
253
+ # Member has read within this
254
+ # [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channels)
228
255
  # @return [MemberInstance] Updated MemberInstance
229
256
  def update(role_sid: :unset, last_consumed_message_index: :unset)
230
257
  data = Twilio::Values.of({
@@ -260,8 +287,12 @@ module Twilio
260
287
  # Initialize the MemberInstance
261
288
  # @param [Version] version Version that contains the resource
262
289
  # @param [Hash] payload payload that contains response from Twilio
263
- # @param [String] service_sid The service_sid
264
- # @param [String] channel_sid The channel_sid
290
+ # @param [String] service_sid The unique id of the
291
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) this member
292
+ # belongs to.
293
+ # @param [String] channel_sid The unique id of the
294
+ # [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channels) for this
295
+ # member.
265
296
  # @param [String] sid The sid
266
297
  # @return [MemberInstance] MemberInstance
267
298
  def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
@@ -308,67 +339,67 @@ module Twilio
308
339
  end
309
340
 
310
341
  ##
311
- # @return [String] The sid
342
+ # @return [String] A 34 character string that uniquely identifies this resource.
312
343
  def sid
313
344
  @properties['sid']
314
345
  end
315
346
 
316
347
  ##
317
- # @return [String] The account_sid
348
+ # @return [String] The unique id of the Account responsible for this member.
318
349
  def account_sid
319
350
  @properties['account_sid']
320
351
  end
321
352
 
322
353
  ##
323
- # @return [String] The channel_sid
354
+ # @return [String] The unique id of the Channel for this member.
324
355
  def channel_sid
325
356
  @properties['channel_sid']
326
357
  end
327
358
 
328
359
  ##
329
- # @return [String] The service_sid
360
+ # @return [String] The unique id of the Service this member belongs to.
330
361
  def service_sid
331
362
  @properties['service_sid']
332
363
  end
333
364
 
334
365
  ##
335
- # @return [String] The identity
366
+ # @return [String] A unique string identifier for this User in this Service.
336
367
  def identity
337
368
  @properties['identity']
338
369
  end
339
370
 
340
371
  ##
341
- # @return [Time] The date_created
372
+ # @return [Time] The date that this resource was created.
342
373
  def date_created
343
374
  @properties['date_created']
344
375
  end
345
376
 
346
377
  ##
347
- # @return [Time] The date_updated
378
+ # @return [Time] The date that this resource was last updated.
348
379
  def date_updated
349
380
  @properties['date_updated']
350
381
  end
351
382
 
352
383
  ##
353
- # @return [String] The role_sid
384
+ # @return [String] The Role assigned to this member.
354
385
  def role_sid
355
386
  @properties['role_sid']
356
387
  end
357
388
 
358
389
  ##
359
- # @return [String] The last_consumed_message_index
390
+ # @return [String] An Integer representing index of the last Message this Member has read within this Channel
360
391
  def last_consumed_message_index
361
392
  @properties['last_consumed_message_index']
362
393
  end
363
394
 
364
395
  ##
365
- # @return [Time] The last_consumption_timestamp
396
+ # @return [Time] An ISO8601 based timestamp string representing the datetime of the last Message read event for this Member within this Channel
366
397
  def last_consumption_timestamp
367
398
  @properties['last_consumption_timestamp']
368
399
  end
369
400
 
370
401
  ##
371
- # @return [String] The url
402
+ # @return [String] An absolute URL for this member.
372
403
  def url
373
404
  @properties['url']
374
405
  end
@@ -389,8 +420,13 @@ module Twilio
389
420
 
390
421
  ##
391
422
  # Update the MemberInstance
392
- # @param [String] role_sid The role_sid
393
- # @param [String] last_consumed_message_index The last_consumed_message_index
423
+ # @param [String] role_sid The
424
+ # [Role](https://www.twilio.com/docs/api/chat/rest/v1/roles) assigned to this
425
+ # member.
426
+ # @param [String] last_consumed_message_index An Integer representing index of the
427
+ # last [Message](https://www.twilio.com/docs/api/chat/rest/v1/messages) this
428
+ # Member has read within this
429
+ # [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channels)
394
430
  # @return [MemberInstance] Updated MemberInstance
395
431
  def update(role_sid: :unset, last_consumed_message_index: :unset)
396
432
  context.update(role_sid: role_sid, last_consumed_message_index: last_consumed_message_index, )