edinet_api_client 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 38e394b3e0ea1ccad57dbc28d7006a0f6108a1e63bd2e3f44876bf0eae051b1e
4
+ data.tar.gz: d25a8817c4ca0c6480b54611f3f029ebae424be7e946795219395aa760f6d50c
5
+ SHA512:
6
+ metadata.gz: a0c48631cd223e1fe4af7e7b407958418e66d08252b32cfa5dd17266ce9bcc69469627aae3a174e55ba45d3361ad3780759b5aad0a286a1fa62e48b2d4692a0f
7
+ data.tar.gz: 532d8444bac77082573cbd3b586ab9921cfad445c2cac4bd9fea1527c3d32476b6568dd5d2cdfc6990e2286dba9147099b6860ebe395f4fa110a884f3137e95b
data/Gemfile ADDED
@@ -0,0 +1,9 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ gem 'pry-byebug'
8
+ gem 'rubocop', '~> 0.66.0'
9
+ end
data/Gemfile.lock ADDED
@@ -0,0 +1,97 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ edinet_api_client (1.0.0)
5
+ json (~> 2.1, >= 2.1.0)
6
+ typhoeus (~> 1.0, >= 1.0.1)
7
+
8
+ GEM
9
+ remote: https://rubygems.org/
10
+ specs:
11
+ ZenTest (4.11.2)
12
+ addressable (2.5.2)
13
+ public_suffix (>= 2.0.2, < 4.0)
14
+ ast (2.4.0)
15
+ autotest (4.4.6)
16
+ ZenTest (>= 4.4.1)
17
+ autotest-fsevent (0.2.14)
18
+ sys-uname
19
+ autotest-growl (0.2.16)
20
+ autotest-rails-pure (4.1.2)
21
+ byebug (10.0.2)
22
+ coderay (1.1.2)
23
+ crack (0.4.3)
24
+ safe_yaml (~> 1.0.0)
25
+ diff-lcs (1.3)
26
+ ethon (0.11.0)
27
+ ffi (>= 1.3.0)
28
+ ffi (1.9.25)
29
+ hashdiff (0.3.7)
30
+ jaro_winkler (1.5.2)
31
+ json (2.1.0)
32
+ method_source (0.9.0)
33
+ parallel (1.17.0)
34
+ parser (2.6.3.0)
35
+ ast (~> 2.4.0)
36
+ pry (0.11.3)
37
+ coderay (~> 1.1.0)
38
+ method_source (~> 0.9.0)
39
+ pry-byebug (3.6.0)
40
+ byebug (~> 10.0)
41
+ pry (~> 0.10)
42
+ psych (3.1.0)
43
+ public_suffix (3.0.3)
44
+ rainbow (3.0.0)
45
+ rake (12.0.0)
46
+ rspec (3.8.0)
47
+ rspec-core (~> 3.8.0)
48
+ rspec-expectations (~> 3.8.0)
49
+ rspec-mocks (~> 3.8.0)
50
+ rspec-core (3.8.0)
51
+ rspec-support (~> 3.8.0)
52
+ rspec-expectations (3.8.1)
53
+ diff-lcs (>= 1.2.0, < 2.0)
54
+ rspec-support (~> 3.8.0)
55
+ rspec-mocks (3.8.0)
56
+ diff-lcs (>= 1.2.0, < 2.0)
57
+ rspec-support (~> 3.8.0)
58
+ rspec-support (3.8.0)
59
+ rubocop (0.66.0)
60
+ jaro_winkler (~> 1.5.1)
61
+ parallel (~> 1.10)
62
+ parser (>= 2.5, != 2.5.1.1)
63
+ psych (>= 3.1.0)
64
+ rainbow (>= 2.2.2, < 4.0)
65
+ ruby-progressbar (~> 1.7)
66
+ unicode-display_width (>= 1.4.0, < 1.6)
67
+ ruby-progressbar (1.10.0)
68
+ safe_yaml (1.0.4)
69
+ sys-uname (1.0.3)
70
+ ffi (>= 1.0.0)
71
+ typhoeus (1.3.0)
72
+ ethon (>= 0.9.0)
73
+ unicode-display_width (1.5.0)
74
+ vcr (3.0.3)
75
+ webmock (1.24.6)
76
+ addressable (>= 2.3.6)
77
+ crack (>= 0.3.2)
78
+ hashdiff
79
+
80
+ PLATFORMS
81
+ ruby
82
+
83
+ DEPENDENCIES
84
+ autotest (~> 4.4, >= 4.4.6)
85
+ autotest-fsevent (~> 0.2, >= 0.2.12)
86
+ autotest-growl (~> 0.2, >= 0.2.16)
87
+ autotest-rails-pure (~> 4.1, >= 4.1.2)
88
+ edinet_api_client!
89
+ pry-byebug
90
+ rake (~> 12.0.0)
91
+ rspec (~> 3.6, >= 3.6.0)
92
+ rubocop (~> 0.66.0)
93
+ vcr (~> 3.0, >= 3.0.1)
94
+ webmock (~> 1.24, >= 1.24.3)
95
+
96
+ BUNDLED WITH
97
+ 1.17.2
data/README.md ADDED
@@ -0,0 +1,98 @@
1
+ # edinet_api_client
2
+
3
+ EdinetAPIClient - the Ruby gem for the EDINET API
4
+
5
+ EDINET API は、利用者が EDINET の画面からではなく、プログラムを介して EDINET のデータベースから効率的にデータを取得できる API(アプリケーション・プログラミング・インターフェース)です。EDINET API により、EDINET 利用者は効率的に開示情報を取得することが可能となります。
6
+
7
+ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
+
9
+ - API version: 1.0.0
10
+ - Package version: 1.0.0
11
+ - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
+ For more information, please visit [https://twitter.com/gabu](https://twitter.com/gabu)
13
+
14
+ ## Installation
15
+
16
+ ### Build a gem
17
+
18
+ To build the Ruby code into a gem:
19
+
20
+ ```shell
21
+ gem build edinet_api_client.gemspec
22
+ ```
23
+
24
+ Then either install the gem locally:
25
+
26
+ ```shell
27
+ gem install ./edinet_api_client-1.0.0.gem
28
+ ```
29
+
30
+ (for development, run `gem install --dev ./edinet_api_client-1.0.0.gem` to install the development dependencies)
31
+
32
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
+
34
+ Finally add this to the Gemfile:
35
+
36
+ gem 'edinet_api_client', '~> 1.0.0'
37
+
38
+ ### Install from Git
39
+
40
+ If the Ruby gem is hosted at a git repository: https://github.com/gabu/edinet_api_client, then add the following in the Gemfile:
41
+
42
+ gem 'edinet_api_client', :git => 'https://github.com/gabu/edinet_api_client.git'
43
+
44
+ ### Include the Ruby code directly
45
+
46
+ Include the Ruby code directly using `-I` as follows:
47
+
48
+ ```shell
49
+ ruby -Ilib script.rb
50
+ ```
51
+
52
+ ## Getting Started
53
+
54
+ Please follow the [installation](#installation) procedure and then run the following code:
55
+
56
+ ```ruby
57
+ # Load the gem
58
+ require 'edinet_api_client'
59
+
60
+ api_instance = EdinetAPIClient::DefaultApi.new
61
+ date = '2019-04-01' # String | 出力対象とする提出書類一覧のファイル日付(YYYY-MM-DD形式)を指定します。
62
+ opts = {
63
+ type: 1 # Integer | 取得情報を指定します。 * 1: メタデータのみを取得します。 * 2: 提出書類一覧及びメタデータを取得します。
64
+ }
65
+
66
+ begin
67
+ #書類一覧 API
68
+ result = api_instance.find_documents(date, opts)
69
+ p result
70
+ rescue EdinetAPIClient::ApiError => e
71
+ puts "Exception when calling DefaultApi->find_documents: #{e}"
72
+ end
73
+
74
+ ```
75
+
76
+ ## Documentation for API Endpoints
77
+
78
+ All URIs are relative to *https://disclosure.edinet-fsa.go.jp/api/v1*
79
+
80
+ Class | Method | HTTP request | Description
81
+ ------------ | ------------- | ------------- | -------------
82
+ *EdinetAPIClient::DefaultApi* | [**find_documents**](docs/DefaultApi.md#find_documents) | **GET** /documents.json | 書類一覧 API
83
+ *EdinetAPIClient::DefaultApi* | [**get_document**](docs/DefaultApi.md#get_document) | **GET** /documents/{docID} | 書類取得 API
84
+
85
+
86
+ ## Documentation for Models
87
+
88
+ - [EdinetAPIClient::Document](docs/Document.md)
89
+ - [EdinetAPIClient::InlineResponse200](docs/InlineResponse200.md)
90
+ - [EdinetAPIClient::Metadata](docs/Metadata.md)
91
+ - [EdinetAPIClient::MetadataParameter](docs/MetadataParameter.md)
92
+ - [EdinetAPIClient::MetadataResultset](docs/MetadataResultset.md)
93
+
94
+
95
+ ## Documentation for Authorization
96
+
97
+ All endpoints do not require authorization.
98
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+
3
+ begin
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+ task default: :spec
8
+ rescue LoadError
9
+ # no rspec available
10
+ end
@@ -0,0 +1,110 @@
1
+ # EdinetAPIClient::DefaultApi
2
+
3
+ All URIs are relative to *https://disclosure.edinet-fsa.go.jp/api/v1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**find_documents**](DefaultApi.md#find_documents) | **GET** /documents.json | 書類一覧 API
8
+ [**get_document**](DefaultApi.md#get_document) | **GET** /documents/{docID} | 書類取得 API
9
+
10
+
11
+
12
+ ## find_documents
13
+
14
+ > InlineResponse200 find_documents(date, opts)
15
+
16
+ 書類一覧 API
17
+
18
+ 書類一覧 API では、「メタデータのみ」または「提出書類一覧及びメタデータ」を取得することが可能です。
19
+
20
+ ### Example
21
+
22
+ ```ruby
23
+ # load the gem
24
+ require 'edinet_api_client'
25
+
26
+ api_instance = EdinetAPIClient::DefaultApi.new
27
+ date = '2019-04-01' # String | 出力対象とする提出書類一覧のファイル日付(YYYY-MM-DD形式)を指定します。
28
+ opts = {
29
+ type: 1 # Integer | 取得情報を指定します。 * 1: メタデータのみを取得します。 * 2: 提出書類一覧及びメタデータを取得します。
30
+ }
31
+
32
+ begin
33
+ #書類一覧 API
34
+ result = api_instance.find_documents(date, opts)
35
+ p result
36
+ rescue EdinetAPIClient::ApiError => e
37
+ puts "Exception when calling DefaultApi->find_documents: #{e}"
38
+ end
39
+ ```
40
+
41
+ ### Parameters
42
+
43
+
44
+ Name | Type | Description | Notes
45
+ ------------- | ------------- | ------------- | -------------
46
+ **date** | **String**| 出力対象とする提出書類一覧のファイル日付(YYYY-MM-DD形式)を指定します。 |
47
+ **type** | **Integer**| 取得情報を指定します。 * 1: メタデータのみを取得します。 * 2: 提出書類一覧及びメタデータを取得します。 | [optional] [default to 1]
48
+
49
+ ### Return type
50
+
51
+ [**InlineResponse200**](InlineResponse200.md)
52
+
53
+ ### Authorization
54
+
55
+ No authorization required
56
+
57
+ ### HTTP request headers
58
+
59
+ - **Content-Type**: Not defined
60
+ - **Accept**: application/json
61
+
62
+
63
+ ## get_document
64
+
65
+ > File get_document(doc_id, type)
66
+
67
+ 書類取得 API
68
+
69
+ 書類取得 API では、書類をダウンロードすることが可能です。
70
+
71
+ ### Example
72
+
73
+ ```ruby
74
+ # load the gem
75
+ require 'edinet_api_client'
76
+
77
+ api_instance = EdinetAPIClient::DefaultApi.new
78
+ doc_id = 'S100FMJY' # String | 取得したい書類の書類管理番号を指定します(書類管理番号は、書類一覧 API で取得した提出書類一覧に基づきます。ただし、開示対象外の書類は取得できません)。
79
+ type = 1 # Integer | 必要書類を指定します。 * 1: 提出本文書及び監査報告書を取得します。 * 2: PDF を取得します。 * 3: 代替書面・添付文書を取得します。 * 4: 英文ファイルを取得します。
80
+
81
+ begin
82
+ #書類取得 API
83
+ result = api_instance.get_document(doc_id, type)
84
+ p result
85
+ rescue EdinetAPIClient::ApiError => e
86
+ puts "Exception when calling DefaultApi->get_document: #{e}"
87
+ end
88
+ ```
89
+
90
+ ### Parameters
91
+
92
+
93
+ Name | Type | Description | Notes
94
+ ------------- | ------------- | ------------- | -------------
95
+ **doc_id** | **String**| 取得したい書類の書類管理番号を指定します(書類管理番号は、書類一覧 API で取得した提出書類一覧に基づきます。ただし、開示対象外の書類は取得できません)。 |
96
+ **type** | **Integer**| 必要書類を指定します。 * 1: 提出本文書及び監査報告書を取得します。 * 2: PDF を取得します。 * 3: 代替書面・添付文書を取得します。 * 4: 英文ファイルを取得します。 |
97
+
98
+ ### Return type
99
+
100
+ **File**
101
+
102
+ ### Authorization
103
+
104
+ No authorization required
105
+
106
+ ### HTTP request headers
107
+
108
+ - **Content-Type**: Not defined
109
+ - **Accept**: application/pdf, application/octet-stream
110
+
data/docs/Document.md ADDED
@@ -0,0 +1,69 @@
1
+ # EdinetAPIClient::Document
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **seq_number** | **Integer** | ファイル日付ごとの連番です。 | [optional]
8
+ **doc_id** | **String** | 書類管理番号が出力されます。 | [optional]
9
+ **edinet_code** | **String** | 提出者の EDINET コードが出力されます。 | [optional]
10
+ **sec_code** | **String** | 提出者の証券コードが出力されます。 | [optional]
11
+ **jcn** | **String** | 提出者の法人番号が出力されます。 | [optional]
12
+ **filer_name** | **String** | 提出者の名前が出力されます。 | [optional]
13
+ **fund_code** | **String** | ファンドコードが出力されます。 | [optional]
14
+ **ordinance_code** | **String** | 府令コードが出力されます。 | [optional]
15
+ **form_code** | **String** | 様式コードが出力されます。 | [optional]
16
+ **doc_type_code** | **String** | 書類種別コードが出力されます。 | [optional]
17
+ **period_start** | **String** | 期間(自)が出力されます。 | [optional]
18
+ **period_end** | **String** | 期間(至)が出力されます。 | [optional]
19
+ **submit_date_time** | **String** | 提出日時が出力されます。 | [optional]
20
+ **doc_description** | **String** | EDINET の閲覧サイトの書類検索結果画面において、「提出書類」欄に表示される文字列が出力されます。 | [optional]
21
+ **issuer_edinet_code** | **String** | 大量保有について発行会社の EDINET コードが出力されます。 | [optional]
22
+ **subject_edinet_code** | **String** | 公開買付けについて対象となる EDINET コードが出力されます。 | [optional]
23
+ **subsidiary_edinet_code** | **String** | 小会社の EDINET コードが出力されます。複数存在する場合(最大10個)、\&quot;,\&quot;(カンマ)で結合した文字列が出力されます。 | [optional]
24
+ **current_report_reason** | **String** | 臨時報告書の提出事由が出力されます。複数存在する場合、\&quot;,\&quot;(カンマ)で結合した文字列が出力されます。 | [optional]
25
+ **parent_doc_id** | **String** | 親書類管理番号が出力されます。 | [optional]
26
+ **ope_date_time** | **String** | 「2-1-6 財務局職員による書類情報修正」、「2-1-7 財務局職員による書類の不開示」、磁気ディスク退出及び紙面提出を行った日時が出力されます。 | [optional]
27
+ **withdrawal_status** | **String** | 取下書は\&quot;1\&quot;、取り下げられた書類は\&quot;2\&quot;、それ以外は\&quot;0\&quot;が出力されます。 | [optional]
28
+ **doc_info_edit_status** | **String** | 財務局職員が書類を修正した情報は\&quot;1\&quot;、修正された書類は\&quot;2\&quot;、それ以外は\&quot;0\&quot;が出力されます。 | [optional]
29
+ **disclosure_status** | **String** | 財務局職員によって書類の不開示を開始した情報は\&quot;1\&quot;、不開示とされている書類は\&quot;2\&quot;、財務局職員によって書類の不開示を解除した情報は\&quot;3\&quot;、それ以外は\&quot;0\&quot;が出力されます。 | [optional]
30
+ **xbrl_flag** | **String** | 書類に XBRL がある場合は\&quot;1\&quot;、それ以外は\&quot;0\&quot;が出力されます。 | [optional]
31
+ **pdf_flag** | **String** | 書類に PDF がある場合は\&quot;1\&quot;、それ以外は\&quot;0\&quot;が出力されます。 | [optional]
32
+ **attach_doc_flag** | **String** | 書類に代替書面・添付文書がある場合は\&quot;1\&quot;、それ以外は\&quot;0\&quot;が出力されます。 | [optional]
33
+ **english_doc_flag** | **String** | 書類に英文ファイルがある場合は\&quot;1\&quot;、それ以外は\&quot;0\&quot;が出力されます。 | [optional]
34
+
35
+ ## Code Sample
36
+
37
+ ```ruby
38
+ require 'EdinetAPIClient'
39
+
40
+ instance = EdinetAPIClient::Document.new(seq_number: 1,
41
+ doc_id: S1000001,
42
+ edinet_code: E10001,
43
+ sec_code: 10000,
44
+ jcn: 6000012010023,
45
+ filer_name: エディネット株式会社,
46
+ fund_code: G00001,
47
+ ordinance_code: 030,
48
+ form_code: 04A000,
49
+ doc_type_code: 030,
50
+ period_start: 2019-04-01,
51
+ period_end: 2020-03-31,
52
+ submit_date_time: 2019-04-01 12:34,
53
+ doc_description: 有価証券届出書(内国投資信託受益証券),
54
+ issuer_edinet_code: null,
55
+ subject_edinet_code: null,
56
+ subsidiary_edinet_code: null,
57
+ current_report_reason: null,
58
+ parent_doc_id: null,
59
+ ope_date_time: null,
60
+ withdrawal_status: 0,
61
+ doc_info_edit_status: 0,
62
+ disclosure_status: 0,
63
+ xbrl_flag: 1,
64
+ pdf_flag: 1,
65
+ attach_doc_flag: 1,
66
+ english_doc_flag: 0)
67
+ ```
68
+
69
+
@@ -0,0 +1,19 @@
1
+ # EdinetAPIClient::InlineResponse200
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **metadata** | [**Metadata**](Metadata.md) | | [optional]
8
+ **results** | [**Array&lt;Document&gt;**](Document.md) | | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'EdinetAPIClient'
14
+
15
+ instance = EdinetAPIClient::InlineResponse200.new(metadata: null,
16
+ results: null)
17
+ ```
18
+
19
+
data/docs/Metadata.md ADDED
@@ -0,0 +1,27 @@
1
+ # EdinetAPIClient::Metadata
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **title** | **String** | API の名称が出力されます | [optional]
8
+ **parameter** | [**MetadataParameter**](MetadataParameter.md) | | [optional]
9
+ **resultset** | [**MetadataResultset**](MetadataResultset.md) | | [optional]
10
+ **process_date_time** | **DateTime** | 提出書類一覧の更新時間が出力されます。提出書類一覧の内容に変更がない場合でも書類一覧更新日時は更新されます。 | [optional]
11
+ **status** | **String** | ステータスコードが出力されます | [optional]
12
+ **message** | **String** | メッセージが出力されます | [optional]
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'EdinetAPIClient'
18
+
19
+ instance = EdinetAPIClient::Metadata.new(title: 提出された書類を把握するための API,
20
+ parameter: null,
21
+ resultset: null,
22
+ process_date_time: null,
23
+ status: 200,
24
+ message: OK)
25
+ ```
26
+
27
+