newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/package_option.rb

@@ -0,0 +1,72 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # PackageOption Model.
+  class PackageOption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PackageOptionDimensions]
+    attr_accessor :dimensions
+
+    # TODO: Write general description for this method
+    # @return [PackageOptionWeight]
+    attr_accessor :weight
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['dimensions'] = 'dimensions'
+      @_hash['weight'] = 'weight'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        dimensions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        dimensions
+      ]
+    end
+
+    def initialize(weight = nil, dimensions = SKIP)
+      @dimensions = dimensions unless dimensions == SKIP
+      @weight = weight
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      weight = PackageOptionWeight.from_hash(hash['weight']) if hash['weight']
+      dimensions = PackageOptionDimensions.from_hash(hash['dimensions']) if hash['dimensions']
+
+      # Create object from extracted values.
+      PackageOption.new(weight,
+                        dimensions)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} dimensions: #{@dimensions}, weight: #{@weight}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} dimensions: #{@dimensions.inspect}, weight: #{@weight.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/package_option_dimensions.rb

@@ -0,0 +1,85 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # PackageOptionDimensions Model.
+  class PackageOptionDimensions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :height
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :length
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :unit
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :width
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['height'] = 'height'
+      @_hash['length'] = 'length'
+      @_hash['unit'] = 'unit'
+      @_hash['width'] = 'width'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(height = nil, length = nil, unit = nil, width = nil)
+      @height = height
+      @length = length
+      @unit = unit
+      @width = width
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      height = hash.key?('height') ? hash['height'] : nil
+      length = hash.key?('length') ? hash['length'] : nil
+      unit = hash.key?('unit') ? hash['unit'] : nil
+      width = hash.key?('width') ? hash['width'] : nil
+
+      # Create object from extracted values.
+      PackageOptionDimensions.new(height,
+                                  length,
+                                  unit,
+                                  width)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} height: #{@height}, length: #{@length}, unit: #{@unit}, width: #{@width}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} height: #{@height.inspect}, length: #{@length.inspect}, unit:"\
+      " #{@unit.inspect}, width: #{@width.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/package_option_weight.rb

@@ -0,0 +1,68 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # PackageOptionWeight Model.
+  class PackageOptionWeight < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['unit'] = 'unit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, unit = nil)
+      @amount = amount
+      @unit = unit
+    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
+      unit = hash.key?('unit') ? hash['unit'] : nil
+
+      # Create object from extracted values.
+      PackageOptionWeight.new(amount,
+                              unit)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, unit: #{@unit}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, unit: #{@unit.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/package_tracking.rb

@@ -0,0 +1,104 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # PackageTracking Model.
+  class PackageTracking < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reason
+
+    # Set by Newstore. It is the time at which the event has been received on
+    # the endpoint.
+    # @return [String]
+    attr_accessor :received_at
+
+    # Set by Newstore. It is the time at which the event has been received on
+    # the endpoint.
+    # @return [TrackingStatusEnum]
+    attr_accessor :status
+
+    # Set by Newstore. It is the time at which the event has been received on
+    # the endpoint.
+    # @return [String]
+    attr_accessor :tracking_code
+
+    # Set by carrier. It is the time at which the event has been
+    # recorded/generated by the carrier.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash['received_at'] = 'received_at'
+      @_hash['status'] = 'status'
+      @_hash['tracking_code'] = 'tracking_code'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        reason
+      ]
+    end
+
+    def initialize(received_at = nil, status = nil, tracking_code = nil,
+                   updated_at = nil, reason = SKIP)
+      @reason = reason unless reason == SKIP
+      @received_at = received_at
+      @status = status
+      @tracking_code = tracking_code
+      @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.
+      received_at = hash.key?('received_at') ? hash['received_at'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      tracking_code = hash.key?('tracking_code') ? hash['tracking_code'] : nil
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create object from extracted values.
+      PackageTracking.new(received_at,
+                          status,
+                          tracking_code,
+                          updated_at,
+                          reason)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason}, received_at: #{@received_at}, status: #{@status},"\
+      " tracking_code: #{@tracking_code}, 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} reason: #{@reason.inspect}, received_at: #{@received_at.inspect}, status:"\
+      " #{@status.inspect}, tracking_code: #{@tracking_code.inspect}, updated_at:"\
+      " #{@updated_at.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/package_type_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
+  # A package type that is available for associates to select during the packing
+  # flow.
+  class PackageTypeResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The physical dimensions of a package type.
+    # @return [PackageDimensions]
+    attr_accessor :dimensions
+
+    # Unique identifier of the package type.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Display name shown to associates when selecting a package.
+    # @return [String]
+    attr_accessor :name
+
+    # The weight of a package type.
+    # @return [PackageWeight]
+    attr_accessor :weight
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['dimensions'] = 'dimensions'
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['weight'] = 'weight'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(dimensions = nil, id = nil, name = nil, weight = nil)
+      @dimensions = dimensions
+      @id = id
+      @name = name
+      @weight = weight
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      dimensions = PackageDimensions.from_hash(hash['dimensions']) if hash['dimensions']
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      weight = PackageWeight.from_hash(hash['weight']) if hash['weight']
+
+      # Create object from extracted values.
+      PackageTypeResponse.new(dimensions,
+                              id,
+                              name,
+                              weight)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} dimensions: #{@dimensions}, id: #{@id}, name: #{@name}, weight:"\
+      " #{@weight}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} dimensions: #{@dimensions.inspect}, id: #{@id.inspect}, name:"\
+      " #{@name.inspect}, weight: #{@weight.inspect}>"
+    end
+  end
+end

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

data/lib/new_store_api/models/package_weight.rb

@@ -0,0 +1,68 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The weight of a package type.
+  class PackageWeight < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Weight of the package.
+    # @return [Float]
+    attr_accessor :amount
+
+    # Unit of measurement for the weight.
+    # @return [WeightUnitEnum]
+    attr_accessor :unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['unit'] = 'unit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, unit = nil)
+      @amount = amount
+      @unit = unit
+    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
+      unit = hash.key?('unit') ? hash['unit'] : nil
+
+      # Create object from extracted values.
+      PackageWeight.new(amount,
+                        unit)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, unit: #{@unit}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, unit: #{@unit.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/packing_time_duration.rb

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

data/lib/new_store_api/models/paginated_response.rb

@@ -0,0 +1,77 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Contains default fields for paginatable APIs.
+  class PaginatedResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains the count of returned elements.
+    # @return [Integer]
+    attr_accessor :count
+
+    # Contains the current offset.
+    # @return [Integer]
+    attr_accessor :offset
+
+    # Contains the total count of elements.
+    # @return [Integer]
+    attr_accessor :total
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['count'] = 'count'
+      @_hash['offset'] = 'offset'
+      @_hash['total'] = 'total'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(count = nil, offset = nil, total = nil)
+      @count = count
+      @offset = offset
+      @total = total
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      count = hash.key?('count') ? hash['count'] : nil
+      offset = hash.key?('offset') ? hash['offset'] : nil
+      total = hash.key?('total') ? hash['total'] : nil
+
+      # Create object from extracted values.
+      PaginatedResponse.new(count,
+                            offset,
+                            total)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} count: #{@count}, offset: #{@offset}, total: #{@total}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} count: #{@count.inspect}, offset: #{@offset.inspect}, total:"\
+      " #{@total.inspect}>"
+    end
+  end
+end