cns_openapi_ruby_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: afdbb397204185ca3fae12dc02cf31dc2c2df7281cef412deebe46b5e395c9e5
+  data.tar.gz: 7f82082555cae5f9c018fc4f09f1d27abb7ad8cbb02201683315bc622b737939
+SHA512:
+  metadata.gz: 4fe828991fb579c9a18e66e2a1d4ef6c1e98c05fb1f81542bb0af0b1899d07838f3aea090a28619cfe03f362e0d01c22d3e8e5cfc621c6e9049e40eba7201ba5
+  data.tar.gz: cacf300540fa87e2e86d34340186aae571fa559e917d8bf408aa5ca399e1a8e4fa2c4fefba9c716077e72c05d9d34587bf6721bf19abab66ad8deabd9cd19bbf

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    cns_openapi_ruby_client (1.0.0)
+      activesupport (~> 4.2, >= 4.2.11)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.11.3)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.15.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    psych (3.3.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.11.0)
+    thread_safe (0.3.6)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cns_openapi_ruby_client!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,123 @@
+# cns_openapi_ruby_client
+
+OpenApiGenerator generates base code. Some code customized to parse xml. 
+
+CnsOpenapiRubyClient - the Ruby gem for the Corporate number system API v4
+
+Corporate number system API v4
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://www.houjin-bangou.nta.go.jp/webapi/toiawase/](https://www.houjin-bangou.nta.go.jp/webapi/toiawase/)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build cns_openapi_ruby_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./cns_openapi_ruby_client-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./cns_openapi_ruby_client-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'cns_openapi_ruby_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 'cns_openapi_ruby_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:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'cns_openapi_ruby_client'
+
+# Setup authorization
+CnsOpenapiRubyClient.configure do |config|
+  # Configure API key authorization: id
+  config.api_key['id'] = '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['id'] = 'Bearer'
+end
+
+api_instance = CnsOpenapiRubyClient::CorporationsApi.new
+name = 'name_example' # String | 取得の対象とする法人名を URL エンコード（UTF-8）した値をセットします。
+type = '12' # String | リクエストに対して応答するデータのファイル形式と文字コードを指定します。
+opts = {
+  mode: 1, # Integer | 検索方式を指定できます。 指定しない場合は、｢１｣（前方一致検索）で処理します。
+  target: 1, # Integer | 検索対象を指定できます。 指定しない場合は、｢１｣（JIS 第一・第二水準）で処理します。
+  address: 'address_example', # String | 国内所在地の都道府県コード又は 都道府県コードと市区町村コードを組み合わせたコードのいずれかを指定できます。 市区町村コードのみではエラー(エラーコード 051)となります。
+  kind: '01', # String | 法人種別を指定できます。
+  change: 0, # Integer | 法人名や所在地の変更があった法人等に ついて過去の情報を含めて検索するかどうかを指定できます。
+  close: 0, # Integer | 登記記録の閉鎖等があった法人等の情報を取得するかどうかを指定できます。
+  from: 'from_example', # String | 取得の対象とする法人番号指定年月日の開始日を指定できます。
+  to: 'to_example', # String | 取得の対象とする法人番号指定年月日の終了日を指定できます。 
+  divide: 56 # Integer | 分割番号を指定できます。 指定しない場合は、「１」で処理します。
+}
+
+begin
+  #法人名を指定しリクエストすることで、指定した法人名の基本３情報及び付随する情報を取得することができます。
+  result = api_instance.get_corporations(name, type, opts)
+  p result
+rescue CnsOpenapiRubyClient::ApiError => e
+  puts "Exception when calling CorporationsApi->get_corporations: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.houjin-bangou.nta.go.jp/4*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CnsOpenapiRubyClient::CorporationsApi* | [**get_corporations**](docs/CorporationsApi.md#get_corporations) | **GET** /name | 法人名を指定しリクエストすることで、指定した法人名の基本３情報及び付随する情報を取得することができます。
+
+
+## Documentation for Models
+
+ - [CnsOpenapiRubyClient::CorporateType](docs/CorporateType.md)
+ - [CnsOpenapiRubyClient::Corporation](docs/Corporation.md)
+ - [CnsOpenapiRubyClient::CorrectCodeType](docs/CorrectCodeType.md)
+ - [CnsOpenapiRubyClient::ProcessCodeType](docs/ProcessCodeType.md)
+ - [CnsOpenapiRubyClient::Response](docs/Response.md)
+ - [CnsOpenapiRubyClient::ResponseWrapper](docs/ResponseWrapper.md)
+
+
+## Documentation for Authorization
+
+
+### id
+
+
+- **Type**: API key
+- **API key parameter name**: id
+- **Location**: URL query string
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/cns_openapi_ruby_client.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Corporate number system API v4
+
+#Corporate number system API v4
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.1
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "cns_openapi_ruby_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cns_openapi_ruby_client"
+  s.version     = CnsOpenapiRubyClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["OpenAPI-Generator"]
+  s.email       = [""]
+  s.homepage    = "https://openapi-generator.tech"
+  s.summary     = "Corporate number system API v4 Ruby Gem"
+  s.description = "Corporate number system API v4"
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 2.4"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'activesupport', '~> 4.2', '>= 4.2.11'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/CorporateType.md

