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/template.rb,
lib/form_api/models/submission.rb,
lib/form_api/models/invalid_request.rb,
lib/form_api/models/pending_template.rb,
lib/form_api/models/submission_batch.rb,
lib/form_api/models/submission_action.rb,
lib/form_api/models/combined_submission.rb,
lib/form_api/models/authentication_error.rb,
lib/form_api/models/submission_batch_data.rb,
lib/form_api/models/create_submission_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/update_data_request_response.rb,
lib/form_api/models/authentication_success_response.rb,
lib/form_api/models/create_submission_data_batch_v1.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/create_submission_data_batch_request.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, CombinedSubmission, CombinedSubmissionAction, CombinedSubmissionData, Configuration, CreateCombinedSubmissionResponse, CreateSubmissionBatchResponse, CreateSubmissionBatchSubmissionsResponse, CreateSubmissionData, CreateSubmissionDataBatchRequest, CreateSubmissionDataBatchV1, CreateSubmissionDataRequestData, CreateSubmissionDataRequestTokenResponse, CreateSubmissionDataRequestTokenResponseToken, CreateSubmissionResponse, Error, InvalidRequest, PDFApi, PendingTemplate, Submission, SubmissionAction, SubmissionBatch, SubmissionBatchData, SubmissionDataRequest, Template, UpdateDataRequestResponse, UpdateSubmissionDataRequestData

Constant Summary collapse

VERSION =
'1.6.0'

Class Method Summary collapse

Class Method Details

.configureObject

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.



61
62
63
64
65
66
67
# File 'lib/form_api.rb', line 61

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