twilio-ruby 5.18.0 → 5.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e418d7d21510dea6981e3c385aed3061d51f4ad1
-  data.tar.gz: 97936c90f34ad95d5d72783c4f08e990cd1569bb
+SHA256:
+  metadata.gz: fe045a2e772454c9b888039ad8140d8f4645ce87756e12c09024d2f7b65c3cd2
+  data.tar.gz: e74ff7b452249e730a32e5fcc2d419d7157b71db0519e3822d8175509cec6a19
 SHA512:
-  metadata.gz: 23243a677dab11740bb16fc2dc4f5a4d8369b2b9444be7338a0447b64e77ae6a5594068703f4d837b1224f3c1916fadfff2660f28b76c3d55eba82ccad62c663
-  data.tar.gz: e8bb8fa788bfaada41bd560037cc1e2be6552174a96aca5416c0f84883665454b45e079fa4b9084dca2030bbd3ab2642ea87cdc38a69f0b04ba287b96ee2b76c
+  metadata.gz: c9734374ce684115310150d8aa8ee367a3704628cdfeedcb421264f90df53b9330642ad0c8c612ff6eec712aedfba2bd46cc5464cba8d4e9dcde0d93cff1b7ae
+  data.tar.gz: 9e4cea3ca89dbc6634330b1d0797d870b53f92b3bc3c834e08436a5b3cada6e45d541041bd22f6ae70257f69edc0a5df3c2bbc24d14d1c94a8d90c764246b0a5

data/.travis.yml

@@ -17,10 +17,6 @@ services:
 matrix:
   fast_finish: true
 
-before_install:
-  # Bundler on Travis may be too out of date
-  # Update bundler to a recent version.
-  - gem install bundler
 deploy:
   provider: script
   script: make docker-build && make docker-push

data/CHANGES.md

@@ -1,6 +1,26 @@
 twilio-ruby changelog
 =====================
 
+[2019-01-11] Version 5.19.0
+----------------------------
+**Library**
+- PR #436: Remove jruby-openssl requirement. Thanks to @philnash!
+
+**Chat**
+- Mark Member attributes as PII
+
+**Insights**
+- Initial revision.
+
+**Proxy**
+- Remove unsupported query parameters **(breaking change)**
+- Remove invalid session statuses in doc
+
+**Verify**
+- Add `lookup` information in the response when creating a new verification (depends on the LookupEnabled flag being enabled at the service level)
+- Add `VerificationSid` optional parameter on Verification check.
+
+
 [2018-12-17] Version 5.18.0
 ----------------------------
 **Authy**

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2018, Twilio, Inc. <help@twilio.com>
+Copyright (C) 2019, Twilio, Inc. <help@twilio.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

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.18.0'
+gem 'twilio-ruby', '~> 5.19.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.18.0
+gem install twilio-ruby -v 5.19.0
 ```
 
 To build and install the development branch yourself from the latest source:

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

@@ -109,9 +109,13 @@ module Twilio
             ##
             # Retrieve a single page of AwsInstance records from the API.
             # Request is executed immediately.
-            # @param [String] credentials The credentials
-            # @param [String] friendly_name The friendly_name
-            # @param [String] account_sid The account_sid
+            # @param [String] credentials String containing AWS access credentials with format
+            #   <AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>, e.g.
+            #   AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+            # @param [String] friendly_name A human readable description of this resource, up
+            #   to 64 characters.
+            # @param [String] account_sid The Subaccount this Credential should be associated
+            #   with. Needs to be a valid Subaccount of the account issuing the request
             # @return [AwsInstance] Newly created AwsInstance
             def create(credentials: nil, friendly_name: :unset, account_sid: :unset)
               data = Twilio::Values.of({
@@ -169,7 +173,8 @@ module Twilio
             ##
             # Initialize the AwsContext
             # @param [Version] version Version that contains the resource
-            # @param [String] sid The sid
+            # @param [String] sid The Credential Sid that uniquely identifies the Credential
+            #   to fetch
             # @return [AwsContext] AwsContext
             def initialize(version, sid)
               super(version)
@@ -196,7 +201,8 @@ module Twilio
 
             ##
             # Update the AwsInstance
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A human readable description of this resource, up
+            #   to 64 characters.
             # @return [AwsInstance] Updated AwsInstance
             def update(friendly_name: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -230,7 +236,8 @@ module Twilio
             # Initialize the AwsInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] sid The sid
+            # @param [String] sid The Credential Sid that uniquely identifies the Credential
+            #   to fetch
             # @return [AwsInstance] AwsInstance
             def initialize(version, payload, sid: nil)
               super(version)
@@ -262,37 +269,37 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A 34 character string that uniquely identifies this resource.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] AccountSid the Credential resource belongs to
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] A human readable description of this resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date this resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date this resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The URI for this resource, relative to `https://accounts.twilio.com`
             def url
               @properties['url']
             end
