signwell_sdk 0.1.2 → 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/workflows/ci.yml +3 -3
- data/.github/workflows/generator-ownership.yml +1 -1
- data/.github/workflows/manual-release.yml +1 -1
- data/.github/workflows/release.yml +1 -1
- data/.release-please-manifest.json +1 -1
- data/CHANGELOG.md +20 -0
- data/Gemfile.lock +16 -12
- data/README.md +11 -0
- data/docs/AdditionalFieldsInnerInner.md +4 -0
- 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 +82 -8
- data/docs/DocumentFromTemplateRequest.md +11 -3
- data/docs/DocumentFromTemplateResponse.md +11 -1
- data/docs/DocumentFromTemplateResponseFieldsInnerInner.md +4 -0
- data/docs/DocumentFromTemplateResponseRecipientsInner.md +6 -0
- data/docs/DocumentRequest.md +10 -4
- data/docs/DocumentResponse.md +11 -1
- data/docs/DocumentResponseFieldsInnerInner.md +4 -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/PlaceholdersInner.md +4 -2
- data/docs/PlaceholdersInnerPasscodeDelivery.md +22 -0
- data/docs/RecipientsInner.md +14 -4
- data/docs/RecipientsInnerPasscodeDelivery.md +22 -0
- data/docs/ReminderRecipientsInner.md +1 -1
- data/docs/SendReminderRequest.md +1 -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/WebhooksApi.md +1 -1
- data/lib/signwell_sdk/api/api_application_api.rb +1 -2
- data/lib/signwell_sdk/api/bulk_send_api.rb +1 -2
- data/lib/signwell_sdk/api/document_api.rb +87 -14
- data/lib/signwell_sdk/api/me_api.rb +1 -2
- data/lib/signwell_sdk/api/regional_api.rb +1 -2
- data/lib/signwell_sdk/api/template_api.rb +1 -2
- data/lib/signwell_sdk/api/webhooks_api.rb +3 -4
- data/lib/signwell_sdk/api_client.rb +26 -6
- data/lib/signwell_sdk/api_error.rb +1 -2
- data/lib/signwell_sdk/api_model_base.rb +88 -0
- data/lib/signwell_sdk/configuration.rb +1 -1
- data/lib/signwell_sdk/extras/rate_limit.rb +17 -0
- data/lib/signwell_sdk/models/account_info_response.rb +1 -2
- data/lib/signwell_sdk/models/account_info_response_active_users_inner.rb +1 -2
- data/lib/signwell_sdk/models/account_info_response_preferences.rb +1 -2
- data/lib/signwell_sdk/models/additional_fields_inner_inner.rb +24 -3
- data/lib/signwell_sdk/models/additional_fields_inner_inner_value.rb +3 -4
- data/lib/signwell_sdk/models/additional_files_inner.rb +1 -2
- data/lib/signwell_sdk/models/api_application_response.rb +1 -2
- data/lib/signwell_sdk/models/api_application_response_owner.rb +1 -2
- data/lib/signwell_sdk/models/api_application_response_preferences.rb +1 -2
- data/lib/signwell_sdk/models/attachment_request_info.rb +1 -2
- data/lib/signwell_sdk/models/attachment_requests_inner.rb +1 -2
- data/lib/signwell_sdk/models/bulk_send_create_response.rb +1 -2
- data/lib/signwell_sdk/models/bulk_send_csv_request.rb +2 -3
- data/lib/signwell_sdk/models/bulk_send_csv_template_response.rb +1 -2
- data/lib/signwell_sdk/models/bulk_send_documents_response.rb +1 -2
- data/lib/signwell_sdk/models/bulk_send_list_item.rb +1 -2
- data/lib/signwell_sdk/models/bulk_send_list_response.rb +1 -2
- data/lib/signwell_sdk/models/bulk_send_response.rb +1 -2
- data/lib/signwell_sdk/models/bulk_send_response_templates_inner.rb +1 -2
- data/lib/signwell_sdk/models/bulk_send_validate_csv_response.rb +1 -2
- data/lib/signwell_sdk/models/checkbox_group_info.rb +1 -2
- data/lib/signwell_sdk/models/checkbox_groups_inner.rb +1 -2
- data/lib/signwell_sdk/models/checkbox_validation.rb +4 -3
- data/lib/signwell_sdk/models/completed_pdf_response.rb +3 -4
- data/lib/signwell_sdk/models/completed_pdf_url_response.rb +1 -2
- 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 +1 -2
- data/lib/signwell_sdk/models/copied_contacts_inner.rb +1 -2
- data/lib/signwell_sdk/models/copied_placeholders_inner.rb +2 -3
- data/lib/signwell_sdk/models/create_bulk_send_request.rb +3 -4
- data/lib/signwell_sdk/models/create_webhook_request.rb +1 -2
- data/lib/signwell_sdk/models/date_format.rb +4 -3
- data/lib/signwell_sdk/models/detailed_option.rb +1 -2
- data/lib/signwell_sdk/models/document_from_template_request.rb +90 -6
- data/lib/signwell_sdk/models/document_from_template_response.rb +101 -6
- data/lib/signwell_sdk/models/document_from_template_response_fields_inner_inner.rb +24 -3
- data/lib/signwell_sdk/models/document_from_template_response_fields_inner_inner_recipient.rb +1 -2
- data/lib/signwell_sdk/models/document_from_template_response_recipients_inner.rb +71 -3
- data/lib/signwell_sdk/models/document_list_response.rb +1 -2
- data/lib/signwell_sdk/models/document_request.rb +42 -7
- data/lib/signwell_sdk/models/document_response.rb +101 -6
- data/lib/signwell_sdk/models/document_response_attachment_requests_inner.rb +1 -2
- data/lib/signwell_sdk/models/document_response_fields_inner_inner.rb +24 -3
- data/lib/signwell_sdk/models/document_response_fields_inner_inner_options_inner.rb +1 -2
- data/lib/signwell_sdk/models/document_response_fields_inner_inner_recipient.rb +1 -2
- data/lib/signwell_sdk/models/document_response_fields_inner_inner_value.rb +3 -4
- data/lib/signwell_sdk/models/document_response_recipients_inner.rb +71 -3
- 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 +1 -2
- data/lib/signwell_sdk/models/document_template_request.rb +18 -6
- data/lib/signwell_sdk/models/document_template_response.rb +17 -6
- data/lib/signwell_sdk/models/document_template_response_copied_placeholders_inner.rb +1 -2
- data/lib/signwell_sdk/models/document_template_response_placeholders_inner.rb +15 -6
- data/lib/signwell_sdk/models/document_template_update_request.rb +18 -6
- data/lib/signwell_sdk/models/dropdown_option.rb +3 -4
- 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 +1 -2
- data/lib/signwell_sdk/models/error_response_meta.rb +1 -2
- data/lib/signwell_sdk/models/field_type.rb +4 -3
- data/lib/signwell_sdk/models/fields_inner_inner.rb +24 -3
- data/lib/signwell_sdk/models/file_format.rb +4 -3
- data/lib/signwell_sdk/models/file_info.rb +1 -2
- data/lib/signwell_sdk/models/files_inner.rb +1 -2
- data/lib/signwell_sdk/models/label_info.rb +1 -2
- data/lib/signwell_sdk/models/label_request.rb +1 -2
- data/lib/signwell_sdk/models/label_response.rb +1 -2
- data/lib/signwell_sdk/models/me_response.rb +1 -2
- data/lib/signwell_sdk/models/me_response_contact.rb +1 -2
- data/lib/signwell_sdk/models/me_response_user.rb +1 -2
- data/lib/signwell_sdk/models/me_response_user_preferences.rb +1 -2
- data/lib/signwell_sdk/models/nom151_certificate_response.rb +1 -2
- data/lib/signwell_sdk/models/nom151_certificate_response_nom151.rb +1 -2
- data/lib/signwell_sdk/models/nom151_url_response.rb +1 -2
- data/lib/signwell_sdk/models/pagination_meta.rb +1 -2
- data/lib/signwell_sdk/models/placeholders_inner.rb +16 -7
- data/lib/signwell_sdk/models/placeholders_inner_passcode_delivery.rb +271 -0
- data/lib/signwell_sdk/models/rate_limit_error_response.rb +1 -2
- data/lib/signwell_sdk/models/recipients_inner.rb +103 -23
- data/lib/signwell_sdk/models/recipients_inner_passcode_delivery.rb +271 -0
- data/lib/signwell_sdk/models/reminder_recipients_inner.rb +2 -3
- data/lib/signwell_sdk/models/send_reminder_request.rb +2 -3
- data/lib/signwell_sdk/models/template_attachment_requests_inner.rb +1 -2
- data/lib/signwell_sdk/models/template_checkbox_groups_inner.rb +1 -2
- data/lib/signwell_sdk/models/template_field_values_inner.rb +1 -2
- data/lib/signwell_sdk/models/template_field_values_inner_value.rb +3 -4
- data/lib/signwell_sdk/models/template_fields_inner_inner.rb +24 -3
- data/lib/signwell_sdk/models/template_recipients_inner.rb +103 -23
- data/lib/signwell_sdk/models/text_validation.rb +5 -3
- 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 +41 -6
- data/lib/signwell_sdk/models/update_recipients_map_inner.rb +16 -7
- data/lib/signwell_sdk/models/update_recipients_map_inner_passcode_delivery.rb +271 -0
- data/lib/signwell_sdk/models/update_recipients_request.rb +1 -2
- data/lib/signwell_sdk/models/validation_error_response.rb +1 -2
- data/lib/signwell_sdk/models/webhook_response.rb +1 -2
- data/lib/signwell_sdk/version.rb +4 -4
- data/lib/signwell_sdk.rb +19 -2
- data/openapi.yaml +2231 -972
- data/package-lock.json +542 -136
- data/package.json +4 -1
- data/signwell_sdk.gemspec +1 -2
- data/spec/api/api_application_api_spec.rb +1 -2
- data/spec/api/bulk_send_api_spec.rb +1 -2
- data/spec/api/document_api_spec.rb +11 -4
- data/spec/api/me_api_spec.rb +1 -2
- data/spec/api/regional_api_spec.rb +1 -2
- data/spec/api/template_api_spec.rb +1 -2
- data/spec/api/webhooks_api_spec.rb +1 -2
- data/spec/models/account_info_response_active_users_inner_spec.rb +1 -2
- data/spec/models/account_info_response_preferences_spec.rb +1 -2
- data/spec/models/account_info_response_spec.rb +1 -2
- data/spec/models/additional_fields_inner_inner_spec.rb +13 -2
- data/spec/models/additional_fields_inner_inner_value_spec.rb +1 -2
- data/spec/models/additional_files_inner_spec.rb +1 -2
- data/spec/models/api_application_response_owner_spec.rb +1 -2
- data/spec/models/api_application_response_preferences_spec.rb +1 -2
- data/spec/models/api_application_response_spec.rb +1 -2
- data/spec/models/attachment_request_info_spec.rb +1 -2
- data/spec/models/attachment_requests_inner_spec.rb +1 -2
- data/spec/models/bulk_send_create_response_spec.rb +1 -2
- data/spec/models/bulk_send_csv_request_spec.rb +1 -2
- data/spec/models/bulk_send_csv_template_response_spec.rb +1 -2
- data/spec/models/bulk_send_documents_response_spec.rb +1 -2
- data/spec/models/bulk_send_list_item_spec.rb +1 -2
- data/spec/models/bulk_send_list_response_spec.rb +1 -2
- data/spec/models/bulk_send_response_spec.rb +1 -2
- data/spec/models/bulk_send_response_templates_inner_spec.rb +1 -2
- data/spec/models/bulk_send_validate_csv_response_spec.rb +1 -2
- data/spec/models/checkbox_group_info_spec.rb +1 -2
- data/spec/models/checkbox_groups_inner_spec.rb +1 -2
- data/spec/models/checkbox_validation_spec.rb +1 -2
- data/spec/models/completed_pdf_response_spec.rb +1 -2
- data/spec/models/completed_pdf_url_response_spec.rb +1 -2
- 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 +1 -2
- data/spec/models/copied_contacts_inner_spec.rb +1 -2
- data/spec/models/copied_placeholders_inner_spec.rb +1 -2
- data/spec/models/create_bulk_send_request_spec.rb +1 -2
- data/spec/models/create_webhook_request_spec.rb +1 -2
- data/spec/models/date_format_spec.rb +1 -2
- data/spec/models/detailed_option_spec.rb +1 -2
- data/spec/models/document_from_template_request_spec.rb +25 -2
- data/spec/models/document_from_template_response_fields_inner_inner_recipient_spec.rb +1 -2
- data/spec/models/document_from_template_response_fields_inner_inner_spec.rb +13 -2
- data/spec/models/document_from_template_response_recipients_inner_spec.rb +19 -2
- data/spec/models/document_from_template_response_spec.rb +31 -2
- data/spec/models/document_list_response_spec.rb +1 -2
- data/spec/models/document_request_spec.rb +19 -2
- data/spec/models/document_response_attachment_requests_inner_spec.rb +1 -2
- data/spec/models/document_response_fields_inner_inner_options_inner_spec.rb +1 -2
- data/spec/models/document_response_fields_inner_inner_recipient_spec.rb +1 -2
- data/spec/models/document_response_fields_inner_inner_spec.rb +13 -2
- data/spec/models/document_response_fields_inner_inner_value_spec.rb +1 -2
- 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 +19 -2
- data/spec/models/document_response_spec.rb +31 -2
- data/spec/models/document_template_list_response_spec.rb +1 -2
- data/spec/models/document_template_request_spec.rb +7 -2
- data/spec/models/document_template_response_copied_placeholders_inner_spec.rb +1 -2
- data/spec/models/document_template_response_placeholders_inner_spec.rb +7 -2
- data/spec/models/document_template_response_spec.rb +7 -2
- data/spec/models/document_template_update_request_spec.rb +7 -2
- data/spec/models/dropdown_option_spec.rb +1 -2
- 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 +1 -2
- data/spec/models/error_response_spec.rb +1 -2
- data/spec/models/field_type_spec.rb +1 -2
- data/spec/models/fields_inner_inner_spec.rb +13 -2
- data/spec/models/file_format_spec.rb +1 -2
- data/spec/models/file_info_spec.rb +1 -2
- data/spec/models/files_inner_spec.rb +1 -2
- data/spec/models/label_info_spec.rb +1 -2
- data/spec/models/label_request_spec.rb +1 -2
- data/spec/models/label_response_spec.rb +1 -2
- data/spec/models/me_response_contact_spec.rb +1 -2
- data/spec/models/me_response_spec.rb +1 -2
- data/spec/models/me_response_user_preferences_spec.rb +1 -2
- data/spec/models/me_response_user_spec.rb +1 -2
- data/spec/models/nom151_certificate_response_nom151_spec.rb +1 -2
- data/spec/models/nom151_certificate_response_spec.rb +1 -2
- data/spec/models/nom151_url_response_spec.rb +1 -2
- data/spec/models/pagination_meta_spec.rb +1 -2
- data/spec/models/placeholders_inner_passcode_delivery_spec.rb +46 -0
- data/spec/models/placeholders_inner_spec.rb +7 -2
- data/spec/models/rate_limit_error_response_spec.rb +1 -2
- data/spec/models/recipients_inner_passcode_delivery_spec.rb +46 -0
- data/spec/models/recipients_inner_spec.rb +31 -2
- data/spec/models/reminder_recipients_inner_spec.rb +1 -2
- data/spec/models/send_reminder_request_spec.rb +1 -2
- data/spec/models/template_attachment_requests_inner_spec.rb +1 -2
- data/spec/models/template_checkbox_groups_inner_spec.rb +1 -2
- data/spec/models/template_field_values_inner_spec.rb +1 -2
- data/spec/models/template_field_values_inner_value_spec.rb +1 -2
- data/spec/models/template_fields_inner_inner_spec.rb +13 -2
- data/spec/models/template_recipients_inner_spec.rb +31 -2
- data/spec/models/text_validation_spec.rb +1 -2
- 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 +19 -2
- data/spec/models/update_recipients_map_inner_passcode_delivery_spec.rb +46 -0
- data/spec/models/update_recipients_map_inner_spec.rb +7 -2
- data/spec/models/update_recipients_request_spec.rb +1 -2
- data/spec/models/validation_error_response_spec.rb +1 -2
- data/spec/models/webhook_response_spec.rb +1 -2
- data/spec/regressions/api_client_spec.rb +56 -1
- data/spec/spec_helper.rb +1 -2
- metadata +73 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 26737c81ef2605b70dd33c3c153d571c63161649688a5eeb7855b58fb6d2f9dd
|
|
4
|
+
data.tar.gz: 25a3d1b47d81f5a4d97257913fec9a6c425eb209f56d3bfbebef7c85a9149f65
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 064f791c14b5c3c5fc5263a49daf4f1cd2a0543abdca791d88e2459505a93e16c187a08fbd76b642f80626ad2d1c79383e4fb6b8cc8cca1d84c771459ece973b
|
|
7
|
+
data.tar.gz: 0524a3800750317c2a6846b812b067458c49520aee1d01e5320cb75919c938ffa8e93b4afd82b55086d28f629d305ba862f0199794b90e97ed90e8964094d8f8
|
data/.github/workflows/ci.yml
CHANGED
|
@@ -19,11 +19,11 @@ jobs:
|
|
|
19
19
|
faraday-version: '1'
|
|
20
20
|
name: Ruby ${{ matrix.ruby-version }} / Faraday ${{ matrix.faraday-version }}
|
|
21
21
|
steps:
|
|
22
|
-
- uses: actions/checkout@
|
|
22
|
+
- uses: actions/checkout@v7
|
|
23
23
|
|
|
24
|
-
- uses: actions/setup-node@
|
|
24
|
+
- uses: actions/setup-node@v7
|
|
25
25
|
with:
|
|
26
|
-
node-version: '
|
|
26
|
+
node-version: '24'
|
|
27
27
|
|
|
28
28
|
- name: Start Prism mock server
|
|
29
29
|
run: |
|
data/CHANGELOG.md
CHANGED
|
@@ -1,4 +1,24 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.2.0 — 2026-10-29
|
|
4
|
+
|
|
5
|
+
### Added
|
|
6
|
+
|
|
7
|
+
- Support the current documented SMS delivery fields, conditional rules and decisions, and embedded signing/branding options.
|
|
8
|
+
- Expose 21 CFR Part 11 indicators in document responses and updated passcode-delivery settings.
|
|
9
|
+
- Add the document authentication update endpoint.
|
|
10
|
+
|
|
11
|
+
### Changed
|
|
12
|
+
|
|
13
|
+
- Retry explicit HTTP 429 responses up to twice by default, with Retry-After, bounded backoff, and opt-out.
|
|
14
|
+
- Preserve future enum response values and false/integer union values.
|
|
15
|
+
|
|
16
|
+
- Refresh generated resources, request/response models, and API documentation from the current published SignWell API.
|
|
17
|
+
- Regenerate with OpenAPI Generator 7.26.0 while preserving existing minimum runtimes.
|
|
18
|
+
|
|
19
|
+
### Dependencies
|
|
20
|
+
|
|
21
|
+
- Refresh the Ruby dependency lockfile.
|
|
22
|
+
|
|
3
23
|
For a detailed list of changes in each release, see
|
|
4
24
|
[GitHub Releases](https://github.com/Bidsketch/signwell-sdk-ruby/releases).
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
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
6
|
faraday-multipart (~> 1.0, >= 1.0.0)
|
|
7
7
|
marcel (~> 1.0, >= 1.0.0)
|
|
@@ -25,9 +25,12 @@ GEM
|
|
|
25
25
|
logger (1.7.0)
|
|
26
26
|
marcel (1.2.1)
|
|
27
27
|
multipart-post (2.4.1)
|
|
28
|
-
net-http (0.
|
|
28
|
+
net-http (0.10.0)
|
|
29
|
+
net-protocol (>= 0.3.0)
|
|
29
30
|
uri (>= 0.11.1)
|
|
30
|
-
|
|
31
|
+
net-protocol (0.4.0)
|
|
32
|
+
timeout
|
|
33
|
+
parallel (2.3.0)
|
|
31
34
|
parser (3.3.12.0)
|
|
32
35
|
ast (~> 2.4.1)
|
|
33
36
|
racc
|
|
@@ -35,7 +38,7 @@ GEM
|
|
|
35
38
|
racc (1.8.1)
|
|
36
39
|
rainbow (3.1.1)
|
|
37
40
|
rake (13.4.2)
|
|
38
|
-
regexp_parser (2.
|
|
41
|
+
regexp_parser (2.13.1)
|
|
39
42
|
rspec (3.13.2)
|
|
40
43
|
rspec-core (~> 3.13.0)
|
|
41
44
|
rspec-expectations (~> 3.13.0)
|
|
@@ -49,14 +52,14 @@ GEM
|
|
|
49
52
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
50
53
|
rspec-support (~> 3.13.0)
|
|
51
54
|
rspec-support (3.13.7)
|
|
52
|
-
rubocop (1.
|
|
55
|
+
rubocop (1.92.0)
|
|
53
56
|
json (>= 2.3)
|
|
54
57
|
language_server-protocol (~> 3.17.0.2)
|
|
55
58
|
lint_roller (~> 1.1.0)
|
|
56
59
|
parallel (>= 1.10)
|
|
57
60
|
parser (>= 3.3.0.2)
|
|
58
61
|
rainbow (>= 2.2.2, < 4.0)
|
|
59
|
-
regexp_parser (>= 2.
|
|
62
|
+
regexp_parser (>= 2.11.3, < 3.0)
|
|
60
63
|
rubocop-ast (>= 1.49.0, < 2.0)
|
|
61
64
|
ruby-progressbar (~> 1.7)
|
|
62
65
|
unicode-display_width (>= 2.4.0, < 4.0)
|
|
@@ -64,14 +67,15 @@ GEM
|
|
|
64
67
|
parser (>= 3.3.7.2)
|
|
65
68
|
prism (~> 1.7)
|
|
66
69
|
ruby-progressbar (1.13.0)
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
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)
|
|
71
75
|
|
|
72
76
|
PLATFORMS
|
|
77
|
+
arm64-darwin-24
|
|
73
78
|
ruby
|
|
74
|
-
x86_64-linux
|
|
75
79
|
|
|
76
80
|
DEPENDENCIES
|
|
77
81
|
rake (~> 13.0)
|
|
@@ -80,4 +84,4 @@ DEPENDENCIES
|
|
|
80
84
|
signwell_sdk!
|
|
81
85
|
|
|
82
86
|
BUNDLED WITH
|
|
83
|
-
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
|
|
@@ -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,
|
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] |
|
data/docs/DocumentApi.md
CHANGED
|
@@ -12,6 +12,7 @@ All URIs are relative to *https://www.signwell.com*
|
|
|
12
12
|
| [**list_documents**](DocumentApi.md#list_documents) | **GET** /api/v1/documents | List Documents |
|
|
13
13
|
| [**send_document**](DocumentApi.md#send_document) | **POST** /api/v1/documents/{id}/send | Update and Send Document |
|
|
14
14
|
| [**send_reminder**](DocumentApi.md#send_reminder) | **POST** /api/v1/documents/{id}/remind | Send Reminder |
|
|
15
|
+
| [**update_authentication**](DocumentApi.md#update_authentication) | **PATCH** /api/v1/documents/{id}/authentication | Update Authentication |
|
|
15
16
|
| [**update_recipients**](DocumentApi.md#update_recipients) | **PATCH** /api/v1/documents/{id}/recipients | Update Recipients |
|
|
16
17
|
|
|
17
18
|
|
|
@@ -21,7 +22,7 @@ All URIs are relative to *https://www.signwell.com*
|
|
|
21
22
|
|
|
22
23
|
Create Document
|
|
23
24
|
|
|
24
|
-
Creates and optionally sends a new document for signing. If `draft` is set to true the document will not be sent.
|
|
25
|
+
Creates and optionally sends a new document for signing. If `draft` is set to true the document will not be sent. Recipients are notified by email, SMS, or both based on each recipient's `delivery_method`. SMS delivery is available only to workspaces that are eligible for SMS and have it enabled, and requires a `phone_number` in E.164 format.
|
|
25
26
|
|
|
26
27
|
### Examples
|
|
27
28
|
|
|
@@ -37,7 +38,7 @@ SignWell.configure do |config|
|
|
|
37
38
|
end
|
|
38
39
|
|
|
39
40
|
api_instance = SignWell::Resources::DocumentApi.new
|
|
40
|
-
document_request = SignWell::DocumentRequest.new({files: [SignWell::FilesInner.new({name: 'name_example'})], recipients: [SignWell::RecipientsInner.new({id: 'id_example'
|
|
41
|
+
document_request = SignWell::DocumentRequest.new({files: [SignWell::FilesInner.new({name: 'name_example'})], recipients: [SignWell::RecipientsInner.new({id: 'id_example'})]}) # DocumentRequest |
|
|
41
42
|
|
|
42
43
|
begin
|
|
43
44
|
# Create Document
|
|
@@ -92,7 +93,7 @@ end
|
|
|
92
93
|
|
|
93
94
|
Create Document from Template
|
|
94
95
|
|
|
95
|
-
Creates and optionally sends a new document for signing. If `draft` is set to true the document will not be sent.
|
|
96
|
+
Creates and optionally sends a new document for signing. If `draft` is set to true the document will not be sent. Pre-signed template signatures and initials are copied to the new document as document content — they remain visible on the document but do not generate a signing event, do not emit a `document_signed` webhook, and the recipient's status will not reflect them as a real signing action. If the template was pre-signed for a signer and the request adds new unsigned signature/initials fields for that same signer, the pre-applied ratifications are cleared silently so the signer is asked to sign once. Recipients are notified by email, SMS, or both based on each recipient's `delivery_method`. SMS delivery is available only to workspaces that are eligible for SMS and have it enabled, and requires a `phone_number` in E.164 format.
|
|
96
97
|
|
|
97
98
|
### Examples
|
|
98
99
|
|
|
@@ -108,7 +109,7 @@ SignWell.configure do |config|
|
|
|
108
109
|
end
|
|
109
110
|
|
|
110
111
|
api_instance = SignWell::Resources::DocumentApi.new
|
|
111
|
-
document_from_template_request = SignWell::DocumentFromTemplateRequest.new({recipients: [SignWell::TemplateRecipientsInner.new({id: 'id_example'
|
|
112
|
+
document_from_template_request = SignWell::DocumentFromTemplateRequest.new({recipients: [SignWell::TemplateRecipientsInner.new({id: 'id_example'})]}) # DocumentFromTemplateRequest |
|
|
112
113
|
|
|
113
114
|
begin
|
|
114
115
|
# Create Document from Template
|
|
@@ -312,7 +313,7 @@ end
|
|
|
312
313
|
|
|
313
314
|
Get Document
|
|
314
315
|
|
|
315
|
-
Returns a document and all associated document data. Supply the unique document ID from either a document creation request or Document page URL.
|
|
316
|
+
Returns a document and all associated document data. Supply the unique document ID from either a document creation request or Document page URL. Each recipient includes its `delivery_method`, and recipients whose delivery includes SMS also include an `sms` object with the masked phone number and SMS delivery status.
|
|
316
317
|
|
|
317
318
|
### Examples
|
|
318
319
|
|
|
@@ -460,7 +461,7 @@ end
|
|
|
460
461
|
|
|
461
462
|
Update and Send Document
|
|
462
463
|
|
|
463
|
-
Updates a draft document and sends it to be signed by recipients.
|
|
464
|
+
Updates a draft document and sends it to be signed by recipients. `subject` and `message` apply to email notifications only; SMS notifications always use fixed system templates.
|
|
464
465
|
|
|
465
466
|
### Examples
|
|
466
467
|
|
|
@@ -533,7 +534,7 @@ end
|
|
|
533
534
|
|
|
534
535
|
Send Reminder
|
|
535
536
|
|
|
536
|
-
Sends a reminder
|
|
537
|
+
Sends a reminder to recipients who have not signed yet. Each recipient is reminded through their delivery method (email, SMS, or both). SMS reminders are only sent to recipients whose delivery method includes SMS, and only when the workspace is eligible for SMS and has it enabled.
|
|
537
538
|
|
|
538
539
|
### Examples
|
|
539
540
|
|
|
@@ -599,13 +600,86 @@ nil (empty response body)
|
|
|
599
600
|
- **Accept**: application/json
|
|
600
601
|
|
|
601
602
|
|
|
603
|
+
## update_authentication
|
|
604
|
+
|
|
605
|
+
> <DocumentResponse> update_authentication(id, update_authentication_request)
|
|
606
|
+
|
|
607
|
+
Update Authentication
|
|
608
|
+
|
|
609
|
+
Update passcode delivery settings for recipients on a sent document. Only recipients who have not started signing can be updated.
|
|
610
|
+
|
|
611
|
+
### Examples
|
|
612
|
+
|
|
613
|
+
```ruby
|
|
614
|
+
require 'time'
|
|
615
|
+
require 'signwell_sdk'
|
|
616
|
+
# setup authorization
|
|
617
|
+
SignWell.configure do |config|
|
|
618
|
+
# Configure API key authorization: api_key
|
|
619
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
620
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
621
|
+
# config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
622
|
+
end
|
|
623
|
+
|
|
624
|
+
api_instance = SignWell::Resources::DocumentApi.new
|
|
625
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
626
|
+
update_authentication_request = SignWell::UpdateAuthenticationRequest.new({recipients: [SignWell::UpdateAuthenticationRequestRecipientsInner.new({id: 'id_example'})]}) # UpdateAuthenticationRequest |
|
|
627
|
+
|
|
628
|
+
begin
|
|
629
|
+
# Update Authentication
|
|
630
|
+
result = api_instance.update_authentication(id, update_authentication_request)
|
|
631
|
+
p result
|
|
632
|
+
rescue SignWell::Errors::ApiError => e
|
|
633
|
+
puts "Error when calling DocumentApi->update_authentication: #{e}"
|
|
634
|
+
end
|
|
635
|
+
```
|
|
636
|
+
|
|
637
|
+
#### Using the update_authentication_with_http_info variant
|
|
638
|
+
|
|
639
|
+
This returns an Array which contains the response data, status code and headers.
|
|
640
|
+
|
|
641
|
+
> <Array(<DocumentResponse>, Integer, Hash)> update_authentication_with_http_info(id, update_authentication_request)
|
|
642
|
+
|
|
643
|
+
```ruby
|
|
644
|
+
begin
|
|
645
|
+
# Update Authentication
|
|
646
|
+
data, status_code, headers = api_instance.update_authentication_with_http_info(id, update_authentication_request)
|
|
647
|
+
p status_code # => 2xx
|
|
648
|
+
p headers # => { ... }
|
|
649
|
+
p data # => <DocumentResponse>
|
|
650
|
+
rescue SignWell::Errors::ApiError => e
|
|
651
|
+
puts "Error when calling DocumentApi->update_authentication_with_http_info: #{e}"
|
|
652
|
+
end
|
|
653
|
+
```
|
|
654
|
+
|
|
655
|
+
### Parameters
|
|
656
|
+
|
|
657
|
+
| Name | Type | Description | Notes |
|
|
658
|
+
| ---- | ---- | ----------- | ----- |
|
|
659
|
+
| **id** | **String** | | |
|
|
660
|
+
| **update_authentication_request** | [**UpdateAuthenticationRequest**](UpdateAuthenticationRequest.md) | | |
|
|
661
|
+
|
|
662
|
+
### Return type
|
|
663
|
+
|
|
664
|
+
[**DocumentResponse**](DocumentResponse.md)
|
|
665
|
+
|
|
666
|
+
### Authorization
|
|
667
|
+
|
|
668
|
+
[api_key](../README.md#api_key)
|
|
669
|
+
|
|
670
|
+
### HTTP request headers
|
|
671
|
+
|
|
672
|
+
- **Content-Type**: application/json
|
|
673
|
+
- **Accept**: application/json
|
|
674
|
+
|
|
675
|
+
|
|
602
676
|
## update_recipients
|
|
603
677
|
|
|
604
678
|
> <DocumentResponse> update_recipients(id, update_recipients_request)
|
|
605
679
|
|
|
606
680
|
Update Recipients
|
|
607
681
|
|
|
608
|
-
Updates one or more recipients on a document that has already been sent. Only recipients who have not started signing may be updated. Recipient IDs must be retrieved from the Get Document response. Allowed document statuses: sent, viewed, pending, bounced. For non-embedded documents, updated recipients will receive a new notification email. For embedded signing documents, email behavior follows each recipient's send_email setting.
|
|
682
|
+
Updates one or more recipients on a document that has already been sent. Only recipients who have not started signing may be updated. Recipient IDs must be retrieved from the Get Document response. Allowed document statuses: sent, viewed, pending, bounced. For non-embedded documents, updated recipients will receive a new notification email. For embedded signing documents, email behavior follows each recipient's send_email setting. This endpoint does not support changing a recipient's `delivery_method` or `phone_number`; SMS delivery settings are set when the document is created.
|
|
609
683
|
|
|
610
684
|
### Examples
|
|
611
685
|
|
|
@@ -5,11 +5,12 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **test_mode** | **Boolean** | Set to `true` to enable Test Mode. Documents created with Test Mode do not count towards API billing and are not legally binding. Defaults to `false` | [optional][default to false] |
|
|
8
|
+
| **send_sms_test_preview_email** | **Boolean** | Only applies when `test_mode` is `true`. When `true`, and the document has an SMS-only recipient, sends the document owner a test-mode preview email (with a masked phone number) instead of the regular SMS sender-copy email. No SMS is sent and no credits are used, in test mode or otherwise. Defaults to `false`. | [optional][default to false] |
|
|
8
9
|
| **template_id** | **String** | Use when you have to create a document from a single template. Either :template_id or :template_ids must be present in the request, not both. | [optional] |
|
|
9
10
|
| **template_ids** | **Array<String>** | Use when you have to create a document from multiple templates. Either :template_id or :template_ids must be present in the request, not both. | [optional] |
|
|
10
11
|
| **name** | **String** | The name of the document. | [optional] |
|
|
11
|
-
| **subject** | **String** | Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject (if the document is created from a template). | [optional] |
|
|
12
|
-
| **message** | **String** | Email message for the signature request that recipients will see. Defaults to the default system message or a template message (if the document is created from a template). | [optional] |
|
|
12
|
+
| **subject** | **String** | Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject (if the document is created from a template). Applies to email notifications only; SMS notifications always use fixed system templates. | [optional] |
|
|
13
|
+
| **message** | **String** | Email message for the signature request that recipients will see. Defaults to the default system message or a template message (if the document is created from a template). Applies to email notifications only; SMS notifications always use fixed system templates. | [optional] |
|
|
13
14
|
| **recipients** | [**Array<TemplateRecipientsInner>**](TemplateRecipientsInner.md) | Document recipients are people that must complete and/or sign a document. Recipients of the document must be assigned to a placeholder of the template. Recipients will inherit all placeholder fields and settings. | |
|
|
14
15
|
| **exclude_placeholders** | **Array<String>** | Exclude one or more template placeholders when creating a document from a template. Any excluded placeholders (and their associated recipients and fields) will not be included on the created document. Values must match placeholder names on the template. You can't exclude all placeholders (at least one recipient must remain). | [optional] |
|
|
15
16
|
| **draft** | **Boolean** | Whether the document can still be updated before sending a signature request. If set to `false` the document is sent for signing as part of this request. Defaults to `false`. | [optional][default to false] |
|
|
@@ -20,14 +21,17 @@
|
|
|
20
21
|
| **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] |
|
|
21
22
|
| **embedded_signing** | **Boolean** | When set to `true` it enables embedded signing in your website/web application. Embedded functionality works with an iFrame and email authentication is disabled. :embedded_signinig defaults to `false`. | [optional][default to false] |
|
|
22
23
|
| **embedded_signing_notifications** | **Boolean** | On embedding signing, document owners (and CC'd contacts) do not get a notification email when documents have been completed. Setting this param to `true` will send out those final completed notifications. Default is `false` | [optional][default to false] |
|
|
24
|
+
| **embedded** | [**EmbeddedRequest**](EmbeddedRequest.md) | | [optional] |
|
|
23
25
|
| **text_tags** | **Boolean** | An alternative way (if you can’t use the recommended way) of placing fields in specific locations of your document by using special text tags. Useful when changing the content of your files changes the location of fields. See API documentation for “Text Tags” for details. Defaults to false. | [optional][default to false] |
|
|
24
26
|
| **custom_requester_name** | **String** | Sets the custom requester name for the document. When set, this is the name used for all email communications, signing notifications, and in the audit file. | [optional] |
|
|
25
27
|
| **custom_requester_email** | **String** | Sets the custom requester email for the document. When set, this is the email used for all email communications, signing notifications, and in the audit file. | [optional] |
|
|
26
28
|
| **redirect_url** | **String** | A URL that recipients are redirected to after successfully signing a document. | [optional] |
|
|
27
29
|
| **allow_decline** | **Boolean** | Whether to allow recipients the option to decline signing a document. If multiple signers are involved in a document, any single recipient can cancel the entire document signing process by declining to sign. | [optional][default to true] |
|
|
28
|
-
| **allow_reassign** | **Boolean** | In some cases a signer is not the right person to sign and may need to reassign their signing responsibilities to another person. This feature allows them to reassign the document to someone else. | [optional][default to true] |
|
|
30
|
+
| **allow_reassign** | **Boolean** | In some cases a signer is not the right person to sign and may need to reassign their signing responsibilities to another person. This feature allows them to reassign the document to someone else. Unavailable on 21 CFR Part 11 documents: omit it and reassignment stays off, while sending `true` returns a 422. | [optional][default to true] |
|
|
29
31
|
| **decline_redirect_url** | **String** | A URL that recipients are redirected to if the document is declined. | [optional] |
|
|
30
32
|
| **language** | **String** | Sets the language for all recipients on the document and updates all recipient side interactions including the document email and the document itself. Accepted languages: English, Français, Español, Deutsch, Polski, Português, Dansk, Nederlands, Italiano, Русский, Svenska, العربية, Ελληνικά, Türkçe, Slovenčina. Defaults to English. Language should be sent in ISO 639-1 format: en, fr, es, de, pl, pt, da, nl, it, ru, sv, ar, el, tr, sk. | [optional] |
|
|
33
|
+
| **conditional_rules** | [**Array<ConditionalRuleRequest>**](ConditionalRuleRequest.md) | Conditional logic rules that show, hide, or require fields based on what a signer does to other fields. Every identifier is a field api_id. At most 10 rules per document or template. | [optional] |
|
|
34
|
+
| **conditional_rules_mode** | **String** | When creating a document from a template, controls how the conditional_rules in the request reconcile with the template's inherited rules: `replace` (drop inherited, use the body's rules), `append` (keep inherited, add the body's rules), or `none` (clear all rules). Required when sending conditional_rules that should not simply inherit. | [optional] |
|
|
31
35
|
| **metadata** | **Hash<String, String>** | Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned. | [optional] |
|
|
32
36
|
| **template_fields** | [**Array<TemplateFieldValuesInner>**](TemplateFieldValuesInner.md) | Fields of your template(s) that you can prepopulate with values. Signature and Initials fields cannot be signed through the API. | [optional] |
|
|
33
37
|
| **files** | [**Array<AdditionalFilesInner>**](AdditionalFilesInner.md) | | [optional] |
|
|
@@ -44,6 +48,7 @@ require 'signwell_sdk'
|
|
|
44
48
|
|
|
45
49
|
instance = SignWell::Models::DocumentFromTemplateRequest.new(
|
|
46
50
|
test_mode: null,
|
|
51
|
+
send_sms_test_preview_email: null,
|
|
47
52
|
template_id: null,
|
|
48
53
|
template_ids: null,
|
|
49
54
|
name: null,
|
|
@@ -59,6 +64,7 @@ instance = SignWell::Models::DocumentFromTemplateRequest.new(
|
|
|
59
64
|
api_application_id: null,
|
|
60
65
|
embedded_signing: null,
|
|
61
66
|
embedded_signing_notifications: null,
|
|
67
|
+
embedded: null,
|
|
62
68
|
text_tags: null,
|
|
63
69
|
custom_requester_name: null,
|
|
64
70
|
custom_requester_email: null,
|
|
@@ -67,6 +73,8 @@ instance = SignWell::Models::DocumentFromTemplateRequest.new(
|
|
|
67
73
|
allow_reassign: null,
|
|
68
74
|
decline_redirect_url: null,
|
|
69
75
|
language: null,
|
|
76
|
+
conditional_rules: null,
|
|
77
|
+
conditional_rules_mode: null,
|
|
70
78
|
metadata: null,
|
|
71
79
|
template_fields: null,
|
|
72
80
|
files: null,
|