newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/enriched_transaction_item_dto.rb

@@ -0,0 +1,261 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # EnrichedTransactionItemDto Model.
+  class EnrichedTransactionItemDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # UUID of the consumer.
+    # @return [String]
+    attr_accessor :consumer_uuid
+
+    # Currency code shown and billed to the consumer.
+    # @return [String]
+    attr_accessor :currency_consumer
+
+    # The item's list of extended attributes.
+    # @return [Array[ExtAttrResource]]
+    attr_accessor :extended_attributes
+
+    # Cost of handling.
+    # @return [Float]
+    attr_accessor :handling_charges
+
+    # Unique identifier of the item.
+    # @return [String]
+    attr_accessor :id
+
+    # Price per quantity 1 of the item, can be incl. or excl. tax depending on
+    # tax_method.
+    # @return [Float]
+    attr_accessor :item_price
+
+    # Gross price for the total quantity of the line item, after all discounts.
+    # @return [Float]
+    attr_accessor :price_line_item
+
+    # Net price for total quantity of line item, after applying all discounts.
+    # @return [Float]
+    attr_accessor :price_net
+
+    # Total amount of tax added to the net price, after appplying all discounts.
+    # @return [Float]
+    attr_accessor :price_tax
+
+    # Unique identifier of the product.
+    # @return [String]
+    attr_accessor :product_id
+
+    # Human-readable name of the product.
+    # @return [String]
+    attr_accessor :product_name
+
+    # SKU of the product.
+    # @return [String]
+    attr_accessor :product_sku
+
+    # Item quantity. Positive number for sold items and negative number for
+    # returned items
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # Consumer's shipping address.
+    # @return [EnrichedTransactionAddressDto]
+    attr_accessor :shipping_address
+
+    # The origin of goods address, e.g. physical address of a store.
+    # @return [EnrichedTransactionAddressDto]
+    attr_accessor :shipping_origin
+
+    # Tax classification identifier for the line item.
+    # @return [String]
+    attr_accessor :tax_class
+
+    # Tax classification identifier for the line item.
+    # @return [SalesOrderTaxMethodEnum]
+    attr_accessor :tax_method
+
+    # All applied tax percent values and tax amounts for total quantity of line
+    # item (usually more than one rate per line item).
+    # @return [Array[TaxRateDto]]
+    attr_accessor :tax_rates
+
+    # All applied tax percent values and tax amounts for total quantity of line
+    # item (usually more than one rate per line item).
+    # @return [ItemTypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['consumer_uuid'] = 'consumer_uuid'
+      @_hash['currency_consumer'] = 'currency_consumer'
+      @_hash['extended_attributes'] = 'extended_attributes'
+      @_hash['handling_charges'] = 'handling_charges'
+      @_hash['id'] = 'id'
+      @_hash['item_price'] = 'item_price'
+      @_hash['price_line_item'] = 'price_line_item'
+      @_hash['price_net'] = 'price_net'
+      @_hash['price_tax'] = 'price_tax'
+      @_hash['product_id'] = 'product_id'
+      @_hash['product_name'] = 'product_name'
+      @_hash['product_sku'] = 'product_sku'
+      @_hash['quantity'] = 'quantity'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['shipping_origin'] = 'shipping_origin'
+      @_hash['tax_class'] = 'tax_class'
+      @_hash['tax_method'] = 'tax_method'
+      @_hash['tax_rates'] = 'tax_rates'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        consumer_uuid
+        currency_consumer
+        extended_attributes
+        handling_charges
+        id
+        product_id
+        product_name
+        product_sku
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(item_price = nil, price_line_item = nil, price_net = nil,
+                   price_tax = nil, quantity = nil, shipping_address = nil,
+                   shipping_origin = nil, tax_class = nil, tax_method = nil,
+                   tax_rates = nil, type = nil, consumer_uuid = SKIP,
+                   currency_consumer = SKIP, extended_attributes = SKIP,
+                   handling_charges = SKIP, id = SKIP, product_id = SKIP,
+                   product_name = SKIP, product_sku = SKIP)
+      @consumer_uuid = consumer_uuid unless consumer_uuid == SKIP
+      @currency_consumer = currency_consumer unless currency_consumer == SKIP
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @handling_charges = handling_charges unless handling_charges == SKIP
+      @id = id unless id == SKIP
+      @item_price = item_price
+      @price_line_item = price_line_item
+      @price_net = price_net
+      @price_tax = price_tax
+      @product_id = product_id unless product_id == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @product_sku = product_sku unless product_sku == SKIP
+      @quantity = quantity
+      @shipping_address = shipping_address
+      @shipping_origin = shipping_origin
+      @tax_class = tax_class
+      @tax_method = tax_method
+      @tax_rates = tax_rates
+      @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.
+      item_price = hash.key?('item_price') ? hash['item_price'] : nil
+      price_line_item =
+        hash.key?('price_line_item') ? hash['price_line_item'] : nil
+      price_net = hash.key?('price_net') ? hash['price_net'] : nil
+      price_tax = hash.key?('price_tax') ? hash['price_tax'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      shipping_address = EnrichedTransactionAddressDto.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      shipping_origin = EnrichedTransactionAddressDto.from_hash(hash['shipping_origin']) if
+        hash['shipping_origin']
+      tax_class = hash.key?('tax_class') ? hash['tax_class'] : nil
+      tax_method = hash.key?('tax_method') ? hash['tax_method'] : nil
+      # Parameter is an array, so we need to iterate through it
+      tax_rates = nil
+      unless hash['tax_rates'].nil?
+        tax_rates = []
+        hash['tax_rates'].each do |structure|
+          tax_rates << (TaxRateDto.from_hash(structure) if structure)
+        end
+      end
+
+      tax_rates = nil unless hash.key?('tax_rates')
+      type = hash.key?('type') ? hash['type'] : nil
+      consumer_uuid = hash.key?('consumer_uuid') ? hash['consumer_uuid'] : SKIP
+      currency_consumer =
+        hash.key?('currency_consumer') ? hash['currency_consumer'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      extended_attributes = nil
+      unless hash['extended_attributes'].nil?
+        extended_attributes = []
+        hash['extended_attributes'].each do |structure|
+          extended_attributes << (ExtAttrResource.from_hash(structure) if structure)
+        end
+      end
+
+      extended_attributes = SKIP unless hash.key?('extended_attributes')
+      handling_charges =
+        hash.key?('handling_charges') ? hash['handling_charges'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      product_name = hash.key?('product_name') ? hash['product_name'] : SKIP
+      product_sku = hash.key?('product_sku') ? hash['product_sku'] : SKIP
+
+      # Create object from extracted values.
+      EnrichedTransactionItemDto.new(item_price,
+                                     price_line_item,
+                                     price_net,
+                                     price_tax,
+                                     quantity,
+                                     shipping_address,
+                                     shipping_origin,
+                                     tax_class,
+                                     tax_method,
+                                     tax_rates,
+                                     type,
+                                     consumer_uuid,
+                                     currency_consumer,
+                                     extended_attributes,
+                                     handling_charges,
+                                     id,
+                                     product_id,
+                                     product_name,
+                                     product_sku)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} consumer_uuid: #{@consumer_uuid}, currency_consumer: #{@currency_consumer},"\
+      " extended_attributes: #{@extended_attributes}, handling_charges: #{@handling_charges}, id:"\
+      " #{@id}, item_price: #{@item_price}, price_line_item: #{@price_line_item}, price_net:"\
+      " #{@price_net}, price_tax: #{@price_tax}, product_id: #{@product_id}, product_name:"\
+      " #{@product_name}, product_sku: #{@product_sku}, quantity: #{@quantity}, shipping_address:"\
+      " #{@shipping_address}, shipping_origin: #{@shipping_origin}, tax_class: #{@tax_class},"\
+      " tax_method: #{@tax_method}, tax_rates: #{@tax_rates}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} consumer_uuid: #{@consumer_uuid.inspect}, currency_consumer:"\
+      " #{@currency_consumer.inspect}, extended_attributes: #{@extended_attributes.inspect},"\
+      " handling_charges: #{@handling_charges.inspect}, id: #{@id.inspect}, item_price:"\
+      " #{@item_price.inspect}, price_line_item: #{@price_line_item.inspect}, price_net:"\
+      " #{@price_net.inspect}, price_tax: #{@price_tax.inspect}, product_id:"\
+      " #{@product_id.inspect}, product_name: #{@product_name.inspect}, product_sku:"\
+      " #{@product_sku.inspect}, quantity: #{@quantity.inspect}, shipping_address:"\
+      " #{@shipping_address.inspect}, shipping_origin: #{@shipping_origin.inspect}, tax_class:"\
+      " #{@tax_class.inspect}, tax_method: #{@tax_method.inspect}, tax_rates:"\
+      " #{@tax_rates.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/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
+  class EnvironmentEnum
+    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?
+
+      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/epc_body.rb

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

data/lib/new_store_api/models/epson_printer_model_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
+  # Epson printer model being used.
+  class EpsonPrinterModelEnum
+    EPSON_PRINTER_MODEL_ENUM = [
+      # TODO: Write general description for EPSON_FP_81_II_RT
+      EPSON_FP_81_II_RT = 'epson_fp_81_ii_rt'.freeze,
+
+      # TODO: Write general description for EPSON_FP_90_III_RT
+      EPSON_FP_90_III_RT = 'epson_fp_90_iii_rt'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EPSON_PRINTER_MODEL_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = EPSON_FP_81_II_RT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'epson_fp_81_ii_rt' then EPSON_FP_81_II_RT
+      when 'epson_fp_90_iii_rt' then EPSON_FP_90_III_RT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/error.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
+  # Error Model.
+  class Error < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique error code.
+    # @return [CodeEnum]
+    attr_accessor :code
+
+    # A detailed message about the error.
+    # @return [String]
+    attr_accessor :message
+
+    # The SKU of the product with an error.
+    # @return [String]
+    attr_accessor :product_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['message'] = 'message'
+      @_hash['product_id'] = 'product_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = nil, message = nil, product_id = SKIP)
+      @code = code
+      @message = message
+      @product_id = product_id unless product_id == 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.
+      code = hash.key?('code') ? hash['code'] : nil
+      message = hash.key?('message') ? hash['message'] : nil
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+
+      # Create object from extracted values.
+      Error.new(code,
+                message,
+                product_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, message: #{@message}, 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} code: #{@code.inspect}, message: #{@message.inspect}, product_id:"\
+      " #{@product_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/event_captured_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
+  # EventCapturedDto Model.
+  class EventCapturedDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Message that indicates that the event was captured.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message = nil)
+      @message = message
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      message = hash.key?('message') ? hash['message'] : nil
+
+      # Create object from extracted values.
+      EventCapturedDto.new(message)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/event_name1_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
+  # The name of the external event.
+  class EventName1Enum
+    EVENT_NAME1_ENUM = [
+      # TODO: Write general description for ENUM_ORDERCOMPLETED
+      ENUM_ORDERCOMPLETED = 'order.completed'.freeze,
+
+      # TODO: Write general description for ENUM_RETURNPROCESSED
+      ENUM_RETURNPROCESSED = 'return.processed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EVENT_NAME1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_ORDERCOMPLETED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_ordercompleted' then ENUM_ORDERCOMPLETED
+      when 'enum_returnprocessed' then ENUM_RETURNPROCESSED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/event_name_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
+  # Event-Name.
+  class EventNameEnum
+    EVENT_NAME_ENUM = [
+      # TODO: Write general description for ENUM_CONSUMER_PROFILEDELETED
+      ENUM_CONSUMER_PROFILEDELETED = 'consumer_profile.deleted'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_CONSUMER_PROFILEDELETION_REQUESTED
+      ENUM_CONSUMER_PROFILEDELETION_REQUESTED = 'consumer_profile.deletion_requested'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EVENT_NAME_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_CONSUMER_PROFILEDELETED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_consumer_profiledeleted' then ENUM_CONSUMER_PROFILEDELETED
+      when 'enum_consumer_profiledeletion_requested' then ENUM_CONSUMER_PROFILEDELETION_REQUESTED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/excluded_product.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
+  # ExcludedProduct Model.
+  class ExcludedProduct < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :sku
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['sku'] = 'sku'
+      @_hash['title'] = 'title'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sku
+        title
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(sku = SKIP, title = SKIP)
+      @sku = sku unless sku == SKIP
+      @title = title unless title == 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.
+      sku = hash.key?('sku') ? hash['sku'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+
+      # Create object from extracted values.
+      ExcludedProduct.new(sku,
+                          title)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sku: #{@sku}, title: #{@title}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sku: #{@sku.inspect}, title: #{@title.inspect}>"
+    end
+  end
+end