@@ -306,7 +313,8 @@ module Twilio
 
             ##
             # Update the AwsInstance
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A human readable description of this resource, up
+            #   to 64 characters.
             # @return [AwsInstance] Updated AwsInstance
             def update(friendly_name: :unset)
               context.update(friendly_name: friendly_name, )

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

@@ -44,7 +44,8 @@ module Twilio
 
           ##
           # Access the aws
-          # @param [String] sid The sid
+          # @param [String] sid The Credential Sid that uniquely identifies the Credential
+          #   to fetch
           # @return [AwsList]
           # @return [AwsContext] if sid was passed.
           def aws(sid=:unset)

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

@@ -19,8 +19,8 @@ module Twilio
               # @param [String] account_sid The unique id of the
               #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
               #   resource.
-              # @param [String] call_sid A 34-character string that uniquely identifies the Call
-              #   resource.
+              # @param [String] call_sid The unique string that that we created to identify this
+              #   Call resource.
               # @return [FeedbackList] FeedbackList
               def initialize(version, account_sid: nil, call_sid: nil)
                 super(version)
@@ -183,8 +183,8 @@ module Twilio
               # @param [String] account_sid The unique id of the
               #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
               #   resource.
-              # @param [String] call_sid A 34-character string that uniquely identifies the Call
-              #   resource.
+              # @param [String] call_sid The unique string that that we created to identify this
+              #   Call resource.
               # @return [FeedbackInstance] FeedbackInstance
               def initialize(version, payload, account_sid: nil, call_sid: nil)
                 super(version)

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

@@ -16,9 +16,9 @@ module Twilio
               ##
               # Initialize the FeedbackSummaryList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The unique id of the
-              #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for creating
-              #   this Call.
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created this Call
+              #   resource.
               # @return [FeedbackSummaryList] FeedbackSummaryList
               def initialize(version, account_sid: nil)
                 super(version)
@@ -155,9 +155,9 @@ module Twilio
               # Initialize the FeedbackSummaryInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] account_sid The unique id of the
-              #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for creating
-              #   this Call.
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created this Call
+              #   resource.
               # @param [String] sid A 34 character string that uniquely identifies this
               #   resource.
               # @return [FeedbackSummaryInstance] FeedbackSummaryInstance

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

@@ -16,11 +16,12 @@ module Twilio
               ##
               # Initialize the RecordingList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The unique ID of the
-              #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
-              #   recording.
-              # @param [String] call_sid A unique identifier for the call associated with the
-              #   recording. This will always refer to the parent leg of a two leg call.
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created this
+              #   Recording resource.
+              # @param [String] call_sid The SID of the
+              #   [Call](https://www.twilio.com/docs/api/voice/call) this Recording resource is
+              #   associated with.
               # @return [RecordingList] RecordingList
               def initialize(version, account_sid: nil, call_sid: nil)
                 super(version)
@@ -33,23 +34,26 @@ module Twilio
               ##
               # Retrieve a single page of RecordingInstance records from the API.
               # Request is executed immediately.
