Class: YousignClient::UserGroupsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/yousign_client/api/user_groups_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserGroupsApi

Returns a new instance of UserGroupsApi.



19
20
21
 
# File 'lib/yousign_client/api/user_groups_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/yousign_client/api/user_groups_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#user_groups_get(opts = {}) ⇒ Array<UserGroup>

Get User Group list

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



25
26
27
28
 
# 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 = {}) ⇒ Array<(Array<UserGroup>, Fixnum, Hash)>

Get User Group list

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<UserGroup>, Fixnum, Hash)>) —

    Array<UserGroup> data, response status code and response headers



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# 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 = {}) ⇒ UserGroup

Find a User Group by ID

Parameters:

  • id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



72
73
74
75
 
# 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 = {}) ⇒ Array<(UserGroup, Fixnum, Hash)>

Find a User Group by ID

Parameters:

  • id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UserGroup, Fixnum, Hash)>) —

    UserGroup data, response status code and response headers



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# 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