newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/line_item11.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
+  # Line item
+  class LineItem11 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Sales order item UUID.
+    # @return [UUID | String]
+    attr_accessor :item_id
+
+    # New state that should be applied to this item defined by sales order item
+    # UUID.
+    # @return [StateEnum]
+    attr_accessor :state
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['item_id'] = 'item_id'
+      @_hash['state'] = 'state'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(item_id = nil, state = nil)
+      @item_id = item_id
+      @state = state
+    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_id = hash.key?('item_id') ? hash['item_id'] : nil
+      state = hash.key?('state') ? hash['state'] : nil
+
+      # Create object from extracted values.
+      LineItem11.new(item_id,
+                     state)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [LineItem11 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.item_id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.state,
+                                  ->(val) { StateEnum.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['item_id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['state'],
+                                ->(val) { StateEnum.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_id: #{@item_id}, state: #{@state}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_id: #{@item_id.inspect}, state: #{@state.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/line_item2.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
+  # A single ordered product line.
+  class LineItem2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Tenant-defined name/value pairs for this line item, propagated through the
+    # platform.
+    # @return [Array[ExtendedAttribute]]
+    attr_accessor :extended_attributes
+
+    # Optional per-unit external identifiers for a serialised item.
+    # @return [ExternalIdentifiers]
+    attr_accessor :external_identifiers
+
+    # Caller-provided identifier for this line item. Must be unique within the
+    # order.
+    # @return [String]
+    attr_accessor :line_item_id
+
+    # References the `line_item_id` of the parent product line item this add-on
+    # is attached to. Null or omitted for a standalone product line.
+    # @return [String]
+    attr_accessor :parent_line_item_id
+
+    # The required price points for a line item, in the currency's minor unit.
+    # @return [LineItemPrice]
+    attr_accessor :price
+
+    # The identifier of the product as it was fetched from the catalog.
+    # @return [String]
+    attr_accessor :product_id
+
+    # Caller-provided external identifier for this item. Echoed back as
+    # `external_item_id` in the response. Null when not supplied.
+    # @return [String]
+    attr_accessor :unit_external_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['extended_attributes'] = 'extended_attributes'
+      @_hash['external_identifiers'] = 'external_identifiers'
+      @_hash['line_item_id'] = 'line_item_id'
+      @_hash['parent_line_item_id'] = 'parent_line_item_id'
+      @_hash['price'] = 'price'
+      @_hash['product_id'] = 'product_id'
+      @_hash['unit_external_id'] = 'unit_external_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        extended_attributes
+        external_identifiers
+        parent_line_item_id
+        unit_external_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        external_identifiers
+        parent_line_item_id
+        unit_external_id
+      ]
+    end
+
+    def initialize(line_item_id = nil, price = nil, product_id = nil,
+                   extended_attributes = SKIP, external_identifiers = SKIP,
+                   parent_line_item_id = SKIP, unit_external_id = SKIP)
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @external_identifiers = external_identifiers unless external_identifiers == SKIP
+      @line_item_id = line_item_id
+      @parent_line_item_id = parent_line_item_id unless parent_line_item_id == SKIP
+      @price = price
+      @product_id = product_id
+      @unit_external_id = unit_external_id unless unit_external_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.
+      line_item_id = hash.key?('line_item_id') ? hash['line_item_id'] : nil
+      price = LineItemPrice.from_hash(hash['price']) if hash['price']
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+      # 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 << (ExtendedAttribute.from_hash(structure) if structure)
+        end
+      end
+
+      extended_attributes = SKIP unless hash.key?('extended_attributes')
+      external_identifiers = ExternalIdentifiers.from_hash(hash['external_identifiers']) if
+        hash['external_identifiers']
+      parent_line_item_id =
+        hash.key?('parent_line_item_id') ? hash['parent_line_item_id'] : SKIP
+      unit_external_id =
+        hash.key?('unit_external_id') ? hash['unit_external_id'] : SKIP
+
+      # Create object from extracted values.
+      LineItem2.new(line_item_id,
+                    price,
+                    product_id,
+                    extended_attributes,
+                    external_identifiers,
+                    parent_line_item_id,
+                    unit_external_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} extended_attributes: #{@extended_attributes}, external_identifiers:"\
+      " #{@external_identifiers}, line_item_id: #{@line_item_id}, parent_line_item_id:"\
+      " #{@parent_line_item_id}, price: #{@price}, product_id: #{@product_id}, unit_external_id:"\
+      " #{@unit_external_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} extended_attributes: #{@extended_attributes.inspect}, external_identifiers:"\
+      " #{@external_identifiers.inspect}, line_item_id: #{@line_item_id.inspect},"\
+      " parent_line_item_id: #{@parent_line_item_id.inspect}, price: #{@price.inspect},"\
+      " product_id: #{@product_id.inspect}, unit_external_id: #{@unit_external_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/line_item21.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
+  # Line item with product information and optional addon relationships
+  class LineItem21 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Line item ID of the parent product of this addon. If specified, must
+    # reference the product's `line_item_id` in this list. Null if this is not
+    # an addon or for backward compatibility with the `delivery` service API.
+    # @return [String]
+    attr_accessor :addon_parent_item_id
+
+    # Indicates if the product is a preorder item. If true, the product is
+    # expected to be available in the future and should have future
+    # availability.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_preorder
+
+    # Line item ID of the unique instance of the product or addon. Optional for
+    # backward compatibility with the `delivery` service API. Its main use is to
+    # set the relationship between parent items and addons. If not specified,
+    # response will not have it. If specified, all other line items must have a
+    # `line_item_id`.
+    # @return [String]
+    attr_accessor :line_item_id
+
+    # Line item ID of the unique instance of the product or addon. Optional for
+    # backward compatibility with the `delivery` service API. Its main use is to
+    # set the relationship between parent items and addons. If not specified,
+    # response will not have it. If specified, all other line items must have a
+    # `line_item_id`.
+    # @return [String]
+    attr_accessor :product_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['addon_parent_item_id'] = 'addon_parent_item_id'
+      @_hash['is_preorder'] = 'is_preorder'
+      @_hash['line_item_id'] = 'line_item_id'
+      @_hash['product_id'] = 'product_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        addon_parent_item_id
+        is_preorder
+        line_item_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        addon_parent_item_id
+        line_item_id
+      ]
+    end
+
+    def initialize(product_id = nil, addon_parent_item_id = SKIP,
+                   is_preorder = false, line_item_id = SKIP)
+      @addon_parent_item_id = addon_parent_item_id unless addon_parent_item_id == SKIP
+      @is_preorder = is_preorder unless is_preorder == SKIP
+      @line_item_id = line_item_id unless line_item_id == SKIP
+      @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.
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+      addon_parent_item_id =
+        hash.key?('addon_parent_item_id') ? hash['addon_parent_item_id'] : SKIP
+      is_preorder = hash['is_preorder'] ||= false
+      line_item_id = hash.key?('line_item_id') ? hash['line_item_id'] : SKIP
+
+      # Create object from extracted values.
+      LineItem21.new(product_id,
+                     addon_parent_item_id,
+                     is_preorder,
+                     line_item_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [LineItem21 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.product_id,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['product_id'],
+                            ->(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} addon_parent_item_id: #{@addon_parent_item_id}, is_preorder:"\
+      " #{@is_preorder}, 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} addon_parent_item_id: #{@addon_parent_item_id.inspect}, is_preorder:"\
+      " #{@is_preorder.inspect}, line_item_id: #{@line_item_id.inspect}, product_id:"\
+      " #{@product_id.inspect}>"
+    end
+  end
+end

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

data/lib/new_store_api/models/line_item_price.rb

@@ -0,0 +1,180 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The required price points for a line item, in the currency's minor unit.
+  class LineItemPrice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The price of the product in the default pricebook, in the currency's minor
+    # unit. Differs from `list_price` when the item was priced from another
+    # pricebook. Null when not supplied.
+    # @return [Integer]
+    attr_accessor :default_list_price
+
+    # Discounts applied to this item, item-level or order-level prorated onto it
+    # (see `scope`). Their `applied_amount` is already deducted from `price`, so
+    # they describe how `list_price` became `price` rather than a further
+    # reduction to apply.
+    # @return [Array[Object]]
+    attr_accessor :discounts
+
+    # The price of the product in the chosen pricebook, in the currency's minor
+    # unit. This is the price the item's discounts are applied to.
+    # @return [Integer]
+    attr_accessor :list_price
+
+    # The price of the item **after** its discounts have been applied, in the
+    # currency's minor unit. It must equal `list_price` minus the sum of
+    # `discounts[].applied_amount`, or, when a `price_override` is supplied, the
+    # overridden price.
+    # @return [Integer]
+    attr_accessor :price
+
+    # Details of a manual price override applied to this item; null when none
+    # was applied.
+    # @return [PriceOverride]
+    attr_accessor :price_override
+
+    # Total tax amount for the item, in the currency's minor unit. With
+    # tax_excluded pricing the customer pays `price` plus this tax; with
+    # tax_included pricing this is the tax already contained in `price`.
+    # Defaults to 0.
+    # @return [Integer]
+    attr_accessor :price_tax
+
+    # A reference to the pricebook used to lookup list_price
+    # @return [String]
+    attr_accessor :pricebook
+
+    # Optional breakdown of the taxes that make up `price_tax`.
+    # @return [Array[TaxLine]]
+    attr_accessor :tax_lines
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['default_list_price'] = 'default_list_price'
+      @_hash['discounts'] = 'discounts'
+      @_hash['list_price'] = 'list_price'
+      @_hash['price'] = 'price'
+      @_hash['price_override'] = 'price_override'
+      @_hash['price_tax'] = 'price_tax'
+      @_hash['pricebook'] = 'pricebook'
+      @_hash['tax_lines'] = 'tax_lines'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        default_list_price
+        discounts
+        price_override
+        price_tax
+        pricebook
+        tax_lines
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        default_list_price
+        price_override
+      ]
+    end
+
+    def initialize(list_price = nil, price = nil, default_list_price = SKIP,
+                   discounts = SKIP, price_override = SKIP, price_tax = 0,
+                   pricebook = 'default', tax_lines = SKIP)
+      @default_list_price = default_list_price unless default_list_price == SKIP
+      @discounts = discounts unless discounts == SKIP
+      @list_price = list_price
+      @price = price
+      @price_override = price_override unless price_override == SKIP
+      @price_tax = price_tax unless price_tax == SKIP
+      @pricebook = pricebook unless pricebook == SKIP
+      @tax_lines = tax_lines unless tax_lines == 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.
+      list_price = hash.key?('list_price') ? hash['list_price'] : nil
+      price = hash.key?('price') ? hash['price'] : nil
+      default_list_price =
+        hash.key?('default_list_price') ? hash['default_list_price'] : SKIP
+      discounts = hash.key?('discounts') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:LineItemPriceDiscounts), hash['discounts']
+      ) : SKIP
+      price_override = PriceOverride.from_hash(hash['price_override']) if hash['price_override']
+      price_tax = hash['price_tax'] ||= 0
+      pricebook = hash['pricebook'] ||= 'default'
+      # Parameter is an array, so we need to iterate through it
+      tax_lines = nil
+      unless hash['tax_lines'].nil?
+        tax_lines = []
+        hash['tax_lines'].each do |structure|
+          tax_lines << (TaxLine.from_hash(structure) if structure)
+        end
+      end
+
+      tax_lines = SKIP unless hash.key?('tax_lines')
+
+      # Create object from extracted values.
+      LineItemPrice.new(list_price,
+                        price,
+                        default_list_price,
+                        discounts,
+                        price_override,
+                        price_tax,
+                        pricebook,
+                        tax_lines)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [LineItemPrice | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.list_price,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.price,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['list_price'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['price'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} default_list_price: #{@default_list_price}, discounts: #{@discounts},"\
+      " list_price: #{@list_price}, price: #{@price}, price_override: #{@price_override},"\
+      " price_tax: #{@price_tax}, pricebook: #{@pricebook}, tax_lines: #{@tax_lines}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} default_list_price: #{@default_list_price.inspect}, discounts:"\
+      " #{@discounts.inspect}, list_price: #{@list_price.inspect}, price: #{@price.inspect},"\
+      " price_override: #{@price_override.inspect}, price_tax: #{@price_tax.inspect}, pricebook:"\
+      " #{@pricebook.inspect}, tax_lines: #{@tax_lines.inspect}>"
+    end
+  end
+end

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