doc_out/AuthorizationApi.html.md in purecloud-0.44.1 vs doc_out/AuthorizationApi.html.md in purecloud-0.45.1

- old
+ new

@@ -17,11 +17,11 @@ |[**get_roles_role_id**](AuthorizationApi.html#get_roles_role_id) | **GET** /api/v2/authorization/roles/{roleId} | Get a single organization role.| |[**get_user_id_roles**](AuthorizationApi.html#get_user_id_roles) | **GET** /api/v2/users/{userId}/roles | Returns a listing of roles and permissions for a user.| |[**patch_roles_role_id**](AuthorizationApi.html#patch_roles_role_id) | **PATCH** /api/v2/authorization/roles/{roleId} | Patch Organization Role for needsUpdate Field| |[**post_roles**](AuthorizationApi.html#post_roles) | **POST** /api/v2/authorization/roles | Create an organization role.| |[**post_roles_default**](AuthorizationApi.html#post_roles_default) | **POST** /api/v2/authorization/roles/default | Restores all default roles| -|[**post_roles_leftrole_id_comparedefault_rightrole_id**](AuthorizationApi.html#post_roles_leftrole_id_comparedefault_rightrole_id) | **POST** /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId} | Get an unsaved org role to default role comparison| +|[**post_roles_leftrole_id_comparedefault_rightrole_id**](AuthorizationApi.html#post_roles_leftrole_id_comparedefault_rightrole_id) | **POST** /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId} | Get an unsaved org role to default role comparison| |[**put_roles_default**](AuthorizationApi.html#put_roles_default) | **PUT** /api/v2/authorization/roles/default | Restore specified default roles| |[**put_roles_role_id**](AuthorizationApi.html#put_roles_role_id) | **PUT** /api/v2/authorization/roles/{roleId} | Update an organization role.| |[**put_roles_role_id_users_add**](AuthorizationApi.html#put_roles_role_id_users_add) | **PUT** /api/v2/authorization/roles/{roleId}/users/add | Sets the users for the role| |[**put_roles_role_id_users_remove**](AuthorizationApi.html#put_roles_role_id_users_remove) | **PUT** /api/v2/authorization/roles/{roleId}/users/remove | Removes the users from the role| |[**put_user_id_roles**](AuthorizationApi.html#put_user_id_roles) | **PUT** /api/v2/users/{userId}/roles | Sets the user&#39;s roles| @@ -488,11 +488,11 @@ <a name="patch_roles_role_id"></a> -## -[**DomainOrganizationRole**](DomainOrganizationRole.html) patch_roles_role_id(role_id, opts) +## -[**DomainOrganizationRole**](DomainOrganizationRole.html) patch_roles_role_id(role_id, body) Patch Organization Role for needsUpdate Field Patch Organization Role for needsUpdate Field @@ -513,17 +513,16 @@ api_instance = PureCloud::AuthorizationApi.new role_id = "role_id_example" # String | Role ID -opts = { - body: PureCloud::DomainOrganizationRole.new # DomainOrganizationRole | -} +body = PureCloud::DomainOrganizationRole.new # DomainOrganizationRole | Organization role + begin #Patch Organization Role for needsUpdate Field - result = api_instance.patch_roles_role_id(role_id, opts) + result = api_instance.patch_roles_role_id(role_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling AuthorizationApi->patch_roles_role_id: #{e}" end ~~~ @@ -531,11 +530,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **role_id** | **String**| Role ID | - **body** | [**DomainOrganizationRole**](DomainOrganizationRole.html)| | [optional] + **body** | [**DomainOrganizationRole**](DomainOrganizationRole.html)| Organization role | {: class="table table-striped"} ### Return type @@ -548,11 +547,11 @@ <a name="post_roles"></a> -## -[**DomainOrganizationRole**](DomainOrganizationRole.html) post_roles(opts) +## -[**DomainOrganizationRole**](DomainOrganizationRole.html) post_roles(body) Create an organization role. @@ -571,28 +570,27 @@ config.access_token = @authToken end api_instance = PureCloud::AuthorizationApi.new -opts = { - body: PureCloud::DomainOrganizationRole.new # DomainOrganizationRole | -} +body = PureCloud::DomainOrganizationRole.new # DomainOrganizationRole | Organization role + begin #Create an organization role. - result = api_instance.post_roles(opts) + result = api_instance.post_roles(body) p result rescue PureCloud::ApiError => e puts "Exception when calling AuthorizationApi->post_roles: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**DomainOrganizationRole**](DomainOrganizationRole.html)| | [optional] + **body** | [**DomainOrganizationRole**](DomainOrganizationRole.html)| Organization role | {: class="table table-striped"} ### Return type @@ -662,13 +660,13 @@ <a name="post_roles_leftrole_id_comparedefault_rightrole_id"></a> -## -[**DomainOrgRoleDifference**](DomainOrgRoleDifference.html) post_roles_leftrole_id_comparedefault_rightrole_id(left_role_id, right_role_id, opts) +## -[**DomainOrgRoleDifference**](DomainOrgRoleDifference.html) post_roles_leftrole_id_comparedefault_rightrole_id(left_role_id, right_role_id, body) - Get an unsaved org role to default role comparison +Get an unsaved org role to default role comparison Allows users to compare their existing roles in an unsaved state to its default role ### Example ~~~ruby @@ -689,17 +687,16 @@ left_role_id = "left_role_id_example" # String | Left Role ID right_role_id = "right_role_id_example" # String | Right Role id -opts = { - body: PureCloud::DomainOrganizationRole.new # DomainOrganizationRole | -} +body = PureCloud::DomainOrganizationRole.new # DomainOrganizationRole | Organization role + begin - # Get an unsaved org role to default role comparison - result = api_instance.post_roles_leftrole_id_comparedefault_rightrole_id(left_role_id, right_role_id, opts) + #Get an unsaved org role to default role comparison + result = api_instance.post_roles_leftrole_id_comparedefault_rightrole_id(left_role_id, right_role_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling AuthorizationApi->post_roles_leftrole_id_comparedefault_rightrole_id: #{e}" end ~~~ @@ -708,11 +705,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **left_role_id** | **String**| Left Role ID | **right_role_id** | **String**| Right Role id | - **body** | [**DomainOrganizationRole**](DomainOrganizationRole.html)| | [optional] + **body** | [**DomainOrganizationRole**](DomainOrganizationRole.html)| Organization role | {: class="table table-striped"} ### Return type @@ -725,11 +722,11 @@ <a name="put_roles_default"></a> -## -[**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) put_roles_default(opts) +## -[**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) put_roles_default(body) Restore specified default roles @@ -748,28 +745,27 @@ config.access_token = @authToken end api_instance = PureCloud::AuthorizationApi.new -opts = { - body: [PureCloud::DomainOrganizationRole.new] # Array<DomainOrganizationRole> | -} +body = [PureCloud::DomainOrganizationRole.new] # Array<DomainOrganizationRole> | Organization roles list + begin #Restore specified default roles - result = api_instance.put_roles_default(opts) + result = api_instance.put_roles_default(body) p result rescue PureCloud::ApiError => e puts "Exception when calling AuthorizationApi->put_roles_default: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Array&lt;DomainOrganizationRole&gt;**](DomainOrganizationRole.html)| | [optional] + **body** | [**Array&lt;DomainOrganizationRole&gt;**](DomainOrganizationRole.html)| Organization roles list | {: class="table table-striped"} ### Return type @@ -782,11 +778,11 @@ <a name="put_roles_role_id"></a> -## -[**DomainOrganizationRole**](DomainOrganizationRole.html) put_roles_role_id(role_id, opts) +## -[**DomainOrganizationRole**](DomainOrganizationRole.html) put_roles_role_id(role_id, body) Update an organization role. Update @@ -807,17 +803,16 @@ api_instance = PureCloud::AuthorizationApi.new role_id = "role_id_example" # String | Role ID -opts = { - body: PureCloud::DomainOrganizationRole.new # DomainOrganizationRole | -} +body = PureCloud::DomainOrganizationRole.new # DomainOrganizationRole | Organization role + begin #Update an organization role. - result = api_instance.put_roles_role_id(role_id, opts) + result = api_instance.put_roles_role_id(role_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling AuthorizationApi->put_roles_role_id: #{e}" end ~~~ @@ -825,11 +820,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **role_id** | **String**| Role ID | - **body** | [**DomainOrganizationRole**](DomainOrganizationRole.html)| | [optional] + **body** | [**DomainOrganizationRole**](DomainOrganizationRole.html)| Organization role | {: class="table table-striped"} ### Return type @@ -842,11 +837,11 @@ <a name="put_roles_role_id_users_add"></a> -## -Array&lt;String&gt;** put_roles_role_id_users_add(role_id, opts) +## -Array&lt;String&gt;** put_roles_role_id_users_add(role_id, body) Sets the users for the role @@ -867,17 +862,16 @@ api_instance = PureCloud::AuthorizationApi.new role_id = "role_id_example" # String | Role ID -opts = { - body: [PureCloud::Array<String>.new] # Array<String> | -} +body = [PureCloud::Array<String>.new] # Array<String> | List of user IDs + begin #Sets the users for the role - result = api_instance.put_roles_role_id_users_add(role_id, opts) + result = api_instance.put_roles_role_id_users_add(role_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling AuthorizationApi->put_roles_role_id_users_add: #{e}" end ~~~ @@ -885,11 +879,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **role_id** | **String**| Role ID | - **body** | **Array&lt;String&gt;**| | [optional] + **body** | **Array&lt;String&gt;**| List of user IDs | {: class="table table-striped"} ### Return type @@ -902,11 +896,11 @@ <a name="put_roles_role_id_users_remove"></a> -## -Array&lt;String&gt;** put_roles_role_id_users_remove(role_id, opts) +## -Array&lt;String&gt;** put_roles_role_id_users_remove(role_id, body) Removes the users from the role @@ -927,17 +921,16 @@ api_instance = PureCloud::AuthorizationApi.new role_id = "role_id_example" # String | Role ID -opts = { - body: [PureCloud::Array<String>.new] # Array<String> | -} +body = [PureCloud::Array<String>.new] # Array<String> | List of user IDs + begin #Removes the users from the role - result = api_instance.put_roles_role_id_users_remove(role_id, opts) + result = api_instance.put_roles_role_id_users_remove(role_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling AuthorizationApi->put_roles_role_id_users_remove: #{e}" end ~~~ @@ -945,11 +938,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **role_id** | **String**| Role ID | - **body** | **Array&lt;String&gt;**| | [optional] + **body** | **Array&lt;String&gt;**| List of user IDs | {: class="table table-striped"} ### Return type @@ -962,11 +955,11 @@ <a name="put_user_id_roles"></a> -## -[**UserAuthorization**](UserAuthorization.html) put_user_id_roles(user_id, opts) +## -[**UserAuthorization**](UserAuthorization.html) put_user_id_roles(user_id, body) Sets the user's roles @@ -987,17 +980,16 @@ api_instance = PureCloud::AuthorizationApi.new user_id = "user_id_example" # String | User ID -opts = { - body: [PureCloud::Array<String>.new] # Array<String> | -} +body = [PureCloud::Array<String>.new] # Array<String> | List of roles + begin #Sets the user's roles - result = api_instance.put_user_id_roles(user_id, opts) + result = api_instance.put_user_id_roles(user_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling AuthorizationApi->put_user_id_roles: #{e}" end ~~~ @@ -1005,10 +997,10 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **String**| User ID | - **body** | **Array&lt;String&gt;**| | [optional] + **body** | **Array&lt;String&gt;**| List of roles | {: class="table table-striped"} ### Return type