signwell_sdk 0.1.1 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/ISSUE_TEMPLATE/bug_report.yml +53 -0
- data/.github/ISSUE_TEMPLATE/config.yml +5 -0
- data/.github/ISSUE_TEMPLATE/feature_request.yml +35 -0
- data/.github/pull_request_template.md +39 -0
- data/.github/workflows/ci.yml +45 -0
- data/.github/workflows/generator-ownership.yml +53 -0
- data/.github/workflows/manual-release.yml +64 -0
- data/.github/workflows/release.yml +69 -0
- data/.gitignore +39 -0
- data/.release-please-manifest.json +3 -0
- data/.rspec +2 -0
- data/.rubocop.yml +200 -0
- data/CHANGELOG.md +20 -0
- data/CONTRIBUTING.md +13 -0
- data/Gemfile.lock +28 -34
- data/README.md +93 -6
- data/docs/AdditionalFieldsInnerInner.md +4 -0
- data/docs/{APIApplicationApi.md → ApiApplicationApi.md} +9 -9
- data/docs/BulkSendApi.md +4 -4
- data/docs/BulkSendCsvRequest.md +1 -1
- data/docs/ConditionalLogicDecisionInfo.md +26 -0
- data/docs/ConditionalRuleInfo.md +26 -0
- data/docs/ConditionalRuleInfoConditionsInner.md +26 -0
- data/docs/ConditionalRuleRequest.md +28 -0
- data/docs/ConditionalRuleRequestConditionsInner.md +26 -0
- data/docs/CopiedPlaceholdersInner.md +1 -1
- data/docs/CreateBulkSendRequest.md +2 -2
- data/docs/DocumentApi.md +89 -13
- data/docs/DocumentFromTemplateRequest.md +11 -3
- data/docs/DocumentFromTemplateResponse.md +12 -2
- data/docs/DocumentFromTemplateResponseFieldsInnerInner.md +6 -0
- data/docs/DocumentFromTemplateResponseRecipientsInner.md +6 -0
- data/docs/DocumentRequest.md +10 -4
- data/docs/DocumentResponse.md +12 -2
- data/docs/DocumentResponseFieldsInnerInner.md +6 -0
- data/docs/DocumentResponseRecipientsInner.md +6 -0
- data/docs/DocumentResponseRecipientsInnerPasscodeDelivery.md +22 -0
- data/docs/DocumentResponseRecipientsInnerSms.md +30 -0
- data/docs/DocumentTemplateRequest.md +5 -3
- data/docs/DocumentTemplateResponse.md +3 -1
- data/docs/DocumentTemplateResponsePlaceholdersInner.md +3 -1
- data/docs/DocumentTemplateUpdateRequest.md +5 -3
- data/docs/EmbeddedBranding.md +18 -0
- data/docs/EmbeddedBrandingBranding.md +26 -0
- data/docs/EmbeddedBrandingRequest.md +26 -0
- data/docs/EmbeddedBrandingRequestCompanyLogo.md +20 -0
- data/docs/EmbeddedRequest.md +18 -0
- data/docs/FieldsInnerInner.md +4 -0
- data/docs/FileInfo.md +1 -1
- data/docs/PlaceholdersInner.md +4 -2
- data/docs/PlaceholdersInnerPasscodeDelivery.md +22 -0
- data/docs/RecipientsInner.md +14 -4
- data/docs/RecipientsInnerPasscodeDelivery.md +22 -0
- data/docs/RegionalApi.md +4 -4
- data/docs/ReminderRecipientsInner.md +1 -1
- data/docs/SendReminderRequest.md +1 -1
- data/docs/TemplateApi.md +3 -1
- data/docs/TemplateFieldsInnerInner.md +4 -0
- data/docs/TemplateRecipientsInner.md +14 -4
- data/docs/UpdateAuthenticationRequest.md +18 -0
- data/docs/UpdateAuthenticationRequestRecipientsInner.md +22 -0
- data/docs/UpdateDocumentAndSendRequest.md +9 -3
- data/docs/UpdateRecipientsMapInner.md +4 -2
- data/docs/UpdateRecipientsMapInnerPasscodeDelivery.md +22 -0
- data/docs/WebhookResponse.md +0 -2
- data/docs/WebhooksApi.md +1 -1
- data/lib/signwell_sdk/api/api_application_api.rb +35 -40
- data/lib/signwell_sdk/api/bulk_send_api.rb +116 -111
- data/lib/signwell_sdk/api/document_api.rb +324 -162
- data/lib/signwell_sdk/api/me_api.rb +20 -20
- data/lib/signwell_sdk/api/regional_api.rb +46 -28
- data/lib/signwell_sdk/api/template_api.rb +116 -85
- data/lib/signwell_sdk/api/webhooks_api.rb +51 -48
- data/lib/signwell_sdk/api_client.rb +274 -95
- data/lib/signwell_sdk/api_error.rb +141 -17
- data/lib/signwell_sdk/api_model_base.rb +88 -0
- data/lib/signwell_sdk/configuration.rb +43 -53
- data/lib/signwell_sdk/{embedded → extras/embedded}/railtie.rb +2 -0
- data/lib/signwell_sdk/extras/embedded/view_helpers.rb +281 -0
- data/lib/signwell_sdk/{embedded.rb → extras/embedded.rb} +96 -54
- data/lib/signwell_sdk/extras/rate_limit.rb +17 -0
- data/lib/signwell_sdk/extras/webhook.rb +257 -0
- data/lib/signwell_sdk/models/account_info_response.rb +109 -85
- data/lib/signwell_sdk/models/account_info_response_active_users_inner.rb +79 -60
- data/lib/signwell_sdk/models/account_info_response_preferences.rb +111 -102
- data/lib/signwell_sdk/models/additional_fields_inner_inner.rb +248 -145
- data/lib/signwell_sdk/models/additional_fields_inner_inner_value.rb +25 -24
- data/lib/signwell_sdk/models/additional_files_inner.rb +57 -52
- data/lib/signwell_sdk/models/api_application_response.rb +90 -72
- data/lib/signwell_sdk/models/api_application_response_owner.rb +79 -58
- data/lib/signwell_sdk/models/api_application_response_preferences.rb +66 -62
- data/lib/signwell_sdk/models/attachment_request_info.rb +65 -52
- data/lib/signwell_sdk/models/attachment_requests_inner.rb +67 -56
- data/lib/signwell_sdk/models/bulk_send_create_response.rb +109 -77
- data/lib/signwell_sdk/models/bulk_send_csv_request.rb +54 -49
- data/lib/signwell_sdk/models/bulk_send_csv_template_response.rb +45 -42
- data/lib/signwell_sdk/models/bulk_send_documents_response.rb +145 -102
- data/lib/signwell_sdk/models/bulk_send_list_item.rb +146 -97
- data/lib/signwell_sdk/models/bulk_send_list_response.rb +98 -72
- data/lib/signwell_sdk/models/bulk_send_response.rb +124 -91
- data/lib/signwell_sdk/models/bulk_send_response_templates_inner.rb +59 -48
- data/lib/signwell_sdk/models/bulk_send_validate_csv_response.rb +90 -77
- data/lib/signwell_sdk/models/checkbox_group_info.rb +110 -85
- data/lib/signwell_sdk/models/checkbox_groups_inner.rb +104 -82
- data/lib/signwell_sdk/models/checkbox_validation.rb +16 -16
- data/lib/signwell_sdk/models/completed_pdf_response.rb +24 -23
- data/lib/signwell_sdk/models/completed_pdf_url_response.rb +45 -42
- data/lib/signwell_sdk/models/conditional_logic_decision_info.rb +365 -0
- data/lib/signwell_sdk/models/conditional_rule_info.rb +351 -0
- data/lib/signwell_sdk/models/conditional_rule_info_conditions_inner.rb +340 -0
- data/lib/signwell_sdk/models/conditional_rule_request.rb +322 -0
- data/lib/signwell_sdk/models/conditional_rule_request_conditions_inner.rb +371 -0
- data/lib/signwell_sdk/models/copied_contact_info.rb +57 -50
- data/lib/signwell_sdk/models/copied_contacts_inner.rb +51 -46
- data/lib/signwell_sdk/models/copied_placeholders_inner.rb +57 -54
- data/lib/signwell_sdk/models/create_bulk_send_request.rb +108 -94
- data/lib/signwell_sdk/models/create_webhook_request.rb +51 -48
- data/lib/signwell_sdk/models/date_format.rb +17 -17
- data/lib/signwell_sdk/models/detailed_option.rb +59 -54
- data/lib/signwell_sdk/models/document_from_template_request.rb +351 -224
- data/lib/signwell_sdk/models/document_from_template_response.rb +384 -212
- data/lib/signwell_sdk/models/document_from_template_response_fields_inner_inner.rb +247 -139
- data/lib/signwell_sdk/models/document_from_template_response_fields_inner_inner_recipient.rb +65 -54
- data/lib/signwell_sdk/models/document_from_template_response_recipients_inner.rb +219 -119
- data/lib/signwell_sdk/models/document_list_response.rb +98 -72
- data/lib/signwell_sdk/models/document_request.rb +288 -216
- data/lib/signwell_sdk/models/document_response.rb +386 -214
- data/lib/signwell_sdk/models/document_response_attachment_requests_inner.rb +65 -54
- data/lib/signwell_sdk/models/document_response_fields_inner_inner.rb +247 -139
- data/lib/signwell_sdk/models/document_response_fields_inner_inner_options_inner.rb +50 -49
- data/lib/signwell_sdk/models/document_response_fields_inner_inner_recipient.rb +59 -48
- data/lib/signwell_sdk/models/document_response_fields_inner_inner_value.rb +25 -24
- data/lib/signwell_sdk/models/document_response_recipients_inner.rb +222 -118
- data/lib/signwell_sdk/models/document_response_recipients_inner_passcode_delivery.rb +246 -0
- data/lib/signwell_sdk/models/document_response_recipients_inner_sms.rb +292 -0
- data/lib/signwell_sdk/models/document_template_list_response.rb +98 -72
- data/lib/signwell_sdk/models/document_template_request.rb +213 -168
- data/lib/signwell_sdk/models/document_template_response.rb +250 -180
- data/lib/signwell_sdk/models/document_template_response_copied_placeholders_inner.rb +82 -72
- data/lib/signwell_sdk/models/document_template_response_placeholders_inner.rb +98 -79
- data/lib/signwell_sdk/models/document_template_update_request.rb +156 -127
- data/lib/signwell_sdk/models/dropdown_option.rb +24 -23
- data/lib/signwell_sdk/models/embedded_branding.rb +241 -0
- data/lib/signwell_sdk/models/embedded_branding_branding.rb +307 -0
- data/lib/signwell_sdk/models/embedded_branding_request.rb +297 -0
- data/lib/signwell_sdk/models/embedded_branding_request_company_logo.rb +236 -0
- data/lib/signwell_sdk/models/embedded_request.rb +225 -0
- data/lib/signwell_sdk/models/error_response.rb +44 -45
- data/lib/signwell_sdk/models/error_response_meta.rb +66 -55
- data/lib/signwell_sdk/models/field_type.rb +27 -28
- data/lib/signwell_sdk/models/fields_inner_inner.rb +242 -141
- data/lib/signwell_sdk/models/file_format.rb +14 -14
- data/lib/signwell_sdk/models/file_info.rb +51 -56
- data/lib/signwell_sdk/models/files_inner.rb +57 -52
- data/lib/signwell_sdk/models/label_info.rb +44 -45
- data/lib/signwell_sdk/models/label_request.rb +45 -42
- data/lib/signwell_sdk/models/label_response.rb +51 -46
- data/lib/signwell_sdk/models/me_response.rb +121 -76
- data/lib/signwell_sdk/models/me_response_contact.rb +113 -85
- data/lib/signwell_sdk/models/me_response_user.rb +91 -68
- data/lib/signwell_sdk/models/me_response_user_preferences.rb +50 -49
- data/lib/signwell_sdk/models/nom151_certificate_response.rb +45 -42
- data/lib/signwell_sdk/models/nom151_certificate_response_nom151.rb +137 -82
- data/lib/signwell_sdk/models/nom151_url_response.rb +45 -42
- data/lib/signwell_sdk/models/pagination_meta.rb +87 -65
- data/lib/signwell_sdk/models/placeholders_inner.rb +81 -60
- data/lib/signwell_sdk/models/placeholders_inner_passcode_delivery.rb +271 -0
- data/lib/signwell_sdk/models/rate_limit_error_response.rb +45 -42
- data/lib/signwell_sdk/models/recipients_inner.rb +190 -90
- data/lib/signwell_sdk/models/recipients_inner_passcode_delivery.rb +271 -0
- data/lib/signwell_sdk/models/reminder_recipients_inner.rb +45 -46
- data/lib/signwell_sdk/models/send_reminder_request.rb +40 -43
- data/lib/signwell_sdk/models/template_attachment_requests_inner.rb +64 -55
- data/lib/signwell_sdk/models/template_checkbox_groups_inner.rb +101 -81
- data/lib/signwell_sdk/models/template_field_values_inner.rb +59 -48
- data/lib/signwell_sdk/models/template_field_values_inner_value.rb +25 -24
- data/lib/signwell_sdk/models/template_fields_inner_inner.rb +239 -140
- data/lib/signwell_sdk/models/template_recipients_inner.rb +196 -94
- data/lib/signwell_sdk/models/text_validation.rb +24 -24
- data/lib/signwell_sdk/models/update_authentication_request.rb +243 -0
- data/lib/signwell_sdk/models/update_authentication_request_recipients_inner.rb +262 -0
- data/lib/signwell_sdk/models/update_document_and_send_request.rb +206 -150
- data/lib/signwell_sdk/models/update_recipients_map_inner.rb +102 -69
- data/lib/signwell_sdk/models/update_recipients_map_inner_passcode_delivery.rb +271 -0
- data/lib/signwell_sdk/models/update_recipients_request.rb +42 -43
- data/lib/signwell_sdk/models/validation_error_response.rb +42 -43
- data/lib/signwell_sdk/models/webhook_response.rb +67 -66
- data/lib/signwell_sdk/version.rb +4 -4
- data/lib/signwell_sdk.rb +34 -13
- data/openapi.yaml +2171 -902
- data/package-lock.json +542 -136
- data/package.json +4 -1
- data/signwell_sdk.gemspec +26 -8
- data/spec/api/api_application_api_spec.rb +15 -14
- data/spec/api/bulk_send_api_spec.rb +13 -14
- data/spec/api/document_api_spec.rb +24 -21
- data/spec/api/me_api_spec.rb +11 -10
- data/spec/api/regional_api_spec.rb +12 -11
- data/spec/api/template_api_spec.rb +12 -13
- data/spec/api/webhooks_api_spec.rb +12 -11
- data/spec/models/account_info_response_active_users_inner_spec.rb +11 -11
- data/spec/models/account_info_response_preferences_spec.rb +11 -11
- data/spec/models/account_info_response_spec.rb +10 -10
- data/spec/models/additional_fields_inner_inner_spec.rb +23 -11
- data/spec/models/additional_fields_inner_inner_value_spec.rb +9 -10
- data/spec/models/additional_files_inner_spec.rb +11 -11
- data/spec/models/api_application_response_owner_spec.rb +11 -11
- data/spec/models/api_application_response_preferences_spec.rb +11 -11
- data/spec/models/api_application_response_spec.rb +10 -10
- data/spec/models/attachment_request_info_spec.rb +11 -11
- data/spec/models/attachment_requests_inner_spec.rb +11 -11
- data/spec/models/bulk_send_create_response_spec.rb +10 -10
- data/spec/models/bulk_send_csv_request_spec.rb +11 -11
- data/spec/models/bulk_send_csv_template_response_spec.rb +10 -10
- data/spec/models/bulk_send_documents_response_spec.rb +11 -11
- data/spec/models/bulk_send_list_item_spec.rb +11 -11
- data/spec/models/bulk_send_list_response_spec.rb +10 -10
- data/spec/models/bulk_send_response_spec.rb +11 -11
- data/spec/models/bulk_send_response_templates_inner_spec.rb +11 -11
- data/spec/models/bulk_send_validate_csv_response_spec.rb +10 -10
- data/spec/models/checkbox_group_info_spec.rb +10 -10
- data/spec/models/checkbox_groups_inner_spec.rb +10 -10
- data/spec/models/checkbox_validation_spec.rb +10 -10
- data/spec/models/completed_pdf_response_spec.rb +9 -10
- data/spec/models/completed_pdf_url_response_spec.rb +10 -10
- data/spec/models/conditional_logic_decision_info_spec.rb +58 -0
- data/spec/models/conditional_rule_info_conditions_inner_spec.rb +58 -0
- data/spec/models/conditional_rule_info_spec.rb +58 -0
- data/spec/models/conditional_rule_request_conditions_inner_spec.rb +58 -0
- data/spec/models/conditional_rule_request_spec.rb +64 -0
- data/spec/models/copied_contact_info_spec.rb +11 -11
- data/spec/models/copied_contacts_inner_spec.rb +11 -11
- data/spec/models/copied_placeholders_inner_spec.rb +11 -11
- data/spec/models/create_bulk_send_request_spec.rb +11 -11
- data/spec/models/create_webhook_request_spec.rb +11 -11
- data/spec/models/date_format_spec.rb +10 -10
- data/spec/models/detailed_option_spec.rb +11 -11
- data/spec/models/document_from_template_request_spec.rb +35 -11
- data/spec/models/document_from_template_response_fields_inner_inner_recipient_spec.rb +11 -11
- data/spec/models/document_from_template_response_fields_inner_inner_spec.rb +29 -11
- data/spec/models/document_from_template_response_recipients_inner_spec.rb +29 -11
- data/spec/models/document_from_template_response_spec.rb +41 -11
- data/spec/models/document_list_response_spec.rb +10 -10
- data/spec/models/document_request_spec.rb +29 -11
- data/spec/models/document_response_attachment_requests_inner_spec.rb +11 -11
- data/spec/models/document_response_fields_inner_inner_options_inner_spec.rb +11 -11
- data/spec/models/document_response_fields_inner_inner_recipient_spec.rb +11 -11
- data/spec/models/document_response_fields_inner_inner_spec.rb +29 -11
- data/spec/models/document_response_fields_inner_inner_value_spec.rb +9 -10
- data/spec/models/document_response_recipients_inner_passcode_delivery_spec.rb +46 -0
- data/spec/models/document_response_recipients_inner_sms_spec.rb +70 -0
- data/spec/models/document_response_recipients_inner_spec.rb +29 -11
- data/spec/models/document_response_spec.rb +41 -11
- data/spec/models/document_template_list_response_spec.rb +10 -10
- data/spec/models/document_template_request_spec.rb +17 -11
- data/spec/models/document_template_response_copied_placeholders_inner_spec.rb +10 -10
- data/spec/models/document_template_response_placeholders_inner_spec.rb +16 -10
- data/spec/models/document_template_response_spec.rb +17 -11
- data/spec/models/document_template_update_request_spec.rb +17 -11
- data/spec/models/dropdown_option_spec.rb +9 -10
- data/spec/models/embedded_branding_branding_spec.rb +58 -0
- data/spec/models/embedded_branding_request_company_logo_spec.rb +40 -0
- data/spec/models/embedded_branding_request_spec.rb +58 -0
- data/spec/models/embedded_branding_spec.rb +34 -0
- data/spec/models/embedded_request_spec.rb +34 -0
- data/spec/models/error_response_meta_spec.rb +11 -11
- data/spec/models/error_response_spec.rb +11 -11
- data/spec/models/field_type_spec.rb +10 -10
- data/spec/models/fields_inner_inner_spec.rb +23 -11
- data/spec/models/file_format_spec.rb +10 -10
- data/spec/models/file_info_spec.rb +11 -11
- data/spec/models/files_inner_spec.rb +11 -11
- data/spec/models/label_info_spec.rb +11 -11
- data/spec/models/label_request_spec.rb +10 -10
- data/spec/models/label_response_spec.rb +11 -11
- data/spec/models/me_response_contact_spec.rb +10 -10
- data/spec/models/me_response_spec.rb +10 -10
- data/spec/models/me_response_user_preferences_spec.rb +11 -11
- data/spec/models/me_response_user_spec.rb +10 -10
- data/spec/models/nom151_certificate_response_nom151_spec.rb +10 -10
- data/spec/models/nom151_certificate_response_spec.rb +10 -10
- data/spec/models/nom151_url_response_spec.rb +10 -10
- data/spec/models/pagination_meta_spec.rb +11 -11
- data/spec/models/placeholders_inner_passcode_delivery_spec.rb +46 -0
- data/spec/models/placeholders_inner_spec.rb +17 -11
- data/spec/models/rate_limit_error_response_spec.rb +10 -10
- data/spec/models/recipients_inner_passcode_delivery_spec.rb +46 -0
- data/spec/models/recipients_inner_spec.rb +41 -11
- data/spec/models/reminder_recipients_inner_spec.rb +11 -11
- data/spec/models/send_reminder_request_spec.rb +10 -10
- data/spec/models/template_attachment_requests_inner_spec.rb +11 -11
- data/spec/models/template_checkbox_groups_inner_spec.rb +10 -10
- data/spec/models/template_field_values_inner_spec.rb +11 -11
- data/spec/models/template_field_values_inner_value_spec.rb +9 -10
- data/spec/models/template_fields_inner_inner_spec.rb +23 -11
- data/spec/models/template_recipients_inner_spec.rb +41 -11
- data/spec/models/text_validation_spec.rb +10 -10
- data/spec/models/update_authentication_request_recipients_inner_spec.rb +46 -0
- data/spec/models/update_authentication_request_spec.rb +34 -0
- data/spec/models/update_document_and_send_request_spec.rb +29 -11
- data/spec/models/update_recipients_map_inner_passcode_delivery_spec.rb +46 -0
- data/spec/models/update_recipients_map_inner_spec.rb +16 -10
- data/spec/models/update_recipients_request_spec.rb +10 -10
- data/spec/models/validation_error_response_spec.rb +10 -10
- data/spec/models/webhook_response_spec.rb +11 -17
- data/spec/regressions/api_client_spec.rb +536 -0
- data/spec/regressions/bulk_send_api_spec.rb +47 -0
- data/spec/regressions/embedded_spec.rb +263 -0
- data/spec/regressions/generated_resource_helpers_spec.rb +119 -0
- data/spec/regressions/response_modes_spec.rb +93 -0
- data/spec/regressions/view_helpers_spec.rb +202 -0
- data/spec/regressions/webhook_spec.rb +210 -0
- data/spec/spec_helper.rb +10 -12
- metadata +197 -91
- data/lib/signwell_sdk/embedded/view_helpers.rb +0 -132
- data/lib/signwell_sdk/webhook.rb +0 -109
data/Gemfile.lock
CHANGED
|
@@ -1,50 +1,44 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
signwell_sdk (0.
|
|
4
|
+
signwell_sdk (0.2.0)
|
|
5
5
|
faraday (>= 1.0.1, < 3.0)
|
|
6
|
-
faraday-multipart
|
|
7
|
-
marcel
|
|
6
|
+
faraday-multipart (~> 1.0, >= 1.0.0)
|
|
7
|
+
marcel (~> 1.0, >= 1.0.0)
|
|
8
8
|
|
|
9
9
|
GEM
|
|
10
10
|
remote: https://rubygems.org/
|
|
11
11
|
specs:
|
|
12
|
-
addressable (2.8.9)
|
|
13
|
-
public_suffix (>= 2.0.2, < 8.0)
|
|
14
12
|
ast (2.4.3)
|
|
15
|
-
bigdecimal (4.0.1)
|
|
16
13
|
diff-lcs (1.6.2)
|
|
17
|
-
faraday (2.14.
|
|
14
|
+
faraday (2.14.4)
|
|
18
15
|
faraday-net_http (>= 2.0, < 3.5)
|
|
19
16
|
json
|
|
20
17
|
logger
|
|
21
18
|
faraday-multipart (1.2.0)
|
|
22
19
|
multipart-post (~> 2.0)
|
|
23
|
-
faraday-net_http (3.4.
|
|
20
|
+
faraday-net_http (3.4.4)
|
|
24
21
|
net-http (~> 0.5)
|
|
25
|
-
json (
|
|
26
|
-
|
|
27
|
-
addressable (~> 2.8)
|
|
28
|
-
bigdecimal (>= 3.1, < 5)
|
|
29
|
-
language_server-protocol (3.17.0.5)
|
|
22
|
+
json (3.0.2)
|
|
23
|
+
language_server-protocol (3.17.0.6)
|
|
30
24
|
lint_roller (1.1.0)
|
|
31
25
|
logger (1.7.0)
|
|
32
|
-
marcel (1.1
|
|
33
|
-
mcp (0.8.0)
|
|
34
|
-
json-schema (>= 4.1)
|
|
26
|
+
marcel (1.2.1)
|
|
35
27
|
multipart-post (2.4.1)
|
|
36
|
-
net-http (0.
|
|
28
|
+
net-http (0.10.0)
|
|
29
|
+
net-protocol (>= 0.3.0)
|
|
37
30
|
uri (>= 0.11.1)
|
|
38
|
-
|
|
39
|
-
|
|
31
|
+
net-protocol (0.4.0)
|
|
32
|
+
timeout
|
|
33
|
+
parallel (2.3.0)
|
|
34
|
+
parser (3.3.12.0)
|
|
40
35
|
ast (~> 2.4.1)
|
|
41
36
|
racc
|
|
42
37
|
prism (1.9.0)
|
|
43
|
-
public_suffix (7.0.5)
|
|
44
38
|
racc (1.8.1)
|
|
45
39
|
rainbow (3.1.1)
|
|
46
|
-
rake (13.
|
|
47
|
-
regexp_parser (2.
|
|
40
|
+
rake (13.4.2)
|
|
41
|
+
regexp_parser (2.13.1)
|
|
48
42
|
rspec (3.13.2)
|
|
49
43
|
rspec-core (~> 3.13.0)
|
|
50
44
|
rspec-expectations (~> 3.13.0)
|
|
@@ -58,30 +52,30 @@ GEM
|
|
|
58
52
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
59
53
|
rspec-support (~> 3.13.0)
|
|
60
54
|
rspec-support (3.13.7)
|
|
61
|
-
rubocop (1.
|
|
62
|
-
json (
|
|
55
|
+
rubocop (1.92.0)
|
|
56
|
+
json (>= 2.3)
|
|
63
57
|
language_server-protocol (~> 3.17.0.2)
|
|
64
58
|
lint_roller (~> 1.1.0)
|
|
65
|
-
|
|
66
|
-
parallel (~> 1.10)
|
|
59
|
+
parallel (>= 1.10)
|
|
67
60
|
parser (>= 3.3.0.2)
|
|
68
61
|
rainbow (>= 2.2.2, < 4.0)
|
|
69
|
-
regexp_parser (>= 2.
|
|
62
|
+
regexp_parser (>= 2.11.3, < 3.0)
|
|
70
63
|
rubocop-ast (>= 1.49.0, < 2.0)
|
|
71
64
|
ruby-progressbar (~> 1.7)
|
|
72
65
|
unicode-display_width (>= 2.4.0, < 4.0)
|
|
73
|
-
rubocop-ast (1.
|
|
66
|
+
rubocop-ast (1.50.0)
|
|
74
67
|
parser (>= 3.3.7.2)
|
|
75
68
|
prism (~> 1.7)
|
|
76
69
|
ruby-progressbar (1.13.0)
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
70
|
+
timeout (0.6.1)
|
|
71
|
+
unicode-display_width (3.3.0)
|
|
72
|
+
unicode-emoji (~> 4.3)
|
|
73
|
+
unicode-emoji (4.3.0)
|
|
74
|
+
uri (1.1.2)
|
|
81
75
|
|
|
82
76
|
PLATFORMS
|
|
77
|
+
arm64-darwin-24
|
|
83
78
|
ruby
|
|
84
|
-
x86_64-linux
|
|
85
79
|
|
|
86
80
|
DEPENDENCIES
|
|
87
81
|
rake (~> 13.0)
|
|
@@ -90,4 +84,4 @@ DEPENDENCIES
|
|
|
90
84
|
signwell_sdk!
|
|
91
85
|
|
|
92
86
|
BUNDLED WITH
|
|
93
|
-
2.
|
|
87
|
+
2.7.2
|
data/README.md
CHANGED
|
@@ -16,6 +16,17 @@ Or install directly:
|
|
|
16
16
|
gem install signwell_sdk
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
+
## Retries and future API values
|
|
20
|
+
|
|
21
|
+
Explicit HTTP 429 responses retry up to twice, including JSON POST requests and
|
|
22
|
+
downloads. Retry-After seconds or HTTP dates are honored; absent or invalid
|
|
23
|
+
headers use one then two seconds of backoff. A requested wait above 60 seconds
|
|
24
|
+
returns the rate-limit error immediately. Network failures and other status codes
|
|
25
|
+
are not retried by default. Disable SDK retries with `config.max_rate_limit_retries = 0`.
|
|
26
|
+
|
|
27
|
+
Unknown enum strings returned by the API remain readable as `unknown_default_open_api`.
|
|
28
|
+
Known enum values keep their existing API strings.
|
|
29
|
+
|
|
19
30
|
## Quick Start
|
|
20
31
|
|
|
21
32
|
```ruby
|
|
@@ -58,6 +69,50 @@ document = api.create_document(request)
|
|
|
58
69
|
puts document.id
|
|
59
70
|
```
|
|
60
71
|
|
|
72
|
+
Status errors are available under `SignWell::Errors`. HTTP 403 responses raise `PermissionDeniedError`, with `ForbiddenError` kept as an additive alias. Transport failures raise `ApiConnectionError`, with `TransportError` kept as an additive alias. Local required-argument validation uses Ruby's native `ArgumentError`.
|
|
73
|
+
|
|
74
|
+
## Binary Responses
|
|
75
|
+
|
|
76
|
+
Some endpoints return a downloaded file by default and JSON when a mode flag is enabled.
|
|
77
|
+
|
|
78
|
+
```ruby
|
|
79
|
+
bulk_send = SignWell::Resources::BulkSendApi.new
|
|
80
|
+
documents = SignWell::Resources::DocumentApi.new
|
|
81
|
+
regional = SignWell::Resources::RegionalApi.new
|
|
82
|
+
|
|
83
|
+
csv_file = bulk_send.get_bulk_send_csv_template(['00000000-0000-0000-0000-000000000000'])
|
|
84
|
+
csv_json = bulk_send.get_bulk_send_csv_template(
|
|
85
|
+
['00000000-0000-0000-0000-000000000000'],
|
|
86
|
+
base64: true
|
|
87
|
+
)
|
|
88
|
+
|
|
89
|
+
pdf_file = documents.get_completed_pdf('doc_123')
|
|
90
|
+
pdf_url = documents.get_completed_pdf('doc_123', url_only: true)
|
|
91
|
+
|
|
92
|
+
certificate_file = regional.get_nom151_certificate('doc_123')
|
|
93
|
+
certificate_url = regional.get_nom151_certificate('doc_123', url_only: true)
|
|
94
|
+
certificate_object = regional.get_nom151_certificate('doc_123', object_only: true)
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Downloaded files are returned as `Tempfile` objects by default. Set `config.return_binary_data = true` if you want binary response bodies returned as strings.
|
|
98
|
+
|
|
99
|
+
## Rate Limits
|
|
100
|
+
|
|
101
|
+
A 429 raises `SignWell::Errors::RateLimitError`, which carries the throttling headers on `error.rate_limit`:
|
|
102
|
+
|
|
103
|
+
```ruby
|
|
104
|
+
begin
|
|
105
|
+
documents.create_document(body)
|
|
106
|
+
rescue SignWell::Errors::RateLimitError => e
|
|
107
|
+
e.rate_limit.limit # => 100
|
|
108
|
+
e.rate_limit.remaining # => 0
|
|
109
|
+
e.rate_limit.reset_at # => 2026-09-20 21:55:00 UTC
|
|
110
|
+
e.rate_limit.retry_after # => 30
|
|
111
|
+
end
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
`reset` is in seconds either way, but it means two different things: an absolute epoch when the server sends a timestamp (what SignWell sends) or a large number, and a delay from now when it sends a small one. **`reset_at` is set only when `reset` is absolute** — so check it rather than guessing, and prefer `retry_after` / `retry_after_at` when you just want a sleep. Any field the response did not carry is `nil`.
|
|
115
|
+
|
|
61
116
|
## Embedded Signing
|
|
62
117
|
|
|
63
118
|
The embedded API lets you integrate document signing directly into your app via an iframe, instead of redirecting users to SignWell. The `SignWell::Embedded` helper simplifies both the backend (creating documents, extracting URLs) and the frontend (rendering the iframe).
|
|
@@ -67,24 +122,26 @@ The embedded API lets you integrate document signing directly into your app via
|
|
|
67
122
|
```ruby
|
|
68
123
|
doc = SignWell::Embedded.create_signing_document(
|
|
69
124
|
name: 'NDA',
|
|
70
|
-
file_url: 'https://example.com/nda.pdf',
|
|
125
|
+
files: [{ name: 'nda.pdf', file_url: 'https://example.com/nda.pdf' }],
|
|
71
126
|
recipients: [{ name: 'Jane Doe', email: 'jane@example.com' }],
|
|
72
127
|
fields: [[{ x: 20, y: 60, page: 1, type: 'signature' }]]
|
|
73
128
|
)
|
|
74
129
|
|
|
75
130
|
# Get the signing URL for the first recipient
|
|
76
|
-
signing_url = SignWell::Embedded.
|
|
131
|
+
signing_url = SignWell::Embedded.embedded_signing_url(doc)
|
|
77
132
|
|
|
78
133
|
# Or get all signing URLs as { email => url }
|
|
79
|
-
urls = SignWell::Embedded.
|
|
134
|
+
urls = SignWell::Embedded.embedded_signing_urls(doc)
|
|
80
135
|
```
|
|
81
136
|
|
|
137
|
+
Embedded signing documents must provide fields for every recipient, set `with_signature_page: true`, or use `text_tags: true`. The helper validates that shape before making the API request so invalid fieldless signing documents fail locally instead of returning a `422` response.
|
|
138
|
+
|
|
82
139
|
### Backend: Create a draft for embedded requesting (field placement)
|
|
83
140
|
|
|
84
141
|
```ruby
|
|
85
142
|
doc = SignWell::Embedded.create_requesting_document(
|
|
86
143
|
name: 'Contract',
|
|
87
|
-
file_url: 'https://example.com/contract.pdf',
|
|
144
|
+
files: [{ name: 'contract.pdf', file_url: 'https://example.com/contract.pdf' }],
|
|
88
145
|
recipients: [{ name: 'Jane Doe', email: 'jane@example.com' }]
|
|
89
146
|
)
|
|
90
147
|
|
|
@@ -106,7 +163,7 @@ doc = SignWell::Embedded.create_signing_document_from_template(
|
|
|
106
163
|
recipients: [{ placeholder_name: 'Signer 1', name: 'Jane Doe', email: 'jane@example.com' }]
|
|
107
164
|
)
|
|
108
165
|
|
|
109
|
-
signing_url = SignWell::Embedded.
|
|
166
|
+
signing_url = SignWell::Embedded.embedded_signing_url(doc)
|
|
110
167
|
```
|
|
111
168
|
|
|
112
169
|
### Frontend: JavaScript
|
|
@@ -131,10 +188,40 @@ If you use Rails, view helpers are available automatically:
|
|
|
131
188
|
|
|
132
189
|
```erb
|
|
133
190
|
<%= signwell_embed_script_tag %>
|
|
134
|
-
<%= signwell_signing_iframe(url: @signing_url, events: { completed: 'onComplete' }) %>
|
|
191
|
+
<%= signwell_signing_iframe(url: @signing_url, events: { completed: 'SignWellHandlers.onComplete' }) %>
|
|
135
192
|
<%= signwell_requesting_iframe(url: @edit_url) %>
|
|
136
193
|
```
|
|
137
194
|
|
|
195
|
+
Embed helpers only accept HTTPS SignWell URLs by default and reject credentialed URLs, `http:`, `javascript:`, and arbitrary hosts before rendering script output. For non-production SignWell environments, pass exact hostnames through `allowed_embed_hosts`. Redirect URLs must be HTTPS and credential-free; pass `allowed_redirect_hosts` to restrict redirects to your app host.
|
|
196
|
+
|
|
197
|
+
## Webhooks
|
|
198
|
+
|
|
199
|
+
```ruby
|
|
200
|
+
payload = JSON.parse(request.body.read)
|
|
201
|
+
event = payload['event']
|
|
202
|
+
|
|
203
|
+
SignWell::Webhook.verify_event!(
|
|
204
|
+
event: event,
|
|
205
|
+
webhook_id: ENV.fetch('SIGNWELL_WEBHOOK_ID'),
|
|
206
|
+
tolerance_seconds: 300
|
|
207
|
+
)
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
Use replay-aware verification when webhook processing has side effects:
|
|
211
|
+
|
|
212
|
+
```ruby
|
|
213
|
+
REPLAY_STORE = SignWell::Webhook::MemoryReplayStore.new
|
|
214
|
+
|
|
215
|
+
SignWell::Webhook.verify_event_once!(
|
|
216
|
+
event: event,
|
|
217
|
+
webhook_id: ENV.fetch('SIGNWELL_WEBHOOK_ID'),
|
|
218
|
+
tolerance_seconds: 300,
|
|
219
|
+
replay_store: REPLAY_STORE
|
|
220
|
+
)
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
`verify_event` and `verify_event_once` return `false` instead of raising. The in-memory replay store is intended for local development and single-process examples; production apps should back replay protection with Redis, a database, or another shared atomic insert.
|
|
224
|
+
|
|
138
225
|
## Documentation
|
|
139
226
|
|
|
140
227
|
For the full API reference (all resources, models, and methods), see the documentation on gemdocs:
|
|
@@ -15,6 +15,8 @@
|
|
|
15
15
|
| **api_id** | **String** | Unique identifier of the field. Useful when needing to reference specific field values or update a document and its fields. | [optional] |
|
|
16
16
|
| **name** | **String** | Checkbox fields only. At least 2 checkbox fields in an array of fields must be assigned to the same recipient and grouped with selection requirements. | [optional] |
|
|
17
17
|
| **validation** | [**TextValidation**](TextValidation.md) | | [optional] |
|
|
18
|
+
| **validation_regex** | **String** | Text fields with custom validation only: the regex pattern used to validate field values. Required when validation is set to custom. | [optional] |
|
|
19
|
+
| **validation_regex_error_message** | **String** | Text fields with custom validation only: the error message shown to the recipient when their input doesn't match the regex pattern. Required when validation is set to custom. | [optional] |
|
|
18
20
|
| **fixed_width** | **Boolean** | Text fields only: whether the field width will stay fixed and text will display in multiple lines, rather than one long line. If set to `false` the field width will automatically grow horizontally to fit text on one line. Defaults to `false`. | [optional][default to false] |
|
|
19
21
|
| **lock_sign_date** | **Boolean** | Date fields only: makes fields readonly and automatically populates with the date the recipient signed. Defaults to `false`. | [optional][default to false] |
|
|
20
22
|
| **date_format** | [**DateFormat**](DateFormat.md) | | [optional] |
|
|
@@ -42,6 +44,8 @@ instance = SignWell::Models::AdditionalFieldsInnerInner.new(
|
|
|
42
44
|
api_id: null,
|
|
43
45
|
name: null,
|
|
44
46
|
validation: null,
|
|
47
|
+
validation_regex: null,
|
|
48
|
+
validation_regex_error_message: null,
|
|
45
49
|
fixed_width: null,
|
|
46
50
|
lock_sign_date: null,
|
|
47
51
|
date_format: null,
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
# SignWell::Resources::
|
|
1
|
+
# SignWell::Resources::ApiApplicationApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://www.signwell.com*
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**delete_api_application**](
|
|
8
|
-
| [**get_api_application**](
|
|
7
|
+
| [**delete_api_application**](ApiApplicationApi.md#delete_api_application) | **DELETE** /api/v1/api_applications/{id} | Delete API Application |
|
|
8
|
+
| [**get_api_application**](ApiApplicationApi.md#get_api_application) | **GET** /api/v1/api_applications/{id} | Get API Application |
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
## delete_api_application
|
|
@@ -29,14 +29,14 @@ SignWell.configure do |config|
|
|
|
29
29
|
# config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
30
30
|
end
|
|
31
31
|
|
|
32
|
-
api_instance = SignWell::Resources::
|
|
32
|
+
api_instance = SignWell::Resources::ApiApplicationApi.new
|
|
33
33
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
34
34
|
|
|
35
35
|
begin
|
|
36
36
|
# Delete API Application
|
|
37
37
|
api_instance.delete_api_application(id)
|
|
38
38
|
rescue SignWell::Errors::ApiError => e
|
|
39
|
-
puts "Error when calling
|
|
39
|
+
puts "Error when calling ApiApplicationApi->delete_api_application: #{e}"
|
|
40
40
|
end
|
|
41
41
|
```
|
|
42
42
|
|
|
@@ -54,7 +54,7 @@ begin
|
|
|
54
54
|
p headers # => { ... }
|
|
55
55
|
p data # => nil
|
|
56
56
|
rescue SignWell::Errors::ApiError => e
|
|
57
|
-
puts "Error when calling
|
|
57
|
+
puts "Error when calling ApiApplicationApi->delete_api_application_with_http_info: #{e}"
|
|
58
58
|
end
|
|
59
59
|
```
|
|
60
60
|
|
|
@@ -99,7 +99,7 @@ SignWell.configure do |config|
|
|
|
99
99
|
# config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
100
100
|
end
|
|
101
101
|
|
|
102
|
-
api_instance = SignWell::Resources::
|
|
102
|
+
api_instance = SignWell::Resources::ApiApplicationApi.new
|
|
103
103
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
104
104
|
|
|
105
105
|
begin
|
|
@@ -107,7 +107,7 @@ begin
|
|
|
107
107
|
result = api_instance.get_api_application(id)
|
|
108
108
|
p result
|
|
109
109
|
rescue SignWell::Errors::ApiError => e
|
|
110
|
-
puts "Error when calling
|
|
110
|
+
puts "Error when calling ApiApplicationApi->get_api_application: #{e}"
|
|
111
111
|
end
|
|
112
112
|
```
|
|
113
113
|
|
|
@@ -125,7 +125,7 @@ begin
|
|
|
125
125
|
p headers # => { ... }
|
|
126
126
|
p data # => <ApiApplicationResponse>
|
|
127
127
|
rescue SignWell::Errors::ApiError => e
|
|
128
|
-
puts "Error when calling
|
|
128
|
+
puts "Error when calling ApiApplicationApi->get_api_application_with_http_info: #{e}"
|
|
129
129
|
end
|
|
130
130
|
```
|
|
131
131
|
|
data/docs/BulkSendApi.md
CHANGED
|
@@ -156,7 +156,7 @@ end
|
|
|
156
156
|
|
|
157
157
|
## get_bulk_send_csv_template
|
|
158
158
|
|
|
159
|
-
> File get_bulk_send_csv_template(template_ids, opts)
|
|
159
|
+
> Models::BulkSendCsvTemplateResponse or File get_bulk_send_csv_template(template_ids, opts)
|
|
160
160
|
|
|
161
161
|
Get Bulk Send CSV Template
|
|
162
162
|
|
|
@@ -194,7 +194,7 @@ end
|
|
|
194
194
|
|
|
195
195
|
This returns an Array which contains the response data, status code and headers.
|
|
196
196
|
|
|
197
|
-
> <Array(File, Integer, Hash)> get_bulk_send_csv_template_with_http_info(template_ids, opts)
|
|
197
|
+
> <Array(Models::BulkSendCsvTemplateResponse or File, Integer, Hash)> get_bulk_send_csv_template_with_http_info(template_ids, opts)
|
|
198
198
|
|
|
199
199
|
```ruby
|
|
200
200
|
begin
|
|
@@ -202,7 +202,7 @@ begin
|
|
|
202
202
|
data, status_code, headers = api_instance.get_bulk_send_csv_template_with_http_info(template_ids, opts)
|
|
203
203
|
p status_code # => 2xx
|
|
204
204
|
p headers # => { ... }
|
|
205
|
-
p data # => File
|
|
205
|
+
p data # => Models::BulkSendCsvTemplateResponse or File
|
|
206
206
|
rescue SignWell::Errors::ApiError => e
|
|
207
207
|
puts "Error when calling BulkSendApi->get_bulk_send_csv_template_with_http_info: #{e}"
|
|
208
208
|
end
|
|
@@ -217,7 +217,7 @@ end
|
|
|
217
217
|
|
|
218
218
|
### Return type
|
|
219
219
|
|
|
220
|
-
**File**
|
|
220
|
+
**Models::BulkSendCsvTemplateResponse or File**
|
|
221
221
|
|
|
222
222
|
### Authorization
|
|
223
223
|
|
data/docs/BulkSendCsvRequest.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **template_ids** | **Array<String>** | Specify one or more templates to generate a single blank CSV file that will contain available columns for your recipient data. The template_ids[] parameter is an array of template IDs (e.g.,`/?template_ids[]=5a67dbd7-928a-4ea0-a7e2-e476a0eb045f&template_ids[]=d7315111-c671-4b15-8354-c9a19bbaefa0`). Each ID should be a separate parameter in the query string. | |
|
|
8
|
-
| **bulk_send_csv** | **String** | A RFC 4648 base64 string of the template CSV file to be validated. | |
|
|
8
|
+
| **bulk_send_csv** | **String** | A RFC 4648 base64 string of the template CSV file to be validated. While 21 CFR Part 11 is enabled, every recipient needs a name: the CSV must carry a name column next to each placeholder email column (for example `signer_name` alongside `signer_email`), and each row must fill that name in wherever it carries the matching email, otherwise it returns a 422. A row that leaves both the email and the name blank sends nothing to that placeholder, so no name is needed there. | |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# SignWell::Models::ConditionalLogicDecisionInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **rule_id** | **String** | External ID of the conditional rule that fired | |
|
|
8
|
+
| **field_api_id** | **String** | api_id of the field the decision applies to | |
|
|
9
|
+
| **decision_type** | **String** | Whether the signer kept the existing signature or the value was cleared | |
|
|
10
|
+
| **decided_at** | **Time** | When the decision was recorded | |
|
|
11
|
+
| **description** | **String** | Human-readable summary of the decision | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'signwell_sdk'
|
|
17
|
+
|
|
18
|
+
instance = SignWell::Models::ConditionalLogicDecisionInfo.new(
|
|
19
|
+
rule_id: null,
|
|
20
|
+
field_api_id: null,
|
|
21
|
+
decision_type: null,
|
|
22
|
+
decided_at: null,
|
|
23
|
+
description: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# SignWell::Models::ConditionalRuleInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Conditional rule ID | |
|
|
8
|
+
| **target_id** | **String** | api_id of the field that owns the rule, or the external_id of a checkbox group when the rule is owned by a group (groups have no api_id) | |
|
|
9
|
+
| **action_type** | **String** | Action applied to action_field_ids when the conditions are met | |
|
|
10
|
+
| **action_field_ids** | **Array<String>** | api_ids of fields the rule affects when triggered | [optional] |
|
|
11
|
+
| **conditions** | [**Array<ConditionalRuleInfoConditionsInner>**](ConditionalRuleInfoConditionsInner.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'signwell_sdk'
|
|
17
|
+
|
|
18
|
+
instance = SignWell::Models::ConditionalRuleInfo.new(
|
|
19
|
+
id: null,
|
|
20
|
+
target_id: null,
|
|
21
|
+
action_type: null,
|
|
22
|
+
action_field_ids: null,
|
|
23
|
+
conditions: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# SignWell::Models::ConditionalRuleInfoConditionsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **condition_type** | **String** | How field_api_ids combine within this condition | [optional] |
|
|
8
|
+
| **status** | **String** | Field state that satisfies this condition | [optional] |
|
|
9
|
+
| **join_operator** | **String** | How this condition joins with the next one in the rule | [optional] |
|
|
10
|
+
| **field_api_ids** | **Array<String>** | api_ids of fields evaluated by this condition | [optional] |
|
|
11
|
+
| **position** | **Integer** | Order of this condition within the rule | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'signwell_sdk'
|
|
17
|
+
|
|
18
|
+
instance = SignWell::Models::ConditionalRuleInfoConditionsInner.new(
|
|
19
|
+
condition_type: null,
|
|
20
|
+
status: null,
|
|
21
|
+
join_operator: null,
|
|
22
|
+
field_api_ids: null,
|
|
23
|
+
position: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# SignWell::Models::ConditionalRuleRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The rule's persistent ID. Ignored on create (every rule is new). On an update (template update or document update-and-send) include it to modify an existing rule, or pair it with `deleted: true` to remove the rule; omit it to add a new rule. | [optional] |
|
|
8
|
+
| **deleted** | **Boolean** | Only meaningful on an update (template update or document update-and-send): set to true together with the rule's `id` to remove that rule. Ignored on create — there is no existing rule to delete. | [optional] |
|
|
9
|
+
| **target_id** | **String** | api_id of the field that owns the rule, or the external_id of a checkbox group when the rule is owned by a group (groups have no api_id). Cannot also appear in action_field_ids (self-reference is forbidden). | [optional] |
|
|
10
|
+
| **action_type** | **String** | Action applied to action_field_ids when the conditions are met: `show`, `hide`, or `require`. | [optional] |
|
|
11
|
+
| **action_field_ids** | **Array<String>** | api_ids of the fields the action applies to. List a checkbox group's member api_ids to target the whole group. | [optional] |
|
|
12
|
+
| **conditions** | [**Array<ConditionalRuleRequestConditionsInner>**](ConditionalRuleRequestConditionsInner.md) | The conditions that trigger the rule. At least 1, at most 5. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'signwell_sdk'
|
|
18
|
+
|
|
19
|
+
instance = SignWell::Models::ConditionalRuleRequest.new(
|
|
20
|
+
id: null,
|
|
21
|
+
deleted: null,
|
|
22
|
+
target_id: null,
|
|
23
|
+
action_type: null,
|
|
24
|
+
action_field_ids: null,
|
|
25
|
+
conditions: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# SignWell::Models::ConditionalRuleRequestConditionsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **condition_type** | **String** | How the field_api_ids combine within a condition: `any_of`, `all_of`, `none_of`, or `not_all_of`. | |
|
|
8
|
+
| **status** | **String** | The field state the condition tests for: `completed` or `not_completed`. | |
|
|
9
|
+
| **join_operator** | **String** | How this condition joins the next one in the rule: `and_operator` or `or_operator`. The first condition's value is ignored. | [optional] |
|
|
10
|
+
| **field_api_ids** | **Array<String>** | api_ids of the trigger fields the condition watches. | |
|
|
11
|
+
| **position** | **Integer** | 1-indexed order of the condition within the rule. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'signwell_sdk'
|
|
17
|
+
|
|
18
|
+
instance = SignWell::Models::ConditionalRuleRequestConditionsInner.new(
|
|
19
|
+
condition_type: null,
|
|
20
|
+
status: null,
|
|
21
|
+
join_operator: null,
|
|
22
|
+
field_api_ids: null,
|
|
23
|
+
position: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | Name of the placeholder. | |
|
|
8
|
-
| **preassigned_recipient_name** | **String** | In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the name. | [optional] |
|
|
8
|
+
| **preassigned_recipient_name** | **String** | In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the name. Every recipient on a 21 CFR Part 11 document needs a name, so leaving it unset means the name has to be supplied when the document is created. | [optional] |
|
|
9
9
|
| **preassigned_recipient_email** | **String** | In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the email. | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **template_ids** | **Array<String>** | Unique identifiers for a list of templates. | |
|
|
8
|
-
| **bulk_send_csv** | **String** | A RFC 4648 base64 string of the template CSV file to be validated. | |
|
|
7
|
+
| **template_ids** | **Array<String>** | Unique identifiers for a list of templates. A template that carries a pre-applied signature or initials field cannot be used while 21 CFR Part 11 is enabled, which requires every signature to be signed by the recipient: it returns a 422. | |
|
|
8
|
+
| **bulk_send_csv** | **String** | A RFC 4648 base64 string of the template CSV file to be validated. While 21 CFR Part 11 is enabled, every recipient needs a name: the CSV must carry a name column next to each placeholder email column (for example `signer_name` alongside `signer_email`), and each row must fill that name in wherever it carries the matching email, otherwise it returns a 422. A row that leaves both the email and the name blank sends nothing to that placeholder, so no name is needed there. | |
|
|
9
9
|
| **skip_row_errors** | **Boolean** | Whether to skip errors in the rows. Defaults to `false`. | [optional][default to false] |
|
|
10
10
|
| **api_application_id** | **String** | Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more control over embedded API settings | [optional] |
|
|
11
11
|
| **name** | **String** | The name of the Bulk Send. Will be used as the document name for each of the documents. | [optional] |
|