newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/address_response.rb

@@ -0,0 +1,189 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # AddressResponse Model.
+  class AddressResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the address.
+    # @return [String]
+    attr_accessor :id
+
+    # First line of the address. Typically, the street and house number.
+    # @return [String]
+    attr_accessor :address_line_1
+
+    # Second line of the address. Typically, the apartment number or PO box
+    # @return [String]
+    attr_accessor :address_line_2
+
+    # The city/town of the address.
+    # @return [String]
+    attr_accessor :city
+
+    # Company name.
+    # @return [String]
+    attr_accessor :company_name
+
+    # Phone number of the address.
+    # @return [String]
+    attr_accessor :contact_phone
+
+    # Country code in ISO 3166-1 alpha-2 format.
+    # @return [String]
+    attr_accessor :country_code
+
+    # Full name.
+    # @return [String]
+    attr_accessor :full_name
+
+    # State/province or region of the address.
+    # @return [String]
+    attr_accessor :state
+
+    # Postal code of the address.
+    # @return [String]
+    attr_accessor :zip_code
+
+    # Postal code of the address.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Postal code of the address.
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['address_line_1'] = 'address_line_1'
+      @_hash['address_line_2'] = 'address_line_2'
+      @_hash['city'] = 'city'
+      @_hash['company_name'] = 'company_name'
+      @_hash['contact_phone'] = 'contact_phone'
+      @_hash['country_code'] = 'country_code'
+      @_hash['full_name'] = 'full_name'
+      @_hash['state'] = 'state'
+      @_hash['zip_code'] = 'zip_code'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address_line_1
+        address_line_2
+        city
+        company_name
+        contact_phone
+        full_name
+        state
+        zip_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        company_name
+        contact_phone
+        state
+      ]
+    end
+
+    def initialize(id = nil, country_code = nil, created_at = nil,
+                   updated_at = nil, address_line_1 = SKIP,
+                   address_line_2 = SKIP, city = SKIP, company_name = SKIP,
+                   contact_phone = SKIP, full_name = SKIP, state = SKIP,
+                   zip_code = SKIP)
+      @id = id
+      @address_line_1 = address_line_1 unless address_line_1 == SKIP
+      @address_line_2 = address_line_2 unless address_line_2 == SKIP
+      @city = city unless city == SKIP
+      @company_name = company_name unless company_name == SKIP
+      @contact_phone = contact_phone unless contact_phone == SKIP
+      @country_code = country_code
+      @full_name = full_name unless full_name == SKIP
+      @state = state unless state == SKIP
+      @zip_code = zip_code unless zip_code == SKIP
+      @created_at = created_at
+      @updated_at = updated_at
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   end
+      address_line_1 =
+        hash.key?('address_line_1') ? hash['address_line_1'] : SKIP
+      address_line_2 =
+        hash.key?('address_line_2') ? hash['address_line_2'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      company_name = hash.key?('company_name') ? hash['company_name'] : SKIP
+      contact_phone = hash.key?('contact_phone') ? hash['contact_phone'] : SKIP
+      full_name = hash.key?('full_name') ? hash['full_name'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      zip_code = hash.key?('zip_code') ? hash['zip_code'] : SKIP
+
+      # Create object from extracted values.
+      AddressResponse.new(id,
+                          country_code,
+                          created_at,
+                          updated_at,
+                          address_line_1,
+                          address_line_2,
+                          city,
+                          company_name,
+                          contact_phone,
+                          full_name,
+                          state,
+                          zip_code)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, address_line_1: #{@address_line_1}, address_line_2:"\
+      " #{@address_line_2}, city: #{@city}, company_name: #{@company_name}, contact_phone:"\
+      " #{@contact_phone}, country_code: #{@country_code}, full_name: #{@full_name}, state:"\
+      " #{@state}, zip_code: #{@zip_code}, created_at: #{@created_at}, updated_at:"\
+      " #{@updated_at}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, address_line_1: #{@address_line_1.inspect},"\
+      " address_line_2: #{@address_line_2.inspect}, city: #{@city.inspect}, company_name:"\
+      " #{@company_name.inspect}, contact_phone: #{@contact_phone.inspect}, country_code:"\
+      " #{@country_code.inspect}, full_name: #{@full_name.inspect}, state: #{@state.inspect},"\
+      " zip_code: #{@zip_code.inspect}, created_at: #{@created_at.inspect}, updated_at:"\
+      " #{@updated_at.inspect}>"
+    end
+  end
+end

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

data/lib/new_store_api/models/allocation.rb

@@ -0,0 +1,85 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # Allocation Model.
+  class Allocation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Timestamp at which allocation was created
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # The uuid of the order item.
+    # @return [String]
+    attr_accessor :item_uuid
+
+    # The uuid of the order.
+    # @return [String]
+    attr_accessor :order_uuid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'created_at'
+      @_hash['item_uuid'] = 'item_uuid'
+      @_hash['order_uuid'] = 'order_uuid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(created_at = nil, item_uuid = nil, order_uuid = nil)
+      @created_at = created_at
+      @item_uuid = item_uuid
+      @order_uuid = order_uuid
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      item_uuid = hash.key?('item_uuid') ? hash['item_uuid'] : nil
+      order_uuid = hash.key?('order_uuid') ? hash['order_uuid'] : nil
+
+      # Create object from extracted values.
+      Allocation.new(created_at,
+                     item_uuid,
+                     order_uuid)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at}, item_uuid: #{@item_uuid}, order_uuid:"\
+      " #{@order_uuid}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at.inspect}, item_uuid: #{@item_uuid.inspect},"\
+      " order_uuid: #{@order_uuid.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/amount.rb

@@ -0,0 +1,69 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The amount consisting of value and currency
+  class Amount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Currency in the ISO 4217 Alpha-3-character format
+    # <https://www.iso.org/iso-4217-currency-codes.html>.
+    # @return [String]
+    attr_accessor :currency
+
+    # Monetary amount
+    # @return [Integer]
+    attr_accessor :subunits
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['subunits'] = 'subunits'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency = nil, subunits = nil)
+      @currency = currency
+      @subunits = subunits
+    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
+      subunits = hash.key?('subunits') ? hash['subunits'] : nil
+
+      # Create object from extracted values.
+      Amount.new(currency,
+                 subunits)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency}, subunits: #{@subunits}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency.inspect}, subunits: #{@subunits.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/application_enum.rb

