twilio-ruby 5.6.4 → 5.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b61bb869a4e198c0bec01878527e08e1923a8b8a
-  data.tar.gz: 843793d920e54949decc3e2ab10df1e5ca6e18b0
+  metadata.gz: df9978edce096bf5092e3d6ac5a54c02d063795f
+  data.tar.gz: beb0f63c4bb36035ea5e78dcb32c258d388fb49e
 SHA512:
-  metadata.gz: ab7d228e4ab9f24f3e387de64e77f0574e378981a3556fe93ec42ed1f285e0737d71f13d378fab006ee93f3a29d45688200fb70641f58b00e48c287da44fa133
-  data.tar.gz: a32ac855b80a7e40b0c275d651db8523de2262f66cdd2031bed8f420a858038d83407a10ebee945e848d2a758613dcae84c1a83c969f8fb453932c717a194ead
+  metadata.gz: 6b31f0cedb31d01c8bea49036beff344fb865f90479ac21300a36415d1e691b7c3130dbf428d2914664560ff02432993a16567989f84c936ed7f8c513b755a4e
+  data.tar.gz: e6ae47e713762e25cf73505817d6a81e0177242df3fe5e3b365639871deb03e03bf978729b2dcd9970d92e2e194e60edf064827c1eed4a39eec47b5c21293a1b

data/.rubocop.yml

@@ -21,6 +21,9 @@ Metrics/BlockLength:
 Metrics/AbcSize:
   Enabled: false
 
+Layout/IndentHeredoc:
+  Enabled: false
+
 Metrics/ClassLength:
   Max: 175
 

data/CHANGES.md

@@ -1,6 +1,15 @@
 twilio-ruby changelog
 =====================
 
+[2018-03-02] Version 5.7.0
+---------------------------
+**TwiML**
+- Allow newlines in TwiML content. Better XML configuration in general.
+
+**Studio**
+- Add new /Context endpoint for step and engagement resources. Removes the context property from existing step and engagement resources. *(breaking change)*
+
+
 [2018-02-23] Version 5.6.4
 ---------------------------
 **Library**

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
+  gem 'equivalent-xml', '~> 0.6'
   gem 'fakeweb', '~> 1.3'
   gem 'rack', '~> 1.3'
   gem 'rake', '~> 10.1'

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

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

@@ -68,7 +68,7 @@ module Twilio
             client_name = "clientName=#{CGI.escape(@client_name)}"
           end
           unless @params.empty?
-            params = 'appParams=' + @params.map { |k, v| CGI.escape("#{k}=#{v}") }.join('%26')
+            params = 'appParams=' + @params.map { |k, v| CGI.escape("#{k}=#{v}") }.join(CGI.escape('&'))
           end
 
           suffix = [application_sid, client_name, params].compact.join('&')

data/lib/twilio-ruby/rest/studio/v1/flow/engagement.rb

@@ -182,6 +182,7 @@ module Twilio
 
               # Dependents
               @steps = nil
+              @engagement_context = nil
             end
 
             ##
@@ -217,6 +218,14 @@ module Twilio
               @steps
             end
 
+            ##
+            # Access the engagement_context
+            # @return [EngagementContextList]
+            # @return [EngagementContextContext]
+            def engagement_context
+              EngagementContextContext.new(@version, @solution[:flow_sid], @solution[:sid], )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -246,7 +255,6 @@ module Twilio
                   'contact_sid' => payload['contact_sid'],
                   'contact_channel_address' => payload['contact_channel_address'],
                   'status' => payload['status'],
