purecloud 0.37.1 → 0.38.1

data/lib/purecloud/api/suggest_api.rb

@@ -0,0 +1,272 @@
+=begin
+PureCloud Platform API
+
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
+
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@inin.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require "uri"
+
+module PureCloud
+  class SuggestApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Search using q64
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :q64 
+    # @option opts [Array<String>] :expand 
+    # @option opts [BOOLEAN] :profile  (default to true)
+    # @return [JsonNodeSearchResponse]
+    def get_search(opts = {})
+      data, status_code, headers = get_search_with_http_info(opts)
+      return data
+    end
+
+    # Search using q64
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :q64 
+    # @option opts [Array<String>] :expand 
+    # @option opts [BOOLEAN] :profile 
+    # @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
+    def get_search_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SuggestApi#get_search ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/search".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'q64'] = opts[:'q64'] if opts[:'q64']
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+      query_params[:'profile'] = opts[:'profile'] if opts[:'profile']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'JsonNodeSearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SuggestApi#get_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Suggest using q64
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :q64 
+    # @option opts [BOOLEAN] :profile  (default to true)
+    # @return [JsonNodeSearchResponse]
+    def get_suggest(opts = {})
+      data, status_code, headers = get_suggest_with_http_info(opts)
+      return data
+    end
+
+    # Suggest using q64
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :q64 
+    # @option opts [BOOLEAN] :profile 
+    # @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
+    def get_suggest_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SuggestApi#get_suggest ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/search/suggest".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'q64'] = opts[:'q64'] if opts[:'q64']
+      query_params[:'profile'] = opts[:'profile'] if opts[:'profile']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'JsonNodeSearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SuggestApi#get_suggest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Search
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [SearchRequest] :body Search request options
+    # @option opts [BOOLEAN] :profile  (default to true)
+    # @return [JsonNodeSearchResponse]
+    def post_search(opts = {})
+      data, status_code, headers = post_search_with_http_info(opts)
+      return data
+    end
+
+    # Search
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [SearchRequest] :body Search request options
+    # @option opts [BOOLEAN] :profile 
+    # @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
+    def post_search_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SuggestApi#post_search ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/search".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'profile'] = opts[:'profile'] if opts[:'profile']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'body'])
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'JsonNodeSearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SuggestApi#post_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Suggest
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [SearchRequest] :body Search request options
+    # @option opts [BOOLEAN] :profile  (default to true)
+    # @return [JsonNodeSearchResponse]
+    def post_suggest(opts = {})
+      data, status_code, headers = post_suggest_with_http_info(opts)
+      return data
+    end
+
+    # Suggest
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [SearchRequest] :body Search request options
+    # @option opts [BOOLEAN] :profile 
+    # @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
+    def post_suggest_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SuggestApi#post_suggest ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/search/suggest".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'profile'] = opts[:'profile'] if opts[:'profile']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'body'])
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'JsonNodeSearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SuggestApi#post_suggest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/purecloud/api_client.rb

@@ -33,7 +33,7 @@ module PureCloud
 
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "PureCloud SDK/Ruby 0.37.1"
+      @user_agent = "PureCloud SDK/Ruby 0.38.1"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent

data/lib/purecloud/models/authz_grant.rb

@@ -0,0 +1,186 @@
+=begin
+PureCloud Platform API
+
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
+
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@inin.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require 'date'
+
+module PureCloud
+  class AuthzGrant
+    attr_accessor :permission_context
+
+    attr_accessor :role
+
+    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :grant_made_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'permission_context' => :'permissionContext',
+        
+        :'role' => :'role',
+        
+        :'grant_made_at' => :'grantMadeAt'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'permission_context' => :'AuthzPermissionContext',
+        :'role' => :'AuthzGrantRole',
+        :'grant_made_at' => :'DateTime'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'permissionContext']
+        self.permission_context = attributes[:'permissionContext']
+      end
+      
+      if attributes[:'role']
+        self.role = attributes[:'role']
+      end
+      
+      if attributes[:'grantMadeAt']
+        self.grant_made_at = attributes[:'grantMadeAt']
+      end
+      
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          permission_context == o.permission_context &&
+          role == o.role &&
+          grant_made_at == o.grant_made_at
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [permission_context, role, grant_made_at].hash
+    end
+
+    # build the object from hash
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        _model = Object.const_get("PureCloud").const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end