twilio-ruby 5.25.3 → 5.25.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd77745a32efbf1a49af3c876422268d4f97ef2ffe20232d1017601a9794a0c0
-  data.tar.gz: 7d2dc0964c166398c12b1ab1022cc83ca5bd94418ae52a8a60a970c43b9f2dd1
+  metadata.gz: 85fe4385815510c6e6ef8d4d4697adfbac376a96141a5aa4610a8a6538aed999
+  data.tar.gz: da45f6917c09d04948ea1039b2ac5e0c36642f37a3446b6ec0c43d82d1939dad
 SHA512:
-  metadata.gz: 9f6db888d496163430367b37eb030b8eba4c5e58e2186f2abd895a034c688f9872753a1ed62bdb063e64d1f1370b9bf0f8c8fbca49a9623b44f3cb229e4b1e75
-  data.tar.gz: df9c5bc3cb0f1caab8cb278625dc275cc3643f4f846ea7489eac804e656dadf085af2b6bc126bbefe61970fe7a5c2d5311f819def58857dbf0b1accc716814cc
+  metadata.gz: 5872e52b4c22b8ff5a0c22d39d0d3fce6f3ae19947437d4429a625c6b55669857522e66c50af3ceb5f93edfd34425877c4ee31ef3342e3f6e3dbf29a71d5f166
+  data.tar.gz: 1c7d0564ad462ba2f3406beb500afe0a31433996a57b73253cad9890ba539cfc50d177d75e9a999121d0b1bbad8587da8c1271899784b69ae086dc0b9d09338d

data/CHANGES.md

@@ -1,6 +1,32 @@
 twilio-ruby changelog
 =====================
 
