purecloud 0.37.1 → 0.38.1

data/doc_out/User.html.md

@@ -18,7 +18,7 @@ title: User
 | **title** | **String** |  | [optional] |
 | **username** | **String** |  | [optional] |
 | **images** | [**Array<UserImage>**](UserImage.html) |  | [optional] |
-| **version** | **String** | Required when updating. Version must be the current version. Only the system can assign version. | [optional] |
+| **version** | **Integer** | Required when updating. Version must be the current version. Only the system can assign version. | [optional] |
 | **routing_status** | [**RoutingStatus**](RoutingStatus.html) | ACD routing status | [optional] |
 | **presence** | [**UserPresence**](UserPresence.html) | Active presence | [optional] |
 | **conversation_summary** | [**UserConversationSummary**](UserConversationSummary.html) | Summary of conversion statistics for conversation types. | [optional] |

data/doc_out/UserMe.html.md

@@ -18,7 +18,7 @@ title: UserMe
 | **title** | **String** |  | [optional] |
 | **username** | **String** |  | [optional] |
 | **images** | [**Array<UserImage>**](UserImage.html) |  | [optional] |
-| **version** | **String** | Required when updating. Version must be the current version. Only the system can assign version. | [optional] |
+| **version** | **Integer** | Required when updating. Version must be the current version. Only the system can assign version. | [optional] |
 | **routing_status** | [**RoutingStatus**](RoutingStatus.html) | ACD routing status | [optional] |
 | **presence** | [**UserPresence**](UserPresence.html) | Active presence | [optional] |
 | **conversation_summary** | [**UserConversationSummary**](UserConversationSummary.html) | Summary of conversion statistics for conversation types. | [optional] |

data/doc_out/UserPresence.html.md

@@ -13,6 +13,7 @@ title: UserPresence
 | **primary** | **BOOLEAN** | A boolean used to tell whether or not to set this presence source as the primary on a PATCH | [optional] [default to false]|
 | **presence_definition** | [**OrganizationPresence**](OrganizationPresence.html) |  | [optional] |
 | **message** | **String** |  | [optional] |
+| **modified_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/doc_out/index.html.md

@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v2
-- Package version: 0.37.1
-- Build date: 2016-04-21T12:51:39.418Z
+- Package version: 0.38.1
+- Build date: 2016-05-01T03:13:46.334Z
 
 For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
 
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
 
 ### from rubygems.org
 
-    gem 'purecloud', '~> 0.37.1'
+    gem 'purecloud', '~> 0.38.1'
 
 ### Install from Git
 

data/lib/purecloud.rb

@@ -70,6 +70,12 @@ require 'purecloud/models/audit_filter'
 require 'purecloud/models/audit_message'
 require 'purecloud/models/audit_search_result'
 require 'purecloud/models/audit_user'
+require 'purecloud/models/authz_grant'
+require 'purecloud/models/authz_grant_policy'
+require 'purecloud/models/authz_grant_role'
+require 'purecloud/models/authz_object'
+require 'purecloud/models/authz_permission_context'
+require 'purecloud/models/authz_subject'
 require 'purecloud/models/available_additional_service'
 require 'purecloud/models/available_additional_service_listing'
 require 'purecloud/models/available_topic'
@@ -303,6 +309,7 @@ require 'purecloud/models/evaluation_scoring_set'
 require 'purecloud/models/evaluator_activity'
 require 'purecloud/models/evaluator_activity_entity_listing'
 require 'purecloud/models/expansion_criterium'
+require 'purecloud/models/export_uri'
 require 'purecloud/models/expression_response'
 require 'purecloud/models/extension'
 require 'purecloud/models/extension_entity_listing'
@@ -402,6 +409,9 @@ require 'purecloud/models/line_entity_listing'
 require 'purecloud/models/line_status'
 require 'purecloud/models/linked_entity_listing_flow_details'
 require 'purecloud/models/linked_entity_listing_work_item_search_details'
+require 'purecloud/models/location'
+require 'purecloud/models/location_address'
+require 'purecloud/models/location_emergency_number'
 require 'purecloud/models/lock_info'
 require 'purecloud/models/logical_interface_entity_listing'
 require 'purecloud/models/management_unit'
@@ -716,14 +726,15 @@ require 'purecloud/api/authorization_api'
 require 'purecloud/api/configuration_api'
 require 'purecloud/api/content_management_api'
 require 'purecloud/api/conversations_api'
-require 'purecloud/api/external_contacts_api'
 require 'purecloud/api/fax_api'
 require 'purecloud/api/geolocation_api'
 require 'purecloud/api/greetings_api'
 require 'purecloud/api/groups_api'
 require 'purecloud/api/languages_api'
+require 'purecloud/api/locations_api'
 require 'purecloud/api/notifications_api'
 require 'purecloud/api/o_auth_api'
+require 'purecloud/api/objects_api'
 require 'purecloud/api/organization_api'
 require 'purecloud/api/outbound_api'
 require 'purecloud/api/presence_api'
