twilio-ruby 5.8.1 → 5.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96dfe1755e485568a5ae67471ebb9ca1cd4f7978
-  data.tar.gz: ad246f39e5739b9209436a19066a10d27ccd9ea7
+  metadata.gz: d2668bc72407cd9d9b495cfe2069b7110738f9c6
+  data.tar.gz: 100681bc6b203cf585b33d84c19830c0693ceb27
 SHA512:
-  metadata.gz: 64bb9b61131575a991142432d073ab5ac2b36f10239dfbdec32f8a79e2268cc7afa44ab5ce1346a13906ab2f8ded4c852dd1ffe3d620d558de28155f3a5634df
-  data.tar.gz: fd28ffaec1cca7d04b07c3e6b426200457cf976e7baf1ebaaa2b88449b2e6366c58d671adb370a18e88127cba105e37cc8aca930a2dfbec7abdfe298cfe03049
+  metadata.gz: 41bc8928fafdfe7c496226129c0e55eaf7892218e8ed151855fe79a3806c801ceb0d65aaed962eac66726b2954faaa2720647df7c07af4770e4e629df03f1c99
+  data.tar.gz: 9918116537ce84d427d456bd3d6ce3981675500650541df719addb30a7a526438694e27ce4c0c6a492d2f82c3b16988f63aca9623e5bd7e5c8571d5534b58d8b

data/CHANGES.md

@@ -1,6 +1,15 @@
 twilio-ruby changelog
 =====================
 
+[2018-04-27] Version 5.9.0
+---------------------------
+**Library**
+- PR #403: Adds frozen_string_literal magic comment. Thanks to @philnash!
+
+**Video**
+- Redesign API by adding custom `VideoLayout` object. **(breaking change)**
+
+
 [2018-04-20] Version 5.8.1
 ---------------------------
 **Library**

data/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,4 @@
+Please ensure the following steps have been run before submitting this pull request:
+
+- [ ] Run `make test` and ensure it passes locally
+- [ ] Run `make lint` to appease Rubocop

data/README.md

