newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/signature_se_v1_dto.rb

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

data/lib/new_store_api/models/signature_th_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
+  # SignatureThV1Dto Model.
+  class SignatureThV1Dto < 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.
+      SignatureThV1Dto.new(environment,
+                           receipt_number,
+                           series_name)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SignatureThV1Dto | 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

data/lib/new_store_api/models/signature_version_ie_enum.rb

@@ -0,0 +1,26 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Fiscal signature version.
+  class SignatureVersionIeEnum
+    SIGNATURE_VERSION_IE_ENUM = [
+      # TODO: Write general description for V0
+      V0 = 'V0'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SIGNATURE_VERSION_IE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = V0)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/new_store_api/models/simulation_routed_item.rb

@@ -0,0 +1,80 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Routed line item with the selected location.
+  class SimulationRoutedItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location selected for the line item.
+    # @return [String]
+    attr_accessor :fulfillment_node_id
+
+    # Line item identifier from the request.
+    # @return [String]
+    attr_accessor :line_item_id
+
+    # Product identifier from the request.
+    # @return [String]
+    attr_accessor :product_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fulfillment_node_id'] = 'fulfillment_node_id'
+      @_hash['line_item_id'] = 'line_item_id'
+      @_hash['product_id'] = 'product_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fulfillment_node_id = nil, line_item_id = nil,
+                   product_id = nil)
+      @fulfillment_node_id = fulfillment_node_id
+      @line_item_id = line_item_id
+      @product_id = product_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.
+      fulfillment_node_id =
+        hash.key?('fulfillment_node_id') ? hash['fulfillment_node_id'] : nil
+      line_item_id = hash.key?('line_item_id') ? hash['line_item_id'] : nil
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+
+      # Create object from extracted values.
+      SimulationRoutedItem.new(fulfillment_node_id,
+                               line_item_id,
+                               product_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fulfillment_node_id: #{@fulfillment_node_id}, line_item_id:"\
+      " #{@line_item_id}, product_id: #{@product_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fulfillment_node_id: #{@fulfillment_node_id.inspect}, line_item_id:"\
+      " #{@line_item_id.inspect}, product_id: #{@product_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sort_options_enum.rb

@@ -0,0 +1,44 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SortOptions.
+  class SortOptionsEnum
+    SORT_OPTIONS_ENUM = [
+      # TODO: Write general description for ENUM_CREATED_ATASC
+      ENUM_CREATED_ATASC = 'created_at|asc'.freeze,
+
+      # TODO: Write general description for ENUM_CREATED_ATDESC
+      ENUM_CREATED_ATDESC = 'created_at|desc'.freeze,
+
+      # TODO: Write general description for ENUM_STATUSASC
+      ENUM_STATUSASC = 'status|asc'.freeze,
+
+      # TODO: Write general description for ENUM_STATUSDESC
+      ENUM_STATUSDESC = 'status|desc'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SORT_OPTIONS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_CREATED_ATASC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_created_atasc' then ENUM_CREATED_ATASC
+      when 'enum_created_atdesc' then ENUM_CREATED_ATDESC
+      when 'enum_statusasc' then ENUM_STATUSASC
+      when 'enum_statusdesc' then ENUM_STATUSDESC
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/source_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
+  # Price source
+  class SourceEnum
+    SOURCE_ENUM = [
+      # TODO: Write general description for INTERNAL
+      INTERNAL = 'INTERNAL'.freeze,
+
+      # TODO: Write general description for INTERNAL1
+      INTERNAL1 = 'internal'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SOURCE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = INTERNAL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'internal' then INTERNAL
+      when 'internal1' then INTERNAL1
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/state_enum.rb

@@ -0,0 +1,37 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # New state that should be applied to this item defined by sales order item
+  # UUID.
+  class StateEnum
+    STATE_ENUM = [
+      # TODO: Write general description for SHIPPED
+      SHIPPED = 'shipped'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'rejected'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = SHIPPED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'shipped' then SHIPPED
+      when 'rejected' then REJECTED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/status11_enum.rb

@@ -0,0 +1,50 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Current status of fulfillment request: dispatched - fulfillment request was
+  # sent to sent to store/DC services, but wasn't acknowledged yet; acknowledged
+  # - fulfillment request was acknowledged by store/DC service and will be send
+  # to store/DC for fulfillment; partially_completed - some items of fulfillment
+  # request were already processed (cancelled, rejected, shipped) but not all of
+  # them; completed - all items of fulfillment request were processed
+  # (cancelled, rejected, shipped).
+  class Status11Enum
+    STATUS11_ENUM = [
+      # TODO: Write general description for DISPATCHED
+      DISPATCHED = 'dispatched'.freeze,
+
+      # TODO: Write general description for ACKNOWLEDGED
+      ACKNOWLEDGED = 'acknowledged'.freeze,
+
+      # TODO: Write general description for PARTIALLY_COMPLETED
+      PARTIALLY_COMPLETED = 'partially_completed'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'completed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS11_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = DISPATCHED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'dispatched' then DISPATCHED
+      when 'acknowledged' then ACKNOWLEDGED
+      when 'partially_completed' then PARTIALLY_COMPLETED
+      when 'completed' then COMPLETED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/status1_enum.rb

@@ -0,0 +1,52 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The status of a single item, doesn't reflect the order status
+  class Status1Enum
+    STATUS1_ENUM = [
+      # TODO: Write general description for COMPLETE
+      COMPLETE = 'complete'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for IN_FULFILLMENT
+      IN_FULFILLMENT = 'in_fulfillment'.freeze,
+
+      # TODO: Write general description for CAPTURED
+      CAPTURED = 'captured'.freeze,
+
+      # TODO: Write general description for ON_HOLD
+      ON_HOLD = 'on_hold'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = COMPLETE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'complete' then COMPLETE
+      when 'cancelled' then CANCELLED
+      when 'pending' then PENDING
+      when 'in_fulfillment' then IN_FULFILLMENT
+      when 'captured' then CAPTURED
+      when 'on_hold' then ON_HOLD
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/status21_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
+  # Status21.
+  class Status21Enum
+    STATUS21_ENUM = [
+      # TODO: Write general description for OK
+      OK = 'ok'.freeze,
+
+      # TODO: Write general description for NO_AVAILABILITY
+      NO_AVAILABILITY = 'no_availability'.freeze,
+
+      # TODO: Write general description for DESTINATION_NOT_SERVICED
+      DESTINATION_NOT_SERVICED = 'destination_not_serviced'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS21_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 'no_availability' then NO_AVAILABILITY
+      when 'destination_not_serviced' then DESTINATION_NOT_SERVICED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/status2_enum.rb

@@ -0,0 +1,49 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Status of this item: dispatched - item was routed to a store/DC (check
+  # status of fulfillment request to see whether DC/store service has already
+  # accepted this fulfillment request or not); shipped - item was marked as
+  # shipped; rejected - item was rejected by fulfillment node and going to be
+  # rerouted (or was rerouted if fulfillment request already completed);
+  # cancelled - item was cancelled.
+  class Status2Enum
+    STATUS2_ENUM = [
+      # TODO: Write general description for DISPATCHED
+      DISPATCHED = 'dispatched'.freeze,
+
+      # TODO: Write general description for SHIPPED
+      SHIPPED = 'shipped'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'rejected'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS2_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = DISPATCHED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'dispatched' then DISPATCHED
+      when 'shipped' then SHIPPED
+      when 'rejected' then REJECTED
+      when 'cancelled' then CANCELLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/status_enum.rb

@@ -0,0 +1,44 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The current status of the import.
+  class StatusEnum
+    STATUS_ENUM = [
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'COMPLETED'.freeze,
+
+      # TODO: Write general description for PARTIALLY_COMPLETED
+      PARTIALLY_COMPLETED = 'PARTIALLY_COMPLETED'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'completed' then COMPLETED
+      when 'partially_completed' then PARTIALLY_COMPLETED
+      when 'failed' then FAILED
+      else
+        default_value
+      end
+    end
+  end
+end