twilio-ruby 5.16.0 → 5.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 990fdb17dd39d71d342bee9cc7d71f0bd939214b
-  data.tar.gz: af52a8ab2f0fa61c7b0885fdf823e87c5d799a94
+SHA256:
+  metadata.gz: 76bee160e21650babe371c8f045b020200e802d65d9553ade40a9f27a0cb1454
+  data.tar.gz: 8a48441e1b442b85976a0a5b731a45bb7895be15be33b981d6a7bcfb8f2b729f
 SHA512:
-  metadata.gz: fcda9a64dcc8b8d084aace47dd2c393007fa95c91d0ca1bc76d46ffb47778befc475da8863f7ec3b6cf4b8507e2b858fd2ceee58205fee20af75c8346fb9eb3b
-  data.tar.gz: '09227a35d7584c5fab94983896117435fb15e1adc42372093f308b517f7d25abc91f2cfcbc128015b0fe6d0f3188beda79176e70fe8e8b47e3e5f1b0baadc2b1'
+  metadata.gz: 1c01b2cd4e9afba17aaebae337eabbd928d1de846de76373e2062d5b2796bccdb71267ba8164e2c3b65a0018987e11f12216022c8eac4ab42ce33447187cc17b
+  data.tar.gz: 755535e5ba8b07e7310fffc001b5d746f4a98d60cb64ab090438e291fa4b48f27b2a46c0e1faefb4016dda299989a72068d50731acb8de5ff1f6bee31a1f53d7

data/CHANGES.md

@@ -1,6 +1,28 @@
 twilio-ruby changelog
 =====================
 
+[2018-11-30] Version 5.17.0
+----------------------------
+**Api**
+- Add `interactive_data` optional param to Messages create request
+
+**Authy**
+- Required authentication for `/v1/Forms/{type}` endpoint **(breaking change)**
+- Removed `Challenge.reason` to `Challenge.responded_reason`
+- Removed `verification_sid` from Challenge responses
+- Removed `config` param from the Factor creation
+- Replaced all occurrences of `FactorType` and `FormType` in favor of a unified `Type` **(breaking change)**
+
+**Chat**
+- Add Member attributes
+
+**Preview**
+- Removed `Authy` version from `preview` subdomain in favor to `authy` subdomain. **(breaking change)**
+
+**Verify**
+- Add `CustomCode` optional parameter on Verication creation.
+
+
 [2018-11-16] Version 5.16.0
 ----------------------------
 **Messaging**

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

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

@@ -74,6 +74,9 @@ module Twilio
             # @param [message.ContentRetention] content_retention The content_retention
             # @param [message.AddressRetention] address_retention The address_retention
             # @param [Boolean] smart_encoded The smart_encoded
+            # @param [String] interactive_data A JSON string that represents interactive
+            #   message which is a category of messages including list picker, time picker, and
+            #   an Apple Pay request.
             # @param [String] from A Twilio phone number (in
             #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format),  [alphanumeric
             #   sender
@@ -104,7 +107,7 @@ module Twilio
             #   You may include up to 10 MediaUrls per message. *Sending images via SMS is
             #   currently only possible in the US and Canada*
             # @return [MessageInstance] Newly created MessageInstance
