purecloudplatformclientv2 36.0.0 → 36.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 75b21b636cf2aba720acb06e4108e56e4e5ceeab
4
- data.tar.gz: e88bc2876c207a0c74d3199fbf286158dc0ae1af
3
+ metadata.gz: b4324d4d420da278d411be6d1be5725bb8e848b8
4
+ data.tar.gz: d9e7e561751329187659da739020e78fcfbaa300
5
5
  SHA512:
6
- metadata.gz: 3cec2f5f108920980968c63fe89771b44894aaa9ffcf0337d2c7b5d183360bdcfab23ea3eab12fe63fe117986173084ab338efe5d5c426116d0959898596f4ca
7
- data.tar.gz: ee486089eb83bfb2958fb12012a483bcbea490cfc98feb8b51e4c3a748673d2cc7abf9ec78f5a6decef0f62aaf9e4f5735f162f3422cb839c7ad37f8da7a1c36
6
+ metadata.gz: c637c3df2a9e0ab537480e3383cb8188d094defe1fc693cab0be5039fb164f4b01da093b1d629291c4e528347994071114475b097990a88f00073b23fade23f7
7
+ data.tar.gz: b297deab4a105bd0a9a7719b5ea9861d089d692b7c8e2b1ac41a30076d50cf5f3384d6286dc3a6c6d09d28621c536da7c71b7ee5c7ae748868b278a3e23fba45
data/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: PureCloud Ruby Gem
3
3
  ---
4
- ![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=36.0.0)
4
+ ![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=36.1.0)
5
5
 
6
6
  Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
7
7
 
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
10
10
  ### from rubygems.org
11
11
 
12
12
  ~~~ ruby
13
- gem install 'purecloudplatformclientv2', '~> 36.0.0'
13
+ gem install 'purecloudplatformclientv2', '~> 36.1.0'
14
14
  ~~~
15
15
 
16
16
  ### Install from Git
@@ -15,8 +15,8 @@ title: DomainOrganizationRole
15
15
  | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
16
16
  | **user_count** | **Integer** | | [optional] |
17
17
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
18
- | **base** | **BOOLEAN** | | [optional] |
19
18
  | **default** | **BOOLEAN** | | [optional] |
19
+ | **base** | **BOOLEAN** | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
@@ -15,8 +15,8 @@ title: DomainOrganizationRoleCreate
15
15
  | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
16
16
  | **user_count** | **Integer** | | [optional] |
17
17
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
18
- | **base** | **BOOLEAN** | | [optional] |
19
18
  | **default** | **BOOLEAN** | | [optional] |
19
+ | **base** | **BOOLEAN** | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
@@ -15,8 +15,8 @@ title: DomainOrganizationRoleUpdate
15
15
  | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
16
16
  | **user_count** | **Integer** | | [optional] |
17
17
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
18
- | **base** | **BOOLEAN** | | [optional] |
19
18
  | **default** | **BOOLEAN** | | [optional] |
19
+ | **base** | **BOOLEAN** | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
@@ -7,6 +7,8 @@ title: JsonNode
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
+ | **array** | **BOOLEAN** | | [optional] |
11
+ | **null** | **BOOLEAN** | | [optional] |
10
12
  | **node_type** | **String** | | [optional] |
11
13
  | **object** | **BOOLEAN** | | [optional] |
12
14
  | **boolean** | **BOOLEAN** | | [optional] |
@@ -26,8 +28,6 @@ title: JsonNode
26
28
  | **big_integer** | **BOOLEAN** | | [optional] |
27
29
  | **textual** | **BOOLEAN** | | [optional] |
28
30
  | **binary** | **BOOLEAN** | | [optional] |
29
- | **array** | **BOOLEAN** | | [optional] |
30
- | **null** | **BOOLEAN** | | [optional] |
31
31
  {: class="table table-striped"}
32
32
 
33
33
 
@@ -30,6 +30,7 @@ title: OrgUser
30
30
  | **profile_skills** | **Array<String>** | Skills possessed by the user | [optional] |
31
31
  | **locations** | [**Array<Location>**](Location.html) | The user placement at each site location. | [optional] |