@@ -27,13 +27,13 @@ in-line code documentation here in the library.
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.8.1'
+gem 'twilio-ruby', '~> 5.9.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.8.1
+gem install twilio-ruby -v 5.9.0
 ```
 
 To build and install the development branch yourself from the latest source:

data/lib/rack/twilio_webhook_authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rack
   # Middleware that authenticates webhooks from Twilio using the request
   # validator.

data/lib/twilio-ruby/framework/domain.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     class Domain

data/lib/twilio-ruby/framework/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     class TwilioError < StandardError

data/lib/twilio-ruby/framework/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     def url_join(left, right)

data/lib/twilio-ruby/framework/obsolete_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     class ObsoleteClient

data/lib/twilio-ruby/framework/page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     # Page Base Class

data/lib/twilio-ruby/framework/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   class Request
     attr_reader :host, :port, :method, :url, :params, :data, :headers, :auth, :timeout

data/lib/twilio-ruby/framework/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     class ListResource

data/lib/twilio-ruby/framework/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   class Response
     attr_accessor :status_code, :body, :headers

data/lib/twilio-ruby/framework/serialize.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   def self.serialize_iso8601_date(date)
     if date.eql?(:unset)

data/lib/twilio-ruby/framework/twilio_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   class TwilioResponse
     attr_accessor :status_code, :body

data/lib/twilio-ruby/framework/values.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   class Values
     def self.of(hash)

data/lib/twilio-ruby/framework/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     class Version

data/lib/twilio-ruby/http/http_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 
 module Twilio

data/lib/twilio-ruby/jwt/access_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module JWT
     module AccessTokenGrant

data/lib/twilio-ruby/jwt/client_capability.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module JWT
     module Scope

data/lib/twilio-ruby/jwt/jwt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module JWT
     class BaseJWT

data/lib/twilio-ruby/jwt/task_router.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module JWT
     class TaskRouterCapability < BaseJWT

data/lib/twilio-ruby/rest/accounts/v1/credential/aws.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/accounts/v1/credential.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/accounts/v1.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/accounts.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,7 +17,8 @@ module Twilio
               # Initialize the DependentPhoneNumberList
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid The account_sid
-              # @param [String] address_sid The sid
+              # @param [String] address_sid A 34 character string that uniquely identifies this
+              #   address.
               # @return [DependentPhoneNumberList] DependentPhoneNumberList
               def initialize(version, account_sid: nil, address_sid: nil)
                 super(version)
@@ -154,7 +157,8 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] account_sid The account_sid
-              # @param [String] address_sid The sid
+              # @param [String] address_sid A 34 character string that uniquely identifies this
+              #   address.
               # @return [DependentPhoneNumberInstance] DependentPhoneNumberInstance
               def initialize(version, payload, account_sid: nil, address_sid: nil)
                 super(version)

data/lib/twilio-ruby/rest/api/v2010/account/address.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,9 @@ module Twilio
             ##
             # Initialize the AddressList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
+            # @param [String] account_sid The unique id of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
+            #   address.
             # @return [AddressList] AddressList
             def initialize(version, account_sid: nil)
               super(version)
@@ -26,15 +30,24 @@ module Twilio
             ##
             # Retrieve a single page of AddressInstance records from the API.
             # Request is executed immediately.
-            # @param [String] customer_name The customer_name
-            # @param [String] street The street
-            # @param [String] city The city
-            # @param [String] region The region
-            # @param [String] postal_code The postal_code
-            # @param [String] iso_country The iso_country
-            # @param [String] friendly_name The friendly_name
+            # @param [String] customer_name Your name or business name, or that of your
+            #   customer.
+            # @param [String] street The number and street address where you or your customer
+            #   is located.
+            # @param [String] city The city in which you or your customer is located.
+            # @param [String] region The state or region in which you or your customer is
+            #   located.
+            # @param [String] postal_code The postal code in which you or your customer is
+            #   located.
+            # @param [String] iso_country The ISO country code of your or your customer's
+            #   address.
+            # @param [String] friendly_name A human-readable description of the new address.
+            #   Maximum 64 characters.
             # @param [Boolean] emergency_enabled The emergency_enabled
-            # @param [Boolean] auto_correct_address The auto_correct_address
+            # @param [Boolean] auto_correct_address If you don't set a value for this
+            #   parameter, or if you set it to `true`, then the system will, if necessary,
+            #   auto-correct the address you provide. If you don't want the system to
+            #   auto-correct the address, you will explicitly need to set this value to `false`.
             # @return [AddressInstance] Newly created AddressInstance
             def create(customer_name: nil, street: nil, city: nil, region: nil, postal_code: nil, iso_country: nil, friendly_name: :unset, emergency_enabled: :unset, auto_correct_address: :unset)
               data = Twilio::Values.of({
@@ -62,9 +75,11 @@ module Twilio
             # Lists AddressInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] customer_name The customer_name
-            # @param [String] friendly_name The friendly_name
-            # @param [String] iso_country The iso_country
+            # @param [String] customer_name Only return the Address resources with customer
+            #   names that exactly match this name.
+            # @param [String] friendly_name Only return the Address resources with friendly
+            #   names that exactly match this name.
+            # @param [String] iso_country Only return the Address resources in this country.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit.  Default is no limit
             # @param [Integer] page_size Number of records to fetch per request, when
@@ -86,9 +101,11 @@ module Twilio
             # Streams AddressInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] customer_name The customer_name
-            # @param [String] friendly_name The friendly_name
-            # @param [String] iso_country The iso_country
+            # @param [String] customer_name Only return the Address resources with customer
+            #   names that exactly match this name.
+            # @param [String] friendly_name Only return the Address resources with friendly
+            #   names that exactly match this name.
+            # @param [String] iso_country Only return the Address resources in this country.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit. Default is no limit.
             # @param [Integer] page_size Number of records to fetch per request, when
@@ -126,9 +143,11 @@ module Twilio
             ##
             # Retrieve a single page of AddressInstance records from the API.
             # Request is executed immediately.
-            # @param [String] customer_name The customer_name
-            # @param [String] friendly_name The friendly_name
-            # @param [String] iso_country The iso_country
+            # @param [String] customer_name Only return the Address resources with customer
+            #   names that exactly match this name.
+            # @param [String] friendly_name Only return the Address resources with friendly
+            #   names that exactly match this name.
+            # @param [String] iso_country Only return the Address resources in this country.
             # @param [String] page_token PageToken provided by the API
             # @param [Integer] page_number Page Number, this value is simply for client state
             # @param [Integer] page_size Number of records to return, defaults to 50
@@ -241,14 +260,22 @@ module Twilio
 
             ##
             # Update the AddressInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] customer_name The customer_name
-            # @param [String] street The street
-            # @param [String] city The city
-            # @param [String] region The region
-            # @param [String] postal_code The postal_code
+            # @param [String] friendly_name A human-readable description of the address.
+            #   Maximum 64 characters.
+            # @param [String] customer_name Your name or business name, or that of your
+            #   customer.
+            # @param [String] street The number and street address where you or your customer
+            #   is located.
+            # @param [String] city The city in which you or your customer is located.
+            # @param [String] region The state or region in which you or your customer is
+            #   located.
+            # @param [String] postal_code The postal code in which you or your customer is
+            #   located.
             # @param [Boolean] emergency_enabled The emergency_enabled
-            # @param [Boolean] auto_correct_address The auto_correct_address
+            # @param [Boolean] auto_correct_address If you don't set a value for this
+            #   parameter, or if you set it to `true`, then the system will, if necessary,
+            #   auto-correct the address you provide. If you don't want the system to
+            #   auto-correct the address, you will explicitly need to set this value to `false`.
             # @return [AddressInstance] Updated AddressInstance
             def update(friendly_name: :unset, customer_name: :unset, street: :unset, city: :unset, region: :unset, postal_code: :unset, emergency_enabled: :unset, auto_correct_address: :unset)
               data = Twilio::Values.of({
@@ -300,7 +327,9 @@ module Twilio
             # Initialize the AddressInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] account_sid The account_sid
+            # @param [String] account_sid The unique id of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
+            #   address.
             # @param [String] sid The sid
             # @return [AddressInstance] AddressInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
@@ -341,19 +370,19 @@ module Twilio
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The unique id of the Account responsible for this address.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The city
+            # @return [String] The city in which you or your customer is located.
             def city
               @properties['city']
             end
 
             ##
-            # @return [String] The customer_name
+            # @return [String] Your name or business name, or that of your customer.
             def customer_name
               @properties['customer_name']
             end
@@ -371,55 +400,55 @@ module Twilio
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] A human-readable description of the address.
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The iso_country
+            # @return [String] The ISO country code of your or your customer's address.
             def iso_country
               @properties['iso_country']
             end
 
             ##
-            # @return [String] The postal_code
+            # @return [String] The postal code in which you or your customer is located.
             def postal_code
               @properties['postal_code']
             end
 
             ##
-            # @return [String] The region
+            # @return [String] The state or region in which you or your customer is located.
             def region
               @properties['region']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A 34 character string that uniquely identifies this address.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The street
+            # @return [String] The number and street address where you or your customer is located.
             def street
               @properties['street']
             end
 
             ##
-            # @return [String] The uri
+            # @return [String] The URI for this resource, relative to https://api.
             def uri
               @properties['uri']
             end
 
             ##
-            # @return [Boolean] The emergency_enabled
+            # @return [Boolean] This is a value that indicates if emergency calling has been enabled on this number.
             def emergency_enabled
               @properties['emergency_enabled']
             end
 
             ##
-            # @return [Boolean] The validated
+            # @return [Boolean] In some countries, addresses are validated to comply with local regulation.
             def validated
               @properties['validated']
             end
@@ -440,14 +469,22 @@ module Twilio
 
             ##
             # Update the AddressInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] customer_name The customer_name
-            # @param [String] street The street
-            # @param [String] city The city
-            # @param [String] region The region
-            # @param [String] postal_code The postal_code
+            # @param [String] friendly_name A human-readable description of the address.
+            #   Maximum 64 characters.
+            # @param [String] customer_name Your name or business name, or that of your
+            #   customer.
+            # @param [String] street The number and street address where you or your customer
+            #   is located.
+            # @param [String] city The city in which you or your customer is located.
+            # @param [String] region The state or region in which you or your customer is
+            #   located.
+            # @param [String] postal_code The postal code in which you or your customer is
+            #   located.
             # @param [Boolean] emergency_enabled The emergency_enabled
-            # @param [Boolean] auto_correct_address The auto_correct_address
+            # @param [Boolean] auto_correct_address If you don't set a value for this
+            #   parameter, or if you set it to `true`, then the system will, if necessary,
+            #   auto-correct the address you provide. If you don't want the system to
+            #   auto-correct the address, you will explicitly need to set this value to `false`.
             # @return [AddressInstance] Updated AddressInstance
             def update(friendly_name: :unset, customer_name: :unset, street: :unset, city: :unset, region: :unset, postal_code: :unset, emergency_enabled: :unset, auto_correct_address: :unset)
               context.update(