newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/role.rb

@@ -0,0 +1,135 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # Needed for granting permissions per group not individually.
+  class Role < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Identifier of the role.
+    # @return [String]
+    attr_accessor :id
+
+    # The role is read-only and not editable.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_readonly
+
+    # Name of the role.
+    # @return [String]
+    attr_accessor :name
+
+    # List of permissions which are assigned to the role.
+    # @return [Array[Permission]]
+    attr_accessor :permissions
+
+    # List of permissions which are assigned to the role.
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'created_at'
+      @_hash['id'] = 'id'
+      @_hash['is_readonly'] = 'is_readonly'
+      @_hash['name'] = 'name'
+      @_hash['permissions'] = 'permissions'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_at
+        is_readonly
+        permissions
+        updated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil, name = nil, created_at = SKIP, is_readonly = SKIP,
+                   permissions = SKIP, updated_at = SKIP)
+      @created_at = created_at unless created_at == SKIP
+      @id = id
+      @is_readonly = is_readonly unless is_readonly == SKIP
+      @name = name
+      @permissions = permissions unless permissions == SKIP
+      @updated_at = updated_at unless updated_at == 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   else
+                     SKIP
+                   end
+      is_readonly = hash.key?('is_readonly') ? hash['is_readonly'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      permissions = nil
+      unless hash['permissions'].nil?
+        permissions = []
+        hash['permissions'].each do |structure|
+          permissions << (Permission.from_hash(structure) if structure)
+        end
+      end
+
+      permissions = SKIP unless hash.key?('permissions')
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   else
+                     SKIP
+                   end
+
+      # Create object from extracted values.
+      Role.new(id,
+               name,
+               created_at,
+               is_readonly,
+               permissions,
+               updated_at)
+    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} created_at: #{@created_at}, id: #{@id}, is_readonly: #{@is_readonly}, name:"\
+      " #{@name}, permissions: #{@permissions}, 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} created_at: #{@created_at.inspect}, id: #{@id.inspect}, is_readonly:"\
+      " #{@is_readonly.inspect}, name: #{@name.inspect}, permissions: #{@permissions.inspect},"\
+      " updated_at: #{@updated_at.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/role_item.rb

@@ -0,0 +1,98 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # Needed for granting permissions per group not individually.
+  class RoleItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the role.
+    # @return [String]
+    attr_accessor :id
+
+    # The role is read-only and not editable.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_readonly
+
+    # Name of the role.
+    # @return [String]
+    attr_accessor :name
+
+    # Name of the role.
+    # @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['is_readonly'] = 'is_readonly'
+      @_hash['name'] = 'name'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        is_readonly
+        updated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil, name = nil, is_readonly = SKIP, updated_at = SKIP)
+      @id = id
+      @is_readonly = is_readonly unless is_readonly == SKIP
+      @name = name
+      @updated_at = updated_at unless updated_at == 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      is_readonly = hash.key?('is_readonly') ? hash['is_readonly'] : SKIP
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   else
+                     SKIP
+                   end
+
+      # Create object from extracted values.
+      RoleItem.new(id,
+                   name,
+                   is_readonly,
+                   updated_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}, is_readonly: #{@is_readonly}, name: #{@name}, 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}, is_readonly: #{@is_readonly.inspect}, name:"\
+      " #{@name.inspect}, updated_at: #{@updated_at.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/route_to.rb

@@ -0,0 +1,76 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Contains the fulfillment node identifier where the sales order item should
+  # be routed to (used for manual routing action).
+  class RouteTo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The fulfillment node id where the sales_order_item should be routed to.
+    # @return [String]
+    attr_accessor :fulfillment_node_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
+    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)
+      @fulfillment_node_id = fulfillment_node_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
+
+      # Create object from extracted values.
+      RouteTo.new(fulfillment_node_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RouteTo | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.fulfillment_node_id,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['fulfillment_node_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} fulfillment_node_id: #{@fulfillment_node_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}>"
+    end
+  end
+end

data/lib/new_store_api/models/routes.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
+  # Routes Model.
+  class Routes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DestinationRegion1]
+    attr_accessor :destination_region
+
+    # This configuration mentions the service levels identifications and which
+    # location group will serve this region
+    # @return [Hash[String, Object]]
+    attr_accessor :fulfilled_by
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['destination_region'] = 'destination_region'
+      @_hash['fulfilled_by'] = 'fulfilled_by'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        destination_region
+        fulfilled_by
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(destination_region = SKIP, fulfilled_by = SKIP)
+      @destination_region = destination_region unless destination_region == SKIP
+      @fulfilled_by = fulfilled_by unless fulfilled_by == 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.
+      destination_region = DestinationRegion1.from_hash(hash['destination_region']) if
+        hash['destination_region']
+      fulfilled_by = hash.key?('fulfilled_by') ? hash['fulfilled_by'] : SKIP
+
+      # Create object from extracted values.
+      Routes.new(destination_region,
+                 fulfilled_by)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Routes | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} destination_region: #{@destination_region}, fulfilled_by:"\
+      " #{@fulfilled_by}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} destination_region: #{@destination_region.inspect}, fulfilled_by:"\
+      " #{@fulfilled_by.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routes_v1.rb

