twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/frontline_api/v1/user.rb

@@ -0,0 +1,233 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FrontlineApi < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserList < ListResource
+          ##
+          # Initialize the UserList
+          # @param [Version] version Version that contains the resource
+          # @return [UserList] UserList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.FrontlineApi.V1.UserList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserPage < Page
+          ##
+          # Initialize the UserPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [UserPage] UserPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of UserInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [UserInstance] UserInstance
+          def get_instance(payload)
+            UserInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.FrontlineApi.V1.UserPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserContext < InstanceContext
+          ##
+          # Initialize the UserContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The SID of the User resource to fetch. This value can be
+          #   either the `sid` or the `identity` of the User resource to fetch.
+          # @return [UserContext] UserContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Users/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the UserInstance
+          # @return [UserInstance] Fetched UserInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            UserInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Update the UserInstance
+          # @param [String] friendly_name The string that you assigned to describe the User.
+          # @param [String] avatar The avatar URL which will be shown in Frontline
+          #   application.
+          # @param [user.StateType] state Current state of this user. Can be either `active`
+          #   or `deactivated` and defaults to `active`
+          # @return [UserInstance] Updated UserInstance
+          def update(friendly_name: :unset, avatar: :unset, state: :unset)
+            data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Avatar' => avatar, 'State' => state, })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            UserInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FrontlineApi.V1.UserContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FrontlineApi.V1.UserContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserInstance < InstanceResource
+          ##
+          # Initialize the UserInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The SID of the User resource to fetch. This value can be
+          #   either the `sid` or the `identity` of the User resource to fetch.
+          # @return [UserInstance] UserInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'identity' => payload['identity'],
+                'friendly_name' => payload['friendly_name'],
+                'avatar' => payload['avatar'],
+                'state' => payload['state'],
+                'url' => payload['url'],
+            }
+
+            # 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 [UserContext] UserContext for this UserInstance
+          def context
+            unless @instance_context
+              @instance_context = UserContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that identifies the resource
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The string that identifies the resource's User
+          def identity
+            @properties['identity']
+          end
+
+          ##
+          # @return [String] The string that you assigned to describe the User
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [String] The avatar URL which will be shown in Frontline application
+          def avatar
+            @properties['avatar']
+          end
+
+          ##
+          # @return [user.StateType] Current state of this user
+          def state
+            @properties['state']
+          end
+
+          ##
+          # @return [String] An absolute URL for this user.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the UserInstance
+          # @return [UserInstance] Fetched UserInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the UserInstance
+          # @param [String] friendly_name The string that you assigned to describe the User.
+          # @param [String] avatar The avatar URL which will be shown in Frontline
+          #   application.
+          # @param [user.StateType] state Current state of this user. Can be either `active`
+          #   or `deactivated` and defaults to `active`
+          # @return [UserInstance] Updated UserInstance
+          def update(friendly_name: :unset, avatar: :unset, state: :unset)
+            context.update(friendly_name: friendly_name, avatar: avatar, state: state, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FrontlineApi.V1.UserInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FrontlineApi.V1.UserInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FrontlineApi
+      class V1 < Version
+        ##
+        # Initialize the V1 version of FrontlineApi
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @users = nil
+        end
+
+        ##
+        # @param [String] sid The SID of the User resource to fetch. This value can be
+        #   either the `sid` or the `identity` of the User resource to fetch.
+        # @return [Twilio::REST::Frontline_api::V1::UserContext] if sid was passed.
+        # @return [Twilio::REST::Frontline_api::V1::UserList]
+        def users(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @users ||= UserList.new self
+          else
+              UserContext.new(self, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::FrontlineApi::V1>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FrontlineApi < Domain
+      ##
+      # Initialize the FrontlineApi Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://frontline-api.twilio.com'
+        @host = 'frontline-api.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of frontline_api
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the User
+      #   resource.
+      # @return [Twilio::REST::Frontline_api::V1::UserInstance] if sid was passed.
+      # @return [Twilio::REST::Frontline_api::V1::UserList]
+      def users(sid=:unset)
+        self.v1.users(sid)
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::FrontlineApi>'
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/insights/v1/call/event.rb

@@ -0,0 +1,262 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Insights < Domain
+      class V1 < Version
+        class CallContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class EventList < ListResource
+            ##
+            # Initialize the EventList
+            # @param [Version] version Version that contains the resource
+            # @param [String] call_sid The call_sid
+            # @return [EventList] EventList
+            def initialize(version, call_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {call_sid: call_sid}
+              @uri = "/Voice/#{@solution[:call_sid]}/Events"
+            end
+
+            ##
+            # Lists EventInstance records from the API as a list.
+            # Unlike stream(), this operation is eager and will load `limit` records into
+            # memory before returning.
+            # @param [event.TwilioEdge] edge The edge
+            # @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(edge: :unset, limit: nil, page_size: nil)
+              self.stream(edge: edge, limit: limit, page_size: page_size).entries
+            end
+
+            ##
+            # Streams EventInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @param [event.TwilioEdge] edge The edge
+            # @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(edge: :unset, limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(edge: edge, page_size: limits[:page_size], )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields EventInstance 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 EventInstance records from the API.
+            # Request is executed immediately.
+            # @param [event.TwilioEdge] edge The edge
+            # @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 EventInstance
+            def page(edge: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'Edge' => edge,
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+
+              response = @version.page('GET', @uri, params: params)
+
+              EventPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of EventInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of EventInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              EventPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Insights.V1.EventList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class EventPage < Page
+            ##
+            # Initialize the EventPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [EventPage] EventPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of EventInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [EventInstance] EventInstance
+            def get_instance(payload)
+              EventInstance.new(@version, payload, call_sid: @solution[:call_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Insights.V1.EventPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class EventInstance < InstanceResource
+            ##
+            # Initialize the EventInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] call_sid The call_sid
+            # @return [EventInstance] EventInstance
+            def initialize(version, payload, call_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'timestamp' => payload['timestamp'],
+                  'call_sid' => payload['call_sid'],
+                  'account_sid' => payload['account_sid'],
+                  'edge' => payload['edge'],
+                  'group' => payload['group'],
+                  'level' => payload['level'],
+                  'name' => payload['name'],
+                  'carrier_edge' => payload['carrier_edge'],
+                  'sip_edge' => payload['sip_edge'],
+                  'sdk_edge' => payload['sdk_edge'],
+                  'client_edge' => payload['client_edge'],
+              }
+            end
+
+            ##
+            # @return [String] The timestamp
+            def timestamp
+              @properties['timestamp']
+            end
+
+            ##
+            # @return [String] The call_sid
+            def call_sid
+              @properties['call_sid']
+            end
+
+            ##
+            # @return [String] The account_sid
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [event.TwilioEdge] The edge
+            def edge
+              @properties['edge']
+            end
+
+            ##
+            # @return [String] The group
+            def group
+              @properties['group']
+            end
+
+            ##
+            # @return [event.Level] The level
+            def level
+              @properties['level']
+            end
+
+            ##
+            # @return [String] The name
+            def name
+              @properties['name']
+            end
+
+            ##
+            # @return [Hash] The carrier_edge
+            def carrier_edge
+              @properties['carrier_edge']
+            end
+
+            ##
+            # @return [Hash] The sip_edge
+            def sip_edge
+              @properties['sip_edge']
+            end
+
+            ##
+            # @return [Hash] The sdk_edge
+            def sdk_edge
+              @properties['sdk_edge']
+            end
+
+            ##
+            # @return [Hash] The client_edge
+            def client_edge
+              @properties['client_edge']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Insights.V1.EventInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Insights.V1.EventInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end