Class: EdinetAPIClient::Document

Inherits:
Object
  • Object
show all
Defined in:
lib/edinet_api_client/models/document.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Document

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/edinet_api_client/models/document.rb', line 166

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `EdinetAPIClient::Document` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `EdinetAPIClient::Document`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'seq_number')
    self.seq_number = attributes[:'seq_number']
  end

  if attributes.key?(:'doc_id')
    self.doc_id = attributes[:'doc_id']
  end

  if attributes.key?(:'edinet_code')
    self.edinet_code = attributes[:'edinet_code']
  end

  if attributes.key?(:'sec_code')
    self.sec_code = attributes[:'sec_code']
  end

  if attributes.key?(:'jcn')
    self.jcn = attributes[:'jcn']
  end

  if attributes.key?(:'filer_name')
    self.filer_name = attributes[:'filer_name']
  end

  if attributes.key?(:'fund_code')
    self.fund_code = attributes[:'fund_code']
  end

  if attributes.key?(:'ordinance_code')
    self.ordinance_code = attributes[:'ordinance_code']
  end

  if attributes.key?(:'form_code')
    self.form_code = attributes[:'form_code']
  end

  if attributes.key?(:'doc_type_code')
    self.doc_type_code = attributes[:'doc_type_code']
  end

  if attributes.key?(:'period_start')
    self.period_start = attributes[:'period_start']
  end

  if attributes.key?(:'period_end')
    self.period_end = attributes[:'period_end']
  end

  if attributes.key?(:'submit_date_time')
    self.submit_date_time = attributes[:'submit_date_time']
  end

  if attributes.key?(:'doc_description')
    self.doc_description = attributes[:'doc_description']
  end

  if attributes.key?(:'issuer_edinet_code')
    self.issuer_edinet_code = attributes[:'issuer_edinet_code']
  end

  if attributes.key?(:'subject_edinet_code')
    self.subject_edinet_code = attributes[:'subject_edinet_code']
  end

  if attributes.key?(:'subsidiary_edinet_code')
    self.subsidiary_edinet_code = attributes[:'subsidiary_edinet_code']
  end

  if attributes.key?(:'current_report_reason')
    self.current_report_reason = attributes[:'current_report_reason']
  end

  if attributes.key?(:'parent_doc_id')
    self.parent_doc_id = attributes[:'parent_doc_id']
  end

  if attributes.key?(:'ope_date_time')
    self.ope_date_time = attributes[:'ope_date_time']
  end

  if attributes.key?(:'withdrawal_status')
    self.withdrawal_status = attributes[:'withdrawal_status']
  end

  if attributes.key?(:'doc_info_edit_status')
    self.doc_info_edit_status = attributes[:'doc_info_edit_status']
  end

  if attributes.key?(:'disclosure_status')
    self.disclosure_status = attributes[:'disclosure_status']
  end

  if attributes.key?(:'xbrl_flag')
    self.xbrl_flag = attributes[:'xbrl_flag']
  end

  if attributes.key?(:'pdf_flag')
    self.pdf_flag = attributes[:'pdf_flag']
  end

  if attributes.key?(:'attach_doc_flag')
    self.attach_doc_flag = attributes[:'attach_doc_flag']
  end

  if attributes.key?(:'english_doc_flag')
    self.english_doc_flag = attributes[:'english_doc_flag']
  end
end

Instance Attribute Details

#attach_doc_flag ⇒ Object

書類に代替書面・添付文書がある場合は"1"、それ以外は"0"が出力されます。



93
94
95
 
# File 'lib/edinet_api_client/models/document.rb', line 93

def attach_doc_flag
  @attach_doc_flag
end

#current_report_reason ⇒ Object

臨時報告書の提出事由が出力されます。複数存在する場合、","（カンマ）で結合した文字列が出力されます。



69
70
71
 
# File 'lib/edinet_api_client/models/document.rb', line 69

def current_report_reason
  @current_report_reason
end

#disclosure_status ⇒ Object

財務局職員によって書類の不開示を開始した情報は"1"、不開示とされている書類は"2"、財務局職員によって書類の不開示を解除した情報は"3"、それ以外は"0"が出力されます。



84
85
86
 
# File 'lib/edinet_api_client/models/document.rb', line 84

def disclosure_status
  @disclosure_status
end

#doc_description ⇒ Object

EDINET の閲覧サイトの書類検索結果画面において、「提出書類」欄に表示される文字列が出力されます。



57
58
59
 
# File 'lib/edinet_api_client/models/document.rb', line 57

def doc_description
  @doc_description
end

#doc_id ⇒ Object

書類管理番号が出力されます。



21
22
23
 
# File 'lib/edinet_api_client/models/document.rb', line 21

def doc_id
  @doc_id
end

#doc_info_edit_status ⇒ Object

財務局職員が書類を修正した情報は"1"、修正された書類は"2"、それ以外は"0"が出力されます。



81
82
83
 
# File 'lib/edinet_api_client/models/document.rb', line 81

def doc_info_edit_status
  @doc_info_edit_status
end