-            def create(to: nil, status_callback: :unset, application_sid: :unset, max_price: :unset, provide_feedback: :unset, validity_period: :unset, max_rate: :unset, force_delivery: :unset, provider_sid: :unset, content_retention: :unset, address_retention: :unset, smart_encoded: :unset, from: :unset, messaging_service_sid: :unset, body: :unset, media_url: :unset)
+            def create(to: nil, status_callback: :unset, application_sid: :unset, max_price: :unset, provide_feedback: :unset, validity_period: :unset, max_rate: :unset, force_delivery: :unset, provider_sid: :unset, content_retention: :unset, address_retention: :unset, smart_encoded: :unset, interactive_data: :unset, from: :unset, messaging_service_sid: :unset, body: :unset, media_url: :unset)
               data = Twilio::Values.of({
                   'To' => to,
                   'From' => from,
@@ -122,6 +125,7 @@ module Twilio
                   'ContentRetention' => content_retention,
                   'AddressRetention' => address_retention,
                   'SmartEncoded' => smart_encoded,
+                  'InteractiveData' => interactive_data,
               })
 
               payload = @version.create(

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

@@ -56,7 +56,7 @@ module Twilio
 
             ##
             # Access the ip_access_control_lists
-            # @param [String] sid The ip-access-control-list Sid that uniquely identifies this
+            # @param [String] sid The IpAccessControlList Sid that uniquely identifies this
             #   resource
             # @return [IpAccessControlListList]
             # @return [IpAccessControlListContext] if sid was passed.

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

@@ -113,7 +113,7 @@ module Twilio
               # Retrieve a single page of CredentialListInstance records from the API.
               # Request is executed immediately.
               # @param [String] friendly_name A human readable descriptive text that describes
-              #   the IpAccessControlList, up to 64 characters long.
+              #   the CredentialList, up to 64 characters long.
               # @return [CredentialListInstance] Newly created CredentialListInstance
               def create(friendly_name: nil)
                 data = Twilio::Values.of({'FriendlyName' => friendly_name, })

data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb

@@ -117,7 +117,7 @@ module Twilio
                 # @param [String] username The username that will be passed when authenticating
                 #   SIP requests. The username should be sent in response to Twilio’s challenge of
                 #   the initial INVITE. It can be up to 32 characters long.
-                # @param [String] password The password that the username will use when when
+                # @param [String] password The password that the username will use when
                 #   authenticating SIP requests. The password must be a minimum of 12 characters,
                 #   contain at least 1 digit, and have mixed case. (eg “IWasAtSignal2018”)
                 # @return [CredentialInstance] Newly created CredentialInstance
@@ -218,7 +218,7 @@ module Twilio
 
                 ##
                 # Update the CredentialInstance
-                # @param [String] password The password that the username will use when when
+                # @param [String] password The password that the username will use when
                 #   authenticating SIP requests. The password must be a minimum of 12 characters,
                 #   contain at least 1 digit, and have mixed case. (eg “IWasAtSignal2018”)
                 # @return [CredentialInstance] Updated CredentialInstance
@@ -355,7 +355,7 @@ module Twilio
 
                 ##
                 # Update the CredentialInstance
-                # @param [String] password The password that the username will use when when
+                # @param [String] password The password that the username will use when
                 #   authenticating SIP requests. The password must be a minimum of 12 characters,
                 #   contain at least 1 digit, and have mixed case. (eg “IWasAtSignal2018”)
                 # @return [CredentialInstance] Updated CredentialInstance

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

@@ -168,7 +168,7 @@ module Twilio
               # Initialize the IpAccessControlListContext
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid The account_sid
-              # @param [String] sid The ip-access-control-list Sid that uniquely identifies this
+              # @param [String] sid The IpAccessControlList Sid that uniquely identifies this
               #   resource
               # @return [IpAccessControlListContext] IpAccessControlListContext
               def initialize(version, account_sid, sid)
@@ -268,7 +268,7 @@ module Twilio
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] account_sid A 34 character string that uniquely identifies this
               #   resource.
-              # @param [String] sid The ip-access-control-list Sid that uniquely identifies this
+              # @param [String] sid The IpAccessControlList Sid that uniquely identifies this
               #   resource
               # @return [IpAccessControlListInstance] IpAccessControlListInstance
               def initialize(version, payload, account_sid: nil, sid: nil)

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

@@ -28,6 +28,15 @@ module Twilio
         @v1 ||= V1.new self
       end
 
