Class: YousignClient::ProceduresApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProceduresApi

Returns a new instance of ProceduresApi.



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

def api_client
  @api_client
end

Instance Method Details

#export_procedures_get(opts = {}) ⇒ String

Export Procedure list

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Return Procedure list based on the status for each Procedure

  • :name (String) —

    Filter by name (contains)

  • :members_firstname (String) —

    Filter by member firstname (contains)

  • :members_lastname (String) —

    Filter by member lastname (contains)

  • :members_phone (String) —

    Filter by member phone (contains)

  • :members_email (String) —

    Filter by member email (contains)

  • :files_name (String) —

    Filter by file name (contains)

  • :created_at (Array<Date>) —

    Filter by creation date createdAt&#x3D;2017-09-18 createdAt&#x3D;2017-09-18 createdAt&#x3D;2017-09-18 createdAt&#x3D;2017-09-18

  • :updated_at (Array<Date>) —

    Filter by update date updatedAt&#x3D;2017-09-18 updatedAt&#x3D;2017-09-18 updatedAt&#x3D;2017-09-18 updatedAt&#x3D;2017-09-18

  • :expires_at (Array<Date>) —

    Filter by expire date expiresAt&#x3D;2017-09-18 expiresAt&#x3D;2017-09-18 expiresAt&#x3D;2017-09-18 expiresAt&#x3D;2017-09-18

  • :deleted_at (Array<Date>) —

    Filter by delete date deletedAt&#x3D;2017-09-18 deletedAt&#x3D;2017-09-18 deletedAt&#x3D;2017-09-18 deletedAt&#x3D;2017-09-18

  • :order_created_at (String) —

    Order by attribut

Returns:

  • (String) 


37
38
39
40
 
# File 'lib/yousign_client/api/procedures_api.rb', line 37

def export_procedures_get(opts = {})
  data, _status_code, _headers = export_procedures_get_with_http_info(opts)
  data
end

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

Export Procedure list

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Return Procedure list based on the status for each Procedure

  • :name (String) —

    Filter by name (contains)

  • :members_firstname (String) —

    Filter by member firstname (contains)

  • :members_lastname (String) —

    Filter by member lastname (contains)

  • :members_phone (String) —

    Filter by member phone (contains)

  • :members_email (String) —

    Filter by member email (contains)

  • :files_name (String) —

    Filter by file name (contains)

  • :created_at (Array<Date>) —

    Filter by creation date createdAt&#x3D;2017-09-18 createdAt&#x3D;2017-09-18 createdAt&#x3D;2017-09-18 createdAt&#x3D;2017-09-18

  • :updated_at (Array<Date>) —

    Filter by update date updatedAt&#x3D;2017-09-18 updatedAt&#x3D;2017-09-18 updatedAt&#x3D;2017-09-18 updatedAt&#x3D;2017-09-18

  • :expires_at (Array<Date>) —

    Filter by expire date expiresAt&#x3D;2017-09-18 expiresAt&#x3D;2017-09-18 expiresAt&#x3D;2017-09-18 expiresAt&#x3D;2017-09-18

  • :deleted_at (Array<Date>) —

    Filter by delete date deletedAt&#x3D;2017-09-18 deletedAt&#x3D;2017-09-18 deletedAt&#x3D;2017-09-18 deletedAt&#x3D;2017-09-18

  • :order_created_at (String) —

    Order by attribut

Returns:

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

    String data, response status code and response headers



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
 
# File 'lib/yousign_client/api/procedures_api.rb', line 57

