fountain_partner_api_client

FountainPartnerApiClient - the Ruby gem for the Fountain Partner Docs

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

This SDK is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: 0.0.5
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build fountain_partner_api_client.gemspec

Then either install the gem locally:

gem install ./fountain_partner_api_client-0.0.5.gem

(for development, run gem install --dev ./fountain_partner_api_client-0.0.5.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'fountain_partner_api_client', '~> 0.0.5'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'fountain_partner_api_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'fountain_partner_api_client'

# Setup authorization
FountainPartnerApiClient.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
end

api_instance = FountainPartnerApiClient::DefaultApi.new
applicant_id = 'applicant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  v1_partners_id_applicants_applicant_id_details_post_request: FountainPartnerApiClient::V1PartnersIdApplicantsApplicantIdDetailsPostRequest.new # V1PartnersIdApplicantsApplicantIdDetailsPostRequest | 
}

begin
  #Create Applicant Details
  result = api_instance.v1_partners_id_applicants_applicant_id_details_post(applicant_id, id, opts)
  p result
rescue FountainPartnerApiClient::ApiError => e
  puts "Exception when calling DefaultApi->v1_partners_id_applicants_applicant_id_details_post: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost:3009

Class	Method	HTTP request	Description
FountainPartnerApiClient::DefaultApi	v1_partners_id_applicants_applicant_id_details_post	POST /v1/partners/id/applicants/applicant_id/details	Create Applicant Details
FountainPartnerApiClient::DefaultApi	v1_partners_id_applicants_applicant_id_put	PUT /v1/partners/id/applicants/applicant_id	Update Applicant
FountainPartnerApiClient::DefaultApi	v1_partners_id_applicants_applicant_id_status_post	POST /v1/partners/id/applicants/applicant_id/status	Create Applicant Status
FountainPartnerApiClient::DefaultApi	v1_partners_id_get	GET /v1/partners/id	Show Partner
FountainPartnerApiClient::DefaultApi	v1_partners_id_put	PUT /v1/partners/id	Update Partner

Documentation for Models

• FountainPartnerApiClient::V1PartnersIdApplicantsApplicantIdDetailsPostRequest
• FountainPartnerApiClient::V1PartnersIdApplicantsApplicantIdDetailsPostRequestApplicant
• FountainPartnerApiClient::V1PartnersIdApplicantsApplicantIdDetailsPostRequestApplicantPartnerDetails
• FountainPartnerApiClient::V1PartnersIdApplicantsApplicantIdPut200Response
• FountainPartnerApiClient::V1PartnersIdApplicantsApplicantIdPutRequest
• FountainPartnerApiClient::V1PartnersIdApplicantsApplicantIdPutRequestApplicant
• FountainPartnerApiClient::V1PartnersIdApplicantsApplicantIdPutRequestApplicantLabelsInner
• FountainPartnerApiClient::V1PartnersIdApplicantsApplicantIdStatusPostRequest
• FountainPartnerApiClient::V1PartnersIdApplicantsApplicantIdStatusPostRequestApplicant
• FountainPartnerApiClient::V1PartnersIdApplicantsApplicantIdStatusPostRequestApplicantPartnerStatus
• FountainPartnerApiClient::V1PartnersIdGet200Response
• FountainPartnerApiClient::V1PartnersIdGet200Response1
• FountainPartnerApiClient::V1PartnersIdGet200Response1Data
• FountainPartnerApiClient::V1PartnersIdGet200Response1DataAttributes
• FountainPartnerApiClient::V1PartnersIdGet200ResponseData
• FountainPartnerApiClient::V1PartnersIdGet200ResponseDataAttributes
• FountainPartnerApiClient::V1PartnersIdGetRequest
• FountainPartnerApiClient::V1PartnersIdGetRequestPartner

Documentation for Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: X-ACCESS-TOKEN
• Location: HTTP header