@@ -0,0 +1,75 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # RoutesV1 Model.
+  class RoutesV1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DestinationRegion]
+    attr_accessor :destination_region
+
+    # This configuration mentions the service levels identifications and which
+    # location group will serve this region
+    # @return [Hash[String, Object]]
+    attr_accessor :fulfilled_by
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['destination_region'] = 'destination_region'
+      @_hash['fulfilled_by'] = 'fulfilled_by'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        destination_region
+        fulfilled_by
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(destination_region = SKIP, fulfilled_by = SKIP)
+      @destination_region = destination_region unless destination_region == SKIP
+      @fulfilled_by = fulfilled_by unless fulfilled_by == 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.
+      destination_region = DestinationRegion.from_hash(hash['destination_region']) if
+        hash['destination_region']
+      fulfilled_by = hash.key?('fulfilled_by') ? hash['fulfilled_by'] : SKIP
+
+      # Create object from extracted values.
+      RoutesV1.new(destination_region,
+                   fulfilled_by)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} destination_region: #{@destination_region}, fulfilled_by:"\
+      " #{@fulfilled_by}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} destination_region: #{@destination_region.inspect}, fulfilled_by:"\
+      " #{@fulfilled_by.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_decision_trace.rb

@@ -0,0 +1,128 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Optional decision trace explaining how routing chose placements.
+  class RoutingDecisionTrace < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location weights after filters, sorted for display.
+    # @return [Object]
+    attr_accessor :after_filters_sorted_row
+
+    # Snapshot of fetcher inputs used for the simulation run.
+    # @return [Object]
+    attr_accessor :fetchers_snapshot
+
+    # Filter steps applied during routing.
+    # @return [Array[Object]]
+    attr_accessor :filter_steps
+
+    # Initial location weights before filters.
+    # @return [Object]
+    attr_accessor :initial_location_row
+
+    # Selected routing logic candidate in the decision trace.
+    # @return [RoutingDecisionTracePicked]
+    attr_accessor :picked
+
+    # Reducer steps applied to candidate routing results.
+    # @return [Array[Object]]
+    attr_accessor :reducer_steps
+
+    # Strategy execution details for the simulation.
+    # @return [Object]
+    attr_accessor :strategy
+
+    # Decision trace schema version.
+    # @return [Integer]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['after_filters_sorted_row'] = 'after_filters_sorted_row'
+      @_hash['fetchers_snapshot'] = 'fetchers_snapshot'
+      @_hash['filter_steps'] = 'filter_steps'
+      @_hash['initial_location_row'] = 'initial_location_row'
+      @_hash['picked'] = 'picked'
+      @_hash['reducer_steps'] = 'reducer_steps'
+      @_hash['strategy'] = 'strategy'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(after_filters_sorted_row = nil, fetchers_snapshot = nil,
+                   filter_steps = nil, initial_location_row = nil, picked = nil,
+                   reducer_steps = nil, strategy = nil, version = nil)
+      @after_filters_sorted_row = after_filters_sorted_row
+      @fetchers_snapshot = fetchers_snapshot
+      @filter_steps = filter_steps
+      @initial_location_row = initial_location_row
+      @picked = picked
+      @reducer_steps = reducer_steps
+      @strategy = strategy
+      @version = version
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      after_filters_sorted_row =
+        hash.key?('after_filters_sorted_row') ? hash['after_filters_sorted_row'] : nil
+      fetchers_snapshot =
+        hash.key?('fetchers_snapshot') ? hash['fetchers_snapshot'] : nil
+      filter_steps = hash.key?('filter_steps') ? hash['filter_steps'] : nil
+      initial_location_row =
+        hash.key?('initial_location_row') ? hash['initial_location_row'] : nil
+      picked = RoutingDecisionTracePicked.from_hash(hash['picked']) if hash['picked']
+      reducer_steps = hash.key?('reducer_steps') ? hash['reducer_steps'] : nil
+      strategy = hash.key?('strategy') ? hash['strategy'] : nil
+      version = hash.key?('version') ? hash['version'] : nil
+
+      # Create object from extracted values.
+      RoutingDecisionTrace.new(after_filters_sorted_row,
+                               fetchers_snapshot,
+                               filter_steps,
+                               initial_location_row,
+                               picked,
+                               reducer_steps,
+                               strategy,
+                               version)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} after_filters_sorted_row: #{@after_filters_sorted_row}, fetchers_snapshot:"\
+      " #{@fetchers_snapshot}, filter_steps: #{@filter_steps}, initial_location_row:"\
+      " #{@initial_location_row}, picked: #{@picked}, reducer_steps: #{@reducer_steps}, strategy:"\
+      " #{@strategy}, version: #{@version}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} after_filters_sorted_row: #{@after_filters_sorted_row.inspect},"\
+      " fetchers_snapshot: #{@fetchers_snapshot.inspect}, filter_steps: #{@filter_steps.inspect},"\
+      " initial_location_row: #{@initial_location_row.inspect}, picked: #{@picked.inspect},"\
+      " reducer_steps: #{@reducer_steps.inspect}, strategy: #{@strategy.inspect}, version:"\
+      " #{@version.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_decision_trace_picked.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
+  # Selected routing logic candidate in the decision trace.
+  class RoutingDecisionTracePicked < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the selected routing candidate.
+    # @return [String]
+    attr_accessor :candidate_id
+
+    # Human-readable label for the selected candidate.
+    # @return [String]
+    attr_accessor :label
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['candidate_id'] = 'candidate_id'
+      @_hash['label'] = 'label'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(candidate_id = nil, label = nil)
+      @candidate_id = candidate_id
+      @label = label
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      candidate_id = hash.key?('candidate_id') ? hash['candidate_id'] : nil
+      label = hash.key?('label') ? hash['label'] : nil
+
+      # Create object from extracted values.
+      RoutingDecisionTracePicked.new(candidate_id,
+                                     label)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} candidate_id: #{@candidate_id}, label: #{@label}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} candidate_id: #{@candidate_id.inspect}, label: #{@label.inspect}>"
+    end
+  end
+end