docspring 4.4.0 → 4.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.openapi-generator/FILES +6 -0
- data/AGENTS.md +2 -0
- data/CHANGELOG.md +15 -0
- data/Gemfile.lock +10 -10
- data/LICENSE +1 -1
- data/README.md +4 -1
- data/docs/Client.md +98 -96
- data/docs/CreateSubmissionRequest.md +3 -3
- data/docs/CreateTemplateRequest.md +11 -3
- data/docs/ErrorInfo.md +7 -3
- data/docs/HtmlEngineOptions.md +4 -4
- data/docs/HtmlEngineOptionsInput.md +4 -4
- data/docs/SubmissionInput.md +1 -1
- data/docs/Template.md +10 -2
- data/docs/TemplateFormSection.md +24 -0
- data/docs/TemplateFormSectionInput.md +24 -0
- data/docs/UpdateTemplateRequest.md +10 -2
- data/docs/ValidateSubmissionRequest.md +3 -3
- data/lib/docspring/api/client.rb +99 -96
- data/lib/docspring/api_client.rb +1 -1
- data/lib/docspring/models/create_submission_request.rb +3 -3
- data/lib/docspring/models/create_template_request.rb +48 -6
- data/lib/docspring/models/error_info.rb +26 -6
- data/lib/docspring/models/html_engine_options.rb +4 -4
- data/lib/docspring/models/html_engine_options_input.rb +4 -4
- data/lib/docspring/models/submission_input.rb +1 -1
- data/lib/docspring/models/template.rb +85 -3
- data/lib/docspring/models/template_form_section.rb +254 -0
- data/lib/docspring/models/template_form_section_input.rb +252 -0
- data/lib/docspring/models/update_template_request.rb +47 -3
- data/lib/docspring/models/validate_submission_request.rb +3 -3
- data/lib/docspring/request_schemas.json +84 -10
- data/lib/docspring/version.rb +1 -1
- data/lib/docspring.rb +2 -0
- data/spec/api/client_spec.rb +49 -48
- data/spec/models/create_template_request_spec.rb +24 -0
- data/spec/models/error_info_spec.rb +12 -0
- data/spec/models/template_form_section_input_spec.rb +54 -0
- data/spec/models/template_form_section_spec.rb +54 -0
- data/spec/models/template_spec.rb +24 -0
- data/spec/models/update_template_request_spec.rb +24 -0
- metadata +9 -1
data/lib/docspring/api/client.rb
CHANGED
|
@@ -71,7 +71,7 @@ end
|
|
|
71
71
|
# @param template_id [String] The template's ID.
|
|
72
72
|
# @param body [AddTemplateFieldsRequest] The fields to add to the template's draft.
|
|
73
73
|
# @param [Hash] opts the optional parameters
|
|
74
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
74
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
75
75
|
# @return [TemplateFields]
|
|
76
76
|
def add_template_fields(template_id, body, opts = {})
|
|
77
77
|
data, _status_code, _headers = add_template_fields_with_http_info(template_id, body, opts)
|
|
@@ -83,7 +83,7 @@ end
|
|
|
83
83
|
# @param template_id [String] The template's ID.
|
|
84
84
|
# @param body [AddTemplateFieldsRequest] The fields to add to the template's draft.
|
|
85
85
|
# @param [Hash] opts the optional parameters
|
|
86
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
86
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
87
87
|
# @return [Array<(TemplateFields, Integer, Hash)>] TemplateFields data, response status code and response headers
|
|
88
88
|
def add_template_fields_with_http_info(template_id, body, opts = {})
|
|
89
89
|
if @api_client.config.debugging
|
|
@@ -148,7 +148,7 @@ end
|
|
|
148
148
|
# @param template_id [String] The template's ID.
|
|
149
149
|
# @param [Hash] opts the optional parameters
|
|
150
150
|
# @option opts [CopyTemplateRequest] :body Settings for the copy.
|
|
151
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
151
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
152
152
|
# @return [Template]
|
|
153
153
|
def copy_template(template_id, opts = {})
|
|
154
154
|
data, _status_code, _headers = copy_template_with_http_info(template_id, opts)
|
|
@@ -160,7 +160,7 @@ end
|
|
|
160
160
|
# @param template_id [String] The template's ID.
|
|
161
161
|
# @param [Hash] opts the optional parameters
|
|
162
162
|
# @option opts [CopyTemplateRequest] :body Settings for the copy.
|
|
163
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
163
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
164
164
|
# @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
|
|
165
165
|
def copy_template_with_http_info(template_id, opts = {})
|
|
166
166
|
if @api_client.config.debugging
|
|
@@ -220,7 +220,7 @@ end
|
|
|
220
220
|
# Adds an email action to your account. It sends for every template, or only for the templates in `template_ids` and the templates in the folders in `folder_ids` (and the folders inside them). Each template can turn it off or change its settings for that template only (`PUT /templates/{template_id}/email_actions/{email_action_id}/customization`). Without a paid plan (Starter or higher), email actions only email your team: test submissions' emails go to your account's users, and live submissions' emails aren't sent.
|
|
221
221
|
# @param body [CreateAccountEmailActionRequest] The account email action to create. Properties left out get their defaults, and it sends for every template unless it lists `template_ids` or `folder_ids`.
|
|
222
222
|
# @param [Hash] opts the optional parameters
|
|
223
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
223
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
224
224
|
# @return [EmailAction]
|
|
225
225
|
def create_account_email_action(body, opts = {})
|
|
226
226
|
data, _status_code, _headers = create_account_email_action_with_http_info(body, opts)
|
|
@@ -231,7 +231,7 @@ end
|
|
|
231
231
|
# Adds an email action to your account. It sends for every template, or only for the templates in `template_ids` and the templates in the folders in `folder_ids` (and the folders inside them). Each template can turn it off or change its settings for that template only (`PUT /templates/{template_id}/email_actions/{email_action_id}/customization`). Without a paid plan (Starter or higher), email actions only email your team: test submissions' emails go to your account's users, and live submissions' emails aren't sent.
|
|
232
232
|
# @param body [CreateAccountEmailActionRequest] The account email action to create. Properties left out get their defaults, and it sends for every template unless it lists `template_ids` or `folder_ids`.
|
|
233
233
|
# @param [Hash] opts the optional parameters
|
|
234
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
234
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
235
235
|
# @return [Array<(EmailAction, Integer, Hash)>] EmailAction data, response status code and response headers
|
|
236
236
|
def create_account_email_action_with_http_info(body, opts = {})
|
|
237
237
|
if @api_client.config.debugging
|
|
@@ -292,7 +292,7 @@ end
|
|
|
292
292
|
# @param body [CreateCombinedPdfRequest] The PDFs to merge, and the combined PDF's settings.
|
|
293
293
|
# @param [Hash] opts the optional parameters
|
|
294
294
|
# @option opts [Boolean] :wait Wait until the PDF has been generated before responding. Default true on sync.api hosts.
|
|
295
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
295
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
296
296
|
# @return [CombinedPdf]
|
|
297
297
|
def create_combined_pdf(body, opts = {})
|
|
298
298
|
data, _status_code, _headers = create_combined_pdf_with_http_info(body, opts)
|
|
@@ -304,7 +304,7 @@ end
|
|
|
304
304
|
# @param body [CreateCombinedPdfRequest] The PDFs to merge, and the combined PDF's settings.
|
|
305
305
|
# @param [Hash] opts the optional parameters
|
|
306
306
|
# @option opts [Boolean] :wait Wait until the PDF has been generated before responding. Default true on sync.api hosts.
|
|
307
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
307
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
308
308
|
# @return [Array<(CombinedPdf, Integer, Hash)>] CombinedPdf data, response status code and response headers
|
|
309
309
|
def create_combined_pdf_with_http_info(body, opts = {})
|
|
310
310
|
if @api_client.config.debugging
|
|
@@ -365,7 +365,7 @@ end
|
|
|
365
365
|
# Creates a custom file from a PDF you uploaded, so you can merge it with other PDFs. Upload the file with the presigned upload (GET /uploads/presign) first, then pass its `fields.key` as `cache_id`.
|
|
366
366
|
# @param body [CreateCustomFileFromUploadRequest] The uploaded file to create the custom file from.
|
|
367
367
|
# @param [Hash] opts the optional parameters
|
|
368
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
368
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
369
369
|
# @return [CustomFile]
|
|
370
370
|
def create_custom_file_from_upload(body, opts = {})
|
|
371
371
|
data, _status_code, _headers = create_custom_file_from_upload_with_http_info(body, opts)
|
|
@@ -376,7 +376,7 @@ end
|
|
|
376
376
|
# Creates a custom file from a PDF you uploaded, so you can merge it with other PDFs. Upload the file with the presigned upload (GET /uploads/presign) first, then pass its `fields.key` as `cache_id`.
|
|
377
377
|
# @param body [CreateCustomFileFromUploadRequest] The uploaded file to create the custom file from.
|
|
378
378
|
# @param [Hash] opts the optional parameters
|
|
379
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
379
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
380
380
|
# @return [Array<(CustomFile, Integer, Hash)>] CustomFile data, response status code and response headers
|
|
381
381
|
def create_custom_file_from_upload_with_http_info(body, opts = {})
|
|
382
382
|
if @api_client.config.debugging
|
|
@@ -437,7 +437,7 @@ end
|
|
|
437
437
|
# @param template_id [String] The template's ID.
|
|
438
438
|
# @param body [CreateEmailActionRequest] The email action to create. Properties left out get their defaults.
|
|
439
439
|
# @param [Hash] opts the optional parameters
|
|
440
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
440
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
441
441
|
# @return [EmailAction]
|
|
442
442
|
def create_email_action(template_id, body, opts = {})
|
|
443
443
|
data, _status_code, _headers = create_email_action_with_http_info(template_id, body, opts)
|
|
@@ -449,7 +449,7 @@ end
|
|
|
449
449
|
# @param template_id [String] The template's ID.
|
|
450
450
|
# @param body [CreateEmailActionRequest] The email action to create. Properties left out get their defaults.
|
|
451
451
|
# @param [Hash] opts the optional parameters
|
|
452
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
452
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
453
453
|
# @return [Array<(EmailAction, Integer, Hash)>] EmailAction data, response status code and response headers
|
|
454
454
|
def create_email_action_with_http_info(template_id, body, opts = {})
|
|
455
455
|
if @api_client.config.debugging
|
|
@@ -513,7 +513,7 @@ end
|
|
|
513
513
|
# Adds a domain for email actions to send from, and returns the DNS records to add to it. DocSpring checks for them every few minutes, and the domain is verified once its DKIM and DMARC records are found. Needs a paid monthly plan.
|
|
514
514
|
# @param body [CreateEmailDomainRequest] The domain to add.
|
|
515
515
|
# @param [Hash] opts the optional parameters
|
|
516
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
516
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
517
517
|
# @return [EmailDomain]
|
|
518
518
|
def create_email_domain(body, opts = {})
|
|
519
519
|
data, _status_code, _headers = create_email_domain_with_http_info(body, opts)
|
|
@@ -524,7 +524,7 @@ end
|
|
|
524
524
|
# Adds a domain for email actions to send from, and returns the DNS records to add to it. DocSpring checks for them every few minutes, and the domain is verified once its DKIM and DMARC records are found. Needs a paid monthly plan.
|
|
525
525
|
# @param body [CreateEmailDomainRequest] The domain to add.
|
|
526
526
|
# @param [Hash] opts the optional parameters
|
|
527
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
527
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
528
528
|
# @return [Array<(EmailDomain, Integer, Hash)>] EmailDomain data, response status code and response headers
|
|
529
529
|
def create_email_domain_with_http_info(body, opts = {})
|
|
530
530
|
if @api_client.config.debugging
|
|
@@ -584,7 +584,7 @@ end
|
|
|
584
584
|
# Creates a folder for organizing templates. Pass `parent_folder_id` to create it inside another folder. Folder names are unique within their parent folder.
|
|
585
585
|
# @param body [CreateFolderRequest] The folder to create.
|
|
586
586
|
# @param [Hash] opts the optional parameters
|
|
587
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
587
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
588
588
|
# @return [Folder]
|
|
589
589
|
def create_folder(body, opts = {})
|
|
590
590
|
data, _status_code, _headers = create_folder_with_http_info(body, opts)
|
|
@@ -595,7 +595,7 @@ end
|
|
|
595
595
|
# Creates a folder for organizing templates. Pass `parent_folder_id` to create it inside another folder. Folder names are unique within their parent folder.
|
|
596
596
|
# @param body [CreateFolderRequest] The folder to create.
|
|
597
597
|
# @param [Hash] opts the optional parameters
|
|
598
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
598
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
599
599
|
# @return [Array<(Folder, Integer, Hash)>] Folder data, response status code and response headers
|
|
600
600
|
def create_folder_with_http_info(body, opts = {})
|
|
601
601
|
if @api_client.config.debugging
|
|
@@ -656,7 +656,7 @@ end
|
|
|
656
656
|
# @param signature_request_id [String] The signature request's ID.
|
|
657
657
|
# @param body [CreateSignatureRequestEventRequest] The event to record.
|
|
658
658
|
# @param [Hash] opts the optional parameters
|
|
659
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
659
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
660
660
|
# @return [SignatureRequestEvent]
|
|
661
661
|
def create_signature_request_event(signature_request_id, body, opts = {})
|
|
662
662
|
data, _status_code, _headers = create_signature_request_event_with_http_info(signature_request_id, body, opts)
|
|
@@ -668,7 +668,7 @@ end
|
|
|
668
668
|
# @param signature_request_id [String] The signature request's ID.
|
|
669
669
|
# @param body [CreateSignatureRequestEventRequest] The event to record.
|
|
670
670
|
# @param [Hash] opts the optional parameters
|
|
671
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
671
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
672
672
|
# @return [Array<(SignatureRequestEvent, Integer, Hash)>] SignatureRequestEvent data, response status code and response headers
|
|
673
673
|
def create_signature_request_event_with_http_info(signature_request_id, body, opts = {})
|
|
674
674
|
if @api_client.config.debugging
|
|
@@ -733,7 +733,7 @@ end
|
|
|
733
733
|
# @param signature_request_id [String] The signature request's ID.
|
|
734
734
|
# @param [Hash] opts the optional parameters
|
|
735
735
|
# @option opts [CreateSignatureRequestTokenRequest] :body The kind of link to make. Send no body for an `api` token.
|
|
736
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
736
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
737
737
|
# @return [SignatureRequestToken]
|
|
738
738
|
def create_signature_request_token(signature_request_id, opts = {})
|
|
739
739
|
data, _status_code, _headers = create_signature_request_token_with_http_info(signature_request_id, opts)
|
|
@@ -745,7 +745,7 @@ end
|
|
|
745
745
|
# @param signature_request_id [String] The signature request's ID.
|
|
746
746
|
# @param [Hash] opts the optional parameters
|
|
747
747
|
# @option opts [CreateSignatureRequestTokenRequest] :body The kind of link to make. Send no body for an `api` token.
|
|
748
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
748
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
749
749
|
# @return [Array<(SignatureRequestToken, Integer, Hash)>] SignatureRequestToken data, response status code and response headers
|
|
750
750
|
def create_signature_request_token_with_http_info(signature_request_id, opts = {})
|
|
751
751
|
if @api_client.config.debugging
|
|
@@ -808,7 +808,7 @@ end
|
|
|
808
808
|
# @param [Hash] opts the optional parameters
|
|
809
809
|
# @option opts [String] :version The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` (the newest published version, or the draft when none has been published) or `draft`. Default `latest`.
|
|
810
810
|
# @option opts [Boolean] :wait Wait until the files have been generated before responding. Default true on sync.api hosts.
|
|
811
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
811
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
812
812
|
# @return [Submission]
|
|
813
813
|
def create_submission(template_id, body, opts = {})
|
|
814
814
|
data, _status_code, _headers = create_submission_with_http_info(template_id, body, opts)
|
|
@@ -822,7 +822,7 @@ end
|
|
|
822
822
|
# @param [Hash] opts the optional parameters
|
|
823
823
|
# @option opts [String] :version The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` (the newest published version, or the draft when none has been published) or `draft`. Default `latest`.
|
|
824
824
|
# @option opts [Boolean] :wait Wait until the files have been generated before responding. Default true on sync.api hosts.
|
|
825
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
825
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
826
826
|
# @return [Array<(Submission, Integer, Hash)>] Submission data, response status code and response headers
|
|
827
827
|
def create_submission_with_http_info(template_id, body, opts = {})
|
|
828
828
|
if @api_client.config.debugging
|
|
@@ -889,7 +889,7 @@ end
|
|
|
889
889
|
# @param body [CreateSubmissionBatchRequest] The submissions to create, and the settings they share.
|
|
890
890
|
# @param [Hash] opts the optional parameters
|
|
891
891
|
# @option opts [Boolean] :wait Wait until every file in the batch has been generated before responding. Default true on sync.api hosts.
|
|
892
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
892
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
893
893
|
# @return [SubmissionBatch]
|
|
894
894
|
def create_submission_batch(body, opts = {})
|
|
895
895
|
data, _status_code, _headers = create_submission_batch_with_http_info(body, opts)
|
|
@@ -901,7 +901,7 @@ end
|
|
|
901
901
|
# @param body [CreateSubmissionBatchRequest] The submissions to create, and the settings they share.
|
|
902
902
|
# @param [Hash] opts the optional parameters
|
|
903
903
|
# @option opts [Boolean] :wait Wait until every file in the batch has been generated before responding. Default true on sync.api hosts.
|
|
904
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
904
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
905
905
|
# @return [Array<(SubmissionBatch, Integer, Hash)>] SubmissionBatch data, response status code and response headers
|
|
906
906
|
def create_submission_batch_with_http_info(body, opts = {})
|
|
907
907
|
if @api_client.config.debugging
|
|
@@ -963,7 +963,7 @@ end
|
|
|
963
963
|
# @param body [CreateTemplateRequest] The template to create.
|
|
964
964
|
# @param [Hash] opts the optional parameters
|
|
965
965
|
# @option opts [Boolean] :wait Wait until the PDF has been processed, a `document_url`'s PDF or Word document downloaded, and an OpenDocument file converted, before responding. Default true on sync.api hosts.
|
|
966
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
966
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
967
967
|
# @return [Template]
|
|
968
968
|
def create_template(body, opts = {})
|
|
969
969
|
data, _status_code, _headers = create_template_with_http_info(body, opts)
|
|
@@ -975,7 +975,7 @@ end
|
|
|
975
975
|
# @param body [CreateTemplateRequest] The template to create.
|
|
976
976
|
# @param [Hash] opts the optional parameters
|
|
977
977
|
# @option opts [Boolean] :wait Wait until the PDF has been processed, a `document_url`'s PDF or Word document downloaded, and an OpenDocument file converted, before responding. Default true on sync.api hosts.
|
|
978
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
978
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
979
979
|
# @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
|
|
980
980
|
def create_template_with_http_info(body, opts = {})
|
|
981
981
|
if @api_client.config.debugging
|
|
@@ -1038,7 +1038,7 @@ end
|
|
|
1038
1038
|
# @param body [CreateTemplatePreviewRequest] The data to render the template with.
|
|
1039
1039
|
# @param [Hash] opts the optional parameters
|
|
1040
1040
|
# @option opts [String] :version A published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` (the newest published version, or the draft when none has been published) or `draft`. Default `draft`.
|
|
1041
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1041
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1042
1042
|
# @return [TemplatePreview]
|
|
1043
1043
|
def create_template_preview(template_id, body, opts = {})
|
|
1044
1044
|
data, _status_code, _headers = create_template_preview_with_http_info(template_id, body, opts)
|
|
@@ -1051,7 +1051,7 @@ end
|
|
|
1051
1051
|
# @param body [CreateTemplatePreviewRequest] The data to render the template with.
|
|
1052
1052
|
# @param [Hash] opts the optional parameters
|
|
1053
1053
|
# @option opts [String] :version A published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` (the newest published version, or the draft when none has been published) or `draft`. Default `draft`.
|
|
1054
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1054
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1055
1055
|
# @return [Array<(TemplatePreview, Integer, Hash)>] TemplatePreview data, response status code and response headers
|
|
1056
1056
|
def create_template_preview_with_http_info(template_id, body, opts = {})
|
|
1057
1057
|
if @api_client.config.debugging
|
|
@@ -1116,7 +1116,7 @@ end
|
|
|
1116
1116
|
# Creates a webhook that sends a POST request to your endpoint whenever a subscribed event happens. Scope it to API tokens, templates or folders to receive only their events.
|
|
1117
1117
|
# @param body [CreateWebhookRequest] The webhook to create.
|
|
1118
1118
|
# @param [Hash] opts the optional parameters
|
|
1119
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1119
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1120
1120
|
# @return [Webhook]
|
|
1121
1121
|
def create_webhook(body, opts = {})
|
|
1122
1122
|
data, _status_code, _headers = create_webhook_with_http_info(body, opts)
|
|
@@ -1127,7 +1127,7 @@ end
|
|
|
1127
1127
|
# Creates a webhook that sends a POST request to your endpoint whenever a subscribed event happens. Scope it to API tokens, templates or folders to receive only their events.
|
|
1128
1128
|
# @param body [CreateWebhookRequest] The webhook to create.
|
|
1129
1129
|
# @param [Hash] opts the optional parameters
|
|
1130
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1130
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1131
1131
|
# @return [Array<(Webhook, Integer, Hash)>] Webhook data, response status code and response headers
|
|
1132
1132
|
def create_webhook_with_http_info(body, opts = {})
|
|
1133
1133
|
if @api_client.config.debugging
|
|
@@ -1187,7 +1187,7 @@ end
|
|
|
1187
1187
|
# Deletes one of your account's email actions, with every template's customization of it. Emails it has already queued for submissions aren't sent. Submissions keep the record of the emails it sent.
|
|
1188
1188
|
# @param email_action_id [String] The account email action's ID.
|
|
1189
1189
|
# @param [Hash] opts the optional parameters
|
|
1190
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1190
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1191
1191
|
# @return [EmailAction]
|
|
1192
1192
|
def delete_account_email_action(email_action_id, opts = {})
|
|
1193
1193
|
data, _status_code, _headers = delete_account_email_action_with_http_info(email_action_id, opts)
|
|
@@ -1198,7 +1198,7 @@ end
|
|
|
1198
1198
|
# Deletes one of your account's email actions, with every template's customization of it. Emails it has already queued for submissions aren't sent. Submissions keep the record of the emails it sent.
|
|
1199
1199
|
# @param email_action_id [String] The account email action's ID.
|
|
1200
1200
|
# @param [Hash] opts the optional parameters
|
|
1201
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1201
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1202
1202
|
# @return [Array<(EmailAction, Integer, Hash)>] EmailAction data, response status code and response headers
|
|
1203
1203
|
def delete_account_email_action_with_http_info(email_action_id, opts = {})
|
|
1204
1204
|
if @api_client.config.debugging
|
|
@@ -1253,7 +1253,7 @@ end
|
|
|
1253
1253
|
# Deletes a custom file and returns it. Use a live API token: test tokens can't delete custom files.
|
|
1254
1254
|
# @param custom_file_id [String] The custom file's ID.
|
|
1255
1255
|
# @param [Hash] opts the optional parameters
|
|
1256
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1256
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1257
1257
|
# @return [CustomFile]
|
|
1258
1258
|
def delete_custom_file(custom_file_id, opts = {})
|
|
1259
1259
|
data, _status_code, _headers = delete_custom_file_with_http_info(custom_file_id, opts)
|
|
@@ -1264,7 +1264,7 @@ end
|
|
|
1264
1264
|
# Deletes a custom file and returns it. Use a live API token: test tokens can't delete custom files.
|
|
1265
1265
|
# @param custom_file_id [String] The custom file's ID.
|
|
1266
1266
|
# @param [Hash] opts the optional parameters
|
|
1267
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1267
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1268
1268
|
# @return [Array<(CustomFile, Integer, Hash)>] CustomFile data, response status code and response headers
|
|
1269
1269
|
def delete_custom_file_with_http_info(custom_file_id, opts = {})
|
|
1270
1270
|
if @api_client.config.debugging
|
|
@@ -1320,7 +1320,7 @@ end
|
|
|
1320
1320
|
# @param template_id [String] The template's ID.
|
|
1321
1321
|
# @param email_action_id [String] The email action's ID.
|
|
1322
1322
|
# @param [Hash] opts the optional parameters
|
|
1323
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1323
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1324
1324
|
# @return [EmailAction]
|
|
1325
1325
|
def delete_email_action(template_id, email_action_id, opts = {})
|
|
1326
1326
|
data, _status_code, _headers = delete_email_action_with_http_info(template_id, email_action_id, opts)
|
|
@@ -1332,7 +1332,7 @@ end
|
|
|
1332
1332
|
# @param template_id [String] The template's ID.
|
|
1333
1333
|
# @param email_action_id [String] The email action's ID.
|
|
1334
1334
|
# @param [Hash] opts the optional parameters
|
|
1335
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1335
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1336
1336
|
# @return [Array<(EmailAction, Integer, Hash)>] EmailAction data, response status code and response headers
|
|
1337
1337
|
def delete_email_action_with_http_info(template_id, email_action_id, opts = {})
|
|
1338
1338
|
if @api_client.config.debugging
|
|
@@ -1392,7 +1392,7 @@ end
|
|
|
1392
1392
|
# @param template_id [String] The template's ID.
|
|
1393
1393
|
# @param email_action_id [String] The ID of one of your account's email actions that sends for the template.
|
|
1394
1394
|
# @param [Hash] opts the optional parameters
|
|
1395
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1395
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1396
1396
|
# @return [EmailAction]
|
|
1397
1397
|
def delete_email_action_customization(template_id, email_action_id, opts = {})
|
|
1398
1398
|
data, _status_code, _headers = delete_email_action_customization_with_http_info(template_id, email_action_id, opts)
|
|
@@ -1404,7 +1404,7 @@ end
|
|
|
1404
1404
|
# @param template_id [String] The template's ID.
|
|
1405
1405
|
# @param email_action_id [String] The ID of one of your account's email actions that sends for the template.
|
|
1406
1406
|
# @param [Hash] opts the optional parameters
|
|
1407
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1407
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1408
1408
|
# @return [Array<(EmailAction, Integer, Hash)>] EmailAction data, response status code and response headers
|
|
1409
1409
|
def delete_email_action_customization_with_http_info(template_id, email_action_id, opts = {})
|
|
1410
1410
|
if @api_client.config.debugging
|
|
@@ -1463,7 +1463,7 @@ end
|
|
|
1463
1463
|
# Removes an email domain. Email actions that send from an address at it fail until you add and verify it again, or change their `from_address`. You can then remove its DNS records.
|
|
1464
1464
|
# @param email_domain_id [String] The email domain's ID.
|
|
1465
1465
|
# @param [Hash] opts the optional parameters
|
|
1466
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1466
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1467
1467
|
# @return [EmailDomain]
|
|
1468
1468
|
def delete_email_domain(email_domain_id, opts = {})
|
|
1469
1469
|
data, _status_code, _headers = delete_email_domain_with_http_info(email_domain_id, opts)
|
|
@@ -1474,7 +1474,7 @@ end
|
|
|
1474
1474
|
# Removes an email domain. Email actions that send from an address at it fail until you add and verify it again, or change their `from_address`. You can then remove its DNS records.
|
|
1475
1475
|
# @param email_domain_id [String] The email domain's ID.
|
|
1476
1476
|
# @param [Hash] opts the optional parameters
|
|
1477
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1477
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1478
1478
|
# @return [Array<(EmailDomain, Integer, Hash)>] EmailDomain data, response status code and response headers
|
|
1479
1479
|
def delete_email_domain_with_http_info(email_domain_id, opts = {})
|
|
1480
1480
|
if @api_client.config.debugging
|
|
@@ -1529,7 +1529,7 @@ end
|
|
|
1529
1529
|
# Deletes an empty folder and returns it. A folder that still has templates or folders in it can't be deleted.
|
|
1530
1530
|
# @param folder_id [String] The folder's ID.
|
|
1531
1531
|
# @param [Hash] opts the optional parameters
|
|
1532
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1532
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1533
1533
|
# @return [Folder]
|
|
1534
1534
|
def delete_folder(folder_id, opts = {})
|
|
1535
1535
|
data, _status_code, _headers = delete_folder_with_http_info(folder_id, opts)
|
|
@@ -1540,7 +1540,7 @@ end
|
|
|
1540
1540
|
# Deletes an empty folder and returns it. A folder that still has templates or folders in it can't be deleted.
|
|
1541
1541
|
# @param folder_id [String] The folder's ID.
|
|
1542
1542
|
# @param [Hash] opts the optional parameters
|
|
1543
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1543
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1544
1544
|
# @return [Array<(Folder, Integer, Hash)>] Folder data, response status code and response headers
|
|
1545
1545
|
def delete_folder_with_http_info(folder_id, opts = {})
|
|
1546
1546
|
if @api_client.config.debugging
|
|
@@ -1596,7 +1596,7 @@ end
|
|
|
1596
1596
|
# @param template_id [String] The template's ID.
|
|
1597
1597
|
# @param [Hash] opts the optional parameters
|
|
1598
1598
|
# @option opts [String] :version Delete only this published version (`1.2.0`) or the draft (`draft`, when no version has been published). Without it, the draft and every published version are deleted.
|
|
1599
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1599
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1600
1600
|
# @return [Template]
|
|
1601
1601
|
def delete_template(template_id, opts = {})
|
|
1602
1602
|
data, _status_code, _headers = delete_template_with_http_info(template_id, opts)
|
|
@@ -1608,7 +1608,7 @@ end
|
|
|
1608
1608
|
# @param template_id [String] The template's ID.
|
|
1609
1609
|
# @param [Hash] opts the optional parameters
|
|
1610
1610
|
# @option opts [String] :version Delete only this published version (`1.2.0`) or the draft (`draft`, when no version has been published). Without it, the draft and every published version are deleted.
|
|
1611
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1611
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1612
1612
|
# @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
|
|
1613
1613
|
def delete_template_with_http_info(template_id, opts = {})
|
|
1614
1614
|
if @api_client.config.debugging
|
|
@@ -1664,7 +1664,7 @@ end
|
|
|
1664
1664
|
# Deletes a webhook so it stops receiving events, and returns it.
|
|
1665
1665
|
# @param webhook_id [String] The webhook's ID.
|
|
1666
1666
|
# @param [Hash] opts the optional parameters
|
|
1667
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1667
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1668
1668
|
# @return [Webhook]
|
|
1669
1669
|
def delete_webhook(webhook_id, opts = {})
|
|
1670
1670
|
data, _status_code, _headers = delete_webhook_with_http_info(webhook_id, opts)
|
|
@@ -1675,7 +1675,7 @@ end
|
|
|
1675
1675
|
# Deletes a webhook so it stops receiving events, and returns it.
|
|
1676
1676
|
# @param webhook_id [String] The webhook's ID.
|
|
1677
1677
|
# @param [Hash] opts the optional parameters
|
|
1678
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1678
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1679
1679
|
# @return [Array<(Webhook, Integer, Hash)>] Webhook data, response status code and response headers
|
|
1680
1680
|
def delete_webhook_with_http_info(webhook_id, opts = {})
|
|
1681
1681
|
if @api_client.config.debugging
|
|
@@ -1730,7 +1730,7 @@ end
|
|
|
1730
1730
|
# Deletes a combined PDF's PDF and returns the expired combined PDF.
|
|
1731
1731
|
# @param combined_pdf_id [String] The combined PDF's ID.
|
|
1732
1732
|
# @param [Hash] opts the optional parameters
|
|
1733
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1733
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1734
1734
|
# @return [CombinedPdf]
|
|
1735
1735
|
def expire_combined_pdf(combined_pdf_id, opts = {})
|
|
1736
1736
|
data, _status_code, _headers = expire_combined_pdf_with_http_info(combined_pdf_id, opts)
|
|
@@ -1741,7 +1741,7 @@ end
|
|
|
1741
1741
|
# Deletes a combined PDF's PDF and returns the expired combined PDF.
|
|
1742
1742
|
# @param combined_pdf_id [String] The combined PDF's ID.
|
|
1743
1743
|
# @param [Hash] opts the optional parameters
|
|
1744
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1744
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1745
1745
|
# @return [Array<(CombinedPdf, Integer, Hash)>] CombinedPdf data, response status code and response headers
|
|
1746
1746
|
def expire_combined_pdf_with_http_info(combined_pdf_id, opts = {})
|
|
1747
1747
|
if @api_client.config.debugging
|
|
@@ -1796,7 +1796,7 @@ end
|
|
|
1796
1796
|
# Deletes a submission's data and PDF now, and returns the expired submission.
|
|
1797
1797
|
# @param submission_id [String] The submission's ID.
|
|
1798
1798
|
# @param [Hash] opts the optional parameters
|
|
1799
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1799
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1800
1800
|
# @return [Submission]
|
|
1801
1801
|
def expire_submission(submission_id, opts = {})
|
|
1802
1802
|
data, _status_code, _headers = expire_submission_with_http_info(submission_id, opts)
|
|
@@ -1807,7 +1807,7 @@ end
|
|
|
1807
1807
|
# Deletes a submission's data and PDF now, and returns the expired submission.
|
|
1808
1808
|
# @param submission_id [String] The submission's ID.
|
|
1809
1809
|
# @param [Hash] opts the optional parameters
|
|
1810
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1810
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1811
1811
|
# @return [Array<(Submission, Integer, Hash)>] Submission data, response status code and response headers
|
|
1812
1812
|
def expire_submission_with_http_info(submission_id, opts = {})
|
|
1813
1813
|
if @api_client.config.debugging
|
|
@@ -1864,7 +1864,7 @@ end
|
|
|
1864
1864
|
# @param body [GenerateSubmissionFilesRequest] The formats to make.
|
|
1865
1865
|
# @param [Hash] opts the optional parameters
|
|
1866
1866
|
# @option opts [Boolean] :wait Wait until the files have been generated before responding. Default true on sync.api hosts.
|
|
1867
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1867
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1868
1868
|
# @return [Submission]
|
|
1869
1869
|
def generate_submission_files(submission_id, body, opts = {})
|
|
1870
1870
|
data, _status_code, _headers = generate_submission_files_with_http_info(submission_id, body, opts)
|
|
@@ -1877,7 +1877,7 @@ end
|
|
|
1877
1877
|
# @param body [GenerateSubmissionFilesRequest] The formats to make.
|
|
1878
1878
|
# @param [Hash] opts the optional parameters
|
|
1879
1879
|
# @option opts [Boolean] :wait Wait until the files have been generated before responding. Default true on sync.api hosts.
|
|
1880
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1880
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1881
1881
|
# @return [Array<(Submission, Integer, Hash)>] Submission data, response status code and response headers
|
|
1882
1882
|
def generate_submission_files_with_http_info(submission_id, body, opts = {})
|
|
1883
1883
|
if @api_client.config.debugging
|
|
@@ -1942,7 +1942,7 @@ end
|
|
|
1942
1942
|
# Generates a preview of a submission's PDF in the background, such as for a submission still waiting for its signature requests. It's in `files.preview` once `preview_generated_at` changes.
|
|
1943
1943
|
# @param submission_id [String] The submission's ID.
|
|
1944
1944
|
# @param [Hash] opts the optional parameters
|
|
1945
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1945
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1946
1946
|
# @return [Submission]
|
|
1947
1947
|
def generate_submission_preview(submission_id, opts = {})
|
|
1948
1948
|
data, _status_code, _headers = generate_submission_preview_with_http_info(submission_id, opts)
|
|
@@ -1953,7 +1953,7 @@ end
|
|
|
1953
1953
|
# Generates a preview of a submission's PDF in the background, such as for a submission still waiting for its signature requests. It's in `files.preview` once `preview_generated_at` changes.
|
|
1954
1954
|
# @param submission_id [String] The submission's ID.
|
|
1955
1955
|
# @param [Hash] opts the optional parameters
|
|
1956
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
1956
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
1957
1957
|
# @return [Array<(Submission, Integer, Hash)>] Submission data, response status code and response headers
|
|
1958
1958
|
def generate_submission_preview_with_http_info(submission_id, opts = {})
|
|
1959
1959
|
if @api_client.config.debugging
|
|
@@ -3885,7 +3885,7 @@ end
|
|
|
3885
3885
|
# @param folder_id [String] The folder's ID.
|
|
3886
3886
|
# @param body [MoveFolderRequest] Where to move the folder.
|
|
3887
3887
|
# @param [Hash] opts the optional parameters
|
|
3888
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
3888
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
3889
3889
|
# @return [Folder]
|
|
3890
3890
|
def move_folder(folder_id, body, opts = {})
|
|
3891
3891
|
data, _status_code, _headers = move_folder_with_http_info(folder_id, body, opts)
|
|
@@ -3897,7 +3897,7 @@ end
|
|
|
3897
3897
|
# @param folder_id [String] The folder's ID.
|
|
3898
3898
|
# @param body [MoveFolderRequest] Where to move the folder.
|
|
3899
3899
|
# @param [Hash] opts the optional parameters
|
|
3900
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
3900
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
3901
3901
|
# @return [Array<(Folder, Integer, Hash)>] Folder data, response status code and response headers
|
|
3902
3902
|
def move_folder_with_http_info(folder_id, body, opts = {})
|
|
3903
3903
|
if @api_client.config.debugging
|
|
@@ -3962,7 +3962,7 @@ end
|
|
|
3962
3962
|
# @param template_id [String] The template's ID.
|
|
3963
3963
|
# @param body [MoveTemplateRequest] Where to move the template.
|
|
3964
3964
|
# @param [Hash] opts the optional parameters
|
|
3965
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
3965
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
3966
3966
|
# @return [Template]
|
|
3967
3967
|
def move_template(template_id, body, opts = {})
|
|
3968
3968
|
data, _status_code, _headers = move_template_with_http_info(template_id, body, opts)
|
|
@@ -3974,7 +3974,7 @@ end
|
|
|
3974
3974
|
# @param template_id [String] The template's ID.
|
|
3975
3975
|
# @param body [MoveTemplateRequest] Where to move the template.
|
|
3976
3976
|
# @param [Hash] opts the optional parameters
|
|
3977
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
3977
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
3978
3978
|
# @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
|
|
3979
3979
|
def move_template_with_http_info(template_id, body, opts = {})
|
|
3980
3980
|
if @api_client.config.debugging
|
|
@@ -4039,7 +4039,7 @@ end
|
|
|
4039
4039
|
# @param template_id [String] The template's ID.
|
|
4040
4040
|
# @param body [PublishTemplateVersionRequest] The version to publish.
|
|
4041
4041
|
# @param [Hash] opts the optional parameters
|
|
4042
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4042
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4043
4043
|
# @return [TemplateVersion]
|
|
4044
4044
|
def publish_template_version(template_id, body, opts = {})
|
|
4045
4045
|
data, _status_code, _headers = publish_template_version_with_http_info(template_id, body, opts)
|
|
@@ -4051,7 +4051,7 @@ end
|
|
|
4051
4051
|
# @param template_id [String] The template's ID.
|
|
4052
4052
|
# @param body [PublishTemplateVersionRequest] The version to publish.
|
|
4053
4053
|
# @param [Hash] opts the optional parameters
|
|
4054
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4054
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4055
4055
|
# @return [Array<(TemplateVersion, Integer, Hash)>] TemplateVersion data, response status code and response headers
|
|
4056
4056
|
def publish_template_version_with_http_info(template_id, body, opts = {})
|
|
4057
4057
|
if @api_client.config.debugging
|
|
@@ -4116,7 +4116,7 @@ end
|
|
|
4116
4116
|
# @param template_id [String] The template's ID.
|
|
4117
4117
|
# @param body [RemoveTemplateFieldsRequest] The fields to remove from the template's draft.
|
|
4118
4118
|
# @param [Hash] opts the optional parameters
|
|
4119
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4119
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4120
4120
|
# @return [TemplateFields]
|
|
4121
4121
|
def remove_template_fields(template_id, body, opts = {})
|
|
4122
4122
|
data, _status_code, _headers = remove_template_fields_with_http_info(template_id, body, opts)
|
|
@@ -4128,7 +4128,7 @@ end
|
|
|
4128
4128
|
# @param template_id [String] The template's ID.
|
|
4129
4129
|
# @param body [RemoveTemplateFieldsRequest] The fields to remove from the template's draft.
|
|
4130
4130
|
# @param [Hash] opts the optional parameters
|
|
4131
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4131
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4132
4132
|
# @return [Array<(TemplateFields, Integer, Hash)>] TemplateFields data, response status code and response headers
|
|
4133
4133
|
def remove_template_fields_with_http_info(template_id, body, opts = {})
|
|
4134
4134
|
if @api_client.config.debugging
|
|
@@ -4193,7 +4193,7 @@ end
|
|
|
4193
4193
|
# @param folder_id [String] The folder's ID.
|
|
4194
4194
|
# @param body [RenameFolderRequest] The folder's new name.
|
|
4195
4195
|
# @param [Hash] opts the optional parameters
|
|
4196
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4196
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4197
4197
|
# @return [Folder]
|
|
4198
4198
|
def rename_folder(folder_id, body, opts = {})
|
|
4199
4199
|
data, _status_code, _headers = rename_folder_with_http_info(folder_id, body, opts)
|
|
@@ -4205,7 +4205,7 @@ end
|
|
|
4205
4205
|
# @param folder_id [String] The folder's ID.
|
|
4206
4206
|
# @param body [RenameFolderRequest] The folder's new name.
|
|
4207
4207
|
# @param [Hash] opts the optional parameters
|
|
4208
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4208
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4209
4209
|
# @return [Array<(Folder, Integer, Hash)>] Folder data, response status code and response headers
|
|
4210
4210
|
def rename_folder_with_http_info(folder_id, body, opts = {})
|
|
4211
4211
|
if @api_client.config.debugging
|
|
@@ -4270,7 +4270,7 @@ end
|
|
|
4270
4270
|
# @param template_id [String] The template's ID.
|
|
4271
4271
|
# @param body [ReorderTemplateFieldsRequest] The new order of the fields in the template's draft.
|
|
4272
4272
|
# @param [Hash] opts the optional parameters
|
|
4273
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4273
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4274
4274
|
# @return [TemplateFields]
|
|
4275
4275
|
def reorder_template_fields(template_id, body, opts = {})
|
|
4276
4276
|
data, _status_code, _headers = reorder_template_fields_with_http_info(template_id, body, opts)
|
|
@@ -4282,7 +4282,7 @@ end
|
|
|
4282
4282
|
# @param template_id [String] The template's ID.
|
|
4283
4283
|
# @param body [ReorderTemplateFieldsRequest] The new order of the fields in the template's draft.
|
|
4284
4284
|
# @param [Hash] opts the optional parameters
|
|
4285
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4285
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4286
4286
|
# @return [Array<(TemplateFields, Integer, Hash)>] TemplateFields data, response status code and response headers
|
|
4287
4287
|
def reorder_template_fields_with_http_info(template_id, body, opts = {})
|
|
4288
4288
|
if @api_client.config.debugging
|
|
@@ -4347,7 +4347,7 @@ end
|
|
|
4347
4347
|
# @param template_id [String] The template's ID.
|
|
4348
4348
|
# @param body [RestoreTemplateVersionRequest] The version to restore.
|
|
4349
4349
|
# @param [Hash] opts the optional parameters
|
|
4350
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4350
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4351
4351
|
# @return [Template]
|
|
4352
4352
|
def restore_template_version(template_id, body, opts = {})
|
|
4353
4353
|
data, _status_code, _headers = restore_template_version_with_http_info(template_id, body, opts)
|
|
@@ -4359,7 +4359,7 @@ end
|
|
|
4359
4359
|
# @param template_id [String] The template's ID.
|
|
4360
4360
|
# @param body [RestoreTemplateVersionRequest] The version to restore.
|
|
4361
4361
|
# @param [Hash] opts the optional parameters
|
|
4362
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4362
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4363
4363
|
# @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
|
|
4364
4364
|
def restore_template_version_with_http_info(template_id, body, opts = {})
|
|
4365
4365
|
if @api_client.config.debugging
|
|
@@ -4424,7 +4424,7 @@ end
|
|
|
4424
4424
|
# @param email_action_id [String] The account email action's ID.
|
|
4425
4425
|
# @param [Hash] opts the optional parameters
|
|
4426
4426
|
# @option opts [SendAccountEmailActionTestEmailRequest] :body Which template the test email is for.
|
|
4427
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4427
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4428
4428
|
# @return [EmailActionTestEmail]
|
|
4429
4429
|
def send_account_email_action_test_email(email_action_id, opts = {})
|
|
4430
4430
|
data, _status_code, _headers = send_account_email_action_test_email_with_http_info(email_action_id, opts)
|
|
@@ -4436,7 +4436,7 @@ end
|
|
|
4436
4436
|
# @param email_action_id [String] The account email action's ID.
|
|
4437
4437
|
# @param [Hash] opts the optional parameters
|
|
4438
4438
|
# @option opts [SendAccountEmailActionTestEmailRequest] :body Which template the test email is for.
|
|
4439
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4439
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4440
4440
|
# @return [Array<(EmailActionTestEmail, Integer, Hash)>] EmailActionTestEmail data, response status code and response headers
|
|
4441
4441
|
def send_account_email_action_test_email_with_http_info(email_action_id, opts = {})
|
|
4442
4442
|
if @api_client.config.debugging
|
|
@@ -4497,7 +4497,7 @@ end
|
|
|
4497
4497
|
# @param template_id [String] The template's ID.
|
|
4498
4498
|
# @param email_action_id [String] The email action's ID.
|
|
4499
4499
|
# @param [Hash] opts the optional parameters
|
|
4500
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4500
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4501
4501
|
# @return [EmailActionTestEmail]
|
|
4502
4502
|
def send_email_action_test_email(template_id, email_action_id, opts = {})
|
|
4503
4503
|
data, _status_code, _headers = send_email_action_test_email_with_http_info(template_id, email_action_id, opts)
|
|
@@ -4509,7 +4509,7 @@ end
|
|
|
4509
4509
|
# @param template_id [String] The template's ID.
|
|
4510
4510
|
# @param email_action_id [String] The email action's ID.
|
|
4511
4511
|
# @param [Hash] opts the optional parameters
|
|
4512
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4512
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4513
4513
|
# @return [Array<(EmailActionTestEmail, Integer, Hash)>] EmailActionTestEmail data, response status code and response headers
|
|
4514
4514
|
def send_email_action_test_email_with_http_info(template_id, email_action_id, opts = {})
|
|
4515
4515
|
if @api_client.config.debugging
|
|
@@ -4626,7 +4626,7 @@ end
|
|
|
4626
4626
|
# @param email_action_id [String] The account email action's ID.
|
|
4627
4627
|
# @param body [UpdateAccountEmailActionRequest] The settings to change. Properties left out keep their values.
|
|
4628
4628
|
# @param [Hash] opts the optional parameters
|
|
4629
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4629
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4630
4630
|
# @return [EmailAction]
|
|
4631
4631
|
def update_account_email_action(email_action_id, body, opts = {})
|
|
4632
4632
|
data, _status_code, _headers = update_account_email_action_with_http_info(email_action_id, body, opts)
|
|
@@ -4638,7 +4638,7 @@ end
|
|
|
4638
4638
|
# @param email_action_id [String] The account email action's ID.
|
|
4639
4639
|
# @param body [UpdateAccountEmailActionRequest] The settings to change. Properties left out keep their values.
|
|
4640
4640
|
# @param [Hash] opts the optional parameters
|
|
4641
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4641
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4642
4642
|
# @return [Array<(EmailAction, Integer, Hash)>] EmailAction data, response status code and response headers
|
|
4643
4643
|
def update_account_email_action_with_http_info(email_action_id, body, opts = {})
|
|
4644
4644
|
if @api_client.config.debugging
|
|
@@ -4704,7 +4704,7 @@ end
|
|
|
4704
4704
|
# @param email_action_id [String] The email action's ID.
|
|
4705
4705
|
# @param body [UpdateEmailActionRequest] The settings to change. Properties left out keep their values.
|
|
4706
4706
|
# @param [Hash] opts the optional parameters
|
|
4707
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4707
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4708
4708
|
# @return [EmailAction]
|
|
4709
4709
|
def update_email_action(template_id, email_action_id, body, opts = {})
|
|
4710
4710
|
data, _status_code, _headers = update_email_action_with_http_info(template_id, email_action_id, body, opts)
|
|
@@ -4717,7 +4717,7 @@ end
|
|
|
4717
4717
|
# @param email_action_id [String] The email action's ID.
|
|
4718
4718
|
# @param body [UpdateEmailActionRequest] The settings to change. Properties left out keep their values.
|
|
4719
4719
|
# @param [Hash] opts the optional parameters
|
|
4720
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4720
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4721
4721
|
# @return [Array<(EmailAction, Integer, Hash)>] EmailAction data, response status code and response headers
|
|
4722
4722
|
def update_email_action_with_http_info(template_id, email_action_id, body, opts = {})
|
|
4723
4723
|
if @api_client.config.debugging
|
|
@@ -4787,7 +4787,7 @@ end
|
|
|
4787
4787
|
# @param email_action_id [String] The ID of one of your account's email actions that sends for the template.
|
|
4788
4788
|
# @param body [UpdateEmailActionCustomizationRequest] The template's changes to the account email action, replacing any it had. Each setting you send is changed for this template, and the ones you leave out follow the account email action. `enabled: false` stops it sending for this template; left out, it sends.
|
|
4789
4789
|
# @param [Hash] opts the optional parameters
|
|
4790
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4790
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4791
4791
|
# @return [EmailAction]
|
|
4792
4792
|
def update_email_action_customization(template_id, email_action_id, body, opts = {})
|
|
4793
4793
|
data, _status_code, _headers = update_email_action_customization_with_http_info(template_id, email_action_id, body, opts)
|
|
@@ -4800,7 +4800,7 @@ end
|
|
|
4800
4800
|
# @param email_action_id [String] The ID of one of your account's email actions that sends for the template.
|
|
4801
4801
|
# @param body [UpdateEmailActionCustomizationRequest] The template's changes to the account email action, replacing any it had. Each setting you send is changed for this template, and the ones you leave out follow the account email action. `enabled: false` stops it sending for this template; left out, it sends.
|
|
4802
4802
|
# @param [Hash] opts the optional parameters
|
|
4803
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4803
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4804
4804
|
# @return [Array<(EmailAction, Integer, Hash)>] EmailAction data, response status code and response headers
|
|
4805
4805
|
def update_email_action_customization_with_http_info(template_id, email_action_id, body, opts = {})
|
|
4806
4806
|
if @api_client.config.debugging
|
|
@@ -4869,7 +4869,7 @@ end
|
|
|
4869
4869
|
# @param signature_request_id [String] The signature request's ID.
|
|
4870
4870
|
# @param body [UpdateSignatureRequestRequest] The settings to change. Properties left out keep their values.
|
|
4871
4871
|
# @param [Hash] opts the optional parameters
|
|
4872
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4872
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4873
4873
|
# @return [SignatureRequest]
|
|
4874
4874
|
def update_signature_request(signature_request_id, body, opts = {})
|
|
4875
4875
|
data, _status_code, _headers = update_signature_request_with_http_info(signature_request_id, body, opts)
|
|
@@ -4881,7 +4881,7 @@ end
|
|
|
4881
4881
|
# @param signature_request_id [String] The signature request's ID.
|
|
4882
4882
|
# @param body [UpdateSignatureRequestRequest] The settings to change. Properties left out keep their values.
|
|
4883
4883
|
# @param [Hash] opts the optional parameters
|
|
4884
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4884
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4885
4885
|
# @return [Array<(SignatureRequest, Integer, Hash)>] SignatureRequest data, response status code and response headers
|
|
4886
4886
|
def update_signature_request_with_http_info(signature_request_id, body, opts = {})
|
|
4887
4887
|
if @api_client.config.debugging
|
|
@@ -4946,7 +4946,7 @@ end
|
|
|
4946
4946
|
# @param template_id [String] The template's ID.
|
|
4947
4947
|
# @param body [UpdateTemplateRequest] The settings to change. Properties left out keep their values.
|
|
4948
4948
|
# @param [Hash] opts the optional parameters
|
|
4949
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4949
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4950
4950
|
# @return [Template]
|
|
4951
4951
|
def update_template(template_id, body, opts = {})
|
|
4952
4952
|
data, _status_code, _headers = update_template_with_http_info(template_id, body, opts)
|
|
@@ -4958,7 +4958,7 @@ end
|
|
|
4958
4958
|
# @param template_id [String] The template's ID.
|
|
4959
4959
|
# @param body [UpdateTemplateRequest] The settings to change. Properties left out keep their values.
|
|
4960
4960
|
# @param [Hash] opts the optional parameters
|
|
4961
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
4961
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
4962
4962
|
# @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
|
|
4963
4963
|
def update_template_with_http_info(template_id, body, opts = {})
|
|
4964
4964
|
if @api_client.config.debugging
|
|
@@ -5024,7 +5024,7 @@ end
|
|
|
5024
5024
|
# @param body [UpdateTemplateDocumentRequest] The new PDF, or a Word template's new Word document, as one of `cache_id`, `document_url` and `document_base64`.
|
|
5025
5025
|
# @param [Hash] opts the optional parameters
|
|
5026
5026
|
# @option opts [Boolean] :wait Wait until the PDF has been processed, a `document_url`'s PDF or Word document downloaded, and an OpenDocument file converted, before responding. Default true on sync.api hosts.
|
|
5027
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
5027
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5028
5028
|
# @return [Template]
|
|
5029
5029
|
def update_template_document(template_id, body, opts = {})
|
|
5030
5030
|
data, _status_code, _headers = update_template_document_with_http_info(template_id, body, opts)
|
|
@@ -5037,7 +5037,7 @@ end
|
|
|
5037
5037
|
# @param body [UpdateTemplateDocumentRequest] The new PDF, or a Word template's new Word document, as one of `cache_id`, `document_url` and `document_base64`.
|
|
5038
5038
|
# @param [Hash] opts the optional parameters
|
|
5039
5039
|
# @option opts [Boolean] :wait Wait until the PDF has been processed, a `document_url`'s PDF or Word document downloaded, and an OpenDocument file converted, before responding. Default true on sync.api hosts.
|
|
5040
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
5040
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5041
5041
|
# @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
|
|
5042
5042
|
def update_template_document_with_http_info(template_id, body, opts = {})
|
|
5043
5043
|
if @api_client.config.debugging
|
|
@@ -5103,7 +5103,7 @@ end
|
|
|
5103
5103
|
# @param template_id [String] The template's ID.
|
|
5104
5104
|
# @param body [UpdateTemplateFieldsRequest] The fields to change in the template's draft.
|
|
5105
5105
|
# @param [Hash] opts the optional parameters
|
|
5106
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
5106
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5107
5107
|
# @return [TemplateFields]
|
|
5108
5108
|
def update_template_fields(template_id, body, opts = {})
|
|
5109
5109
|
data, _status_code, _headers = update_template_fields_with_http_info(template_id, body, opts)
|
|
@@ -5115,7 +5115,7 @@ end
|
|
|
5115
5115
|
# @param template_id [String] The template's ID.
|
|
5116
5116
|
# @param body [UpdateTemplateFieldsRequest] The fields to change in the template's draft.
|
|
5117
5117
|
# @param [Hash] opts the optional parameters
|
|
5118
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
5118
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5119
5119
|
# @return [Array<(TemplateFields, Integer, Hash)>] TemplateFields data, response status code and response headers
|
|
5120
5120
|
def update_template_fields_with_http_info(template_id, body, opts = {})
|
|
5121
5121
|
if @api_client.config.debugging
|
|
@@ -5180,7 +5180,7 @@ end
|
|
|
5180
5180
|
# @param webhook_id [String] The webhook's ID.
|
|
5181
5181
|
# @param body [UpdateWebhookRequest] The settings to change. Properties left out keep their values.
|
|
5182
5182
|
# @param [Hash] opts the optional parameters
|
|
5183
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
5183
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5184
5184
|
# @return [Webhook]
|
|
5185
5185
|
def update_webhook(webhook_id, body, opts = {})
|
|
5186
5186
|
data, _status_code, _headers = update_webhook_with_http_info(webhook_id, body, opts)
|
|
@@ -5192,7 +5192,7 @@ end
|
|
|
5192
5192
|
# @param webhook_id [String] The webhook's ID.
|
|
5193
5193
|
# @param body [UpdateWebhookRequest] The settings to change. Properties left out keep their values.
|
|
5194
5194
|
# @param [Hash] opts the optional parameters
|
|
5195
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
5195
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5196
5196
|
# @return [Array<(Webhook, Integer, Hash)>] Webhook data, response status code and response headers
|
|
5197
5197
|
def update_webhook_with_http_info(webhook_id, body, opts = {})
|
|
5198
5198
|
if @api_client.config.debugging
|
|
@@ -5266,7 +5266,8 @@ end
|
|
|
5266
5266
|
# @option opts [FieldSetupNaming] :field_naming With `detect_fields`, how the fields are named. `ai` (the default) names them and sets their types and settings with AI; `preserve` keeps the names of the PDF's form fields, and AI only names the fields it detected. `preserve` needs `field_source` `auto` or `pdf_form_fields`.
|
|
5267
5267
|
# @option opts [FieldSetupLogic] :field_logic With `detect_fields`, whether AI reads the whole form once the fields are named and sets up conditional logic and required fields (`ai`) or not (`none`). Default: your account's template settings.
|
|
5268
5268
|
# @option opts [OutputFormat] :output_format What each submission of a Word template makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. Required when `document` is a Word document.
|
|
5269
|
-
# @option opts [
|
|
5269
|
+
# @option opts [Boolean] :include_office_use_fields With `detect_fields`, whether AI field setup keeps the fields that only the office receiving the form fills in, such as a "For office use only" box (`true`), or leaves them out (`false`). Default: your account's template settings.
|
|
5270
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5270
5271
|
# @return [Template]
|
|
5271
5272
|
def upload_template(document, opts = {})
|
|
5272
5273
|
data, _status_code, _headers = upload_template_with_http_info(document, opts)
|
|
@@ -5287,7 +5288,8 @@ end
|
|
|
5287
5288
|
# @option opts [FieldSetupNaming] :field_naming With `detect_fields`, how the fields are named. `ai` (the default) names them and sets their types and settings with AI; `preserve` keeps the names of the PDF's form fields, and AI only names the fields it detected. `preserve` needs `field_source` `auto` or `pdf_form_fields`.
|
|
5288
5289
|
# @option opts [FieldSetupLogic] :field_logic With `detect_fields`, whether AI reads the whole form once the fields are named and sets up conditional logic and required fields (`ai`) or not (`none`). Default: your account's template settings.
|
|
5289
5290
|
# @option opts [OutputFormat] :output_format What each submission of a Word template makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. Required when `document` is a Word document.
|
|
5290
|
-
# @option opts [
|
|
5291
|
+
# @option opts [Boolean] :include_office_use_fields With `detect_fields`, whether AI field setup keeps the fields that only the office receiving the form fills in, such as a "For office use only" box (`true`), or leaves them out (`false`). Default: your account's template settings.
|
|
5292
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5291
5293
|
# @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
|
|
5292
5294
|
def upload_template_with_http_info(document, opts = {})
|
|
5293
5295
|
if @api_client.config.debugging
|
|
@@ -5327,6 +5329,7 @@ end
|
|
|
5327
5329
|
form_params['field_naming'] = opts[:'field_naming'] if !opts[:'field_naming'].nil?
|
|
5328
5330
|
form_params['field_logic'] = opts[:'field_logic'] if !opts[:'field_logic'].nil?
|
|
5329
5331
|
form_params['output_format'] = opts[:'output_format'] if !opts[:'output_format'].nil?
|
|
5332
|
+
form_params['include_office_use_fields'] = opts[:'include_office_use_fields'] if !opts[:'include_office_use_fields'].nil?
|
|
5330
5333
|
|
|
5331
5334
|
# http body (model)
|
|
5332
5335
|
post_body = opts[:debug_body]
|
|
@@ -5361,7 +5364,7 @@ end
|
|
|
5361
5364
|
# @param [Hash] opts the optional parameters
|
|
5362
5365
|
# @option opts [Boolean] :wait Wait until the PDF has been processed, a `document_url`'s PDF or Word document downloaded, and an OpenDocument file converted, before responding. Default true on sync.api hosts.
|
|
5363
5366
|
# @option opts [Boolean] :reimport_fields Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields. Only for PDF templates: a Word template adds a field for each new tag.
|
|
5364
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
5367
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5365
5368
|
# @return [Template]
|
|
5366
5369
|
def upload_template_document(template_id, document, opts = {})
|
|
5367
5370
|
data, _status_code, _headers = upload_template_document_with_http_info(template_id, document, opts)
|
|
@@ -5375,7 +5378,7 @@ end
|
|
|
5375
5378
|
# @param [Hash] opts the optional parameters
|
|
5376
5379
|
# @option opts [Boolean] :wait Wait until the PDF has been processed, a `document_url`'s PDF or Word document downloaded, and an OpenDocument file converted, before responding. Default true on sync.api hosts.
|
|
5377
5380
|
# @option opts [Boolean] :reimport_fields Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields. Only for PDF templates: a Word template adds a field for each new tag.
|
|
5378
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
5381
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5379
5382
|
# @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
|
|
5380
5383
|
def upload_template_document_with_http_info(template_id, document, opts = {})
|
|
5381
5384
|
if @api_client.config.debugging
|
|
@@ -5444,7 +5447,7 @@ end
|
|
|
5444
5447
|
# @param body [ValidateSubmissionRequest] The submission's data and settings.
|
|
5445
5448
|
# @param [Hash] opts the optional parameters
|
|
5446
5449
|
# @option opts [String] :version The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` (the newest published version, or the draft when none has been published) or `draft`. Default `latest`.
|
|
5447
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
5450
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5448
5451
|
# @return [SubmissionValidation]
|
|
5449
5452
|
def validate_submission(template_id, body, opts = {})
|
|
5450
5453
|
data, _status_code, _headers = validate_submission_with_http_info(template_id, body, opts)
|
|
@@ -5457,7 +5460,7 @@ end
|
|
|
5457
5460
|
# @param body [ValidateSubmissionRequest] The submission's data and settings.
|
|
5458
5461
|
# @param [Hash] opts the optional parameters
|
|
5459
5462
|
# @option opts [String] :version The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` (the newest published version, or the draft when none has been published) or `draft`. Default `latest`.
|
|
5460
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
5463
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5461
5464
|
# @return [Array<(SubmissionValidation, Integer, Hash)>] SubmissionValidation data, response status code and response headers
|
|
5462
5465
|
def validate_submission_with_http_info(template_id, body, opts = {})
|
|
5463
5466
|
if @api_client.config.debugging
|
|
@@ -5522,7 +5525,7 @@ end
|
|
|
5522
5525
|
# Checks the email domain's DNS records now, instead of waiting for the next check. If DocSpring has stopped looking for its DKIM records (3 days after they were created), it starts again with new ones: replace the CNAME records with them.
|
|
5523
5526
|
# @param email_domain_id [String] The email domain's ID.
|
|
5524
5527
|
# @param [Hash] opts the optional parameters
|
|
5525
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
5528
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5526
5529
|
# @return [EmailDomain]
|
|
5527
5530
|
def verify_email_domain(email_domain_id, opts = {})
|
|
5528
5531
|
data, _status_code, _headers = verify_email_domain_with_http_info(email_domain_id, opts)
|
|
@@ -5533,7 +5536,7 @@ end
|
|
|
5533
5536
|
# Checks the email domain's DNS records now, instead of waiting for the next check. If DocSpring has stopped looking for its DKIM records (3 days after they were created), it starts again with new ones: replace the CNAME records with them.
|
|
5534
5537
|
# @param email_domain_id [String] The email domain's ID.
|
|
5535
5538
|
# @param [Hash] opts the optional parameters
|
|
5536
|
-
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then.
|
|
5539
|
+
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5537
5540
|
# @return [Array<(EmailDomain, Integer, Hash)>] EmailDomain data, response status code and response headers
|
|
5538
5541
|
def verify_email_domain_with_http_info(email_domain_id, opts = {})
|
|
5539
5542
|
if @api_client.config.debugging
|