newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/signature_pl_v1_dto.rb

@@ -0,0 +1,101 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SignaturePlV1Dto Model.
+  class SignaturePlV1Dto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Commands and their responses.
+    # @return [Array[PosnetOnlineCommandLogV1Dto]]
+    attr_accessor :commands
+
+    # Counters after the transaction execution.
+    # @return [PosnetOnlineCountersV1Dto]
+    attr_accessor :counters
+
+    # Unique serial number of the printer that executed the transaction.
+    # @return [String]
+    attr_accessor :serial_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['commands'] = 'commands'
+      @_hash['counters'] = 'counters'
+      @_hash['serial_number'] = 'serial_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        commands
+        counters
+        serial_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(commands = SKIP, counters = SKIP, serial_number = SKIP)
+      @commands = commands unless commands == SKIP
+      @counters = counters unless counters == SKIP
+      @serial_number = serial_number unless serial_number == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      commands = nil
+      unless hash['commands'].nil?
+        commands = []
+        hash['commands'].each do |structure|
+          commands << (PosnetOnlineCommandLogV1Dto.from_hash(structure) if structure)
+        end
+      end
+
+      commands = SKIP unless hash.key?('commands')
+      counters = PosnetOnlineCountersV1Dto.from_hash(hash['counters']) if hash['counters']
+      serial_number = hash.key?('serial_number') ? hash['serial_number'] : SKIP
+
+      # Create object from extracted values.
+      SignaturePlV1Dto.new(commands,
+                           counters,
+                           serial_number)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SignaturePlV1Dto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} commands: #{@commands}, counters: #{@counters}, serial_number:"\
+      " #{@serial_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} commands: #{@commands.inspect}, counters: #{@counters.inspect},"\
+      " serial_number: #{@serial_number.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/signature_pr_v1_dto.rb