@@ -0,0 +1,40 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Abbreviation of the application this permission belongs to.
+  class ApplicationEnum
+    APPLICATION_ENUM = [
+      # TODO: Write general description for NOM
+      NOM = 'nom'.freeze,
+
+      # TODO: Write general description for AA
+      AA = 'aa'.freeze,
+
+      # TODO: Write general description for MCP
+      MCP = 'mcp'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      APPLICATION_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = NOM)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'nom' then NOM
+      when 'aa' then AA
+      when 'mcp' then MCP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/atp_insights_response.rb

@@ -0,0 +1,135 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Limited response of valid request for fetching allocations by ATP keys.
+  class AtpInsightsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Allocations for the product with given product_id at the fulfillment node
+    # with given fulfillment_node_id. This request will limit the response to a
+    # maximum of 2000 allocations.
+    # @return [Array[Allocation]]
+    attr_accessor :allocations
+
+    # The fulfillment node ID of the store/warehouse.
+    # @return [String]
+    attr_accessor :fulfillment_node_id
+
+    # Future allocations for the product with given product_id at the
+    # fulfillment node with given fulfillment_node_id. This request will limit
+    # the response to a maximum of 2000 allocations.
+    # @return [Array[FutureAllocation]]
+    attr_accessor :future_allocations
+
+    # The product ID of the item.
+    # @return [String]
+    attr_accessor :product_id
+
+    # Reservations for the product with given product_id at the fulfillment node
+    # with given fulfillment_node_id. This request will limit the response to a
+    # maximum of 2000 reservations.
+    # @return [Array[Reservation]]
+    attr_accessor :reservations
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['allocations'] = 'allocations'
+      @_hash['fulfillment_node_id'] = 'fulfillment_node_id'
+      @_hash['future_allocations'] = 'future_allocations'
+      @_hash['product_id'] = 'product_id'
+      @_hash['reservations'] = 'reservations'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        future_allocations
+        reservations
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(allocations = nil, fulfillment_node_id = nil,
+                   product_id = nil, future_allocations = SKIP,
+                   reservations = SKIP)
+      @allocations = allocations
+      @fulfillment_node_id = fulfillment_node_id
+      @future_allocations = future_allocations unless future_allocations == SKIP
+      @product_id = product_id
+      @reservations = reservations unless reservations == 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.
+      # Parameter is an array, so we need to iterate through it
+      allocations = nil
+      unless hash['allocations'].nil?
+        allocations = []
+        hash['allocations'].each do |structure|
+          allocations << (Allocation.from_hash(structure) if structure)
+        end
+      end
+
+      allocations = nil unless hash.key?('allocations')
+      fulfillment_node_id =
+        hash.key?('fulfillment_node_id') ? hash['fulfillment_node_id'] : nil
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      future_allocations = nil
+      unless hash['future_allocations'].nil?
+        future_allocations = []
+        hash['future_allocations'].each do |structure|
+          future_allocations << (FutureAllocation.from_hash(structure) if structure)
+        end
+      end
+
+      future_allocations = SKIP unless hash.key?('future_allocations')
+      # Parameter is an array, so we need to iterate through it
+      reservations = nil
+      unless hash['reservations'].nil?
+        reservations = []
+        hash['reservations'].each do |structure|
+          reservations << (Reservation.from_hash(structure) if structure)
+        end
+      end
+
+      reservations = SKIP unless hash.key?('reservations')
+
+      # Create object from extracted values.
+      AtpInsightsResponse.new(allocations,
+                              fulfillment_node_id,
+                              product_id,
+                              future_allocations,
+                              reservations)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} allocations: #{@allocations}, fulfillment_node_id: #{@fulfillment_node_id},"\
+      " future_allocations: #{@future_allocations}, product_id: #{@product_id}, reservations:"\
+      " #{@reservations}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} allocations: #{@allocations.inspect}, fulfillment_node_id:"\
+      " #{@fulfillment_node_id.inspect}, future_allocations: #{@future_allocations.inspect},"\
+      " product_id: #{@product_id.inspect}, reservations: #{@reservations.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/atp_key.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
+  # ATP key is the combination of product id and fulfillment node id.
+  class AtpKey < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The id of the fulfillment node.
+    # @return [String]
+    attr_accessor :fulfillment_node_id
+
+    # The id of the product.
+    # @return [String]
+    attr_accessor :product_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fulfillment_node_id'] = 'fulfillment_node_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(fulfillment_node_id = nil, product_id = nil)
+      @fulfillment_node_id = fulfillment_node_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.
+      fulfillment_node_id =
+        hash.key?('fulfillment_node_id') ? hash['fulfillment_node_id'] : nil
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+
+      # Create object from extracted values.
+      AtpKey.new(fulfillment_node_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} fulfillment_node_id: #{@fulfillment_node_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} fulfillment_node_id: #{@fulfillment_node_id.inspect}, product_id:"\
+      " #{@product_id.inspect}>"
+    end
+  end
+end