/mfkessai-ruby

an example mfk client for ruby

Primary LanguageRuby

swagger_client

SwaggerClient - the Ruby gem for the MF KESSAI REST API

MF KESSAI REST API

This SDK is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build swagger_client.gemspec

Then either install the gem locally:

gem install ./swagger_client-1.0.0.gem

(for development, run gem install --dev ./swagger_client-1.0.0.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 'swagger_client', '~> 1.0.0'

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 'swagger_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 'swagger_client'

# Setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: apikey
  config.api_key['apikey'] = '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['apikey'] = 'Bearer'
end

api_instance = SwaggerClient::CustomerApi.new

id = "id_example" # String | 顧客ID

payload = SwaggerClient::CustomerExaminationPayload.new # CustomerExaminationPayload | 


begin
  #create examination customer
  result = api_instance.customer_create_examination(id, payload)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling CustomerApi->customer_create_examination: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://sandbox-api.mfkessai.co.jp/v1

Class Method HTTP request Description
SwaggerClient::CustomerApi customer_create_examination POST /customers/{id}/examination create examination customer
SwaggerClient::CustomerApi customer_credit_facility GET /customers/{id}/credit_facility credit facility customer
SwaggerClient::CustomerApi customer_examination GET /customers/{id}/examination examination customer
SwaggerClient::CustomerApi customer_index GET /customers index customer
SwaggerClient::CustomerApi customer_show GET /customers/{id} show customer
SwaggerClient::DestinationApi destination_create POST /destinations create destination
SwaggerClient::ExaminationApi examination_create POST /examinations create examination
SwaggerClient::ExaminationApi examination_create_transaction POST /examinations/{id}/transaction create_transaction examination
SwaggerClient::ExaminationApi examination_index GET /examinations index examination
SwaggerClient::ExaminationApi examination_show GET /examinations/{id} show examination
SwaggerClient::PingApi ping_show GET /ping show ping
SwaggerClient::TransactionApi transaction_cancel POST /transactions/{id}/cancel cancel transaction
SwaggerClient::TransactionApi transaction_create POST /transactions create transaction
SwaggerClient::TransactionApi transaction_index GET /transactions index transaction
SwaggerClient::TransactionApi transaction_show GET /transactions/{id} show transaction

Documentation for Models

Documentation for Authorization

apikey

  • Type: API key
  • API key parameter name: apikey
  • Location: HTTP header