#doc_type_code ⇒ Object

書類種別コードが出力されます。



45
46
47
 
# File 'lib/edinet_api_client/models/document.rb', line 45

def doc_type_code
  @doc_type_code
end

#edinet_code ⇒ Object

提出者の EDINET コードが出力されます。



24
25
26
 
# File 'lib/edinet_api_client/models/document.rb', line 24

def edinet_code
  @edinet_code
end

#english_doc_flag ⇒ Object

書類に英文ファイルがある場合は"1"、それ以外は"0"が出力されます。



96
97
98
 
# File 'lib/edinet_api_client/models/document.rb', line 96

def english_doc_flag
  @english_doc_flag
end

#filer_name ⇒ Object

提出者の名前が出力されます。



33
34
35
 
# File 'lib/edinet_api_client/models/document.rb', line 33

def filer_name
  @filer_name
end

#form_code ⇒ Object

様式コードが出力されます。



42
43
44
 
# File 'lib/edinet_api_client/models/document.rb', line 42

def form_code
  @form_code
end

#fund_code ⇒ Object

ファンドコードが出力されます。



36
37
38
 
# File 'lib/edinet_api_client/models/document.rb', line 36

def fund_code
  @fund_code
end

#issuer_edinet_code ⇒ Object

大量保有について発行会社の EDINET コードが出力されます。



60
61
62
 
# File 'lib/edinet_api_client/models/document.rb', line 60

def issuer_edinet_code
  @issuer_edinet_code
end

#jcn ⇒ Object

提出者の法人番号が出力されます。



30
31
32
 
# File 'lib/edinet_api_client/models/document.rb', line 30

def jcn
  @jcn
end

#ope_date_time ⇒ Object

「2-1-6 財務局職員による書類情報修正」、「2-1-7 財務局職員による書類の不開示」、磁気ディスク退出及び紙面提出を行った日時が出力されます。



75
76
77
 
# File 'lib/edinet_api_client/models/document.rb', line 75

def ope_date_time
  @ope_date_time
end

#ordinance_code ⇒ Object

府令コードが出力されます。



39
40
41
 
# File 'lib/edinet_api_client/models/document.rb', line 39

def ordinance_code
  @ordinance_code
end

#parent_doc_id ⇒ Object

親書類管理番号が出力されます。



72
73
74
 
# File 'lib/edinet_api_client/models/document.rb', line 72

def parent_doc_id
  @parent_doc_id
end

#pdf_flag ⇒ Object

書類に PDF がある場合は"1"、それ以外は"0"が出力されます。



90
91
92
 
# File 'lib/edinet_api_client/models/document.rb', line 90

def pdf_flag
  @pdf_flag
end

#period_end ⇒ Object

期間（至）が出力されます。



51
52
53
 
# File 'lib/edinet_api_client/models/document.rb', line 51

def period_end
  @period_end
end

#period_start ⇒ Object

期間（自）が出力されます。



48
49
50
 
# File 'lib/edinet_api_client/models/document.rb', line 48

def period_start
  @period_start
end

#sec_code ⇒ Object

提出者の証券コードが出力されます。



27
28
29
 
# File 'lib/edinet_api_client/models/document.rb', line 27

def sec_code
  @sec_code
end

#seq_number ⇒ Object

ファイル日付ごとの連番です。



18
19
20
 
# File 'lib/edinet_api_client/models/document.rb', line 18

def seq_number
  @seq_number
end

#subject_edinet_code ⇒ Object

公開買付けについて対象となる EDINET コードが出力されます。



63
64
65
 
# File 'lib/edinet_api_client/models/document.rb', line 63

def subject_edinet_code
  @subject_edinet_code
end

#submit_date_time ⇒ Object

提出日時が出力されます。



54
55
56
 
# File 'lib/edinet_api_client/models/document.rb', line 54

def submit_date_time
  @submit_date_time
end

#subsidiary_edinet_code ⇒ Object

小会社の EDINET コードが出力されます。複数存在する場合（最大10個）、","（カンマ）で結合した文字列が出力されます。



66
67
68
 
# File 'lib/edinet_api_client/models/document.rb', line 66

def subsidiary_edinet_code
  @subsidiary_edinet_code
end

#withdrawal_status ⇒ Object

取下書は"1"、取り下げられた書類は"2"、それ以外は"0"が出力されます。



78
79
80
 
# File 'lib/edinet_api_client/models/document.rb', line 78

def withdrawal_status
  @withdrawal_status
end

#xbrl_flag ⇒ Object

書類に XBRL がある場合は"1"、それ以外は"0"が出力されます。



87
88
89
 
# File 'lib/edinet_api_client/models/document.rb', line 87

def xbrl_flag
  @xbrl_flag
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/edinet_api_client/models/document.rb', line 99