@@ -0,0 +1,15 @@
+# CnsOpenapiRubyClient::CorporateType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'cns_openapi_ruby_client'
+
+instance = CnsOpenapiRubyClient::CorporateType.new()
+```
+

data/docs/Corporation.md

@@ -0,0 +1,76 @@
+# CnsOpenapiRubyClient::Corporation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sequence_number** | **Integer** | 一連番号 | [optional] |
+| **corporate_number** | **Integer** | 法人番号の指定を受けた者（以下「法人番号保有者」という。）の 法人番号を示すデータ項目。 | [optional] |
+| **process** | [**ProcessCodeType**](ProcessCodeType.md) |  | [optional] |
+| **correct** | [**CorrectCodeType**](CorrectCodeType.md) |  | [optional] |
+| **update_date** | **Date** | 法務省等からデータを受け取り、当庁でデータを更新した日付を表す。 | [optional] |
+| **change_date** | **Date** | 事由が発生した日付を表すデータ項目。 | [optional] |
+| **name** | **String** | 法人番号保有者の商号又は名称を示すデータ項目。 | [optional] |
+| **name_image_id** | **Integer** | 商号又は名称イメージIDは、 イメージファイルを閲覧するために指定する値（情報）。 | [optional] |
+| **kind** | [**CorporateType**](CorporateType.md) |  | [optional] |
+| **prefecture_name** | **String** | 法人番号保有者の本店又は主たる事務所の所在地の都道府県名。 | [optional] |
+| **city_name** | **String** | 法人番号保有者の本店又は主たる事務所の所在地の市区町村名。 | [optional] |
+| **street_number** | **String** | 法人番号保有者の本店又は主たる事務所の所在地の丁目番地等。 | [optional] |
+| **address_image_id** | **Integer** | 国内所在地イメージIDは、 イメージファイルを閲覧するために指定する値（情報）。 | [optional] |
+| **prefecture_code** | **Integer** | 都道府県コード。データを取り込み、名寄せ作業や不要なデータを識別する際、 当該コードを活用することにより、効率的な作業を行うことができる。 | [optional] |
+| **city_code** | **Integer** | 市区町村コード | [optional] |
+| **post_code** | **Integer** | 国内所在地の文字情報を基に設定した郵便番号。 | [optional] |
+| **address_outside** | **String** | 本店又は主たる事務所の所在地が国外にある法人番号保有者の 国外における本店又は主たる事務所の所在地を示すデータ項目。 | [optional] |
+| **address_outside_image_id** | **Integer** | 国外所在地イメージIDは、 イメージファイルを閲覧するために指定する値（情報）。 | [optional] |
+| **close_date** | **Date** | 登記記録の閉鎖等の事由が生じた年月日を表す。 | [optional] |
+| **close_cause** | **String** | 閉鎖の事由は、登記記録の閉鎖等が生じた事由を表すデータ項目。 | [optional] |
+| **successor_corporate_number** | **Integer** | 合併等による事業承継があったことにより 登記記録が閉鎖された場合の存続する法人の法人番号。 | [optional] |
+| **change_cause** | **String** | 合併等による事業承継があった場合の事業承継内容を示すデータ項目。 | [optional] |
+| **assignment_date** | **Date** | 法人番号指定年月日は、法人番号が指定された年月日を表す。 | [optional] |
+| **latest** | **Integer** | 応答結果のデータが、最新の情報か過去の情報かを表す。 | [optional] |
+| **en_name** | **String** | 法人番号保有者が登録した商号又は名称（英語表記）。 | [optional] |
+| **en_prefecture_name** | **String** | 法人番号保有者が登録した本店又は主たる事務所の 所在地の都道府県名（英語表記）。 | [optional] |
+| **en_city_name** | **String** | 法人番号保有者が登録した本店又は主たる事務所の 所在地の丁目番地等（英語表記）。 | [optional] |
+| **en_address_outside** | **String** | 本店又は主たる事務所の所在地が国外にある法人番号保有者が 登録した国外における本店又は主たる事務所の所在地（英語表記）。 | [optional] |
+| **furigana** | **String** | 法人番号保有者の商号又は名称に対するフリガナ情報を示すデータ項目。 | [optional] |
+| **hihyoji** | **Integer** | 設立登記法人のうち、登記上の所在地が、住居表示の実施や区画整理等で 既に廃止されており、現在では存在しない住所表記となっていることが 確認できた法人について、検索対象から除外していることを示すデータ項目。 | [optional] |
+
+## Example
+
+```ruby
+require 'cns_openapi_ruby_client'
+
+instance = CnsOpenapiRubyClient::Corporation.new(
+  sequence_number: 11111111,
+  corporate_number: 9999999999999,
+  process: null,
+  correct: null,
+  update_date: Mon Apr 02 00:00:00 GMT 2018,
+  change_date: Mon Oct 05 00:00:00 GMT 2015,
+  name: 株式会社foo,
+  name_image_id: 99999999,
+  kind: null,
+  prefecture_name: 北海道,
+  city_name: 旭川市,
+  street_number: 大字下白銀町７,
+  address_image_id: 87308,
+  prefecture_code: 1,
+  city_code: 111,
+  post_code: 7777777,
+  address_outside: ニューヨーク州ブロンクス区西２６３丁目１番地,
+  address_outside_image_id: 1,
+  close_date: Fri Mar 31 00:00:00 GMT 2017,
+  close_cause: 01,
+  successor_corporate_number: 1,
+  change_cause: 不本意ながら吸収合併されたため。,
+  assignment_date: Fri Jan 01 00:00:00 GMT 2010,
+  latest: 0,
+  en_name: Netflix,
+  en_prefecture_name: Hokkaido,
+  en_city_name: null,
+  en_address_outside: 47 W 13th St, New York, NY 10011, USA,
+  furigana: ワッツマンリサーチ,
+  hihyoji: 0
+)
+```
+

data/docs/CorporationsApi.md

@@ -0,0 +1,101 @@
+# CnsOpenapiRubyClient::CorporationsApi
+
+All URIs are relative to *https://api.houjin-bangou.nta.go.jp/4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_corporations**](CorporationsApi.md#get_corporations) | **GET** /name | 法人名を指定しリクエストすることで、指定した法人名の基本３情報及び付随する情報を取得することができます。 |
+
+
+## get_corporations
+
+> <ResponseWrapper> get_corporations(name, type, opts)
+
+法人名を指定しリクエストすることで、指定した法人名の基本３情報及び付随する情報を取得することができます。
+
+法人名による法人情報の取得
+
+### Examples
+
+```ruby
+require 'time'
+require 'cns_openapi_ruby_client'
+# setup authorization
+CnsOpenapiRubyClient.configure do |config|
+  # Configure API key authorization: id
+  config.api_key['id'] = '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['id'] = 'Bearer'
+end
+
+api_instance = CnsOpenapiRubyClient::CorporationsApi.new
+name = 'name_example' # String | 取得の対象とする法人名を URL エンコード（UTF-8）した値をセットします。
+type = '12' # String | リクエストに対して応答するデータのファイル形式と文字コードを指定します。
+opts = {
+  mode: 1, # Integer | 検索方式を指定できます。 指定しない場合は、｢１｣（前方一致検索）で処理します。
+  target: 1, # Integer | 検索対象を指定できます。 指定しない場合は、｢１｣（JIS 第一・第二水準）で処理します。
+  address: 'address_example', # String | 国内所在地の都道府県コード又は 都道府県コードと市区町村コードを組み合わせたコードのいずれかを指定できます。 市区町村コードのみではエラー(エラーコード 051)となります。
+  kind: '01', # String | 法人種別を指定できます。
+  change: 0, # Integer | 法人名や所在地の変更があった法人等に ついて過去の情報を含めて検索するかどうかを指定できます。
+  close: 0, # Integer | 登記記録の閉鎖等があった法人等の情報を取得するかどうかを指定できます。
+  from: 'from_example', # String | 取得の対象とする法人番号指定年月日の開始日を指定できます。
+  to: 'to_example', # String | 取得の対象とする法人番号指定年月日の終了日を指定できます。 
+  divide: 56 # Integer | 分割番号を指定できます。 指定しない場合は、「１」で処理します。
+}
+
+begin
+  # 法人名を指定しリクエストすることで、指定した法人名の基本３情報及び付随する情報を取得することができます。
+  result = api_instance.get_corporations(name, type, opts)
+  p result
+rescue CnsOpenapiRubyClient::ApiError => e
+  puts "Error when calling CorporationsApi->get_corporations: #{e}"
+end
+```
+
+#### Using the get_corporations_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResponseWrapper>, Integer, Hash)> get_corporations_with_http_info(name, type, opts)
+
+```ruby
+begin
+  # 法人名を指定しリクエストすることで、指定した法人名の基本３情報及び付随する情報を取得することができます。
+  data, status_code, headers = api_instance.get_corporations_with_http_info(name, type, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResponseWrapper>
+rescue CnsOpenapiRubyClient::ApiError => e
+  puts "Error when calling CorporationsApi->get_corporations_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | 取得の対象とする法人名を URL エンコード（UTF-8）した値をセットします。 |  |
+| **type** | **String** | リクエストに対して応答するデータのファイル形式と文字コードを指定します。 | [default to &#39;12&#39;] |
+| **mode** | **Integer** | 検索方式を指定できます。 指定しない場合は、｢１｣（前方一致検索）で処理します。 | [optional][default to 1] |
+| **target** | **Integer** | 検索対象を指定できます。 指定しない場合は、｢１｣（JIS 第一・第二水準）で処理します。 | [optional][default to 1] |
+| **address** | **String** | 国内所在地の都道府県コード又は 都道府県コードと市区町村コードを組み合わせたコードのいずれかを指定できます。 市区町村コードのみではエラー(エラーコード 051)となります。 | [optional] |
+| **kind** | **String** | 法人種別を指定できます。 | [optional] |
+| **change** | **Integer** | 法人名や所在地の変更があった法人等に ついて過去の情報を含めて検索するかどうかを指定できます。 | [optional][default to 0] |
+| **close** | **Integer** | 登記記録の閉鎖等があった法人等の情報を取得するかどうかを指定できます。 | [optional][default to 1] |
+| **from** | **String** | 取得の対象とする法人番号指定年月日の開始日を指定できます。 | [optional] |
+| **to** | **String** | 取得の対象とする法人番号指定年月日の終了日を指定できます。  | [optional] |
+| **divide** | **Integer** | 分割番号を指定できます。 指定しない場合は、「１」で処理します。 | [optional] |
+
+### Return type
+
+[**ResponseWrapper**](ResponseWrapper.md)
+
+### Authorization
+
+[id](../README.md#id)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/xml, application/json
+