purecloud 0.36.1 → 0.37.1

data/doc_out/AutomateQueueMemberEntityListing.html.md

@@ -1,22 +0,0 @@
----
-title: AutomateQueueMemberEntityListing
----
-## PureCloud::AutomateQueueMemberEntityListing
-
-## Properties
-
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **page_size** | **Integer** |  | [optional] |
-| **page_number** | **Integer** |  | [optional] |
-| **total** | **Integer** |  | [optional] |
-| **entities** | [**Array<AutomateQueueMember>**](AutomateQueueMember.html) |  | [optional] |
-| **self_uri** | **String** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
-| **previous_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
-| **page_count** | **Integer** |  | [optional] |
-{: class="table table-striped"}
-
-

data/doc_out/CommonAuditRequest.html.md

@@ -1,19 +0,0 @@
----
-title: CommonAuditRequest
----
-## PureCloud::CommonAuditRequest
-
-## Properties
-
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **page_number** | **Integer** |  | [optional] |
-| **page_size** | **Integer** |  | [optional] |
-| **sort_by** | [**Array<SortBy>**](SortBy.html) |  | [optional] |
-| **query_phrase** | **String** |  | [optional] |
-| **query_fields** | **Array<String>** |  | [optional] |
-| **facets** | [**Array<AuditFacet>**](AuditFacet.html) |  | [optional] |
-| **filters** | [**Array<AuditFilter>**](AuditFilter.html) |  | [optional] |
-{: class="table table-striped"}
-
-

data/doc_out/Location.html.md

@@ -1,24 +0,0 @@
----
-title: Location
----
-## PureCloud::Location
-
-## Properties
-
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **id** | **String** | The globally unique identifier for the object. | [optional] |
-| **name** | **String** |  | [optional] |
-| **address** | **String** |  | [optional] |
-| **address_fields** | [**LocationAddressFields**](LocationAddressFields.html) |  | [optional] |
-| **address_verified** | **BOOLEAN** |  | [optional] [default to false]|
-| **emergency_number** | [**LocationEmergencyNumber**](LocationEmergencyNumber.html) |  | [optional] |
-| **notes** | **String** |  | [optional] |
-| **path** | **Array<String>** |  | [optional] |
-| **state** | **String** | Current activity status of the location. | [optional] |
-| **sublocation_order** | **Array<String>** |  | [optional] |
-| **version** | **Float** |  | [optional] |
-| **self_uri** | **String** | The URI for this object | [optional] |
-{: class="table table-striped"}
-
-

data/doc_out/LocationAddressFields.html.md

@@ -1,19 +0,0 @@
----
-title: LocationAddressFields
----
-## PureCloud::LocationAddressFields
-
-## Properties
-
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **city** | **String** |  | [optional] |
-| **country** | **String** |  | [optional] |
-| **country_name** | **String** |  | [optional] |
-| **state** | **String** |  | [optional] |
-| **street1** | **String** |  | [optional] |
-| **street2** | **String** |  | [optional] |
-| **zipcode** | **String** |  | [optional] |
-{: class="table table-striped"}
-
-

data/doc_out/LocationEmergencyNumber.html.md

@@ -1,15 +0,0 @@
----
-title: LocationEmergencyNumber
----
-## PureCloud::LocationEmergencyNumber
-
-## Properties
-
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **e164** | **String** |  | [optional] |
-| **number** | **String** |  | [optional] |
-| **type** | **String** | The type of emergency number. | [optional] |
-{: class="table table-striped"}
-
-

data/doc_out/LocationsApi.html.md

