signwell_sdk 0.0.1.pre.alpha.1
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 +7 -0
- data/.ignore +2 -0
- data/CHANGELOG.md +24 -0
- data/README.md +398 -0
- data/SECURITY.md +23 -0
- data/lib/signwell_sdk/client.rb +72 -0
- data/lib/signwell_sdk/errors.rb +228 -0
- data/lib/signwell_sdk/file_part.rb +58 -0
- data/lib/signwell_sdk/internal/transport/base_client.rb +573 -0
- data/lib/signwell_sdk/internal/transport/pooled_net_requester.rb +210 -0
- data/lib/signwell_sdk/internal/type/array_of.rb +168 -0
- data/lib/signwell_sdk/internal/type/base_model.rb +531 -0
- data/lib/signwell_sdk/internal/type/base_page.rb +55 -0
- data/lib/signwell_sdk/internal/type/boolean.rb +77 -0
- data/lib/signwell_sdk/internal/type/converter.rb +327 -0
- data/lib/signwell_sdk/internal/type/enum.rb +156 -0
- data/lib/signwell_sdk/internal/type/file_input.rb +111 -0
- data/lib/signwell_sdk/internal/type/hash_of.rb +188 -0
- data/lib/signwell_sdk/internal/type/request_parameters.rb +42 -0
- data/lib/signwell_sdk/internal/type/union.rb +243 -0
- data/lib/signwell_sdk/internal/type/unknown.rb +81 -0
- data/lib/signwell_sdk/internal/util.rb +920 -0
- data/lib/signwell_sdk/internal.rb +20 -0
- data/lib/signwell_sdk/models/attachment_request_info.rb +34 -0
- data/lib/signwell_sdk/models/checkbox_group_info.rb +66 -0
- data/lib/signwell_sdk/models/checkbox_validation.rb +18 -0
- data/lib/signwell_sdk/models/copied_contact_info.rb +34 -0
- data/lib/signwell_sdk/models/date_format.rb +20 -0
- data/lib/signwell_sdk/models/field_type.rb +29 -0
- data/lib/signwell_sdk/models/file_info.rb +26 -0
- data/lib/signwell_sdk/models/label_info.rb +26 -0
- data/lib/signwell_sdk/models/text_validation.rb +25 -0
- data/lib/signwell_sdk/models/v1/api_application_delete_params.rb +16 -0
- data/lib/signwell_sdk/models/v1/api_application_retrieve_params.rb +16 -0
- data/lib/signwell_sdk/models/v1/attachment_request.rb +38 -0
- data/lib/signwell_sdk/models/v1/bulk_send_create_params.rb +107 -0
- data/lib/signwell_sdk/models/v1/bulk_send_list_params.rb +55 -0
- data/lib/signwell_sdk/models/v1/bulk_send_retrieve_csv_template_params.rb +39 -0
- data/lib/signwell_sdk/models/v1/bulk_send_retrieve_documents_params.rb +32 -0
- data/lib/signwell_sdk/models/v1/bulk_send_retrieve_params.rb +16 -0
- data/lib/signwell_sdk/models/v1/bulk_send_validate_csv_params.rb +39 -0
- data/lib/signwell_sdk/models/v1/checkbox_group.rb +80 -0
- data/lib/signwell_sdk/models/v1/copied_contact.rb +26 -0
- data/lib/signwell_sdk/models/v1/document.rb +543 -0
- data/lib/signwell_sdk/models/v1/document_create_from_template_params.rb +740 -0
- data/lib/signwell_sdk/models/v1/document_create_from_template_response.rb +500 -0
- data/lib/signwell_sdk/models/v1/document_create_params.rb +620 -0
- data/lib/signwell_sdk/models/v1/document_delete_params.rb +16 -0
- data/lib/signwell_sdk/models/v1/document_file.rb +34 -0
- data/lib/signwell_sdk/models/v1/document_list_params.rb +32 -0
- data/lib/signwell_sdk/models/v1/document_list_response.rb +50 -0
- data/lib/signwell_sdk/models/v1/document_remind_params.rb +49 -0
- data/lib/signwell_sdk/models/v1/document_retrieve_completed_pdf_params.rb +55 -0
- data/lib/signwell_sdk/models/v1/document_retrieve_completed_pdf_response.rb +22 -0
- data/lib/signwell_sdk/models/v1/document_retrieve_params.rb +16 -0
- data/lib/signwell_sdk/models/v1/document_send_params.rb +198 -0
- data/lib/signwell_sdk/models/v1/document_template.rb +503 -0
- data/lib/signwell_sdk/models/v1/document_template_create_params.rb +599 -0
- data/lib/signwell_sdk/models/v1/document_template_delete_params.rb +16 -0
- data/lib/signwell_sdk/models/v1/document_template_list_params.rb +32 -0
- data/lib/signwell_sdk/models/v1/document_template_list_response.rb +50 -0
- data/lib/signwell_sdk/models/v1/document_template_retrieve_params.rb +16 -0
- data/lib/signwell_sdk/models/v1/document_template_update_params.rb +162 -0
- data/lib/signwell_sdk/models/v1/hook_create_params.rb +32 -0
- data/lib/signwell_sdk/models/v1/hook_delete_params.rb +16 -0
- data/lib/signwell_sdk/models/v1/hook_list_params.rb +16 -0
- data/lib/signwell_sdk/models/v1/label.rb +22 -0
- data/lib/signwell_sdk/models/v1/template_checkbox_group.rb +80 -0
- data/lib/signwell_sdk/models/v1_me_params.rb +14 -0
- data/lib/signwell_sdk/models.rb +63 -0
- data/lib/signwell_sdk/request_options.rb +77 -0
- data/lib/signwell_sdk/resources/v1/api_applications.rb +59 -0
- data/lib/signwell_sdk/resources/v1/bulk_sends.rb +198 -0
- data/lib/signwell_sdk/resources/v1/document_templates.rb +204 -0
- data/lib/signwell_sdk/resources/v1/documents.rb +372 -0
- data/lib/signwell_sdk/resources/v1/hooks.rb +78 -0
- data/lib/signwell_sdk/resources/v1.rb +47 -0
- data/lib/signwell_sdk/version.rb +5 -0
- data/lib/signwell_sdk.rb +107 -0
- data/manifest.yaml +17 -0
- data/rbi/signwell_sdk/client.rbi +49 -0
- data/rbi/signwell_sdk/errors.rbi +205 -0
- data/rbi/signwell_sdk/file_part.rbi +37 -0
- data/rbi/signwell_sdk/internal/transport/base_client.rbi +302 -0
- data/rbi/signwell_sdk/internal/transport/pooled_net_requester.rbi +84 -0
- data/rbi/signwell_sdk/internal/type/array_of.rbi +104 -0
- data/rbi/signwell_sdk/internal/type/base_model.rbi +308 -0
- data/rbi/signwell_sdk/internal/type/base_page.rbi +43 -0
- data/rbi/signwell_sdk/internal/type/boolean.rbi +58 -0
- data/rbi/signwell_sdk/internal/type/converter.rbi +216 -0
- data/rbi/signwell_sdk/internal/type/enum.rbi +82 -0
- data/rbi/signwell_sdk/internal/type/file_input.rbi +59 -0
- data/rbi/signwell_sdk/internal/type/hash_of.rbi +104 -0
- data/rbi/signwell_sdk/internal/type/request_parameters.rbi +31 -0
- data/rbi/signwell_sdk/internal/type/union.rbi +128 -0
- data/rbi/signwell_sdk/internal/type/unknown.rbi +58 -0
- data/rbi/signwell_sdk/internal/util.rbi +487 -0
- data/rbi/signwell_sdk/internal.rbi +18 -0
- data/rbi/signwell_sdk/models/attachment_request_info.rbi +52 -0
- data/rbi/signwell_sdk/models/checkbox_group_info.rbi +89 -0
- data/rbi/signwell_sdk/models/checkbox_validation.rbi +27 -0
- data/rbi/signwell_sdk/models/copied_contact_info.rbi +50 -0
- data/rbi/signwell_sdk/models/date_format.rbi +26 -0
- data/rbi/signwell_sdk/models/field_type.rbi +41 -0
- data/rbi/signwell_sdk/models/file_info.rbi +36 -0
- data/rbi/signwell_sdk/models/label_info.rbi +40 -0
- data/rbi/signwell_sdk/models/text_validation.rbi +44 -0
- data/rbi/signwell_sdk/models/v1/api_application_delete_params.rbi +34 -0
- data/rbi/signwell_sdk/models/v1/api_application_retrieve_params.rbi +34 -0
- data/rbi/signwell_sdk/models/v1/attachment_request.rbi +59 -0
- data/rbi/signwell_sdk/models/v1/bulk_send_create_params.rbi +160 -0
- data/rbi/signwell_sdk/models/v1/bulk_send_list_params.rbi +92 -0
- data/rbi/signwell_sdk/models/v1/bulk_send_retrieve_csv_template_params.rbi +67 -0
- data/rbi/signwell_sdk/models/v1/bulk_send_retrieve_documents_params.rbi +62 -0
- data/rbi/signwell_sdk/models/v1/bulk_send_retrieve_params.rbi +34 -0
- data/rbi/signwell_sdk/models/v1/bulk_send_validate_csv_params.rbi +64 -0
- data/rbi/signwell_sdk/models/v1/checkbox_group.rbi +121 -0
- data/rbi/signwell_sdk/models/v1/copied_contact.rbi +41 -0
- data/rbi/signwell_sdk/models/v1/document.rbi +833 -0
- data/rbi/signwell_sdk/models/v1/document_create_from_template_params.rbi +1270 -0
- data/rbi/signwell_sdk/models/v1/document_create_from_template_response.rbi +856 -0
- data/rbi/signwell_sdk/models/v1/document_create_params.rbi +1019 -0
- data/rbi/signwell_sdk/models/v1/document_delete_params.rbi +34 -0
- data/rbi/signwell_sdk/models/v1/document_file.rbi +55 -0
- data/rbi/signwell_sdk/models/v1/document_list_params.rbi +62 -0
- data/rbi/signwell_sdk/models/v1/document_list_response.rbi +71 -0
- data/rbi/signwell_sdk/models/v1/document_remind_params.rbi +107 -0
- data/rbi/signwell_sdk/models/v1/document_retrieve_completed_pdf_params.rbi +123 -0
- data/rbi/signwell_sdk/models/v1/document_retrieve_completed_pdf_response.rbi +34 -0
- data/rbi/signwell_sdk/models/v1/document_retrieve_params.rbi +34 -0
- data/rbi/signwell_sdk/models/v1/document_send_params.rbi +307 -0
- data/rbi/signwell_sdk/models/v1/document_template.rbi +830 -0
- data/rbi/signwell_sdk/models/v1/document_template_create_params.rbi +1050 -0
- data/rbi/signwell_sdk/models/v1/document_template_delete_params.rbi +34 -0
- data/rbi/signwell_sdk/models/v1/document_template_list_params.rbi +62 -0
- data/rbi/signwell_sdk/models/v1/document_template_list_response.rbi +71 -0
- data/rbi/signwell_sdk/models/v1/document_template_retrieve_params.rbi +34 -0
- data/rbi/signwell_sdk/models/v1/document_template_update_params.rbi +257 -0
- data/rbi/signwell_sdk/models/v1/hook_create_params.rbi +59 -0
- data/rbi/signwell_sdk/models/v1/hook_delete_params.rbi +34 -0
- data/rbi/signwell_sdk/models/v1/hook_list_params.rbi +34 -0
- data/rbi/signwell_sdk/models/v1/label.rbi +29 -0
- data/rbi/signwell_sdk/models/v1/template_checkbox_group.rbi +121 -0
- data/rbi/signwell_sdk/models/v1_me_params.rbi +27 -0
- data/rbi/signwell_sdk/models.rbi +25 -0
- data/rbi/signwell_sdk/request_options.rbi +59 -0
- data/rbi/signwell_sdk/resources/v1/api_applications.rbi +45 -0
- data/rbi/signwell_sdk/resources/v1/bulk_sends.rbi +173 -0
- data/rbi/signwell_sdk/resources/v1/document_templates.rbi +276 -0
- data/rbi/signwell_sdk/resources/v1/documents.rbi +527 -0
- data/rbi/signwell_sdk/resources/v1/hooks.rbi +52 -0
- data/rbi/signwell_sdk/resources/v1.rbi +32 -0
- data/rbi/signwell_sdk/version.rbi +5 -0
- data/sig/signwell_sdk/client.rbs +26 -0
- data/sig/signwell_sdk/errors.rbs +117 -0
- data/sig/signwell_sdk/file_part.rbs +21 -0
- data/sig/signwell_sdk/internal/transport/base_client.rbs +133 -0
- data/sig/signwell_sdk/internal/transport/pooled_net_requester.rbs +48 -0
- data/sig/signwell_sdk/internal/type/array_of.rbs +48 -0
- data/sig/signwell_sdk/internal/type/base_model.rbs +102 -0
- data/sig/signwell_sdk/internal/type/base_page.rbs +24 -0
- data/sig/signwell_sdk/internal/type/boolean.rbs +26 -0
- data/sig/signwell_sdk/internal/type/converter.rbs +79 -0
- data/sig/signwell_sdk/internal/type/enum.rbs +32 -0
- data/sig/signwell_sdk/internal/type/file_input.rbs +25 -0
- data/sig/signwell_sdk/internal/type/hash_of.rbs +48 -0
- data/sig/signwell_sdk/internal/type/request_parameters.rbs +19 -0
- data/sig/signwell_sdk/internal/type/union.rbs +52 -0
- data/sig/signwell_sdk/internal/type/unknown.rbs +26 -0
- data/sig/signwell_sdk/internal/util.rbs +185 -0
- data/sig/signwell_sdk/internal.rbs +9 -0
- data/sig/signwell_sdk/models/attachment_request_info.rbs +19 -0
- data/sig/signwell_sdk/models/checkbox_group_info.rbs +52 -0
- data/sig/signwell_sdk/models/checkbox_validation.rbs +16 -0
- data/sig/signwell_sdk/models/copied_contact_info.rbs +21 -0
- data/sig/signwell_sdk/models/date_format.rbs +22 -0
- data/sig/signwell_sdk/models/field_type.rbs +42 -0
- data/sig/signwell_sdk/models/file_info.rbs +15 -0
- data/sig/signwell_sdk/models/label_info.rbs +19 -0
- data/sig/signwell_sdk/models/text_validation.rbs +34 -0
- data/sig/signwell_sdk/models/v1/api_application_delete_params.rbs +17 -0
- data/sig/signwell_sdk/models/v1/api_application_retrieve_params.rbs +17 -0
- data/sig/signwell_sdk/models/v1/attachment_request.rbs +26 -0
- data/sig/signwell_sdk/models/v1/bulk_send_create_params.rbs +89 -0
- data/sig/signwell_sdk/models/v1/bulk_send_list_params.rbs +51 -0
- data/sig/signwell_sdk/models/v1/bulk_send_retrieve_csv_template_params.rbs +32 -0
- data/sig/signwell_sdk/models/v1/bulk_send_retrieve_documents_params.rbs +34 -0
- data/sig/signwell_sdk/models/v1/bulk_send_retrieve_params.rbs +17 -0
- data/sig/signwell_sdk/models/v1/bulk_send_validate_csv_params.rbs +30 -0
- data/sig/signwell_sdk/models/v1/checkbox_group.rbs +69 -0
- data/sig/signwell_sdk/models/v1/copied_contact.rbs +19 -0
- data/sig/signwell_sdk/models/v1/document.rbs +563 -0
- data/sig/signwell_sdk/models/v1/document_create_from_template_params.rbs +570 -0
- data/sig/signwell_sdk/models/v1/document_create_from_template_response.rbs +518 -0
- data/sig/signwell_sdk/models/v1/document_create_params.rbs +473 -0
- data/sig/signwell_sdk/models/v1/document_delete_params.rbs +17 -0
- data/sig/signwell_sdk/models/v1/document_file.rbs +32 -0
- data/sig/signwell_sdk/models/v1/document_list_params.rbs +34 -0
- data/sig/signwell_sdk/models/v1/document_list_response.rbs +47 -0
- data/sig/signwell_sdk/models/v1/document_remind_params.rbs +48 -0
- data/sig/signwell_sdk/models/v1/document_retrieve_completed_pdf_params.rbs +57 -0
- data/sig/signwell_sdk/models/v1/document_retrieve_completed_pdf_response.rbs +15 -0
- data/sig/signwell_sdk/models/v1/document_retrieve_params.rbs +17 -0
- data/sig/signwell_sdk/models/v1/document_send_params.rbs +160 -0
- data/sig/signwell_sdk/models/v1/document_template.rbs +530 -0
- data/sig/signwell_sdk/models/v1/document_template_create_params.rbs +459 -0
- data/sig/signwell_sdk/models/v1/document_template_delete_params.rbs +17 -0
- data/sig/signwell_sdk/models/v1/document_template_list_params.rbs +34 -0
- data/sig/signwell_sdk/models/v1/document_template_list_response.rbs +47 -0
- data/sig/signwell_sdk/models/v1/document_template_retrieve_params.rbs +17 -0
- data/sig/signwell_sdk/models/v1/document_template_update_params.rbs +132 -0
- data/sig/signwell_sdk/models/v1/hook_create_params.rbs +32 -0
- data/sig/signwell_sdk/models/v1/hook_delete_params.rbs +17 -0
- data/sig/signwell_sdk/models/v1/hook_list_params.rbs +17 -0
- data/sig/signwell_sdk/models/v1/label.rbs +15 -0
- data/sig/signwell_sdk/models/v1/template_checkbox_group.rbs +69 -0
- data/sig/signwell_sdk/models/v1_me_params.rbs +14 -0
- data/sig/signwell_sdk/models.rbs +23 -0
- data/sig/signwell_sdk/request_options.rbs +36 -0
- data/sig/signwell_sdk/resources/v1/api_applications.rbs +19 -0
- data/sig/signwell_sdk/resources/v1/bulk_sends.rbs +55 -0
- data/sig/signwell_sdk/resources/v1/document_templates.rbs +71 -0
- data/sig/signwell_sdk/resources/v1/documents.rbs +130 -0
- data/sig/signwell_sdk/resources/v1/hooks.rbs +22 -0
- data/sig/signwell_sdk/resources/v1.rbs +19 -0
- data/sig/signwell_sdk/version.rbs +3 -0
- metadata +298 -0
|
@@ -0,0 +1,599 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module SignwellSDK
|
|
4
|
+
module Models
|
|
5
|
+
module V1
|
|
6
|
+
# @see SignwellSDK::Resources::V1::DocumentTemplates#create
|
|
7
|
+
class DocumentTemplateCreateParams < SignwellSDK::Internal::Type::BaseModel
|
|
8
|
+
extend SignwellSDK::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include SignwellSDK::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute files
|
|
12
|
+
# Document files can be uploaded by specifying a file URL or base64 string. Either
|
|
13
|
+
# `file_url` or `file_base64` must be present (not both). Valid file types are:
|
|
14
|
+
# .pdf, .doc, .docx, .pages, .ppt, .pptx, .key, .xls, .xlsx, .numbers, .jpg,
|
|
15
|
+
# .jpeg, .png, .tiff, .tif, .webp, .html, and .htm
|
|
16
|
+
#
|
|
17
|
+
# @return [Array<SignwellSDK::Models::V1::DocumentFile>]
|
|
18
|
+
required :files, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::DocumentFile] }
|
|
19
|
+
|
|
20
|
+
# @!attribute placeholders
|
|
21
|
+
# Placeholders are generally job roles that must complete and/or sign the
|
|
22
|
+
# document. For example, a placeholder might be “Client” or “Legal Department”.
|
|
23
|
+
# When a document is created from the template, you assign a person to each
|
|
24
|
+
# placeholder.
|
|
25
|
+
#
|
|
26
|
+
# @return [Array<SignwellSDK::Models::V1::DocumentTemplateCreateParams::Placeholder>]
|
|
27
|
+
required :placeholders,
|
|
28
|
+
-> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::DocumentTemplateCreateParams::Placeholder] }
|
|
29
|
+
|
|
30
|
+
# @!attribute allow_decline
|
|
31
|
+
# Whether to allow recipients the option to decline signing a document. If
|
|
32
|
+
# multiple signers are involved in a document, any single recipient can cancel the
|
|
33
|
+
# entire document signing process by declining to sign.
|
|
34
|
+
#
|
|
35
|
+
# @return [Boolean, nil]
|
|
36
|
+
optional :allow_decline, SignwellSDK::Internal::Type::Boolean
|
|
37
|
+
|
|
38
|
+
# @!attribute allow_reassign
|
|
39
|
+
# In some cases a signer is not the right person to sign and may need to reassign
|
|
40
|
+
# their signing responsibilities to another person. This feature allows them to
|
|
41
|
+
# reassign the document to someone else.
|
|
42
|
+
#
|
|
43
|
+
# @return [Boolean, nil]
|
|
44
|
+
optional :allow_reassign, SignwellSDK::Internal::Type::Boolean
|
|
45
|
+
|
|
46
|
+
# @!attribute api_application_id
|
|
47
|
+
# Unique identifier for API Application settings to use. API Applications are
|
|
48
|
+
# optional and mainly used when isolating OAuth apps or for more control over
|
|
49
|
+
# embedded API settings
|
|
50
|
+
#
|
|
51
|
+
# @return [String, nil]
|
|
52
|
+
optional :api_application_id, String
|
|
53
|
+
|
|
54
|
+
# @!attribute apply_signing_order
|
|
55
|
+
# When set to `true` recipients will sign one at a time in the order of the
|
|
56
|
+
# `recipients` collection of this request.
|
|
57
|
+
#
|
|
58
|
+
# @return [Boolean, nil]
|
|
59
|
+
optional :apply_signing_order, SignwellSDK::Internal::Type::Boolean
|
|
60
|
+
|
|
61
|
+
# @!attribute attachment_requests
|
|
62
|
+
# Attachments that a recipient must upload to complete the signing process.
|
|
63
|
+
# Attachment requests are shown after all document fields have been completed.
|
|
64
|
+
#
|
|
65
|
+
# @return [Array<SignwellSDK::Models::V1::DocumentTemplateCreateParams::AttachmentRequest>, nil]
|
|
66
|
+
optional :attachment_requests,
|
|
67
|
+
-> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::DocumentTemplateCreateParams::AttachmentRequest] }
|
|
68
|
+
|
|
69
|
+
# @!attribute checkbox_groups
|
|
70
|
+
# Checkbox fields that are placed on a document can be grouped with selection
|
|
71
|
+
# requirements. At least 2 checkbox fields in an array of fields must be assigned
|
|
72
|
+
# to the same recipient.
|
|
73
|
+
#
|
|
74
|
+
# @return [Array<SignwellSDK::Models::V1::TemplateCheckboxGroup>, nil]
|
|
75
|
+
optional :checkbox_groups,
|
|
76
|
+
-> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::TemplateCheckboxGroup] }
|
|
77
|
+
|
|
78
|
+
# @!attribute copied_placeholders
|
|
79
|
+
# Copied placeholders are emailed the final document once it has been completed by
|
|
80
|
+
# all recipients.
|
|
81
|
+
#
|
|
82
|
+
# @return [Array<SignwellSDK::Models::V1::DocumentTemplateCreateParams::CopiedPlaceholder>, nil]
|
|
83
|
+
optional :copied_placeholders,
|
|
84
|
+
-> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::DocumentTemplateCreateParams::CopiedPlaceholder] }
|
|
85
|
+
|
|
86
|
+
# @!attribute decline_redirect_url
|
|
87
|
+
# A URL that recipients are redirected to if the document is declined.
|
|
88
|
+
#
|
|
89
|
+
# @return [String, nil]
|
|
90
|
+
optional :decline_redirect_url, String
|
|
91
|
+
|
|
92
|
+
# @!attribute draft
|
|
93
|
+
# Whether the template can still be updated before it is ready for usage. If set
|
|
94
|
+
# to `false` the template is marked as `Available` and it will be ready for use.
|
|
95
|
+
# Defaults to `false`.
|
|
96
|
+
#
|
|
97
|
+
# @return [Boolean, nil]
|
|
98
|
+
optional :draft, SignwellSDK::Internal::Type::Boolean
|
|
99
|
+
|
|
100
|
+
# @!attribute expires_in
|
|
101
|
+
# Number of days before the signature request expires. Defaults to the account
|
|
102
|
+
# expiration setting or template expiration (if the document is created from a
|
|
103
|
+
# template).
|
|
104
|
+
#
|
|
105
|
+
# @return [Integer, nil]
|
|
106
|
+
optional :expires_in, Integer
|
|
107
|
+
|
|
108
|
+
# @!attribute fields
|
|
109
|
+
# Document fields placed on a document for collecting data or signatures from
|
|
110
|
+
# recipients. At least one field must be present in the Create Document request if
|
|
111
|
+
# `draft` is `false` (unless adding a signature page by using
|
|
112
|
+
# `with_signature_page`). Field data should be sent as a 2-dimensional JSON array.
|
|
113
|
+
# One array of fields is needed for each file in the files array. An array of
|
|
114
|
+
# fields can be empty if you have a file that does not contain any fields.
|
|
115
|
+
#
|
|
116
|
+
# @return [Array<Array<SignwellSDK::Models::V1::DocumentTemplateCreateParams::Field>>, nil]
|
|
117
|
+
optional :fields,
|
|
118
|
+
-> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::DocumentTemplateCreateParams::Field]] }
|
|
119
|
+
|
|
120
|
+
# @!attribute labels
|
|
121
|
+
# Labels can be used to organize documents in a way that can make it easy to find
|
|
122
|
+
# using the document search in SignWell. A document can have multiple labels.
|
|
123
|
+
#
|
|
124
|
+
# @return [Array<SignwellSDK::Models::V1::Label>, nil]
|
|
125
|
+
optional :labels, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::Label] }
|
|
126
|
+
|
|
127
|
+
# @!attribute language
|
|
128
|
+
# Sets the language for the template and documents created from the template for
|
|
129
|
+
# all recipient side interactions including the document email and the document
|
|
130
|
+
# itself. Accepted languages: English, Français, Español, Deutsch, Polski,
|
|
131
|
+
# Português, Dansk, Nederlands, Italiano, Русский, Svenska, العربية, Ελληνικά,
|
|
132
|
+
# Türkçe, Slovenčina. Language should be sent in ISO 639-1 format: en, fr, es, de,
|
|
133
|
+
# pl, pt, da, nl, it, ru, sv, ar, el, tr, sk.
|
|
134
|
+
#
|
|
135
|
+
# @return [String, nil]
|
|
136
|
+
optional :language, String
|
|
137
|
+
|
|
138
|
+
# @!attribute message
|
|
139
|
+
# Email message for the signature request that recipients will see. Defaults to
|
|
140
|
+
# the default system message or a template message (if the document is created
|
|
141
|
+
# from a template).
|
|
142
|
+
#
|
|
143
|
+
# @return [String, nil]
|
|
144
|
+
optional :message, String
|
|
145
|
+
|
|
146
|
+
# @!attribute metadata
|
|
147
|
+
# Optional key-value data that can be associated with the document. If set, will
|
|
148
|
+
# be available every time the document data is returned.
|
|
149
|
+
#
|
|
150
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
151
|
+
optional :metadata, SignwellSDK::Internal::Type::HashOf[String]
|
|
152
|
+
|
|
153
|
+
# @!attribute name
|
|
154
|
+
# The name of the template.
|
|
155
|
+
#
|
|
156
|
+
# @return [String, nil]
|
|
157
|
+
optional :name, String
|
|
158
|
+
|
|
159
|
+
# @!attribute redirect_url
|
|
160
|
+
# A URL that recipients are redirected to after successfully signing a document.
|
|
161
|
+
#
|
|
162
|
+
# @return [String, nil]
|
|
163
|
+
optional :redirect_url, String
|
|
164
|
+
|
|
165
|
+
# @!attribute reminders
|
|
166
|
+
# Whether to send signing reminders to recipients. Reminders are sent on day 3,
|
|
167
|
+
# day 6, and day 10 if set to `true`. Defaults to `true`.
|
|
168
|
+
#
|
|
169
|
+
# @return [Boolean, nil]
|
|
170
|
+
optional :reminders, SignwellSDK::Internal::Type::Boolean
|
|
171
|
+
|
|
172
|
+
# @!attribute subject
|
|
173
|
+
# Email subject for the signature request that recipients will see. Defaults to
|
|
174
|
+
# the default system subject or a template subject (if the document is created
|
|
175
|
+
# from a template).
|
|
176
|
+
#
|
|
177
|
+
# @return [String, nil]
|
|
178
|
+
optional :subject, String
|
|
179
|
+
|
|
180
|
+
# @!attribute text_tags
|
|
181
|
+
# An alternative way (if you can’t use the recommended way) of placing fields in
|
|
182
|
+
# specific locations of your document by using special text tags. Useful when
|
|
183
|
+
# changing the content of your files changes the location of fields. See API
|
|
184
|
+
# documentation for “Text Tags” for details. Defaults to false.
|
|
185
|
+
#
|
|
186
|
+
# @return [Boolean, nil]
|
|
187
|
+
optional :text_tags, SignwellSDK::Internal::Type::Boolean
|
|
188
|
+
|
|
189
|
+
# @!method initialize(files:, placeholders:, allow_decline: nil, allow_reassign: nil, api_application_id: nil, apply_signing_order: nil, attachment_requests: nil, checkbox_groups: nil, copied_placeholders: nil, decline_redirect_url: nil, draft: nil, expires_in: nil, fields: nil, labels: nil, language: nil, message: nil, metadata: nil, name: nil, redirect_url: nil, reminders: nil, subject: nil, text_tags: nil, request_options: {})
|
|
190
|
+
# Some parameter documentations has been truncated, see
|
|
191
|
+
# {SignwellSDK::Models::V1::DocumentTemplateCreateParams} for more details.
|
|
192
|
+
#
|
|
193
|
+
# @param files [Array<SignwellSDK::Models::V1::DocumentFile>] Document files can be uploaded by specifying a file URL or base64 string. Either
|
|
194
|
+
#
|
|
195
|
+
# @param placeholders [Array<SignwellSDK::Models::V1::DocumentTemplateCreateParams::Placeholder>] Placeholders are generally job roles that must complete and/or sign the document
|
|
196
|
+
#
|
|
197
|
+
# @param allow_decline [Boolean] Whether to allow recipients the option to decline signing a document. If multipl
|
|
198
|
+
#
|
|
199
|
+
# @param allow_reassign [Boolean] In some cases a signer is not the right person to sign and may need to reassign
|
|
200
|
+
#
|
|
201
|
+
# @param api_application_id [String] Unique identifier for API Application settings to use. API Applications are opti
|
|
202
|
+
#
|
|
203
|
+
# @param apply_signing_order [Boolean] When set to `true` recipients will sign one at a time in the order of the `recip
|
|
204
|
+
#
|
|
205
|
+
# @param attachment_requests [Array<SignwellSDK::Models::V1::DocumentTemplateCreateParams::AttachmentRequest>] Attachments that a recipient must upload to complete the signing process. Attach
|
|
206
|
+
#
|
|
207
|
+
# @param checkbox_groups [Array<SignwellSDK::Models::V1::TemplateCheckboxGroup>] Checkbox fields that are placed on a document can be grouped with selection requ
|
|
208
|
+
#
|
|
209
|
+
# @param copied_placeholders [Array<SignwellSDK::Models::V1::DocumentTemplateCreateParams::CopiedPlaceholder>] Copied placeholders are emailed the final document once it has been completed by
|
|
210
|
+
#
|
|
211
|
+
# @param decline_redirect_url [String] A URL that recipients are redirected to if the document is declined.
|
|
212
|
+
#
|
|
213
|
+
# @param draft [Boolean] Whether the template can still be updated before it is ready for usage. If set t
|
|
214
|
+
#
|
|
215
|
+
# @param expires_in [Integer] Number of days before the signature request expires. Defaults to the account exp
|
|
216
|
+
#
|
|
217
|
+
# @param fields [Array<Array<SignwellSDK::Models::V1::DocumentTemplateCreateParams::Field>>] Document fields placed on a document for collecting data or signatures from reci
|
|
218
|
+
#
|
|
219
|
+
# @param labels [Array<SignwellSDK::Models::V1::Label>] Labels can be used to organize documents in a way that can make it easy to find
|
|
220
|
+
#
|
|
221
|
+
# @param language [String] Sets the language for the template and documents created from the template for a
|
|
222
|
+
#
|
|
223
|
+
# @param message [String] Email message for the signature request that recipients will see. Defaults to th
|
|
224
|
+
#
|
|
225
|
+
# @param metadata [Hash{Symbol=>String}] Optional key-value data that can be associated with the document. If set, will b
|
|
226
|
+
#
|
|
227
|
+
# @param name [String] The name of the template.
|
|
228
|
+
#
|
|
229
|
+
# @param redirect_url [String] A URL that recipients are redirected to after successfully signing a document.
|
|
230
|
+
#
|
|
231
|
+
# @param reminders [Boolean] Whether to send signing reminders to recipients. Reminders are sent on day 3, da
|
|
232
|
+
#
|
|
233
|
+
# @param subject [String] Email subject for the signature request that recipients will see. Defaults to th
|
|
234
|
+
#
|
|
235
|
+
# @param text_tags [Boolean] An alternative way (if you can’t use the recommended way) of placing fields in s
|
|
236
|
+
#
|
|
237
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
238
|
+
|
|
239
|
+
class Placeholder < SignwellSDK::Internal::Type::BaseModel
|
|
240
|
+
# @!attribute id
|
|
241
|
+
# A unique identifier that you will give to each placeholder. We recommend
|
|
242
|
+
# numbering sequentially from 1 to X. IDs are required for associating recipients
|
|
243
|
+
# to fields and more.
|
|
244
|
+
#
|
|
245
|
+
# @return [String]
|
|
246
|
+
required :id, String
|
|
247
|
+
|
|
248
|
+
# @!attribute name
|
|
249
|
+
# Name of the placeholder.
|
|
250
|
+
#
|
|
251
|
+
# @return [String]
|
|
252
|
+
required :name, String
|
|
253
|
+
|
|
254
|
+
# @!attribute preassigned_recipient_email
|
|
255
|
+
# In some cases, it may be necessary to pre-fill the name and email for a
|
|
256
|
+
# placeholder because it will always be the same person for all documents created
|
|
257
|
+
# from this template. This sets the email.
|
|
258
|
+
#
|
|
259
|
+
# @return [String, nil]
|
|
260
|
+
optional :preassigned_recipient_email, String
|
|
261
|
+
|
|
262
|
+
# @!attribute preassigned_recipient_name
|
|
263
|
+
# In some cases, it may be necessary to pre-fill the name and email for a
|
|
264
|
+
# placeholder because it will always be the same person for all documents created
|
|
265
|
+
# from this template. This sets the name.
|
|
266
|
+
#
|
|
267
|
+
# @return [String, nil]
|
|
268
|
+
optional :preassigned_recipient_name, String
|
|
269
|
+
|
|
270
|
+
# @!method initialize(id:, name:, preassigned_recipient_email: nil, preassigned_recipient_name: nil)
|
|
271
|
+
# Some parameter documentations has been truncated, see
|
|
272
|
+
# {SignwellSDK::Models::V1::DocumentTemplateCreateParams::Placeholder} for more
|
|
273
|
+
# details.
|
|
274
|
+
#
|
|
275
|
+
# @param id [String] A unique identifier that you will give to each placeholder. We recommend numberi
|
|
276
|
+
#
|
|
277
|
+
# @param name [String] Name of the placeholder.
|
|
278
|
+
#
|
|
279
|
+
# @param preassigned_recipient_email [String] In some cases, it may be necessary to pre-fill the name and email for a placehol
|
|
280
|
+
#
|
|
281
|
+
# @param preassigned_recipient_name [String] In some cases, it may be necessary to pre-fill the name and email for a placehol
|
|
282
|
+
end
|
|
283
|
+
|
|
284
|
+
class AttachmentRequest < SignwellSDK::Internal::Type::BaseModel
|
|
285
|
+
# @!attribute name
|
|
286
|
+
# Name of the requested attachment.
|
|
287
|
+
#
|
|
288
|
+
# @return [String]
|
|
289
|
+
required :name, String
|
|
290
|
+
|
|
291
|
+
# @!attribute placeholder_id
|
|
292
|
+
# Unique identifier of the recipient that will view the attachment request.
|
|
293
|
+
#
|
|
294
|
+
# @return [String]
|
|
295
|
+
required :placeholder_id, String
|
|
296
|
+
|
|
297
|
+
# @!attribute required
|
|
298
|
+
# Whether the recipient will need to upload the attachment to successfully
|
|
299
|
+
# complete/sign the document. Defaults to `true`.
|
|
300
|
+
#
|
|
301
|
+
# @return [Boolean, nil]
|
|
302
|
+
optional :required, SignwellSDK::Internal::Type::Boolean
|
|
303
|
+
|
|
304
|
+
# @!method initialize(name:, placeholder_id:, required: nil)
|
|
305
|
+
# Some parameter documentations has been truncated, see
|
|
306
|
+
# {SignwellSDK::Models::V1::DocumentTemplateCreateParams::AttachmentRequest} for
|
|
307
|
+
# more details.
|
|
308
|
+
#
|
|
309
|
+
# @param name [String] Name of the requested attachment.
|
|
310
|
+
#
|
|
311
|
+
# @param placeholder_id [String] Unique identifier of the recipient that will view the attachment request.
|
|
312
|
+
#
|
|
313
|
+
# @param required [Boolean] Whether the recipient will need to upload the attachment to successfully complet
|
|
314
|
+
end
|
|
315
|
+
|
|
316
|
+
class CopiedPlaceholder < SignwellSDK::Internal::Type::BaseModel
|
|
317
|
+
# @!attribute name
|
|
318
|
+
# Name of the placeholder.
|
|
319
|
+
#
|
|
320
|
+
# @return [String]
|
|
321
|
+
required :name, String
|
|
322
|
+
|
|
323
|
+
# @!attribute preassigned_recipient_email
|
|
324
|
+
# In some cases, it may be necessary to pre-fill the name and email for a
|
|
325
|
+
# placeholder because it will always be the same person for all documents created
|
|
326
|
+
# from this template. This sets the email.
|
|
327
|
+
#
|
|
328
|
+
# @return [String, nil]
|
|
329
|
+
optional :preassigned_recipient_email, String
|
|
330
|
+
|
|
331
|
+
# @!attribute preassigned_recipient_name
|
|
332
|
+
# In some cases, it may be necessary to pre-fill the name and email for a
|
|
333
|
+
# placeholder because it will always be the same person for all documents created
|
|
334
|
+
# from this template. This sets the name.
|
|
335
|
+
#
|
|
336
|
+
# @return [String, nil]
|
|
337
|
+
optional :preassigned_recipient_name, String
|
|
338
|
+
|
|
339
|
+
# @!method initialize(name:, preassigned_recipient_email: nil, preassigned_recipient_name: nil)
|
|
340
|
+
# Some parameter documentations has been truncated, see
|
|
341
|
+
# {SignwellSDK::Models::V1::DocumentTemplateCreateParams::CopiedPlaceholder} for
|
|
342
|
+
# more details.
|
|
343
|
+
#
|
|
344
|
+
# @param name [String] Name of the placeholder.
|
|
345
|
+
#
|
|
346
|
+
# @param preassigned_recipient_email [String] In some cases, it may be necessary to pre-fill the name and email for a placehol
|
|
347
|
+
#
|
|
348
|
+
# @param preassigned_recipient_name [String] In some cases, it may be necessary to pre-fill the name and email for a placehol
|
|
349
|
+
end
|
|
350
|
+
|
|
351
|
+
class Field < SignwellSDK::Internal::Type::BaseModel
|
|
352
|
+
# @!attribute page
|
|
353
|
+
# The page number within the file. If the page does not exist within the file then
|
|
354
|
+
# the field won't be created.
|
|
355
|
+
#
|
|
356
|
+
# @return [Integer]
|
|
357
|
+
required :page, Integer
|
|
358
|
+
|
|
359
|
+
# @!attribute placeholder_id
|
|
360
|
+
# Unique identifier of the placeholder assigned to the field.
|
|
361
|
+
#
|
|
362
|
+
# @return [String]
|
|
363
|
+
required :placeholder_id, String
|
|
364
|
+
|
|
365
|
+
# @!attribute type
|
|
366
|
+
# Field type of the field. Valid field types: initials, signatures, checkbox,
|
|
367
|
+
# date, and text. To autofill fields with contact data, use an autofill field
|
|
368
|
+
# type. To group checkbox fields, enter an api_id for each checkbox and add the
|
|
369
|
+
# checkbox_groups parameter.
|
|
370
|
+
#
|
|
371
|
+
# @return [Symbol, SignwellSDK::Models::FieldType]
|
|
372
|
+
required :type, enum: -> { SignwellSDK::FieldType }
|
|
373
|
+
|
|
374
|
+
# @!attribute x
|
|
375
|
+
# Horizontal value in the coordinates of the field (in pixels). Coordinates are
|
|
376
|
+
# specific to the page where fields are located.
|
|
377
|
+
#
|
|
378
|
+
# @return [Float]
|
|
379
|
+
required :x, Float
|
|
380
|
+
|
|
381
|
+
# @!attribute y_
|
|
382
|
+
# Vertical value in the coordinates of the field (in pixels). Coordinates are
|
|
383
|
+
# specific to the page where fields are located.
|
|
384
|
+
#
|
|
385
|
+
# @return [Float]
|
|
386
|
+
required :y_, Float, api_name: :y
|
|
387
|
+
|
|
388
|
+
# @!attribute allow_other
|
|
389
|
+
# Whether to allow "Other" option with text input (for dropdown/select fields
|
|
390
|
+
# only)
|
|
391
|
+
#
|
|
392
|
+
# @return [Boolean, nil]
|
|
393
|
+
optional :allow_other, SignwellSDK::Internal::Type::Boolean
|
|
394
|
+
|
|
395
|
+
# @!attribute api_id
|
|
396
|
+
# Unique identifier of the field. Useful when needing to reference specific field
|
|
397
|
+
# values or update a document and its fields.
|
|
398
|
+
#
|
|
399
|
+
# @return [String, nil]
|
|
400
|
+
optional :api_id, String
|
|
401
|
+
|
|
402
|
+
# @!attribute date_format
|
|
403
|
+
# Date fields only: date format to use for the field. Valid values: MM/DD/YYYY,
|
|
404
|
+
# DD/MM/YYYY, YYYY/MM/DD, Month DD, YYYY, and MM/DD/YYYY hh:mm:ss a. Defaults to
|
|
405
|
+
# MM/DD/YYYY.
|
|
406
|
+
#
|
|
407
|
+
# @return [Symbol, SignwellSDK::Models::DateFormat, nil]
|
|
408
|
+
optional :date_format, enum: -> { SignwellSDK::DateFormat }
|
|
409
|
+
|
|
410
|
+
# @!attribute default_option
|
|
411
|
+
# Default selected option (for dropdown/select fields only)
|
|
412
|
+
#
|
|
413
|
+
# @return [String, nil]
|
|
414
|
+
optional :default_option, String
|
|
415
|
+
|
|
416
|
+
# @!attribute fixed_width
|
|
417
|
+
# Text fields only: whether the field width will stay fixed and text will display
|
|
418
|
+
# in multiple lines, rather than one long line. If set to `false` the field width
|
|
419
|
+
# will automatically grow horizontally to fit text on one line. Defaults to
|
|
420
|
+
# `false`.
|
|
421
|
+
#
|
|
422
|
+
# @return [Boolean, nil]
|
|
423
|
+
optional :fixed_width, SignwellSDK::Internal::Type::Boolean
|
|
424
|
+
|
|
425
|
+
# @!attribute height
|
|
426
|
+
# Height of the field (in pixels). Maximum height varies by field type:
|
|
427
|
+
# Signature/Initials (200px), others (74px). When using text tags if the height is
|
|
428
|
+
# greater than the maximum height, the height will be set to the maximum height.
|
|
429
|
+
#
|
|
430
|
+
# @return [Float, nil]
|
|
431
|
+
optional :height, Float
|
|
432
|
+
|
|
433
|
+
# @!attribute label
|
|
434
|
+
# Text and Date fields only: label that is displayed when the field is empty.
|
|
435
|
+
#
|
|
436
|
+
# @return [String, nil]
|
|
437
|
+
optional :label, String
|
|
438
|
+
|
|
439
|
+
# @!attribute lock_sign_date
|
|
440
|
+
# Date fields only: makes fields readonly and automatically populates with the
|
|
441
|
+
# date the recipient signed. Defaults to `false`.
|
|
442
|
+
#
|
|
443
|
+
# @return [Boolean, nil]
|
|
444
|
+
optional :lock_sign_date, SignwellSDK::Internal::Type::Boolean
|
|
445
|
+
|
|
446
|
+
# @!attribute name
|
|
447
|
+
# Checkbox fields only. At least 2 checkbox fields in an array of fields must be
|
|
448
|
+
# assigned to the same recipient and grouped with selection requirements.
|
|
449
|
+
#
|
|
450
|
+
# @return [String, nil]
|
|
451
|
+
optional :name, String
|
|
452
|
+
|
|
453
|
+
# @!attribute options
|
|
454
|
+
# Array of dropdown options (for dropdown/select fields only)
|
|
455
|
+
#
|
|
456
|
+
# @return [Array<String, SignwellSDK::Models::V1::DocumentTemplateCreateParams::Field::Option::DetailedOption>, nil]
|
|
457
|
+
optional :options,
|
|
458
|
+
-> { SignwellSDK::Internal::Type::ArrayOf[union: SignwellSDK::V1::DocumentTemplateCreateParams::Field::Option] }
|
|
459
|
+
|
|
460
|
+
# @!attribute required
|
|
461
|
+
# Whether the field must be completed by the recipient. Defaults to `true` except
|
|
462
|
+
# for checkbox type fields.
|
|
463
|
+
#
|
|
464
|
+
# @return [Boolean, nil]
|
|
465
|
+
optional :required, SignwellSDK::Internal::Type::Boolean
|
|
466
|
+
|
|
467
|
+
# @!attribute validation
|
|
468
|
+
# Text fields only: optional validation for field values. Valid values: numbers,
|
|
469
|
+
# letters, email_address, us_phone_number, us_zip_code, us_ssn, us_age,
|
|
470
|
+
# alphanumeric, us_bank_routing_number, us_bank_account.
|
|
471
|
+
#
|
|
472
|
+
# @return [Symbol, SignwellSDK::Models::TextValidation, nil]
|
|
473
|
+
optional :validation, enum: -> { SignwellSDK::TextValidation }
|
|
474
|
+
|
|
475
|
+
# @!attribute value
|
|
476
|
+
# Varies according to the field type. Text fields accept strings or numbers. Date
|
|
477
|
+
# fields accept Iso8601 date strings. CheckBoxes accept booleans. Signature and
|
|
478
|
+
# Initials fields can't be signed through API requests. Autofill text fields
|
|
479
|
+
# accept strings or numbers.
|
|
480
|
+
#
|
|
481
|
+
# @return [String, Boolean, Float, nil]
|
|
482
|
+
optional :value, union: -> { SignwellSDK::V1::DocumentTemplateCreateParams::Field::Value }
|
|
483
|
+
|
|
484
|
+
# @!attribute width
|
|
485
|
+
# Width of the field (in pixels). For text fields, width will auto-grow unless
|
|
486
|
+
# `fixed_width` is true.
|
|
487
|
+
#
|
|
488
|
+
# @return [Float, nil]
|
|
489
|
+
optional :width, Float
|
|
490
|
+
|
|
491
|
+
# @!method initialize(page:, placeholder_id:, type:, x:, y_:, allow_other: nil, api_id: nil, date_format: nil, default_option: nil, fixed_width: nil, height: nil, label: nil, lock_sign_date: nil, name: nil, options: nil, required: nil, validation: nil, value: nil, width: nil)
|
|
492
|
+
# Some parameter documentations has been truncated, see
|
|
493
|
+
# {SignwellSDK::Models::V1::DocumentTemplateCreateParams::Field} for more details.
|
|
494
|
+
#
|
|
495
|
+
# @param page [Integer] The page number within the file. If the page does not exist within the file then
|
|
496
|
+
#
|
|
497
|
+
# @param placeholder_id [String] Unique identifier of the placeholder assigned to the field.
|
|
498
|
+
#
|
|
499
|
+
# @param type [Symbol, SignwellSDK::Models::FieldType] Field type of the field. Valid field types: initials, signatures, checkbox, date
|
|
500
|
+
#
|
|
501
|
+
# @param x [Float] Horizontal value in the coordinates of the field (in pixels). Coordinates are sp
|
|
502
|
+
#
|
|
503
|
+
# @param y_ [Float] Vertical value in the coordinates of the field (in pixels). Coordinates are spec
|
|
504
|
+
#
|
|
505
|
+
# @param allow_other [Boolean] Whether to allow "Other" option with text input (for dropdown/select fields only
|
|
506
|
+
#
|
|
507
|
+
# @param api_id [String] Unique identifier of the field. Useful when needing to reference specific field
|
|
508
|
+
#
|
|
509
|
+
# @param date_format [Symbol, SignwellSDK::Models::DateFormat] Date fields only: date format to use for the field. Valid values: MM/DD/YYYY, DD
|
|
510
|
+
#
|
|
511
|
+
# @param default_option [String] Default selected option (for dropdown/select fields only)
|
|
512
|
+
#
|
|
513
|
+
# @param fixed_width [Boolean] Text fields only: whether the field width will stay fixed and text will display
|
|
514
|
+
#
|
|
515
|
+
# @param height [Float] Height of the field (in pixels). Maximum height varies by field type: Signature/
|
|
516
|
+
#
|
|
517
|
+
# @param label [String] Text and Date fields only: label that is displayed when the field is empty.
|
|
518
|
+
#
|
|
519
|
+
# @param lock_sign_date [Boolean] Date fields only: makes fields readonly and automatically populates with the dat
|
|
520
|
+
#
|
|
521
|
+
# @param name [String] Checkbox fields only. At least 2 checkbox fields in an array of fields must be a
|
|
522
|
+
#
|
|
523
|
+
# @param options [Array<String, SignwellSDK::Models::V1::DocumentTemplateCreateParams::Field::Option::DetailedOption>] Array of dropdown options (for dropdown/select fields only)
|
|
524
|
+
#
|
|
525
|
+
# @param required [Boolean] Whether the field must be completed by the recipient. Defaults to `true` except
|
|
526
|
+
#
|
|
527
|
+
# @param validation [Symbol, SignwellSDK::Models::TextValidation] Text fields only: optional validation for field values. Valid values: numbers, l
|
|
528
|
+
#
|
|
529
|
+
# @param value [String, Boolean, Float] Varies according to the field type. Text fields accept strings or numbers. Date
|
|
530
|
+
#
|
|
531
|
+
# @param width [Float] Width of the field (in pixels). For text fields, width will auto-grow unless `fi
|
|
532
|
+
|
|
533
|
+
# A dropdown option - either a simple string or a detailed object with name and
|
|
534
|
+
# optional api_id
|
|
535
|
+
module Option
|
|
536
|
+
extend SignwellSDK::Internal::Type::Union
|
|
537
|
+
|
|
538
|
+
# Simple string option
|
|
539
|
+
variant String
|
|
540
|
+
|
|
541
|
+
# Detailed option object
|
|
542
|
+
variant -> { SignwellSDK::V1::DocumentTemplateCreateParams::Field::Option::DetailedOption }
|
|
543
|
+
|
|
544
|
+
class DetailedOption < SignwellSDK::Internal::Type::BaseModel
|
|
545
|
+
# @!attribute name
|
|
546
|
+
# Option display name
|
|
547
|
+
#
|
|
548
|
+
# @return [String]
|
|
549
|
+
required :name, String
|
|
550
|
+
|
|
551
|
+
# @!attribute api_id
|
|
552
|
+
# Unique identifier for the option
|
|
553
|
+
#
|
|
554
|
+
# @return [String, nil]
|
|
555
|
+
optional :api_id, String
|
|
556
|
+
|
|
557
|
+
# @!attribute is_other
|
|
558
|
+
# Whether this is the special "Other" option
|
|
559
|
+
#
|
|
560
|
+
# @return [Boolean, nil]
|
|
561
|
+
optional :is_other, SignwellSDK::Internal::Type::Boolean
|
|
562
|
+
|
|
563
|
+
# @!method initialize(name:, api_id: nil, is_other: nil)
|
|
564
|
+
# Detailed option object
|
|
565
|
+
#
|
|
566
|
+
# @param name [String] Option display name
|
|
567
|
+
#
|
|
568
|
+
# @param api_id [String] Unique identifier for the option
|
|
569
|
+
#
|
|
570
|
+
# @param is_other [Boolean] Whether this is the special "Other" option
|
|
571
|
+
end
|
|
572
|
+
|
|
573
|
+
# @!method self.variants
|
|
574
|
+
# @return [Array(String, SignwellSDK::Models::V1::DocumentTemplateCreateParams::Field::Option::DetailedOption)]
|
|
575
|
+
end
|
|
576
|
+
|
|
577
|
+
# Varies according to the field type. Text fields accept strings or numbers. Date
|
|
578
|
+
# fields accept Iso8601 date strings. CheckBoxes accept booleans. Signature and
|
|
579
|
+
# Initials fields can't be signed through API requests. Autofill text fields
|
|
580
|
+
# accept strings or numbers.
|
|
581
|
+
#
|
|
582
|
+
# @see SignwellSDK::Models::V1::DocumentTemplateCreateParams::Field#value
|
|
583
|
+
module Value
|
|
584
|
+
extend SignwellSDK::Internal::Type::Union
|
|
585
|
+
|
|
586
|
+
variant String
|
|
587
|
+
|
|
588
|
+
variant SignwellSDK::Internal::Type::Boolean
|
|
589
|
+
|
|
590
|
+
variant Float
|
|
591
|
+
|
|
592
|
+
# @!method self.variants
|
|
593
|
+
# @return [Array(String, Boolean, Float)]
|
|
594
|
+
end
|
|
595
|
+
end
|
|
596
|
+
end
|
|
597
|
+
end
|
|
598
|
+
end
|
|
599
|
+
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module SignwellSDK
|
|
4
|
+
module Models
|
|
5
|
+
module V1
|
|
6
|
+
# @see SignwellSDK::Resources::V1::DocumentTemplates#delete
|
|
7
|
+
class DocumentTemplateDeleteParams < SignwellSDK::Internal::Type::BaseModel
|
|
8
|
+
extend SignwellSDK::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include SignwellSDK::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!method initialize(request_options: {})
|
|
12
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module SignwellSDK
|
|
4
|
+
module Models
|
|
5
|
+
module V1
|
|
6
|
+
# @see SignwellSDK::Resources::V1::DocumentTemplates#list
|
|
7
|
+
class DocumentTemplateListParams < SignwellSDK::Internal::Type::BaseModel
|
|
8
|
+
extend SignwellSDK::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include SignwellSDK::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute limit
|
|
12
|
+
# The number of documents to fetch. Defaults to 10, max is 50.
|
|
13
|
+
#
|
|
14
|
+
# @return [Integer, nil]
|
|
15
|
+
optional :limit, Integer
|
|
16
|
+
|
|
17
|
+
# @!attribute page
|
|
18
|
+
# The page number for pagination. Defaults to the first page.
|
|
19
|
+
#
|
|
20
|
+
# @return [Integer, nil]
|
|
21
|
+
optional :page, Integer
|
|
22
|
+
|
|
23
|
+
# @!method initialize(limit: nil, page: nil, request_options: {})
|
|
24
|
+
# @param limit [Integer] The number of documents to fetch. Defaults to 10, max is 50.
|
|
25
|
+
#
|
|
26
|
+
# @param page [Integer] The page number for pagination. Defaults to the first page.
|
|
27
|
+
#
|
|
28
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|