Class: DocuSign_eSign::NotaryApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/api/notary_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = NotaryApi.default) ⇒ NotaryApi

Returns a new instance of NotaryApi.



44
45
46
 
# File 'lib/docusign_esign/api/notary_api.rb', line 44

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



42
43
44
 
# File 'lib/docusign_esign/api/notary_api.rb', line 42

def api_client
  @api_client
end

Instance Method Details

#create_notary(notary) ⇒ Notary

Add a notary to the system Registers the current user as a notary.

Parameters:

  • notary (optional parameter)

Returns:



52
53
54
55
 
# File 'lib/docusign_esign/api/notary_api.rb', line 52

def create_notary(notary)
  data, _status_code, _headers = create_notary_with_http_info( notary)
  return data
end

#create_notary_jurisdictions(notary_jurisdiction) ⇒ NotaryJurisdiction

Add a notary jurisdiction to the system Creates a jurisdiction object.

Parameters:

  • notary_jurisdiction (optional parameter)

Returns:



99
100
101
102
 
# File 'lib/docusign_esign/api/notary_api.rb', line 99

def create_notary_jurisdictions(notary_jurisdiction)
  data, _status_code, _headers = create_notary_jurisdictions_with_http_info( notary_jurisdiction)
  return data
end

#create_notary_jurisdictions_with_http_info(notary_jurisdiction) ⇒ Array<(NotaryJurisdiction, Fixnum, Hash)>

Add a notary jurisdiction to the system Creates a jurisdiction object.

Parameters:

  • notary_jurisdiction (optional parameter)

Returns:

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

    NotaryJurisdiction data, response status code and response headers



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/docusign_esign/api/notary_api.rb', line 108

def create_notary_jurisdictions_with_http_info(notary_jurisdiction)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.create_notary_jurisdictions ..."
  end
  # resource path
  local_var_path = "/v2.1/current_user/notary/jurisdictions".sub('{format}','json')

  # 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(notary_jurisdiction)
  auth_names = []
  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 => 'NotaryJurisdiction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#create_notary_jurisdictions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_notary_with_http_info(notary) ⇒ Array<(Notary, Fixnum, Hash)>

Add a notary to the system Registers the current user as a notary.

Parameters:

  • notary (optional parameter)

Returns:

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

    Notary data, response status code and response headers



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
 
# File 'lib/docusign_esign/api/notary_api.rb', line 61

def create_notary_with_http_info(notary)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.create_notary ..."
  end
  # resource path
  local_var_path = "/v2.1/current_user/notary".sub('{format}','json')

  # 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(notary)
  auth_names = []
  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 => 'Notary')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#create_notary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_notary_jurisdiction(jurisdiction_id) ⇒ nil

Delete a notary jurisdiction a specified user. Deletes the specified jurisdiction.

Parameters:

  • jurisdiction_id

Returns:

  • (nil) 


146
147
148
149
 
# File 'lib/docusign_esign/api/notary_api.rb', line 146

def delete_notary_jurisdiction(jurisdiction_id)
  delete_notary_jurisdiction_with_http_info(jurisdiction_id)
  return nil
end

#delete_notary_jurisdiction_with_http_info(jurisdiction_id) ⇒ Array<(nil, Fixnum, Hash)>

Delete a notary jurisdiction a specified user. Deletes the specified jurisdiction.

Parameters:

  • jurisdiction_id

Returns:

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

    nil, 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
 
# File 'lib/docusign_esign/api/notary_api.rb', line 155