+      ##
+      # @param [form.FormTypes] type The Type of this Form. One of `form-app-push`,
+      #   `form-sms` or `form-totp`.
+      # @return [Twilio::REST::Authy::V1::FormInstance] if type was passed.
+      # @return [Twilio::REST::Authy::V1::FormList]
+      def forms(type=:unset)
+        self.v1.forms(type)
+      end
+
       ##
       # @param [String] sid A 34 character string that uniquely identifies this Service.
       # @return [Twilio::REST::Authy::V1::ServiceInstance] if sid was passed.
@@ -36,15 +45,6 @@ module Twilio
         self.v1.services(sid)
       end
 
-      ##
-      # @param [form.FormType] form_type The Form Type of this Form. One of
-      #   `form-app-push`, `form-sms` or `form-totp`.
-      # @return [Twilio::REST::Authy::V1::FormInstance] if form_type was passed.
-      # @return [Twilio::REST::Authy::V1::FormList]
-      def forms(form_type=:unset)
-        self.v1.forms(form_type)
-      end
-
       ##
       # Provide a user friendly representation
       def to_s

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

@@ -15,8 +15,23 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
-          @services = nil
           @forms = nil
+          @services = nil
+        end
+
+        ##
+        # @param [form.FormTypes] type The Type of this Form. One of `form-app-push`,
+        #   `form-sms` or `form-totp`.
+        # @return [Twilio::REST::Authy::V1::FormContext] if type was passed.
+        # @return [Twilio::REST::Authy::V1::FormList]
+        def forms(type=:unset)
+          if type.nil?
+            raise ArgumentError, 'type cannot be nil'
+          elsif type == :unset
+            @forms ||= FormList.new self
+          else
+            FormContext.new(self, type)
+          end
         end
 
         ##
@@ -33,21 +48,6 @@ module Twilio
           end
         end
 
-        ##
-        # @param [form.FormType] form_type The Form Type of this Form. One of
-        #   `form-app-push`, `form-sms` or `form-totp`.
-        # @return [Twilio::REST::Authy::V1::FormContext] if form_type was passed.
-        # @return [Twilio::REST::Authy::V1::FormList]
-        def forms(form_type=:unset)
-          if form_type.nil?
-            raise ArgumentError, 'form_type cannot be nil'
-          elsif form_type == :unset
-            @forms ||= FormList.new self
-          else
-            FormContext.new(self, form_type)
-          end
-        end
-
         ##
         # Provide a user friendly representation
         def to_s

data/lib/twilio-ruby/rest/authy/v1/form.rb

@@ -68,15 +68,15 @@ module Twilio
           ##
           # Initialize the FormContext
           # @param [Version] version Version that contains the resource
-          # @param [form.FormType] form_type The Form Type of this Form. One of
-          #   `form-app-push`, `form-sms` or `form-totp`.
+          # @param [form.FormTypes] type The Type of this Form. One of `form-app-push`,
+          #   `form-sms` or `form-totp`.
           # @return [FormContext] FormContext
-          def initialize(version, form_type)
+          def initialize(version, type)
             super(version)
 
             # Path Solution
-            @solution = {form_type: form_type, }
-            @uri = "/Forms/#{@solution[:form_type]}"
+            @solution = {type: type, }
+            @uri = "/Forms/#{@solution[:type]}"
           end
 
           ##
@@ -91,7 +91,7 @@ module Twilio
                 params,
             )
 
-            FormInstance.new(@version, payload, form_type: @solution[:form_type], )
+            FormInstance.new(@version, payload, type: @solution[:type], )
           end
 
           ##
@@ -109,15 +109,15 @@ module Twilio
           # Initialize the FormInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [form.FormType] form_type The Form Type of this Form. One of
-          #   `form-app-push`, `form-sms` or `form-totp`.
+          # @param [form.FormTypes] type The Type of this Form. One of `form-app-push`,
+          #   `form-sms` or `form-totp`.
           # @return [FormInstance] FormInstance
