Module: FormAPI

Defined in:
lib/form_api/version.rb,
lib/form_api.rb,
lib/form_api/api_error.rb,
lib/form_api/api/client.rb,
lib/form_api/api_client.rb,
lib/form_api/api/pdf_api.rb,
lib/form_api/models/error.rb,
lib/form_api/configuration.rb,
lib/form_api/models/folder.rb,
lib/form_api/models/template.rb,
lib/form_api/models/submission.rb,
lib/form_api/models/custom_file.rb,
lib/form_api/models/folders_folder.rb,
lib/form_api/models/invalid_request.rb,
lib/form_api/models/submission_data.rb,
lib/form_api/models/move_folder_data.rb,
lib/form_api/models/pending_template.rb,
lib/form_api/models/submission_batch.rb,
lib/form_api/models/combine_pdfs_data.rb,
lib/form_api/models/submission_action.rb,
lib/form_api/models/create_folder_data.rb,
lib/form_api/models/move_template_data.rb,
lib/form_api/models/rename_folder_data.rb,
lib/form_api/models/combined_submission.rb,
lib/form_api/models/authentication_error.rb,
lib/form_api/models/create_template_data.rb,
lib/form_api/models/templatesv2_template.rb,
lib/form_api/models/submission_batch_data.rb,
lib/form_api/models/create_custom_file_data.rb,
lib/form_api/models/submission_data_request.rb,
lib/form_api/models/combined_submission_data.rb,
lib/form_api/models/combined_submission_action.rb,
lib/form_api/models/create_submission_response.rb,
lib/form_api/models/create_custom_file_response.rb,
lib/form_api/models/update_data_request_response.rb,
lib/form_api/models/submission_data_batch_request.rb,
lib/form_api/models/templatesv2_template_document.rb,
lib/form_api/models/authentication_success_response.rb,
lib/form_api/models/create_submission_batch_response.rb,
lib/form_api/models/create_combined_submission_response.rb,
lib/form_api/models/create_submission_data_request_data.rb,
lib/form_api/models/update_submission_data_request_data.rb,
lib/form_api/models/templatesv2_template_document_metadata.rb,
lib/form_api/models/create_submission_batch_submissions_response.rb,
lib/form_api/models/create_submission_data_request_token_response.rb,
lib/form_api/models/create_submission_data_request_token_response_token.rb

Overview

#API v1

#FormAPI 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-SNAPSHOT

Defined Under Namespace

Classes: ApiClient, ApiError, AuthenticationError, AuthenticationSuccessResponse, Client, CombinePdfsData, CombinedSubmission, CombinedSubmissionAction, CombinedSubmissionData, Configuration, CreateCombinedSubmissionResponse, CreateCustomFileData, CreateCustomFileResponse, CreateFolderData, CreateSubmissionBatchResponse, CreateSubmissionBatchSubmissionsResponse, CreateSubmissionDataRequestData, CreateSubmissionDataRequestTokenResponse, CreateSubmissionDataRequestTokenResponseToken, CreateSubmissionResponse, CreateTemplateData, CustomFile, Error, Folder, FoldersFolder, InvalidRequest, MoveFolderData, MoveTemplateData, PDFApi, PendingTemplate, RenameFolderData, Submission, SubmissionAction, SubmissionBatch, SubmissionBatchData, SubmissionData, SubmissionDataBatchRequest, SubmissionDataRequest, Template, Templatesv2Template, Templatesv2TemplateDocument, Templatesv2TemplateDocumentMetadata, UpdateDataRequestResponse, UpdateSubmissionDataRequestData

Constant Summary collapse

VERSION = 
'1.12.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

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

If no block given, return the default Configuration object.



74
75
76
77
78
79
80
 
# File 'lib/form_api.rb', line 74

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