relation_client

RelationClient - the Ruby gem for the Re:lation API

https://developer.ingage.jp/

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.3
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build relation_client.gemspec

Then either install the gem locally:

gem install ./relation_client-1.0.3.gem

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

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 'relation_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 'relation_client'

# Setup authorization
RelationClient.configure do |config|
  # Configure Bearer authorization (JWT): bearer
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = RelationClient::MessageBoxApi.new
message_box_id = 789 # Integer | Parameter description in CommonMark or HTML.

begin
  #登録
  result = api_instance.message_box_id_customers_post(message_box_id)
  p result
rescue RelationClient::ApiError => e
  puts "Exception when calling MessageBoxApi->message_box_id_customers_post: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://https:#.relationapp.jp/api/v2*

Class	Method	HTTP request	Description
RelationClient::MessageBoxApi	message_box_id_customers_post	POST /message_box_id/customers	登録
RelationClient::MessageBoxApi	message_box_id_records_post	POST /message_box_id/records	応答メモ作成
RelationClient::MessageBoxApi	message_boxes_get	GET /message_boxes	一覧取得

Documentation for Models

• RelationClient::Customer
• RelationClient::MessageBox
• RelationClient::RecordRequest
• RelationClient::RecordResponse

Documentation for Authorization

bearer

• Type: Bearer authentication (JWT)