32
32
  | **groups** | [**Array<Group>**](Group.html) | The groups the user is a member of | [optional] |
33
+ | **acd_auto_answer** | **BOOLEAN** | acd auto answer | [optional] |
33
34
  | **organization** | [**Organization**](Organization.html) | | [optional] |
34
35
  {: class="table table-striped"}
35
36
 
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: PatchUser
3
+ ---
4
+ ## PureCloud::PatchUser
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **acd_auto_answer** | **BOOLEAN** | The value that denotes if acdAutoAnswer is set on the user | [optional] |
13
+ | **self_uri** | **String** | The URI for this object | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
@@ -7,10 +7,10 @@ title: TimeZone
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
+ | **display_name** | **String** | | [optional] |
11
+ | **id** | **String** | | [optional] |
10
12
  | **dstsavings** | **Integer** | | [optional] |
11
13
  | **raw_offset** | **Integer** | | [optional] |
12
- | **id** | **String** | | [optional] |
13
- | **display_name** | **String** | | [optional] |
14
14
  {: class="table table-striped"}
15
15
 
16
16
 
@@ -30,6 +30,7 @@ title: TrustUser
30
30
  | **profile_skills** | **Array<String>** | Skills possessed by the user | [optional] |
31
31
  | **locations** | [**Array<Location>**](Location.html) | The user placement at each site location. | [optional] |
32
32
  | **groups** | [**Array<Group>**](Group.html) | The groups the user is a member of | [optional] |
33
+ | **acd_auto_answer** | **BOOLEAN** | acd auto answer | [optional] |
33
34
  | **trust_user_details** | [**TrustUserDetails**](TrustUserDetails.html) | | [optional] |
34
35
  {: class="table table-striped"}
35
36
 
@@ -23,6 +23,7 @@ title: UpdateUser
23
23
  | **locations** | [**Array<Location>**](Location.html) | The user placement at each site location. | [optional] |
24
24
  | **groups** | [**Array<Group>**](Group.html) | The groups the user is a member of | [optional] |
25
25
  | **state** | **String** | The state of the user. This property can be used to restore a deleted user or transition between active and inactive. If specified, it is the only modifiable field. | [optional] |
26
+ | **acd_auto_answer** | **BOOLEAN** | The value that denotes if acdAutoAnswer is set on the user | [optional] |
26
27
  | **self_uri** | **String** | The URI for this object | [optional] |
27
28
  {: class="table table-striped"}
28
29
 
@@ -30,6 +30,7 @@ title: User
30
30
  | **profile_skills** | **Array<String>** | Skills possessed by the user | [optional] |
31
31
  | **locations** | [**Array<Location>**](Location.html) | The user placement at each site location. | [optional] |
32
32
  | **groups** | [**Array<Group>**](Group.html) | The groups the user is a member of | [optional] |
33
+ | **acd_auto_answer** | **BOOLEAN** | acd auto answer | [optional] |
33
34
  | **self_uri** | **String** | The URI for this object | [optional] |
34
35
  {: class="table table-striped"}
35
36
 
@@ -30,6 +30,7 @@ title: UserMe
30
30
  | **profile_skills** | **Array<String>** | Skills possessed by the user | [optional] |
31
31
  | **locations** | [**Array<Location>**](Location.html) | The user placement at each site location. | [optional] |
32
32
  | **groups** | [**Array<Group>**](Group.html) | The groups the user is a member of | [optional] |
33
+ | **acd_auto_answer** | **BOOLEAN** | acd auto answer | [optional] |
33
34
  | **date** | [**ServerDate**](ServerDate.html) | The PureCloud system date time. | [optional] |
34
35
  | **geolocation_settings** | [**GeolocationSettings**](GeolocationSettings.html) | Geolocation settings for user's organization. | [optional] |
35
36
  | **organization** | [**Organization**](Organization.html) | Organization details for this user. | [optional] |
