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
data/docs/RecipientsInner.md
CHANGED
|
@@ -5,13 +5,18 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | A unique identifier that you will give to each recipient. We recommend numbering sequentially from 1 to X. IDs are required for associating recipients to fields and more. | |
|
|
8
|
-
| **name** | **String** | Name of the recipient. | [optional] |
|
|
9
|
-
| **email** | **String** | Email address for the recipient. |
|
|
10
|
-
| **passcode** | **String** | If set, signers assigned with a passcode will be required to enter the passcode before they’re able to view and complete the document. | [optional] |
|
|
8
|
+
| **name** | **String** | Name of the recipient. Required on 21 CFR Part 11 documents: a recipient without a name returns a 422. | [optional] |
|
|
9
|
+
| **email** | **String** | Email address for the recipient. Required unless the recipient's `delivery_method` is `sms`. | [optional] |
|
|
10
|
+
| **passcode** | **String** | If set, signers assigned with a passcode will be required to enter the passcode before they’re able to view and complete the document. On a 21 CFR Part 11 document SignWell generates the passcode, so a sender-defined passcode returns a 422. | [optional] |
|
|
11
|
+
| **passcode_delivery** | [**RecipientsInnerPasscodeDelivery**](RecipientsInnerPasscodeDelivery.md) | | [optional] |
|
|
11
12
|
| **subject** | **String** | Email subject for the signature request that the recipient will see. Overrides the general subject for the document. | [optional] |
|
|
12
13
|
| **message** | **String** | Email message for the signature request that the recipient will see. Overrides the general message for the document. | [optional] |
|
|
13
14
|
| **send_email** | **Boolean** | Applies on when `embedded_signing` is `true`. By default, recipients are not notified through email to sign when doing embedded signing. Setting this to `true` will send a notification email to the recipient. Default is `false`. | [optional][default to false] |
|
|
14
15
|
| **send_email_delay** | **Integer** | If `send_email` is `true` recipients will receive a new document notification immediately. In the case of embedded signing, you can delay this notification to only send if the document is not completed within a few minutes. The email notification will not go out if the document is completed before the delay time is over. Valid values are in minutes ranging from `0` to `60`. Defaults to `0`. | [optional][default to 0] |
|
|
16
|
+
| **delivery_method** | **String** | How the recipient is notified and receives the signing link: `email` (default), `sms`, or `email_and_sms`. SMS delivery is available only to workspaces that are eligible for SMS and have it enabled. `email` requires `email`, `sms` requires `phone_number`, and `email_and_sms` requires both. SMS content always uses fixed system templates; `subject` and `message` apply to email notifications only. A 21 CFR Part 11 document records one verified channel per recipient: `email` and `sms` are both accepted, while `email_and_sms` returns a 422. | [optional][default to 'email'] |
|
|
17
|
+
| **phone_number** | **String** | Recipient phone number in E.164 format (for example `+14155551234`). Required when `delivery_method` is `sms` or `email_and_sms`. Only phone numbers from the country codes currently enabled for SMS are accepted. | [optional] |
|
|
18
|
+
| **send_sms** | **Boolean** | Applies only when `embedded_signing` is `true` and the recipient's `delivery_method` includes SMS. By default, recipients are not notified through SMS when doing embedded signing. Setting this to `true` will send the SMS notification to the recipient. Default is `false`. | [optional][default to false] |
|
|
19
|
+
| **send_sms_delay** | **Integer** | If `send_sms` is `true` the recipient will receive the SMS notification immediately. In the case of embedded signing, you can delay this notification to only send if the document is not completed within a few minutes. The SMS will not go out if the document is completed before the delay time is over. Valid values are in minutes ranging from `0` to `60`. Defaults to `0`. | [optional][default to 0] |
|
|
15
20
|
|
|
16
21
|
## Example
|
|
17
22
|
|
|
@@ -23,10 +28,15 @@ instance = SignWell::Models::RecipientsInner.new(
|
|
|
23
28
|
name: null,
|
|
24
29
|
email: signer@example.com,
|
|
25
30
|
passcode: null,
|
|
31
|
+
passcode_delivery: null,
|
|
26
32
|
subject: null,
|
|
27
33
|
message: null,
|
|
28
34
|
send_email: null,
|
|
29
|
-
send_email_delay: null
|
|
35
|
+
send_email_delay: null,
|
|
36
|
+
delivery_method: null,
|
|
37
|
+
phone_number: +14155551234,
|
|
38
|
+
send_sms: null,
|
|
39
|
+
send_sms_delay: null
|
|
30
40
|
)
|
|
31
41
|
```
|
|
32
42
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# SignWell::Models::RecipientsInnerPasscodeDelivery
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **enabled** | **Boolean** | Enable passcode delivery for this recipient. Cannot be set to `false` on a 21 CFR Part 11 document: it returns a 422. | [optional] |
|
|
8
|
+
| **methods** | **Array<String>** | Delivery methods for the passcode. Currently supports: email. Defaults to [\"email\"] when omitted. | [optional] |
|
|
9
|
+
| **expire_after_access** | **Boolean** | When enabled, the passcode is cleared after successful authentication. If passcode_delivery is also enabled, a new passcode is auto-generated on the next send request. Otherwise the recipient will no longer need a passcode. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'signwell_sdk'
|
|
15
|
+
|
|
16
|
+
instance = SignWell::Models::RecipientsInnerPasscodeDelivery.new(
|
|
17
|
+
enabled: null,
|
|
18
|
+
methods: null,
|
|
19
|
+
expire_after_access: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | Recipient's name (required if multiple recipients share the same email). | [optional] |
|
|
8
|
-
| **email** | **String** | Recipient's email address. | [optional] |
|
|
8
|
+
| **email** | **String** | Recipient's email address. Used to match the recipient to remind; not required for SMS-only recipients, who can be identified by name instead. | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
data/docs/SendReminderRequest.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **recipients** | [**Array<ReminderRecipientsInner>**](ReminderRecipientsInner.md) | Optional list
|
|
7
|
+
| **recipients** | [**Array<ReminderRecipientsInner>**](ReminderRecipientsInner.md) | Optional list of recipients within the document to remind. If none are specified, all recipients that have not signed yet are reminded. Each recipient is reminded through their own delivery method: email-only recipients get a reminder email, SMS-only recipients get a reminder text, and email_and_sms recipients get both. If the workspace has insufficient SMS credit, only the SMS reminder is skipped and the sender is notified once; the email reminder (if applicable) still goes out. | [optional] |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
|
@@ -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] |
|
|
@@ -41,6 +43,8 @@ instance = SignWell::Models::TemplateFieldsInnerInner.new(
|
|
|
41
43
|
api_id: null,
|
|
42
44
|
name: null,
|
|
43
45
|
validation: null,
|
|
46
|
+
validation_regex: null,
|
|
47
|
+
validation_regex_error_message: null,
|
|
44
48
|
fixed_width: null,
|
|
45
49
|
lock_sign_date: null,
|
|
46
50
|
date_format: null,
|
|
@@ -5,14 +5,19 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | A unique identifier that you will give to each recipient. We recommend numbering sequentially from 1 to X. IDs are required for associating recipients to fields and more. | |
|
|
8
|
-
| **name** | **String** | Name of the recipient. | [optional] |
|
|
9
|
-
| **email** | **String** | Email address for the recipient. |
|
|
8
|
+
| **name** | **String** | Name of the recipient. Required on 21 CFR Part 11 documents: a recipient without a name returns a 422. | [optional] |
|
|
9
|
+
| **email** | **String** | Email address for the recipient. Required unless `delivery_method` is `sms`. | [optional] |
|
|
10
10
|
| **placeholder_name** | **String** | The name of the placeholder you want this recipient assigned to. | [optional] |
|
|
11
|
-
| **passcode** | **String** | If set, signers assigned with a passcode will be required to enter the passcode before they’re able to view and complete the document. | [optional] |
|
|
11
|
+
| **passcode** | **String** | If set, signers assigned with a passcode will be required to enter the passcode before they’re able to view and complete the document. On a 21 CFR Part 11 document SignWell generates the passcode, so a sender-defined passcode returns a 422. | [optional] |
|
|
12
|
+
| **passcode_delivery** | [**RecipientsInnerPasscodeDelivery**](RecipientsInnerPasscodeDelivery.md) | | [optional] |
|
|
12
13
|
| **subject** | **String** | Email subject for the signature request that the recipient will see. Overrides the general subject for the template. | [optional] |
|
|
13
14
|
| **message** | **String** | Email message for the signature request that the recipient will see. Overrides the general message for the template. | [optional] |
|
|
14
15
|
| **send_email** | **Boolean** | Applies on when `embedded_signing` is `true`. By default, recipients are not notified through email to sign when doing embedded signing. Setting this to `true` will send a notification email to the recipient. Default is `false`. | [optional][default to false] |
|
|
15
16
|
| **send_email_delay** | **Integer** | If `send_email` is `true` recipients will receive a new document notification immediately. In the case of embedded signing, you can delay this notification to only send if the document is not completed within a few minutes. The email notification will not go out if the document is completed before the delay time is over. Valid values are in minutes ranging from `0` to `60`. Defaults to `0`. | [optional][default to 0] |
|
|
17
|
+
| **delivery_method** | **String** | How the recipient is notified and receives the signing link: `email` (default), `sms`, or `email_and_sms`. SMS delivery is available only to workspaces that are eligible for SMS and have it enabled. `email` requires `email`, `sms` requires `phone_number`, and `email_and_sms` requires both. SMS content always uses fixed system templates; `subject` and `message` apply to email notifications only. A 21 CFR Part 11 document records one verified channel per recipient: `email` and `sms` are both accepted, while `email_and_sms` returns a 422. | [optional][default to 'email'] |
|
|
18
|
+
| **phone_number** | **String** | Recipient phone number in E.164 format (for example `+14155551234`). Required when `delivery_method` is `sms` or `email_and_sms`. Only phone numbers from the country codes currently enabled for SMS are accepted. | [optional] |
|
|
19
|
+
| **send_sms** | **Boolean** | Applies only when `embedded_signing` is `true` and the recipient's `delivery_method` includes SMS. By default, recipients are not notified through SMS when doing embedded signing. Setting this to `true` will send the SMS notification to the recipient. Default is `false`. | [optional][default to false] |
|
|
20
|
+
| **send_sms_delay** | **Integer** | If `send_sms` is `true` the recipient will receive the SMS notification immediately. In the case of embedded signing, you can delay this notification to only send if the document is not completed within a few minutes. The SMS will not go out if the document is completed before the delay time is over. Valid values are in minutes ranging from `0` to `60`. Defaults to `0`. | [optional][default to 0] |
|
|
16
21
|
|
|
17
22
|
## Example
|
|
18
23
|
|
|
@@ -25,10 +30,15 @@ instance = SignWell::Models::TemplateRecipientsInner.new(
|
|
|
25
30
|
email: signer@example.com,
|
|
26
31
|
placeholder_name: null,
|
|
27
32
|
passcode: null,
|
|
33
|
+
passcode_delivery: null,
|
|
28
34
|
subject: null,
|
|
29
35
|
message: null,
|
|
30
36
|
send_email: null,
|
|
31
|
-
send_email_delay: null
|
|
37
|
+
send_email_delay: null,
|
|
38
|
+
delivery_method: null,
|
|
39
|
+
phone_number: +14155551234,
|
|
40
|
+
send_sms: null,
|
|
41
|
+
send_sms_delay: null
|
|
32
42
|
)
|
|
33
43
|
```
|
|
34
44
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# SignWell::Models::UpdateAuthenticationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **recipients** | [**Array<UpdateAuthenticationRequestRecipientsInner>**](UpdateAuthenticationRequestRecipientsInner.md) | Recipients whose authentication settings should be updated. | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'signwell_sdk'
|
|
13
|
+
|
|
14
|
+
instance = SignWell::Models::UpdateAuthenticationRequest.new(
|
|
15
|
+
recipients: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# SignWell::Models::UpdateAuthenticationRequestRecipientsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | A unique identifier that you will give to each recipient. We recommend numbering sequentially from 1 to X. IDs are required for associating recipients to fields and more. | |
|
|
8
|
+
| **passcode** | **String** | Updated passcode for the recipient. If set, the signer will be required to enter the passcode before viewing and completing the document. On a 21 CFR Part 11 document SignWell generates the passcode, so a sender-defined passcode returns a 422. | [optional] |
|
|
9
|
+
| **passcode_delivery** | [**UpdateRecipientsMapInnerPasscodeDelivery**](UpdateRecipientsMapInnerPasscodeDelivery.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'signwell_sdk'
|
|
15
|
+
|
|
16
|
+
instance = SignWell::Models::UpdateAuthenticationRequestRecipientsInner.new(
|
|
17
|
+
id: null,
|
|
18
|
+
passcode: null,
|
|
19
|
+
passcode_delivery: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -5,21 +5,24 @@
|
|
|
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
|
| **name** | **String** | The name of the document. | [optional] |
|
|
9
|
-
| **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] |
|
|
10
|
-
| **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] |
|
|
10
|
+
| **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] |
|
|
11
|
+
| **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] |
|
|
11
12
|
| **expires_in** | **Integer** | Number of days before the signature request expires. Defaults to the account expiration setting or template expiration (if the document is created from a template). | [optional] |
|
|
12
13
|
| **reminders** | **Boolean** | Whether to send signing reminders to recipients. Reminders are sent on day 3, day 6, and day 10 if set to `true`. Defaults to `true`. | [optional][default to true] |
|
|
13
14
|
| **apply_signing_order** | **Boolean** | When set to `true` recipients will sign one at a time in the order of the `recipients` collection of this request. | [optional][default to false] |
|
|
14
15
|
| **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] |
|
|
15
16
|
| **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] |
|
|
16
17
|
| **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] |
|
|
18
|
+
| **embedded** | [**EmbeddedRequest**](EmbeddedRequest.md) | | [optional] |
|
|
17
19
|
| **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] |
|
|
18
20
|
| **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] |
|
|
19
21
|
| **redirect_url** | **String** | A URL that recipients are redirected to after successfully signing a document. | [optional] |
|
|
20
22
|
| **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] |
|
|
21
|
-
| **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] |
|
|
23
|
+
| **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] |
|
|
22
24
|
| **decline_redirect_url** | **String** | A URL that recipients are redirected to if the document is declined. | [optional] |
|
|
25
|
+
| **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] |
|
|
23
26
|
| **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] |
|
|
24
27
|
| **labels** | [**Array<LabelRequest>**](LabelRequest.md) | Labels can be used to organize documents in a way that can make it easy to find using the document search in SignWell. A document can have multiple labels. Updating labels on a document will replace any existing labels for that document. | [optional] |
|
|
25
28
|
| **checkbox_groups** | [**Array<CheckboxGroupsInner>**](CheckboxGroupsInner.md) | Checkbox fields that are placed on a document can be grouped with selection requirements. At least 2 checkbox fields in an array of fields must be assigned to the same recipient. | [optional] |
|
|
@@ -31,6 +34,7 @@ require 'signwell_sdk'
|
|
|
31
34
|
|
|
32
35
|
instance = SignWell::Models::UpdateDocumentAndSendRequest.new(
|
|
33
36
|
test_mode: null,
|
|
37
|
+
send_sms_test_preview_email: null,
|
|
34
38
|
name: null,
|
|
35
39
|
subject: null,
|
|
36
40
|
message: null,
|
|
@@ -40,12 +44,14 @@ instance = SignWell::Models::UpdateDocumentAndSendRequest.new(
|
|
|
40
44
|
api_application_id: null,
|
|
41
45
|
embedded_signing: null,
|
|
42
46
|
embedded_signing_notifications: null,
|
|
47
|
+
embedded: null,
|
|
43
48
|
custom_requester_name: null,
|
|
44
49
|
custom_requester_email: null,
|
|
45
50
|
redirect_url: null,
|
|
46
51
|
allow_decline: null,
|
|
47
52
|
allow_reassign: null,
|
|
48
53
|
decline_redirect_url: null,
|
|
54
|
+
conditional_rules: null,
|
|
49
55
|
metadata: null,
|
|
50
56
|
labels: null,
|
|
51
57
|
checkbox_groups: null
|
|
@@ -9,7 +9,8 @@
|
|
|
9
9
|
| **email** | **String** | Updated email address for the recipient. | |
|
|
10
10
|
| **subject** | **String** | Updated email subject for the signature request that this recipient will see. | [optional] |
|
|
11
11
|
| **message** | **String** | Updated email message for the signature request that this recipient will see. | [optional] |
|
|
12
|
-
| **passcode** | **String** | Updated passcode for the recipient. If set, the signer will be required to enter the passcode before viewing and completing the document. | [optional] |
|
|
12
|
+
| **passcode** | **String** | Updated passcode for the recipient. If set, the signer will be required to enter the passcode before viewing and completing the document. On a 21 CFR Part 11 document SignWell generates the passcode, so a sender-defined passcode returns a 422. | [optional] |
|
|
13
|
+
| **passcode_delivery** | [**UpdateRecipientsMapInnerPasscodeDelivery**](UpdateRecipientsMapInnerPasscodeDelivery.md) | | [optional] |
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -22,7 +23,8 @@ instance = SignWell::Models::UpdateRecipientsMapInner.new(
|
|
|
22
23
|
email: jane@example.com,
|
|
23
24
|
subject: null,
|
|
24
25
|
message: null,
|
|
25
|
-
passcode: null
|
|
26
|
+
passcode: null,
|
|
27
|
+
passcode_delivery: null
|
|
26
28
|
)
|
|
27
29
|
```
|
|
28
30
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# SignWell::Models::UpdateRecipientsMapInnerPasscodeDelivery
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **enabled** | **Boolean** | Enable or disable passcode delivery. Cannot be set to `false` on a 21 CFR Part 11 document: it returns a 422. | [optional] |
|
|
8
|
+
| **methods** | **Array<String>** | Delivery methods. Defaults to [\"email\"]. | [optional] |
|
|
9
|
+
| **expire_after_access** | **Boolean** | Clear passcode after successful authentication. If passcode_delivery is also enabled, a new passcode is auto-generated on the next send request. Otherwise the recipient will no longer need a passcode. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'signwell_sdk'
|
|
15
|
+
|
|
16
|
+
instance = SignWell::Models::UpdateRecipientsMapInnerPasscodeDelivery.new(
|
|
17
|
+
enabled: null,
|
|
18
|
+
methods: null,
|
|
19
|
+
expire_after_access: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/WebhooksApi.md
CHANGED
|
@@ -15,7 +15,7 @@ All URIs are relative to *https://www.signwell.com*
|
|
|
15
15
|
|
|
16
16
|
Create Webhook
|
|
17
17
|
|
|
18
|
-
Register a callback URL that we will post document events to.
|
|
18
|
+
Register a callback URL that we will post document events to. Note: a `document_signed` event is not emitted solely because a pre-signed template signature/initials was copied as document content, and `event.related_signer` only identifies a real recipient signing action. Two additional event types cover SMS delivery outcomes: `document_sms_failed` fires when an SMS reaches a terminal failure (undelivered or failed), and `document_sms_opted_out` fires when a phone number is newly added to the SMS suppression list. Both carry `event.related_recipient` (id, name, email when present, `phone_number_masked`, and `delivery_method`) instead of `event.related_signer`, and each recipient in `data.object.recipients[]` whose delivery method includes SMS carries a nested `sms` object (`phone_number_masked`, `send_sms`, `send_sms_delay`, `delivery_status`, `message_type`, `failed`, `failed_details`). Email-only recipients keep their existing payload shape unchanged. Only webhooks registered on API-type hooks receive these two events.
|
|
19
19
|
|
|
20
20
|
### Examples
|
|
21
21
|
|
|
@@ -6,8 +6,7 @@ API for creating, managing, and tracking electronic signature workflows.
|
|
|
6
6
|
The version of the OpenAPI document: v1
|
|
7
7
|
Contact: support@signwell.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.
|
|
10
|
-
|
|
9
|
+
Generator version: 7.26.0
|
|
11
10
|
=end
|
|
12
11
|
|
|
13
12
|
require 'cgi'
|
|
@@ -6,8 +6,7 @@ API for creating, managing, and tracking electronic signature workflows.
|
|
|
6
6
|
The version of the OpenAPI document: v1
|
|
7
7
|
Contact: support@signwell.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.
|
|
10
|
-
|
|
9
|
+
Generator version: 7.26.0
|
|
11
10
|
=end
|
|
12
11
|
|
|
13
12
|
require 'cgi'
|
|
@@ -6,8 +6,7 @@ API for creating, managing, and tracking electronic signature workflows.
|
|
|
6
6
|
The version of the OpenAPI document: v1
|
|
7
7
|
Contact: support@signwell.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.
|
|
10
|
-
|
|
9
|
+
Generator version: 7.26.0
|
|
11
10
|
=end
|
|
12
11
|
|
|
13
12
|
require 'cgi'
|
|
@@ -21,7 +20,7 @@ module SignWell
|
|
|
21
20
|
@api_client = api_client
|
|
22
21
|
end
|
|
23
22
|
# Create Document
|
|
24
|
-
# Creates and optionally sends a new document for signing. If `draft` is set to true the document will not be sent.
|
|
23
|
+
# 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
24
|
# @param document_request [Models::DocumentRequest]
|
|
26
25
|
# @param [Hash] opts the optional parameters
|
|
27
26
|
# @return [Models::DocumentResponse]
|
|
@@ -31,7 +30,7 @@ module SignWell
|
|
|
31
30
|
end
|
|
32
31
|
|
|
33
32
|
# Create Document
|
|
34
|
-
# Creates and optionally sends a new document for signing. If `draft` is set to true the document will not be sent.
|
|
33
|
+
# 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.
|
|
35
34
|
# @param document_request [Models::DocumentRequest]
|
|
36
35
|
# @param [Hash] opts the optional parameters
|
|
37
36
|
# @return [Array<(Models::DocumentResponse, Integer, Hash)>] DocumentResponse data, response status code and response headers
|
|
@@ -89,7 +88,7 @@ module SignWell
|
|
|
89
88
|
end
|
|
90
89
|
|
|
91
90
|
# Create Document from Template
|
|
92
|
-
# Creates and optionally sends a new document for signing. If `draft` is set to true the document will not be sent.
|
|
91
|
+
# 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.
|
|
93
92
|
# @param document_from_template_request [Models::DocumentFromTemplateRequest]
|
|
94
93
|
# @param [Hash] opts the optional parameters
|
|
95
94
|
# @return [Models::DocumentFromTemplateResponse]
|
|
@@ -99,7 +98,7 @@ module SignWell
|
|
|
99
98
|
end
|
|
100
99
|
|
|
101
100
|
# Create Document from Template
|
|
102
|
-
# Creates and optionally sends a new document for signing. If `draft` is set to true the document will not be sent.
|
|
101
|
+
# 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.
|
|
103
102
|
# @param document_from_template_request [Models::DocumentFromTemplateRequest]
|
|
104
103
|
# @param [Hash] opts the optional parameters
|
|
105
104
|
# @return [Array<(Models::DocumentFromTemplateResponse, Integer, Hash)>] DocumentFromTemplateResponse data, response status code and response headers
|
|
@@ -307,7 +306,7 @@ module SignWell
|
|
|
307
306
|
end
|
|
308
307
|
|
|
309
308
|
# Get Document
|
|
310
|
-
# Returns a document and all associated document data. Supply the unique document ID from either a document creation request or Document page URL.
|
|
309
|
+
# 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.
|
|
311
310
|
# @param id [String]
|
|
312
311
|
# @param [Hash] opts the optional parameters
|
|
313
312
|
# @return [Models::DocumentResponse]
|
|
@@ -317,7 +316,7 @@ module SignWell
|
|
|
317
316
|
end
|
|
318
317
|
|
|
319
318
|
# Get Document
|
|
320
|
-
# Returns a document and all associated document data. Supply the unique document ID from either a document creation request or Document page URL.
|
|
319
|
+
# 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.
|
|
321
320
|
# @param id [String]
|
|
322
321
|
# @param [Hash] opts the optional parameters
|
|
323
322
|
# @return [Array<(Models::DocumentResponse, Integer, Hash)>] DocumentResponse data, response status code and response headers
|
|
@@ -509,7 +508,7 @@ module SignWell
|
|
|
509
508
|
end
|
|
510
509
|
|
|
511
510
|
# Update and Send Document
|
|
512
|
-
# Updates a draft document and sends it to be signed by recipients.
|
|
511
|
+
# 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.
|
|
513
512
|
# @param id [String]
|
|
514
513
|
# @param update_document_and_send_request [Models::UpdateDocumentAndSendRequest]
|
|
515
514
|
# @param [Hash] opts the optional parameters
|
|
@@ -520,7 +519,7 @@ module SignWell
|
|
|
520
519
|
end
|
|
521
520
|
|
|
522
521
|
# Update and Send Document
|
|
523
|
-
# Updates a draft document and sends it to be signed by recipients.
|
|
522
|
+
# 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.
|
|
524
523
|
# @param id [String]
|
|
525
524
|
# @param update_document_and_send_request [Models::UpdateDocumentAndSendRequest]
|
|
526
525
|
# @param [Hash] opts the optional parameters
|
|
@@ -588,7 +587,7 @@ module SignWell
|
|
|
588
587
|
end
|
|
589
588
|
|
|
590
589
|
# Send Reminder
|
|
591
|
-
# Sends a reminder
|
|
590
|
+
# 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.
|
|
592
591
|
# @param id [String]
|
|
593
592
|
# @param send_reminder_request [Models::SendReminderRequest]
|
|
594
593
|
# @param [Hash] opts the optional parameters
|
|
@@ -599,7 +598,7 @@ module SignWell
|
|
|
599
598
|
end
|
|
600
599
|
|
|
601
600
|
# Send Reminder
|
|
602
|
-
# Sends a reminder
|
|
601
|
+
# 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.
|
|
603
602
|
# @param id [String]
|
|
604
603
|
# @param send_reminder_request [Models::SendReminderRequest]
|
|
605
604
|
# @param [Hash] opts the optional parameters
|
|
@@ -661,8 +660,82 @@ module SignWell
|
|
|
661
660
|
return data, status_code, headers
|
|
662
661
|
end
|
|
663
662
|
|
|
663
|
+
# Update Authentication
|
|
664
|
+
# Update passcode delivery settings for recipients on a sent document. Only recipients who have not started signing can be updated.
|
|
665
|
+
# @param id [String]
|
|
666
|
+
# @param update_authentication_request [Models::UpdateAuthenticationRequest]
|
|
667
|
+
# @param [Hash] opts the optional parameters
|
|
668
|
+
# @return [Models::DocumentResponse]
|
|
669
|
+
def update_authentication(id, update_authentication_request, opts = {})
|
|
670
|
+
data, _status_code, _headers = update_authentication_with_http_info(id, update_authentication_request, opts)
|
|
671
|
+
data
|
|
672
|
+
end
|
|
673
|
+
|
|
674
|
+
# Update Authentication
|
|
675
|
+
# Update passcode delivery settings for recipients on a sent document. Only recipients who have not started signing can be updated.
|
|
676
|
+
# @param id [String]
|
|
677
|
+
# @param update_authentication_request [Models::UpdateAuthenticationRequest]
|
|
678
|
+
# @param [Hash] opts the optional parameters
|
|
679
|
+
# @return [Array<(Models::DocumentResponse, Integer, Hash)>] DocumentResponse data, response status code and response headers
|
|
680
|
+
def update_authentication_with_http_info(id, update_authentication_request, opts = {})
|
|
681
|
+
if @api_client.config.debugging
|
|
682
|
+
@api_client.config.logger.debug 'Calling API: DocumentApi.update_authentication ...'
|
|
683
|
+
end
|
|
684
|
+
# verify the required parameter 'id' is set
|
|
685
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
686
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling DocumentApi.update_authentication"
|
|
687
|
+
end
|
|
688
|
+
# verify the required parameter 'update_authentication_request' is set
|
|
689
|
+
if @api_client.config.client_side_validation && update_authentication_request.nil?
|
|
690
|
+
fail ArgumentError, "Missing the required parameter 'update_authentication_request' when calling DocumentApi.update_authentication"
|
|
691
|
+
end
|
|
692
|
+
# resource path
|
|
693
|
+
local_var_path = '/api/v1/documents/{id}/authentication'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
694
|
+
|
|
695
|
+
# query parameters
|
|
696
|
+
query_params = opts[:query_params] || {}
|
|
697
|
+
|
|
698
|
+
# header parameters
|
|
699
|
+
header_params = opts[:header_params] || {}
|
|
700
|
+
# HTTP header 'Accept' (if needed)
|
|
701
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
702
|
+
# HTTP header 'Content-Type'
|
|
703
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
704
|
+
if !content_type.nil?
|
|
705
|
+
header_params['Content-Type'] = content_type
|
|
706
|
+
end
|
|
707
|
+
|
|
708
|
+
# form parameters
|
|
709
|
+
form_params = opts[:form_params] || {}
|
|
710
|
+
|
|
711
|
+
# http body (model)
|
|
712
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_authentication_request)
|
|
713
|
+
|
|
714
|
+
# return_type
|
|
715
|
+
return_type = opts[:debug_return_type] || 'DocumentResponse'
|
|
716
|
+
|
|
717
|
+
# auth_names
|
|
718
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
719
|
+
|
|
720
|
+
new_options = opts.merge(
|
|
721
|
+
:operation => :"DocumentApi.update_authentication",
|
|
722
|
+
:header_params => header_params,
|
|
723
|
+
:query_params => query_params,
|
|
724
|
+
:form_params => form_params,
|
|
725
|
+
:body => post_body,
|
|
726
|
+
:auth_names => auth_names,
|
|
727
|
+
:return_type => return_type
|
|
728
|
+
)
|
|
729
|
+
|
|
730
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
731
|
+
if @api_client.config.debugging
|
|
732
|
+
@api_client.config.logger.debug "API called: DocumentApi#update_authentication\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
733
|
+
end
|
|
734
|
+
return data, status_code, headers
|
|
735
|
+
end
|
|
736
|
+
|
|
664
737
|
# Update Recipients
|
|
665
|
-
# 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.
|
|
738
|
+
# 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.
|
|
666
739
|
# @param id [String]
|
|
667
740
|
# @param update_recipients_request [Models::UpdateRecipientsRequest]
|
|
668
741
|
# @param [Hash] opts the optional parameters
|
|
@@ -673,7 +746,7 @@ module SignWell
|
|
|
673
746
|
end
|
|
674
747
|
|
|
675
748
|
# Update Recipients
|
|
676
|
-
# 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.
|
|
749
|
+
# 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.
|
|
677
750
|
# @param id [String]
|
|
678
751
|
# @param update_recipients_request [Models::UpdateRecipientsRequest]
|
|
679
752
|
# @param [Hash] opts the optional parameters
|
|
@@ -6,8 +6,7 @@ API for creating, managing, and tracking electronic signature workflows.
|
|
|
6
6
|
The version of the OpenAPI document: v1
|
|
7
7
|
Contact: support@signwell.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.
|
|
10
|
-
|
|
9
|
+
Generator version: 7.26.0
|
|
11
10
|
=end
|
|
12
11
|
|
|
13
12
|
require 'cgi'
|
|
@@ -6,8 +6,7 @@ API for creating, managing, and tracking electronic signature workflows.
|
|
|
6
6
|
The version of the OpenAPI document: v1
|
|
7
7
|
Contact: support@signwell.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.
|
|
10
|
-
|
|
9
|
+
Generator version: 7.26.0
|
|
11
10
|
=end
|
|
12
11
|
|
|
13
12
|
require 'cgi'
|
|
@@ -6,8 +6,7 @@ API for creating, managing, and tracking electronic signature workflows.
|
|
|
6
6
|
The version of the OpenAPI document: v1
|
|
7
7
|
Contact: support@signwell.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.
|
|
10
|
-
|
|
9
|
+
Generator version: 7.26.0
|
|
11
10
|
=end
|
|
12
11
|
|
|
13
12
|
require 'cgi'
|
|
@@ -6,8 +6,7 @@ API for creating, managing, and tracking electronic signature workflows.
|
|
|
6
6
|
The version of the OpenAPI document: v1
|
|
7
7
|
Contact: support@signwell.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.
|
|
10
|
-
|
|
9
|
+
Generator version: 7.26.0
|
|
11
10
|
=end
|
|
12
11
|
|
|
13
12
|
require 'cgi'
|
|
@@ -21,7 +20,7 @@ module SignWell
|
|
|
21
20
|
@api_client = api_client
|
|
22
21
|
end
|
|
23
22
|
# Create Webhook
|
|
24
|
-
# Register a callback URL that we will post document events to.
|
|
23
|
+
# Register a callback URL that we will post document events to. Note: a `document_signed` event is not emitted solely because a pre-signed template signature/initials was copied as document content, and `event.related_signer` only identifies a real recipient signing action. Two additional event types cover SMS delivery outcomes: `document_sms_failed` fires when an SMS reaches a terminal failure (undelivered or failed), and `document_sms_opted_out` fires when a phone number is newly added to the SMS suppression list. Both carry `event.related_recipient` (id, name, email when present, `phone_number_masked`, and `delivery_method`) instead of `event.related_signer`, and each recipient in `data.object.recipients[]` whose delivery method includes SMS carries a nested `sms` object (`phone_number_masked`, `send_sms`, `send_sms_delay`, `delivery_status`, `message_type`, `failed`, `failed_details`). Email-only recipients keep their existing payload shape unchanged. Only webhooks registered on API-type hooks receive these two events.
|
|
25
24
|
# @param create_webhook_request [Models::CreateWebhookRequest]
|
|
26
25
|
# @param [Hash] opts the optional parameters
|
|
27
26
|
# @return [Models::WebhookResponse]
|
|
@@ -31,7 +30,7 @@ module SignWell
|
|
|
31
30
|
end
|
|
32
31
|
|
|
33
32
|
# Create Webhook
|
|
34
|
-
# Register a callback URL that we will post document events to.
|
|
33
|
+
# Register a callback URL that we will post document events to. Note: a `document_signed` event is not emitted solely because a pre-signed template signature/initials was copied as document content, and `event.related_signer` only identifies a real recipient signing action. Two additional event types cover SMS delivery outcomes: `document_sms_failed` fires when an SMS reaches a terminal failure (undelivered or failed), and `document_sms_opted_out` fires when a phone number is newly added to the SMS suppression list. Both carry `event.related_recipient` (id, name, email when present, `phone_number_masked`, and `delivery_method`) instead of `event.related_signer`, and each recipient in `data.object.recipients[]` whose delivery method includes SMS carries a nested `sms` object (`phone_number_masked`, `send_sms`, `send_sms_delay`, `delivery_status`, `message_type`, `failed`, `failed_details`). Email-only recipients keep their existing payload shape unchanged. Only webhooks registered on API-type hooks receive these two events.
|
|
35
34
|
# @param create_webhook_request [Models::CreateWebhookRequest]
|
|
36
35
|
# @param [Hash] opts the optional parameters
|
|
37
36
|
# @return [Array<(Models::WebhookResponse, Integer, Hash)>] WebhookResponse data, response status code and response headers
|