Module: DocSpring

Defined in:
lib/docspring/version.rb,
lib/docspring.rb,
lib/docspring/api_error.rb,
lib/docspring/api/client.rb,
lib/docspring/api_client.rb,
lib/docspring/api/pdf_api.rb,
lib/docspring/models/error.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/template_data.rb,
lib/docspring/models/folders_folder.rb,
lib/docspring/models/add_fields_data.rb,
lib/docspring/models/invalid_request.rb,
lib/docspring/models/submission_data.rb,
lib/docspring/models/move_folder_data.rb,
lib/docspring/models/pending_template.rb,
lib/docspring/models/submission_batch.rb,
lib/docspring/models/combine_pdfs_data.rb,
lib/docspring/models/submission_action.rb,
lib/docspring/models/copy_template_data.rb,
lib/docspring/models/create_folder_data.rb,
lib/docspring/models/html_template_data.rb,
lib/docspring/models/move_template_data.rb,
lib/docspring/models/rename_folder_data.rb,
lib/docspring/models/combined_submission.rb,
lib/docspring/models/authentication_error.rb,
lib/docspring/models/update_template_data.rb,
lib/docspring/models/upload_template_data.rb,
lib/docspring/models/submission_batch_data.rb,
lib/docspring/models/create_custom_file_data.rb,
lib/docspring/models/submission_data_request.rb,
lib/docspring/models/combined_submission_data.rb,
lib/docspring/models/update_template_response.rb,
lib/docspring/models/create_html_template_data.rb,
lib/docspring/models/combined_submission_action.rb,
lib/docspring/models/create_submission_response.rb,
lib/docspring/models/create_custom_file_response.rb,
lib/docspring/models/add_fields_template_response.rb,
lib/docspring/models/update_data_request_response.rb,
lib/docspring/models/submission_data_batch_request.rb,
lib/docspring/models/upload_template_data_document.rb,
lib/docspring/models/authentication_success_response.rb,
lib/docspring/models/create_submission_batch_response.rb,
lib/docspring/models/create_template_from_upload_data.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/templatestemplate_idadd_fields_fields.rb,
lib/docspring/models/upload_template_data_document_metadata.rb,
lib/docspring/models/create_submission_batch_submissions_response.rb,
lib/docspring/models/create_submission_data_request_token_response.rb,
lib/docspring/models/create_submission_data_request_token_response_token.rb

Overview

#API v1

#DocSpring is a service that helps you fill out and sign PDF templates.

OpenAPI spec version: v1

Generated by: openapi-generator.tech OpenAPI Generator version: 3.3.0

Defined Under Namespace

Classes: AddFieldsData, AddFieldsTemplateResponse, ApiClient, ApiError, AuthenticationError, AuthenticationSuccessResponse, Client, CombinePdfsData, CombinedSubmission, CombinedSubmissionAction, CombinedSubmissionData, Configuration, CopyTemplateData, CreateCombinedSubmissionResponse, CreateCustomFileData, CreateCustomFileResponse, CreateFolderData, CreateHtmlTemplateData, CreateSubmissionBatchResponse, CreateSubmissionBatchSubmissionsResponse, CreateSubmissionDataRequestData, CreateSubmissionDataRequestTokenResponse, CreateSubmissionDataRequestTokenResponseToken, CreateSubmissionResponse, CreateTemplateFromUploadData, CustomFile, Error, Folder, FoldersFolder, HtmlTemplateData, InvalidRequest, MoveFolderData, MoveTemplateData, PDFApi, PendingTemplate, RenameFolderData, Submission, SubmissionAction, SubmissionBatch, SubmissionBatchData, SubmissionData, SubmissionDataBatchRequest, SubmissionDataRequest, Template, TemplateData, TemplatestemplateIdaddFieldsFields, UpdateDataRequestResponse, UpdateSubmissionDataRequestData, UpdateTemplateData, UpdateTemplateResponse, UploadTemplateData, UploadTemplateDataDocument, UploadTemplateDataDocumentMetadata

Constant Summary collapse

VERSION = 
'1.3.2'

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.



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

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