class Pipedrive::PermissionSetsApi
Attributes
Public Class Methods
# File lib/pipedrive-openapi-client/api/permission_sets_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get all Permission Sets @param [Hash] opts the optional parameters @return [PermissionSets]
# File lib/pipedrive-openapi-client/api/permission_sets_api.rb, line 25 def permission_sets_get(opts = {}) data, _status_code, _headers = permission_sets_get_with_http_info(opts) data end
Get all Permission Sets @param [Hash] opts the optional parameters @return [Array<(PermissionSets
, Integer, Hash)>] PermissionSets
data, response status code and response headers
# File lib/pipedrive-openapi-client/api/permission_sets_api.rb, line 33 def permission_sets_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PermissionSetsApi.permission_sets_get ...' end # resource path local_var_path = '/permissionSets' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PermissionSets' # auth_names auth_names = opts[:auth_names] || ['api_key'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: PermissionSetsApi#permission_sets_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Permission Set assignments The list of assignments for a Permission Set @param id [Integer] ID of the permission set @param [Hash] opts the optional parameters @option opts [Integer] :start Pagination start (default to 0) @option opts [Integer] :limit Items shown per page @return [UserAssignmentsToPermissionSet]
# File lib/pipedrive-openapi-client/api/permission_sets_api.rb, line 83 def permission_sets_id_assignments_get(id, opts = {}) data, _status_code, _headers = permission_sets_id_assignments_get_with_http_info(id, opts) data end
List Permission Set assignments The list of assignments for a Permission Set @param id [Integer] ID of the permission set @param [Hash] opts the optional parameters @option opts [Integer] :start Pagination start @option opts [Integer] :limit Items shown per page @return [Array<(UserAssignmentsToPermissionSet
, Integer, Hash)>] UserAssignmentsToPermissionSet
data, response status code and response headers
# File lib/pipedrive-openapi-client/api/permission_sets_api.rb, line 95 def permission_sets_id_assignments_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PermissionSetsApi.permission_sets_id_assignments_get ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling PermissionSetsApi.permission_sets_id_assignments_get" end # resource path local_var_path = '/permissionSets/{id}/assignments'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'UserAssignmentsToPermissionSet' # auth_names auth_names = opts[:auth_names] || ['api_key'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: PermissionSetsApi#permission_sets_id_assignments_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get one Permission Set @param id [Integer] ID of the permission set @param [Hash] opts the optional parameters @return [SinglePermissionSetsItem]
# File lib/pipedrive-openapi-client/api/permission_sets_api.rb, line 148 def permission_sets_id_get(id, opts = {}) data, _status_code, _headers = permission_sets_id_get_with_http_info(id, opts) data end
Get one Permission Set @param id [Integer] ID of the permission set @param [Hash] opts the optional parameters @return [Array<(SinglePermissionSetsItem
, Integer, Hash)>] SinglePermissionSetsItem
data, response status code and response headers
# File lib/pipedrive-openapi-client/api/permission_sets_api.rb, line 157 def permission_sets_id_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PermissionSetsApi.permission_sets_id_get ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling PermissionSetsApi.permission_sets_id_get" end # resource path local_var_path = '/permissionSets/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'SinglePermissionSetsItem' # auth_names auth_names = opts[:auth_names] || ['api_key'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: PermissionSetsApi#permission_sets_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end