newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/external_identifiers1.rb

@@ -0,0 +1,83 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # External product identifiers for this return item.
+  class ExternalIdentifiers1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # External id of the product.
+    # @return [String]
+    attr_accessor :external_item_id
+
+    # Serial number of the product.
+    # @return [String]
+    attr_accessor :serial_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['external_item_id'] = 'external_item_id'
+      @_hash['serial_number'] = 'serial_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_item_id
+        serial_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(external_item_id = SKIP, serial_number = SKIP)
+      @external_item_id = external_item_id unless external_item_id == 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.
+      external_item_id =
+        hash.key?('external_item_id') ? hash['external_item_id'] : SKIP
+      serial_number = hash.key?('serial_number') ? hash['serial_number'] : SKIP
+
+      # Create object from extracted values.
+      ExternalIdentifiers1.new(external_item_id,
+                               serial_number)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ExternalIdentifiers1 | 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} external_item_id: #{@external_item_id}, 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} external_item_id: #{@external_item_id.inspect}, serial_number:"\
+      " #{@serial_number.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/external_token_response.rb

@@ -0,0 +1,63 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ExternalTokenResponse Model.
+  class ExternalTokenResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TS Login token.
+    # @return [String]
+    attr_accessor :external_identity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['external_identity'] = 'external_identity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_identity
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(external_identity = SKIP)
+      @external_identity = external_identity unless external_identity == 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.
+      external_identity =
+        hash.key?('external_identity') ? hash['external_identity'] : SKIP
+
+      # Create object from extracted values.
+      ExternalTokenResponse.new(external_identity)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} external_identity: #{@external_identity}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} external_identity: #{@external_identity.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/f11n_tax_method_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
+  # Defines the tax method used (tax inclusive or exclusive).
+  class F11nTaxMethodEnum
+    F11N_TAX_METHOD_ENUM = [
+      # TODO: Write general description for TAX_INCLUDED
+      TAX_INCLUDED = 'tax_included'.freeze,
+
+      # TODO: Write general description for TAX_EXCLUDED
+      TAX_EXCLUDED = 'tax_excluded'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      F11N_TAX_METHOD_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = TAX_INCLUDED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'tax_included' then TAX_INCLUDED
+      when 'tax_excluded' then TAX_EXCLUDED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/f11n_transaction_type_enum.rb

@@ -0,0 +1,92 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Transaction type.
+  class F11nTransactionTypeEnum
+    F11N_TRANSACTION_TYPE_ENUM = [
+      # TODO: Write general description for SALE
+      SALE = 'sale'.freeze,
+
+      # TODO: Write general description for ENUM_RETURN
+      ENUM_RETURN = 'return'.freeze,
+
+      # TODO: Write general description for EXCHANGE
+      EXCHANGE = 'exchange'.freeze,
+
+      # TODO: Write general description for CANCELLATION
+      CANCELLATION = 'cancellation'.freeze,
+
+      # TODO: Write general description for VOID
+      VOID = 'void'.freeze,
+
+      # TODO: Write general description for CREATE_VOID
+      CREATE_VOID = 'create_void'.freeze,
+
+      # TODO: Write general description for FOREIGN_SALE
+      FOREIGN_SALE = 'foreign_sale'.freeze,
+
+      # TODO: Write general description for FOREIGN_RETURN
+      FOREIGN_RETURN = 'foreign_return'.freeze,
+
+      # TODO: Write general description for FOREIGN_EXCHANGE
+      FOREIGN_EXCHANGE = 'foreign_exchange'.freeze,
+
+      # TODO: Write general description for FOREIGN_CANCELLATION
+      FOREIGN_CANCELLATION = 'foreign_cancellation'.freeze,
+
+      # TODO: Write general description for CREATE_X_REPORT
+      CREATE_X_REPORT = 'create_x_report'.freeze,
+
+      # TODO: Write general description for CREATE_Z_REPORT
+      CREATE_Z_REPORT = 'create_z_report'.freeze,
+
+      # TODO: Write general description for MANUAL_CREATE_REPORT
+      MANUAL_CREATE_REPORT = 'manual_create_report'.freeze,
+
+      # TODO: Write general description for DOCUMENT_PRINTED
+      DOCUMENT_PRINTED = 'document_printed'.freeze,
+
+      # TODO: Write general description for DOCUMENT_EMAILED
+      DOCUMENT_EMAILED = 'document_emailed'.freeze,
+
+      # TODO: Write general description for CASH_DRAWER_TRANSACTION
+      CASH_DRAWER_TRANSACTION = 'cash_drawer_transaction'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      F11N_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 'enum_return' then ENUM_RETURN
+      when 'exchange' then EXCHANGE
+      when 'cancellation' then CANCELLATION
+      when 'void' then VOID
+      when 'create_void' then CREATE_VOID
+      when 'foreign_sale' then FOREIGN_SALE
+      when 'foreign_return' then FOREIGN_RETURN
+      when 'foreign_exchange' then FOREIGN_EXCHANGE
+      when 'foreign_cancellation' then FOREIGN_CANCELLATION
+      when 'create_x_report' then CREATE_X_REPORT
+      when 'create_z_report' then CREATE_Z_REPORT
+      when 'manual_create_report' then MANUAL_CREATE_REPORT
+      when 'document_printed' then DOCUMENT_PRINTED
+      when 'document_emailed' then DOCUMENT_EMAILED
+      when 'cash_drawer_transaction' then CASH_DRAWER_TRANSACTION
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/f11n_warning_code_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
+  # Fiscalization warning codes that are propagated to the clients (e.g.
+  # Associate App) for providing information on possible action items.
+  class F11nWarningCodeEnum
+    F11N_WARNING_CODE_ENUM = [
+      # TODO: Write general description for
+      # F11N_FISCAL_PRINTER_PAPER_RUNNING_OUT
+      F11N_FISCAL_PRINTER_PAPER_RUNNING_OUT = 'f11n_fiscal_printer_paper_running_out'.freeze,
+
+      # TODO: Write general description for
+      # F11N_FISCAL_PRINTER_CHARGER_DISCONNECTED
+      F11N_FISCAL_PRINTER_CHARGER_DISCONNECTED = 'f11n_fiscal_printer_charger_disconnected'.freeze,
+
+      # TODO: Write general description for
+      # F11N_FISCAL_PRINTER_FISCAL_MEMORY_NEARLY_FULL
+      F11N_FISCAL_PRINTER_FISCAL_MEMORY_NEARLY_FULL = 'f11n_fiscal_printer_fiscal_memory_nearly_full'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      F11N_WARNING_CODE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = F11N_FISCAL_PRINTER_PAPER_RUNNING_OUT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'f11n_fiscal_printer_paper_running_out' then F11N_FISCAL_PRINTER_PAPER_RUNNING_OUT
+      when 'f11n_fiscal_printer_charger_disconnected' then F11N_FISCAL_PRINTER_CHARGER_DISCONNECTED
+      when 'f11n_fiscal_printer_fiscal_memory_nearly_full' then F11N_FISCAL_PRINTER_FISCAL_MEMORY_NEARLY_FULL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/failed.rb

@@ -0,0 +1,68 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Failed Model.
+  class Failed < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :order_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error'] = 'error'
+      @_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(error = nil, order_id = nil)
+      @error = error
+      @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.
+      error = hash.key?('error') ? hash['error'] : nil
+      order_id = hash.key?('order_id') ? hash['order_id'] : nil
+
+      # Create object from extracted values.
+      Failed.new(error,
+                 order_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, 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} error: #{@error.inspect}, order_id: #{@order_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/fallback_error_dto.rb

@@ -0,0 +1,79 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # FallbackErrorDto Model.
+  class FallbackErrorDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TaxServiceErrorCodeEnum]
+    attr_accessor :error_code
+
+    # The error message of the underlying tax provider.
+    # @return [String]
+    attr_accessor :message
+
+    # The error message of the underlying tax provider.
+    # @return [TaxCalculationStrategyEnum]
+    attr_accessor :original_tax_provider
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error_code'] = 'error_code'
+      @_hash['message'] = 'message'
+      @_hash['original_tax_provider'] = 'original_tax_provider'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(error_code = nil, message = nil, original_tax_provider = nil)
+      @error_code = error_code
+      @message = message
+      @original_tax_provider = original_tax_provider
+    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_code = hash.key?('error_code') ? hash['error_code'] : nil
+      message = hash.key?('message') ? hash['message'] : nil
+      original_tax_provider =
+        hash.key?('original_tax_provider') ? hash['original_tax_provider'] : nil
+
+      # Create object from extracted values.
+      FallbackErrorDto.new(error_code,
+                           message,
+                           original_tax_provider)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code}, message: #{@message}, original_tax_provider:"\
+      " #{@original_tax_provider}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code.inspect}, message: #{@message.inspect},"\
+      " original_tax_provider: #{@original_tax_provider.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/feature_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
+  # Indicates the feature of the reason code.
+  class FeatureEnum
+    FEATURE_ENUM = [
+      # TODO: Write general description for DISCOUNT
+      DISCOUNT = 'DISCOUNT'.freeze,
+
+      # TODO: Write general description for OVERRIDE
+      OVERRIDE = 'OVERRIDE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FEATURE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = DISCOUNT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'discount' then DISCOUNT
+      when 'override' then OVERRIDE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/fiscal_countries_dto.rb

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

data/lib/new_store_api/models/fiscal_environment_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
+  # Fiscal environment of the tenant.
+  class FiscalEnvironmentEnum
+    FISCAL_ENVIRONMENT_ENUM = [
+      # TODO: Write general description for NONPRODUCTION
+      NONPRODUCTION = 'non-production'.freeze,
+
+      # TODO: Write general description for PRODUCTION
+      PRODUCTION = 'production'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FISCAL_ENVIRONMENT_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = NONPRODUCTION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'nonproduction' then NONPRODUCTION
+      when 'production' then PRODUCTION
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/fiscal_mode_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
+  # Fiscal mode. * Defaults to `standard` if not provided.
+  class FiscalModeEnum
+    FISCAL_MODE_ENUM = [
+      # TODO: Write general description for STANDARD
+      STANDARD = 'standard'.freeze,
+
+      # TODO: Write general description for OFFLINE
+      OFFLINE = 'offline'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FISCAL_MODE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = STANDARD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'standard' then STANDARD
+      when 'offline' then OFFLINE
+      else
+        default_value
+      end
+    end
+  end
+end