-          def initialize(version, payload, form_type: nil)
+          def initialize(version, payload, type: nil)
             super(version)
 
             # Marshaled Properties
             @properties = {
-                'form_type' => payload['form_type'],
+                'type' => payload['type'],
                 'forms' => payload['forms'],
                 'form_meta' => payload['form_meta'],
                 'url' => payload['url'],
@@ -125,7 +125,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'form_type' => form_type || @properties['form_type'], }
+            @params = {'type' => type || @properties['type'], }
           end
 
           ##
@@ -134,31 +134,31 @@ module Twilio
           # @return [FormContext] FormContext for this FormInstance
           def context
             unless @instance_context
-              @instance_context = FormContext.new(@version, @params['form_type'], )
+              @instance_context = FormContext.new(@version, @params['type'], )
             end
             @instance_context
           end
 
           ##
-          # @return [form.FormType] The Form Type of this Form
-          def form_type
-            @properties['form_type']
+          # @return [form.FormTypes] The Type of this Form
+          def type
+            @properties['type']
           end
 
           ##
-          # @return [Hash] Object that contains the available forms for this form type.
+          # @return [Hash] Object that contains the available forms for this type.
           def forms
             @properties['forms']
           end
 
           ##
-          # @return [Hash] Additional information for the available forms for this form type.
+          # @return [Hash] Additional information for the available forms for this type.
           def form_meta
             @properties['form_meta']
           end
 
           ##
-          # @return [String] The URL to access the forms for this form type.
+          # @return [String] The URL to access the forms for this type.
           def url
             @properties['url']
           end

data/lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb

@@ -36,18 +36,12 @@ module Twilio
               # @param [String] binding A unique binding for this Factor that identifies it.
               #   E.g. a phone number for `sms` factors. Required when creating a new Factor. This
               #   value is never returned because it can contain customer secrets.
-              # @param [String] factor_type The Type of this Factor. One of `app-push`, `sms`,
-              #   `totp`, etc.
               # @param [String] friendly_name The friendly name of this Factor
-              # @param [String] config Optional configuration for the Factor
+              # @param [factor.FactorTypes] type The Type of this Factor. One of `app-push`,
+              #   `sms`, `totp`, etc.
               # @return [FactorInstance] Newly created FactorInstance
