Module: SignWell

Defined in:
lib/signwell_sdk/version.rb,
lib/signwell_sdk.rb,
lib/signwell_sdk/webhook.rb,
lib/signwell_sdk/api_error.rb,
lib/signwell_sdk/api/me_api.rb,
lib/signwell_sdk/api_client.rb,
lib/signwell_sdk/configuration.rb,
lib/signwell_sdk/api/document_api.rb,
lib/signwell_sdk/api/template_api.rb,
lib/signwell_sdk/api/webhooks_api.rb,
lib/signwell_sdk/models/file_info.rb,
lib/signwell_sdk/api/bulk_send_api.rb,
lib/signwell_sdk/models/field_type.rb,
lib/signwell_sdk/models/label_info.rb,
lib/signwell_sdk/models/date_format.rb,
lib/signwell_sdk/models/file_format.rb,
lib/signwell_sdk/models/files_inner.rb,
lib/signwell_sdk/models/label_request.rb,
lib/signwell_sdk/models/error_response.rb,
lib/signwell_sdk/models/label_response.rb,
lib/signwell_sdk/models/detailed_option.rb,
lib/signwell_sdk/models/dropdown_option.rb,
lib/signwell_sdk/models/pagination_meta.rb,
lib/signwell_sdk/models/text_validation.rb,
lib/signwell_sdk/api/api_application_api.rb,
lib/signwell_sdk/models/document_request.rb,
lib/signwell_sdk/models/recipients_inner.rb,
lib/signwell_sdk/models/document_response.rb,
lib/signwell_sdk/models/fields_inner_inner.rb,
lib/signwell_sdk/models/placeholders_inner.rb,
lib/signwell_sdk/models/checkbox_group_info.rb,
lib/signwell_sdk/models/checkbox_validation.rb,
lib/signwell_sdk/models/copied_contact_info.rb,
lib/signwell_sdk/models/error_response_meta.rb,
lib/signwell_sdk/models/nom151_url_response.rb,
lib/signwell_sdk/models/bulk_send_csv_request.rb,
lib/signwell_sdk/models/checkbox_groups_inner.rb,
lib/signwell_sdk/models/copied_contacts_inner.rb,
lib/signwell_sdk/models/send_reminder_request.rb,
lib/signwell_sdk/models/additional_files_inner.rb,
lib/signwell_sdk/models/create_webhook_request.rb,
lib/signwell_sdk/models/document_list_response.rb,
lib/signwell_sdk/models/attachment_request_info.rb,
lib/signwell_sdk/models/create_bulk_send_request.rb,
lib/signwell_sdk/models/attachment_requests_inner.rb,
lib/signwell_sdk/models/copied_placeholders_inner.rb,
lib/signwell_sdk/models/document_template_request.rb,
lib/signwell_sdk/models/rate_limit_error_response.rb,
lib/signwell_sdk/models/reminder_recipients_inner.rb,
lib/signwell_sdk/models/template_recipients_inner.rb,
lib/signwell_sdk/models/validation_error_response.rb,
lib/signwell_sdk/models/completed_pdf_url_response.rb,
lib/signwell_sdk/models/document_template_response.rb,
lib/signwell_sdk/models/nom151_certificate_response.rb,
lib/signwell_sdk/models/template_field_values_inner.rb,
lib/signwell_sdk/models/template_fields_inner_inner.rb,
lib/signwell_sdk/models/additional_fields_inner_inner.rb,
lib/signwell_sdk/models/document_from_template_request.rb,
lib/signwell_sdk/models/template_checkbox_groups_inner.rb,
lib/signwell_sdk/models/document_from_template_response.rb,
lib/signwell_sdk/models/document_template_list_response.rb,
lib/signwell_sdk/models/document_template_update_request.rb,
lib/signwell_sdk/models/update_document_and_send_request.rb,
lib/signwell_sdk/models/template_field_values_inner_value.rb,
lib/signwell_sdk/models/document_response_recipients_inner.rb,
lib/signwell_sdk/models/nom151_certificate_response_nom151.rb,
lib/signwell_sdk/models/template_attachment_requests_inner.rb,
lib/signwell_sdk/models/additional_fields_inner_inner_value.rb,
lib/signwell_sdk/models/document_response_fields_inner_inner.rb,
lib/signwell_sdk/models/document_response_fields_inner_inner_value.rb,
lib/signwell_sdk/models/document_response_attachment_requests_inner.rb,
lib/signwell_sdk/models/document_template_response_placeholders_inner.rb,
lib/signwell_sdk/models/document_response_fields_inner_inner_recipient.rb,
lib/signwell_sdk/models/document_from_template_response_recipients_inner.rb,
lib/signwell_sdk/models/document_from_template_response_fields_inner_inner.rb,
lib/signwell_sdk/models/document_response_fields_inner_inner_options_inner.rb,
lib/signwell_sdk/models/document_template_response_copied_placeholders_inner.rb,
lib/signwell_sdk/models/document_from_template_response_fields_inner_inner_recipient.rb

