kendama 0.2.3 → 1.0.1

data/lib/kendama/models/response_body.rb

@@ -3,10 +3,10 @@
 
 #国税庁が提供するインボイス制度適格請求書発行事業者公表システムWeb-APIを使用するためのクライアントAPI(https://www.invoice-kohyo.nta.go.jp/web-api/index.html)
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.0.1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+OpenAPI Generator version: 7.0.0
 
 =end
 
@@ -103,6 +103,7 @@ module Kendama
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       if !@count.nil? && @count.to_s.length > 8
         invalid_properties.push('invalid value for "count", the character length must be smaller than or equal to 8.')
@@ -134,6 +135,7 @@ module Kendama
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if !@count.nil? && @count.to_s.length > 8
       return false if !@count.nil? && @count.to_s.length < 1
       return false if !@divide_number.nil? && @divide_number.to_s.length > 6
@@ -146,11 +148,15 @@ module Kendama
     # Custom attribute writer method with validation
     # @param [Object] count Value to be assigned
     def count=(count)
-      if !count.nil? && count.to_s.length > 8
+      if count.nil?
+        fail ArgumentError, 'count cannot be nil'
+      end
+
+      if count.to_s.length > 8
         fail ArgumentError, 'invalid value for "count", the character length must be smaller than or equal to 8.'
       end
 
-      if !count.nil? && count.to_s.length < 1
+      if count.to_s.length < 1
         fail ArgumentError, 'invalid value for "count", the character length must be great than or equal to 1.'
       end
 
@@ -160,11 +166,15 @@ module Kendama
     # Custom attribute writer method with validation
     # @param [Object] divide_number Value to be assigned
     def divide_number=(divide_number)
-      if !divide_number.nil? && divide_number.to_s.length > 6
+      if divide_number.nil?
+        fail ArgumentError, 'divide_number cannot be nil'
+      end
+
+      if divide_number.to_s.length > 6
         fail ArgumentError, 'invalid value for "divide_number", the character length must be smaller than or equal to 6.'
       end
 
-      if !divide_number.nil? && divide_number.to_s.length < 1
+      if divide_number.to_s.length < 1
         fail ArgumentError, 'invalid value for "divide_number", the character length must be great than or equal to 1.'
       end
 
@@ -174,11 +184,15 @@ module Kendama
     # Custom attribute writer method with validation
     # @param [Object] divide_size Value to be assigned
     def divide_size=(divide_size)
-      if !divide_size.nil? && divide_size.to_s.length > 6
+      if divide_size.nil?
+        fail ArgumentError, 'divide_size cannot be nil'
+      end
+
+      if divide_size.to_s.length > 6
         fail ArgumentError, 'invalid value for "divide_size", the character length must be smaller than or equal to 6.'
       end
 
-      if !divide_size.nil? && divide_size.to_s.length < 1
+      if divide_size.to_s.length < 1
         fail ArgumentError, 'invalid value for "divide_size", the character length must be great than or equal to 1.'
       end
 
@@ -213,37 +227,30 @@ module Kendama
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
         elsif 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) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     end
 
     # Deserializes the data based on type
     # @param string type Data type
     # @param string value Value to be deserialized
     # @return [Object] Deserialized data
-    def _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)

data/lib/kendama/version.rb

@@ -3,13 +3,13 @@
 
 #国税庁が提供するインボイス制度適格請求書発行事業者公表システムWeb-APIを使用するためのクライアントAPI(https://www.invoice-kohyo.nta.go.jp/web-api/index.html)
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.0.1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+OpenAPI Generator version: 7.0.0
 
 =end
 
 module Kendama
-  VERSION = '0.2.3'
+  VERSION = '1.0.1'
 end

data/lib/kendama.rb

@@ -3,10 +3,10 @@
 
 #国税庁が提供するインボイス制度適格請求書発行事業者公表システムWeb-APIを使用するためのクライアントAPI(https://www.invoice-kohyo.nta.go.jp/web-api/index.html)
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.0.1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+OpenAPI Generator version: 7.0.0
 
 =end
 

data/openapi/root.yaml

