purecloudplatformclientv2 10.0.0 → 11.0.0

data/docs/UserEntityListing.md

@@ -13,8 +13,8 @@ title: UserEntityListing
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/docs/UserPresenceAlertContainer.md

@@ -13,8 +13,8 @@ title: UserPresenceAlertContainer
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/docs/UserPresenceRuleContainer.md

@@ -13,8 +13,8 @@ title: UserPresenceRuleContainer
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/docs/UserQueueEntityListing.md

@@ -13,8 +13,8 @@ title: UserQueueEntityListing
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/docs/UserRecordingEntityListing.md

@@ -13,8 +13,8 @@ title: UserRecordingEntityListing
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/docs/UserRecordingsApi.md

@@ -185,7 +185,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **recording_id** | **String**| User Recording ID |  |
- **format_id** | **String**| The desired media format. | [optional] [default to WEBM]<br />**Values**: WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE |
+ **format_id** | **String**| The desired media format. | [optional] [default to WEBM]<br />**Values**: WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE |
 {: class="table table-striped"}
 
 

data/docs/UserSkillEntityListing.md

@@ -13,8 +13,8 @@ title: UserSkillEntityListing
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/docs/UsersApi.md

@@ -39,6 +39,7 @@ Method | Description
 [**post_analytics_users_aggregates_query**](UsersApi.html#post_analytics_users_aggregates_query) | Query for user aggregates
 [**post_analytics_users_details_query**](UsersApi.html#post_analytics_users_details_query) | Query for user details
 [**post_analytics_users_observations_query**](UsersApi.html#post_analytics_users_observations_query) | Query for user observations
+[**post_user_invite**](UsersApi.html#post_user_invite) | Send an activation email to the user
 [**post_user_routingskills**](UsersApi.html#post_user_routingskills) | Add routing skill to user
 [**post_users**](UsersApi.html#post_users) | Create user
 [**post_users_search**](UsersApi.html#post_users_search) | Search users
@@ -1964,6 +1965,68 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_user_invite"></a>
+
+## - post_user_invite(user_id, opts)
+
+Send an activation email to the user
+
+
+
+Wraps POST /api/v2/users/{userId}/invite 
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloudplatformclientv2'
+# 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::UsersApi.new
+
+user_id = "user_id_example" # String | User ID
+
+opts = { 
+  force: false # BOOLEAN | Resend the invitation even if one is already outstanding
+}
+
+begin
+  #Send an activation email to the user
+  api_instance.post_user_invite(user_id, opts)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling UsersApi->post_user_invite: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |  |
+ **force** | **BOOLEAN**| Resend the invitation even if one is already outstanding | [optional] [default to false] |
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_user_routingskills"></a>
 
 ## -[**UserRoutingSkill**](UserRoutingSkill.html) post_user_routingskills(user_id, body)

data/docs/VoicemailApi.md

@@ -657,7 +657,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **message_id** | **String**| Message ID |  |
- **format_id** | **String**| The desired media format. | [optional] [default to WEBM]<br />**Values**: WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE |
+ **format_id** | **String**| The desired media format. | [optional] [default to WEBM]<br />**Values**: WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE |
 {: class="table table-striped"}
 
 

data/docs/VoicemailMessageEntityListing.md

@@ -13,8 +13,8 @@ title: VoicemailMessageEntityListing
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/docs/WorkspaceEntityListing.md

@@ -13,8 +13,8 @@ title: WorkspaceEntityListing
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/docs/WorkspaceMemberEntityListing.md

@@ -13,8 +13,8 @@ title: WorkspaceMemberEntityListing
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/docs/WrapupCodeEntityListing.md

@@ -13,8 +13,8 @@ title: WrapupCodeEntityListing
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/lib/purecloudplatformclientv2/api/greetings_api.rb

@@ -186,8 +186,8 @@ module PureCloud
       
       
       
-      if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
-        fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE'
+      if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'MP3', 'NONE'].include?(opts[:'format_id'])
+        fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE'
       end
       
       
@@ -659,7 +659,7 @@ module PureCloud
     # 
     # @param body The Greeting to create
     # @param [Hash] opts the optional parameters
-    # @return [DefaultGreetingList]
+    # @return [Greeting]
     def post_greetings(body, opts = {})
       data, _status_code, _headers = post_greetings_with_http_info(body, opts)
       return data
@@ -669,7 +669,7 @@ module PureCloud
     # 
     # @param body The Greeting to create
     # @param [Hash] opts the optional parameters
-    # @return [Array<(DefaultGreetingList, Fixnum, Hash)>] DefaultGreetingList data, response status code and response headers
+    # @return [Array<(Greeting, Fixnum, Hash)>] Greeting data, response status code and response headers
     def post_greetings_with_http_info(body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GreetingsApi.post_greetings ..."
@@ -713,7 +713,7 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'DefaultGreetingList')
+        :return_type => 'Greeting')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: GreetingsApi#post_greetings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/purecloudplatformclientv2/api/recording_api.rb

@@ -349,8 +349,8 @@ module PureCloud
       
       
       
-      if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
-        fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE'
+      if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'MP3', 'NONE'].include?(opts[:'format_id'])
+        fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE'
       end
       
       
@@ -609,8 +609,8 @@ module PureCloud
       
       
       
-      if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
-        fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE'
+      if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'MP3', 'NONE'].include?(opts[:'format_id'])
+        fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE'
       end
       
       
@@ -757,8 +757,8 @@ module PureCloud
       
       
       
-      if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
-        fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE'
+      if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'MP3', 'NONE'].include?(opts[:'format_id'])
+        fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE'
       end
       
       

data/lib/purecloudplatformclientv2/api/routing_api.rb

@@ -1891,6 +1891,7 @@ module PureCloud
     # @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] :name Name
     # @option opts [String] :sort_by Sort by (default to name)
     # @return [WrapupCodeEntityListing]
     def get_routing_wrapupcodes(opts = {})
@@ -1903,6 +1904,7 @@ module PureCloud
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size Page size
     # @option opts [Integer] :page_number Page number
+    # @option opts [String] :name Name
     # @option opts [String] :sort_by Sort by
     # @return [Array<(WrapupCodeEntityListing, Fixnum, Hash)>] WrapupCodeEntityListing data, response status code and response headers
     def get_routing_wrapupcodes_with_http_info(opts = {})
@@ -1923,6 +1925,12 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1935,6 +1943,7 @@ module PureCloud
       query_params = {}
       query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
       query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+      query_params[:'name'] = opts[:'name'] if opts[:'name']
       query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
 
       # header parameters

data/lib/purecloudplatformclientv2/api/user_recordings_api.rb

@@ -195,8 +195,8 @@ module PureCloud
       
       
       
-      if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
-        fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE'
+      if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'MP3', 'NONE'].include?(opts[:'format_id'])
+        fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE'
       end
       
       

data/lib/purecloudplatformclientv2/api/users_api.rb

@@ -2335,6 +2335,79 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Send an activation email to the user
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :force Resend the invitation even if one is already outstanding (default to false)
+    # @return [nil]
+    def post_user_invite(user_id, opts = {})
+      post_user_invite_with_http_info(user_id, opts)
+      return nil
+    end
+
+    # Send an activation email to the user
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :force Resend the invitation even if one is already outstanding
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def post_user_invite_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi.post_user_invite ..."
+      end
+      
+      
+      # verify the required parameter 'user_id' is set
+      fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.post_user_invite" if user_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/users/{userId}/invite".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'force'] = opts[:'force'] if opts[:'force']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_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(: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: UsersApi#post_user_invite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Add routing skill to user
     # 
     # @param user_id User ID

data/lib/purecloudplatformclientv2/api/voicemail_api.rb

@@ -700,8 +700,8 @@ module PureCloud
       
       
       
-      if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
-        fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE'
+      if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'MP3', 'NONE'].include?(opts[:'format_id'])
+        fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE'
       end
       
       

