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,372 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module SignwellSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class V1
|
|
6
|
+
class Documents
|
|
7
|
+
# Some parameter documentations has been truncated, see
|
|
8
|
+
# {SignwellSDK::Models::V1::DocumentCreateParams} for more details.
|
|
9
|
+
#
|
|
10
|
+
# Creates and optionally sends a new document for signing. If `draft` is set to
|
|
11
|
+
# true the document will not be sent.
|
|
12
|
+
#
|
|
13
|
+
# @overload create(files:, recipients:, allow_decline: nil, allow_reassign: nil, api_application_id: nil, apply_signing_order: nil, attachment_requests: nil, checkbox_groups: nil, copied_contacts: nil, custom_requester_email: nil, custom_requester_name: nil, decline_redirect_url: nil, draft: nil, embedded_signing: nil, embedded_signing_notifications: nil, expires_in: nil, fields: nil, labels: nil, language: nil, message: nil, metadata: nil, name: nil, redirect_url: nil, reminders: nil, subject: nil, test_mode: nil, text_tags: nil, with_signature_page: nil, request_options: {})
|
|
14
|
+
#
|
|
15
|
+
# @param files [Array<SignwellSDK::Models::V1::DocumentFile>] Document files can be uploaded by specifying a file URL or base64 string. Either
|
|
16
|
+
#
|
|
17
|
+
# @param recipients [Array<SignwellSDK::Models::V1::DocumentCreateParams::Recipient>] Document recipients are people that must complete and/or sign a document.
|
|
18
|
+
#
|
|
19
|
+
# @param allow_decline [Boolean] Whether to allow recipients the option to decline signing a document. If multipl
|
|
20
|
+
#
|
|
21
|
+
# @param allow_reassign [Boolean] In some cases a signer is not the right person to sign and may need to reassign
|
|
22
|
+
#
|
|
23
|
+
# @param api_application_id [String] Unique identifier for API Application settings to use. API Applications are opti
|
|
24
|
+
#
|
|
25
|
+
# @param apply_signing_order [Boolean] When set to `true` recipients will sign one at a time in the order of the `recip
|
|
26
|
+
#
|
|
27
|
+
# @param attachment_requests [Array<SignwellSDK::Models::V1::AttachmentRequest>] Attachments that a recipient must upload to complete the signing process. Attach
|
|
28
|
+
#
|
|
29
|
+
# @param checkbox_groups [Array<SignwellSDK::Models::V1::CheckboxGroup>] Checkbox fields that are placed on a document can be grouped with selection requ
|
|
30
|
+
#
|
|
31
|
+
# @param copied_contacts [Array<SignwellSDK::Models::V1::CopiedContact>] Copied contacts are emailed the final document once it has been completed by all
|
|
32
|
+
#
|
|
33
|
+
# @param custom_requester_email [String] Sets the custom requester email for the document. When set, this is the email us
|
|
34
|
+
#
|
|
35
|
+
# @param custom_requester_name [String] Sets the custom requester name for the document. When set, this is the name used
|
|
36
|
+
#
|
|
37
|
+
# @param decline_redirect_url [String] A URL that recipients are redirected to if the document is declined.
|
|
38
|
+
#
|
|
39
|
+
# @param draft [Boolean] Whether the document can still be updated before sending a signature request. If
|
|
40
|
+
#
|
|
41
|
+
# @param embedded_signing [Boolean] When set to `true` it enables embedded signing in your website/web application.
|
|
42
|
+
#
|
|
43
|
+
# @param embedded_signing_notifications [Boolean] On embedding signing, document owners (and CC'd contacts) do not get a notificat
|
|
44
|
+
#
|
|
45
|
+
# @param expires_in [Integer] Number of days before the signature request expires. Defaults to the account exp
|
|
46
|
+
#
|
|
47
|
+
# @param fields [Array<Array<SignwellSDK::Models::V1::DocumentCreateParams::Field>>] Document fields placed on a document for collecting data or signatures from reci
|
|
48
|
+
#
|
|
49
|
+
# @param labels [Array<SignwellSDK::Models::V1::Label>] Labels can be used to organize documents in a way that can make it easy to find
|
|
50
|
+
#
|
|
51
|
+
# @param language [String] Sets the language for all recipients on the document and updates all recipient s
|
|
52
|
+
#
|
|
53
|
+
# @param message [String] Email message for the signature request that recipients will see. Defaults to th
|
|
54
|
+
#
|
|
55
|
+
# @param metadata [Hash{Symbol=>String}] Optional key-value data that can be associated with the document. If set, will b
|
|
56
|
+
#
|
|
57
|
+
# @param name [String] The name of the document.
|
|
58
|
+
#
|
|
59
|
+
# @param redirect_url [String] A URL that recipients are redirected to after successfully signing a document.
|
|
60
|
+
#
|
|
61
|
+
# @param reminders [Boolean] Whether to send signing reminders to recipients. Reminders are sent on day 3, da
|
|
62
|
+
#
|
|
63
|
+
# @param subject [String] Email subject for the signature request that recipients will see. Defaults to th
|
|
64
|
+
#
|
|
65
|
+
# @param test_mode [Boolean] Set to `true` to enable Test Mode. Documents created with Test Mode do not count
|
|
66
|
+
#
|
|
67
|
+
# @param text_tags [Boolean] An alternative way (if you can’t use the recommended way) of placing fields in s
|
|
68
|
+
#
|
|
69
|
+
# @param with_signature_page [Boolean] When set to `true` the document will have a signature page added to the end, and
|
|
70
|
+
#
|
|
71
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
72
|
+
#
|
|
73
|
+
# @return [SignwellSDK::Models::V1::Document]
|
|
74
|
+
#
|
|
75
|
+
# @see SignwellSDK::Models::V1::DocumentCreateParams
|
|
76
|
+
def create(params)
|
|
77
|
+
parsed, options = SignwellSDK::V1::DocumentCreateParams.dump_request(params)
|
|
78
|
+
@client.request(
|
|
79
|
+
method: :post,
|
|
80
|
+
path: "api/v1/documents",
|
|
81
|
+
body: parsed,
|
|
82
|
+
model: SignwellSDK::V1::Document,
|
|
83
|
+
options: options
|
|
84
|
+
)
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# Returns a document and all associated document data. Supply the unique document
|
|
88
|
+
# ID from either a document creation request or Document page URL.
|
|
89
|
+
#
|
|
90
|
+
# @overload retrieve(id, request_options: {})
|
|
91
|
+
#
|
|
92
|
+
# @param id [String] Unique identifier for a document.
|
|
93
|
+
#
|
|
94
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
95
|
+
#
|
|
96
|
+
# @return [SignwellSDK::Models::V1::Document]
|
|
97
|
+
#
|
|
98
|
+
# @see SignwellSDK::Models::V1::DocumentRetrieveParams
|
|
99
|
+
def retrieve(id, params = {})
|
|
100
|
+
@client.request(
|
|
101
|
+
method: :get,
|
|
102
|
+
path: ["api/v1/documents/%1$s", id],
|
|
103
|
+
model: SignwellSDK::V1::Document,
|
|
104
|
+
options: params[:request_options]
|
|
105
|
+
)
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
# Returns a paginated list of documents for the authenticated account.
|
|
109
|
+
#
|
|
110
|
+
# @overload list(limit: nil, page: nil, request_options: {})
|
|
111
|
+
#
|
|
112
|
+
# @param limit [Integer] The number of documents to fetch. Defaults to 10, max is 50.
|
|
113
|
+
#
|
|
114
|
+
# @param page [Integer] The page number for pagination. Defaults to the first page.
|
|
115
|
+
#
|
|
116
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
117
|
+
#
|
|
118
|
+
# @return [SignwellSDK::Models::V1::DocumentListResponse]
|
|
119
|
+
#
|
|
120
|
+
# @see SignwellSDK::Models::V1::DocumentListParams
|
|
121
|
+
def list(params = {})
|
|
122
|
+
parsed, options = SignwellSDK::V1::DocumentListParams.dump_request(params)
|
|
123
|
+
@client.request(
|
|
124
|
+
method: :get,
|
|
125
|
+
path: "api/v1/documents",
|
|
126
|
+
query: parsed,
|
|
127
|
+
model: SignwellSDK::Models::V1::DocumentListResponse,
|
|
128
|
+
options: options
|
|
129
|
+
)
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
# Deletes a document. Deleting a document will also cancel document signing (if in
|
|
133
|
+
# progress). Supply the unique document ID from either a Create Document request
|
|
134
|
+
# or document page URL.
|
|
135
|
+
#
|
|
136
|
+
# @overload delete(id, request_options: {})
|
|
137
|
+
#
|
|
138
|
+
# @param id [String] Unique identifier for a document.
|
|
139
|
+
#
|
|
140
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
141
|
+
#
|
|
142
|
+
# @return [nil]
|
|
143
|
+
#
|
|
144
|
+
# @see SignwellSDK::Models::V1::DocumentDeleteParams
|
|
145
|
+
def delete(id, params = {})
|
|
146
|
+
@client.request(
|
|
147
|
+
method: :delete,
|
|
148
|
+
path: ["api/v1/documents/%1$s", id],
|
|
149
|
+
model: NilClass,
|
|
150
|
+
options: params[:request_options]
|
|
151
|
+
)
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
# Some parameter documentations has been truncated, see
|
|
155
|
+
# {SignwellSDK::Models::V1::DocumentCreateFromTemplateParams} for more details.
|
|
156
|
+
#
|
|
157
|
+
# Creates and optionally sends a new document for signing. If `draft` is set to
|
|
158
|
+
# true the document will not be sent.
|
|
159
|
+
#
|
|
160
|
+
# @overload create_from_template(recipients:, allow_decline: nil, allow_reassign: nil, api_application_id: nil, apply_signing_order: nil, attachment_requests: nil, checkbox_groups: nil, copied_contacts: nil, custom_requester_email: nil, custom_requester_name: nil, decline_redirect_url: nil, draft: nil, embedded_signing: nil, embedded_signing_notifications: nil, expires_in: nil, fields: nil, files: nil, labels: nil, language: nil, message: nil, metadata: nil, name: nil, redirect_url: nil, reminders: nil, subject: nil, template_fields: nil, template_id: nil, template_ids: nil, test_mode: nil, text_tags: nil, with_signature_page: nil, request_options: {})
|
|
161
|
+
#
|
|
162
|
+
# @param recipients [Array<SignwellSDK::Models::V1::DocumentCreateFromTemplateParams::Recipient>] Document recipients are people that must complete and/or sign a document. Recipi
|
|
163
|
+
#
|
|
164
|
+
# @param allow_decline [Boolean] Whether to allow recipients the option to decline signing a document. If multipl
|
|
165
|
+
#
|
|
166
|
+
# @param allow_reassign [Boolean] In some cases a signer is not the right person to sign and may need to reassign
|
|
167
|
+
#
|
|
168
|
+
# @param api_application_id [String] Unique identifier for API Application settings to use. API Applications are opti
|
|
169
|
+
#
|
|
170
|
+
# @param apply_signing_order [Boolean] When set to `true` recipients will sign one at a time in the order of the `recip
|
|
171
|
+
#
|
|
172
|
+
# @param attachment_requests [Array<SignwellSDK::Models::V1::AttachmentRequest>] Attachments that a recipient must upload to complete the signing process. Attach
|
|
173
|
+
#
|
|
174
|
+
# @param checkbox_groups [Array<SignwellSDK::Models::V1::CheckboxGroup>] Checkbox fields that are placed on a document can be grouped with selection requ
|
|
175
|
+
#
|
|
176
|
+
# @param copied_contacts [Array<SignwellSDK::Models::V1::CopiedContact>] Copied contacts are emailed the final document once it has been completed by all
|
|
177
|
+
#
|
|
178
|
+
# @param custom_requester_email [String] Sets the custom requester email for the document. When set, this is the email us
|
|
179
|
+
#
|
|
180
|
+
# @param custom_requester_name [String] Sets the custom requester name for the document. When set, this is the name used
|
|
181
|
+
#
|
|
182
|
+
# @param decline_redirect_url [String] A URL that recipients are redirected to if the document is declined.
|
|
183
|
+
#
|
|
184
|
+
# @param draft [Boolean] Whether the document can still be updated before sending a signature request. If
|
|
185
|
+
#
|
|
186
|
+
# @param embedded_signing [Boolean] When set to `true` it enables embedded signing in your website/web application.
|
|
187
|
+
#
|
|
188
|
+
# @param embedded_signing_notifications [Boolean] On embedding signing, document owners (and CC'd contacts) do not get a notificat
|
|
189
|
+
#
|
|
190
|
+
# @param expires_in [Integer] Number of days before the signature request expires. Defaults to the account exp
|
|
191
|
+
#
|
|
192
|
+
# @param fields [Array<Array<SignwellSDK::Models::V1::DocumentCreateFromTemplateParams::Field>>] Fields to be added to any appended files (not existing files). Document fields p
|
|
193
|
+
#
|
|
194
|
+
# @param files [Array<SignwellSDK::Models::V1::DocumentCreateFromTemplateParams::File>]
|
|
195
|
+
#
|
|
196
|
+
# @param labels [Array<SignwellSDK::Models::V1::Label>] Labels can be used to organize documents in a way that can make it easy to find
|
|
197
|
+
#
|
|
198
|
+
# @param language [String] Sets the language for all recipients on the document and updates all recipient s
|
|
199
|
+
#
|
|
200
|
+
# @param message [String] Email message for the signature request that recipients will see. Defaults to th
|
|
201
|
+
#
|
|
202
|
+
# @param metadata [Hash{Symbol=>String}] Optional key-value data that can be associated with the document. If set, will b
|
|
203
|
+
#
|
|
204
|
+
# @param name [String] The name of the document.
|
|
205
|
+
#
|
|
206
|
+
# @param redirect_url [String] A URL that recipients are redirected to after successfully signing a document.
|
|
207
|
+
#
|
|
208
|
+
# @param reminders [Boolean] Whether to send signing reminders to recipients. Reminders are sent on day 3, da
|
|
209
|
+
#
|
|
210
|
+
# @param subject [String] Email subject for the signature request that recipients will see. Defaults to th
|
|
211
|
+
#
|
|
212
|
+
# @param template_fields [Array<SignwellSDK::Models::V1::DocumentCreateFromTemplateParams::TemplateField>] Fields of your template(s) that you can prepopulate with values. Signature and I
|
|
213
|
+
#
|
|
214
|
+
# @param template_id [String] Use when you have to create a document from a single template. Either
|
|
215
|
+
# :template\_
|
|
216
|
+
#
|
|
217
|
+
# @param template_ids [Array<String>] Use when you have to create a document from multiple templates. Either :template
|
|
218
|
+
#
|
|
219
|
+
# @param test_mode [Boolean] Set to `true` to enable Test Mode. Documents created with Test Mode do not count
|
|
220
|
+
#
|
|
221
|
+
# @param text_tags [Boolean] An alternative way (if you can’t use the recommended way) of placing fields in s
|
|
222
|
+
#
|
|
223
|
+
# @param with_signature_page [Boolean] When set to `true` the document will have a signature page added to the end, and
|
|
224
|
+
#
|
|
225
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
226
|
+
#
|
|
227
|
+
# @return [SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse]
|
|
228
|
+
#
|
|
229
|
+
# @see SignwellSDK::Models::V1::DocumentCreateFromTemplateParams
|
|
230
|
+
def create_from_template(params)
|
|
231
|
+
parsed, options = SignwellSDK::V1::DocumentCreateFromTemplateParams.dump_request(params)
|
|
232
|
+
@client.request(
|
|
233
|
+
method: :post,
|
|
234
|
+
path: "api/v1/document_templates/documents",
|
|
235
|
+
body: parsed,
|
|
236
|
+
model: SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse,
|
|
237
|
+
options: options
|
|
238
|
+
)
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
# Some parameter documentations has been truncated, see
|
|
242
|
+
# {SignwellSDK::Models::V1::DocumentRemindParams} for more details.
|
|
243
|
+
#
|
|
244
|
+
# Sends a reminder email to recipients that have not signed yet.
|
|
245
|
+
#
|
|
246
|
+
# @overload remind(id, recipients: nil, request_options: {})
|
|
247
|
+
#
|
|
248
|
+
# @param id [String] Unique identifier for a document.
|
|
249
|
+
#
|
|
250
|
+
# @param recipients [Array<SignwellSDK::Models::V1::DocumentRemindParams::Recipient>] Optional list if recipients within the document to send a reminder email to. If
|
|
251
|
+
#
|
|
252
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
253
|
+
#
|
|
254
|
+
# @return [nil]
|
|
255
|
+
#
|
|
256
|
+
# @see SignwellSDK::Models::V1::DocumentRemindParams
|
|
257
|
+
def remind(id, params = {})
|
|
258
|
+
parsed, options = SignwellSDK::V1::DocumentRemindParams.dump_request(params)
|
|
259
|
+
@client.request(
|
|
260
|
+
method: :post,
|
|
261
|
+
path: ["api/v1/documents/%1$s/remind", id],
|
|
262
|
+
body: parsed,
|
|
263
|
+
model: NilClass,
|
|
264
|
+
options: options
|
|
265
|
+
)
|
|
266
|
+
end
|
|
267
|
+
|
|
268
|
+
# Some parameter documentations has been truncated, see
|
|
269
|
+
# {SignwellSDK::Models::V1::DocumentRetrieveCompletedPdfParams} for more details.
|
|
270
|
+
#
|
|
271
|
+
# Gets a completed document PDF or ZIP file. Supply the unique document ID from
|
|
272
|
+
# either a document creation request or document page URL.
|
|
273
|
+
#
|
|
274
|
+
# @overload retrieve_completed_pdf(id, audit_page: nil, file_format: nil, url_only: nil, request_options: {})
|
|
275
|
+
#
|
|
276
|
+
# @param id [String] Unique identifier for a completed document.
|
|
277
|
+
#
|
|
278
|
+
# @param audit_page [Boolean] Whether to include the audit page as part of the document. Defaults to `true`
|
|
279
|
+
#
|
|
280
|
+
# @param file_format [Symbol, SignwellSDK::Models::V1::DocumentRetrieveCompletedPdfParams::FileFormat] Format of the file to be downloaded. Supported formats are 'pdf' and 'zip'.
|
|
281
|
+
#
|
|
282
|
+
# @param url_only [Boolean] Whether to return the URL of the completed PDF or the actual PDF content. Defaul
|
|
283
|
+
#
|
|
284
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
285
|
+
#
|
|
286
|
+
# @return [SignwellSDK::Models::V1::DocumentRetrieveCompletedPdfResponse]
|
|
287
|
+
#
|
|
288
|
+
# @see SignwellSDK::Models::V1::DocumentRetrieveCompletedPdfParams
|
|
289
|
+
def retrieve_completed_pdf(id, params = {})
|
|
290
|
+
parsed, options = SignwellSDK::V1::DocumentRetrieveCompletedPdfParams.dump_request(params)
|
|
291
|
+
@client.request(
|
|
292
|
+
method: :get,
|
|
293
|
+
path: ["api/v1/documents/%1$s/completed_pdf", id],
|
|
294
|
+
query: parsed,
|
|
295
|
+
model: SignwellSDK::Models::V1::DocumentRetrieveCompletedPdfResponse,
|
|
296
|
+
options: options
|
|
297
|
+
)
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
# Some parameter documentations has been truncated, see
|
|
301
|
+
# {SignwellSDK::Models::V1::DocumentSendParams} for more details.
|
|
302
|
+
#
|
|
303
|
+
# Updates a draft document and sends it to be signed by recipients.
|
|
304
|
+
#
|
|
305
|
+
# @overload send_(id, allow_decline: nil, allow_reassign: nil, api_application_id: nil, apply_signing_order: nil, checkbox_groups: nil, custom_requester_email: nil, custom_requester_name: nil, decline_redirect_url: nil, embedded_signing: nil, embedded_signing_notifications: nil, expires_in: nil, labels: nil, message: nil, metadata: nil, name: nil, redirect_url: nil, reminders: nil, subject: nil, test_mode: nil, request_options: {})
|
|
306
|
+
#
|
|
307
|
+
# @param id [String] Unique identifier for a document.
|
|
308
|
+
#
|
|
309
|
+
# @param allow_decline [Boolean] Whether to allow recipients the option to decline signing a document. If multipl
|
|
310
|
+
#
|
|
311
|
+
# @param allow_reassign [Boolean] In some cases a signer is not the right person to sign and may need to reassign
|
|
312
|
+
#
|
|
313
|
+
# @param api_application_id [String] Unique identifier for API Application settings to use. API Applications are opti
|
|
314
|
+
#
|
|
315
|
+
# @param apply_signing_order [Boolean] When set to `true` recipients will sign one at a time in the order of the `recip
|
|
316
|
+
#
|
|
317
|
+
# @param checkbox_groups [Array<SignwellSDK::Models::V1::CheckboxGroup>] Checkbox fields that are placed on a document can be grouped with selection requ
|
|
318
|
+
#
|
|
319
|
+
# @param custom_requester_email [String] Sets the custom requester email for the document. When set, this is the email us
|
|
320
|
+
#
|
|
321
|
+
# @param custom_requester_name [String] Sets the custom requester name for the document. When set, this is the name used
|
|
322
|
+
#
|
|
323
|
+
# @param decline_redirect_url [String] A URL that recipients are redirected to if the document is declined.
|
|
324
|
+
#
|
|
325
|
+
# @param embedded_signing [Boolean] When set to `true` it enables embedded signing in your website/web application.
|
|
326
|
+
#
|
|
327
|
+
# @param embedded_signing_notifications [Boolean] On embedding signing, document owners (and CC'd contacts) do not get a notificat
|
|
328
|
+
#
|
|
329
|
+
# @param expires_in [Integer] Number of days before the signature request expires. Defaults to the account exp
|
|
330
|
+
#
|
|
331
|
+
# @param labels [Array<SignwellSDK::Models::V1::Label>] Labels can be used to organize documents in a way that can make it easy to find
|
|
332
|
+
#
|
|
333
|
+
# @param message [String] Email message for the signature request that recipients will see. Defaults to th
|
|
334
|
+
#
|
|
335
|
+
# @param metadata [Hash{Symbol=>String}] Optional key-value data that can be associated with the document. If set, will b
|
|
336
|
+
#
|
|
337
|
+
# @param name [String] The name of the document.
|
|
338
|
+
#
|
|
339
|
+
# @param redirect_url [String] A URL that recipients are redirected to after successfully signing a document.
|
|
340
|
+
#
|
|
341
|
+
# @param reminders [Boolean] Whether to send signing reminders to recipients. Reminders are sent on day 3, da
|
|
342
|
+
#
|
|
343
|
+
# @param subject [String] Email subject for the signature request that recipients will see. Defaults to th
|
|
344
|
+
#
|
|
345
|
+
# @param test_mode [Boolean] Set to `true` to enable Test Mode. Documents created with Test Mode do not count
|
|
346
|
+
#
|
|
347
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
348
|
+
#
|
|
349
|
+
# @return [SignwellSDK::Models::V1::Document]
|
|
350
|
+
#
|
|
351
|
+
# @see SignwellSDK::Models::V1::DocumentSendParams
|
|
352
|
+
def send_(id, params = {})
|
|
353
|
+
parsed, options = SignwellSDK::V1::DocumentSendParams.dump_request(params)
|
|
354
|
+
@client.request(
|
|
355
|
+
method: :post,
|
|
356
|
+
path: ["api/v1/documents/%1$s/send", id],
|
|
357
|
+
body: parsed,
|
|
358
|
+
model: SignwellSDK::V1::Document,
|
|
359
|
+
options: options
|
|
360
|
+
)
|
|
361
|
+
end
|
|
362
|
+
|
|
363
|
+
# @api private
|
|
364
|
+
#
|
|
365
|
+
# @param client [SignwellSDK::Client]
|
|
366
|
+
def initialize(client:)
|
|
367
|
+
@client = client
|
|
368
|
+
end
|
|
369
|
+
end
|
|
370
|
+
end
|
|
371
|
+
end
|
|
372
|
+
end
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module SignwellSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class V1
|
|
6
|
+
class Hooks
|
|
7
|
+
# Register a callback URL that we will post document events to.
|
|
8
|
+
#
|
|
9
|
+
# @overload create(callback_url:, api_application_id: nil, request_options: {})
|
|
10
|
+
#
|
|
11
|
+
# @param callback_url [String] URL that we will post document events to.
|
|
12
|
+
#
|
|
13
|
+
# @param api_application_id [String] Unique identifier for the API Application.
|
|
14
|
+
#
|
|
15
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
16
|
+
#
|
|
17
|
+
# @return [nil]
|
|
18
|
+
#
|
|
19
|
+
# @see SignwellSDK::Models::V1::HookCreateParams
|
|
20
|
+
def create(params)
|
|
21
|
+
parsed, options = SignwellSDK::V1::HookCreateParams.dump_request(params)
|
|
22
|
+
@client.request(
|
|
23
|
+
method: :post,
|
|
24
|
+
path: "api/v1/hooks",
|
|
25
|
+
body: parsed,
|
|
26
|
+
model: NilClass,
|
|
27
|
+
options: options
|
|
28
|
+
)
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# List all the webhooks in the account.
|
|
32
|
+
#
|
|
33
|
+
# @overload list(request_options: {})
|
|
34
|
+
#
|
|
35
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
36
|
+
#
|
|
37
|
+
# @return [nil]
|
|
38
|
+
#
|
|
39
|
+
# @see SignwellSDK::Models::V1::HookListParams
|
|
40
|
+
def list(params = {})
|
|
41
|
+
@client.request(
|
|
42
|
+
method: :get,
|
|
43
|
+
path: "api/v1/hooks",
|
|
44
|
+
model: NilClass,
|
|
45
|
+
options: params[:request_options]
|
|
46
|
+
)
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
# Deletes a registered callback URL that we are posting document events to.
|
|
50
|
+
#
|
|
51
|
+
# @overload delete(id, request_options: {})
|
|
52
|
+
#
|
|
53
|
+
# @param id [String] Unique identifier for a webhook.
|
|
54
|
+
#
|
|
55
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
56
|
+
#
|
|
57
|
+
# @return [nil]
|
|
58
|
+
#
|
|
59
|
+
# @see SignwellSDK::Models::V1::HookDeleteParams
|
|
60
|
+
def delete(id, params = {})
|
|
61
|
+
@client.request(
|
|
62
|
+
method: :delete,
|
|
63
|
+
path: ["api/v1/hooks/%1$s", id],
|
|
64
|
+
model: NilClass,
|
|
65
|
+
options: params[:request_options]
|
|
66
|
+
)
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# @api private
|
|
70
|
+
#
|
|
71
|
+
# @param client [SignwellSDK::Client]
|
|
72
|
+
def initialize(client:)
|
|
73
|
+
@client = client
|
|
74
|
+
end
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
end
|
|
78
|
+
end
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module SignwellSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class V1
|
|
6
|
+
# @return [SignwellSDK::Resources::V1::Documents]
|
|
7
|
+
attr_reader :documents
|
|
8
|
+
|
|
9
|
+
# @return [SignwellSDK::Resources::V1::DocumentTemplates]
|
|
10
|
+
attr_reader :document_templates
|
|
11
|
+
|
|
12
|
+
# @return [SignwellSDK::Resources::V1::APIApplications]
|
|
13
|
+
attr_reader :api_applications
|
|
14
|
+
|
|
15
|
+
# @return [SignwellSDK::Resources::V1::Hooks]
|
|
16
|
+
attr_reader :hooks
|
|
17
|
+
|
|
18
|
+
# @return [SignwellSDK::Resources::V1::BulkSends]
|
|
19
|
+
attr_reader :bulk_sends
|
|
20
|
+
|
|
21
|
+
# Retrieves the account information associated with the API key being used.
|
|
22
|
+
#
|
|
23
|
+
# @overload me(request_options: {})
|
|
24
|
+
#
|
|
25
|
+
# @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
26
|
+
#
|
|
27
|
+
# @return [nil]
|
|
28
|
+
#
|
|
29
|
+
# @see SignwellSDK::Models::V1MeParams
|
|
30
|
+
def me(params = {})
|
|
31
|
+
@client.request(method: :get, path: "api/v1/me", model: NilClass, options: params[:request_options])
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# @api private
|
|
35
|
+
#
|
|
36
|
+
# @param client [SignwellSDK::Client]
|
|
37
|
+
def initialize(client:)
|
|
38
|
+
@client = client
|
|
39
|
+
@documents = SignwellSDK::Resources::V1::Documents.new(client: client)
|
|
40
|
+
@document_templates = SignwellSDK::Resources::V1::DocumentTemplates.new(client: client)
|
|
41
|
+
@api_applications = SignwellSDK::Resources::V1::APIApplications.new(client: client)
|
|
42
|
+
@hooks = SignwellSDK::Resources::V1::Hooks.new(client: client)
|
|
43
|
+
@bulk_sends = SignwellSDK::Resources::V1::BulkSends.new(client: client)
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
data/lib/signwell_sdk.rb
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Standard libraries.
|
|
4
|
+
# rubocop:disable Lint/RedundantRequireStatement
|
|
5
|
+
require "English"
|
|
6
|
+
require "base64"
|
|
7
|
+
require "cgi"
|
|
8
|
+
require "date"
|
|
9
|
+
require "erb"
|
|
10
|
+
require "etc"
|
|
11
|
+
require "json"
|
|
12
|
+
require "net/http"
|
|
13
|
+
require "openssl"
|
|
14
|
+
require "pathname"
|
|
15
|
+
require "rbconfig"
|
|
16
|
+
require "securerandom"
|
|
17
|
+
require "set"
|
|
18
|
+
require "stringio"
|
|
19
|
+
require "time"
|
|
20
|
+
require "uri"
|
|
21
|
+
# rubocop:enable Lint/RedundantRequireStatement
|
|
22
|
+
|
|
23
|
+
# We already ship the preferred sorbet manifests in the package itself.
|
|
24
|
+
# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
|
|
25
|
+
if Object.const_defined?(:Tapioca) &&
|
|
26
|
+
caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
|
|
27
|
+
ARGV.none?(/dsl/)
|
|
28
|
+
return
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# Gems.
|
|
32
|
+
require "connection_pool"
|
|
33
|
+
|
|
34
|
+
# Package files.
|
|
35
|
+
require_relative "signwell_sdk/version"
|
|
36
|
+
require_relative "signwell_sdk/internal/util"
|
|
37
|
+
require_relative "signwell_sdk/internal/type/converter"
|
|
38
|
+
require_relative "signwell_sdk/internal/type/unknown"
|
|
39
|
+
require_relative "signwell_sdk/internal/type/boolean"
|
|
40
|
+
require_relative "signwell_sdk/internal/type/file_input"
|
|
41
|
+
require_relative "signwell_sdk/internal/type/enum"
|
|
42
|
+
require_relative "signwell_sdk/internal/type/union"
|
|
43
|
+
require_relative "signwell_sdk/internal/type/array_of"
|
|
44
|
+
require_relative "signwell_sdk/internal/type/hash_of"
|
|
45
|
+
require_relative "signwell_sdk/internal/type/base_model"
|
|
46
|
+
require_relative "signwell_sdk/internal/type/base_page"
|
|
47
|
+
require_relative "signwell_sdk/internal/type/request_parameters"
|
|
48
|
+
require_relative "signwell_sdk/internal"
|
|
49
|
+
require_relative "signwell_sdk/request_options"
|
|
50
|
+
require_relative "signwell_sdk/file_part"
|
|
51
|
+
require_relative "signwell_sdk/errors"
|
|
52
|
+
require_relative "signwell_sdk/internal/transport/base_client"
|
|
53
|
+
require_relative "signwell_sdk/internal/transport/pooled_net_requester"
|
|
54
|
+
require_relative "signwell_sdk/client"
|
|
55
|
+
require_relative "signwell_sdk/models/attachment_request_info"
|
|
56
|
+
require_relative "signwell_sdk/models/checkbox_group_info"
|
|
57
|
+
require_relative "signwell_sdk/models/checkbox_validation"
|
|
58
|
+
require_relative "signwell_sdk/models/copied_contact_info"
|
|
59
|
+
require_relative "signwell_sdk/models/date_format"
|
|
60
|
+
require_relative "signwell_sdk/models/field_type"
|
|
61
|
+
require_relative "signwell_sdk/models/file_info"
|
|
62
|
+
require_relative "signwell_sdk/models/label_info"
|
|
63
|
+
require_relative "signwell_sdk/models/text_validation"
|
|
64
|
+
require_relative "signwell_sdk/models/v1/api_application_delete_params"
|
|
65
|
+
require_relative "signwell_sdk/models/v1/api_application_retrieve_params"
|
|
66
|
+
require_relative "signwell_sdk/models/v1/attachment_request"
|
|
67
|
+
require_relative "signwell_sdk/models/v1/bulk_send_create_params"
|
|
68
|
+
require_relative "signwell_sdk/models/v1/bulk_send_list_params"
|
|
69
|
+
require_relative "signwell_sdk/models/v1/bulk_send_retrieve_csv_template_params"
|
|
70
|
+
require_relative "signwell_sdk/models/v1/bulk_send_retrieve_documents_params"
|
|
71
|
+
require_relative "signwell_sdk/models/v1/bulk_send_retrieve_params"
|
|
72
|
+
require_relative "signwell_sdk/models/v1/bulk_send_validate_csv_params"
|
|
73
|
+
require_relative "signwell_sdk/models/v1/checkbox_group"
|
|
74
|
+
require_relative "signwell_sdk/models/v1/copied_contact"
|
|
75
|
+
require_relative "signwell_sdk/models/v1/document"
|
|
76
|
+
require_relative "signwell_sdk/models/v1/document_create_from_template_params"
|
|
77
|
+
require_relative "signwell_sdk/models/v1/document_create_from_template_response"
|
|
78
|
+
require_relative "signwell_sdk/models/v1/document_create_params"
|
|
79
|
+
require_relative "signwell_sdk/models/v1/document_delete_params"
|
|
80
|
+
require_relative "signwell_sdk/models/v1/document_file"
|
|
81
|
+
require_relative "signwell_sdk/models/v1/document_list_params"
|
|
82
|
+
require_relative "signwell_sdk/models/v1/document_list_response"
|
|
83
|
+
require_relative "signwell_sdk/models/v1/document_remind_params"
|
|
84
|
+
require_relative "signwell_sdk/models/v1/document_retrieve_completed_pdf_params"
|
|
85
|
+
require_relative "signwell_sdk/models/v1/document_retrieve_completed_pdf_response"
|
|
86
|
+
require_relative "signwell_sdk/models/v1/document_retrieve_params"
|
|
87
|
+
require_relative "signwell_sdk/models/v1/document_send_params"
|
|
88
|
+
require_relative "signwell_sdk/models/v1/document_template"
|
|
89
|
+
require_relative "signwell_sdk/models/v1/document_template_create_params"
|
|
90
|
+
require_relative "signwell_sdk/models/v1/document_template_delete_params"
|
|
91
|
+
require_relative "signwell_sdk/models/v1/document_template_list_params"
|
|
92
|
+
require_relative "signwell_sdk/models/v1/document_template_list_response"
|
|
93
|
+
require_relative "signwell_sdk/models/v1/document_template_retrieve_params"
|
|
94
|
+
require_relative "signwell_sdk/models/v1/document_template_update_params"
|
|
95
|
+
require_relative "signwell_sdk/models/v1/hook_create_params"
|
|
96
|
+
require_relative "signwell_sdk/models/v1/hook_delete_params"
|
|
97
|
+
require_relative "signwell_sdk/models/v1/hook_list_params"
|
|
98
|
+
require_relative "signwell_sdk/models/v1/label"
|
|
99
|
+
require_relative "signwell_sdk/models/v1/template_checkbox_group"
|
|
100
|
+
require_relative "signwell_sdk/models/v1_me_params"
|
|
101
|
+
require_relative "signwell_sdk/models"
|
|
102
|
+
require_relative "signwell_sdk/resources/v1"
|
|
103
|
+
require_relative "signwell_sdk/resources/v1/api_applications"
|
|
104
|
+
require_relative "signwell_sdk/resources/v1/bulk_sends"
|
|
105
|
+
require_relative "signwell_sdk/resources/v1/documents"
|
|
106
|
+
require_relative "signwell_sdk/resources/v1/document_templates"
|
|
107
|
+
require_relative "signwell_sdk/resources/v1/hooks"
|