@@ -42,6 +42,7 @@ Method | Description
42
42
  [**patch_user_queue**](UsersApi.html#patch_user_queue) | Join or unjoin a queue for a user
43
43
  [**patch_user_queues**](UsersApi.html#patch_user_queues) | Join or unjoin a set of queues for a user
44
44
  [**patch_user_routinglanguage**](UsersApi.html#patch_user_routinglanguage) | Update routing language proficiency or state.
45
+ [**patch_users_bulk**](UsersApi.html#patch_users_bulk) | Update bulk acd autoanswer on users
45
46
  [**post_analytics_users_aggregates_query**](UsersApi.html#post_analytics_users_aggregates_query) | Query for user aggregates
46
47
  [**post_analytics_users_details_query**](UsersApi.html#post_analytics_users_details_query) | Query for user details
47
48
  [**post_analytics_users_observations_query**](UsersApi.html#post_analytics_users_observations_query) | Query for user observations
@@ -2383,6 +2384,74 @@ Name | Type | Description | Notes
2383
2384
 
2384
2385
 
2385
2386
 
2387
+ <a name="patch_users_bulk"></a>
2388
+
2389
+ ## -[**UserEntityListing**](UserEntityListing.html) patch_users_bulk(body)
2390
+
2391
+
2392
+
2393
+ Update bulk acd autoanswer on users
2394
+
2395
+
2396
+
2397
+ Wraps PATCH /api/v2/users/bulk
2398
+
2399
+ Requires ANY permissions:
2400
+
2401
+ * directory:user:add
2402
+ * user_manager
2403
+ * user_administration
2404
+ * directory:user:edit
2405
+
2406
+
2407
+ ### Example
2408
+ ~~~ruby
2409
+ # load the gem
2410
+ require 'purecloudplatformclientv2'
2411
+ # setup authorization
2412
+ @secret = ENV['PURECLOUD_SECRET']
2413
+ @id = ENV['PURECLOUD_CLIENT_ID']
2414
+ environment = "mypurecloud.com"
2415
+
2416
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2417
+
2418
+ PureCloud.configure do |config|
2419
+ config.access_token = @authToken
2420
+ end
2421
+
2422
+ api_instance = PureCloud::UsersApi.new
2423
+
2424
+ body = [PureCloud::PatchUser.new] # Array<PatchUser> | Users
2425
+
2426
+
2427
+ begin
2428
+ #Update bulk acd autoanswer on users
2429
+ result = api_instance.patch_users_bulk(body)
2430
+ p result
2431
+ rescue PureCloud::ApiError => e
2432
+ puts "Exception when calling UsersApi->patch_users_bulk: #{e}"
2433
+ end
2434
+ ~~~
2435
+
2436
+ ### Parameters
2437
+
2438
+ Name | Type | Description | Notes
2439
+ ------------- | ------------- | ------------- | -------------
2440
+ **body** | [**Array&lt;PatchUser&gt;**](PatchUser.html)| Users | |
2441
+ {: class="table table-striped"}
2442
+
2443
+
2444
+ ### Return type
2445
+
2446
+ [**UserEntityListing**](UserEntityListing.html)
2447
+
2448
+ ### HTTP request headers
2449
+
2450
+ - **Content-Type**: application/json
2451
+ - **Accept**: application/json
2452
+
2453
+
2454
+
2386
2455
  <a name="post_analytics_users_aggregates_query"></a>
2387
2456
 
2388
2457
  ## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_analytics_users_aggregates_query(body)
@@ -797,6 +797,7 @@ require 'purecloudplatformclientv2/models/parsed_certificate'
797
797
  require 'purecloudplatformclientv2/models/participant'
798
798
  require 'purecloudplatformclientv2/models/participant_attributes'
799
799
  require 'purecloudplatformclientv2/models/participant_basic'
800
+ require 'purecloudplatformclientv2/models/patch_user'
800
801
  require 'purecloudplatformclientv2/models/permission_collection_entity_listing'
801
802
  require 'purecloudplatformclientv2/models/permissions'
802
803
  require 'purecloudplatformclientv2/models/phone'
@@ -2696,6 +2696,71 @@ module PureCloud
2696
2696
  return data, status_code, headers
2697
2697
  end
2698
2698
 
2699
+ # Update bulk acd autoanswer on users
2700
+ #
2701
+ # @param body Users
2702
+ # @param [Hash] opts the optional parameters
2703
+ # @return [UserEntityListing]
2704
+ def patch_users_bulk(body, opts = {})
2705
+ data, _status_code, _headers = patch_users_bulk_with_http_info(body, opts)
2706
+ return data
2707
+ end
2708
+
2709
+ # Update bulk acd autoanswer on users
2710
+ #
2711
+ # @param body Users
2712
+ # @param [Hash] opts the optional parameters
2713
+ # @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
2714
+ def patch_users_bulk_with_http_info(body, opts = {})
2715
+ if @api_client.config.debugging
2716
+ @api_client.config.logger.debug "Calling API: UsersApi.patch_users_bulk ..."
2717
+ end
2718
+
2719
+
2720
+ # verify the required parameter 'body' is set
2721
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.patch_users_bulk" if body.nil?
2722
+
2723
+
2724
+
2725
+
2726
+
2727
+ # resource path
2728
+ local_var_path = "/api/v2/users/bulk".sub('{format}','json')
2729
+
2730
+ # query parameters
2731
+ query_params = {}
2732
+
2733
+ # header parameters
2734
+ header_params = {}
2735
+
2736
+ # HTTP header 'Accept' (if needed)
2737
+ local_header_accept = ['application/json']
2738
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2739
+
2740
+ # HTTP header 'Content-Type'
2741
+ local_header_content_type = ['application/json']
2742
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2743
+
2744
+ # form parameters
2745
+ form_params = {}
2746
+
2747
+ # http body (model)
2748
+ post_body = @api_client.object_to_http_body(body)
2749
+
2750
+ auth_names = ['PureCloud Auth']
2751
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
2752
+ :header_params => header_params,
2753
+ :query_params => query_params,
2754
+ :form_params => form_params,
2755
+ :body => post_body,
2756
+ :auth_names => auth_names,
2757
+ :return_type => 'UserEntityListing')
2758
+ if @api_client.config.debugging
2759
+ @api_client.config.logger.debug "API called: UsersApi#patch_users_bulk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2760
+ end
2761
+ return data, status_code, headers
2762
+ end
2763
+
2699
2764
  # Query for user aggregates
2700
2765
  #
2701
2766
  # @param body query
@@ -76,7 +76,7 @@ module PureCloud
76
76
  http_method = http_method.to_sym.downcase
77
77
 
78
78
  header_params = @default_headers.merge(opts[:header_params] || {})
79
- header_params['purecloud-sdk'] = '36.0.0'
79
+ header_params['purecloud-sdk'] = '36.1.0'
80
80
  query_params = opts[:query_params] || {}
81
81
  form_params = opts[:form_params] || {}
82
82
 
@@ -36,10 +36,10 @@ module PureCloud
36
36
  # Optional unless patch operation.
37
37
  attr_accessor :role_needs_update
38
38
 
39
- attr_accessor :base
40
-
41
39
  attr_accessor :default
42
40
 
41
+ attr_accessor :base
42
+
43
43
  # The URI for this object
44
44
  attr_accessor :self_uri
45
45
 
@@ -63,10 +63,10 @@ module PureCloud
63
63
 
64
64
  :'role_needs_update' => :'roleNeedsUpdate',
65
65
 
66
- :'base' => :'base',
67
-
68
66
  :'default' => :'default',
69
67
 
68
+ :'base' => :'base',
69
+
70
70
  :'self_uri' => :'selfUri'
71
71
 
72
72
  }
@@ -92,10 +92,10 @@ module PureCloud
92
92
 
93
93
  :'role_needs_update' => :'BOOLEAN',
94
94
 
95
- :'base' => :'BOOLEAN',
96
-
97
95
  :'default' => :'BOOLEAN',
98
96
 
97
+ :'base' => :'BOOLEAN',
98
+
99
99
  :'self_uri' => :'String'
100
100
 
101
101
  }
@@ -186,19 +186,19 @@ module PureCloud
186
186
  end
187
187
 
188
188
 
189
- if attributes.has_key?(:'base')
189
+ if attributes.has_key?(:'default')
190
190
 
191
191
 
192
- self.base = attributes[:'base']
192
+ self.default = attributes[:'default']
193
193
 
194
194
 
195
195
  end
196
196
 
197
197
 
198
- if attributes.has_key?(:'default')
198
+ if attributes.has_key?(:'base')
199
199
 
200
200
 
201
- self.default = attributes[:'default']
201
+ self.base = attributes[:'base']
202
202
 
203
203
 
204
204
  end
@@ -343,8 +343,8 @@ module PureCloud
343
343
  permission_policies == o.permission_policies &&
344
344
  user_count == o.user_count &&
345
345
  role_needs_update == o.role_needs_update &&
346
- base == o.base &&
347
346
  default == o.default &&
347
+ base == o.base &&
348
348
  self_uri == o.self_uri
349
349
  end
350
350
 
@@ -357,7 +357,7 @@ module PureCloud
357
357
  # Calculates hash code according to all attributes.
358
358
  # @return [Fixnum] Hash code
359
359
  def hash
360
- [id, name, description, default_role_id, permissions, permission_policies, user_count, role_needs_update, base, default, self_uri].hash
360
+ [id, name, description, default_role_id, permissions, permission_policies, user_count, role_needs_update, default, base, self_uri].hash
361
361
  end
362
362
 
363
363
  # build the object from hash
@@ -37,10 +37,10 @@ module PureCloud
37
37
  # Optional unless patch operation.
38
38
  attr_accessor :role_needs_update
39
39
 
40
- attr_accessor :base
41
-
42
40
  attr_accessor :default
43
41
 
42
+ attr_accessor :base
43
+
44
44
  # The URI for this object
45
45
  attr_accessor :self_uri
46
46
 
@@ -64,10 +64,10 @@ module PureCloud
64
64
 
65
65
  :'role_needs_update' => :'roleNeedsUpdate',
66
66
 
67
- :'base' => :'base',
68
-
69
67
  :'default' => :'default',
70
68
 
69
+ :'base' => :'base',
70
+
71
71
  :'self_uri' => :'selfUri'
72
72
 
73
73
  }
@@ -93,10 +93,10 @@ module PureCloud
93
93
 
94
94
  :'role_needs_update' => :'BOOLEAN',
95
95
 
96
- :'base' => :'BOOLEAN',
97
-
98
96
  :'default' => :'BOOLEAN',
99
97
 
98
+ :'base' => :'BOOLEAN',
99
+
100
100
  :'self_uri' => :'String'
101
101
 
102
102
  }
@@ -187,19 +187,19 @@ module PureCloud
187
187
  end
188
188
 
189
189
 
190
- if attributes.has_key?(:'base')
190
+ if attributes.has_key?(:'default')
191
191
 
192
192
 
193
- self.base = attributes[:'base']
193
+ self.default = attributes[:'default']
194
194
 
195
195
 
196
196
  end
197
197
 
198
198
 
199
- if attributes.has_key?(:'default')
199
+ if attributes.has_key?(:'base')
200
200
 
201
201
 
202
- self.default = attributes[:'default']
202
+ self.base = attributes[:'base']
203
203
 
204
204
 
205
205
  end
@@ -349,8 +349,8 @@ module PureCloud
349
349
  permission_policies == o.permission_policies &&
350
350
  user_count == o.user_count &&
351
351
  role_needs_update == o.role_needs_update &&
352
- base == o.base &&
353
352
  default == o.default &&
353
+ base == o.base &&
354
354
  self_uri == o.self_uri
355
355
  end
356
356
 
@@ -363,7 +363,7 @@ module PureCloud
363
363
  # Calculates hash code according to all attributes.
364
364
  # @return [Fixnum] Hash code
365
365
  def hash
366
- [id, name, description, default_role_id, permissions, permission_policies, user_count, role_needs_update, base, default, self_uri].hash
366
+ [id, name, description, default_role_id, permissions, permission_policies, user_count, role_needs_update, default, base, self_uri].hash
367
367
  end
368
368
 
369
369
  # build the object from hash