newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/sales_order_tax_line.rb

@@ -0,0 +1,90 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SalesOrderTaxLine Model.
+  class SalesOrderTaxLine < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Monetary tax amount for this line.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The code of the country of the tax in the ISO 3166 ALPHA-2 format. For
+    # example, GB, DE or US.
+    # @return [String]
+    attr_accessor :country_code
+
+    # Name of the tax line, e.g. MA Sales Tax.
+    # @return [String]
+    attr_accessor :name
+
+    # Decimal representation of the tax rate for this line, e.g. 6.25
+    # @return [Float]
+    attr_accessor :rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['country_code'] = 'country_code'
+      @_hash['name'] = 'name'
+      @_hash['rate'] = 'rate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        country_code
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, rate = nil, country_code = SKIP, name = SKIP)
+      @amount = amount
+      @country_code = country_code unless country_code == SKIP
+      @name = name unless name == SKIP
+      @rate = rate
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      rate = hash.key?('rate') ? hash['rate'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      SalesOrderTaxLine.new(amount,
+                            rate,
+                            country_code,
+                            name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, country_code: #{@country_code}, name: #{@name}, rate:"\
+      " #{@rate}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, country_code: #{@country_code.inspect}, name:"\
+      " #{@name.inspect}, rate: #{@rate.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_tax_method_enum.rb

@@ -0,0 +1,36 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Method of calculation of the taxes, can be vat_included or vat_excluded.
+  class SalesOrderTaxMethodEnum
+    SALES_ORDER_TAX_METHOD_ENUM = [
+      # TODO: Write general description for VAT_INCLUDED
+      VAT_INCLUDED = 'vat_included'.freeze,
+
+      # TODO: Write general description for VAT_EXCLUDED
+      VAT_EXCLUDED = 'vat_excluded'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SALES_ORDER_TAX_METHOD_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = VAT_INCLUDED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'vat_included' then VAT_INCLUDED
+      when 'vat_excluded' then VAT_EXCLUDED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_totals.rb

@@ -0,0 +1,121 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SalesOrderTotals Model.
+  class SalesOrderTotals < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The applied discount to the entire order.
+    # @return [Float]
+    attr_accessor :discount
+
+    # The amount paid for gift wrapping.
+    # @return [Float]
+    attr_accessor :gift_wrapping
+
+    # The gross price of the order, is the sum of all product item gross prices.
+    # @return [Float]
+    attr_accessor :gross
+
+    # The net price of the order, is the sum of all product item net prices.
+    # @return [Float]
+    attr_accessor :net
+
+    # The shipping amount.
+    # @return [Float]
+    attr_accessor :shipping
+
+    # The taxes of the order, is the sum of all product item taxes.
+    # @return [Float]
+    attr_accessor :tax
+
+    # The total amount that the customer paid including shipping costs, taxes,
+    # gift_wrapping and any discounts.
+    # @return [Float]
+    attr_accessor :total
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['discount'] = 'discount'
+      @_hash['gift_wrapping'] = 'gift_wrapping'
+      @_hash['gross'] = 'gross'
+      @_hash['net'] = 'net'
+      @_hash['shipping'] = 'shipping'
+      @_hash['tax'] = 'tax'
+      @_hash['total'] = 'total'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        discount
+        gift_wrapping
+        gross
+        net
+        shipping
+        tax
+        total
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(discount = SKIP, gift_wrapping = SKIP, gross = SKIP,
+                   net = SKIP, shipping = SKIP, tax = SKIP, total = SKIP)
+      @discount = discount unless discount == SKIP
+      @gift_wrapping = gift_wrapping unless gift_wrapping == SKIP
+      @gross = gross unless gross == SKIP
+      @net = net unless net == SKIP
+      @shipping = shipping unless shipping == SKIP
+      @tax = tax unless tax == SKIP
+      @total = total unless total == 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.
+      discount = hash.key?('discount') ? hash['discount'] : SKIP
+      gift_wrapping = hash.key?('gift_wrapping') ? hash['gift_wrapping'] : SKIP
+      gross = hash.key?('gross') ? hash['gross'] : SKIP
+      net = hash.key?('net') ? hash['net'] : SKIP
+      shipping = hash.key?('shipping') ? hash['shipping'] : SKIP
+      tax = hash.key?('tax') ? hash['tax'] : SKIP
+      total = hash.key?('total') ? hash['total'] : SKIP
+
+      # Create object from extracted values.
+      SalesOrderTotals.new(discount,
+                           gift_wrapping,
+                           gross,
+                           net,
+                           shipping,
+                           tax,
+                           total)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} discount: #{@discount}, gift_wrapping: #{@gift_wrapping}, gross: #{@gross},"\
+      " net: #{@net}, shipping: #{@shipping}, tax: #{@tax}, total: #{@total}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} discount: #{@discount.inspect}, gift_wrapping: #{@gift_wrapping.inspect},"\
+      " gross: #{@gross.inspect}, net: #{@net.inspect}, shipping: #{@shipping.inspect}, tax:"\
+      " #{@tax.inspect}, total: #{@total.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_v2.rb

@@ -0,0 +1,247 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # SalesOrderV2 Model.
+  class SalesOrderV2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The information about the channel through which the order was placed.
+    # @return [Channel]
+    attr_accessor :channel
+
+    # Currency code (ISO 4217) used in internal accounting
+    # @return [String]
+    attr_accessor :currency
+
+    # Currency code (ISO 4217) used in internal accounting
+    # @return [SalesOrderCustomer]
+    attr_accessor :customer
+
+    # Extended attributes of the sales order item.
+    # @return [Array[SalesOrderExtendedAttribute]]
+    attr_accessor :extended_attributes
+
+    # The fulfillment type of the order. In case of mixed cart orders,
+    # fulfillment type is always 'multiple'
+    # @return [SalesOrderFulfillmentTypeEnum]
+    attr_accessor :fulfillment_type
+
+    # External ID of the order
+    # @return [String]
+    attr_accessor :id
+
+    # Set to true if order is historical.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_historical
+
+    # Set to true if order was created in offline mode.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_offline
+
+    # Set to true if order was created in offline mode.
+    # @return [Array[SalesOrderItemV2]]
+    attr_accessor :items
+
+    # Describes in which Order Management System the order originated from.
+    # @return [SalesOrderOriginEnum]
+    attr_accessor :origin
+
+    # The identifier of the order from the Order Management System where it
+    # originated from. If it originated in Newstore, it must be the identifier
+    # assigned to the order during the order creation process.
+    # @return [String]
+    attr_accessor :origin_id
+
+    # The time when the order was placed. It should follow
+    # https://tools.ietf.org/html/rfc3339 in UTC.
+    # @return [DateTime]
+    attr_accessor :placed_at
+
+    # Address
+    # @return [SalesOrderAddress]
+    attr_accessor :shipping_address
+
+    # Details about the shop the products belong to.
+    # @return [Shop]
+    attr_accessor :shop
+
+    # Current status of the sales order
+    # @return [SalesOrderStatusEnum]
+    attr_accessor :status
+
+    # Metadata about the tax of the order.
+    # @return [TaxInformation]
+    attr_accessor :tax_information
+
+    # Metadata about the tax of the order.
+    # @return [SalesOrderTotals]
+    attr_accessor :totals
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['channel'] = 'channel'
+      @_hash['currency'] = 'currency'
+      @_hash['customer'] = 'customer'
+      @_hash['extended_attributes'] = 'extended_attributes'
+      @_hash['fulfillment_type'] = 'fulfillment_type'
+      @_hash['id'] = 'id'
+      @_hash['is_historical'] = 'is_historical'
+      @_hash['is_offline'] = 'is_offline'
+      @_hash['items'] = 'items'
+      @_hash['origin'] = 'origin'
+      @_hash['origin_id'] = 'origin_id'
+      @_hash['placed_at'] = 'placed_at'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['shop'] = 'shop'
+      @_hash['status'] = 'status'
+      @_hash['tax_information'] = 'tax_information'
+      @_hash['totals'] = 'totals'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        extended_attributes
+        is_historical
+        is_offline
+        shipping_address
+        shop
+        tax_information
+        totals
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        extended_attributes
+      ]
+    end
+
+    def initialize(channel = nil, currency = nil, customer = nil,
+                   fulfillment_type = nil, id = nil, items = nil, origin = nil,
+                   origin_id = nil, placed_at = nil, status = nil,
+                   extended_attributes = SKIP, is_historical = SKIP,
+                   is_offline = SKIP, shipping_address = SKIP, shop = SKIP,
+                   tax_information = SKIP, totals = SKIP)
+      @channel = channel
+      @currency = currency
+      @customer = customer
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @fulfillment_type = fulfillment_type
+      @id = id
+      @is_historical = is_historical unless is_historical == SKIP
+      @is_offline = is_offline unless is_offline == SKIP
+      @items = items
+      @origin = origin
+      @origin_id = origin_id
+      @placed_at = placed_at
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @shop = shop unless shop == SKIP
+      @status = status
+      @tax_information = tax_information unless tax_information == SKIP
+      @totals = totals unless totals == 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.
+      channel = Channel.from_hash(hash['channel']) if hash['channel']
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      customer = SalesOrderCustomer.from_hash(hash['customer']) if hash['customer']
+      fulfillment_type =
+        hash.key?('fulfillment_type') ? hash['fulfillment_type'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (SalesOrderItemV2.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+      origin = hash.key?('origin') ? hash['origin'] : nil
+      origin_id = hash.key?('origin_id') ? hash['origin_id'] : nil
+      placed_at = if hash.key?('placed_at')
+                    (DateTimeHelper.from_rfc3339(hash['placed_at']) if hash['placed_at'])
+                  end
+      status = hash.key?('status') ? hash['status'] : 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 << (SalesOrderExtendedAttribute.from_hash(structure) if structure)
+        end
+      end
+
+      extended_attributes = SKIP unless hash.key?('extended_attributes')
+      is_historical = hash.key?('is_historical') ? hash['is_historical'] : SKIP
+      is_offline = hash.key?('is_offline') ? hash['is_offline'] : SKIP
+      shipping_address = SalesOrderAddress.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      shop = Shop.from_hash(hash['shop']) if hash['shop']
+      tax_information = TaxInformation.from_hash(hash['tax_information']) if
+        hash['tax_information']
+      totals = SalesOrderTotals.from_hash(hash['totals']) if hash['totals']
+
+      # Create object from extracted values.
+      SalesOrderV2.new(channel,
+                       currency,
+                       customer,
+                       fulfillment_type,
+                       id,
+                       items,
+                       origin,
+                       origin_id,
+                       placed_at,
+                       status,
+                       extended_attributes,
+                       is_historical,
+                       is_offline,
+                       shipping_address,
+                       shop,
+                       tax_information,
+                       totals)
+    end
+
+    def to_custom_placed_at
+      DateTimeHelper.to_rfc3339(placed_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} channel: #{@channel}, currency: #{@currency}, customer: #{@customer},"\
+      " extended_attributes: #{@extended_attributes}, fulfillment_type: #{@fulfillment_type}, id:"\
+      " #{@id}, is_historical: #{@is_historical}, is_offline: #{@is_offline}, items: #{@items},"\
+      " origin: #{@origin}, origin_id: #{@origin_id}, placed_at: #{@placed_at}, shipping_address:"\
+      " #{@shipping_address}, shop: #{@shop}, status: #{@status}, tax_information:"\
+      " #{@tax_information}, totals: #{@totals}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} channel: #{@channel.inspect}, currency: #{@currency.inspect}, customer:"\
+      " #{@customer.inspect}, extended_attributes: #{@extended_attributes.inspect},"\
+      " fulfillment_type: #{@fulfillment_type.inspect}, id: #{@id.inspect}, is_historical:"\
+      " #{@is_historical.inspect}, is_offline: #{@is_offline.inspect}, items: #{@items.inspect},"\
+      " origin: #{@origin.inspect}, origin_id: #{@origin_id.inspect}, placed_at:"\
+      " #{@placed_at.inspect}, shipping_address: #{@shipping_address.inspect}, shop:"\
+      " #{@shop.inspect}, status: #{@status.inspect}, tax_information:"\
+      " #{@tax_information.inspect}, totals: #{@totals.inspect}>"
+    end
+  end
+end

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

data/lib/new_store_api/models/schema_for_bulk_cancel_orders_request.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
+  # SchemaForBulkCancelOrdersRequest Model.
+  class SchemaForBulkCancelOrdersRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Optional note for cancellation
+    # @return [String]
+    attr_accessor :note
+
+    # List of order IDs to cancel
+    # @return [Array[String]]
+    attr_accessor :order_ids
+
+    # Reason for cancellation
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['note'] = 'note'
+      @_hash['order_ids'] = 'order_ids'
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        note
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(order_ids = nil, reason = nil, note = SKIP)
+      @note = note unless note == SKIP
+      @order_ids = order_ids
+      @reason = reason
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      order_ids = hash.key?('order_ids') ? hash['order_ids'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : nil
+      note = hash.key?('note') ? hash['note'] : SKIP
+
+      # Create object from extracted values.
+      SchemaForBulkCancelOrdersRequest.new(order_ids,
+                                           reason,
+                                           note)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} note: #{@note}, order_ids: #{@order_ids}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} note: #{@note.inspect}, order_ids: #{@order_ids.inspect}, reason:"\
+      " #{@reason.inspect}>"
+    end
+  end
+end