Class: YousignClient::SignatureUIsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SignatureUIsApi

Returns a new instance of SignatureUIsApi.



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

def api_client
  @api_client
end

Instance Method Details

#signature_ui_labels_get(opts = {}) ⇒ Array<SignatureUiLabelOutput>

Get Signature UI Labels Only usefull if you use a filter with name or signatureUI

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Filtering on name of signature ui labels

  • :signature_ui (String) —

    Filtering on id of signature ui resource

Returns:



28
29
30
31
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 28

def signature_ui_labels_get(opts = {})
  data, _status_code, _headers = signature_ui_labels_get_with_http_info(opts)
  data
end

#signature_ui_labels_get_with_http_info(opts = {}) ⇒ Array<(Array<SignatureUiLabelOutput>, Fixnum, Hash)>

Get Signature UI Labels Only usefull if you use a filter with name or signatureUI

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Filtering on name of signature ui labels

  • :signature_ui (String) —

    Filtering on id of signature ui resource

Returns:

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

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



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
73
74
75
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 39

def signature_ui_labels_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_ui_labels_get ...'
  end
  # resource path
  local_var_path = '/signature_ui_labels'

  # query parameters
  query_params = {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'signatureUi'] = opts[:'signature_ui'] if !opts[:'signature_ui'].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<SignatureUiLabelOutput>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureUIsApi#signature_ui_labels_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a Signature UI Label

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id2 (String) —

    Id of signature ui label

Returns:

  • (nil) 


81
82
83
84
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 81

def signature_ui_labels_id_delete(id, opts = {})
  signature_ui_labels_id_delete_with_http_info(id, opts)
  nil
end

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

Delete a Signature UI Label

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id2 (String) —

    Id of signature ui label

Returns:

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

    nil, response status code and response headers



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
126
127
128
129
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 91

def signature_ui_labels_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_ui_labels_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 SignatureUIsApi.signature_ui_labels_id_delete"
  end
  # resource path
  local_var_path = '/signature_ui_labels/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id2'] if !opts[:'id2'].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(: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: SignatureUIsApi#signature_ui_labels_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signature_ui_labels_id_get(id, opts = {}) ⇒ SignatureUiLabelOutput

Find a Signature UI Label by ID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id2 (String) —

    id of signature ui label

Returns:



135
136
137
138
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 135

def signature_ui_labels_id_get(id, opts = {})
  data, _status_code, _headers = signature_ui_labels_id_get_with_http_info(id, opts)
  data
end

#signature_ui_labels_id_get_with_http_info(id, opts = {}) ⇒ Array<(SignatureUiLabelOutput, Fixnum, Hash)>

Find a Signature UI Label by ID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id2 (String) —

    id of signature ui label

Returns:

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

    SignatureUiLabelOutput data, response status code and response headers



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
180
181
182
183
184
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 145

def signature_ui_labels_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_ui_labels_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 SignatureUIsApi.signature_ui_labels_id_get"
  end
  # resource path
  local_var_path = '/signature_ui_labels/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id2'] if !opts[:'id2'].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 => 'SignatureUiLabelOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureUIsApi#signature_ui_labels_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signature_ui_labels_id_put(id, body, opts = {}) ⇒ SignatureUiLabelOutput

Update a Signature UI Label

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id2 (String) —

    Id of signature ui labels

Returns:



191
192
193
194
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 191

def signature_ui_labels_id_put(id, body, opts = {})
  data, _status_code, _headers = signature_ui_labels_id_put_with_http_info(id, body, opts)
  data
end

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

Update a Signature UI Label

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id2 (String) —

    Id of signature ui labels

Returns:

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

    SignatureUiLabelOutput data, response status code and response headers



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
238
239
240
241
242
243
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 202

def signature_ui_labels_id_put_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_ui_labels_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 SignatureUIsApi.signature_ui_labels_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 SignatureUIsApi.signature_ui_labels_id_put"
  end
  # resource path
  local_var_path = '/signature_ui_labels/{id}'.sub('{' + 'id' + '}', id.to_s)

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

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

#signature_ui_labels_post(body, opts = {}) ⇒ SignatureUiLabelOutput

Create a new Signature UI Label

Parameters:

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

    the optional parameters

Returns:



248
249
250
251
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 248

def signature_ui_labels_post(body, opts = {})
  data, _status_code, _headers = signature_ui_labels_post_with_http_info(body, opts)
  data
end

#signature_ui_labels_post_with_http_info(body, opts = {}) ⇒ Array<(SignatureUiLabelOutput, Fixnum, Hash)>

Create a new Signature UI Label

Parameters:

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

    the optional parameters

Returns:

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

    SignatureUiLabelOutput data, response status code and response headers



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
290
291
292
293
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 257