data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb

@@ -30,10 +30,10 @@ module PureCloud
 
     attr_accessor :first_uri
 
-    attr_accessor :next_uri
-
     attr_accessor :previous_uri
 
+    attr_accessor :next_uri
+
     attr_accessor :last_uri
 
     attr_accessor :page_count
@@ -54,10 +54,10 @@ module PureCloud
         
         :'first_uri' => :'firstUri',
         
-        :'next_uri' => :'nextUri',
-        
         :'previous_uri' => :'previousUri',
         
+        :'next_uri' => :'nextUri',
+        
         :'last_uri' => :'lastUri',
         
         :'page_count' => :'pageCount'
@@ -81,10 +81,10 @@ module PureCloud
         
         :'first_uri' => :'String',
         
-        :'next_uri' => :'String',
-        
         :'previous_uri' => :'String',
         
+        :'next_uri' => :'String',
+        
         :'last_uri' => :'String',
         
         :'page_count' => :'Integer'
@@ -157,19 +157,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'previousUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.previous_uri = attributes[:'previousUri']
         
       
       end
 
       
-      if attributes.has_key?(:'previousUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.previous_uri = attributes[:'previousUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
@@ -312,8 +312,8 @@ module PureCloud
           total == o.total &&
           self_uri == o.self_uri &&
           first_uri == o.first_uri &&
-          next_uri == o.next_uri &&
           previous_uri == o.previous_uri &&
+          next_uri == o.next_uri &&
           last_uri == o.last_uri &&
           page_count == o.page_count
     end
@@ -327,7 +327,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [entities, page_size, page_number, total, self_uri, first_uri, next_uri, previous_uri, last_uri, page_count].hash
+      [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
     end
 
     # build the object from hash