Class: YousignClient::MembersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MembersApi

Returns a new instance of MembersApi.



19
20
21
 
# File 'lib/yousign_client/api/members_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/members_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#members_get(opts = {}) ⇒ Array<MemberOutput>

Get all Members Returns the list of Members of a organization. It only usefull if you use the query params named "procedure" for retrieve all members of a procedure.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :procedure (String)

Returns:



27
28
29
30
 
# File 'lib/yousign_client/api/members_api.rb', line 27

def members_get(opts = {})
  data, _status_code, _headers = members_get_with_http_info(opts)
  data
end

#members_get_with_http_info(opts = {}) ⇒ Array<(Array<MemberOutput>, Fixnum, Hash)>

Get all Members Returns the list of Members of a organization. It only usefull if you use the query params named &quot;procedure&quot; for retrieve all members of a procedure.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :procedure (String)

Returns:

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

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



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
68
69
70
71
72
 
# File 'lib/yousign_client/api/members_api.rb', line 37

def members_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.members_get ...'
  end
  # resource path
  local_var_path = '/members'

  # query parameters
  query_params = {}
  query_params[:'procedure'] = opts[:'procedure'] if !opts[:'procedure'].nil?

  # 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<MemberOutput>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MembersApi#members_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#members_id_delete(id, opts = {}) ⇒ nil

Delete a Member Delete a member

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


78
79
80
81
 
# File 'lib/yousign_client/api/members_api.rb', line 78

def members_id_delete(id, opts = {})
  members_id_delete_with_http_info(id, opts)
  nil
end

#members_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Member Delete a member

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
120
121
122
123
124
125
 
# File 'lib/yousign_client/api/members_api.rb', line 88

def members_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.members_id_delete ...'
  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 MembersApi.members_id_delete"
  end
  # resource path
  local_var_path = '/members/{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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MembersApi#members_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#members_id_proof_get(id, opts = {}) ⇒ String

Get a proof file of a Member Get a proof file of a member

Parameters:

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

    the optional parameters

Returns:

  • (String) 


131
132
133
134
 
# File 'lib/yousign_client/api/members_api.rb', line 131

def members_id_proof_get(id, opts = {})
  data, _status_code, _headers = members_id_proof_get_with_http_info(id, opts)
  data
end

#members_id_proof_get_with_http_info(id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get a proof file of a Member Get a proof file of a member

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/yousign_client/api/members_api.rb', line 141

def members_id_proof_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.members_id_proof_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 MembersApi.members_id_proof_get"
  end
  # resource path
  local_var_path = '/members/{id}/proof'.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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MembersApi#members_id_proof_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#members_id_put(id, body, opts = {}) ⇒ MemberOutput

Edit a Member Edit a member

Parameters:

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

    the optional parameters

Returns:



186
187
188
189
 
# File 'lib/yousign_client/api/members_api.rb', line 186

def members_id_put(id, body, opts = {})
  data, _status_code, _headers = members_id_put_with_http_info(id, body, opts)
  data
end

#members_id_put_with_http_info(id, body, opts = {}) ⇒ Array<(MemberOutput, Fixnum, Hash)>

Edit a Member Edit a member

Parameters:

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

    the optional parameters

Returns:

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

    MemberOutput data, response status code and response headers



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/yousign_client/api/members_api.rb', line 197

def members_id_put_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.members_id_put ...'
  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 MembersApi.members_id_put"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MembersApi.members_id_put"
  end
  # resource path
  local_var_path = '/members/{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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MemberOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MembersApi#members_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#members_post(body, opts = {}) ⇒ MemberOutput

Create a new Member Create a new member

Parameters:

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

    the optional parameters

Returns:



243
244
245
246
 
# File 'lib/yousign_client/api/members_api.rb', line 243

def members_post(body, opts = {})
  data, _status_code, _headers = members_post_with_http_info(body, opts)
  data
end

#members_post_with_http_info(body, opts = {}) ⇒ Array<(MemberOutput, Fixnum, Hash)>

Create a new Member Create a new member

Parameters:

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

    the optional parameters

Returns:

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

    MemberOutput data, response status code and response headers



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/yousign_client/api/members_api.rb', line 253

def members_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.members_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MembersApi.members_post"
  end
  # resource path
  local_var_path = '/members'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api_key']
  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,
    :auth_names => auth_names,
    :return_type => 'MemberOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MembersApi#members_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end