def signature_ui_labels_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_ui_labels_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 SignatureUIsApi.signature_ui_labels_post"
  end
  # resource path
  local_var_path = '/signature_ui_labels'

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

#signature_uis_get(opts = {}) ⇒ Array<SignatureUiOutput>

Get Signature UI list

Parameters:

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

    the optional parameters

Returns:



297
298
299
300
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 297

def signature_uis_get(opts = {})
  data, _status_code, _headers = signature_uis_get_with_http_info(opts)
  data
end

#signature_uis_get_with_http_info(opts = {}) ⇒ Array<(Array<SignatureUiOutput>, Fixnum, Hash)>

Get Signature UI list

Parameters:

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

    the optional parameters

Returns:

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

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 305

def signature_uis_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_uis_get ...'
  end
  # resource path
  local_var_path = '/signature_uis'

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

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

Delete a Signature UI

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id2 (String) —

    Id of the signature ui

Returns:

  • (nil) 


345
346
347
348
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 345

def signature_uis_id_delete(id, opts = {})
  signature_uis_id_delete_with_http_info(id, opts)
  nil
end

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

Delete a Signature UI

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id2 (String) —

    Id of the signature ui

Returns:

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

    nil, response status code and response headers



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 355

def signature_uis_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_uis_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 SignatureUIsApi.signature_uis_id_delete"
  end
  # resource path
  local_var_path = '/signature_uis/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id2'] if !opts[:'id2'].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(: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: SignatureUIsApi#signature_uis_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signature_uis_id_get(id, opts = {}) ⇒ SignatureUiOutput

Find a Signature UI by ID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id2 (String) —

    id of a signature ui

Returns:



399
400
401
402
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 399

def signature_uis_id_get(id, opts = {})
  data, _status_code, _headers = signature_uis_id_get_with_http_info(id, opts)
  data
end

#signature_uis_id_get_with_http_info(id, opts = {}) ⇒ Array<(SignatureUiOutput, Fixnum, Hash)>

Find a Signature UI by ID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id2 (String) —

    id of a signature ui

Returns:

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

    SignatureUiOutput data, response status code and response headers



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 409

def signature_uis_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_uis_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 SignatureUIsApi.signature_uis_id_get"
  end
  # resource path
  local_var_path = '/signature_uis/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id2'] if !opts[:'id2'].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 => 'SignatureUiOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureUIsApi#signature_uis_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signature_uis_id_put(id, opts = {}) ⇒ SignatureUiInputUpdate

Update a Signature UI

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id2 (String) —

    id of signature ui to update

Returns:



454
455
456
457
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 454

def signature_uis_id_put(id, opts = {})
  data, _status_code, _headers = signature_uis_id_put_with_http_info(id, opts)
  data
end

#signature_uis_id_put_with_http_info(id, opts = {}) ⇒ Array<(SignatureUiInputUpdate, Fixnum, Hash)>

Update a Signature UI

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id2 (String) —

    id of signature ui to update

Returns:

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

    SignatureUiInputUpdate data, response status code and response headers



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 464

def signature_uis_id_put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_uis_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 SignatureUIsApi.signature_uis_id_put"
  end
  # resource path
  local_var_path = '/signature_uis/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id2'] if !opts[:'id2'].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(: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 => 'SignatureUiInputUpdate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureUIsApi#signature_uis_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signature_uis_post(body, opts = {}) ⇒ SignatureUiOutput

Create a new Signature UI Here is the url format to build on your side to get a custom signature interface with your settings : webapp.yousign.com/procedure/sign?members=~2Fmembers~2F_MEMBER_ID_&signatureUi=~2Fsignature_uis~2F_SIGNATURE_UI_ID_

Parameters:

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

    the optional parameters

Returns:



509
510
511
512
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 509

def signature_uis_post(body, opts = {})
  data, _status_code, _headers = signature_uis_post_with_http_info(body, opts)
  data
end

#signature_uis_post_with_http_info(body, opts = {}) ⇒ Array<(SignatureUiOutput, Fixnum, Hash)>

Create a new Signature UI Here is the url format to build on your side to get a custom signature interface with your settings : webapp.yousign.com/procedure/sign?members&#x3D;~2Fmembers~2F_MEMBER_ID_&amp;signatureUi&#x3D;~2Fsignature_uis~2F_SIGNATURE_UI_ID_

Parameters:

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

    the optional parameters

Returns:

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

    SignatureUiOutput data, response status code and response headers



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/yousign_client/api/signature_u_is_api.rb', line 519

def signature_uis_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_uis_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 SignatureUIsApi.signature_uis_post"
  end
  # resource path
  local_var_path = '/signature_uis'

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