Overview

SignWell Developer API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1 Contact: [email protected] Generated by: https://openapi-generator.tech Generator version: 7.12.0

Defined Under Namespace

Modules: AdditionalFieldsInnerInnerValue, DocumentResponseFieldsInnerInnerValue, DropdownOption, TemplateFieldValuesInnerValue, Webhook Classes: APIApplicationApi, AdditionalFieldsInnerInner, AdditionalFilesInner, ApiClient, ApiConnectionError, ApiError, ApiStatusError, ApiTimeoutError, AttachmentRequestInfo, AttachmentRequestsInner, AuthenticationError, BadRequestError, BulkSendApi, BulkSendCsvRequest, CheckboxGroupInfo, CheckboxGroupsInner, CheckboxValidation, CompletedPdfUrlResponse, Configuration, ConflictError, CopiedContactInfo, CopiedContactsInner, CopiedPlaceholdersInner, CreateBulkSendRequest, CreateWebhookRequest, DateFormat, DetailedOption, DocumentApi, DocumentFromTemplateRequest, DocumentFromTemplateResponse, DocumentFromTemplateResponseFieldsInnerInner, DocumentFromTemplateResponseFieldsInnerInnerRecipient, DocumentFromTemplateResponseRecipientsInner, DocumentListResponse, DocumentRequest, DocumentResponse, DocumentResponseAttachmentRequestsInner, DocumentResponseFieldsInnerInner, DocumentResponseFieldsInnerInnerOptionsInner, DocumentResponseFieldsInnerInnerRecipient, DocumentResponseRecipientsInner, DocumentTemplateListResponse, DocumentTemplateRequest, DocumentTemplateResponse, DocumentTemplateResponseCopiedPlaceholdersInner, DocumentTemplateResponsePlaceholdersInner, DocumentTemplateUpdateRequest, ErrorResponse, ErrorResponseMeta, FieldType, FieldsInnerInner, FileFormat, FileInfo, FilesInner, InternalServerError, LabelInfo, LabelRequest, LabelResponse, MeApi, Nom151CertificateResponse, Nom151CertificateResponseNom151, Nom151UrlResponse, NotFoundError, PaginationMeta, PermissionDeniedError, PlaceholdersInner, RateLimitError, RateLimitErrorResponse, RecipientsInner, ReminderRecipientsInner, SendReminderRequest, TemplateApi, TemplateAttachmentRequestsInner, TemplateCheckboxGroupsInner, TemplateFieldValuesInner, TemplateFieldsInnerInner, TemplateRecipientsInner, TextValidation, UnprocessableEntityError, UpdateDocumentAndSendRequest, ValidationErrorResponse, WebhooksApi

Constant Summary collapse

VERSION =
'0.1.0.pre.alpha.3'

Class Method Summary collapse

Class Method Details

.configureObject

Customize default settings for the SDK using block. SignWell.configure do |config| config.username = "xxx" config.password = "xxx" end If no block given, return the default Configuration object.



104
105
106
107
108
109
110
# File 'lib/signwell_sdk.rb', line 104

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end