newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/cash_payment.rb

@@ -0,0 +1,179 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # A cash payment.
+  class CashPayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Payment amount, in the currency's minor unit. The instruments' amounts
+    # must add up to the order total: the sum of each line item's `price` —
+    # already net of its discounts — plus its `price_tax` under `TAX_EXCLUDED`
+    # pricing, plus any fulfillment charges.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # Billing address for this payment instrument. Optional. When supplied on
+    # more than one instrument, all must be identical (the platform currently
+    # supports a single billing address per order).
+    # @return [Address1]
+    attr_accessor :billing_address
+
+    # Cash-specific details.
+    # @return [CashDetails]
+    attr_accessor :cash
+
+    # The currency of the payment.
+    # @return [Currency1Enum]
+    attr_accessor :currency
+
+    # The payment method.
+    # @return [String]
+    attr_reader :payment_method
+
+    # The payment provider for a cash payment; always `cash`.
+    # @return [String]
+    attr_reader :payment_provider
+
+    # When the payment was processed, as an RFC 3339 (ISO 8601) date-time
+    # including date, time and timezone.
+    # @return [DateTime]
+    attr_accessor :processed_at
+
+    # Whether the payment is already authorized or already captured.
+    # @return [PaymentStatusEnum]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['cash'] = 'cash'
+      @_hash['currency'] = 'currency'
+      @_hash['payment_method'] = 'payment_method'
+      @_hash['payment_provider'] = 'payment_provider'
+      @_hash['processed_at'] = 'processed_at'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        billing_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        billing_address
+      ]
+    end
+
+    def initialize(amount = nil, cash = nil, currency = nil, processed_at = nil,
+                   status = nil, billing_address = SKIP)
+      @amount = amount
+      @billing_address = billing_address unless billing_address == SKIP
+      @cash = cash
+      @currency = currency
+      @payment_method = 'cash'
+      @payment_provider = 'cash'
+      @processed_at = processed_at
+      @status = status
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      cash = CashDetails.from_hash(hash['cash']) if hash['cash']
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      processed_at = if hash.key?('processed_at')
+                       (DateTimeHelper.from_rfc3339(hash['processed_at']) if hash['processed_at'])
+                     end
+      status = hash.key?('status') ? hash['status'] : nil
+      billing_address = Address1.from_hash(hash['billing_address']) if hash['billing_address']
+
+      # Create object from extracted values.
+      CashPayment.new(amount,
+                      cash,
+                      currency,
+                      processed_at,
+                      status,
+                      billing_address)
+    end
+
+    def to_custom_processed_at
+      DateTimeHelper.to_rfc3339(processed_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CashPayment | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.amount,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.cash,
+                                  ->(val) { CashDetails.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { Currency1Enum.validate(val) }) and
+            APIHelper.valid_type?(value.payment_method,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.payment_provider,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.processed_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.status,
+                                  ->(val) { PaymentStatusEnum.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['amount'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['cash'],
+                                ->(val) { CashDetails.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(val) { Currency1Enum.validate(val) }) and
+          APIHelper.valid_type?(value['payment_method'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['payment_provider'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['processed_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['status'],
+                                ->(val) { PaymentStatusEnum.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, billing_address: #{@billing_address}, cash: #{@cash},"\
+      " currency: #{@currency}, payment_method: #{@payment_method}, payment_provider:"\
+      " #{@payment_provider}, processed_at: #{@processed_at}, status: #{@status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, billing_address: #{@billing_address.inspect},"\
+      " cash: #{@cash.inspect}, currency: #{@currency.inspect}, payment_method:"\
+      " #{@payment_method.inspect}, payment_provider: #{@payment_provider.inspect}, processed_at:"\
+      " #{@processed_at.inspect}, status: #{@status.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/cashbox_config_axena_se_v1_dto.rb

@@ -0,0 +1,283 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CashboxConfigAxenaSeV1Dto Model.
+  class CashboxConfigAxenaSeV1Dto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address of the store.
+    # @return [String]
+    attr_accessor :address
+
+    # Axena (Srv4pos) activation data.
+    # * Can be optionally set during fiscal activations by providing a
+    # previously registered activation.
+    # * If a value is not provided during an activation, a new Cash Registry
+    # will be registered in Axena (Srv4pos) by using the `/activations-advanced`
+    # endpoint.
+    # @return [AxenaActivationDataV1Dto]
+    attr_accessor :axena_activation_data
+
+    # Cash Register name to be used with the Axena (Srv4pos) API.
+    # * The name is generated by getting the short SHA256 hash of the cashbox
+    # identifier and appending an environment prefix.
+    # * Ref: https://dev.srv4pos.com/site/rest.html#cashRegisterNameType
+    # @return [String]
+    attr_accessor :cash_register_name
+
+    # City where the store is located.
+    # @return [String]
+    attr_accessor :city
+
+    # Control unit address.
+    # * Can be optionally set during fiscal activations by providing a the
+    # control unit address retrieved from Axena (Srv4pos).
+    # * If a value is not provided during an activation, the default control
+    # unit information will be used.
+    # @return [String]
+    attr_accessor :control_unit_address
+
+    # Control unit journal address.
+    # * Can be optionally set during fiscal activations by providing a the
+    # control unit journal address retrieved from Axena (Srv4pos).
+    # * If a value is not provided during an activation, the default control
+    # unit information will be used.
+    # @return [String]
+    attr_accessor :control_unit_journal_address
+
+    # Control unit manufacturer.
+    # * Can be optionally set during fiscal activations by providing a the
+    # control unit manufacturer retrieved from Axena (Srv4pos).
+    # * If a value is not provided during an activation, the default control
+    # unit information will be used.
+    # @return [String]
+    attr_accessor :control_unit_manufacturer
+
+    # Control unit model.
+    # * Can be optionally set during fiscal activations by providing a the
+    # control unit model retrieved from Axena (Srv4pos).
+    # * If a value is not provided during an activation, the default control
+    # unit information will be used.
+    # @return [String]
+    attr_accessor :control_unit_model
+
+    # Control unit serial number.
+    # * Can be optionally set during fiscal activations by providing a the
+    # control unit serial number retrieved from Axena (Srv4pos).
+    # * If a value is not provided during an activation, the default control
+    # unit serial number will be used.
+    # @return [String]
+    attr_accessor :control_unit_serial
+
+    # Control unit type.
+    # * Can be optionally set during fiscal activations by providing a the
+    # control unit type retrieved from Axena (Srv4pos).
+    # * If a value is not provided during an activation, the default control
+    # unit information will be used.
+    # @return [String]
+    attr_accessor :control_unit_type
+
+    # Corporate identifier that represents particular tenant/merchant in Axena
+    # (Srv4pos).
+    # @return [String]
+    attr_accessor :corporate_id
+
+    # Flag for enabling late signing mode.
+    # * When enabled:
+    #   * Transactions will be allowed when Axena (Srv4pos) is not reachable.
+    #   * Receipt printing will be blocked until the transaction is proceesed by
+    # Axena (Srv4pos).
+    # * When not enabled:
+    #   * Transaction processing will be blocked when Axena (Srv4pos) is not
+    # reachable.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :late_signing_enabled
+
+    # Legal entity name of the tenant in Sweden.
+    # @return [String]
+    attr_accessor :legal_entity
+
+    # Postal code of the store.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'address'
+      @_hash['axena_activation_data'] = 'axena_activation_data'
+      @_hash['cash_register_name'] = 'cash_register_name'
+      @_hash['city'] = 'city'
+      @_hash['control_unit_address'] = 'control_unit_address'
+      @_hash['control_unit_journal_address'] = 'control_unit_journal_address'
+      @_hash['control_unit_manufacturer'] = 'control_unit_manufacturer'
+      @_hash['control_unit_model'] = 'control_unit_model'
+      @_hash['control_unit_serial'] = 'control_unit_serial'
+      @_hash['control_unit_type'] = 'control_unit_type'
+      @_hash['corporate_id'] = 'corporate_id'
+      @_hash['late_signing_enabled'] = 'late_signing_enabled'
+      @_hash['legal_entity'] = 'legal_entity'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        axena_activation_data
+        cash_register_name
+        control_unit_address
+        control_unit_journal_address
+        control_unit_manufacturer
+        control_unit_model
+        control_unit_serial
+        control_unit_type
+        late_signing_enabled
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address = nil, city = nil, corporate_id = nil,
+                   legal_entity = nil, postal_code = nil,
+                   axena_activation_data = SKIP, cash_register_name = SKIP,
+                   control_unit_address = SKIP,
+                   control_unit_journal_address = SKIP,
+                   control_unit_manufacturer = SKIP, control_unit_model = SKIP,
+                   control_unit_serial = SKIP, control_unit_type = SKIP,
+                   late_signing_enabled = false)
+      @address = address
+      @axena_activation_data = axena_activation_data unless axena_activation_data == SKIP
+      @cash_register_name = cash_register_name unless cash_register_name == SKIP
+      @city = city
+      @control_unit_address = control_unit_address unless control_unit_address == SKIP
+      unless control_unit_journal_address == SKIP
+        @control_unit_journal_address =
+          control_unit_journal_address
+      end
+      unless control_unit_manufacturer == SKIP
+        @control_unit_manufacturer =
+          control_unit_manufacturer
+      end
+      @control_unit_model = control_unit_model unless control_unit_model == SKIP
+      @control_unit_serial = control_unit_serial unless control_unit_serial == SKIP
+      @control_unit_type = control_unit_type unless control_unit_type == SKIP
+      @corporate_id = corporate_id
+      @late_signing_enabled = late_signing_enabled unless late_signing_enabled == SKIP
+      @legal_entity = legal_entity
+      @postal_code = postal_code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      address = hash.key?('address') ? hash['address'] : nil
+      city = hash.key?('city') ? hash['city'] : nil
+      corporate_id = hash.key?('corporate_id') ? hash['corporate_id'] : nil
+      legal_entity = hash.key?('legal_entity') ? hash['legal_entity'] : nil
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : nil
+      axena_activation_data = AxenaActivationDataV1Dto.from_hash(hash['axena_activation_data']) if
+        hash['axena_activation_data']
+      cash_register_name =
+        hash.key?('cash_register_name') ? hash['cash_register_name'] : SKIP
+      control_unit_address =
+        hash.key?('control_unit_address') ? hash['control_unit_address'] : SKIP
+      control_unit_journal_address =
+        hash.key?('control_unit_journal_address') ? hash['control_unit_journal_address'] : SKIP
+      control_unit_manufacturer =
+        hash.key?('control_unit_manufacturer') ? hash['control_unit_manufacturer'] : SKIP
+      control_unit_model =
+        hash.key?('control_unit_model') ? hash['control_unit_model'] : SKIP
+      control_unit_serial =
+        hash.key?('control_unit_serial') ? hash['control_unit_serial'] : SKIP
+      control_unit_type =
+        hash.key?('control_unit_type') ? hash['control_unit_type'] : SKIP
+      late_signing_enabled = hash['late_signing_enabled'] ||= false
+
+      # Create object from extracted values.
+      CashboxConfigAxenaSeV1Dto.new(address,
+                                    city,
+                                    corporate_id,
+                                    legal_entity,
+                                    postal_code,
+                                    axena_activation_data,
+                                    cash_register_name,
+                                    control_unit_address,
+                                    control_unit_journal_address,
+                                    control_unit_manufacturer,
+                                    control_unit_model,
+                                    control_unit_serial,
+                                    control_unit_type,
+                                    late_signing_enabled)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CashboxConfigAxenaSeV1Dto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.address,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.city,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.corporate_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.legal_entity,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.postal_code,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['address'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['city'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['corporate_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['legal_entity'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['postal_code'],
+                                ->(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} address: #{@address}, axena_activation_data: #{@axena_activation_data},"\
+      " cash_register_name: #{@cash_register_name}, city: #{@city}, control_unit_address:"\
+      " #{@control_unit_address}, control_unit_journal_address: #{@control_unit_journal_address},"\
+      " control_unit_manufacturer: #{@control_unit_manufacturer}, control_unit_model:"\
+      " #{@control_unit_model}, control_unit_serial: #{@control_unit_serial}, control_unit_type:"\
+      " #{@control_unit_type}, corporate_id: #{@corporate_id}, late_signing_enabled:"\
+      " #{@late_signing_enabled}, legal_entity: #{@legal_entity}, postal_code: #{@postal_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address.inspect}, axena_activation_data:"\
+      " #{@axena_activation_data.inspect}, cash_register_name: #{@cash_register_name.inspect},"\
+      " city: #{@city.inspect}, control_unit_address: #{@control_unit_address.inspect},"\
+      " control_unit_journal_address: #{@control_unit_journal_address.inspect},"\
+      " control_unit_manufacturer: #{@control_unit_manufacturer.inspect}, control_unit_model:"\
+      " #{@control_unit_model.inspect}, control_unit_serial: #{@control_unit_serial.inspect},"\
+      " control_unit_type: #{@control_unit_type.inspect}, corporate_id: #{@corporate_id.inspect},"\
+      " late_signing_enabled: #{@late_signing_enabled.inspect}, legal_entity:"\
+      " #{@legal_entity.inspect}, postal_code: #{@postal_code.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/cashbox_config_efsta_pt_v1_dto.rb

@@ -0,0 +1,131 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CashboxConfigEfstaPtV1Dto Model.
+  class CashboxConfigEfstaPtV1Dto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address of the store, will be used in SAF-T report
+    # @return [String]
+    attr_accessor :address
+
+    # City of the store, will be used in SAF-T report
+    # @return [String]
+    attr_accessor :city
+
+    # Location short name, will be used in SAF-T report
+    # @return [String]
+    attr_accessor :label
+
+    # Unique identifier of the store (EFSTA location ID) that will be used in
+    # receipts. Limited up to 10 characters
+    # @return [String]
+    attr_accessor :location_id
+
+    # Postal Code of the store, will be used in SAF-T report
+    # @return [String]
+    attr_accessor :postal_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'address'
+      @_hash['city'] = 'city'
+      @_hash['label'] = 'label'
+      @_hash['location_id'] = 'location_id'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address = nil, city = nil, label = nil, location_id = nil,
+                   postal_code = nil)
+      @address = address
+      @city = city
+      @label = label
+      @location_id = location_id
+      @postal_code = postal_code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      address = hash.key?('address') ? hash['address'] : nil
+      city = hash.key?('city') ? hash['city'] : nil
+      label = hash.key?('label') ? hash['label'] : nil
+      location_id = hash.key?('location_id') ? hash['location_id'] : nil
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : nil
+
+      # Create object from extracted values.
+      CashboxConfigEfstaPtV1Dto.new(address,
+                                    city,
+                                    label,
+                                    location_id,
+                                    postal_code)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CashboxConfigEfstaPtV1Dto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.address,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.city,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.label,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.location_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.postal_code,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['address'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['city'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['label'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['location_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['postal_code'],
+                                ->(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} address: #{@address}, city: #{@city}, label: #{@label}, location_id:"\
+      " #{@location_id}, postal_code: #{@postal_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address.inspect}, city: #{@city.inspect}, label:"\
+      " #{@label.inspect}, location_id: #{@location_id.inspect}, postal_code:"\
+      " #{@postal_code.inspect}>"
+    end
+  end
+end