def export_procedures_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProceduresApi.export_procedures_get ...'
  end
  if @api_client.config.client_side_validation && opts[:'status'] && !['active', 'finished', 'expired', 'refused', 'draft'].include?(opts[:'status'])
    fail ArgumentError, 'invalid value for "status", must be one of active, finished, expired, refused, draft'
  end
  if @api_client.config.client_side_validation && opts[:'order_created_at'] && !['asc', 'desc'].include?(opts[:'order_created_at'])
    fail ArgumentError, 'invalid value for "order_created_at", must be one of asc, desc'
  end
  # resource path
  local_var_path = '/export/procedures'

  # query parameters
  query_params = {}
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'members.firstname'] = opts[:'members_firstname'] if !opts[:'members_firstname'].nil?
  query_params[:'members.lastname'] = opts[:'members_lastname'] if !opts[:'members_lastname'].nil?
  query_params[:'members.phone'] = opts[:'members_phone'] if !opts[:'members_phone'].nil?
  query_params[:'members.email'] = opts[:'members_email'] if !opts[:'members_email'].nil?
  query_params[:'files.name'] = opts[:'files_name'] if !opts[:'files_name'].nil?
  query_params[:'createdAt'] = @api_client.build_collection_param(opts[:'created_at'], :csv) if !opts[:'created_at'].nil?
  query_params[:'updatedAt'] = @api_client.build_collection_param(opts[:'updated_at'], :csv) if !opts[:'updated_at'].nil?
  query_params[:'expiresAt'] = @api_client.build_collection_param(opts[:'expires_at'], :csv) if !opts[:'expires_at'].nil?
  query_params[:'deletedAt'] = @api_client.build_collection_param(opts[:'deleted_at'], :csv) if !opts[:'deleted_at'].nil?
  query_params[:'order[createdAt]'] = opts[:'order_created_at'] if !opts[:'order_created_at'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
  # 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: ProceduresApi#export_procedures_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#procedures_get(opts = {}) ⇒ Array<ProcedureOutput>

Get Procedure list

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Return Procedure list based on the status for each Procedure

  • :template (BOOLEAN) —

    Used to get Procedure template list (default to false)

  • :members (Array<String>) —

    Get Procedure list for given members (paraph mode)

  • :items_per_page (String) —

    Number of items per page for the pagination

  • :pagination (BOOLEAN) —

    Enable the pagination

  • :page (Integer) —

    Page of the pagination

  • :name (String) —

    Filter by name (contains)

  • :members_firstname (String) —

    Filter by member firstname (contains)

  • :members_lastname (String) —

    Filter by member lastname (contains)

  • :members_phone (String) —

    Filter by member phone (contains)

  • :members_email (String) —

    Filter by member email (contains)

  • :files_name (String) —

    Filter by file name (contains)

  • :created_at (Array<Date>) —

    Filter by creation date createdAt&#x3D;2017-09-18 createdAt&#x3D;2017-09-18 createdAt&#x3D;2017-09-18 createdAt&#x3D;2017-09-18

  • :updated_at (Array<Date>) —

    Filter by update date updatedAt&#x3D;2017-09-18 updatedAt&#x3D;2017-09-18 updatedAt&#x3D;2017-09-18 updatedAt&#x3D;2017-09-18

  • :expires_at (Array<Date>) —

    Filter by expire date expiresAt&#x3D;2017-09-18 expiresAt&#x3D;2017-09-18 expiresAt&#x3D;2017-09-18 expiresAt&#x3D;2017-09-18

  • :deleted_at (Array<Date>) —

    Filter by delete date deletedAt&#x3D;2017-09-18 deletedAt&#x3D;2017-09-18 deletedAt&#x3D;2017-09-18 deletedAt&#x3D;2017-09-18

  • :order_created_at (String) —

    Order by createdAt order&#x3D;asc order&#x3D;desc

Returns:



130
131
132
133
 
# File 'lib/yousign_client/api/procedures_api.rb', line 130

def procedures_get(opts = {})
  data, _status_code, _headers = procedures_get_with_http_info(opts)
  data
end

#procedures_get_with_http_info(opts = {}) ⇒ Array<(Array<ProcedureOutput>, Fixnum, Hash)>

Get Procedure list

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Return Procedure list based on the status for each Procedure

  • :template (BOOLEAN) —

    Used to get Procedure template list

  • :members (Array<String>) —

    Get Procedure list for given members (paraph mode)

  • :items_per_page (String) —

    Number of items per page for the pagination

  • :pagination (BOOLEAN) —

    Enable the pagination

  • :page (Integer) —

    Page of the pagination

  • :name (String) —

    Filter by name (contains)

  • :members_firstname (String) —

    Filter by member firstname (contains)

  • :members_lastname (String) —

    Filter by member lastname (contains)

  • :members_phone (String) —

    Filter by member phone (contains)

  • :members_email (String) —

    Filter by member email (contains)

  • :files_name (String) —

    Filter by file name (contains)

  • :created_at (Array<Date>) —

    Filter by creation date createdAt&#x3D;2017-09-18 createdAt&#x3D;2017-09-18 createdAt&#x3D;2017-09-18 createdAt&#x3D;2017-09-18

  • :updated_at (Array<Date>) —

    Filter by update date updatedAt&#x3D;2017-09-18 updatedAt&#x3D;2017-09-18 updatedAt&#x3D;2017-09-18 updatedAt&#x3D;2017-09-18

  • :expires_at (Array<Date>) —

    Filter by expire date expiresAt&#x3D;2017-09-18 expiresAt&#x3D;2017-09-18 expiresAt&#x3D;2017-09-18 expiresAt&#x3D;2017-09-18

  • :deleted_at (Array<Date>) —

    Filter by delete date deletedAt&#x3D;2017-09-18 deletedAt&#x3D;2017-09-18 deletedAt&#x3D;2017-09-18 deletedAt&#x3D;2017-09-18

  • :order_created_at (String) —

    Order by createdAt order&#x3D;asc order&#x3D;desc

Returns:

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

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



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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/yousign_client/api/procedures_api.rb', line 155

def procedures_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProceduresApi.procedures_get ...'
  end
  if @api_client.config.client_side_validation && opts[:'status'] && !['active', 'finished', 'expired', 'refused', 'draft'].include?(opts[:'status'])
    fail ArgumentError, 'invalid value for "status", must be one of active, finished, expired, refused, draft'
  end
  if @api_client.config.client_side_validation && opts[:'order_created_at'] && !['asc', 'desc'].include?(opts[:'order_created_at'])
    fail ArgumentError, 'invalid value for "order_created_at", must be one of asc, desc'
  end
  # resource path
  local_var_path = '/procedures'

  # query parameters
  query_params = {}
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'template'] = opts[:'template'] if !opts[:'template'].nil?
  query_params[:'members'] = @api_client.build_collection_param(opts[:'members'], :csv) if !opts[:'members'].nil?
  query_params[:'itemsPerPage'] = opts[:'items_per_page'] if !opts[:'items_per_page'].nil?
  query_params[:'pagination'] = opts[:'pagination'] if !opts[:'pagination'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'members.firstname'] = opts[:'members_firstname'] if !opts[:'members_firstname'].nil?
  query_params[:'members.lastname'] = opts[:'members_lastname'] if !opts[:'members_lastname'].nil?
  query_params[:'members.phone'] = opts[:'members_phone'] if !opts[:'members_phone'].nil?
  query_params[:'members.email'] = opts[:'members_email'] if !opts[:'members_email'].nil?
  query_params[:'files.name'] = opts[:'files_name'] if !opts[:'files_name'].nil?
  query_params[:'createdAt'] = @api_client.build_collection_param(opts[:'created_at'], :csv) if !opts[:'created_at'].nil?
  query_params[:'updatedAt'] = @api_client.build_collection_param(opts[:'updated_at'], :csv) if !opts[:'updated_at'].nil?
  query_params[:'expiresAt'] = @api_client.build_collection_param(opts[:'expires_at'], :csv) if !opts[:'expires_at'].nil?
  query_params[:'deletedAt'] = @api_client.build_collection_param(opts[:'deleted_at'], :csv) if !opts[:'deleted_at'].nil?
  query_params[:'order[createdAt]'] = opts[:'order_created_at'] if !opts[:'order_created_at'].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<ProcedureOutput>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProceduresApi#procedures_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a Procedure

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


