lib/purecloudplatformclientv2/api/authorization_api.rb in purecloudplatformclientv2-8.0.0 vs lib/purecloudplatformclientv2/api/authorization_api.rb in purecloudplatformclientv2-9.0.0

- old
+ new

@@ -41,12 +41,19 @@ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers def delete_authorization_role_with_http_info(role_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.delete_authorization_role ..." end + + # verify the required parameter 'role_id' is set fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.delete_authorization_role" if role_id.nil? + + + + + # resource path local_var_path = "/api/v2/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s) # query parameters query_params = {} @@ -65,11 +72,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + 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, @@ -97,12 +105,19 @@ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers def delete_user_roles_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.delete_user_roles ..." end + + # verify the required parameter 'user_id' is set fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthorizationApi.delete_user_roles" if user_id.nil? + + + + + # resource path local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} @@ -121,11 +136,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + 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, @@ -155,10 +171,23 @@ # @return [Array<(PermissionCollectionEntityListing, Fixnum, Hash)>] PermissionCollectionEntityListing data, response status code and response headers def get_authorization_permissions_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_permissions ..." end + + + + + + + + + + + + + # resource path local_var_path = "/api/v2/authorization/permissions".sub('{format}','json') # query parameters query_params = {} @@ -179,11 +208,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + 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, @@ -210,10 +240,11 @@ # @return [Array<(OrganizationProductEntityListing, Fixnum, Hash)>] OrganizationProductEntityListing data, response status code and response headers def get_authorization_products_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_products ..." end + # resource path local_var_path = "/api/v2/authorization/products".sub('{format}','json') # query parameters query_params = {} @@ -232,11 +263,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + 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, @@ -265,12 +297,19 @@ # @return [Array<(DomainOrganizationRole, Fixnum, Hash)>] DomainOrganizationRole data, response status code and response headers def get_authorization_role_with_http_info(role_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_role ..." end + + # verify the required parameter 'role_id' is set fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.get_authorization_role" if role_id.nil? + + + + + # resource path local_var_path = "/api/v2/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s) # query parameters query_params = {} @@ -289,11 +328,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + 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, @@ -324,14 +364,27 @@ # @return [Array<(DomainOrgRoleDifference, Fixnum, Hash)>] DomainOrgRoleDifference data, response status code and response headers def get_authorization_role_comparedefault_right_role_id_with_http_info(left_role_id, right_role_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_role_comparedefault_right_role_id ..." end + + # verify the required parameter 'left_role_id' is set fail ArgumentError, "Missing the required parameter 'left_role_id' when calling AuthorizationApi.get_authorization_role_comparedefault_right_role_id" if left_role_id.nil? + + + + + + # verify the required parameter 'right_role_id' is set fail ArgumentError, "Missing the required parameter 'right_role_id' when calling AuthorizationApi.get_authorization_role_comparedefault_right_role_id" if right_role_id.nil? + + + + + # resource path local_var_path = "/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}".sub('{format}','json').sub('{' + 'leftRoleId' + '}', left_role_id.to_s).sub('{' + 'rightRoleId' + '}', right_role_id.to_s) # query parameters query_params = {} @@ -350,11 +403,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + 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, @@ -399,10 +453,65 @@ # @return [Array<(OrganizationRoleEntityListing, Fixnum, Hash)>] OrganizationRoleEntityListing data, response status code and response headers def get_authorization_roles_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_roles ..." end + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + # resource path local_var_path = "/api/v2/authorization/roles".sub('{format}','json') # query parameters query_params = {} @@ -430,11 +539,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + 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, @@ -463,12 +573,19 @@ # @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers def get_user_roles_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.get_user_roles ..." end + + # verify the required parameter 'user_id' is set fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthorizationApi.get_user_roles" if user_id.nil? + + + + + # resource path local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} @@ -487,11 +604,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + 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, @@ -522,14 +640,27 @@ # @return [Array<(DomainOrganizationRole, Fixnum, Hash)>] DomainOrganizationRole data, response status code and response headers def patch_authorization_role_with_http_info(role_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.patch_authorization_role ..." end + + # verify the required parameter 'role_id' is set fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.patch_authorization_role" if role_id.nil? + + + + + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.patch_authorization_role" if body.nil? + + + + + # resource path local_var_path = "/api/v2/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s) # query parameters query_params = {} @@ -548,10 +679,11 @@ # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, @@ -585,16 +717,35 @@ # @return [Array<(DomainOrgRoleDifference, Fixnum, Hash)>] DomainOrgRoleDifference data, response status code and response headers def post_authorization_role_comparedefault_right_role_id_with_http_info(left_role_id, right_role_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.post_authorization_role_comparedefault_right_role_id ..." end + + # verify the required parameter 'left_role_id' is set fail ArgumentError, "Missing the required parameter 'left_role_id' when calling AuthorizationApi.post_authorization_role_comparedefault_right_role_id" if left_role_id.nil? + + + + + + # verify the required parameter 'right_role_id' is set fail ArgumentError, "Missing the required parameter 'right_role_id' when calling AuthorizationApi.post_authorization_role_comparedefault_right_role_id" if right_role_id.nil? + + + + + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.post_authorization_role_comparedefault_right_role_id" if body.nil? + + + + + # resource path local_var_path = "/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}".sub('{format}','json').sub('{' + 'leftRoleId' + '}', left_role_id.to_s).sub('{' + 'rightRoleId' + '}', right_role_id.to_s) # query parameters query_params = {} @@ -613,10 +764,11 @@ # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(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, @@ -646,12 +798,19 @@ # @return [Array<(DomainOrganizationRole, Fixnum, Hash)>] DomainOrganizationRole data, response status code and response headers def post_authorization_roles_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.post_authorization_roles ..." end + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.post_authorization_roles" if body.nil? + + + + + # resource path local_var_path = "/api/v2/authorization/roles".sub('{format}','json') # query parameters query_params = {} @@ -670,10 +829,11 @@ # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(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, @@ -695,18 +855,25 @@ data, _status_code, _headers = post_authorization_roles_default_with_http_info(opts) return data end # Restores all default roles - # This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force&#x3D;true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force&#x3D;true, you can restore all default roles. Note: This does not have an effect on custom roles. + # This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles. # @param [Hash] opts the optional parameters # @option opts [BOOLEAN] :force Restore default roles # @return [Array<(OrganizationRoleEntityListing, Fixnum, Hash)>] OrganizationRoleEntityListing data, response status code and response headers def post_authorization_roles_default_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.post_authorization_roles_default ..." end + + + + + + + # resource path local_var_path = "/api/v2/authorization/roles/default".sub('{format}','json') # query parameters query_params = {} @@ -726,11 +893,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + 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, @@ -761,14 +929,27 @@ # @return [Array<(DomainOrganizationRole, Fixnum, Hash)>] DomainOrganizationRole data, response status code and response headers def put_authorization_role_with_http_info(role_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.put_authorization_role ..." end + + # verify the required parameter 'role_id' is set fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.put_authorization_role" if role_id.nil? + + + + + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.put_authorization_role" if body.nil? + + + + + # resource path local_var_path = "/api/v2/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s) # query parameters query_params = {} @@ -787,10 +968,11 @@ # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, @@ -822,14 +1004,27 @@ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers def put_authorization_role_users_add_with_http_info(role_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.put_authorization_role_users_add ..." end + + # verify the required parameter 'role_id' is set fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.put_authorization_role_users_add" if role_id.nil? + + + + + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.put_authorization_role_users_add" if body.nil? + + + + + # resource path local_var_path = "/api/v2/authorization/roles/{roleId}/users/add".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s) # query parameters query_params = {} @@ -848,10 +1043,11 @@ # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, @@ -883,14 +1079,27 @@ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers def put_authorization_role_users_remove_with_http_info(role_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.put_authorization_role_users_remove ..." end + + # verify the required parameter 'role_id' is set fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.put_authorization_role_users_remove" if role_id.nil? + + + + + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.put_authorization_role_users_remove" if body.nil? + + + + + # resource path local_var_path = "/api/v2/authorization/roles/{roleId}/users/remove".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s) # query parameters query_params = {} @@ -909,10 +1118,11 @@ # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, @@ -942,12 +1152,19 @@ # @return [Array<(OrganizationRoleEntityListing, Fixnum, Hash)>] OrganizationRoleEntityListing data, response status code and response headers def put_authorization_roles_default_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.put_authorization_roles_default ..." end + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.put_authorization_roles_default" if body.nil? + + + + + # resource path local_var_path = "/api/v2/authorization/roles/default".sub('{format}','json') # query parameters query_params = {} @@ -966,10 +1183,11 @@ # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, @@ -1001,14 +1219,27 @@ # @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers def put_user_roles_with_http_info(user_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AuthorizationApi.put_user_roles ..." end + + # verify the required parameter 'user_id' is set fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthorizationApi.put_user_roles" if user_id.nil? + + + + + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.put_user_roles" if body.nil? + + + + + # resource path local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} @@ -1027,9 +1258,10 @@ # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params,