@@ -0,0 +1,161 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SignaturePrV1Dto Model.
+  class SignaturePrV1Dto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Control number recieved from YCS.
+    # @return [String]
+    attr_accessor :control_number
+
+    # Control number recieved from YCS.
+    # @return [FiscalEnvironmentEnum]
+    attr_accessor :environment
+
+    # YCS POS Identifier.
+    # @return [Integer]
+    attr_accessor :pos_id
+
+    # The processor of the transaction.
+    # @return [String]
+    attr_accessor :processor
+
+    # Footer message of the processor.
+    # @return [String]
+    attr_accessor :processor_message
+
+    # Flag that states whether transaction requires signing through YCS.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :signing_required
+
+    # Identifier of the transaction.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['control_number'] = 'control_number'
+      @_hash['environment'] = 'environment'
+      @_hash['pos_id'] = 'pos_id'
+      @_hash['processor'] = 'processor'
+      @_hash['processor_message'] = 'processor_message'
+      @_hash['signing_required'] = 'signing_required'
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(control_number = nil, environment = nil, pos_id = nil,
+                   processor = nil, processor_message = nil,
+                   signing_required = nil, transaction_id = nil)
+      @control_number = control_number
+      @environment = environment
+      @pos_id = pos_id
+      @processor = processor
+      @processor_message = processor_message
+      @signing_required = signing_required
+      @transaction_id = transaction_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      control_number =
+        hash.key?('control_number') ? hash['control_number'] : nil
+      environment = hash.key?('environment') ? hash['environment'] : nil
+      pos_id = hash.key?('pos_id') ? hash['pos_id'] : nil
+      processor = hash.key?('processor') ? hash['processor'] : nil
+      processor_message =
+        hash.key?('processor_message') ? hash['processor_message'] : nil
+      signing_required =
+        hash.key?('signing_required') ? hash['signing_required'] : nil
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : nil
+
+      # Create object from extracted values.
+      SignaturePrV1Dto.new(control_number,
+                           environment,
+                           pos_id,
+                           processor,
+                           processor_message,
+                           signing_required,
+                           transaction_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SignaturePrV1Dto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.control_number,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.environment,
+                                  ->(val) { FiscalEnvironmentEnum.validate(val) }) and
+            APIHelper.valid_type?(value.pos_id,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.processor,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.processor_message,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.signing_required,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+            APIHelper.valid_type?(value.transaction_id,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['control_number'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['environment'],
+                                ->(val) { FiscalEnvironmentEnum.validate(val) }) and
+          APIHelper.valid_type?(value['pos_id'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['processor'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['processor_message'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['signing_required'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+          APIHelper.valid_type?(value['transaction_id'],
+                                ->(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} control_number: #{@control_number}, environment: #{@environment}, pos_id:"\
+      " #{@pos_id}, processor: #{@processor}, processor_message: #{@processor_message},"\
+      " signing_required: #{@signing_required}, transaction_id: #{@transaction_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} control_number: #{@control_number.inspect}, environment:"\
+      " #{@environment.inspect}, pos_id: #{@pos_id.inspect}, processor: #{@processor.inspect},"\
+      " processor_message: #{@processor_message.inspect}, signing_required:"\
+      " #{@signing_required.inspect}, transaction_id: #{@transaction_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/signature_pt_v1_dto.rb

@@ -0,0 +1,129 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SignaturePtV1Dto Model.
+  class SignaturePtV1Dto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Fiscalization date.
+    # @return [String]
+    attr_accessor :date
+
+    # Fiscalization data.
+    # @return [Object]
+    attr_accessor :fiscal_data
+
+    # The store location ID in EFSTA.
+    # @return [String]
+    attr_accessor :location_id
+
+    # A base64-encoded string representing the receipt data.
+    # @return [String]
+    attr_accessor :receipt_data
+
+    # Receipt number.
+    # @return [String]
+    attr_accessor :receipt_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['date'] = 'date'
+      @_hash['fiscal_data'] = 'fiscal_data'
+      @_hash['location_id'] = 'location_id'
+      @_hash['receipt_data'] = 'receipt_data'
+      @_hash['receipt_number'] = 'receipt_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        receipt_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(date = nil, fiscal_data = nil, location_id = nil,
+                   receipt_number = nil, receipt_data = SKIP)
+      @date = date
+      @fiscal_data = fiscal_data
+      @location_id = location_id
+      @receipt_data = receipt_data unless receipt_data == SKIP
+      @receipt_number = receipt_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.
+      date = hash.key?('date') ? hash['date'] : nil
+      fiscal_data = hash.key?('fiscal_data') ? hash['fiscal_data'] : nil
+      location_id = hash.key?('location_id') ? hash['location_id'] : nil
+      receipt_number =
+        hash.key?('receipt_number') ? hash['receipt_number'] : nil
+      receipt_data = hash.key?('receipt_data') ? hash['receipt_data'] : SKIP
+
+      # Create object from extracted values.
+      SignaturePtV1Dto.new(date,
+                           fiscal_data,
+                           location_id,
+                           receipt_number,
+                           receipt_data)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SignaturePtV1Dto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.date,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.fiscal_data,
+                                  ->(val) { val.instance_of? Object }) and
+            APIHelper.valid_type?(value.location_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.receipt_number,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['date'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['fiscal_data'],
+                                ->(val) { val.instance_of? Object }) and
+          APIHelper.valid_type?(value['location_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['receipt_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} date: #{@date}, fiscal_data: #{@fiscal_data}, location_id: #{@location_id},"\
+      " receipt_data: #{@receipt_data}, receipt_number: #{@receipt_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} date: #{@date.inspect}, fiscal_data: #{@fiscal_data.inspect}, location_id:"\
+      " #{@location_id.inspect}, receipt_data: #{@receipt_data.inspect}, receipt_number:"\
+      " #{@receipt_number.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/signature_response_v1_dto.rb

@@ -0,0 +1,208 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # SignatureResponseV1Dto Model.
+  class SignatureResponseV1Dto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Context.
+    # @return [ContextV1Dto]
+    attr_accessor :context
+
+    # Context.
+    # @return [String]
+    attr_accessor :country_code
+
+    # Signature creation timestamp to be used on the receipt.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Sales order identifier used in external system.
+    # @return [String]
+    attr_accessor :external_order_id
+
+    # Sales order identifier used in external system.
+    # @return [FiscalModeEnum]
+    attr_accessor :fiscal_mode
+
+    # ID (idempotency key).
+    # @return [String]
+    attr_accessor :id
+
+    # Transaction creation timestamp.
+    # * If set, will override the fiscal transaction timestamp.
+    # @return [String]
+    attr_accessor :original_created_at
+
+    # ID of a reference order (e.g. referencing an original order).
+    # @return [String]
+    attr_accessor :reference_order_id
+
+    # ID of a reference order (e.g. referencing an original order).
+    # @return [TransactionSignatureStrategyEnum]
+    attr_accessor :signature_strategy_override
+
+    # ID of a reference order (e.g. referencing an original order).
+    # @return [OrderManagementStateEnum]
+    attr_accessor :state
+
+    # ID of a reference order (e.g. referencing an original order).
+    # @return [F11nTaxMethodEnum]
+    attr_accessor :tax_method
+
+    # ID of a reference order (e.g. referencing an original order).
+    # @return [Array[TransactionMinV1Dto]]
+    attr_accessor :transactions
+
+    # Signature update timestamp.
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['context'] = 'context'
+      @_hash['country_code'] = 'country_code'
+      @_hash['created_at'] = 'created_at'
+      @_hash['external_order_id'] = 'external_order_id'
+      @_hash['fiscal_mode'] = 'fiscal_mode'
+      @_hash['id'] = 'id'
+      @_hash['original_created_at'] = 'original_created_at'
+      @_hash['reference_order_id'] = 'reference_order_id'
+      @_hash['signature_strategy_override'] = 'signature_strategy_override'
+      @_hash['state'] = 'state'
+      @_hash['tax_method'] = 'tax_method'
+      @_hash['transactions'] = 'transactions'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_order_id
+        fiscal_mode
+        original_created_at
+        reference_order_id
+        signature_strategy_override
+        tax_method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(context = nil, country_code = nil, created_at = nil,
+                   id = nil, state = nil, transactions = nil, updated_at = nil,
+                   external_order_id = SKIP, fiscal_mode = SKIP,
+                   original_created_at = SKIP, reference_order_id = SKIP,
+                   signature_strategy_override = SKIP, tax_method = SKIP)
+      @context = context
+      @country_code = country_code
+      @created_at = created_at
+      @external_order_id = external_order_id unless external_order_id == SKIP
+      @fiscal_mode = fiscal_mode unless fiscal_mode == SKIP
+      @id = id
+      @original_created_at = original_created_at unless original_created_at == SKIP
+      @reference_order_id = reference_order_id unless reference_order_id == SKIP
+      unless signature_strategy_override == SKIP
+        @signature_strategy_override =
+          signature_strategy_override
+      end
+      @state = state
+      @tax_method = tax_method unless tax_method == SKIP
+      @transactions = transactions
+      @updated_at = updated_at
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      context = ContextV1Dto.from_hash(hash['context']) if hash['context']
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      id = hash.key?('id') ? hash['id'] : nil
+      state = hash.key?('state') ? hash['state'] : nil
+      # Parameter is an array, so we need to iterate through it
+      transactions = nil
+      unless hash['transactions'].nil?
+        transactions = []
+        hash['transactions'].each do |structure|
+          transactions << (TransactionMinV1Dto.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = nil unless hash.key?('transactions')
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   end
+      external_order_id =
+        hash.key?('external_order_id') ? hash['external_order_id'] : SKIP
+      fiscal_mode = hash.key?('fiscal_mode') ? hash['fiscal_mode'] : SKIP
+      original_created_at =
+        hash.key?('original_created_at') ? hash['original_created_at'] : SKIP
+      reference_order_id =
+        hash.key?('reference_order_id') ? hash['reference_order_id'] : SKIP
+      signature_strategy_override =
+        hash.key?('signature_strategy_override') ? hash['signature_strategy_override'] : SKIP
+      tax_method = hash.key?('tax_method') ? hash['tax_method'] : SKIP
+
+      # Create object from extracted values.
+      SignatureResponseV1Dto.new(context,
+                                 country_code,
+                                 created_at,
+                                 id,
+                                 state,
+                                 transactions,
+                                 updated_at,
+                                 external_order_id,
+                                 fiscal_mode,
+                                 original_created_at,
+                                 reference_order_id,
+                                 signature_strategy_override,
+                                 tax_method)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} context: #{@context}, country_code: #{@country_code}, created_at:"\
+      " #{@created_at}, external_order_id: #{@external_order_id}, fiscal_mode: #{@fiscal_mode},"\
+      " id: #{@id}, original_created_at: #{@original_created_at}, reference_order_id:"\
+      " #{@reference_order_id}, signature_strategy_override: #{@signature_strategy_override},"\
+      " state: #{@state}, tax_method: #{@tax_method}, transactions: #{@transactions}, updated_at:"\
+      " #{@updated_at}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} context: #{@context.inspect}, country_code: #{@country_code.inspect},"\
+      " created_at: #{@created_at.inspect}, external_order_id: #{@external_order_id.inspect},"\
+      " fiscal_mode: #{@fiscal_mode.inspect}, id: #{@id.inspect}, original_created_at:"\
+      " #{@original_created_at.inspect}, reference_order_id: #{@reference_order_id.inspect},"\
+      " signature_strategy_override: #{@signature_strategy_override.inspect}, state:"\
+      " #{@state.inspect}, tax_method: #{@tax_method.inspect}, transactions:"\
+      " #{@transactions.inspect}, updated_at: #{@updated_at.inspect}>"
+    end
+  end
+end