def self.attribute_map
  {
    :'seq_number' => :'seqNumber',
    :'doc_id' => :'docID',
    :'edinet_code' => :'edinetCode',
    :'sec_code' => :'secCode',
    :'jcn' => :'JCN',
    :'filer_name' => :'filerName',
    :'fund_code' => :'fundCode',
    :'ordinance_code' => :'ordinanceCode',
    :'form_code' => :'formCode',
    :'doc_type_code' => :'docTypeCode',
    :'period_start' => :'periodStart',
    :'period_end' => :'periodEnd',
    :'submit_date_time' => :'submitDateTime',
    :'doc_description' => :'docDescription',
    :'issuer_edinet_code' => :'issuerEdinetCode',
    :'subject_edinet_code' => :'subjectEdinetCode',
    :'subsidiary_edinet_code' => :'subsidiaryEdinetCode',
    :'current_report_reason' => :'currentReportReason',
    :'parent_doc_id' => :'parentDocID',
    :'ope_date_time' => :'opeDateTime',
    :'withdrawal_status' => :'withdrawalStatus',
    :'doc_info_edit_status' => :'docInfoEditStatus',
    :'disclosure_status' => :'disclosureStatus',
    :'xbrl_flag' => :'xbrlFlag',
    :'pdf_flag' => :'pdfFlag',
    :'attach_doc_flag' => :'attachDocFlag',
    :'english_doc_flag' => :'englishDocFlag'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



350
351
352
 
# File 'lib/edinet_api_client/models/document.rb', line 350

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/edinet_api_client/models/document.rb', line 132

def self.openapi_types
  {
    :'seq_number' => :'Integer',
    :'doc_id' => :'String',
    :'edinet_code' => :'String',
    :'sec_code' => :'String',
    :'jcn' => :'String',
    :'filer_name' => :'String',
    :'fund_code' => :'String',
    :'ordinance_code' => :'String',
    :'form_code' => :'String',
    :'doc_type_code' => :'String',
    :'period_start' => :'String',
    :'period_end' => :'String',
    :'submit_date_time' => :'String',
    :'doc_description' => :'String',
    :'issuer_edinet_code' => :'String',
    :'subject_edinet_code' => :'String',
    :'subsidiary_edinet_code' => :'String',
    :'current_report_reason' => :'String',
    :'parent_doc_id' => :'String',
    :'ope_date_time' => :'String',
    :'withdrawal_status' => :'String',
    :'doc_info_edit_status' => :'String',
    :'disclosure_status' => :'String',
    :'xbrl_flag' => :'String',
    :'pdf_flag' => :'String',
    :'attach_doc_flag' => :'String',
    :'english_doc_flag' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/edinet_api_client/models/document.rb', line 303

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      seq_number == o.seq_number &&
      doc_id == o.doc_id &&
      edinet_code == o.edinet_code &&
      sec_code == o.sec_code &&
      jcn == o.jcn &&
      filer_name == o.filer_name &&
      fund_code == o.fund_code &&
      ordinance_code == o.ordinance_code &&
      form_code == o.form_code &&
      doc_type_code == o.doc_type_code &&
      period_start == o.period_start &&
      period_end == o.period_end &&
      submit_date_time == o.submit_date_time &&
      doc_description == o.doc_description &&
      issuer_edinet_code == o.issuer_edinet_code &&
      subject_edinet_code == o.subject_edinet_code &&
      subsidiary_edinet_code == o.subsidiary_edinet_code &&
      current_report_reason == o.current_report_reason &&
      parent_doc_id == o.parent_doc_id &&
      ope_date_time == o.ope_date_time &&
      withdrawal_status == o.withdrawal_status &&
      doc_info_edit_status == o.doc_info_edit_status &&
      disclosure_status == o.disclosure_status &&
      xbrl_flag == o.xbrl_flag &&
      pdf_flag == o.pdf_flag &&
      attach_doc_flag == o.attach_doc_flag &&
      english_doc_flag == o.english_doc_flag
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/edinet_api_client/models/document.rb', line 378

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    EdinetAPIClient.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/edinet_api_client/models/document.rb', line 443

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/edinet_api_client/models/document.rb', line 357

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


337
338
339
 
# File 'lib/edinet_api_client/models/document.rb', line 337

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



343
344
345
 
# File 'lib/edinet_api_client/models/document.rb', line 343

def hash
  [seq_number, doc_id, edinet_code, sec_code, jcn, filer_name, fund_code, ordinance_code, form_code, doc_type_code, period_start, period_end, submit_date_time, doc_description, issuer_edinet_code, subject_edinet_code, subsidiary_edinet_code, current_report_reason, parent_doc_id, ope_date_time, withdrawal_status, doc_info_edit_status, disclosure_status, xbrl_flag, pdf_flag, attach_doc_flag, english_doc_flag].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



290
291
292
293
 
# File 'lib/edinet_api_client/models/document.rb', line 290

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



423
424
425
 
# File 'lib/edinet_api_client/models/document.rb', line 423

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



429
430
431
432
433
434
435
436
437
 
# File 'lib/edinet_api_client/models/document.rb', line 429

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



417
418
419
 
# File 'lib/edinet_api_client/models/document.rb', line 417

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



297
298
299
 
# File 'lib/edinet_api_client/models/document.rb', line 297

def valid?
  true
end