-                  'context' => payload['context'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                   'url' => payload['url'],
@@ -305,12 +313,6 @@ module Twilio
               @properties['status']
             end
 
-            ##
-            # @return [Hash] The context
-            def context
-              @properties['context']
-            end
-
             ##
             # @return [Time] The date_created
             def date_created
@@ -349,6 +351,13 @@ module Twilio
               context.steps
             end
 
+            ##
+            # Access the engagement_context
+            # @return [engagement_context] engagement_context
+            def engagement_context
+              context.engagement_context
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

data/lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb

@@ -0,0 +1,215 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Studio < Domain
+      class V1 < Version
+        class FlowContext < InstanceContext
+          class EngagementContext < InstanceContext
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class EngagementContextList < ListResource
+              ##
+              # Initialize the EngagementContextList
+              # @param [Version] version Version that contains the resource
+              # @param [String] flow_sid The flow_sid
+              # @param [String] engagement_sid The engagement_sid
+              # @return [EngagementContextList] EngagementContextList
+              def initialize(version, flow_sid: nil, engagement_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {flow_sid: flow_sid, engagement_sid: engagement_sid}
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Studio.V1.EngagementContextList>'
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class EngagementContextPage < Page
+              ##
+              # Initialize the EngagementContextPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [EngagementContextPage] EngagementContextPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of EngagementContextInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [EngagementContextInstance] EngagementContextInstance
+              def get_instance(payload)
+                EngagementContextInstance.new(
+                    @version,
+                    payload,
+                    flow_sid: @solution[:flow_sid],
+                    engagement_sid: @solution[:engagement_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Studio.V1.EngagementContextPage>'
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class EngagementContextContext < InstanceContext
+              ##
+              # Initialize the EngagementContextContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] flow_sid The flow_sid
+              # @param [String] engagement_sid The engagement_sid
+              # @return [EngagementContextContext] EngagementContextContext
+              def initialize(version, flow_sid, engagement_sid)
+                super(version)
+
+                # Path Solution
+                @solution = {flow_sid: flow_sid, engagement_sid: engagement_sid, }
+                @uri = "/Flows/#{@solution[:flow_sid]}/Engagements/#{@solution[:engagement_sid]}/Context"
+              end
+
+              ##
+              # Fetch a EngagementContextInstance
+              # @return [EngagementContextInstance] Fetched EngagementContextInstance
+              def fetch
+                params = Twilio::Values.of({})
+
+                payload = @version.fetch(
+                    'GET',
+                    @uri,
+                    params,
+                )
+
+                EngagementContextInstance.new(
+                    @version,
+                    payload,
+                    flow_sid: @solution[:flow_sid],
+                    engagement_sid: @solution[:engagement_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Studio.V1.EngagementContextContext #{context}>"
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class EngagementContextInstance < InstanceResource
+              ##
+              # Initialize the EngagementContextInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] flow_sid The flow_sid
+              # @param [String] engagement_sid The engagement_sid
+              # @return [EngagementContextInstance] EngagementContextInstance
+              def initialize(version, payload, flow_sid: nil, engagement_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'context' => payload['context'],
+                    'engagement_sid' => payload['engagement_sid'],
+                    'flow_sid' => payload['flow_sid'],
+                    'url' => payload['url'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'flow_sid' => flow_sid, 'engagement_sid' => engagement_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 [EngagementContextContext] EngagementContextContext for this EngagementContextInstance
+              def context
+                unless @instance_context
+                  @instance_context = EngagementContextContext.new(
+                      @version,
+                      @params['flow_sid'],
+                      @params['engagement_sid'],
+                  )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The account_sid
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [Hash] The context
+              def context
+                @properties['context']
+              end
+
+              ##
+              # @return [String] The engagement_sid
+              def engagement_sid
+                @properties['engagement_sid']
+              end
+
+              ##
+              # @return [String] The flow_sid
+              def flow_sid
+                @properties['flow_sid']
+              end
+
+              ##
+              # @return [String] The url
+              def url
+                @properties['url']
+              end
+
+              ##
+              # Fetch a EngagementContextInstance
+              # @return [EngagementContextInstance] Fetched EngagementContextInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Studio.V1.EngagementContextInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Studio.V1.EngagementContextInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb

@@ -168,6 +168,9 @@ module Twilio
                 # Path Solution
                 @solution = {flow_sid: flow_sid, engagement_sid: engagement_sid, sid: sid, }
                 @uri = "/Flows/#{@solution[:flow_sid]}/Engagements/#{@solution[:engagement_sid]}/Steps/#{@solution[:sid]}"
+
+                # Dependents
+                @step_context = nil
               end
 
               ##
@@ -191,6 +194,14 @@ module Twilio
                 )
               end
 
+              ##
+              # Access the step_context
+              # @return [StepContextList]
+              # @return [StepContextContext]
+              def step_context
+                StepContextContext.new(@version, @solution[:flow_sid], @solution[:engagement_sid], @solution[:sid], )
+              end
+
               ##
               # Provide a user friendly representation
               def to_s
@@ -220,12 +231,12 @@ module Twilio
                     'flow_sid' => payload['flow_sid'],
                     'engagement_sid' => payload['engagement_sid'],
                     'name' => payload['name'],
-                    'context' => payload['context'],
                     'transitioned_from' => payload['transitioned_from'],
                     'transitioned_to' => payload['transitioned_to'],
                     'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                     'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                     'url' => payload['url'],
+                    'links' => payload['links'],
                 }
 
                 # Context
@@ -283,12 +294,6 @@ module Twilio
                 @properties['name']
               end
 
-              ##
-              # @return [Hash] The context
-              def context
-                @properties['context']
-              end
-
               ##
               # @return [String] The transitioned_from
               def transitioned_from
@@ -319,6 +324,12 @@ module Twilio
                 @properties['url']
               end
 
+              ##
+              # @return [String] The links
+              def links
+                @properties['links']
+              end
+
               ##
               # Fetch a StepInstance
               # @return [StepInstance] Fetched StepInstance
@@ -326,6 +337,13 @@ module Twilio
                 context.fetch
               end
 
+              ##
+              # Access the step_context
+              # @return [step_context] step_context
+              def step_context
+                context.step_context
+              end
+
               ##
               # Provide a user friendly representation
               def to_s

data/lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb

@@ -0,0 +1,230 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Studio < Domain
+      class V1 < Version
+        class FlowContext < InstanceContext
+          class EngagementContext < InstanceContext
+            class StepContext < InstanceContext
+              ##
+              # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+              class StepContextList < ListResource
+                ##
+                # Initialize the StepContextList
+                # @param [Version] version Version that contains the resource
+                # @param [String] flow_sid The flow_sid
+                # @param [String] engagement_sid The engagement_sid
+                # @param [String] step_sid The step_sid
+                # @return [StepContextList] StepContextList
+                def initialize(version, flow_sid: nil, engagement_sid: nil, step_sid: nil)
+                  super(version)
+
+                  # Path Solution
+                  @solution = {flow_sid: flow_sid, engagement_sid: engagement_sid, step_sid: step_sid}
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  '#<Twilio.Studio.V1.StepContextList>'
+                end
+              end
+
+              ##
+              # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+              class StepContextPage < Page
+                ##
+                # Initialize the StepContextPage
+                # @param [Version] version Version that contains the resource
+                # @param [Response] response Response from the API
+                # @param [Hash] solution Path solution for the resource
+                # @return [StepContextPage] StepContextPage
+                def initialize(version, response, solution)
+                  super(version, response)
+
+                  # Path Solution
+                  @solution = solution
+                end
+
+                ##
+                # Build an instance of StepContextInstance
+                # @param [Hash] payload Payload response from the API
+                # @return [StepContextInstance] StepContextInstance
+                def get_instance(payload)
+                  StepContextInstance.new(
+                      @version,
+                      payload,
+                      flow_sid: @solution[:flow_sid],
+                      engagement_sid: @solution[:engagement_sid],
+                      step_sid: @solution[:step_sid],
+                  )
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  '<Twilio.Studio.V1.StepContextPage>'
+                end
+              end
+
+              ##
+              # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+              class StepContextContext < InstanceContext
+                ##
+                # Initialize the StepContextContext
+                # @param [Version] version Version that contains the resource
+                # @param [String] flow_sid The flow_sid
+                # @param [String] engagement_sid The engagement_sid
+                # @param [String] step_sid The step_sid
+                # @return [StepContextContext] StepContextContext
+                def initialize(version, flow_sid, engagement_sid, step_sid)
+                  super(version)
+
+                  # Path Solution
+                  @solution = {flow_sid: flow_sid, engagement_sid: engagement_sid, step_sid: step_sid, }
+                  @uri = "/Flows/#{@solution[:flow_sid]}/Engagements/#{@solution[:engagement_sid]}/Steps/#{@solution[:step_sid]}/Context"
+                end
+
+                ##
+                # Fetch a StepContextInstance
+                # @return [StepContextInstance] Fetched StepContextInstance
+                def fetch
+                  params = Twilio::Values.of({})
+
+                  payload = @version.fetch(
+                      'GET',
+                      @uri,
+                      params,
+                  )
+
+                  StepContextInstance.new(
+                      @version,
+                      payload,
+                      flow_sid: @solution[:flow_sid],
+                      engagement_sid: @solution[:engagement_sid],
+                      step_sid: @solution[:step_sid],
+                  )
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                  "#<Twilio.Studio.V1.StepContextContext #{context}>"
+                end
+              end
+
+              ##
+              # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+              class StepContextInstance < InstanceResource
+                ##
+                # Initialize the StepContextInstance
+                # @param [Version] version Version that contains the resource
+                # @param [Hash] payload payload that contains response from Twilio
+                # @param [String] flow_sid The flow_sid
+                # @param [String] engagement_sid The engagement_sid
+                # @param [String] step_sid The step_sid
+                # @return [StepContextInstance] StepContextInstance
+                def initialize(version, payload, flow_sid: nil, engagement_sid: nil, step_sid: nil)
+                  super(version)
+
+                  # Marshaled Properties
+                  @properties = {
+                      'account_sid' => payload['account_sid'],
+                      'context' => payload['context'],
+                      'engagement_sid' => payload['engagement_sid'],
+                      'flow_sid' => payload['flow_sid'],
+                      'step_sid' => payload['step_sid'],
+                      'url' => payload['url'],
+                  }
+
+                  # Context
+                  @instance_context = nil
+                  @params = {'flow_sid' => flow_sid, 'engagement_sid' => engagement_sid, 'step_sid' => step_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 [StepContextContext] StepContextContext for this StepContextInstance
+                def context
+                  unless @instance_context
+                    @instance_context = StepContextContext.new(
+                        @version,
+                        @params['flow_sid'],
+                        @params['engagement_sid'],
+                        @params['step_sid'],
+                    )
+                  end
+                  @instance_context
+                end
+
+                ##
+                # @return [String] The account_sid
+                def account_sid
+                  @properties['account_sid']
+                end
+
+                ##
+                # @return [Hash] The context
+                def context
+                  @properties['context']
+                end
+
+                ##
+                # @return [String] The engagement_sid
+                def engagement_sid
+                  @properties['engagement_sid']
+                end
+
+                ##
+                # @return [String] The flow_sid
+                def flow_sid
+                  @properties['flow_sid']
+                end
+
+                ##
+                # @return [String] The step_sid
+                def step_sid
+                  @properties['step_sid']
+                end
+
+                ##
+                # @return [String] The url
+                def url
+                  @properties['url']
+                end
+
+                ##
+                # Fetch a StepContextInstance
+                # @return [StepContextInstance] Fetched StepContextInstance
+                def fetch
+                  context.fetch
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                  "<Twilio.Studio.V1.StepContextInstance #{values}>"
+                end
+
+                ##
+                # Provide a detailed, user friendly representation
+                def inspect
+                  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                  "<Twilio.Studio.V1.StepContextInstance #{values}>"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end