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,518 @@
|
|
|
1
|
+
module SignwellSDK
|
|
2
|
+
module Models
|
|
3
|
+
module V1
|
|
4
|
+
type document_create_from_template_response =
|
|
5
|
+
{
|
|
6
|
+
id: String,
|
|
7
|
+
test_mode: bool,
|
|
8
|
+
allow_decline: bool?,
|
|
9
|
+
allow_reassign: bool?,
|
|
10
|
+
api_application_id: String?,
|
|
11
|
+
apply_signing_order: bool,
|
|
12
|
+
archived: bool,
|
|
13
|
+
attachment_requests: ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::AttachmentRequest],
|
|
14
|
+
copied_contacts: ::Array[SignwellSDK::CopiedContactInfo],
|
|
15
|
+
created_at: Time,
|
|
16
|
+
custom_requester_email: String?,
|
|
17
|
+
custom_requester_name: String?,
|
|
18
|
+
decline_redirect_url: String?,
|
|
19
|
+
embedded: bool,
|
|
20
|
+
embedded_edit_url: String,
|
|
21
|
+
expires_in: Integer,
|
|
22
|
+
fields: ::Array[::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field]],
|
|
23
|
+
files: ::Array[SignwellSDK::FileInfo],
|
|
24
|
+
labels: ::Array[SignwellSDK::LabelInfo],
|
|
25
|
+
language: String,
|
|
26
|
+
message: String,
|
|
27
|
+
metadata: ::Hash[Symbol, String]?,
|
|
28
|
+
name: String,
|
|
29
|
+
recipients: ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Recipient],
|
|
30
|
+
redirect_url: String?,
|
|
31
|
+
reminders: bool,
|
|
32
|
+
requester_email_address: String,
|
|
33
|
+
status: String,
|
|
34
|
+
subject: String,
|
|
35
|
+
template_id: String,
|
|
36
|
+
template_ids: ::Array[String],
|
|
37
|
+
updated_at: Time
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
class DocumentCreateFromTemplateResponse < SignwellSDK::Internal::Type::BaseModel
|
|
41
|
+
attr_accessor id: String
|
|
42
|
+
|
|
43
|
+
attr_accessor test_mode: bool
|
|
44
|
+
|
|
45
|
+
attr_accessor allow_decline: bool?
|
|
46
|
+
|
|
47
|
+
attr_accessor allow_reassign: bool?
|
|
48
|
+
|
|
49
|
+
attr_accessor api_application_id: String?
|
|
50
|
+
|
|
51
|
+
attr_reader apply_signing_order: bool?
|
|
52
|
+
|
|
53
|
+
def apply_signing_order=: (bool) -> bool
|
|
54
|
+
|
|
55
|
+
attr_reader archived: bool?
|
|
56
|
+
|
|
57
|
+
def archived=: (bool) -> bool
|
|
58
|
+
|
|
59
|
+
attr_reader attachment_requests: ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::AttachmentRequest]?
|
|
60
|
+
|
|
61
|
+
def attachment_requests=: (
|
|
62
|
+
::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::AttachmentRequest]
|
|
63
|
+
) -> ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::AttachmentRequest]
|
|
64
|
+
|
|
65
|
+
attr_reader copied_contacts: ::Array[SignwellSDK::CopiedContactInfo]?
|
|
66
|
+
|
|
67
|
+
def copied_contacts=: (
|
|
68
|
+
::Array[SignwellSDK::CopiedContactInfo]
|
|
69
|
+
) -> ::Array[SignwellSDK::CopiedContactInfo]
|
|
70
|
+
|
|
71
|
+
attr_reader created_at: Time?
|
|
72
|
+
|
|
73
|
+
def created_at=: (Time) -> Time
|
|
74
|
+
|
|
75
|
+
attr_accessor custom_requester_email: String?
|
|
76
|
+
|
|
77
|
+
attr_accessor custom_requester_name: String?
|
|
78
|
+
|
|
79
|
+
attr_accessor decline_redirect_url: String?
|
|
80
|
+
|
|
81
|
+
attr_reader embedded: bool?
|
|
82
|
+
|
|
83
|
+
def embedded=: (bool) -> bool
|
|
84
|
+
|
|
85
|
+
attr_reader embedded_edit_url: String?
|
|
86
|
+
|
|
87
|
+
def embedded_edit_url=: (String) -> String
|
|
88
|
+
|
|
89
|
+
attr_reader expires_in: Integer?
|
|
90
|
+
|
|
91
|
+
def expires_in=: (Integer) -> Integer
|
|
92
|
+
|
|
93
|
+
attr_reader fields: ::Array[::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field]]?
|
|
94
|
+
|
|
95
|
+
def fields=: (
|
|
96
|
+
::Array[::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field]]
|
|
97
|
+
) -> ::Array[::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field]]
|
|
98
|
+
|
|
99
|
+
attr_reader files: ::Array[SignwellSDK::FileInfo]?
|
|
100
|
+
|
|
101
|
+
def files=: (
|
|
102
|
+
::Array[SignwellSDK::FileInfo]
|
|
103
|
+
) -> ::Array[SignwellSDK::FileInfo]
|
|
104
|
+
|
|
105
|
+
attr_reader labels: ::Array[SignwellSDK::LabelInfo]?
|
|
106
|
+
|
|
107
|
+
def labels=: (
|
|
108
|
+
::Array[SignwellSDK::LabelInfo]
|
|
109
|
+
) -> ::Array[SignwellSDK::LabelInfo]
|
|
110
|
+
|
|
111
|
+
attr_reader language: String?
|
|
112
|
+
|
|
113
|
+
def language=: (String) -> String
|
|
114
|
+
|
|
115
|
+
attr_reader message: String?
|
|
116
|
+
|
|
117
|
+
def message=: (String) -> String
|
|
118
|
+
|
|
119
|
+
attr_accessor metadata: ::Hash[Symbol, String]?
|
|
120
|
+
|
|
121
|
+
attr_reader name: String?
|
|
122
|
+
|
|
123
|
+
def name=: (String) -> String
|
|
124
|
+
|
|
125
|
+
attr_reader recipients: ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Recipient]?
|
|
126
|
+
|
|
127
|
+
def recipients=: (
|
|
128
|
+
::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Recipient]
|
|
129
|
+
) -> ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Recipient]
|
|
130
|
+
|
|
131
|
+
attr_accessor redirect_url: String?
|
|
132
|
+
|
|
133
|
+
attr_reader reminders: bool?
|
|
134
|
+
|
|
135
|
+
def reminders=: (bool) -> bool
|
|
136
|
+
|
|
137
|
+
attr_reader requester_email_address: String?
|
|
138
|
+
|
|
139
|
+
def requester_email_address=: (String) -> String
|
|
140
|
+
|
|
141
|
+
attr_reader status: String?
|
|
142
|
+
|
|
143
|
+
def status=: (String) -> String
|
|
144
|
+
|
|
145
|
+
attr_reader subject: String?
|
|
146
|
+
|
|
147
|
+
def subject=: (String) -> String
|
|
148
|
+
|
|
149
|
+
attr_reader template_id: String?
|
|
150
|
+
|
|
151
|
+
def template_id=: (String) -> String
|
|
152
|
+
|
|
153
|
+
attr_reader template_ids: ::Array[String]?
|
|
154
|
+
|
|
155
|
+
def template_ids=: (::Array[String]) -> ::Array[String]
|
|
156
|
+
|
|
157
|
+
attr_reader updated_at: Time?
|
|
158
|
+
|
|
159
|
+
def updated_at=: (Time) -> Time
|
|
160
|
+
|
|
161
|
+
def initialize: (
|
|
162
|
+
id: String,
|
|
163
|
+
test_mode: bool,
|
|
164
|
+
?allow_decline: bool?,
|
|
165
|
+
?allow_reassign: bool?,
|
|
166
|
+
?api_application_id: String?,
|
|
167
|
+
?apply_signing_order: bool,
|
|
168
|
+
?archived: bool,
|
|
169
|
+
?attachment_requests: ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::AttachmentRequest],
|
|
170
|
+
?copied_contacts: ::Array[SignwellSDK::CopiedContactInfo],
|
|
171
|
+
?created_at: Time,
|
|
172
|
+
?custom_requester_email: String?,
|
|
173
|
+
?custom_requester_name: String?,
|
|
174
|
+
?decline_redirect_url: String?,
|
|
175
|
+
?embedded: bool,
|
|
176
|
+
?embedded_edit_url: String,
|
|
177
|
+
?expires_in: Integer,
|
|
178
|
+
?fields: ::Array[::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field]],
|
|
179
|
+
?files: ::Array[SignwellSDK::FileInfo],
|
|
180
|
+
?labels: ::Array[SignwellSDK::LabelInfo],
|
|
181
|
+
?language: String,
|
|
182
|
+
?message: String,
|
|
183
|
+
?metadata: ::Hash[Symbol, String]?,
|
|
184
|
+
?name: String,
|
|
185
|
+
?recipients: ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Recipient],
|
|
186
|
+
?redirect_url: String?,
|
|
187
|
+
?reminders: bool,
|
|
188
|
+
?requester_email_address: String,
|
|
189
|
+
?status: String,
|
|
190
|
+
?subject: String,
|
|
191
|
+
?template_id: String,
|
|
192
|
+
?template_ids: ::Array[String],
|
|
193
|
+
?updated_at: Time
|
|
194
|
+
) -> void
|
|
195
|
+
|
|
196
|
+
def to_hash: -> {
|
|
197
|
+
id: String,
|
|
198
|
+
test_mode: bool,
|
|
199
|
+
allow_decline: bool?,
|
|
200
|
+
allow_reassign: bool?,
|
|
201
|
+
api_application_id: String?,
|
|
202
|
+
apply_signing_order: bool,
|
|
203
|
+
archived: bool,
|
|
204
|
+
attachment_requests: ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::AttachmentRequest],
|
|
205
|
+
copied_contacts: ::Array[SignwellSDK::CopiedContactInfo],
|
|
206
|
+
created_at: Time,
|
|
207
|
+
custom_requester_email: String?,
|
|
208
|
+
custom_requester_name: String?,
|
|
209
|
+
decline_redirect_url: String?,
|
|
210
|
+
embedded: bool,
|
|
211
|
+
embedded_edit_url: String,
|
|
212
|
+
expires_in: Integer,
|
|
213
|
+
fields: ::Array[::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field]],
|
|
214
|
+
files: ::Array[SignwellSDK::FileInfo],
|
|
215
|
+
labels: ::Array[SignwellSDK::LabelInfo],
|
|
216
|
+
language: String,
|
|
217
|
+
message: String,
|
|
218
|
+
metadata: ::Hash[Symbol, String]?,
|
|
219
|
+
name: String,
|
|
220
|
+
recipients: ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Recipient],
|
|
221
|
+
redirect_url: String?,
|
|
222
|
+
reminders: bool,
|
|
223
|
+
requester_email_address: String,
|
|
224
|
+
status: String,
|
|
225
|
+
subject: String,
|
|
226
|
+
template_id: String,
|
|
227
|
+
template_ids: ::Array[String],
|
|
228
|
+
updated_at: Time
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
type attachment_request =
|
|
232
|
+
{ name: String, recipient_id: String, required: bool }
|
|
233
|
+
|
|
234
|
+
class AttachmentRequest < SignwellSDK::Internal::Type::BaseModel
|
|
235
|
+
attr_accessor name: String
|
|
236
|
+
|
|
237
|
+
attr_accessor recipient_id: String
|
|
238
|
+
|
|
239
|
+
attr_reader required: bool?
|
|
240
|
+
|
|
241
|
+
def required=: (bool) -> bool
|
|
242
|
+
|
|
243
|
+
def initialize: (
|
|
244
|
+
name: String,
|
|
245
|
+
recipient_id: String,
|
|
246
|
+
?required: bool
|
|
247
|
+
) -> void
|
|
248
|
+
|
|
249
|
+
def to_hash: -> { name: String, recipient_id: String, required: bool }
|
|
250
|
+
end
|
|
251
|
+
|
|
252
|
+
type field =
|
|
253
|
+
{
|
|
254
|
+
page: Integer,
|
|
255
|
+
x: Float,
|
|
256
|
+
y_: Float,
|
|
257
|
+
allow_other: bool,
|
|
258
|
+
api_id: String,
|
|
259
|
+
date_format: SignwellSDK::Models::date_format,
|
|
260
|
+
default_option: String,
|
|
261
|
+
fixed_width: bool,
|
|
262
|
+
height: String,
|
|
263
|
+
label: String,
|
|
264
|
+
lock_sign_date: bool,
|
|
265
|
+
name: String?,
|
|
266
|
+
options: ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::Option],
|
|
267
|
+
placeholder_name: String,
|
|
268
|
+
recipient: SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::Recipient,
|
|
269
|
+
recipient_id: String?,
|
|
270
|
+
required: bool,
|
|
271
|
+
signing_elements_group_id: String,
|
|
272
|
+
type: SignwellSDK::Models::field_type,
|
|
273
|
+
validation: SignwellSDK::Models::text_validation,
|
|
274
|
+
value: SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::value?,
|
|
275
|
+
width: String
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
class Field < SignwellSDK::Internal::Type::BaseModel
|
|
279
|
+
attr_accessor page: Integer
|
|
280
|
+
|
|
281
|
+
attr_accessor x: Float
|
|
282
|
+
|
|
283
|
+
attr_accessor y_: Float
|
|
284
|
+
|
|
285
|
+
attr_reader allow_other: bool?
|
|
286
|
+
|
|
287
|
+
def allow_other=: (bool) -> bool
|
|
288
|
+
|
|
289
|
+
attr_reader api_id: String?
|
|
290
|
+
|
|
291
|
+
def api_id=: (String) -> String
|
|
292
|
+
|
|
293
|
+
attr_reader date_format: SignwellSDK::Models::date_format?
|
|
294
|
+
|
|
295
|
+
def date_format=: (
|
|
296
|
+
SignwellSDK::Models::date_format
|
|
297
|
+
) -> SignwellSDK::Models::date_format
|
|
298
|
+
|
|
299
|
+
attr_reader default_option: String?
|
|
300
|
+
|
|
301
|
+
def default_option=: (String) -> String
|
|
302
|
+
|
|
303
|
+
attr_reader fixed_width: bool?
|
|
304
|
+
|
|
305
|
+
def fixed_width=: (bool) -> bool
|
|
306
|
+
|
|
307
|
+
attr_reader height: String?
|
|
308
|
+
|
|
309
|
+
def height=: (String) -> String
|
|
310
|
+
|
|
311
|
+
attr_reader label: String?
|
|
312
|
+
|
|
313
|
+
def label=: (String) -> String
|
|
314
|
+
|
|
315
|
+
attr_reader lock_sign_date: bool?
|
|
316
|
+
|
|
317
|
+
def lock_sign_date=: (bool) -> bool
|
|
318
|
+
|
|
319
|
+
attr_accessor name: String?
|
|
320
|
+
|
|
321
|
+
attr_reader options: ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::Option]?
|
|
322
|
+
|
|
323
|
+
def options=: (
|
|
324
|
+
::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::Option]
|
|
325
|
+
) -> ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::Option]
|
|
326
|
+
|
|
327
|
+
attr_reader placeholder_name: String?
|
|
328
|
+
|
|
329
|
+
def placeholder_name=: (String) -> String
|
|
330
|
+
|
|
331
|
+
attr_reader recipient: SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::Recipient?
|
|
332
|
+
|
|
333
|
+
def recipient=: (
|
|
334
|
+
SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::Recipient
|
|
335
|
+
) -> SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::Recipient
|
|
336
|
+
|
|
337
|
+
attr_accessor recipient_id: String?
|
|
338
|
+
|
|
339
|
+
attr_reader required: bool?
|
|
340
|
+
|
|
341
|
+
def required=: (bool) -> bool
|
|
342
|
+
|
|
343
|
+
attr_reader signing_elements_group_id: String?
|
|
344
|
+
|
|
345
|
+
def signing_elements_group_id=: (String) -> String
|
|
346
|
+
|
|
347
|
+
attr_reader type: SignwellSDK::Models::field_type?
|
|
348
|
+
|
|
349
|
+
def type=: (
|
|
350
|
+
SignwellSDK::Models::field_type
|
|
351
|
+
) -> SignwellSDK::Models::field_type
|
|
352
|
+
|
|
353
|
+
attr_reader validation: SignwellSDK::Models::text_validation?
|
|
354
|
+
|
|
355
|
+
def validation=: (
|
|
356
|
+
SignwellSDK::Models::text_validation
|
|
357
|
+
) -> SignwellSDK::Models::text_validation
|
|
358
|
+
|
|
359
|
+
attr_accessor value: SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::value?
|
|
360
|
+
|
|
361
|
+
attr_reader width: String?
|
|
362
|
+
|
|
363
|
+
def width=: (String) -> String
|
|
364
|
+
|
|
365
|
+
def initialize: (
|
|
366
|
+
page: Integer,
|
|
367
|
+
x: Float,
|
|
368
|
+
y_: Float,
|
|
369
|
+
?allow_other: bool,
|
|
370
|
+
?api_id: String,
|
|
371
|
+
?date_format: SignwellSDK::Models::date_format,
|
|
372
|
+
?default_option: String,
|
|
373
|
+
?fixed_width: bool,
|
|
374
|
+
?height: String,
|
|
375
|
+
?label: String,
|
|
376
|
+
?lock_sign_date: bool,
|
|
377
|
+
?name: String?,
|
|
378
|
+
?options: ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::Option],
|
|
379
|
+
?placeholder_name: String,
|
|
380
|
+
?recipient: SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::Recipient,
|
|
381
|
+
?recipient_id: String?,
|
|
382
|
+
?required: bool,
|
|
383
|
+
?signing_elements_group_id: String,
|
|
384
|
+
?type: SignwellSDK::Models::field_type,
|
|
385
|
+
?validation: SignwellSDK::Models::text_validation,
|
|
386
|
+
?value: SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::value?,
|
|
387
|
+
?width: String
|
|
388
|
+
) -> void
|
|
389
|
+
|
|
390
|
+
def to_hash: -> {
|
|
391
|
+
page: Integer,
|
|
392
|
+
x: Float,
|
|
393
|
+
y_: Float,
|
|
394
|
+
allow_other: bool,
|
|
395
|
+
api_id: String,
|
|
396
|
+
date_format: SignwellSDK::Models::date_format,
|
|
397
|
+
default_option: String,
|
|
398
|
+
fixed_width: bool,
|
|
399
|
+
height: String,
|
|
400
|
+
label: String,
|
|
401
|
+
lock_sign_date: bool,
|
|
402
|
+
name: String?,
|
|
403
|
+
options: ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::Option],
|
|
404
|
+
placeholder_name: String,
|
|
405
|
+
recipient: SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::Recipient,
|
|
406
|
+
recipient_id: String?,
|
|
407
|
+
required: bool,
|
|
408
|
+
signing_elements_group_id: String,
|
|
409
|
+
type: SignwellSDK::Models::field_type,
|
|
410
|
+
validation: SignwellSDK::Models::text_validation,
|
|
411
|
+
value: SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::value?,
|
|
412
|
+
width: String
|
|
413
|
+
}
|
|
414
|
+
|
|
415
|
+
type option = { api_id: String, is_other: bool, name: String }
|
|
416
|
+
|
|
417
|
+
class Option < SignwellSDK::Internal::Type::BaseModel
|
|
418
|
+
attr_reader api_id: String?
|
|
419
|
+
|
|
420
|
+
def api_id=: (String) -> String
|
|
421
|
+
|
|
422
|
+
attr_reader is_other: bool?
|
|
423
|
+
|
|
424
|
+
def is_other=: (bool) -> bool
|
|
425
|
+
|
|
426
|
+
attr_reader name: String?
|
|
427
|
+
|
|
428
|
+
def name=: (String) -> String
|
|
429
|
+
|
|
430
|
+
def initialize: (
|
|
431
|
+
?api_id: String,
|
|
432
|
+
?is_other: bool,
|
|
433
|
+
?name: String
|
|
434
|
+
) -> void
|
|
435
|
+
|
|
436
|
+
def to_hash: -> { api_id: String, is_other: bool, name: String }
|
|
437
|
+
end
|
|
438
|
+
|
|
439
|
+
type recipient = { email: String, name: String, role: String }
|
|
440
|
+
|
|
441
|
+
class Recipient < SignwellSDK::Internal::Type::BaseModel
|
|
442
|
+
attr_accessor email: String
|
|
443
|
+
|
|
444
|
+
attr_accessor name: String
|
|
445
|
+
|
|
446
|
+
attr_reader role: String?
|
|
447
|
+
|
|
448
|
+
def role=: (String) -> String
|
|
449
|
+
|
|
450
|
+
def initialize: (email: String, name: String, ?role: String) -> void
|
|
451
|
+
|
|
452
|
+
def to_hash: -> { email: String, name: String, role: String }
|
|
453
|
+
end
|
|
454
|
+
|
|
455
|
+
type value = String | bool | Float
|
|
456
|
+
|
|
457
|
+
module Value
|
|
458
|
+
extend SignwellSDK::Internal::Type::Union
|
|
459
|
+
|
|
460
|
+
def self?.variants: -> ::Array[SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse::Field::value]
|
|
461
|
+
end
|
|
462
|
+
end
|
|
463
|
+
|
|
464
|
+
type recipient =
|
|
465
|
+
{
|
|
466
|
+
email: String,
|
|
467
|
+
attachment_requests: ::Array[SignwellSDK::AttachmentRequestInfo],
|
|
468
|
+
name: String,
|
|
469
|
+
passcode: String?,
|
|
470
|
+
role: String,
|
|
471
|
+
status: String
|
|
472
|
+
}
|
|
473
|
+
|
|
474
|
+
class Recipient < SignwellSDK::Internal::Type::BaseModel
|
|
475
|
+
attr_accessor email: String
|
|
476
|
+
|
|
477
|
+
attr_reader attachment_requests: ::Array[SignwellSDK::AttachmentRequestInfo]?
|
|
478
|
+
|
|
479
|
+
def attachment_requests=: (
|
|
480
|
+
::Array[SignwellSDK::AttachmentRequestInfo]
|
|
481
|
+
) -> ::Array[SignwellSDK::AttachmentRequestInfo]
|
|
482
|
+
|
|
483
|
+
attr_reader name: String?
|
|
484
|
+
|
|
485
|
+
def name=: (String) -> String
|
|
486
|
+
|
|
487
|
+
attr_accessor passcode: String?
|
|
488
|
+
|
|
489
|
+
attr_reader role: String?
|
|
490
|
+
|
|
491
|
+
def role=: (String) -> String
|
|
492
|
+
|
|
493
|
+
attr_reader status: String?
|
|
494
|
+
|
|
495
|
+
def status=: (String) -> String
|
|
496
|
+
|
|
497
|
+
def initialize: (
|
|
498
|
+
email: String,
|
|
499
|
+
?attachment_requests: ::Array[SignwellSDK::AttachmentRequestInfo],
|
|
500
|
+
?name: String,
|
|
501
|
+
?passcode: String?,
|
|
502
|
+
?role: String,
|
|
503
|
+
?status: String
|
|
504
|
+
) -> void
|
|
505
|
+
|
|
506
|
+
def to_hash: -> {
|
|
507
|
+
email: String,
|
|
508
|
+
attachment_requests: ::Array[SignwellSDK::AttachmentRequestInfo],
|
|
509
|
+
name: String,
|
|
510
|
+
passcode: String?,
|
|
511
|
+
role: String,
|
|
512
|
+
status: String
|
|
513
|
+
}
|
|
514
|
+
end
|
|
515
|
+
end
|
|
516
|
+
end
|
|
517
|
+
end
|
|
518
|
+
end
|