twilio-ruby 5.55.0 → 5.56.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.
- checksums.yaml +4 -4
- data/.rubocop_todo.yml +7 -7
- data/.travis.yml +1 -1
- data/CHANGES.md +22 -0
- data/README.md +10 -2
- data/lib/twilio-ruby.rb +5 -15
- data/lib/twilio-ruby/framework/{domain.rb → rest/domain.rb} +0 -0
- data/lib/twilio-ruby/framework/{error.rb → rest/error.rb} +0 -0
- data/lib/twilio-ruby/framework/{helper.rb → rest/helper.rb} +0 -0
- data/lib/twilio-ruby/framework/{obsolete_client.rb → rest/obsolete_client.rb} +0 -0
- data/lib/twilio-ruby/framework/{page.rb → rest/page.rb} +0 -0
- data/lib/twilio-ruby/framework/{resource.rb → rest/resource.rb} +0 -0
- data/lib/twilio-ruby/framework/{version.rb → rest/version.rb} +0 -0
- data/lib/twilio-ruby/http.rb +5 -0
- data/lib/twilio-ruby/http/http_client.rb +11 -1
- data/lib/twilio-ruby/rest.rb +13 -0
- data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +8 -7
- data/lib/twilio-ruby/rest/api/v2010/account/message.rb +2 -2
- data/lib/twilio-ruby/rest/conversations/v1/conversation.rb +7 -0
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb +7 -0
- data/lib/twilio-ruby/rest/supersim/v1/sim.rb +29 -0
- data/lib/twilio-ruby/rest/supersim/v1/sim/billing_period.rb +231 -0
- data/lib/twilio-ruby/version.rb +1 -1
- metadata +12 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 80e6c32f919f1a2514aafbbb28a11b07f6099e9ffeca5f95dde586e2a717712d
|
4
|
+
data.tar.gz: '09a90113868ce5fc759734f819b76040c96da3c237657a5159912ecc4bd7a871'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 456c8ac1a992f24200563b2c754b6b9f9259287b4e4042550420218b18850de8c0a6e1c875c83e3e00b1e487f42c0b9c22a36060f95729a390b957cf34171319
|
7
|
+
data.tar.gz: dfb91366c5e2db2c817db0a782ec67c5290892daa430c0f32279ba7b7a8ae5e25fac42f9801952845d47c026603b1a95f29f5312637e283cb957bfb671dcd4cc
|
data/.rubocop_todo.yml
CHANGED
@@ -66,7 +66,7 @@ Lint/UnusedBlockArgument:
|
|
66
66
|
Lint/UnusedMethodArgument:
|
67
67
|
Exclude:
|
68
68
|
- 'lib/twilio-ruby.rb'
|
69
|
-
- 'lib/twilio-ruby/framework/page.rb'
|
69
|
+
- 'lib/twilio-ruby/framework/rest/page.rb'
|
70
70
|
- 'spec/holodeck/holodeck.rb'
|
71
71
|
|
72
72
|
# Offense count: 1
|
@@ -130,7 +130,7 @@ Style/FrozenStringLiteralComment:
|
|
130
130
|
# Configuration parameters: MinBodyLength.
|
131
131
|
Style/GuardClause:
|
132
132
|
Exclude:
|
133
|
-
- 'lib/twilio-ruby/framework/page.rb'
|
133
|
+
- 'lib/twilio-ruby/framework/rest/page.rb'
|
134
134
|
|
135
135
|
# Offense count: 1
|
136
136
|
# Cop supports --auto-correct.
|
@@ -144,8 +144,8 @@ Style/HashSyntax:
|
|
144
144
|
# Cop supports --auto-correct.
|
145
145
|
Style/IfUnlessModifier:
|
146
146
|
Exclude:
|
147
|
-
- 'lib/twilio-ruby/framework/page.rb'
|
148
|
-
- 'lib/twilio-ruby/framework/version.rb'
|
147
|
+
- 'lib/twilio-ruby/framework/rest/page.rb'
|
148
|
+
- 'lib/twilio-ruby/framework/rest/version.rb'
|
149
149
|
- 'lib/twilio-ruby/jwt/access_token.rb'
|
150
150
|
- 'lib/twilio-ruby/jwt/client_capability.rb'
|
151
151
|
- 'lib/twilio-ruby/jwt/jwt.rb'
|
@@ -168,9 +168,9 @@ Style/RedundantSelf:
|
|
168
168
|
# SupportedStyles: slashes, percent_r, mixed
|
169
169
|
Style/RegexpLiteral:
|
170
170
|
Exclude:
|
171
|
-
- 'lib/twilio-ruby/framework/domain.rb'
|
172
|
-
- 'lib/twilio-ruby/framework/helper.rb'
|
173
|
-
- 'lib/twilio-ruby/framework/version.rb'
|
171
|
+
- 'lib/twilio-ruby/framework/rest/domain.rb'
|
172
|
+
- 'lib/twilio-ruby/framework/rest/helper.rb'
|
173
|
+
- 'lib/twilio-ruby/framework/rest/version.rb'
|
174
174
|
- 'spec/rack/twilio_webhook_authentication_spec.rb'
|
175
175
|
|
176
176
|
# Offense count: 5
|
data/.travis.yml
CHANGED
@@ -19,7 +19,7 @@ matrix:
|
|
19
19
|
fast_finish: true
|
20
20
|
deploy:
|
21
21
|
- provider: script
|
22
|
-
script: make docker-build && make docker-push
|
22
|
+
script: echo "${DOCKER_PASSWORD}" | docker login -u "${DOCKER_USERNAME}" --password-stdin && make docker-build && make docker-push
|
23
23
|
skip_cleanup: true
|
24
24
|
on:
|
25
25
|
tags: true
|
data/CHANGES.md
CHANGED
@@ -1,6 +1,28 @@
|
|
1
1
|
twilio-ruby changelog
|
2
2
|
=====================
|
3
3
|
|
4
|
+
[2021-06-30] Version 5.56.0
|
5
|
+
---------------------------
|
6
|
+
**Library - Feature**
|
7
|
+
- [PR #559](https://github.com/twilio/twilio-ruby/pull/559): Add `Twilio::HTTP::Client#configure_connection`. Thanks to [@darwinShopify](https://github.com/darwinShopify)!
|
8
|
+
- [PR #558](https://github.com/twilio/twilio-ruby/pull/558): Autoload Twilio::REST and Twilio::HTTP. Thanks to [@gmcgibbon](https://github.com/gmcgibbon)!
|
9
|
+
|
10
|
+
**Conversations**
|
11
|
+
- Read-only Conversation Email Binding property `binding`
|
12
|
+
|
13
|
+
**Supersim**
|
14
|
+
- Add Billing Period resource for the Super Sim Pilot
|
15
|
+
- Add List endpoint to Billing Period resource for Super Sim Pilot
|
16
|
+
- Add Fetch endpoint to Billing Period resource for Super Sim Pilot
|
17
|
+
|
18
|
+
**Taskrouter**
|
19
|
+
- Update `transcribe` & `transcription_configuration` form params in Reservation update endpoint to have private visibility **(breaking change)**
|
20
|
+
- Add `transcribe` & `transcription_configuration` form params to Reservation update endpoint
|
21
|
+
|
22
|
+
**Twiml**
|
23
|
+
- Add `modify` event to `statusCallbackEvent` for `<Conference>`.
|
24
|
+
|
25
|
+
|
4
26
|
[2021-06-16] Version 5.55.0
|
5
27
|
---------------------------
|
6
28
|
**Api**
|
data/README.md
CHANGED
@@ -35,13 +35,13 @@ This library supports the following Ruby implementations:
|
|
35
35
|
To install using [Bundler][bundler] grab the latest stable version:
|
36
36
|
|
37
37
|
```ruby
|
38
|
-
gem 'twilio-ruby', '~> 5.
|
38
|
+
gem 'twilio-ruby', '~> 5.56.0'
|
39
39
|
```
|
40
40
|
|
41
41
|
To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
|
42
42
|
|
43
43
|
```bash
|
44
|
-
gem install twilio-ruby -v 5.
|
44
|
+
gem install twilio-ruby -v 5.56.0
|
45
45
|
```
|
46
46
|
|
47
47
|
To build and install the development branch yourself from the latest source:
|
@@ -158,6 +158,14 @@ message_sid = 'SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
|
|
158
158
|
|
159
159
|
To use a custom HTTP client with this helper library, please see the [Twilio documentation](https://www.twilio.com/docs/libraries/ruby/custom-http-clients).
|
160
160
|
|
161
|
+
To apply customizations such as middleware, you can use the `configure_connection` method like so:
|
162
|
+
|
163
|
+
```ruby
|
164
|
+
@client.http_client.configure_connection do |faraday|
|
165
|
+
faraday.use SomeMiddleware
|
166
|
+
end
|
167
|
+
```
|
168
|
+
|
161
169
|
### Handling Errors
|
162
170
|
|
163
171
|
```ruby
|
data/lib/twilio-ruby.rb
CHANGED
@@ -16,27 +16,17 @@ require 'twilio-ruby/util'
|
|
16
16
|
require 'twilio-ruby/security/request_validator'
|
17
17
|
require 'twilio-ruby/util/configuration'
|
18
18
|
|
19
|
-
Dir[File.
|
20
|
-
require file
|
21
|
-
end
|
22
|
-
Dir[File.dirname(__FILE__) + '/twilio-ruby/framework/**/*.rb'].sort.each do |file|
|
23
|
-
require file
|
24
|
-
end
|
25
|
-
Dir[File.dirname(__FILE__) + '/twilio-ruby/rest/*.rb'].sort.each do |file|
|
26
|
-
require file
|
27
|
-
end
|
28
|
-
Dir[File.dirname(__FILE__) + '/twilio-ruby/rest/**/*.rb'].sort.each do |file|
|
29
|
-
require file
|
30
|
-
end
|
31
|
-
Dir[File.dirname(__FILE__) + '/twilio-ruby/compatibility/**/*.rb'].sort.each do |file|
|
19
|
+
Dir[File.join(__dir__, 'twilio-ruby/framework/*.rb')].sort.each do |file|
|
32
20
|
require file
|
33
21
|
end
|
34
22
|
|
35
23
|
module Twilio
|
36
24
|
extend SingleForwardable
|
37
25
|
|
38
|
-
autoload :JWT, File.join(
|
39
|
-
autoload :TwiML, File.join(
|
26
|
+
autoload :JWT, File.join(__dir__, 'twilio-ruby', 'jwt', 'jwt.rb')
|
27
|
+
autoload :TwiML, File.join(__dir__, 'twilio-ruby', 'twiml', 'twiml.rb')
|
28
|
+
autoload :HTTP, File.join(__dir__, 'twilio-ruby', 'http.rb')
|
29
|
+
autoload :REST, File.join(__dir__, 'twilio-ruby', 'rest.rb')
|
40
30
|
|
41
31
|
def_delegators :configuration, :account_sid, :auth_token, :http_client, :region, :edge, :logger
|
42
32
|
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
@@ -16,18 +16,28 @@ module Twilio
|
|
16
16
|
@ssl_ca_file = ssl_ca_file
|
17
17
|
@timeout = timeout
|
18
18
|
@adapter = Faraday.default_adapter
|
19
|
+
@configure_connection_blocks = []
|
20
|
+
end
|
21
|
+
|
22
|
+
def configure_connection(&block)
|
23
|
+
raise ArgumentError, "#{__method__} must be given a block!" unless block_given?
|
24
|
+
|
25
|
+
@configure_connection_blocks << block
|
26
|
+
nil
|
19
27
|
end
|
20
28
|
|
21
29
|
def _request(request)
|
22
30
|
@connection = Faraday.new(url: request.host + ':' + request.port.to_s, ssl: { verify: true }) do |f|
|
23
31
|
f.options.params_encoder = Faraday::FlatParamsEncoder
|
24
32
|
f.request :url_encoded
|
25
|
-
f.adapter @adapter
|
26
33
|
f.headers = request.headers
|
27
34
|
f.basic_auth(request.auth[0], request.auth[1])
|
28
35
|
f.proxy = "#{@proxy_prot}://#{@proxy_auth}#{@proxy_path}" if @proxy_prot && @proxy_path
|
29
36
|
f.options.open_timeout = request.timeout || @timeout
|
30
37
|
f.options.timeout = request.timeout || @timeout
|
38
|
+
|
39
|
+
@configure_connection_blocks.each { |block| block.call(f) }
|
40
|
+
f.adapter @adapter
|
31
41
|
end
|
32
42
|
|
33
43
|
@last_request = request
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
Dir[File.join(__dir__, 'framework/rest/*.rb')].sort.each do |file|
|
4
|
+
require file
|
5
|
+
end
|
6
|
+
|
7
|
+
Dir[File.join(__dir__, 'rest/*.rb')].sort.each do |file|
|
8
|
+
require file
|
9
|
+
end
|
10
|
+
|
11
|
+
Dir[File.join(__dir__, 'rest/**/*.rb')].sort.each do |file|
|
12
|
+
require file
|
13
|
+
end
|
@@ -107,8 +107,8 @@ module Twilio
|
|
107
107
|
# `POST`.
|
108
108
|
# @param [Array[String]] conference_status_callback_event The conference state
|
109
109
|
# changes that should generate a call to `conference_status_callback`. Can be:
|
110
|
-
# `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`, and
|
111
|
-
# Separate multiple values with a space. Defaults to `start end`.
|
110
|
+
# `start`, `end`, `join`, `leave`, `mute`, `hold`, `modify`, `speaker`, and
|
111
|
+
# `announcement`. Separate multiple values with a space. Defaults to `start end`.
|
112
112
|
# @param [String] recording_channels The recording channels for the final
|
113
113
|
# recording. Can be: `mono` or `dual` and the default is `mono`.
|
114
114
|
# @param [String] recording_status_callback The URL that we should call using the
|
@@ -130,13 +130,14 @@ module Twilio
|
|
130
130
|
# `POST` and defaults to `POST`.
|
131
131
|
# @param [Array[String]] recording_status_callback_event The recording state
|
132
132
|
# changes that should generate a call to `recording_status_callback`. Can be:
|
133
|
-
# `in-progress`, `
|
134
|
-
#
|
133
|
+
# `started`, `in-progress`, `paused`, `resumed`, `stopped`, `completed`, `failed`,
|
134
|
+
# and `absent`. Separate multiple values with a space, ex: `'in-progress completed
|
135
|
+
# failed'`.
|
135
136
|
# @param [Array[String]] conference_recording_status_callback_event The conference
|
136
137
|
# recording state changes that generate a call to
|
137
|
-
# `conference_recording_status_callback`. Can be: `in-progress`, `completed`,
|
138
|
-
# `failed`. Separate multiple values with a space
|
139
|
-
#
|
138
|
+
# `conference_recording_status_callback`. Can be: `in-progress`, `completed`,
|
139
|
+
# `failed`, and `absent`. Separate multiple values with a space, ex: `'in-progress
|
140
|
+
# completed failed'`
|
140
141
|
# @param [Boolean] coaching Whether the participant is coaching another call. Can
|
141
142
|
# be: `true` or `false`. If not present, defaults to `false` unless
|
142
143
|
# `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.
|
@@ -330,7 +330,7 @@ module Twilio
|
|
330
330
|
# @param [String] body The text of the message you want to send. Can be up to
|
331
331
|
# 1,600 characters long.
|
332
332
|
# @return [MessageInstance] Updated MessageInstance
|
333
|
-
def update(body:
|
333
|
+
def update(body: :unset)
|
334
334
|
data = Twilio::Values.of({'Body' => body, })
|
335
335
|
|
336
336
|
payload = @version.update('POST', @uri, data: data)
|
@@ -580,7 +580,7 @@ module Twilio
|
|
580
580
|
# @param [String] body The text of the message you want to send. Can be up to
|
581
581
|
# 1,600 characters long.
|
582
582
|
# @return [MessageInstance] Updated MessageInstance
|
583
|
-
def update(body:
|
583
|
+
def update(body: :unset)
|
584
584
|
context.update(body: body, )
|
585
585
|
end
|
586
586
|
|
@@ -362,6 +362,7 @@ module Twilio
|
|
362
362
|
'timers' => payload['timers'],
|
363
363
|
'url' => payload['url'],
|
364
364
|
'links' => payload['links'],
|
365
|
+
'bindings' => payload['bindings'],
|
365
366
|
}
|
366
367
|
|
367
368
|
# Context
|
@@ -458,6 +459,12 @@ module Twilio
|
|
458
459
|
@properties['links']
|
459
460
|
end
|
460
461
|
|
462
|
+
##
|
463
|
+
# @return [Hash] The bindings
|
464
|
+
def bindings
|
465
|
+
@properties['bindings']
|
466
|
+
end
|
467
|
+
|
461
468
|
##
|
462
469
|
# Update the ConversationInstance
|
463
470
|
# @param [String] friendly_name The human-readable name of this conversation,
|
@@ -394,6 +394,7 @@ module Twilio
|
|
394
394
|
'timers' => payload['timers'],
|
395
395
|
'url' => payload['url'],
|
396
396
|
'links' => payload['links'],
|
397
|
+
'bindings' => payload['bindings'],
|
397
398
|
}
|
398
399
|
|
399
400
|
# Context
|
@@ -490,6 +491,12 @@ module Twilio
|
|
490
491
|
@properties['links']
|
491
492
|
end
|
492
493
|
|
494
|
+
##
|
495
|
+
# @return [Hash] The bindings
|
496
|
+
def bindings
|
497
|
+
@properties['bindings']
|
498
|
+
end
|
499
|
+
|
493
500
|
##
|
494
501
|
# Update the ConversationInstance
|
495
502
|
# @param [String] friendly_name The human-readable name of this conversation,
|
@@ -200,6 +200,9 @@ module Twilio
|
|
200
200
|
# Path Solution
|
201
201
|
@solution = {sid: sid, }
|
202
202
|
@uri = "/Sims/#{@solution[:sid]}"
|
203
|
+
|
204
|
+
# Dependents
|
205
|
+
@billing_periods = nil
|
203
206
|
end
|
204
207
|
|
205
208
|
##
|
@@ -246,6 +249,18 @@ module Twilio
|
|
246
249
|
SimInstance.new(@version, payload, sid: @solution[:sid], )
|
247
250
|
end
|
248
251
|
|
252
|
+
##
|
253
|
+
# Access the billing_periods
|
254
|
+
# @return [BillingPeriodList]
|
255
|
+
# @return [BillingPeriodContext]
|
256
|
+
def billing_periods
|
257
|
+
unless @billing_periods
|
258
|
+
@billing_periods = BillingPeriodList.new(@version, sim_sid: @solution[:sid], )
|
259
|
+
end
|
260
|
+
|
261
|
+
@billing_periods
|
262
|
+
end
|
263
|
+
|
249
264
|
##
|
250
265
|
# Provide a user friendly representation
|
251
266
|
def to_s
|
@@ -284,6 +299,7 @@ module Twilio
|
|
284
299
|
'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
|
285
300
|
'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
|
286
301
|
'url' => payload['url'],
|
302
|
+
'links' => payload['links'],
|
287
303
|
}
|
288
304
|
|
289
305
|
# Context
|
@@ -356,6 +372,12 @@ module Twilio
|
|
356
372
|
@properties['url']
|
357
373
|
end
|
358
374
|
|
375
|
+
##
|
376
|
+
# @return [String] The links
|
377
|
+
def links
|
378
|
+
@properties['links']
|
379
|
+
end
|
380
|
+
|
359
381
|
##
|
360
382
|
# Fetch the SimInstance
|
361
383
|
# @return [SimInstance] Fetched SimInstance
|
@@ -394,6 +416,13 @@ module Twilio
|
|
394
416
|
)
|
395
417
|
end
|
396
418
|
|
419
|
+
##
|
420
|
+
# Access the billing_periods
|
421
|
+
# @return [billing_periods] billing_periods
|
422
|
+
def billing_periods
|
423
|
+
context.billing_periods
|
424
|
+
end
|
425
|
+
|
397
426
|
##
|
398
427
|
# Provide a user friendly representation
|
399
428
|
def to_s
|
@@ -0,0 +1,231 @@
|
|
1
|
+
##
|
2
|
+
# This code was generated by
|
3
|
+
# \ / _ _ _| _ _
|
4
|
+
# | (_)\/(_)(_|\/| |(/_ v1.0.0
|
5
|
+
# / /
|
6
|
+
#
|
7
|
+
# frozen_string_literal: true
|
8
|
+
|
9
|
+
module Twilio
|
10
|
+
module REST
|
11
|
+
class Supersim < Domain
|
12
|
+
class V1 < Version
|
13
|
+
class SimContext < InstanceContext
|
14
|
+
class BillingPeriodList < ListResource
|
15
|
+
##
|
16
|
+
# Initialize the BillingPeriodList
|
17
|
+
# @param [Version] version Version that contains the resource
|
18
|
+
# @param [String] sim_sid The SID of the Super SIM the Billing Period belongs to.
|
19
|
+
# @return [BillingPeriodList] BillingPeriodList
|
20
|
+
def initialize(version, sim_sid: nil)
|
21
|
+
super(version)
|
22
|
+
|
23
|
+
# Path Solution
|
24
|
+
@solution = {sim_sid: sim_sid}
|
25
|
+
@uri = "/Sims/#{@solution[:sim_sid]}/BillingPeriods"
|
26
|
+
end
|
27
|
+
|
28
|
+
##
|
29
|
+
# Lists BillingPeriodInstance records from the API as a list.
|
30
|
+
# Unlike stream(), this operation is eager and will load `limit` records into
|
31
|
+
# memory before returning.
|
32
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
33
|
+
# guarantees to never return more than limit. Default is no limit
|
34
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
35
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
36
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
37
|
+
# efficient page size, i.e. min(limit, 1000)
|
38
|
+
# @return [Array] Array of up to limit results
|
39
|
+
def list(limit: nil, page_size: nil)
|
40
|
+
self.stream(limit: limit, page_size: page_size).entries
|
41
|
+
end
|
42
|
+
|
43
|
+
##
|
44
|
+
# Streams BillingPeriodInstance records from the API as an Enumerable.
|
45
|
+
# This operation lazily loads records as efficiently as possible until the limit
|
46
|
+
# is reached.
|
47
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
48
|
+
# guarantees to never return more than limit. Default is no limit.
|
49
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
50
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
51
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
52
|
+
# efficient page size, i.e. min(limit, 1000)
|
53
|
+
# @return [Enumerable] Enumerable that will yield up to limit results
|
54
|
+
def stream(limit: nil, page_size: nil)
|
55
|
+
limits = @version.read_limits(limit, page_size)
|
56
|
+
|
57
|
+
page = self.page(page_size: limits[:page_size], )
|
58
|
+
|
59
|
+
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
60
|
+
end
|
61
|
+
|
62
|
+
##
|
63
|
+
# When passed a block, yields BillingPeriodInstance records from the API.
|
64
|
+
# This operation lazily loads records as efficiently as possible until the limit
|
65
|
+
# is reached.
|
66
|
+
def each
|
67
|
+
limits = @version.read_limits
|
68
|
+
|
69
|
+
page = self.page(page_size: limits[:page_size], )
|
70
|
+
|
71
|
+
@version.stream(page,
|
72
|
+
limit: limits[:limit],
|
73
|
+
page_limit: limits[:page_limit]).each {|x| yield x}
|
74
|
+
end
|
75
|
+
|
76
|
+
##
|
77
|
+
# Retrieve a single page of BillingPeriodInstance records from the API.
|
78
|
+
# Request is executed immediately.
|
79
|
+
# @param [String] page_token PageToken provided by the API
|
80
|
+
# @param [Integer] page_number Page Number, this value is simply for client state
|
81
|
+
# @param [Integer] page_size Number of records to return, defaults to 50
|
82
|
+
# @return [Page] Page of BillingPeriodInstance
|
83
|
+
def page(page_token: :unset, page_number: :unset, page_size: :unset)
|
84
|
+
params = Twilio::Values.of({
|
85
|
+
'PageToken' => page_token,
|
86
|
+
'Page' => page_number,
|
87
|
+
'PageSize' => page_size,
|
88
|
+
})
|
89
|
+
|
90
|
+
response = @version.page('GET', @uri, params: params)
|
91
|
+
|
92
|
+
BillingPeriodPage.new(@version, response, @solution)
|
93
|
+
end
|
94
|
+
|
95
|
+
##
|
96
|
+
# Retrieve a single page of BillingPeriodInstance records from the API.
|
97
|
+
# Request is executed immediately.
|
98
|
+
# @param [String] target_url API-generated URL for the requested results page
|
99
|
+
# @return [Page] Page of BillingPeriodInstance
|
100
|
+
def get_page(target_url)
|
101
|
+
response = @version.domain.request(
|
102
|
+
'GET',
|
103
|
+
target_url
|
104
|
+
)
|
105
|
+
BillingPeriodPage.new(@version, response, @solution)
|
106
|
+
end
|
107
|
+
|
108
|
+
##
|
109
|
+
# Provide a user friendly representation
|
110
|
+
def to_s
|
111
|
+
'#<Twilio.Supersim.V1.BillingPeriodList>'
|
112
|
+
end
|
113
|
+
end
|
114
|
+
|
115
|
+
class BillingPeriodPage < Page
|
116
|
+
##
|
117
|
+
# Initialize the BillingPeriodPage
|
118
|
+
# @param [Version] version Version that contains the resource
|
119
|
+
# @param [Response] response Response from the API
|
120
|
+
# @param [Hash] solution Path solution for the resource
|
121
|
+
# @return [BillingPeriodPage] BillingPeriodPage
|
122
|
+
def initialize(version, response, solution)
|
123
|
+
super(version, response)
|
124
|
+
|
125
|
+
# Path Solution
|
126
|
+
@solution = solution
|
127
|
+
end
|
128
|
+
|
129
|
+
##
|
130
|
+
# Build an instance of BillingPeriodInstance
|
131
|
+
# @param [Hash] payload Payload response from the API
|
132
|
+
# @return [BillingPeriodInstance] BillingPeriodInstance
|
133
|
+
def get_instance(payload)
|
134
|
+
BillingPeriodInstance.new(@version, payload, sim_sid: @solution[:sim_sid], )
|
135
|
+
end
|
136
|
+
|
137
|
+
##
|
138
|
+
# Provide a user friendly representation
|
139
|
+
def to_s
|
140
|
+
'<Twilio.Supersim.V1.BillingPeriodPage>'
|
141
|
+
end
|
142
|
+
end
|
143
|
+
|
144
|
+
class BillingPeriodInstance < InstanceResource
|
145
|
+
##
|
146
|
+
# Initialize the BillingPeriodInstance
|
147
|
+
# @param [Version] version Version that contains the resource
|
148
|
+
# @param [Hash] payload payload that contains response from Twilio
|
149
|
+
# @param [String] sim_sid The SID of the Super SIM the Billing Period belongs to.
|
150
|
+
# @return [BillingPeriodInstance] BillingPeriodInstance
|
151
|
+
def initialize(version, payload, sim_sid: nil)
|
152
|
+
super(version)
|
153
|
+
|
154
|
+
# Marshaled Properties
|
155
|
+
@properties = {
|
156
|
+
'sid' => payload['sid'],
|
157
|
+
'account_sid' => payload['account_sid'],
|
158
|
+
'sim_sid' => payload['sim_sid'],
|
159
|
+
'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']),
|
160
|
+
'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
|
161
|
+
'period_type' => payload['period_type'],
|
162
|
+
'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
|
163
|
+
'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
|
164
|
+
}
|
165
|
+
end
|
166
|
+
|
167
|
+
##
|
168
|
+
# @return [String] The SID of the Billing Period
|
169
|
+
def sid
|
170
|
+
@properties['sid']
|
171
|
+
end
|
172
|
+
|
173
|
+
##
|
174
|
+
# @return [String] The SID of the Account the Super SIM belongs to
|
175
|
+
def account_sid
|
176
|
+
@properties['account_sid']
|
177
|
+
end
|
178
|
+
|
179
|
+
##
|
180
|
+
# @return [String] The SID of the Super SIM the Billing Period belongs to
|
181
|
+
def sim_sid
|
182
|
+
@properties['sim_sid']
|
183
|
+
end
|
184
|
+
|
185
|
+
##
|
186
|
+
# @return [Time] The start time of the Billing Period
|
187
|
+
def start_time
|
188
|
+
@properties['start_time']
|
189
|
+
end
|
190
|
+
|
191
|
+
##
|
192
|
+
# @return [Time] The end time of the Billing Period
|
193
|
+
def end_time
|
194
|
+
@properties['end_time']
|
195
|
+
end
|
196
|
+
|
197
|
+
##
|
198
|
+
# @return [billing_period.BpType] The type of the Billing Period
|
199
|
+
def period_type
|
200
|
+
@properties['period_type']
|
201
|
+
end
|
202
|
+
|
203
|
+
##
|
204
|
+
# @return [Time] The ISO 8601 date and time in GMT when the resource was created
|
205
|
+
def date_created
|
206
|
+
@properties['date_created']
|
207
|
+
end
|
208
|
+
|
209
|
+
##
|
210
|
+
# @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
|
211
|
+
def date_updated
|
212
|
+
@properties['date_updated']
|
213
|
+
end
|
214
|
+
|
215
|
+
##
|
216
|
+
# Provide a user friendly representation
|
217
|
+
def to_s
|
218
|
+
"<Twilio.Supersim.V1.BillingPeriodInstance>"
|
219
|
+
end
|
220
|
+
|
221
|
+
##
|
222
|
+
# Provide a detailed, user friendly representation
|
223
|
+
def inspect
|
224
|
+
"<Twilio.Supersim.V1.BillingPeriodInstance>"
|
225
|
+
end
|
226
|
+
end
|
227
|
+
end
|
228
|
+
end
|
229
|
+
end
|
230
|
+
end
|
231
|
+
end
|
data/lib/twilio-ruby/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: twilio-ruby
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 5.
|
4
|
+
version: 5.56.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Twilio API Team
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-06-
|
11
|
+
date: 2021-06-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: jwt
|
@@ -236,23 +236,25 @@ files:
|
|
236
236
|
- githooks/pre-commit
|
237
237
|
- lib/rack/twilio_webhook_authentication.rb
|
238
238
|
- lib/twilio-ruby.rb
|
239
|
-
- lib/twilio-ruby/framework/domain.rb
|
240
|
-
- lib/twilio-ruby/framework/error.rb
|
241
|
-
- lib/twilio-ruby/framework/helper.rb
|
242
|
-
- lib/twilio-ruby/framework/obsolete_client.rb
|
243
|
-
- lib/twilio-ruby/framework/page.rb
|
244
239
|
- lib/twilio-ruby/framework/request.rb
|
245
|
-
- lib/twilio-ruby/framework/resource.rb
|
246
240
|
- lib/twilio-ruby/framework/response.rb
|
241
|
+
- lib/twilio-ruby/framework/rest/domain.rb
|
242
|
+
- lib/twilio-ruby/framework/rest/error.rb
|
243
|
+
- lib/twilio-ruby/framework/rest/helper.rb
|
244
|
+
- lib/twilio-ruby/framework/rest/obsolete_client.rb
|
245
|
+
- lib/twilio-ruby/framework/rest/page.rb
|
246
|
+
- lib/twilio-ruby/framework/rest/resource.rb
|
247
|
+
- lib/twilio-ruby/framework/rest/version.rb
|
247
248
|
- lib/twilio-ruby/framework/serialize.rb
|
248
249
|
- lib/twilio-ruby/framework/twilio_response.rb
|
249
250
|
- lib/twilio-ruby/framework/values.rb
|
250
|
-
- lib/twilio-ruby/
|
251
|
+
- lib/twilio-ruby/http.rb
|
251
252
|
- lib/twilio-ruby/http/http_client.rb
|
252
253
|
- lib/twilio-ruby/jwt/access_token.rb
|
253
254
|
- lib/twilio-ruby/jwt/client_capability.rb
|
254
255
|
- lib/twilio-ruby/jwt/jwt.rb
|
255
256
|
- lib/twilio-ruby/jwt/task_router.rb
|
257
|
+
- lib/twilio-ruby/rest.rb
|
256
258
|
- lib/twilio-ruby/rest/accounts.rb
|
257
259
|
- lib/twilio-ruby/rest/accounts/v1.rb
|
258
260
|
- lib/twilio-ruby/rest/accounts/v1/auth_token_promotion.rb
|
@@ -622,6 +624,7 @@ files:
|
|
622
624
|
- lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb
|
623
625
|
- lib/twilio-ruby/rest/supersim/v1/network_access_profile/network_access_profile_network.rb
|
624
626
|
- lib/twilio-ruby/rest/supersim/v1/sim.rb
|
627
|
+
- lib/twilio-ruby/rest/supersim/v1/sim/billing_period.rb
|
625
628
|
- lib/twilio-ruby/rest/supersim/v1/sms_command.rb
|
626
629
|
- lib/twilio-ruby/rest/supersim/v1/usage_record.rb
|
627
630
|
- lib/twilio-ruby/rest/sync.rb
|