@@ -0,0 +1,17 @@
+openapi: 3.0.3
+info:
+  title: 国税庁API
+  description: 国税庁が提供するインボイス制度適格請求書発行事業者公表システムWeb-APIを使用するためのクライアントAPI(https://www.invoice-kohyo.nta.go.jp/web-api/index.html)
+  version: 1.0.1
+servers:
+  - url: https://kensyo.invoice-kohyo.nta.go.jp/
+    description: 検証環境
+  - url: https://web-api.invoice-kohyo.nta.go.jp/
+    description: 本番環境
+paths:
+  "/1/num":
+    $ref: "./v1/num.yaml#/paths/~11~1num"
+  "/1/diff":
+    $ref: "./v1/diff.yaml#/paths/~11~1diff"
+  "/1/valid":
+    $ref: "./v1/valid.yaml#/paths/~11~1valid"

data/openapi/v1/announcement.yaml

@@ -0,0 +1,179 @@
+components:
+  schemas:
+    ResponseBody:
+      type: object
+      properties:
+        lastUpdateDate:
+          type: string
+          description: 最終更新年月日
+          example: "2021-11-01"
+          format: date
+        count:
+          type: string
+          description: 総件数
+          example: 1
+          minLength: 1
+          maxLength: 8
+        divideNumber:
+          type: string
+          description: 分割番号
+          example: 1
+          minLength: 1
+          maxLength: 6
+        divideSize:
+          type: string
+          description: 分割数
+          example: 1
+          minLength: 1
+          maxLength: 6
+        announcement:
+          type: array
+          items:
+            $ref: "#/components/schemas/Announcement"
+
+    Announcement:
+      type: object
+      properties:
+        sequenceNumber:
+          type: string
+          description: 一連番号
+          example: 1
+          minLength: 1
+          maxLength: 8
+        registratedNumber:
+          type: string
+          description: 登録番号
+          example: T8040001999011
+        process:
+          type: string
+          description: 事業者処理区分
+          example: 01
+          enum:
+          - "01"
+          - "02"
+          - "03"
+          - "04"
+          - "99"
+        correct:
+          type: string
+          description: 訂正区分
+          example: 0
+          enum:
+          - 0
+          - 1
+          - ""
+        kind:
+          type: string
+          description: 人格区分
+          example: 2
+          enum:
+          - 1
+          - 2
+        country:
+          type: string
+          description: 国内外区分
+          example: 1
+          enum:
+          - 1
+          - 2
+          - 3
+        latest:
+          type: string
+          description: 最新履歴
+          example: 1
+          enum:
+          - 0
+          - 1
+        registrationDate:
+          type: string
+          description: 登録年月日
+          example: "2023-10-01"
+          format: date
+        updateDate:
+          type: string
+          description: 更新年月日
+          example: "2021-11-01"
+          format: date
+        disposalDate:
+          type: string
+          description: 取消年月日
+        expireDate:
+          type: string
+          description: 失効年月日
+        address:
+          type: string
+          description: 本店又は主たる事務所の所在地（法人）
+          example: 北海道札幌市中央区大通西１０丁目
+          maxLength: 600
+        addressPrefectureCode:
+          type: string
+          description: 本店又は主たる事務所の所在地都道府県コード（法人）
+          example: 01
+        addressCityCode:
+          type: string
+          description: 本店又は主たる事務所の所在地市区町村コード（法人）
+          example: 101
+        addressRequest:
+          type: string
+          description: 本店又は主たる事務所の所在地（公表申出）
+          maxLength: 600
+        addressRequestPrefectureCode:
+          type: string
+          description: 本店又は主たる事務所の所在地都道府県コード（公表申出）
+        addressRequestCityCode:
+          type: string
+          description: 本店又は主たる事務所の所在地市区町村コード（公表申出）
+        kana:
+          type: string
+          description: 日本語（カナ）
+          maxLength: 500
+        name:
+          type: string
+          description: 氏名又は名称
+          example: 株式会社インボイス公表
+          maxLength: 300
+        addressInside:
+          type: string
+          description: 国内において行う資産の譲渡等に係る事務所、事業所その他これらに準ずるものの所在地
+          maxLength: 300
+        addressInsidePrefectureCode:
+          type: string
+          description: 国内において行う資産の譲渡等に係る事務所、事業所その他これらに準ずるものの所在地都道府県コード
+        addressInsideCityCode:
+          type: string
+          description: 国内において行う資産の譲渡等に係る事務所、事業所その他これらに準ずるものの所在地市区町村コード
+        tradeName:
+          type: string
+          description: 主たる屋号
+          maxLength: 200
+        popularName_previousName:
+          type: string
+          description: 通称・旧姓
+          maxLength: 200
+      required:
+        - sequenceNumber
+        - registratedNumber
+        - process
+        - correct
+        - kind
+        - country
+        - latest
+        - registrationDate
+        - updateDate
+        - disposalDate
+        - expireDate
+        - address
+        - addressPrefectureCode
+        - addressCityCode
+        - addressRequest
+        - addressRequestPrefectureCode
+        - addressRequestCityCode
+        - kana
+        - name
+        - addressInside
+        - addressInsidePrefectureCod
+        - addressInsideCityCode
+        - tradeName
+        - popularName_previousName
+        - required
+

data/openapi/v1/diff.yaml

@@ -0,0 +1,87 @@
+openapi: 3.0.3
+info:
+  title: 国税庁API
+  description: 国税庁が提供するインボイス制度適格請求書発行事業者公表システムWeb-APIを使用するためのクライアントAPI(https://www.invoice-kohyo.nta.go.jp/web-api/index.html)
+  version: 1.0.1
+paths:
+  "/1/diff":
+    get:
+      operationId: getAnnouncementByDiff
+      summary: 取得期間を指定して情報を取得
+      description: 取得期間を指定し、当該期間内に「更新年月日」が含まれる公表情報を取得
+      tags:
+        - v1
+      parameters:
+        - $ref: "#/components/parameters/Id"
+        - $ref: "#/components/parameters/From"
+        - $ref: "#/components/parameters/To"
+        - $ref: "#/components/parameters/Type"
+        - $ref: "#/components/parameters/Division"
+        - $ref: "#/components/parameters/Divide"
+      responses:
+        "200":
+          description: 成功
+          content:
+            application/json:
+              schema:
+                $ref: "./announcement.yaml#/components/schemas/ResponseBody"
+
+components:
+  parameters:
+    Id:
+      in: query
+      name: id
+      required: true
+      schema:
+        type: string
+        description: アプリケーションID
+    From:
+      in: query
+      name: from
+      required: true
+      schema:
+        type: string
+        description: 取得期間開始日
+        example: "2024-10-01"
+        format: date
+    To:
+      in: query
+      name: to
+      required: true
+      schema:
+        type: string
+        description: 取得期間終了日
+        example: "2024-10-01"
+        format: date
+    Type:
+      in: query
+      name: type
+      required: true
+      schema:
+        type: string
+        description: 応答形式
+        example: 21
+        enum:
+          # - 01
+          # - 11
+          - 21
+        default: 21
+    Division:
+      in: query
+      name: division
+      schema:
+        type: string
+        description: 人格区分
+        default: 1
+        enum:
+          - 1
+          - 2
+    Divide:
+      in: query
+      name: divide
+      schema:
+        type: string
+        description: 分割番号
+        default: 1
+        minLength: 1
+        maxLength: 999999

data/openapi/v1/num.yaml

@@ -0,0 +1,66 @@
+openapi: 3.0.3
+info:
+  title: 国税庁API
+  description: 国税庁が提供するインボイス制度適格請求書発行事業者公表システムWeb-APIを使用するためのクライアントAPI(https://www.invoice-kohyo.nta.go.jp/web-api/index.html)
+  version: 1.0.1
+paths:
+  "/1/num":
+    get:
+      operationId: getAnnouncementByNumber
+      summary: 登録番号を指定して情報を取得
+      description: 指定された登録番号に係る登録年月日、取消年月日及び失効年月日に紐づく最新情報（履歴情報は任意）を取得
+      tags:
+        - v1
+      parameters:
+        - $ref: "#/components/parameters/Id"
+        - $ref: "#/components/parameters/Number"
+        - $ref: "#/components/parameters/Type"
+        - $ref: "#/components/parameters/History"
+      responses:
+        "200":
+          description: 成功
+          content:
+            application/json:
+              schema:
+                $ref: "./announcement.yaml#/components/schemas/ResponseBody"
+
+components:
+  parameters:
+    Id:
+      in: query
+      name: id
+      required: true
+      schema:
+        type: string
+        description: アプリケーションID
+    Number:
+      in: query
+      name: number
+      required: true
+      schema:
+        type: string
+        description: 登録番号
+        example: T8040001999011
+    Type:
+      in: query
+      name: type
+      required: true
+      schema:
+        type: string
+        description: 応答形式
+        example: 21
+        enum:
+          # - 01
+          # - 11
+          - 21
+        default: 21
+    History:
+      in: query
+      name: history
+      schema:
+        type: string
+        description: 履歴情報要否
+        example: 0
+        enum:
+          - 0
+          - 1

data/openapi/v1/valid.yaml

@@ -0,0 +1,65 @@
+openapi: 3.0.3
+info:
+  title: 国税庁API
+  description: 国税庁が提供するインボイス制度適格請求書発行事業者公表システムWeb-APIを使用するためのクライアントAPI(https://www.invoice-kohyo.nta.go.jp/web-api/index.html)
+  version: 1.0.1
+paths:
+  "/1/valid":
+    get:
+      operationId: getAnnouncementByValid
+      summary: 登録番号と日付を指定して情報を取得
+      description: 登録番号及び指定された日付を基準日とした直近の登録年月日、取消年月日、失効年月日に紐づく情報を取得
+      tags:
+        - v1
+      parameters:
+        - $ref: "#/components/parameters/Id"
+        - $ref: "#/components/parameters/Number"
+        - $ref: "#/components/parameters/Day"
+        - $ref: "#/components/parameters/Type"
+      responses:
+        "200":
+          description: 成功
+          content:
+            application/json:
+              schema:
+                $ref: "./announcement.yaml#/components/schemas/ResponseBody"
+
+components:
+  parameters:
+    Id:
+      in: query
+      name: id
+      required: true
+      schema:
+        type: string
+        description: アプリケーションID
+    Number:
+      in: query
+      name: number
+      required: true
+      schema:
+        type: string
+        description: 登録番号
+        example: T8040001999011
+    Day:
+      in: query
+      name: day
+      required: true
+      schema:
+        type: string
+        description: 判定基準日
+        example: "2023-12-01"
+        format: date
+    Type:
+      in: query
+      name: type
+      required: true
+      schema:
+        type: string
+        description: 応答形式
+        example: 21
+        enum:
+          # - 01
+          # - 11
+          - 21
+        default: 21

data/spec/api/v1_api_spec.rb

@@ -1,12 +1,12 @@
 =begin
 #国税庁API
 
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+#国税庁が提供するインボイス制度適格請求書発行事業者公表システムWeb-APIを使用するためのクライアントAPI(https://www.invoice-kohyo.nta.go.jp/web-api/index.html)
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 1.0.1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+OpenAPI Generator version: 7.0.0
 
 =end
 
@@ -32,6 +32,23 @@ describe 'V1Api' do
     end
   end
 
+  # unit tests for get_announcement_by_diff
+  # 取得期間を指定して情報を取得
+  # 取得期間を指定し、当該期間内に「更新年月日」が含まれる公表情報を取得
+  # @param id 
+  # @param from 
+  # @param to 
+  # @param type 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :division 
+  # @option opts [String] :divide 
+  # @return [ResponseBody]
+  describe 'get_announcement_by_diff test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for get_announcement_by_number
   # 登録番号を指定して情報を取得
   # 指定された登録番号に係る登録年月日、取消年月日及び失効年月日に紐づく最新情報（履歴情報は任意）を取得
@@ -47,4 +64,19 @@ describe 'V1Api' do
     end
   end
 
+  # unit tests for get_announcement_by_valid
+  # 登録番号と日付を指定して情報を取得
+  # 登録番号及び指定された日付を基準日とした直近の登録年月日、取消年月日、失効年月日に紐づく情報を取得
+  # @param id 
+  # @param number 
+  # @param day 
+  # @param type 
+  # @param [Hash] opts the optional parameters
+  # @return [ResponseBody]
+  describe 'get_announcement_by_valid test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/api_client_spec.rb

@@ -3,10 +3,10 @@
 
 #国税庁が提供するインボイス制度適格請求書発行事業者公表システムWeb-APIを使用するためのクライアントAPI(https://www.invoice-kohyo.nta.go.jp/web-api/index.html)
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.0.1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+OpenAPI Generator version: 7.0.0
 
 =end
 

data/spec/configuration_spec.rb

@@ -3,10 +3,10 @@
 
 #国税庁が提供するインボイス制度適格請求書発行事業者公表システムWeb-APIを使用するためのクライアントAPI(https://www.invoice-kohyo.nta.go.jp/web-api/index.html)
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.0.1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+OpenAPI Generator version: 7.0.0
 
 =end