@@ -1,133 +0,0 @@
----
-title: LocationsApi
----
-
-## PureCloud::LocationsApi
-
-All URIs are relative to *https://api.mypurecloud.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-|[**get_location_id**](LocationsApi.html#get_location_id) | **GET** /api/v2/locations/{locationId} | Get Location by ID.|
-|[**get_locations**](LocationsApi.html#get_locations) | **GET** /api/v2/locations | Get the list of locations.|
-{: class="table table-striped"}
-
-<a name="get_location_id"></a>
-
-## -[**Location**](Location.html) get_location_id(location_id)
-
-Get Location by ID.
-
-
-
-### Example
-~~~ruby
-# load the gem
-require 'purecloud'
-# setup authorization
-@secret = ENV['PURECLOUD_SECRET']
-@id = ENV['PURECLOUD_CLIENT_ID']
-environment = "mypurecloud.com"
-
-@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
-
-PureCloud.configure do |config|
-  config.access_token = @authToken
-end
-
-api_instance = PureCloud::LocationsApi.new
-
-location_id = "location_id_example" # String | Location ID
-
-
-begin
-  #Get Location by ID.
-  result = api_instance.get_location_id(location_id)
-  p result
-rescue PureCloud::ApiError => e
-  puts "Exception when calling LocationsApi->get_location_id: #{e}"
-end
-~~~
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **location_id** | **String**| Location ID | 
-{: class="table table-striped"}
-
-
-### Return type
-
-[**Location**](Location.html)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-<a name="get_locations"></a>
-
-## -[**LocationEntityListing**](LocationEntityListing.html) get_locations(opts)
-
-Get the list of locations.
-
-
-
-### Example
-~~~ruby
-# load the gem
-require 'purecloud'
-# setup authorization
-@secret = ENV['PURECLOUD_SECRET']
-@id = ENV['PURECLOUD_CLIENT_ID']
-environment = "mypurecloud.com"
-
-@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
-
-PureCloud.configure do |config|
-  config.access_token = @authToken
-end
-
-api_instance = PureCloud::LocationsApi.new
-
-opts = { 
-  state: "ACTIVE", # String | Location state
-  name: "name_example", # String | Location name
-  page_size: 25, # Integer | Page size
-  page_number: 1 # Integer | Page number
-}
-
-begin
-  #Get the list of locations.
-  result = api_instance.get_locations(opts)
-  p result
-rescue PureCloud::ApiError => e
-  puts "Exception when calling LocationsApi->get_locations: #{e}"
-end
-~~~
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **state** | **String**| Location state | [optional] [default to ACTIVE]
- **name** | **String**| Location name | [optional] 
- **page_size** | **Integer**| Page size | [optional] [default to 25]
- **page_number** | **Integer**| Page number | [optional] [default to 1]
-{: class="table table-striped"}
-
-
-### Return type
-
-[**LocationEntityListing**](LocationEntityListing.html)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-

data/doc_out/QueuesEntityListing.html.md

@@ -1,22 +0,0 @@
----
-title: QueuesEntityListing
----
-## PureCloud::QueuesEntityListing
-
-## Properties
-
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **page_size** | **Integer** |  | [optional] |
-| **page_number** | **Integer** |  | [optional] |
-| **total** | **Integer** |  | [optional] |
-| **entities** | [**Array<AutomateQueue>**](AutomateQueue.html) |  | [optional] |
-| **self_uri** | **String** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
-| **previous_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
-| **page_count** | **Integer** |  | [optional] |
-{: class="table table-striped"}
-
-

data/doc_out/SortBy.html.md

@@ -1,14 +0,0 @@
----
-title: SortBy
----
-## PureCloud::SortBy
-
-## Properties
-
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **name** | **String** |  | [optional] |
-| **ascending** | **BOOLEAN** |  | [optional] [default to false]|
-{: class="table table-striped"}
-
-

data/lib/purecloud/api/locations_api.rb

@@ -1,158 +0,0 @@
-=begin
-PureCloud API
-
-PureCloud API
-
-OpenAPI spec version: v1
-Contact: chuck.pulfer@inin.com
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-
-License: ININ
-http://www.inin.com
-
-Terms of Service: http://www.inin.com
-
-=end
-
-require "uri"
-
-module PureCloud
-  class LocationsApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-
-    # Get Location by ID.
-    # 
-    # @param location_id Location ID
-    # @param [Hash] opts the optional parameters
-    # @return [Location]
-    def get_location_id(location_id, opts = {})
-      data, status_code, headers = get_location_id_with_http_info(location_id, opts)
-      return data
-    end
-
-    # Get Location by ID.
-    # 
-    # @param location_id Location ID
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Location, Fixnum, Hash)>] Location data, response status code and response headers
-    def get_location_id_with_http_info(location_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: LocationsApi#get_location_id ..."
-      end
-      
-      # verify the required parameter 'location_id' is set
-      fail "Missing the required parameter 'location_id' when calling get_location_id" if location_id.nil?
-      
-      # resource path
-      local_var_path = "/api/v2/locations/{locationId}".sub('{format}','json').sub('{' + 'locationId' + '}', location_id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # 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 => 'Location')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: LocationsApi#get_location_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Get the list of locations.
-    # 
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :state Location state (default to ACTIVE)
-    # @option opts [String] :name Location name
-    # @option opts [Integer] :page_size Page size (default to 25)
-    # @option opts [Integer] :page_number Page number (default to 1)
-    # @return [LocationEntityListing]
-    def get_locations(opts = {})
-      data, status_code, headers = get_locations_with_http_info(opts)
-      return data
-    end
-
-    # Get the list of locations.
-    # 
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :state Location state
-    # @option opts [String] :name Location name
-    # @option opts [Integer] :page_size Page size
-    # @option opts [Integer] :page_number Page number
-    # @return [Array<(LocationEntityListing, Fixnum, Hash)>] LocationEntityListing data, response status code and response headers
-    def get_locations_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: LocationsApi#get_locations ..."
-      end
-      
-      if opts[:'state'] && !['ACTIVE', 'DELETED'].include?(opts[:'state'])
-        fail 'invalid value for "state", must be one of ACTIVE, DELETED'
-      end
-      
-      # resource path
-      local_var_path = "/api/v2/locations".sub('{format}','json')
-
-      # query parameters
-      query_params = {}
-      query_params[:'state'] = opts[:'state'] if opts[:'state']
-      query_params[:'name'] = opts[:'name'] if opts[:'name']
-      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
-      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
-
-      # 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 => 'LocationEntityListing')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: LocationsApi#get_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end

data/lib/purecloud/models/automate_queue_member_entity_listing.rb

@@ -1,257 +0,0 @@
-=begin
-PureCloud API
-
-PureCloud API
-
-OpenAPI spec version: v1
-Contact: chuck.pulfer@inin.com
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-
-License: ININ
-http://www.inin.com
-
-Terms of Service: http://www.inin.com
-
-=end
-
-require 'date'
-
-module PureCloud
-  class AutomateQueueMemberEntityListing
-    attr_accessor :page_size
-
-    attr_accessor :page_number
-
-    attr_accessor :total
-
-    attr_accessor :entities
-
-    attr_accessor :self_uri
-
-    attr_accessor :first_uri
-
-    attr_accessor :previous_uri
-
-    attr_accessor :next_uri
-
-    attr_accessor :last_uri
-
-    attr_accessor :page_count
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        
-        :'page_size' => :'pageSize',
-        
-        :'page_number' => :'pageNumber',
-        
-        :'total' => :'total',
-        
-        :'entities' => :'entities',
-        
-        :'self_uri' => :'selfUri',
-        
-        :'first_uri' => :'firstUri',
-        
-        :'previous_uri' => :'previousUri',
-        
-        :'next_uri' => :'nextUri',
-        
-        :'last_uri' => :'lastUri',
-        
-        :'page_count' => :'pageCount'
-        
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      {
-        :'page_size' => :'Integer',
-        :'page_number' => :'Integer',
-        :'total' => :'Integer',
-        :'entities' => :'Array<AutomateQueueMember>',
-        :'self_uri' => :'String',
-        :'first_uri' => :'String',
-        :'previous_uri' => :'String',
-        :'next_uri' => :'String',
-        :'last_uri' => :'String',
-        :'page_count' => :'Integer'
-        
-      }
-    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[:'pageSize']
-        self.page_size = attributes[:'pageSize']
-      end
-      
-      if attributes[:'pageNumber']
-        self.page_number = attributes[:'pageNumber']
-      end
-      
-      if attributes[:'total']
-        self.total = attributes[:'total']
-      end
-      
-      if attributes[:'entities']
-        if (value = attributes[:'entities']).is_a?(Array)
-          self.entities = value
-        end
-      end
-      
-      if attributes[:'selfUri']
-        self.self_uri = attributes[:'selfUri']
-      end
-      
-      if attributes[:'firstUri']
-        self.first_uri = attributes[:'firstUri']
-      end
-      
-      if attributes[:'previousUri']
-        self.previous_uri = attributes[:'previousUri']
-      end
-      
-      if attributes[:'nextUri']
-        self.next_uri = attributes[:'nextUri']
-      end
-      
-      if attributes[:'lastUri']
-        self.last_uri = attributes[:'lastUri']
-      end
-      
-      if attributes[:'pageCount']
-        self.page_count = attributes[:'pageCount']
-      end
-      
-    end
-
-    # Check equality by comparing each attribute.
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          page_size == o.page_size &&
-          page_number == o.page_number &&
-          total == o.total &&
-          entities == o.entities &&
-          self_uri == o.self_uri &&
-          first_uri == o.first_uri &&
-          previous_uri == o.previous_uri &&
-          next_uri == o.next_uri &&
-          last_uri == o.last_uri &&
-          page_count == o.page_count
-    end
-
-    # @see the `==` method
-    def eql?(o)
-      self == o
-    end
-
-    # Calculate hash code according to all attributes.
-    def hash
-      [page_size, page_number, total, entities, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].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