-              def create(binding: nil, factor_type: nil, friendly_name: nil, config: :unset)
-                data = Twilio::Values.of({
-                    'Binding' => binding,
-                    'FactorType' => factor_type,
-                    'FriendlyName' => friendly_name,
-                    'Config' => config,
-                })
+              def create(binding: nil, friendly_name: nil, type: nil)
+                data = Twilio::Values.of({'Binding' => binding, 'FriendlyName' => friendly_name, 'Type' => type, })
 
                 payload = @version.create(
                     'POST',
@@ -399,13 +393,13 @@ module Twilio
               end
 
               ##
-              # @return [factor.FactorStatus] The Status of this Factor
+              # @return [factor.FactorStatuses] The Status of this Factor
               def status
                 @properties['status']
               end
 
               ##
-              # @return [String] The Type of this Factor
+              # @return [factor.FactorTypes] The Type of this Factor
               def type
                 @properties['type']
               end

data/lib/twilio-ruby/rest/authy/v1/service/entity/factor/challenge.rb

@@ -221,9 +221,8 @@ module Twilio
                       'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                       'date_responded' => Twilio.deserialize_iso8601_datetime(payload['date_responded']),
                       'expiration_date' => Twilio.deserialize_iso8601_datetime(payload['expiration_date']),
-                      'verification_sid' => payload['verification_sid'],
                       'status' => payload['status'],
-                      'reason' => payload['reason'],
+                      'responded_reason' => payload['responded_reason'],
                       'details' => payload['details'],
                       'hidden_details' => payload['hidden_details'],
                       'type' => payload['type'],
@@ -318,21 +317,15 @@ module Twilio
                 end
 
                 ##
-                # @return [String] Verification Sid.
-                def verification_sid
-                  @properties['verification_sid']
-                end
-
-                ##
-                # @return [challenge.ChallengeStatus] The Status of this Challenge
+                # @return [challenge.ChallengeStatuses] The Status of this Challenge
                 def status
                   @properties['status']
                 end
 
                 ##
-                # @return [challenge.ChallengeReason] The Reason of this Challenge `status`
-                def reason
-                  @properties['reason']
+                # @return [challenge.ChallengeReasons] The Reason of this Challenge `status`
+                def responded_reason
+                  @properties['responded_reason']
                 end
 
                 ##
@@ -348,7 +341,7 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The Factor Type of this Challenge
+                # @return [challenge.FactorTypes] The Type of this Challenge
                 def type
                   @properties['type']
                 end

data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb

@@ -55,8 +55,12 @@ module Twilio
               #   Chat service if not specified.  Note that this should only be used in cases
               #   where a Member is being recreated from a backup/separate source  and where a
               #   Member was previously updated.
+              # @param [String] attributes An optional string metadata field you can use to
+              #   store any data you wish. The string value must contain structurally valid JSON
+              #   if specified.  **Note** that if the attributes are not set "{}" will be
+              #   returned.
               # @return [MemberInstance] Newly created MemberInstance
-              def create(identity: nil, role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset)
+              def create(identity: nil, role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset, attributes: :unset)
                 data = Twilio::Values.of({
                     'Identity' => identity,
                     'RoleSid' => role_sid,
@@ -64,6 +68,7 @@ module Twilio
                     'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(last_consumption_timestamp),
                     'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
                     'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
+                    'Attributes' => attributes,
                 })
 
                 payload = @version.create(
@@ -287,14 +292,19 @@ module Twilio
               #   Chat service if not specified.  Note that this should only be used in cases
               #   where a Member is being recreated from a backup/separate source  and where a
               #   Member was previously updated.
+              # @param [String] attributes An optional string metadata field you can use to
+              #   store any data you wish. The string value must contain structurally valid JSON
+              #   if specified.  **Note** that if the attributes are not set "{}" will be
+              #   returned.
               # @return [MemberInstance] Updated MemberInstance
-              def update(role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset)
+              def update(role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset, attributes: :unset)
                 data = Twilio::Values.of({
                     'RoleSid' => role_sid,
                     'LastConsumedMessageIndex' => last_consumed_message_index,
                     'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(last_consumption_timestamp),
                     'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
                     'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
+                    'Attributes' => attributes,
                 })
 
                 payload = @version.update(
@@ -349,6 +359,7 @@ module Twilio
                     'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i,
                     'last_consumption_timestamp' => Twilio.deserialize_iso8601_datetime(payload['last_consumption_timestamp']),
                     'url' => payload['url'],
+                    'attributes' => payload['attributes'],
                 }
 
                 # Context
@@ -442,6 +453,12 @@ module Twilio
                 @properties['url']
               end
 
+              ##
+              # @return [String] An optional string metadata field you can use to store any data you wish.
+              def attributes
+                @properties['attributes']
+              end
+
               ##
               # Fetch a MemberInstance
               # @return [MemberInstance] Fetched MemberInstance
@@ -475,14 +492,19 @@ module Twilio
               #   Chat service if not specified.  Note that this should only be used in cases
               #   where a Member is being recreated from a backup/separate source  and where a
               #   Member was previously updated.
+              # @param [String] attributes An optional string metadata field you can use to
+              #   store any data you wish. The string value must contain structurally valid JSON
+              #   if specified.  **Note** that if the attributes are not set "{}" will be
+              #   returned.
               # @return [MemberInstance] Updated MemberInstance
-              def update(role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset)
+              def update(role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset, attributes: :unset)
                 context.update(
                     role_sid: role_sid,
                     last_consumed_message_index: last_consumed_message_index,
                     last_consumption_timestamp: last_consumption_timestamp,
                     date_created: date_created,
                     date_updated: date_updated,
+                    attributes: attributes,
                 )
               end