@@ -733,6 +744,7 @@ require 'purecloud/api/response_management_api'
 require 'purecloud/api/routing_api'
 require 'purecloud/api/search_api'
 require 'purecloud/api/stations_api'
+require 'purecloud/api/suggest_api'
 require 'purecloud/api/telephony_providers_edge_api'
 require 'purecloud/api/tokens_api'
 require 'purecloud/api/user_recordings_api'

data/lib/purecloud/api/authorization_api.rb

@@ -142,6 +142,66 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Returns a permission-protected object, showing the permission contexts it belongs to.
+    # 
+    # @param object_id Object ID
+    # @param [Hash] opts the optional parameters
+    # @return [AuthzObject]
+    def get_objects_object_id(object_id, opts = {})
+      data, status_code, headers = get_objects_object_id_with_http_info(object_id, opts)
+      return data
+    end
+
+    # Returns a permission-protected object, showing the permission contexts it belongs to.
+    # 
+    # @param object_id Object ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthzObject, Fixnum, Hash)>] AuthzObject data, response status code and response headers
+    def get_objects_object_id_with_http_info(object_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AuthorizationApi#get_objects_object_id ..."
+      end
+      
+      # verify the required parameter 'object_id' is set
+      fail "Missing the required parameter 'object_id' when calling get_objects_object_id" if object_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/authorization/objects/{objectId}".sub('{format}','json').sub('{' + 'objectId' + '}', object_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 => 'AuthzObject')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthorizationApi#get_objects_object_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get all permissions.
     # Retrieve a list of all permission defined in the system.
     # @param [Hash] opts the optional parameters

data/lib/purecloud/api/groups_api.rb

@@ -24,6 +24,71 @@ module PureCloud
       @api_client = api_client
     end
 
+    # Remove members
+    # 
+    # @param group_id Group ID
+    # @param ids Comma separated list of userIds to remove
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_group_id_members(group_id, ids, opts = {})
+      delete_group_id_members_with_http_info(group_id, ids, opts)
+      return nil
+    end
+
+    # Remove members
+    # 
+    # @param group_id Group ID
+    # @param ids Comma separated list of userIds to remove
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_group_id_members_with_http_info(group_id, ids, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: GroupsApi#delete_group_id_members ..."
+      end
+      
+      # verify the required parameter 'group_id' is set
+      fail "Missing the required parameter 'group_id' when calling delete_group_id_members" if group_id.nil?
+      
+      # verify the required parameter 'ids' is set
+      fail "Missing the required parameter 'ids' when calling delete_group_id_members" if ids.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/groups/{groupId}/members".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'ids'] = ids
+
+      # 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(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GroupsApi#delete_group_id_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get group
     # 
     # @param group_id Group ID
@@ -286,6 +351,67 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Add members
+    # 
+    # @param group_id Group ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [GroupMembersUpdate] :body Add members
+    # @return [nil]
+    def post_group_id_members(group_id, opts = {})
+      post_group_id_members_with_http_info(group_id, opts)
+      return nil
+    end
+
+    # Add members
+    # 
+    # @param group_id Group ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [GroupMembersUpdate] :body Add members
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def post_group_id_members_with_http_info(group_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: GroupsApi#post_group_id_members ..."
+      end
+      
+      # verify the required parameter 'group_id' is set
+      fail "Missing the required parameter 'group_id' when calling post_group_id_members" if group_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/groups/{groupId}/members".sub('{format}','json').sub('{' + 'groupId' + '}', group_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 = @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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GroupsApi#post_group_id_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create a group
     # 
     # @param [Hash] opts the optional parameters

data/lib/purecloud/api/locations_api.rb

@@ -0,0 +1,273 @@
+=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 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 a list of all locations.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size (default to 25)
+    # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [String] :sort_order Sort order
+    # @return [Array<Location>]
+    def get_locations(opts = {})
+      data, status_code, headers = get_locations_with_http_info(opts)
+      return data
+    end
+
+    # Get a list of all locations.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @option opts [String] :sort_order Sort order
+    # @return [Array<(Array<Location>, Fixnum, Hash)>] Array<Location> 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[:'sort_order'] && !['asc', 'desc'].include?(opts[:'sort_order'])
+        fail 'invalid value for "sort_order", must be one of asc, desc'
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/locations".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+      query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
+
+      # 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 => 'Array<Location>')
+      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
+
+    # Search using q64
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :q64 
+    # @option opts [Array<String>] :expand 
+    # @return [GroupsSearchResponse]
+    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 
+    # @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse 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: LocationsApi#get_search ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/locations/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']
+
+      # 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 => 'GroupsSearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationsApi#get_search\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
+    # @return [GroupsSearchResponse]
+    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
+    # @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse 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: LocationsApi#post_search ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/locations/search".sub('{format}','json')
+
+      # 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 = @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 => 'GroupsSearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationsApi#post_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end