217
218
219
220
 
# File 'lib/yousign_client/api/procedures_api.rb', line 217

def procedures_id_delete(id, opts = {})
  procedures_id_delete_with_http_info(id, opts)
  nil
end

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

Delete a Procedure

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/yousign_client/api/procedures_api.rb', line 226

def procedures_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProceduresApi.procedures_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 ProceduresApi.procedures_id_delete"
  end
  # resource path
  local_var_path = '/procedures/{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: ProceduresApi#procedures_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#procedures_id_duplicate_post(id, body, opts = {}) ⇒ ProcedureOutput

Duplicate a Procedure

Parameters:

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

    the optional parameters

Returns:



269
270
271
272
 
# File 'lib/yousign_client/api/procedures_api.rb', line 269

def procedures_id_duplicate_post(id, body, opts = {})
  data, _status_code, _headers = procedures_id_duplicate_post_with_http_info(id, body, opts)
  data
end

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

Duplicate a Procedure

Parameters:

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

    the optional parameters

Returns:

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

    ProcedureOutput data, response status code and response headers



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/yousign_client/api/procedures_api.rb', line 279

def procedures_id_duplicate_post_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProceduresApi.procedures_id_duplicate_post ...'
  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 ProceduresApi.procedures_id_duplicate_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 ProceduresApi.procedures_id_duplicate_post"
  end
  # resource path
  local_var_path = '/procedures/{id}/duplicate'.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(: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 => 'ProcedureOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProceduresApi#procedures_id_duplicate_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#procedures_id_get(id, opts = {}) ⇒ ProcedureOutput

Find a Procedure by ID

Parameters:

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

    the optional parameters

Returns:



324
325
326
327
 
# File 'lib/yousign_client/api/procedures_api.rb', line 324

def procedures_id_get(id, opts = {})
  data, _status_code, _headers = procedures_id_get_with_http_info(id, opts)
  data
end

#procedures_id_get_with_http_info(id, opts = {}) ⇒ Array<(ProcedureOutput, Fixnum, Hash)>

Find a Procedure by ID

Parameters:

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

    the optional parameters

Returns:

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

    ProcedureOutput data, response status code and response headers



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/yousign_client/api/procedures_api.rb', line 333

def procedures_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProceduresApi.procedures_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 ProceduresApi.procedures_id_get"
  end
  # resource path
  local_var_path = '/procedures/{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 => 'ProcedureOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProceduresApi#procedures_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a Procedure proof file Get a Procedure proof file

Parameters:

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

    the optional parameters

Returns:

  • (String) 


377
378
379
380
 
# File 'lib/yousign_client/api/procedures_api.rb', line 377

def procedures_id_proof_get(id, opts = {})
  data, _status_code, _headers = procedures_id_proof_get_with_http_info(id, opts)
  data
end

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

Get a Procedure proof file Get a Procedure proof file

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/yousign_client/api/procedures_api.rb', line 387

def procedures_id_proof_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProceduresApi.procedures_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 ProceduresApi.procedures_id_proof_get"
  end
  # resource path
  local_var_path = '/procedures/{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: ProceduresApi#procedures_id_proof_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#procedures_id_put(id, body, opts = {}) ⇒ ProcedureOutput

Update a Procedure

Parameters:

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

    the optional parameters

Returns:



431
432
433
434
 
# File 'lib/yousign_client/api/procedures_api.rb', line 431

def procedures_id_put(id, body, opts = {})
  data, _status_code, _headers = procedures_id_put_with_http_info(id, body, opts)
  data
end

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

Update a Procedure

Parameters:

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

    the optional parameters

Returns:

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

    ProcedureOutput data, response status code and response headers



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/yousign_client/api/procedures_api.rb', line 441

def procedures_id_put_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProceduresApi.procedures_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 ProceduresApi.procedures_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 ProceduresApi.procedures_id_put"
  end
  # resource path
  local_var_path = '/procedures/{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 => 'ProcedureOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProceduresApi#procedures_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#procedures_id_remind_post(id, body, opts = {}) ⇒ ProcedureOutput

Remind a Procedure

Parameters:

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

    the optional parameters

Returns:



487
488
489
490
 
# File 'lib/yousign_client/api/procedures_api.rb', line 487

def procedures_id_remind_post(id, body, opts = {})
  data, _status_code, _headers = procedures_id_remind_post_with_http_info(id, body, opts)
  data
end

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

Remind a Procedure

Parameters:

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

    the optional parameters

Returns:

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

    ProcedureOutput data, response status code and response headers



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/yousign_client/api/procedures_api.rb', line 497

def procedures_id_remind_post_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProceduresApi.procedures_id_remind_post ...'
  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 ProceduresApi.procedures_id_remind_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 ProceduresApi.procedures_id_remind_post"
  end
  # resource path
  local_var_path = '/procedures/{id}/remind'.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(: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 => 'ProcedureOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProceduresApi#procedures_id_remind_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#procedures_post(body, opts = {}) ⇒ ProcedureOutput

Create a new Procedure

Parameters:

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

    the optional parameters

Returns:



542
543
544
545
 
# File 'lib/yousign_client/api/procedures_api.rb', line 542

def procedures_post(body, opts = {})
  data, _status_code, _headers = procedures_post_with_http_info(body, opts)
  data
end

#procedures_post_with_http_info(body, opts = {}) ⇒ Array<(ProcedureOutput, Fixnum, Hash)>

Create a new Procedure

Parameters:

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

    the optional parameters

Returns:

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

    ProcedureOutput data, response status code and response headers



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
 
# File 'lib/yousign_client/api/procedures_api.rb', line 551

def procedures_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProceduresApi.procedures_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 ProceduresApi.procedures_post"
  end
  # resource path
  local_var_path = '/procedures'

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