+[2019-08-21] Version 5.25.4
+----------------------------
+**Library**
+- [PR #460](https://github.com/twilio/twilio-ruby/pull/460): Update the IP messaging domain name to be 'chat'. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+- [PR #458](https://github.com/twilio/twilio-ruby/pull/458): Update TwiML docs for naming overrides. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+**Conversations**
+- Add Chat Conversation SID to conversation default output properties
+
+**Flex**
+- Adding `outbound_call_flows` object to Flex Configuration
+- Adding read and fetch to channels API
+
+**Supersim**
+- Add Sims and Commands resources for the Super Sim Pilot
+
+**Sync**
+- Added configuration option for enabling webhooks from REST.
+
+**Wireless**
+- Added `usage_notification_method` and `usage_notification_url` properties to `rate_plan`.
+
+**Twiml**
+- Add support for `ach-debit` transactions in `Pay` verb
+
+
 [2019-08-05] Version 5.25.3
 ----------------------------
 **Preview**

data/README.md

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

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

@@ -72,11 +72,6 @@ module Twilio
             # @param [Boolean] force_delivery Reserved
             # @param [Boolean] smart_encoded Whether to detect Unicode characters that have a
             #   similar GSM-7 character and replace them. Can be: `true` or `false`.
-            # @param [String] interactive_data A JSON string that represents an interactive
-            #   message. An interactive message is a category of messages that includes a list
-            #   picker, a time picker, and an Apple Pay request.
-            # @param [Boolean] force_opt_in Whether to forcefully whitelist a from:to pair.
-            #   Can be: `true` or `false`.
             # @param [String] from A Twilio phone number in
             #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric
             #   sender
@@ -100,7 +95,7 @@ module Twilio
             #   can include up to 10 `media_url` parameters per message. You can send images in
             #   an SMS message in only 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, force_delivery: :unset, smart_encoded: :unset, interactive_data: :unset, force_opt_in: :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, force_delivery: :unset, smart_encoded: :unset, from: :unset, messaging_service_sid: :unset, body: :unset, media_url: :unset)
               data = Twilio::Values.of({
                   'To' => to,
                   'From' => from,
@@ -114,8 +109,6 @@ module Twilio
                   'ValidityPeriod' => validity_period,
                   'ForceDelivery' => force_delivery,
                   'SmartEncoded' => smart_encoded,
-                  'InteractiveData' => interactive_data,
-                  'ForceOptIn' => force_opt_in,
               })
 
               payload = @version.create(

data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb

@@ -37,7 +37,7 @@ module Twilio
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
               # @param [String] language The [ISO
-              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`, `nl-NL`
+              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`
               # @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
@@ -54,7 +54,7 @@ module Twilio
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
               # @param [String] language The [ISO
-              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`, `nl-NL`
+              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`
               # @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
@@ -88,7 +88,7 @@ module Twilio
               # Retrieve a single page of FieldValueInstance records from the API.
               # Request is executed immediately.
               # @param [String] language The [ISO
-              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`, `nl-NL`
+              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`
               # @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
@@ -125,7 +125,7 @@ module Twilio
               # Retrieve a single page of FieldValueInstance records from the API.
               # Request is executed immediately.
               # @param [String] language The [ISO
-              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`, `nl-NL`
+              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`
               # @param [String] value The Field Value data.
               # @param [String] synonym_of The string value that indicates which word the field
               #   value is a synonym of.

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

@@ -36,6 +36,22 @@ module Twilio
         self.v1.flex_flow(sid)
       end
 
+      ##
+      # @param [String] sid The unique SID identifier of the Flex Chat Channel
+      # @return [Twilio::REST::Flex_api::V1::ChannelInstance] if sid was passed.
+      # @return [Twilio::REST::Flex_api::V1::ChannelList]
+      def channel(sid=:unset)
+        self.v1.channel(sid)
+      end
+
+      ##
+      # @param [String] sid The unique SID identifier of the Flex Chat Channel
+      # @return [Twilio::REST::Flex_api::V1::WebChannelInstance] if sid was passed.
+      # @return [Twilio::REST::Flex_api::V1::WebChannelList]
+      def web_channel(sid=:unset)
+        self.v1.web_channel(sid)
+      end
+
       ##
       # @return [Twilio::REST::Flex_api::V1::ConfigurationInstance]
       def configuration

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

@@ -16,6 +16,8 @@ module Twilio
           super
           @version = 'v1'
           @flex_flow = nil
+          @channel = nil
+          @web_channel = nil
           @configuration = nil
         end
 
@@ -33,6 +35,34 @@ module Twilio
           end
         end
 
+        ##
+        # @param [String] sid The unique SID identifier of the Flex Chat Channel
+        # @return [Twilio::REST::Flex_api::V1::ChannelContext] if sid was passed.
+        # @return [Twilio::REST::Flex_api::V1::ChannelList]
+        def channel(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @channel ||= ChannelList.new self
+          else
+            ChannelContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The unique SID identifier of the Flex Chat Channel
+        # @return [Twilio::REST::Flex_api::V1::WebChannelContext] if sid was passed.
+        # @return [Twilio::REST::Flex_api::V1::WebChannelList]
+        def web_channel(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @web_channel ||= WebChannelList.new self
+          else
+            WebChannelContext.new(self, sid)
+          end
+        end
+
         ##
         # @return [Twilio::REST::Flex_api::V1::ConfigurationContext]
         def configuration

data/lib/twilio-ruby/rest/flex_api/v1/channel.rb

@@ -0,0 +1,352 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FlexApi < Domain
+      class V1 < Version
+        class ChannelList < ListResource
+          ##
+          # Initialize the ChannelList
+          # @param [Version] version Version that contains the resource
+          # @return [ChannelList] ChannelList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Channels"
+          end
+
+          ##
+          # Lists ChannelInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @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
+          #    not set will use the default value of 50 records.  If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Array] Array of up to limit results
+          def list(limit: nil, page_size: nil)
+            self.stream(limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams ChannelInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @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
+          #    not set will use the default value of 50 records. If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Enumerable] Enumerable that will yield up to limit results
+          def stream(limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields ChannelInstance records from the API.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          def each
+            limits = @version.read_limits
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+          end
+
+          ##
+          # Retrieve a single page of ChannelInstance records from the API.
+          # Request is executed immediately.
+          # @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
+          # @return [Page] Page of ChannelInstance
+          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+            response = @version.page(
+                'GET',
+                @uri,
+                params
+            )
+            ChannelPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of ChannelInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of ChannelInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            ChannelPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of ChannelInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] flex_flow_sid The unique ID of the FlexFlow
+          # @param [String] identity Chat User identity
+          # @param [String] chat_user_friendly_name Customer friendly name (chat
+          #   participant)
+          # @param [String] chat_friendly_name Chat channel friendly name
+          # @param [String] target Target Contact Identity, for example phone number for SMS
+          # @param [String] chat_unique_name Chat channel unique name
+          # @param [String] pre_engagement_data Pre-engagement data
+          # @param [String] task_sid The unique SID identifier of the Taskrouter task
+          # @param [String] task_attributes Task attributes to be added for the TaskRouter
+          #   Task
+          # @param [Boolean] long_lived Boolean flag determining whether channel is created
+          #   as long lived or not
+          # @return [ChannelInstance] Newly created ChannelInstance
+          def create(flex_flow_sid: nil, identity: nil, chat_user_friendly_name: nil, chat_friendly_name: nil, target: :unset, chat_unique_name: :unset, pre_engagement_data: :unset, task_sid: :unset, task_attributes: :unset, long_lived: :unset)
+            data = Twilio::Values.of({
+                'FlexFlowSid' => flex_flow_sid,
+                'Identity' => identity,
+                'ChatUserFriendlyName' => chat_user_friendly_name,
+                'ChatFriendlyName' => chat_friendly_name,
+                'Target' => target,
+                'ChatUniqueName' => chat_unique_name,
+                'PreEngagementData' => pre_engagement_data,
+                'TaskSid' => task_sid,
+                'TaskAttributes' => task_attributes,
+                'LongLived' => long_lived,
+            })
+
+            payload = @version.create(
+                'POST',
+                @uri,
+                data: data
+            )
+
+            ChannelInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.FlexApi.V1.ChannelList>'
+          end
+        end
+
+        class ChannelPage < Page
+          ##
+          # Initialize the ChannelPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [ChannelPage] ChannelPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ChannelInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ChannelInstance] ChannelInstance
+          def get_instance(payload)
+            ChannelInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.FlexApi.V1.ChannelPage>'
+          end
+        end
+
+        class ChannelContext < InstanceContext
+          ##
+          # Initialize the ChannelContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The unique SID identifier of the Flex Chat Channel
+          # @return [ChannelContext] ChannelContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Channels/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch a ChannelInstance
+          # @return [ChannelInstance] Fetched ChannelInstance
+          def fetch
+            params = Twilio::Values.of({})
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            ChannelInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Deletes the ChannelInstance
+          # @return [Boolean] true if delete succeeds, true otherwise
+          def delete
+            @version.delete('delete', @uri)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FlexApi.V1.ChannelContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FlexApi.V1.ChannelContext #{context}>"
+          end
+        end
+
+        class ChannelInstance < InstanceResource
+          ##
+          # Initialize the ChannelInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The unique SID identifier of the Flex Chat Channel
+          # @return [ChannelInstance] ChannelInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'flex_flow_sid' => payload['flex_flow_sid'],
+                'sid' => payload['sid'],
+                'user_sid' => payload['user_sid'],
+                'task_sid' => payload['task_sid'],
+                'url' => payload['url'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'sid' => sid || @properties['sid'], }
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [ChannelContext] ChannelContext for this ChannelInstance
+          def context
+            unless @instance_context
+              @instance_context = ChannelContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The ID of the account that owns this Workflow
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The unique ID of the FlexFlow
+          def flex_flow_sid
+            @properties['flex_flow_sid']
+          end
+
+          ##
+          # @return [String] Flex Chat Channel Sid
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] Chat User Sid.
+          def user_sid
+            @properties['user_sid']
+          end
+
+          ##
+          # @return [String] TaskRouter Task Sid.
+          def task_sid
+            @properties['task_sid']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [Time] The time the Flex Chat Channel was created, given as GMT in ISO 8601 format.
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The time the Flex Chat Channel was last updated, given as GMT in ISO 8601 format.
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # Fetch a ChannelInstance
+          # @return [ChannelInstance] Fetched ChannelInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Deletes the ChannelInstance
+          # @return [Boolean] true if delete succeeds, true otherwise
+          def delete
+            context.delete
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FlexApi.V1.ChannelInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FlexApi.V1.ChannelInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end