newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/initial_reservation_status_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
+  # Initial status of the reservation. If PENDING then the reservation will need
+  # to be confirmed by a store associate before the stock is reserved.
+  class InitialReservationStatusEnum
+    INITIAL_RESERVATION_STATUS_ENUM = [
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze,
+
+      # TODO: Write general description for RESERVED
+      RESERVED = 'RESERVED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INITIAL_RESERVATION_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 'reserved' then RESERVED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/injected_order_address.rb

@@ -0,0 +1,193 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # InjectedOrderAddress Model.
+  class InjectedOrderAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :address_line_1
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :address_line_2
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :city
+
+    # The code of the country in the ISO ALPHA-2 format.
+    # @return [String]
+    attr_accessor :country
+
+    # The code of the country in the ISO ALPHA-2 format.
+    # @return [String]
+    attr_accessor :first_name
+
+    # The code of the country in the ISO ALPHA-2 format.
+    # @return [String]
+    attr_accessor :last_name
+
+    # The code of the country in the ISO ALPHA-2 format.
+    # @return [String]
+    attr_accessor :phone
+
+    # The code of the country in the ISO ALPHA-2 format.
+    # @return [String]
+    attr_accessor :salutation
+
+    # The code of the country in the ISO ALPHA-2 format.
+    # @return [String]
+    attr_accessor :state
+
+    # The code of the country in the ISO ALPHA-2 format.
+    # @return [String]
+    attr_accessor :suffix
+
+    # The code of the country in the ISO ALPHA-2 format.
+    # @return [String]
+    attr_accessor :title
+
+    # The code of the country in the ISO ALPHA-2 format.
+    # @return [String]
+    attr_accessor :zip_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address_line_1'] = 'address_line_1'
+      @_hash['address_line_2'] = 'address_line_2'
+      @_hash['city'] = 'city'
+      @_hash['country'] = 'country'
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['phone'] = 'phone'
+      @_hash['salutation'] = 'salutation'
+      @_hash['state'] = 'state'
+      @_hash['suffix'] = 'suffix'
+      @_hash['title'] = 'title'
+      @_hash['zip_code'] = 'zip_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address_line_2
+        city
+        first_name
+        last_name
+        phone
+        salutation
+        state
+        suffix
+        title
+        zip_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address_line_1 = nil, country = nil, address_line_2 = SKIP,
+                   city = SKIP, first_name = SKIP, last_name = SKIP,
+                   phone = SKIP, salutation = SKIP, state = SKIP, suffix = SKIP,
+                   title = SKIP, zip_code = SKIP)
+      @address_line_1 = address_line_1
+      @address_line_2 = address_line_2 unless address_line_2 == SKIP
+      @city = city unless city == SKIP
+      @country = country
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @phone = phone unless phone == SKIP
+      @salutation = salutation unless salutation == SKIP
+      @state = state unless state == SKIP
+      @suffix = suffix unless suffix == SKIP
+      @title = title unless title == SKIP
+      @zip_code = zip_code unless zip_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.
+      address_line_1 =
+        hash.key?('address_line_1') ? hash['address_line_1'] : nil
+      country = hash.key?('country') ? hash['country'] : nil
+      address_line_2 =
+        hash.key?('address_line_2') ? hash['address_line_2'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      salutation = hash.key?('salutation') ? hash['salutation'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      zip_code = hash.key?('zip_code') ? hash['zip_code'] : SKIP
+
+      # Create object from extracted values.
+      InjectedOrderAddress.new(address_line_1,
+                               country,
+                               address_line_2,
+                               city,
+                               first_name,
+                               last_name,
+                               phone,
+                               salutation,
+                               state,
+                               suffix,
+                               title,
+                               zip_code)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InjectedOrderAddress | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.address_line_1,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.country,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['address_line_1'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['country'],
+                                ->(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} address_line_1: #{@address_line_1}, address_line_2: #{@address_line_2},"\
+      " city: #{@city}, country: #{@country}, first_name: #{@first_name}, last_name:"\
+      " #{@last_name}, phone: #{@phone}, salutation: #{@salutation}, state: #{@state}, suffix:"\
+      " #{@suffix}, title: #{@title}, zip_code: #{@zip_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address_line_1: #{@address_line_1.inspect}, address_line_2:"\
+      " #{@address_line_2.inspect}, city: #{@city.inspect}, country: #{@country.inspect},"\
+      " first_name: #{@first_name.inspect}, last_name: #{@last_name.inspect}, phone:"\
+      " #{@phone.inspect}, salutation: #{@salutation.inspect}, state: #{@state.inspect}, suffix:"\
+      " #{@suffix.inspect}, title: #{@title.inspect}, zip_code: #{@zip_code.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/injected_order_discount_info.rb

@@ -0,0 +1,141 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # InjectedOrderDiscountInfo Model.
+  class InjectedOrderDiscountInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :coupon_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # A string token identifying the discount, e.g. BLACK_FRIDAY_SALE.
+    # @return [String]
+    attr_accessor :discount_ref
+
+    # Discount applied. In the case of an item_discount_info, the discount is
+    # applied to the item itself. In the case of an item_order_discount_info,
+    # the discount is applied to the whole order.
+    # @return [Float]
+    attr_accessor :original_value
+
+    # Monetary discount amount applied to the current item.
+    # @return [Float]
+    attr_accessor :price_adjustment
+
+    # Monetary discount amount applied to the current item.
+    # @return [String]
+    attr_reader :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['coupon_code'] = 'coupon_code'
+      @_hash['description'] = 'description'
+      @_hash['discount_ref'] = 'discount_ref'
+      @_hash['original_value'] = 'original_value'
+      @_hash['price_adjustment'] = 'price_adjustment'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        coupon_code
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(discount_ref = nil, original_value = nil,
+                   price_adjustment = nil, coupon_code = SKIP,
+                   description = SKIP)
+      @coupon_code = coupon_code unless coupon_code == SKIP
+      @description = description unless description == SKIP
+      @discount_ref = discount_ref
+      @original_value = original_value
+      @price_adjustment = price_adjustment
+      @type = 'fixed'
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      discount_ref = hash.key?('discount_ref') ? hash['discount_ref'] : nil
+      original_value =
+        hash.key?('original_value') ? hash['original_value'] : nil
+      price_adjustment =
+        hash.key?('price_adjustment') ? hash['price_adjustment'] : nil
+      coupon_code = hash.key?('coupon_code') ? hash['coupon_code'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      InjectedOrderDiscountInfo.new(discount_ref,
+                                    original_value,
+                                    price_adjustment,
+                                    coupon_code,
+                                    description)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InjectedOrderDiscountInfo | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.discount_ref,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.original_value,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.price_adjustment,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.type,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['discount_ref'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['original_value'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['price_adjustment'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['type'],
+                                ->(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} coupon_code: #{@coupon_code}, description: #{@description}, discount_ref:"\
+      " #{@discount_ref}, original_value: #{@original_value}, price_adjustment:"\
+      " #{@price_adjustment}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} coupon_code: #{@coupon_code.inspect}, description: #{@description.inspect},"\
+      " discount_ref: #{@discount_ref.inspect}, original_value: #{@original_value.inspect},"\
+      " price_adjustment: #{@price_adjustment.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/injected_order_discount_info1.rb

@@ -0,0 +1,141 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # InjectedOrderDiscountInfo1 Model.
+  class InjectedOrderDiscountInfo1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :coupon_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # A string token identifying the discount, e.g. BLACK_FRIDAY_SALE.
+    # @return [String]
+    attr_accessor :discount_ref
+
+    # Discount applied. In the case of an item_discount_info, the discount is
+    # applied to the item itself. In the case of an item_order_discount_info,
+    # the discount is applied to the whole order.
+    # @return [Float]
+    attr_accessor :original_value
+
+    # Monetary discount amount applied to the current item.
+    # @return [Float]
+    attr_accessor :price_adjustment
+
+    # Monetary discount amount applied to the current item.
+    # @return [String]
+    attr_reader :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['coupon_code'] = 'coupon_code'
+      @_hash['description'] = 'description'
+      @_hash['discount_ref'] = 'discount_ref'
+      @_hash['original_value'] = 'original_value'
+      @_hash['price_adjustment'] = 'price_adjustment'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        coupon_code
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(discount_ref = nil, original_value = nil,
+                   price_adjustment = nil, coupon_code = SKIP,
+                   description = SKIP)
+      @coupon_code = coupon_code unless coupon_code == SKIP
+      @description = description unless description == SKIP
+      @discount_ref = discount_ref
+      @original_value = original_value
+      @price_adjustment = price_adjustment
+      @type = 'percentage'
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      discount_ref = hash.key?('discount_ref') ? hash['discount_ref'] : nil
+      original_value =
+        hash.key?('original_value') ? hash['original_value'] : nil
+      price_adjustment =
+        hash.key?('price_adjustment') ? hash['price_adjustment'] : nil
+      coupon_code = hash.key?('coupon_code') ? hash['coupon_code'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      InjectedOrderDiscountInfo1.new(discount_ref,
+                                     original_value,
+                                     price_adjustment,
+                                     coupon_code,
+                                     description)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InjectedOrderDiscountInfo1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.discount_ref,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.original_value,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.price_adjustment,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.type,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['discount_ref'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['original_value'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['price_adjustment'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['type'],
+                                ->(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} coupon_code: #{@coupon_code}, description: #{@description}, discount_ref:"\
+      " #{@discount_ref}, original_value: #{@original_value}, price_adjustment:"\
+      " #{@price_adjustment}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} coupon_code: #{@coupon_code.inspect}, description: #{@description.inspect},"\
+      " discount_ref: #{@discount_ref.inspect}, original_value: #{@original_value.inspect},"\
+      " price_adjustment: #{@price_adjustment.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/injected_order_extended_attribute.rb

@@ -0,0 +1,91 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Extra information about the order, which is propagated through NewStore
+  # applications.
+  class InjectedOrderExtendedAttribute < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil, value = nil)
+      @name = name
+      @value = value
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+      value = hash.key?('value') ? hash['value'] : nil
+
+      # Create object from extracted values.
+      InjectedOrderExtendedAttribute.new(name,
+                                         value)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InjectedOrderExtendedAttribute | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.name,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.value,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['name'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['value'],
+                                ->(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} name: #{@name}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/injected_order_item_ids.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
+  # InjectedOrderItemIds Model.
+  class InjectedOrderItemIds < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The external order item id as specified in the request.
+    # @return [String]
+    attr_accessor :external_item_id
+
+    # An identifier that is assigned to the item by the system.
+    # @return [String]
+    attr_accessor :id
+
+    # The product id from the catalog.
+    # @return [String]
+    attr_accessor :product_id
+
+    # 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['id'] = '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(external_item_id = nil, id = nil, product_id = nil)
+      @external_item_id = external_item_id
+      @id = 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.
+      external_item_id =
+        hash.key?('external_item_id') ? hash['external_item_id'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+
+      # Create object from extracted values.
+      InjectedOrderItemIds.new(external_item_id,
+                               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} external_item_id: #{@external_item_id}, id: #{@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} external_item_id: #{@external_item_id.inspect}, id: #{@id.inspect},"\
+      " product_id: #{@product_id.inspect}>"
+    end
+  end
+end