Module: DocSpring

Defined in:
lib/docspring/version.rb,
lib/docspring.rb,
lib/docspring/api_error.rb,
lib/docspring/api_client.rb,
lib/docspring/api/pdf_api.rb,
lib/docspring/configuration.rb,
lib/docspring/models/folder.rb,
lib/docspring/models/template.rb,
lib/docspring/models/submission.rb,
lib/docspring/models/custom_file.rb,
lib/docspring/models/json_schema.rb,
lib/docspring/models/error_response.rb,
lib/docspring/models/add_fields_data.rb,
lib/docspring/models/move_folder_data.rb,
lib/docspring/models/submission_batch.rb,
lib/docspring/models/template_preview.rb,
lib/docspring/models/combine_pdfs_data.rb,
lib/docspring/models/submission_action.rb,
lib/docspring/models/create_folder_data.rb,
lib/docspring/models/move_template_data.rb,
lib/docspring/models/rename_folder_data.rb,
lib/docspring/models/submission_preview.rb,
lib/docspring/models/combined_submission.rb,
lib/docspring/models/create_pdf_template.rb,
lib/docspring/models/create_html_template.rb,
lib/docspring/models/publish_version_data.rb,
lib/docspring/models/restore_version_data.rb,
lib/docspring/models/update_html_template.rb,
lib/docspring/models/copy_template_options.rb,
lib/docspring/models/submission_batch_data.rb,
lib/docspring/models/success_error_response.rb,
lib/docspring/models/create_custom_file_data.rb,
lib/docspring/models/submission_data_request.rb,
lib/docspring/models/upload_presign_response.rb,
lib/docspring/models/combined_submission_data.rb,
lib/docspring/models/multiple_errors_response.rb,
lib/docspring/models/template_delete_response.rb,
lib/docspring/models/list_submissions_response.rb,
lib/docspring/models/combined_submission_action.rb,
lib/docspring/models/create_pdf_submission_data.rb,
lib/docspring/models/create_submission_response.rb,
lib/docspring/models/create_custom_file_response.rb,
lib/docspring/models/create_html_submission_data.rb,
lib/docspring/models/submission_data_request_show.rb,
lib/docspring/models/template_add_fields_response.rb,
lib/docspring/models/submission_data_request_event.rb,
lib/docspring/models/submission_data_request_token.rb,
lib/docspring/models/batch_generate_pdfs201_response.rb,
lib/docspring/models/success_multiple_errors_response.rb,
lib/docspring/models/submission_batch_with_submissions.rb,
lib/docspring/models/template_publish_version_response.rb,
lib/docspring/models/create_combined_submission_response.rb,
lib/docspring/models/create_submission_data_request_data.rb,
lib/docspring/models/update_submission_data_request_data.rb,
lib/docspring/models/create_submission_data_request_response.rb,
lib/docspring/models/create_submission_data_request_event_request.rb,
lib/docspring/models/create_submission_data_request_event_response.rb,
lib/docspring/models/create_submission_data_request_token_response.rb more...

Overview

#DocSpring API

#DocSpring provides an API that helps you fill out and sign PDF templates.

The version of the OpenAPI document: v1

Generated by: openapi-generator.tech Generator version: 7.11.0

Defined Under Namespace

Classes: AddFieldsData, ApiClient, ApiError, BatchGeneratePdfs201Response, CombinePdfsData, CombinedSubmission, CombinedSubmissionAction, CombinedSubmissionData, Configuration, CopyTemplateOptions, CreateCombinedSubmissionResponse, CreateCustomFileData, CreateCustomFileResponse, CreateFolderData, CreateHtmlSubmissionData, CreateHtmlTemplate, CreatePdfSubmissionData, CreatePdfTemplate, CreateSubmissionDataRequestData, CreateSubmissionDataRequestEventRequest, CreateSubmissionDataRequestEventResponse, CreateSubmissionDataRequestResponse, CreateSubmissionDataRequestTokenResponse, CreateSubmissionResponse, CustomFile, ErrorResponse, Folder, JsonSchema, ListSubmissionsResponse, MoveFolderData, MoveTemplateData, MultipleErrorsResponse, PDFApi, PublishVersionData, RenameFolderData, RestoreVersionData, Submission, SubmissionAction, SubmissionBatch, SubmissionBatchData, SubmissionBatchWithSubmissions, SubmissionDataRequest, SubmissionDataRequestEvent, SubmissionDataRequestShow, SubmissionDataRequestToken, SubmissionPreview, SuccessErrorResponse, SuccessMultipleErrorsResponse, Template, TemplateAddFieldsResponse, TemplateDeleteResponse, TemplatePreview, TemplatePublishVersionResponse, UpdateHtmlTemplate, UpdateSubmissionDataRequestData, UploadPresignResponse

Constant Summary collapse

VERSION = 
'3.1.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

DocSpring.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

[View source]

84
85
86
87
88
89
90
 
# File 'lib/docspring.rb', line 84

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