class YousignClient::UserGroupsApi
Attributes
api_client[RW]
Public Class Methods
new(api_client = ApiClient.default)
click to toggle source
# File lib/yousign_client/api/user_groups_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
user_groups_get(opts = {})
click to toggle source
Get User Group list @param [Hash] opts the optional parameters @return [Array<UserGroup>]
# File lib/yousign_client/api/user_groups_api.rb, line 25 def user_groups_get(opts = {}) data, _status_code, _headers = user_groups_get_with_http_info(opts) data end
user_groups_get_with_http_info(opts = {})
click to toggle source
Get User Group list @param [Hash] opts the optional parameters @return [Array<(Array<UserGroup>, Fixnum, Hash)>] Array<UserGroup> data, response status code and response headers
# File lib/yousign_client/api/user_groups_api.rb, line 33 def user_groups_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UserGroupsApi.user_groups_get ...' end # resource path local_var_path = '/user_groups' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] 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, :auth_names => auth_names, :return_type => 'Array<UserGroup>') if @api_client.config.debugging @api_client.config.logger.debug "API called: UserGroupsApi#user_groups_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
user_groups_id_get(id, opts = {})
click to toggle source
Find a User Group by ID @param id @param [Hash] opts the optional parameters @return [UserGroup]
# File lib/yousign_client/api/user_groups_api.rb, line 72 def user_groups_id_get(id, opts = {}) data, _status_code, _headers = user_groups_id_get_with_http_info(id, opts) data end
user_groups_id_get_with_http_info(id, opts = {})
click to toggle source
Find a User Group by ID @param id @param [Hash] opts the optional parameters @return [Array<(UserGroup
, Fixnum, Hash)>] UserGroup
data, response status code and response headers
# File lib/yousign_client/api/user_groups_api.rb, line 81 def user_groups_id_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UserGroupsApi.user_groups_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 UserGroupsApi.user_groups_id_get" end # resource path local_var_path = '/user_groups/{id}'.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] 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, :auth_names => auth_names, :return_type => 'UserGroup') if @api_client.config.debugging @api_client.config.logger.debug "API called: UserGroupsApi#user_groups_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end