-              # @param [String] recording_status_callback_event The recording status changes
-              #   that should generate a request to the URL specified in RecordingStatusCallback.
-              #   Possible values: `in-progress`, `completed` and `absent`. To specify multiple
-              #   values separate them with a space. Defaults to `completed`.
-              # @param [String] recording_status_callback The URL which Twilio will make its GET
-              #   or POST request to for the recording events specified in parameter
-              #   RecordingStatusCallbackEvent. See [RecordingStatusCallback
-              #   parameters](https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback) for more details.
-              # @param [String] recording_status_callback_method The HTTP method Twilio should
-              #   use when making a request to the RecordingStatusCallback URL. Possible values:
-              #   `GET`, `POST`. Defaults to `POST`.
-              # @param [String] trim Possible values: `trim-silence` or `do-not-trim`.
-              #   `trim-silence` will trim the silence from the beginning and end of the
-              #   recording. `do-not-trim` will not trim the silence. Defaults to `do-not-trim`
-              # @param [String] recording_channels Possible values: `mono` or `dual`. `mono`
-              #   records all parties of your call into one channel. `dual` records a 2 party call
-              #   into separate channels. Defaults to `mono`.
+              # @param [String] recording_status_callback_event The recording status events on
+              #   which we should call the `recording_status_callback` URL. Can be: `in-progress`,
+              #   `completed` and `absent` and the default is `completed`. Separate multiple event
+              #   values with a space. 
+              # @param [String] recording_status_callback The URL we call using the
+              #   `recording_status_callback_method` on each recording event specified in 
+              #   `recording_status_callback_event`. For more information, see
+              #   [RecordingStatusCallback
+              #   parameters](https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback).
+              # @param [String] recording_status_callback_method The HTTP method we should use
+              #   when calling the `recording_status_callback` URL. Can be: `GET`, `POST` and the
+              #   default is `POST`.
+              # @param [String] trim Whether to trim any leading and trailing silence in the
+              #   recording. Can be: `trim-silence` or `do-not-trim` and the default is
+              #   `do-not-trim`. `trim-silence` trims the silence from the beginning and end of
+              #   the recording and `do-not-trim` does not.
+              # @param [String] recording_channels The number of channels used in the recording.
+              #   Can be: `mono` or `dual` and the default is `mono`. `mono` records all parties
+              #   of the call into one channel. `dual` records each party of a 2-party call into
+              #   separate channels.
               # @return [RecordingInstance] Newly created RecordingInstance
               def create(recording_status_callback_event: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, trim: :unset, recording_channels: :unset)
                 data = Twilio::Values.of({
@@ -78,9 +82,9 @@ module Twilio
               # Lists RecordingInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [Time] date_created_before Filter by date created
-              # @param [Time] date_created Filter by date created
-              # @param [Time] date_created_after Filter by date created
+              # @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created_after The `YYYY-MM-DD` value of the resources to read
               # @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
@@ -102,9 +106,9 @@ module Twilio
               # Streams RecordingInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [Time] date_created_before Filter by date created
-              # @param [Time] date_created Filter by date created
-              # @param [Time] date_created_after Filter by date created
+              # @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created_after The `YYYY-MM-DD` value of the resources to read
               # @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
@@ -142,9 +146,9 @@ module Twilio
               ##
               # Retrieve a single page of RecordingInstance records from the API.
               # Request is executed immediately.
-              # @param [Time] date_created_before Filter by date created
-              # @param [Time] date_created Filter by date created
-              # @param [Time] date_created_after Filter by date created
+              # @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created_after The `YYYY-MM-DD` value of the resources to read
               # @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
@@ -224,11 +228,13 @@ module Twilio
               ##
               # Initialize the RecordingContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The unique ID of the
-              #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
-              #   recording.
-              # @param [String] call_sid The call Sid that uniquely identifies this resource
-              # @param [String] sid The recording Sid that uniquely identifies this resource
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created the
+              #   Recording resource(s) to fetch.
+              # @param [String] call_sid The [Call](https://www.twilio.com/docs/api/voice/call)
+              #   SID of the resource(s) to fetch.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Recording resource to fetch
               # @return [RecordingContext] RecordingContext
               def initialize(version, account_sid, call_sid, sid)
                 super(version)
@@ -240,12 +246,13 @@ module Twilio
 
               ##
               # Update the RecordingInstance
-              # @param [recording.Status] status The status to change the recording to. 
-              #   Possible values: `stopped`, `paused`, `in-progress`
-              # @param [String] pause_behavior Only applicable when setting Status parameter to
-              #   `paused`. Possible values: `skip` or `silence`. `skip` will result in no
-              #   recording at all during the pause period. `silence` will replace the actual
-              #   audio of the call with silence during the pause period.  Defaults to `silence`
+              # @param [recording.Status] status The new status of the recording. Can be:
+              #   `stopped`, `paused`, `in-progress`
+              # @param [String] pause_behavior Whether to record during a pause. Can be: `skip`
+              #   or `silence` and the default is `silence`. `skip` does not record during the
+              #   pause period, while `silence` will replace the actual audio of the call with
+              #   silence during the pause period. This parameter only applies when setting
+              #   `status` is set to `paused`.
               # @return [RecordingInstance] Updated RecordingInstance
               def update(status: nil, pause_behavior: :unset)
                 data = Twilio::Values.of({'Status' => status, 'PauseBehavior' => pause_behavior, })
@@ -306,12 +313,14 @@ module Twilio
               # Initialize the RecordingInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] account_sid The unique ID of the
-              #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
-              #   recording.
-              # @param [String] call_sid A unique identifier for the call associated with the
-              #   recording. This will always refer to the parent leg of a two leg call.
-              # @param [String] sid The recording Sid that uniquely identifies this resource
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created this
+              #   Recording resource.
+              # @param [String] call_sid The SID of the
+              #   [Call](https://www.twilio.com/docs/api/voice/call) this Recording resource is
+              #   associated with.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Recording resource to fetch
               # @return [RecordingInstance] RecordingInstance
               def initialize(version, payload, account_sid: nil, call_sid: nil, sid: nil)
                 super(version)
@@ -359,55 +368,55 @@ module Twilio
               end
 
               ##
-              # @return [String] The unique sid that identifies this account
+              # @return [String] The SID of the Account that created this resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The version of the API in use during the recording.
+              # @return [String] The API version used to make the recording
               def api_version
                 @properties['api_version']
               end
 
               ##
-              # @return [String] The unique id for the call leg that corresponds to the recording.
+              # @return [String] The SID of the Call this resource is associated with
               def call_sid
                 @properties['call_sid']
               end
 
               ##
-              # @return [String] The unique id for the conference associated with the recording, if a conference recording.
+              # @return [String] The Conference SID that identifies the conference associated with the recording
               def conference_sid
                 @properties['conference_sid']
               end
 
               ##
-              # @return [Time] The date this resource was created
+              # @return [Time] The RFC 2822 date and time in GMT that this resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date this resource was last updated
+              # @return [Time] The RFC 2822 date and time in GMT that this resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [Time] The start time of the recording, given in RFC 2822 format.
+              # @return [Time] The start time of the recording, given in RFC 2822 format
               def start_time
                 @properties['start_time']
               end
 
               ##
-              # @return [String] The length of the recording, in seconds.
+              # @return [String] The length of the recording in seconds
               def duration
                 @properties['duration']
               end
 
               ##
-              # @return [String] A string that uniquely identifies this recording
+              # @return [String] The unique string that identifies this resource
               def sid
                 @properties['sid']
               end
@@ -419,55 +428,56 @@ module Twilio
               end
 
               ##
-              # @return [String] The URI for this resource
+              # @return [String] The URI of this resource, relative to `https://api.twilio.com`
               def uri
                 @properties['uri']
               end
 
               ##
-              # @return [Hash] Details for how to decrypt the recording.
+              # @return [Hash] Details about how to decrypt the recording
               def encryption_details
                 @properties['encryption_details']
               end
 
               ##
-              # @return [String] The currency used in the Price property.
+              # @return [String] The currency used in the Price property
               def price_unit
                 @properties['price_unit']
               end
 
               ##
-              # @return [recording.Status] The status of the recording.
+              # @return [recording.Status] The status of this recording
               def status
                 @properties['status']
               end
 
               ##
-              # @return [String] The number of channels in the final recording file as an integer.
+              # @return [String] The number of channels in the final recording file as an integer
               def channels
                 @properties['channels']
               end
 
               ##
-              # @return [recording.Source] The way in which this recording was created.
+              # @return [recording.Source] How this recording was created
               def source
                 @properties['source']
               end
 
               ##
-              # @return [String] More information about why the recording is missing, if Status is `absent`.
+              # @return [String] More information about why the recording is missing, if status is `absent`
               def error_code
                 @properties['error_code']
               end
 
               ##
               # Update the RecordingInstance
-              # @param [recording.Status] status The status to change the recording to. 
-              #   Possible values: `stopped`, `paused`, `in-progress`
-              # @param [String] pause_behavior Only applicable when setting Status parameter to
-              #   `paused`. Possible values: `skip` or `silence`. `skip` will result in no
-              #   recording at all during the pause period. `silence` will replace the actual
-              #   audio of the call with silence during the pause period.  Defaults to `silence`
+              # @param [recording.Status] status The new status of the recording. Can be:
+              #   `stopped`, `paused`, `in-progress`
+              # @param [String] pause_behavior Whether to record during a pause. Can be: `skip`
+              #   or `silence` and the default is `silence`. `skip` does not record during the
+              #   pause period, while `silence` will replace the actual audio of the call with
+              #   silence during the pause period. This parameter only applies when setting
+              #   `status` is set to `paused`.
               # @return [RecordingInstance] Updated RecordingInstance
               def update(status: nil, pause_behavior: :unset)
                 context.update(status: status, pause_behavior: pause_behavior, )