newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/ft_de_state_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
+  # Queue state after signing.
+  class FtDeStateEnum
+    FT_DE_STATE_ENUM = [
+      # TODO: Write general description for OK
+      OK = 'OK'.freeze,
+
+      # TODO: Write general description for OUT_OF_SERVICE
+      OUT_OF_SERVICE = 'OUT_OF_SERVICE'.freeze,
+
+      # TODO: Write general description for TSE_DEVICE_COMM_BROKEN
+      TSE_DEVICE_COMM_BROKEN = 'TSE_DEVICE_COMM_BROKEN'.freeze,
+
+      # TODO: Write general description for LATE_SIGNING_MODE
+      LATE_SIGNING_MODE = 'LATE_SIGNING_MODE'.freeze,
+
+      # TODO: Write general description for MESSAGE_PENDING
+      MESSAGE_PENDING = 'MESSAGE_PENDING'.freeze,
+
+      # TODO: Write general description for SWITCHING_SCU
+      SWITCHING_SCU = 'SWITCHING_SCU'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FT_DE_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 'out_of_service' then OUT_OF_SERVICE
+      when 'tse_device_comm_broken' then TSE_DEVICE_COMM_BROKEN
+      when 'late_signing_mode' then LATE_SIGNING_MODE
+      when 'message_pending' then MESSAGE_PENDING
+      when 'switching_scu' then SWITCHING_SCU
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/ft_fr_signature_format_enum.rb

@@ -0,0 +1,84 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Signature format to be used.
+  class FtFrSignatureFormatEnum
+    FT_FR_SIGNATURE_FORMAT_ENUM = [
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'UNKNOWN'.freeze,
+
+      # TODO: Write general description for TEXT
+      TEXT = 'TEXT'.freeze,
+
+      # TODO: Write general description for LINK
+      LINK = 'LINK'.freeze,
+
+      # TODO: Write general description for QR_CODE
+      QR_CODE = 'QR_CODE'.freeze,
+
+      # TODO: Write general description for CODE128
+      CODE128 = 'CODE128'.freeze,
+
+      # TODO: Write general description for OCR_A
+      OCR_A = 'OCR_A'.freeze,
+
+      # TODO: Write general description for PDF417
+      PDF417 = 'PDF417'.freeze,
+
+      # TODO: Write general description for DATAMATRIX
+      DATAMATRIX = 'DATAMATRIX'.freeze,
+
+      # TODO: Write general description for AZTEC
+      AZTEC = 'AZTEC'.freeze,
+
+      # TODO: Write general description for EAN_8
+      EAN_8 = 'EAN_8'.freeze,
+
+      # TODO: Write general description for EAN_13
+      EAN_13 = 'EAN_13'.freeze,
+
+      # TODO: Write general description for UPC_A
+      UPC_A = 'UPC_A'.freeze,
+
+      # TODO: Write general description for CODE39
+      CODE39 = 'CODE39'.freeze,
+
+      # TODO: Write general description for BASE64
+      BASE64 = 'BASE64'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FT_FR_SIGNATURE_FORMAT_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNKNOWN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'unknown' then UNKNOWN
+      when 'text' then TEXT
+      when 'link' then LINK
+      when 'qr_code' then QR_CODE
+      when 'code128' then CODE128
+      when 'ocr_a' then OCR_A
+      when 'pdf417' then PDF417
+      when 'datamatrix' then DATAMATRIX
+      when 'aztec' then AZTEC
+      when 'ean_8' then EAN_8
+      when 'ean_13' then EAN_13
+      when 'upc_a' then UPC_A
+      when 'code39' then CODE39
+      when 'base64' then BASE64
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/ft_fr_signature_type_enum.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
+  # Signature data type.
+  class FtFrSignatureTypeEnum
+    FT_FR_SIGNATURE_TYPE_ENUM = [
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'UNKNOWN'.freeze,
+
+      # TODO: Write general description for JWT
+      JWT = 'JWT'.freeze,
+
+      # TODO: Write general description for SHIFT_CLOSING_SUM
+      SHIFT_CLOSING_SUM = 'SHIFT_CLOSING_SUM'.freeze,
+
+      # TODO: Write general description for DAY_CLOSING_SUM
+      DAY_CLOSING_SUM = 'DAY_CLOSING_SUM'.freeze,
+
+      # TODO: Write general description for MONTH_CLOSING_SUM
+      MONTH_CLOSING_SUM = 'MONTH_CLOSING_SUM'.freeze,
+
+      # TODO: Write general description for YEAR_CLOSING_SUM
+      YEAR_CLOSING_SUM = 'YEAR_CLOSING_SUM'.freeze,
+
+      # TODO: Write general description for ARCHIVE_TOTALS_SUM
+      ARCHIVE_TOTALS_SUM = 'ARCHIVE_TOTALS_SUM'.freeze,
+
+      # TODO: Write general description for PERPETUAL_TOTAL_SUM
+      PERPETUAL_TOTAL_SUM = 'PERPETUAL_TOTAL_SUM'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FT_FR_SIGNATURE_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNKNOWN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'unknown' then UNKNOWN
+      when 'jwt' then JWT
+      when 'shift_closing_sum' then SHIFT_CLOSING_SUM
+      when 'day_closing_sum' then DAY_CLOSING_SUM
+      when 'month_closing_sum' then MONTH_CLOSING_SUM
+      when 'year_closing_sum' then YEAR_CLOSING_SUM
+      when 'archive_totals_sum' then ARCHIVE_TOTALS_SUM
+      when 'perpetual_total_sum' then PERPETUAL_TOTAL_SUM
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/ft_fr_state_enum.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
+  # Queue state after signing.
+  class FtFrStateEnum
+    FT_FR_STATE_ENUM = [
+      # TODO: Write general description for OK
+      OK = 'OK'.freeze,
+
+      # TODO: Write general description for OUT_OF_SERVICE
+      OUT_OF_SERVICE = 'OUT_OF_SERVICE'.freeze,
+
+      # TODO: Write general description for RESERVED_1
+      RESERVED_1 = 'RESERVED_1'.freeze,
+
+      # TODO: Write general description for RESERVED_2
+      RESERVED_2 = 'RESERVED_2'.freeze,
+
+      # TODO: Write general description for LATE_SIGNING_MODE
+      LATE_SIGNING_MODE = 'LATE_SIGNING_MODE'.freeze,
+
+      # TODO: Write general description for RESERVED_3
+      RESERVED_3 = 'RESERVED_3'.freeze,
+
+      # TODO: Write general description for RESERVED_4
+      RESERVED_4 = 'RESERVED_4'.freeze,
+
+      # TODO: Write general description for MESSAGE_PENDING
+      MESSAGE_PENDING = 'MESSAGE_PENDING'.freeze,
+
+      # TODO: Write general description for RESERVED_5
+      RESERVED_5 = 'RESERVED_5'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FT_FR_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 'out_of_service' then OUT_OF_SERVICE
+      when 'reserved_1' then RESERVED_1
+      when 'reserved_2' then RESERVED_2
+      when 'late_signing_mode' then LATE_SIGNING_MODE
+      when 'reserved_3' then RESERVED_3
+      when 'reserved_4' then RESERVED_4
+      when 'message_pending' then MESSAGE_PENDING
+      when 'reserved_5' then RESERVED_5
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment1.rb

@@ -0,0 +1,75 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Groups line items under a single fulfillment option.
+  class Fulfillment1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Service-level fulfillment option (e.g. in-store handover).
+    # The source spec models this as a `oneOf`; this MVP supports only the
+    # service-level variant and omits the shipping (`shipping_offer_token`) one.
+    # @return [FulfillmentOption]
+    attr_accessor :fulfillment_option
+
+    # The line items fulfilled by this fulfillment. Each value must match a
+    # `line_items[].line_item_id` in the same order. A given `line_item_id` must
+    # appear in exactly one fulfillment.
+    # @return [Array[String]]
+    attr_accessor :line_item_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fulfillment_option'] = 'fulfillment_option'
+      @_hash['line_item_ids'] = 'line_item_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fulfillment_option = nil, line_item_ids = nil)
+      @fulfillment_option = fulfillment_option
+      @line_item_ids = line_item_ids
+    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_option = FulfillmentOption.from_hash(hash['fulfillment_option']) if
+        hash['fulfillment_option']
+      line_item_ids = hash.key?('line_item_ids') ? hash['line_item_ids'] : nil
+
+      # Create object from extracted values.
+      Fulfillment1.new(fulfillment_option,
+                       line_item_ids)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fulfillment_option: #{@fulfillment_option}, line_item_ids:"\
+      " #{@line_item_ids}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fulfillment_option: #{@fulfillment_option.inspect}, line_item_ids:"\
+      " #{@line_item_ids.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment_assignment.rb

@@ -0,0 +1,109 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # FulfillmentAssignment Model.
+  class FulfillmentAssignment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # Which products can be fulfilled from this location.
+    # @return [Array[LineItem]]
+    attr_accessor :line_items
+
+    # The Location ID that is going to fulfill the items
+    # @return [String]
+    attr_accessor :location_id
+
+    # The Location ID that is going to fulfill the items
+    # @return [Float]
+    attr_accessor :price
+
+    # The Location ID that is going to fulfill the items
+    # @return [String]
+    attr_accessor :tax_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['line_items'] = 'line_items'
+      @_hash['location_id'] = 'location_id'
+      @_hash['price'] = 'price'
+      @_hash['tax_code'] = 'tax_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        tax_code
+      ]
+    end
+
+    def initialize(currency = nil, line_items = nil, location_id = nil,
+                   price = nil, tax_code = SKIP)
+      @currency = currency
+      @line_items = line_items
+      @location_id = location_id
+      @price = price
+      @tax_code = tax_code unless tax_code == 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.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (LineItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = nil unless hash.key?('line_items')
+      location_id = hash.key?('location_id') ? hash['location_id'] : nil
+      price = hash.key?('price') ? hash['price'] : nil
+      tax_code = hash.key?('tax_code') ? hash['tax_code'] : SKIP
+
+      # Create object from extracted values.
+      FulfillmentAssignment.new(currency,
+                                line_items,
+                                location_id,
+                                price,
+                                tax_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency}, line_items: #{@line_items}, location_id:"\
+      " #{@location_id}, price: #{@price}, tax_code: #{@tax_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency.inspect}, line_items: #{@line_items.inspect},"\
+      " location_id: #{@location_id.inspect}, price: #{@price.inspect}, tax_code:"\
+      " #{@tax_code.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment_config_destination_region.rb

@@ -0,0 +1,70 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Destination region for a fulfillment config route (Routes.json).
+  class FulfillmentConfigDestinationRegion < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Two-letter ISO 3166-1 alpha-2 country code for the route destination.
+    # @return [String]
+    attr_accessor :country
+
+    # Zip code region identifier; keys into zip_code_regions.
+    # @return [String]
+    attr_accessor :zip_code_region
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country'] = 'country'
+      @_hash['zip_code_region'] = 'zip_code_region'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = nil, zip_code_region = nil)
+      @country = country
+      @zip_code_region = zip_code_region
+    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 = hash.key?('country') ? hash['country'] : nil
+      zip_code_region =
+        hash.key?('zip_code_region') ? hash['zip_code_region'] : nil
+
+      # Create object from extracted values.
+      FulfillmentConfigDestinationRegion.new(country,
+                                             zip_code_region)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country: #{@country}, zip_code_region: #{@zip_code_region}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country: #{@country.inspect}, zip_code_region:"\
+      " #{@zip_code_region.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment_config_get_routing_rules_section_sample_response.rb

@@ -0,0 +1,87 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # FulfillmentConfigGetRoutingRulesSectionSampleResponse Model.
+  class FulfillmentConfigGetRoutingRulesSectionSampleResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Routing rules specification
+    # @return [Array[Routes]]
+    attr_accessor :routes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['routes'] = 'routes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(routes = nil)
+      @routes = routes
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      routes = nil
+      unless hash['routes'].nil?
+        routes = []
+        hash['routes'].each do |structure|
+          routes << (Routes.from_hash(structure) if structure)
+        end
+      end
+
+      routes = nil unless hash.key?('routes')
+
+      # Create object from extracted values.
+      FulfillmentConfigGetRoutingRulesSectionSampleResponse.new(routes)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FulfillmentConfigGetRoutingRulesSectionSampleResponse | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.routes,
+                                     ->(val) { Routes.validate(val) },
+                                     is_model_hash: true,
+                                     is_inner_model_hash: true)
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['routes'],
+                            ->(val) { Routes.validate(val) },
+                            is_model_hash: true,
+                            is_inner_model_hash: true)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} routes: #{@routes}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} routes: #{@routes.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment_config_get_routing_rules_section_sample_response1.rb

@@ -0,0 +1,76 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # FulfillmentConfigGetRoutingRulesSectionSampleResponse1 Model.
+  class FulfillmentConfigGetRoutingRulesSectionSampleResponse1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Service levels priority. This is ordered according to which service level
+    # will be taken first
+    # @return [Array[String]]
+    attr_accessor :sl_levels_priority
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['sl_levels_priority'] = 'sl_levels_priority'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(sl_levels_priority = nil)
+      @sl_levels_priority = sl_levels_priority
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      sl_levels_priority =
+        hash.key?('sl_levels_priority') ? hash['sl_levels_priority'] : nil
+
+      # Create object from extracted values.
+      FulfillmentConfigGetRoutingRulesSectionSampleResponse1.new(sl_levels_priority)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FulfillmentConfigGetRoutingRulesSectionSampleResponse1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.sl_levels_priority,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['sl_levels_priority'],
+                            ->(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} sl_levels_priority: #{@sl_levels_priority}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sl_levels_priority: #{@sl_levels_priority.inspect}>"
+    end
+  end
+end