newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/routing_insights.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
+  # Routing insights data by sales_order_uuid or external_id
+  class RoutingInsights < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Routing insights information for an order
+    # @return [RoutingInsightsData]
+    attr_accessor :insights
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['insights'] = 'insights'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(insights = nil)
+      @insights = insights
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      insights = RoutingInsightsData.from_hash(hash['insights']) if hash['insights']
+
+      # Create object from extracted values.
+      RoutingInsights.new(insights)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} insights: #{@insights}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} insights: #{@insights.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_insights_activity.rb

@@ -0,0 +1,141 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # RoutingInsightsActivity Model.
+  class RoutingInsightsActivity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Information regarding which entities were affected by this event
+    # @return [RoutingInsightsCorrelation]
+    attr_accessor :correlation
+
+    # Information regarding the event type
+    # @return [String]
+    attr_accessor :summary
+
+    # Information regarding the event type
+    # @return [DateTime]
+    attr_accessor :timestamp
+
+    # Event type
+    # @return [String]
+    attr_accessor :type
+
+    # Event type
+    # @return [Object]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['correlation'] = 'correlation'
+      @_hash['summary'] = 'summary'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['type'] = 'type'
+      @_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(correlation = nil, summary = nil, timestamp = nil,
+                   type = nil, value = nil)
+      @correlation = correlation
+      @summary = summary
+      @timestamp = timestamp
+      @type = type
+      @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.
+      correlation = RoutingInsightsCorrelation.from_hash(hash['correlation']) if
+        hash['correlation']
+      summary = hash.key?('summary') ? hash['summary'] : nil
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  end
+      type = hash.key?('type') ? hash['type'] : nil
+      value = hash.key?('value') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:RoutingInsightsActivityValue), hash['value']
+      ) : nil
+
+      # Create object from extracted values.
+      RoutingInsightsActivity.new(correlation,
+                                  summary,
+                                  timestamp,
+                                  type,
+                                  value)
+    end
+
+    def to_custom_timestamp
+      DateTimeHelper.to_rfc3339(timestamp)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RoutingInsightsActivity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.correlation,
+                                ->(val) { RoutingInsightsCorrelation.validate(val) },
+                                is_model_hash: true) and
+            APIHelper.valid_type?(value.summary,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.timestamp,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.type,
+                                  ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:RoutingInsightsActivityValue)
+                           .validate(value.value)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['correlation'],
+                              ->(val) { RoutingInsightsCorrelation.validate(val) },
+                              is_model_hash: true) and
+          APIHelper.valid_type?(value['summary'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['timestamp'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['type'],
+                                ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:RoutingInsightsActivityValue)
+                         .validate(value['value'])
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} correlation: #{@correlation}, summary: #{@summary}, timestamp:"\
+      " #{@timestamp}, type: #{@type}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} correlation: #{@correlation.inspect}, summary: #{@summary.inspect},"\
+      " timestamp: #{@timestamp.inspect}, type: #{@type.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_insights_correlation.rb

@@ -0,0 +1,163 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Information regarding which entities were affected by this event
+  class RoutingInsightsCorrelation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :ancestor_logistic_order_uuid
+
+    # Any fulfillment request identifiers for this LO uuid
+    # @return [RoutingInsightsFulfillmentRequests]
+    attr_accessor :fulfillment_request
+
+    # Any fulfillment request identifiers for this LO uuid
+    # @return [UUID | String]
+    attr_accessor :logistic_order_uuid
+
+    # Any fulfillment request identifiers for this LO uuid
+    # @return [RoutingInsightsRoutingStrategies]
+    attr_accessor :routing_strategies
+
+    # Any fulfillment request identifiers for this LO uuid
+    # @return [Array[UUID | String]]
+    attr_accessor :sales_order_item_ids
+
+    # Any fulfillment request identifiers for this LO uuid
+    # @return [RoutingInsightsServiceLevels]
+    attr_accessor :service_levels
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ancestor_logistic_order_uuid'] = 'ancestor_logistic_order_uuid'
+      @_hash['fulfillment_request'] = 'fulfillment_request'
+      @_hash['logistic_order_uuid'] = 'logistic_order_uuid'
+      @_hash['routing_strategies'] = 'routing_strategies'
+      @_hash['sales_order_item_ids'] = 'sales_order_item_ids'
+      @_hash['service_levels'] = 'service_levels'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        ancestor_logistic_order_uuid
+      ]
+    end
+
+    def initialize(ancestor_logistic_order_uuid = nil,
+                   fulfillment_request = nil, logistic_order_uuid = nil,
+                   routing_strategies = nil, sales_order_item_ids = nil,
+                   service_levels = nil)
+      @ancestor_logistic_order_uuid = ancestor_logistic_order_uuid
+      @fulfillment_request = fulfillment_request
+      @logistic_order_uuid = logistic_order_uuid
+      @routing_strategies = routing_strategies
+      @sales_order_item_ids = sales_order_item_ids
+      @service_levels = service_levels
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      ancestor_logistic_order_uuid =
+        hash.key?('ancestor_logistic_order_uuid') ? hash['ancestor_logistic_order_uuid'] : nil
+      if hash['fulfillment_request']
+        fulfillment_request = RoutingInsightsFulfillmentRequests.from_hash(hash['fulfillment_request'])
+      end
+      logistic_order_uuid =
+        hash.key?('logistic_order_uuid') ? hash['logistic_order_uuid'] : nil
+      routing_strategies = RoutingInsightsRoutingStrategies.from_hash(hash['routing_strategies']) if
+        hash['routing_strategies']
+      sales_order_item_ids =
+        hash.key?('sales_order_item_ids') ? hash['sales_order_item_ids'] : nil
+      service_levels = RoutingInsightsServiceLevels.from_hash(hash['service_levels']) if
+        hash['service_levels']
+
+      # Create object from extracted values.
+      RoutingInsightsCorrelation.new(ancestor_logistic_order_uuid,
+                                     fulfillment_request,
+                                     logistic_order_uuid,
+                                     routing_strategies,
+                                     sales_order_item_ids,
+                                     service_levels)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RoutingInsightsCorrelation | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.ancestor_logistic_order_uuid,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.fulfillment_request,
+                                  ->(val) { RoutingInsightsFulfillmentRequests.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.logistic_order_uuid,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.routing_strategies,
+                                  ->(val) { RoutingInsightsRoutingStrategies.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.sales_order_item_ids,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.service_levels,
+                                  ->(val) { RoutingInsightsServiceLevels.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['ancestor_logistic_order_uuid'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['fulfillment_request'],
+                                ->(val) { RoutingInsightsFulfillmentRequests.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['logistic_order_uuid'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['routing_strategies'],
+                                ->(val) { RoutingInsightsRoutingStrategies.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['sales_order_item_ids'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['service_levels'],
+                                ->(val) { RoutingInsightsServiceLevels.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ancestor_logistic_order_uuid: #{@ancestor_logistic_order_uuid},"\
+      " fulfillment_request: #{@fulfillment_request}, logistic_order_uuid:"\
+      " #{@logistic_order_uuid}, routing_strategies: #{@routing_strategies}, sales_order_item_ids:"\
+      " #{@sales_order_item_ids}, service_levels: #{@service_levels}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ancestor_logistic_order_uuid: #{@ancestor_logistic_order_uuid.inspect},"\
+      " fulfillment_request: #{@fulfillment_request.inspect}, logistic_order_uuid:"\
+      " #{@logistic_order_uuid.inspect}, routing_strategies: #{@routing_strategies.inspect},"\
+      " sales_order_item_ids: #{@sales_order_item_ids.inspect}, service_levels:"\
+      " #{@service_levels.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_insights_data.rb

@@ -0,0 +1,128 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # Routing insights information for an order
+  class RoutingInsightsData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[RoutingInsightsActivity]]
+    attr_accessor :activities
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :external_id
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :sales_order_id
+
+    # TODO: Write general description for this method
+    # @return [Array[UUID | String]]
+    attr_accessor :sales_order_item_ids
+
+    # A mapping of sales order item uuid to routing insights for this item
+    # @return [Hash[String, SalesOrderItems1]]
+    attr_accessor :sales_order_items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['activities'] = 'activities'
+      @_hash['created_at'] = 'created_at'
+      @_hash['external_id'] = 'external_id'
+      @_hash['sales_order_id'] = 'sales_order_id'
+      @_hash['sales_order_item_ids'] = 'sales_order_item_ids'
+      @_hash['sales_order_items'] = 'sales_order_items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(activities = nil, created_at = nil, external_id = nil,
+                   sales_order_id = nil, sales_order_item_ids = nil,
+                   sales_order_items = nil)
+      @activities = activities
+      @created_at = created_at
+      @external_id = external_id
+      @sales_order_id = sales_order_id
+      @sales_order_item_ids = sales_order_item_ids
+      @sales_order_items = sales_order_items
+    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
+      activities = nil
+      unless hash['activities'].nil?
+        activities = []
+        hash['activities'].each do |structure|
+          activities << (RoutingInsightsActivity.from_hash(structure) if structure)
+        end
+      end
+
+      activities = nil unless hash.key?('activities')
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      external_id = hash.key?('external_id') ? hash['external_id'] : nil
+      sales_order_id =
+        hash.key?('sales_order_id') ? hash['sales_order_id'] : nil
+      sales_order_item_ids =
+        hash.key?('sales_order_item_ids') ? hash['sales_order_item_ids'] : nil
+      sales_order_items = SalesOrderItems1.from_hash(hash['sales_order_items']) if
+        hash['sales_order_items']
+
+      sales_order_items = nil unless hash.key?('sales_order_items')
+
+      # Create object from extracted values.
+      RoutingInsightsData.new(activities,
+                              created_at,
+                              external_id,
+                              sales_order_id,
+                              sales_order_item_ids,
+                              sales_order_items)
+    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} activities: #{@activities}, created_at: #{@created_at}, external_id:"\
+      " #{@external_id}, sales_order_id: #{@sales_order_id}, sales_order_item_ids:"\
+      " #{@sales_order_item_ids}, sales_order_items: #{@sales_order_items}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} activities: #{@activities.inspect}, created_at: #{@created_at.inspect},"\
+      " external_id: #{@external_id.inspect}, sales_order_id: #{@sales_order_id.inspect},"\
+      " sales_order_item_ids: #{@sales_order_item_ids.inspect}, sales_order_items:"\
+      " #{@sales_order_items.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_insights_fulfillment_requests.rb

@@ -0,0 +1,109 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # Any fulfillment request identifiers for this LO uuid
+  class RoutingInsightsFulfillmentRequests < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :dispatched_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :fulfillment_node_id
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :fulfillment_request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['dispatched_at'] = 'dispatched_at'
+      @_hash['fulfillment_node_id'] = 'fulfillment_node_id'
+      @_hash['fulfillment_request_id'] = 'fulfillment_request_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        dispatched_at
+        fulfillment_node_id
+        fulfillment_request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        dispatched_at
+        fulfillment_node_id
+        fulfillment_request_id
+      ]
+    end
+
+    def initialize(dispatched_at = SKIP, fulfillment_node_id = SKIP,
+                   fulfillment_request_id = SKIP)
+      @dispatched_at = dispatched_at unless dispatched_at == SKIP
+      @fulfillment_node_id = fulfillment_node_id unless fulfillment_node_id == SKIP
+      @fulfillment_request_id = fulfillment_request_id unless fulfillment_request_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.
+      dispatched_at = if hash.key?('dispatched_at')
+                        (DateTimeHelper.from_rfc3339(hash['dispatched_at']) if hash['dispatched_at'])
+                      else
+                        SKIP
+                      end
+      fulfillment_node_id =
+        hash.key?('fulfillment_node_id') ? hash['fulfillment_node_id'] : SKIP
+      fulfillment_request_id =
+        hash.key?('fulfillment_request_id') ? hash['fulfillment_request_id'] : SKIP
+
+      # Create object from extracted values.
+      RoutingInsightsFulfillmentRequests.new(dispatched_at,
+                                             fulfillment_node_id,
+                                             fulfillment_request_id)
+    end
+
+    def to_custom_dispatched_at
+      DateTimeHelper.to_rfc3339(dispatched_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RoutingInsightsFulfillmentRequests | 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} dispatched_at: #{@dispatched_at}, fulfillment_node_id:"\
+      " #{@fulfillment_node_id}, fulfillment_request_id: #{@fulfillment_request_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} dispatched_at: #{@dispatched_at.inspect}, fulfillment_node_id:"\
+      " #{@fulfillment_node_id.inspect}, fulfillment_request_id:"\
+      " #{@fulfillment_request_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_insights_routing_strategies.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
+  # RoutingInsightsRoutingStrategies Model.
+  class RoutingInsightsRoutingStrategies < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The routing strategy for each item id in this LO
+    # @return [Hash[String, RoutingInsightsRoutingStrategy1]]
+    attr_accessor :current
+
+    # The routing strategy for each item id in this LO
+    # @return [Hash[String, RoutingInsightsRoutingStrategy1]]
+    attr_accessor :original
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['current'] = 'current'
+      @_hash['original'] = 'original'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        current
+        original
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(current = SKIP, original = SKIP)
+      @current = current unless current == SKIP
+      @original = original unless original == 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.
+      current = RoutingInsightsRoutingStrategy1.from_hash(hash['current']) if hash['current']
+
+      current = SKIP unless hash.key?('current')
+      original = RoutingInsightsRoutingStrategy1.from_hash(hash['original']) if hash['original']
+
+      original = SKIP unless hash.key?('original')
+
+      # Create object from extracted values.
+      RoutingInsightsRoutingStrategies.new(current,
+                                           original)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RoutingInsightsRoutingStrategies | 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} current: #{@current}, original: #{@original}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} current: #{@current.inspect}, original: #{@original.inspect}>"
+    end
+  end
+end