def delete_notary_jurisdiction_with_http_info(jurisdiction_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.delete_notary_jurisdiction ..."
  end
  # verify the required parameter 'jurisdiction_id' is set
  fail ArgumentError, "Missing the required parameter 'jurisdiction_id' when calling NotaryApi.delete_notary_jurisdiction" if jurisdiction_id.nil?
  # resource path
  local_var_path = "/v2.1/current_user/notary/jurisdictions/{jurisdictionId}".sub('{format}','json').sub('{' + 'jurisdictionId' + '}', jurisdiction_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 = nil
  auth_names = []
  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: NotaryApi#delete_notary_jurisdiction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notary(options = DocuSign_eSign::GetNotaryOptions.default) ⇒ NotaryResult

Get notary settings for a user Gets settings for a notary user. The current user must be a notary.

Parameters:

  • DocuSign_eSign::GetNotaryOptions —

    Options for modifying the behavior of the function.

Returns:



194
195
196
197
 
# File 'lib/docusign_esign/api/notary_api.rb', line 194

def get_notary(options = DocuSign_eSign::GetNotaryOptions.default)
  data, _status_code, _headers = get_notary_with_http_info(options)
  return data
end

#get_notary_jurisdiction(jurisdiction_id) ⇒ NotaryJurisdiction

Get notary a jurisdiction for a user Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The ‘jurisdictionId` must be a jurisdiction that the notary is registered for.

Parameters:

  • jurisdiction_id

Returns:



242
243
244
245
 
# File 'lib/docusign_esign/api/notary_api.rb', line 242

def get_notary_jurisdiction(jurisdiction_id)
  data, _status_code, _headers = get_notary_jurisdiction_with_http_info(jurisdiction_id)
  return data
end

#get_notary_jurisdiction_seal(jurisdiction_id) ⇒ nil

Get notary seal for a jurisdiction

Parameters:

  • jurisdiction_id

Returns:

  • (nil) 


291
292
293
294
 
# File 'lib/docusign_esign/api/notary_api.rb', line 291

def get_notary_jurisdiction_seal(jurisdiction_id)
  get_notary_jurisdiction_seal_with_http_info(jurisdiction_id)
  return nil
end

#get_notary_jurisdiction_seal_with_http_info(jurisdiction_id) ⇒ Array<(nil, Fixnum, Hash)>

Get notary seal for a jurisdiction

Parameters:

  • jurisdiction_id

Returns:

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

    nil, response status code and response headers



300
301
302
303
304
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
 
# File 'lib/docusign_esign/api/notary_api.rb', line 300

def get_notary_jurisdiction_seal_with_http_info(jurisdiction_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.get_notary_jurisdiction_seal ..."
  end
  # verify the required parameter 'jurisdiction_id' is set
  fail ArgumentError, "Missing the required parameter 'jurisdiction_id' when calling NotaryApi.get_notary_jurisdiction_seal" if jurisdiction_id.nil?
  # resource path
  local_var_path = "/v2.1/current_user/notary/jurisdictions/{jurisdictionId}/seal".sub('{format}','json').sub('{' + 'jurisdictionId' + '}', jurisdiction_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 = nil
  auth_names = []
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#get_notary_jurisdiction_seal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notary_jurisdiction_with_http_info(jurisdiction_id) ⇒ Array<(NotaryJurisdiction, Fixnum, Hash)>

Get notary a jurisdiction for a user Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The &#x60;jurisdictionId&#x60; must be a jurisdiction that the notary is registered for.

Parameters:

  • jurisdiction_id

Returns:

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

    NotaryJurisdiction data, response status code and response headers



251
252
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
 
# File 'lib/docusign_esign/api/notary_api.rb', line 251

def get_notary_jurisdiction_with_http_info(jurisdiction_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.get_notary_jurisdiction ..."
  end
  # verify the required parameter 'jurisdiction_id' is set
  fail ArgumentError, "Missing the required parameter 'jurisdiction_id' when calling NotaryApi.get_notary_jurisdiction" if jurisdiction_id.nil?
  # resource path
  local_var_path = "/v2.1/current_user/notary/jurisdictions/{jurisdictionId}".sub('{format}','json').sub('{' + 'jurisdictionId' + '}', jurisdiction_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 = nil
  auth_names = []
  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 => 'NotaryJurisdiction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#get_notary_jurisdiction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notary_jurisdictions ⇒ NotaryJurisdictionList

Get notary jurisdictions for a user Returns a list of jurisdictions that the notary is registered in. The current user must be a notary.

Returns:



338
339
340
341
 
# File 'lib/docusign_esign/api/notary_api.rb', line 338

def get_notary_jurisdictions()
  data, _status_code, _headers = get_notary_jurisdictions_with_http_info()
  return data
end

#get_notary_jurisdictions_with_http_info ⇒ Array<(NotaryJurisdictionList, Fixnum, Hash)>

Get notary jurisdictions for a user Returns a list of jurisdictions that the notary is registered in. The current user must be a notary.

Returns:

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

    NotaryJurisdictionList data, response status code and response headers



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
372
373
374
375
376
377
378
 
# File 'lib/docusign_esign/api/notary_api.rb', line 346

def get_notary_jurisdictions_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.get_notary_jurisdictions ..."
  end
  # resource path
  local_var_path = "/v2.1/current_user/notary/jurisdictions".sub('{format}','json')

  # 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 = nil
  auth_names = []
  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 => 'NotaryJurisdictionList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#get_notary_jurisdictions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notary_with_http_info(options = DocuSign_eSign::GetNotaryOptions.default) ⇒ Array<(NotaryResult, Fixnum, Hash)>

Get notary settings for a user Gets settings for a notary user. The current user must be a notary.

Parameters:

  • DocuSign_eSign::GetNotaryOptions —

    Options for modifying the behavior of the function.

Returns:

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

    NotaryResult data, response status code and response headers



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
 
# File 'lib/docusign_esign/api/notary_api.rb', line 203

def get_notary_with_http_info(options = DocuSign_eSign::GetNotaryOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.get_notary ..."
  end
  # resource path
  local_var_path = "/v2.1/current_user/notary".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'include_jurisdictions'] = options.include_jurisdictions if !options.include_jurisdictions.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 = nil
  auth_names = []
  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 => 'NotaryResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#get_notary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_notary_journals(options = DocuSign_eSign::ListNotaryJournalsOptions.default) ⇒ NotaryJournalList

Get notary jurisdictions for a user

Parameters:

  • DocuSign_eSign::ListNotaryJournalsOptions —

    Options for modifying the behavior of the function.

Returns:



384
385
386
387
 
# File 'lib/docusign_esign/api/notary_api.rb', line 384

def list_notary_journals(options = DocuSign_eSign::ListNotaryJournalsOptions.default)
  data, _status_code, _headers = list_notary_journals_with_http_info(options)
  return data
end

#list_notary_journals_with_http_info(options = DocuSign_eSign::ListNotaryJournalsOptions.default) ⇒ Array<(NotaryJournalList, Fixnum, Hash)>

Get notary jurisdictions for a user

Parameters:

  • DocuSign_eSign::ListNotaryJournalsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    NotaryJournalList data, response status code and response headers



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
426
427
428
 
# File 'lib/docusign_esign/api/notary_api.rb', line 393

def list_notary_journals_with_http_info(options = DocuSign_eSign::ListNotaryJournalsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.list_notary_journals ..."
  end
  # resource path
  local_var_path = "/v2.1/current_user/notary/journals".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'search_text'] = options.search_text if !options.search_text.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.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 = nil
  auth_names = []
  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 => 'NotaryJournalList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#list_notary_journals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_notary(notary) ⇒ Notary

Update a notary Updates notary information for the current user.

Parameters:

  • notary (optional parameter)

Returns:



434
435
436
437
 
# File 'lib/docusign_esign/api/notary_api.rb', line 434

def update_notary(notary)
  data, _status_code, _headers = update_notary_with_http_info( notary)
  return data
end

#update_notary_jurisdiction(jurisdiction_id, notary_jurisdiction) ⇒ NotaryJurisdiction

Update a notary jurisdiction Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The ‘jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body’s ‘jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: “` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Bob Notary", "county": "Adams", "sealType": "system_created" } “` If you want to change the name of the notary from "Bob Notary" to "Robert Notary", your request body would be: “` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Robert Notary", "county": "Adams", "sealType": "system_created" } “`

Parameters:

  • jurisdiction_id
  • notary_jurisdiction (optional parameter)

Returns:



482
483
484
485
 
# File 'lib/docusign_esign/api/notary_api.rb', line 482

def update_notary_jurisdiction(jurisdiction_id, notary_jurisdiction)
  data, _status_code, _headers = update_notary_jurisdiction_with_http_info(jurisdiction_id,  notary_jurisdiction)
  return data
end

#update_notary_jurisdiction_with_http_info(jurisdiction_id, notary_jurisdiction) ⇒ Array<(NotaryJurisdiction, Fixnum, Hash)>

Update a notary jurisdiction Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The &#x60;jurisdictionId&#x60; path parameter must be a jurisdiction that the notary is registered for. - The &#x60;jurisdictionId&#x60; path parameter must match the request body&#39;s &#x60;jurisdiction.jurisdictionId&#x60;. The request body must have a full &#x60;jurisdiction&#x60; object for the jurisdiction property. The best way to do this is to use &#x60;getNotaryJurisdiction&#x60; to obtain the current values and update the properties you want to change. For example, assume &#x60;getNotaryJurisdiction&#x60; returns this: &#x60;&#x60;&#x60; { &quot;jurisdiction&quot;: { &quot;jurisdictionId&quot;: &quot;15&quot;, &quot;name&quot;: &quot;Iowa&quot;, &quot;county&quot;: &quot;&quot;, &quot;enabled&quot;: &quot;true&quot;, &quot;countyInSeal&quot;: &quot;false&quot;, &quot;commissionIdInSeal&quot;: &quot;true&quot;, &quot;stateNameInSeal&quot;: &quot;true&quot;, &quot;notaryPublicInSeal&quot;: &quot;true&quot;, &quot;allowSystemCreatedSeal&quot;: &quot;true&quot;, &quot;allowUserUploadedSeal&quot;: &quot;false&quot; }, &quot;commissionId&quot;: &quot;123456&quot;, &quot;commissionExpiration&quot;: &quot;2020-08-31T07:00:00.0000000Z&quot;, &quot;registeredName&quot;: &quot;Bob Notary&quot;, &quot;county&quot;: &quot;Adams&quot;, &quot;sealType&quot;: &quot;system_created&quot; } &#x60;&#x60;&#x60; If you want to change the name of the notary from &quot;Bob Notary&quot; to &quot;Robert Notary&quot;, your request body would be: &#x60;&#x60;&#x60; { &quot;jurisdiction&quot;: { &quot;jurisdictionId&quot;: &quot;15&quot;, &quot;name&quot;: &quot;Iowa&quot;, &quot;county&quot;: &quot;&quot;, &quot;enabled&quot;: &quot;true&quot;, &quot;countyInSeal&quot;: &quot;false&quot;, &quot;commissionIdInSeal&quot;: &quot;true&quot;, &quot;stateNameInSeal&quot;: &quot;true&quot;, &quot;notaryPublicInSeal&quot;: &quot;true&quot;, &quot;allowSystemCreatedSeal&quot;: &quot;true&quot;, &quot;allowUserUploadedSeal&quot;: &quot;false&quot; }, &quot;commissionId&quot;: &quot;123456&quot;, &quot;commissionExpiration&quot;: &quot;2020-08-31T07:00:00.0000000Z&quot;, &quot;registeredName&quot;: &quot;Robert Notary&quot;, &quot;county&quot;: &quot;Adams&quot;, &quot;sealType&quot;: &quot;system_created&quot; } &#x60;&#x60;&#x60;

Parameters:

  • jurisdiction_id
  • notary_jurisdiction (optional parameter)

Returns:

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

    NotaryJurisdiction data, response status code and response headers



492
493
494
495
496
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
 
# File 'lib/docusign_esign/api/notary_api.rb', line 492

def update_notary_jurisdiction_with_http_info(jurisdiction_id, notary_jurisdiction)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.update_notary_jurisdiction ..."
  end
  # verify the required parameter 'jurisdiction_id' is set
  fail ArgumentError, "Missing the required parameter 'jurisdiction_id' when calling NotaryApi.update_notary_jurisdiction" if jurisdiction_id.nil?
  # resource path
  local_var_path = "/v2.1/current_user/notary/jurisdictions/{jurisdictionId}".sub('{format}','json').sub('{' + 'jurisdictionId' + '}', jurisdiction_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(notary_jurisdiction)
  auth_names = []
  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 => 'NotaryJurisdiction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#update_notary_jurisdiction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_notary_with_http_info(notary) ⇒ Array<(Notary, Fixnum, Hash)>

Update a notary Updates notary information for the current user.

Parameters:

  • notary (optional parameter)

Returns:

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

    Notary data, response status code and response headers



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
 
# File 'lib/docusign_esign/api/notary_api.rb', line 443

def update_notary_with_http_info(notary)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.update_notary ..."
  end
  # resource path
  local_var_path = "/v2.1/current_user/notary".sub('{format}','json')

  # 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(notary)
  auth_names = []
  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 => 'Notary')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#update_notary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end