newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/signature_fr_v1_dto.rb

@@ -0,0 +1,295 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # SignatureFrV1Dto Model.
+  class SignatureFrV1Dto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The APE code of the tenant.
+    # @return [String]
+    attr_accessor :ape_identifier
+
+    # Cashbox ID.
+    # @return [String]
+    attr_accessor :cashbox_id
+
+    # Cashbox name.
+    # @return [String]
+    attr_accessor :cashbox_name
+
+    # Cashbox name.
+    # @return [FiscalEnvironmentEnum]
+    attr_accessor :environment
+
+    # The type of operation.
+    # @return [String]
+    attr_accessor :operation
+
+    # Receipt URL in fiskaltrust Portal.
+    # @return [String]
+    attr_accessor :portal_receipt_url
+
+    # Queue ID.
+    # @return [String]
+    attr_accessor :queue_id
+
+    # Queue item ID.
+    # @return [String]
+    attr_accessor :queue_item_id
+
+    # Queue row.
+    # @return [Integer]
+    attr_accessor :queue_row
+
+    # Receipt ID to be printed on receipt.
+    # @return [String]
+    attr_accessor :receipt_id
+
+    # Receipt moment.
+    # @return [DateTime]
+    attr_accessor :receipt_moment
+
+    # List of signature items to be printed on receipt.
+    # @return [Array[SignatureItemFrV1Dto]]
+    attr_accessor :signature_items
+
+    # List of signature items to be printed on receipt.
+    # @return [FtFrStateEnum]
+    attr_accessor :state
+
+    # Additional state data (JSON string).
+    # @return [Object]
+    attr_accessor :state_data
+
+    # Terminal/associate ID.
+    # @return [String]
+    attr_accessor :terminal_id
+
+    # The VAT identification number of the tenant.
+    # @return [String]
+    attr_accessor :vat_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ape_identifier'] = 'ape_identifier'
+      @_hash['cashbox_id'] = 'cashbox_id'
+      @_hash['cashbox_name'] = 'cashbox_name'
+      @_hash['environment'] = 'environment'
+      @_hash['operation'] = 'operation'
+      @_hash['portal_receipt_url'] = 'portal_receipt_url'
+      @_hash['queue_id'] = 'queue_id'
+      @_hash['queue_item_id'] = 'queue_item_id'
+      @_hash['queue_row'] = 'queue_row'
+      @_hash['receipt_id'] = 'receipt_id'
+      @_hash['receipt_moment'] = 'receipt_moment'
+      @_hash['signature_items'] = 'signature_items'
+      @_hash['state'] = 'state'
+      @_hash['state_data'] = 'state_data'
+      @_hash['terminal_id'] = 'terminal_id'
+      @_hash['vat_number'] = 'vat_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        operation
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ape_identifier = nil, cashbox_id = nil, cashbox_name = nil,
+                   environment = nil, portal_receipt_url = nil, queue_id = nil,
+                   queue_item_id = nil, queue_row = nil, receipt_id = nil,
+                   receipt_moment = nil, signature_items = nil, state = nil,
+                   state_data = nil, terminal_id = nil, vat_number = nil,
+                   operation = SKIP)
+      @ape_identifier = ape_identifier
+      @cashbox_id = cashbox_id
+      @cashbox_name = cashbox_name
+      @environment = environment
+      @operation = operation unless operation == SKIP
+      @portal_receipt_url = portal_receipt_url
+      @queue_id = queue_id
+      @queue_item_id = queue_item_id
+      @queue_row = queue_row
+      @receipt_id = receipt_id
+      @receipt_moment = receipt_moment
+      @signature_items = signature_items
+      @state = state
+      @state_data = state_data
+      @terminal_id = terminal_id
+      @vat_number = vat_number
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      ape_identifier =
+        hash.key?('ape_identifier') ? hash['ape_identifier'] : nil
+      cashbox_id = hash.key?('cashbox_id') ? hash['cashbox_id'] : nil
+      cashbox_name = hash.key?('cashbox_name') ? hash['cashbox_name'] : nil
+      environment = hash.key?('environment') ? hash['environment'] : nil
+      portal_receipt_url =
+        hash.key?('portal_receipt_url') ? hash['portal_receipt_url'] : nil
+      queue_id = hash.key?('queue_id') ? hash['queue_id'] : nil
+      queue_item_id = hash.key?('queue_item_id') ? hash['queue_item_id'] : nil
+      queue_row = hash.key?('queue_row') ? hash['queue_row'] : nil
+      receipt_id = hash.key?('receipt_id') ? hash['receipt_id'] : nil
+      receipt_moment = if hash.key?('receipt_moment')
+                         (DateTimeHelper.from_rfc3339(hash['receipt_moment']) if hash['receipt_moment'])
+                       end
+      # Parameter is an array, so we need to iterate through it
+      signature_items = nil
+      unless hash['signature_items'].nil?
+        signature_items = []
+        hash['signature_items'].each do |structure|
+          signature_items << (SignatureItemFrV1Dto.from_hash(structure) if structure)
+        end
+      end
+
+      signature_items = nil unless hash.key?('signature_items')
+      state = hash.key?('state') ? hash['state'] : nil
+      state_data = hash.key?('state_data') ? hash['state_data'] : nil
+      terminal_id = hash.key?('terminal_id') ? hash['terminal_id'] : nil
+      vat_number = hash.key?('vat_number') ? hash['vat_number'] : nil
+      operation = hash.key?('operation') ? hash['operation'] : SKIP
+
+      # Create object from extracted values.
+      SignatureFrV1Dto.new(ape_identifier,
+                           cashbox_id,
+                           cashbox_name,
+                           environment,
+                           portal_receipt_url,
+                           queue_id,
+                           queue_item_id,
+                           queue_row,
+                           receipt_id,
+                           receipt_moment,
+                           signature_items,
+                           state,
+                           state_data,
+                           terminal_id,
+                           vat_number,
+                           operation)
+    end
+
+    def to_custom_receipt_moment
+      DateTimeHelper.to_rfc3339(receipt_moment)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SignatureFrV1Dto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.ape_identifier,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.cashbox_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.cashbox_name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.environment,
+                                  ->(val) { FiscalEnvironmentEnum.validate(val) }) and
+            APIHelper.valid_type?(value.portal_receipt_url,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.queue_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.queue_item_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.queue_row,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.receipt_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.receipt_moment,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.signature_items,
+                                  ->(val) { SignatureItemFrV1Dto.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.state,
+                                  ->(val) { FtFrStateEnum.validate(val) }) and
+            APIHelper.valid_type?(value.state_data,
+                                  ->(val) { val.instance_of? Object }) and
+            APIHelper.valid_type?(value.terminal_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.vat_number,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['ape_identifier'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['cashbox_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['cashbox_name'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['environment'],
+                                ->(val) { FiscalEnvironmentEnum.validate(val) }) and
+          APIHelper.valid_type?(value['portal_receipt_url'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['queue_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['queue_item_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['queue_row'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['receipt_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['receipt_moment'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['signature_items'],
+                                ->(val) { SignatureItemFrV1Dto.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['state'],
+                                ->(val) { FtFrStateEnum.validate(val) }) and
+          APIHelper.valid_type?(value['state_data'],
+                                ->(val) { val.instance_of? Object }) and
+          APIHelper.valid_type?(value['terminal_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['vat_number'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ape_identifier: #{@ape_identifier}, cashbox_id: #{@cashbox_id},"\
+      " cashbox_name: #{@cashbox_name}, environment: #{@environment}, operation: #{@operation},"\
+      " portal_receipt_url: #{@portal_receipt_url}, queue_id: #{@queue_id}, queue_item_id:"\
+      " #{@queue_item_id}, queue_row: #{@queue_row}, receipt_id: #{@receipt_id}, receipt_moment:"\
+      " #{@receipt_moment}, signature_items: #{@signature_items}, state: #{@state}, state_data:"\
+      " #{@state_data}, terminal_id: #{@terminal_id}, vat_number: #{@vat_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ape_identifier: #{@ape_identifier.inspect}, cashbox_id:"\
+      " #{@cashbox_id.inspect}, cashbox_name: #{@cashbox_name.inspect}, environment:"\
+      " #{@environment.inspect}, operation: #{@operation.inspect}, portal_receipt_url:"\
+      " #{@portal_receipt_url.inspect}, queue_id: #{@queue_id.inspect}, queue_item_id:"\
+      " #{@queue_item_id.inspect}, queue_row: #{@queue_row.inspect}, receipt_id:"\
+      " #{@receipt_id.inspect}, receipt_moment: #{@receipt_moment.inspect}, signature_items:"\
+      " #{@signature_items.inspect}, state: #{@state.inspect}, state_data: #{@state_data.inspect},"\
+      " terminal_id: #{@terminal_id.inspect}, vat_number: #{@vat_number.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/signature_ie_v1_dto.rb

@@ -0,0 +1,165 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SignatureIeV1Dto Model.
+  class SignatureIeV1Dto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Company Registration Number (CRO) number issued by the CRO
+    # (https://cro.ie).
+    # @return [String]
+    attr_accessor :company_number
+
+    # Locally generated signature, part of the chain maintained in the
+    # e-journal.
+    # @return [String]
+    attr_accessor :digital_signature
+
+    # Digital signature in the QR code form.
+    # @return [String]
+    attr_accessor :digital_signature_qr_code
+
+    # Digital signature in the QR code form.
+    # @return [FiscalEnvironmentEnum]
+    attr_accessor :environment
+
+    # The ES256 key version.
+    # @return [String]
+    attr_accessor :key_version
+
+    # The ES256 key version.
+    # @return [SignatureVersionIeEnum]
+    attr_accessor :signature_version
+
+    # The VAT identification number of the legal entity.
+    # @return [String]
+    attr_accessor :vat_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['company_number'] = 'company_number'
+      @_hash['digital_signature'] = 'digital_signature'
+      @_hash['digital_signature_qr_code'] = 'digital_signature_qr_code'
+      @_hash['environment'] = 'environment'
+      @_hash['key_version'] = 'key_version'
+      @_hash['signature_version'] = 'signature_version'
+      @_hash['vat_number'] = 'vat_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(company_number = nil, digital_signature = nil,
+                   digital_signature_qr_code = nil, environment = nil,
+                   key_version = nil, signature_version = nil, vat_number = nil)
+      @company_number = company_number
+      @digital_signature = digital_signature
+      @digital_signature_qr_code = digital_signature_qr_code
+      @environment = environment
+      @key_version = key_version
+      @signature_version = signature_version
+      @vat_number = vat_number
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      company_number =
+        hash.key?('company_number') ? hash['company_number'] : nil
+      digital_signature =
+        hash.key?('digital_signature') ? hash['digital_signature'] : nil
+      digital_signature_qr_code =
+        hash.key?('digital_signature_qr_code') ? hash['digital_signature_qr_code'] : nil
+      environment = hash.key?('environment') ? hash['environment'] : nil
+      key_version = hash.key?('key_version') ? hash['key_version'] : nil
+      signature_version =
+        hash.key?('signature_version') ? hash['signature_version'] : nil
+      vat_number = hash.key?('vat_number') ? hash['vat_number'] : nil
+
+      # Create object from extracted values.
+      SignatureIeV1Dto.new(company_number,
+                           digital_signature,
+                           digital_signature_qr_code,
+                           environment,
+                           key_version,
+                           signature_version,
+                           vat_number)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SignatureIeV1Dto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.company_number,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.digital_signature,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.digital_signature_qr_code,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.environment,
+                                  ->(val) { FiscalEnvironmentEnum.validate(val) }) and
+            APIHelper.valid_type?(value.key_version,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.signature_version,
+                                  ->(val) { SignatureVersionIeEnum.validate(val) }) and
+            APIHelper.valid_type?(value.vat_number,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['company_number'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['digital_signature'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['digital_signature_qr_code'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['environment'],
+                                ->(val) { FiscalEnvironmentEnum.validate(val) }) and
+          APIHelper.valid_type?(value['key_version'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['signature_version'],
+                                ->(val) { SignatureVersionIeEnum.validate(val) }) and
+          APIHelper.valid_type?(value['vat_number'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} company_number: #{@company_number}, digital_signature:"\
+      " #{@digital_signature}, digital_signature_qr_code: #{@digital_signature_qr_code},"\
+      " environment: #{@environment}, key_version: #{@key_version}, signature_version:"\
+      " #{@signature_version}, vat_number: #{@vat_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} company_number: #{@company_number.inspect}, digital_signature:"\
+      " #{@digital_signature.inspect}, digital_signature_qr_code:"\
+      " #{@digital_signature_qr_code.inspect}, environment: #{@environment.inspect}, key_version:"\
+      " #{@key_version.inspect}, signature_version: #{@signature_version.inspect}, vat_number:"\
+      " #{@vat_number.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/signature_in_v1_dto.rb

@@ -0,0 +1,105 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SignatureInV1Dto Model.
+  class SignatureInV1Dto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [FiscalEnvironmentEnum]
+    attr_accessor :environment
+
+    # Receipt Number.
+    # @return [String]
+    attr_accessor :receipt_number
+
+    # The name of the sequencing series used to generate the receipt number.
+    # @return [String]
+    attr_accessor :series_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['environment'] = 'environment'
+      @_hash['receipt_number'] = 'receipt_number'
+      @_hash['series_name'] = 'series_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(environment = nil, receipt_number = nil, series_name = nil)
+      @environment = environment
+      @receipt_number = receipt_number
+      @series_name = series_name
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      environment = hash.key?('environment') ? hash['environment'] : nil
+      receipt_number =
+        hash.key?('receipt_number') ? hash['receipt_number'] : nil
+      series_name = hash.key?('series_name') ? hash['series_name'] : nil
+
+      # Create object from extracted values.
+      SignatureInV1Dto.new(environment,
+                           receipt_number,
+                           series_name)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SignatureInV1Dto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.environment,
+                                ->(val) { FiscalEnvironmentEnum.validate(val) }) and
+            APIHelper.valid_type?(value.receipt_number,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.series_name,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['environment'],
+                              ->(val) { FiscalEnvironmentEnum.validate(val) }) and
+          APIHelper.valid_type?(value['receipt_number'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['series_name'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} environment: #{@environment}, receipt_number: #{@receipt_number},"\
+      " series_name: #{@series_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} environment: #{@environment.inspect}, receipt_number:"\
+      " #{@receipt_number.inspect}, series_name: #{@series_name.inspect}>"
+    end
+  end
+end