edinet_api_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38e394b3e0ea1ccad57dbc28d7006a0f6108a1e63bd2e3f44876bf0eae051b1e
+  data.tar.gz: d25a8817c4ca0c6480b54611f3f029ebae424be7e946795219395aa760f6d50c
+SHA512:
+  metadata.gz: a0c48631cd223e1fe4af7e7b407958418e66d08252b32cfa5dd17266ce9bcc69469627aae3a174e55ba45d3361ad3780759b5aad0a286a1fa62e48b2d4692a0f
+  data.tar.gz: 532d8444bac77082573cbd3b586ab9921cfad445c2cac4bd9fea1527c3d32476b6568dd5d2cdfc6990e2286dba9147099b6860ebe395f4fa110a884f3137e95b

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    edinet_api_client (1.0.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.2)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.14)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    jaro_winkler (1.5.2)
+    json (2.1.0)
+    method_source (0.9.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    psych (3.1.0)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    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.10.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  edinet_api_client!
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,98 @@
+# edinet_api_client
+
+EdinetAPIClient - the Ruby gem for the EDINET API
+
+EDINET API は、利用者が EDINET の画面からではなく、プログラムを介して EDINET のデータベースから効率的にデータを取得できる API(アプリケーション・プログラミング・インターフェース)です。EDINET API により、EDINET 利用者は効率的に開示情報を取得することが可能となります。
+
+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://twitter.com/gabu](https://twitter.com/gabu)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build edinet_api_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./edinet_api_client-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./edinet_api_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 'edinet_api_client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/gabu/edinet_api_client, then add the following in the Gemfile:
+
+    gem 'edinet_api_client', :git => 'https://github.com/gabu/edinet_api_client.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 'edinet_api_client'
+
+api_instance = EdinetAPIClient::DefaultApi.new
+date = '2019-04-01' # String | 出力対象とする提出書類一覧のファイル日付（YYYY-MM-DD形式）を指定します。
+opts = {
+  type: 1 # Integer | 取得情報を指定します。  * 1: メタデータのみを取得します。  * 2: 提出書類一覧及びメタデータを取得します。 
+}
+
+begin
+  #書類一覧 API
+  result = api_instance.find_documents(date, opts)
+  p result
+rescue EdinetAPIClient::ApiError => e
+  puts "Exception when calling DefaultApi->find_documents: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://disclosure.edinet-fsa.go.jp/api/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*EdinetAPIClient::DefaultApi* | [**find_documents**](docs/DefaultApi.md#find_documents) | **GET** /documents.json | 書類一覧 API
+*EdinetAPIClient::DefaultApi* | [**get_document**](docs/DefaultApi.md#get_document) | **GET** /documents/{docID} | 書類取得 API
+
+
+## Documentation for Models
+
+ - [EdinetAPIClient::Document](docs/Document.md)
+ - [EdinetAPIClient::InlineResponse200](docs/InlineResponse200.md)
+ - [EdinetAPIClient::Metadata](docs/Metadata.md)
+ - [EdinetAPIClient::MetadataParameter](docs/MetadataParameter.md)
+ - [EdinetAPIClient::MetadataResultset](docs/MetadataResultset.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

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/docs/DefaultApi.md

@@ -0,0 +1,110 @@
+# EdinetAPIClient::DefaultApi
+
+All URIs are relative to *https://disclosure.edinet-fsa.go.jp/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**find_documents**](DefaultApi.md#find_documents) | **GET** /documents.json | 書類一覧 API
+[**get_document**](DefaultApi.md#get_document) | **GET** /documents/{docID} | 書類取得 API
+
+
+
+## find_documents
+
+> InlineResponse200 find_documents(date, opts)
+
+書類一覧 API
+
+書類一覧 API では、「メタデータのみ」または「提出書類一覧及びメタデータ」を取得することが可能です。
+
+### Example
+
+```ruby
+# load the gem
+require 'edinet_api_client'
+
+api_instance = EdinetAPIClient::DefaultApi.new
+date = '2019-04-01' # String | 出力対象とする提出書類一覧のファイル日付（YYYY-MM-DD形式）を指定します。
+opts = {
+  type: 1 # Integer | 取得情報を指定します。  * 1: メタデータのみを取得します。  * 2: 提出書類一覧及びメタデータを取得します。 
+}
+
+begin
+  #書類一覧 API
+  result = api_instance.find_documents(date, opts)
+  p result
+rescue EdinetAPIClient::ApiError => e
+  puts "Exception when calling DefaultApi->find_documents: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **date** | **String**| 出力対象とする提出書類一覧のファイル日付（YYYY-MM-DD形式）を指定します。 | 
+ **type** | **Integer**| 取得情報を指定します。  * 1: メタデータのみを取得します。  * 2: 提出書類一覧及びメタデータを取得します。  | [optional] [default to 1]
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_document
+
+> File get_document(doc_id, type)
+
+書類取得 API
+
+書類取得 API では、書類をダウンロードすることが可能です。
+
+### Example
+
+```ruby
+# load the gem
+require 'edinet_api_client'
+
+api_instance = EdinetAPIClient::DefaultApi.new
+doc_id = 'S100FMJY' # String | 取得したい書類の書類管理番号を指定します（書類管理番号は、書類一覧 API で取得した提出書類一覧に基づきます。ただし、開示対象外の書類は取得できません）。
+type = 1 # Integer | 必要書類を指定します。  * 1: 提出本文書及び監査報告書を取得します。  * 2: PDF を取得します。  * 3: 代替書面・添付文書を取得します。  * 4: 英文ファイルを取得します。 
+
+begin
+  #書類取得 API
+  result = api_instance.get_document(doc_id, type)
+  p result
+rescue EdinetAPIClient::ApiError => e
+  puts "Exception when calling DefaultApi->get_document: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **doc_id** | **String**| 取得したい書類の書類管理番号を指定します（書類管理番号は、書類一覧 API で取得した提出書類一覧に基づきます。ただし、開示対象外の書類は取得できません）。 | 
+ **type** | **Integer**| 必要書類を指定します。  * 1: 提出本文書及び監査報告書を取得します。  * 2: PDF を取得します。  * 3: 代替書面・添付文書を取得します。  * 4: 英文ファイルを取得します。  | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/pdf, application/octet-stream
+

data/docs/Document.md

@@ -0,0 +1,69 @@
+# EdinetAPIClient::Document
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**seq_number** | **Integer** | ファイル日付ごとの連番です。 | [optional] 
+**doc_id** | **String** | 書類管理番号が出力されます。 | [optional] 
+**edinet_code** | **String** | 提出者の EDINET コードが出力されます。 | [optional] 
+**sec_code** | **String** | 提出者の証券コードが出力されます。 | [optional] 
+**jcn** | **String** | 提出者の法人番号が出力されます。 | [optional] 
+**filer_name** | **String** | 提出者の名前が出力されます。 | [optional] 
+**fund_code** | **String** | ファンドコードが出力されます。 | [optional] 
+**ordinance_code** | **String** | 府令コードが出力されます。 | [optional] 
+**form_code** | **String** | 様式コードが出力されます。 | [optional] 
+**doc_type_code** | **String** | 書類種別コードが出力されます。 | [optional] 
+**period_start** | **String** | 期間（自）が出力されます。 | [optional] 
+**period_end** | **String** | 期間（至）が出力されます。 | [optional] 
+**submit_date_time** | **String** | 提出日時が出力されます。 | [optional] 
+**doc_description** | **String** | EDINET の閲覧サイトの書類検索結果画面において、「提出書類」欄に表示される文字列が出力されます。 | [optional] 
+**issuer_edinet_code** | **String** | 大量保有について発行会社の EDINET コードが出力されます。 | [optional] 
+**subject_edinet_code** | **String** | 公開買付けについて対象となる EDINET コードが出力されます。 | [optional] 
+**subsidiary_edinet_code** | **String** | 小会社の EDINET コードが出力されます。複数存在する場合（最大10個）、\",\"（カンマ）で結合した文字列が出力されます。 | [optional] 
+**current_report_reason** | **String** | 臨時報告書の提出事由が出力されます。複数存在する場合、\",\"（カンマ）で結合した文字列が出力されます。 | [optional] 
+**parent_doc_id** | **String** | 親書類管理番号が出力されます。 | [optional] 
+**ope_date_time** | **String** | 「2-1-6 財務局職員による書類情報修正」、「2-1-7 財務局職員による書類の不開示」、磁気ディスク退出及び紙面提出を行った日時が出力されます。 | [optional] 
+**withdrawal_status** | **String** | 取下書は\"1\"、取り下げられた書類は\"2\"、それ以外は\"0\"が出力されます。 | [optional] 
+**doc_info_edit_status** | **String** | 財務局職員が書類を修正した情報は\"1\"、修正された書類は\"2\"、それ以外は\"0\"が出力されます。 | [optional] 
+**disclosure_status** | **String** | 財務局職員によって書類の不開示を開始した情報は\"1\"、不開示とされている書類は\"2\"、財務局職員によって書類の不開示を解除した情報は\"3\"、それ以外は\"0\"が出力されます。 | [optional] 
+**xbrl_flag** | **String** | 書類に XBRL がある場合は\"1\"、それ以外は\"0\"が出力されます。 | [optional] 
+**pdf_flag** | **String** | 書類に PDF がある場合は\"1\"、それ以外は\"0\"が出力されます。 | [optional] 
+**attach_doc_flag** | **String** | 書類に代替書面・添付文書がある場合は\"1\"、それ以外は\"0\"が出力されます。 | [optional] 
+**english_doc_flag** | **String** | 書類に英文ファイルがある場合は\"1\"、それ以外は\"0\"が出力されます。 | [optional] 
+
+## Code Sample
+
+```ruby
+require 'EdinetAPIClient'
+
+instance = EdinetAPIClient::Document.new(seq_number: 1,
+                                 doc_id: S1000001,
+                                 edinet_code: E10001,
+                                 sec_code: 10000,
+                                 jcn: 6000012010023,
+                                 filer_name: エディネット株式会社,
+                                 fund_code: G00001,
+                                 ordinance_code: 030,
+                                 form_code: 04A000,
+                                 doc_type_code: 030,
+                                 period_start: 2019-04-01,
+                                 period_end: 2020-03-31,
+                                 submit_date_time: 2019-04-01 12:34,
+                                 doc_description: 有価証券届出書(内国投資信託受益証券),
+                                 issuer_edinet_code: null,
+                                 subject_edinet_code: null,
+                                 subsidiary_edinet_code: null,
+                                 current_report_reason: null,
+                                 parent_doc_id: null,
+                                 ope_date_time: null,
+                                 withdrawal_status: 0,
+                                 doc_info_edit_status: 0,
+                                 disclosure_status: 0,
+                                 xbrl_flag: 1,
+                                 pdf_flag: 1,
+                                 attach_doc_flag: 1,
+                                 english_doc_flag: 0)
+```
+
+

data/docs/InlineResponse200.md

@@ -0,0 +1,19 @@
+# EdinetAPIClient::InlineResponse200
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | [**Metadata**](Metadata.md) |  | [optional] 
+**results** | [**Array<Document>**](Document.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'EdinetAPIClient'
+
+instance = EdinetAPIClient::InlineResponse200.new(metadata: null,
+                                 results: null)
+```
+
+

data/docs/Metadata.md

@@ -0,0 +1,27 @@
+# EdinetAPIClient::Metadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | API の名称が出力されます | [optional] 
+**parameter** | [**MetadataParameter**](MetadataParameter.md) |  | [optional] 
+**resultset** | [**MetadataResultset**](MetadataResultset.md) |  | [optional] 
+**process_date_time** | **DateTime** | 提出書類一覧の更新時間が出力されます。提出書類一覧の内容に変更がない場合でも書類一覧更新日時は更新されます。 | [optional] 
+**status** | **String** | ステータスコードが出力されます | [optional] 
+**message** | **String** | メッセージが出力されます | [optional] 
+
+## Code Sample
+
+```ruby
+require 'EdinetAPIClient'
+
+instance = EdinetAPIClient::Metadata.new(title: 提出された書類を把握するための API,
+                                 parameter: null,
+                                 resultset: null,
+                                 process_date_time: null,
+                                 status: 200,
+                                 message: OK)
+```
+
+