newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/transaction_min_v1_dto.rb

@@ -0,0 +1,170 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # TransactionMinV1Dto Model.
+  class TransactionMinV1Dto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :country_code
+
+    # Transaction ID.
+    # @return [String]
+    attr_accessor :id
+
+    # Transaction signature.
+    # @return [Object]
+    attr_accessor :signature
+
+    # Transaction signature.
+    # @return [TransactionStateEnum]
+    attr_accessor :state
+
+    # Temporary transaction signature.
+    # @return [Object]
+    attr_accessor :temporary_signature
+
+    # Sequential transaction number.
+    # @return [Integer]
+    attr_accessor :transaction_number
+
+    # Transaction series (if defined).
+    # @return [String]
+    attr_accessor :transaction_series
+
+    # Transaction series (if defined).
+    # @return [F11nTransactionTypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country_code'] = 'country_code'
+      @_hash['id'] = 'id'
+      @_hash['signature'] = 'signature'
+      @_hash['state'] = 'state'
+      @_hash['temporary_signature'] = 'temporary_signature'
+      @_hash['transaction_number'] = 'transaction_number'
+      @_hash['transaction_series'] = 'transaction_series'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        signature
+        transaction_series
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country_code = nil, id = nil, state = nil,
+                   temporary_signature = nil, transaction_number = nil,
+                   type = nil, signature = SKIP, transaction_series = SKIP)
+      @country_code = country_code
+      @id = id
+      @signature = signature unless signature == SKIP
+      @state = state
+      @temporary_signature = temporary_signature
+      @transaction_number = transaction_number
+      @transaction_series = transaction_series unless transaction_series == SKIP
+      @type = type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      state = hash.key?('state') ? hash['state'] : nil
+      temporary_signature = hash.key?('temporary_signature') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:TransactionMinV1DtoTemporarySignature), hash['temporary_signature']
+      ) : nil
+      transaction_number =
+        hash.key?('transaction_number') ? hash['transaction_number'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      signature = hash.key?('signature') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:TransactionMinV1DtoSignature), hash['signature']
+      ) : SKIP
+      transaction_series =
+        hash.key?('transaction_series') ? hash['transaction_series'] : SKIP
+
+      # Create object from extracted values.
+      TransactionMinV1Dto.new(country_code,
+                              id,
+                              state,
+                              temporary_signature,
+                              transaction_number,
+                              type,
+                              signature,
+                              transaction_series)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TransactionMinV1Dto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.country_code,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.state,
+                                  ->(val) { TransactionStateEnum.validate(val) }) and
+            UnionTypeLookUp.get(:TransactionMinV1DtoTemporarySignature)
+                           .validate(value.temporary_signature) and
+            APIHelper.valid_type?(value.transaction_number,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.type,
+                                  ->(val) { F11nTransactionTypeEnum.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['country_code'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['state'],
+                                ->(val) { TransactionStateEnum.validate(val) }) and
+          UnionTypeLookUp.get(:TransactionMinV1DtoTemporarySignature)
+                         .validate(value['temporary_signature']) and
+          APIHelper.valid_type?(value['transaction_number'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['type'],
+                                ->(val) { F11nTransactionTypeEnum.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country_code: #{@country_code}, id: #{@id}, signature: #{@signature},"\
+      " state: #{@state}, temporary_signature: #{@temporary_signature}, transaction_number:"\
+      " #{@transaction_number}, transaction_series: #{@transaction_series}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country_code: #{@country_code.inspect}, id: #{@id.inspect}, signature:"\
+      " #{@signature.inspect}, state: #{@state.inspect}, temporary_signature:"\
+      " #{@temporary_signature.inspect}, transaction_number: #{@transaction_number.inspect},"\
+      " transaction_series: #{@transaction_series.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/transaction_signature_strategy_enum.rb

@@ -0,0 +1,56 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Offline transaction signature strategy that will be used while processing
+  # offline transactions. * `standard-signing`   * Offline orders will be
+  # fiscally signed according to regulations.   * Can be used in cases if the
+  # receipt would be emailed once the offline order is processed. *
+  # `late-signing`   * Offline orders will be signed with late signing flag.   *
+  # Can be used in cases if the receipt would be emailed once the offline order
+  # is processed. * `manual-receipts`   * Offline orders will be signed with
+  # manual flag.   * A receipt for the offline orders and do not need to be
+  # emailed later.   * Can be used in cases if the a manual receipt was issued
+  # by the store, and an electronic receipt should not be sent. * `no-signing`
+  # * Offline orders will not be signed and should be considered completed
+  # without any signature needed.   * Can be used in cases if the fiscal
+  # signature was issued outside of the NewStore platform.
+  class TransactionSignatureStrategyEnum
+    TRANSACTION_SIGNATURE_STRATEGY_ENUM = [
+      # TODO: Write general description for STANDARDSIGNING
+      STANDARDSIGNING = 'standard-signing'.freeze,
+
+      # TODO: Write general description for LATESIGNING
+      LATESIGNING = 'late-signing'.freeze,
+
+      # TODO: Write general description for MANUALRECEIPTS
+      MANUALRECEIPTS = 'manual-receipts'.freeze,
+
+      # TODO: Write general description for NOSIGNING
+      NOSIGNING = 'no-signing'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRANSACTION_SIGNATURE_STRATEGY_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = STANDARDSIGNING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'standardsigning' then STANDARDSIGNING
+      when 'latesigning' then LATESIGNING
+      when 'manualreceipts' then MANUALRECEIPTS
+      when 'nosigning' then NOSIGNING
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/transaction_state_enum.rb

@@ -0,0 +1,40 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Fiscal transaction state.
+  class TransactionStateEnum
+    TRANSACTION_STATE_ENUM = [
+      # TODO: Write general description for OK
+      OK = 'OK'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze,
+
+      # TODO: Write general description for TEMP_SIGNED
+      TEMP_SIGNED = 'TEMP_SIGNED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRANSACTION_STATE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = OK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ok' then OK
+      when 'failed' then FAILED
+      when 'temp_signed' then TEMP_SIGNED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/transaction_tax_rate_dto.rb

@@ -0,0 +1,117 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # TransactionTaxRateDto Model.
+  class TransactionTaxRateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Monetary tax amount for the unit price corresponding to this tax_rate
+    # item's percent value, e.g. 3.37.
+    # @return [Float]
+    attr_accessor :amount
+
+    # Country of jurisdiction for the applied tax.
+    # @return [String]
+    attr_accessor :country_code
+
+    # Tax percent value for this tax rate item, e.g. 0.19 means 19% tax.
+    # @return [Float]
+    attr_accessor :rate
+
+    # Name of the applied tax.
+    # @return [String]
+    attr_accessor :tax_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['country_code'] = 'country_code'
+      @_hash['rate'] = 'rate'
+      @_hash['tax_name'] = 'tax_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, country_code = nil, rate = nil, tax_name = nil)
+      @amount = amount
+      @country_code = country_code
+      @rate = rate
+      @tax_name = tax_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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      rate = hash.key?('rate') ? hash['rate'] : nil
+      tax_name = hash.key?('tax_name') ? hash['tax_name'] : nil
+
+      # Create object from extracted values.
+      TransactionTaxRateDto.new(amount,
+                                country_code,
+                                rate,
+                                tax_name)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TransactionTaxRateDto | 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? Float }) and
+            APIHelper.valid_type?(value.country_code,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.rate,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.tax_name,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['amount'],
+                              ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['country_code'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['rate'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['tax_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} amount: #{@amount}, country_code: #{@country_code}, rate: #{@rate},"\
+      " tax_name: #{@tax_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, country_code: #{@country_code.inspect}, rate:"\
+      " #{@rate.inspect}, tax_name: #{@tax_name.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/transaction_type_enum.rb

@@ -0,0 +1,36 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Type of the transaction.
+  class TransactionTypeEnum
+    TRANSACTION_TYPE_ENUM = [
+      # TODO: Write general description for SALE
+      SALE = 'SALE'.freeze,
+
+      # TODO: Write general description for RETURN
+      RETURN = 'RETURN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRANSACTION_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = SALE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sale' then SALE
+      when 'return' then RETURN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/transaction_update_dto.rb

@@ -0,0 +1,64 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # TransactionUpdateDto Model.
+  class TransactionUpdateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The order ID that will be used as a reference to link the order to the
+    # created tax transaction in the tax provider records.
+    # * In case the order ID is not provided then a randomly generated
+    # identifier will be used instead.
+    # * The tax transaction will be stored by using the given value.
+    # @return [String]
+    attr_accessor :order_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['order_id'] = 'order_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(order_id = nil)
+      @order_id = order_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.
+      order_id = hash.key?('order_id') ? hash['order_id'] : nil
+
+      # Create object from extracted values.
+      TransactionUpdateDto.new(order_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_id: #{@order_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_id: #{@order_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/transfer_document_response.rb

@@ -0,0 +1,71 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # TransferDocumentResponse Model.
+  class TransferDocumentResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :permalink
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error'] = 'error'
+      @_hash['permalink'] = 'permalink'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        error
+        permalink
+      ]
+    end
+
+    def initialize(error = nil, permalink = nil)
+      @error = error
+      @permalink = permalink
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      error = hash.key?('error') ? hash['error'] : nil
+      permalink = hash.key?('permalink') ? hash['permalink'] : nil
+
+      # Create object from extracted values.
+      TransferDocumentResponse.new(error,
+                                   permalink)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, permalink: #{@permalink}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, permalink: #{@permalink.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/transfer_transaction_line_item_response.rb

@@ -0,0 +1,71 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # TransferTransactionLineItemResponse Model.
+  class TransferTransactionLineItemResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :transferred_quantity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_id'] = 'product_id'
+      @_hash['transferred_quantity'] = 'transferred_quantity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_id = nil, transferred_quantity = nil)
+      @product_id = product_id
+      @transferred_quantity = transferred_quantity
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+      transferred_quantity =
+        hash.key?('transferred_quantity') ? hash['transferred_quantity'] : nil
+
+      # Create object from extracted values.
+      TransferTransactionLineItemResponse.new(product_id,
+                                              transferred_quantity)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_id: #{@product_id}, transferred_quantity:"\
+      " #{@transferred_quantity}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_id: #{@product_id.inspect}, transferred_quantity:"\
+      " #{@transferred_quantity.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/type11_enum.rb

@@ -0,0 +1,36 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Type11.
+  class Type11Enum
+    TYPE11_ENUM = [
+      # TODO: Write general description for SHIPPING
+      SHIPPING = 'shipping'.freeze,
+
+      # TODO: Write general description for GIFTWRAPPING
+      GIFTWRAPPING = 'gift-wrapping'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE11_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = SHIPPING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'shipping' then SHIPPING
+      when 'giftwrapping' then GIFTWRAPPING
+      else
+        default_value
+      end
+    end
+  end
+end