walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/refinements.rb

@@ -0,0 +1,107 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Refinements Model.
+  class Refinements < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Department]]
+    attr_accessor :departments
+
+    # TODO: Write general description for this method
+    # @return [Array[ClassificationRefinement]]
+    attr_accessor :classification_refinements
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['departments'] = 'departments'
+      @_hash['classification_refinements'] = 'classificationRefinements'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        departments
+        classification_refinements
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(departments: SKIP, classification_refinements: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @departments = departments unless departments == SKIP
+      unless classification_refinements == SKIP
+        @classification_refinements =
+          classification_refinements
+      end
+      @additional_properties = additional_properties
+    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
+      departments = nil
+      unless hash['departments'].nil?
+        departments = []
+        hash['departments'].each do |structure|
+          departments << (Department.from_hash(structure) if structure)
+        end
+      end
+
+      departments = SKIP unless hash.key?('departments')
+      # Parameter is an array, so we need to iterate through it
+      classification_refinements = nil
+      unless hash['classificationRefinements'].nil?
+        classification_refinements = []
+        hash['classificationRefinements'].each do |structure|
+          classification_refinements << (ClassificationRefinement.from_hash(structure) if structure)
+        end
+      end
+
+      classification_refinements = SKIP unless hash.key?('classificationRefinements')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Refinements.new(departments: departments,
+                      classification_refinements: classification_refinements,
+                      additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} departments: #{@departments}, classification_refinements:"\
+      " #{@classification_refinements}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} departments: #{@departments.inspect}, classification_refinements:"\
+      " #{@classification_refinements.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/refund_order_line.rb

@@ -0,0 +1,106 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # RefundOrderLine Model.
+  class RefundOrderLine < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :line_number
+
+    # TODO: Write general description for this method
+    # @return [Money]
+    attr_accessor :refund_amount
+
+    # Why the refund is being issued. Compressed from gmp-orders-mono's
+    # 22-entry `RefundReason` enum to the three classes that actually
+    # drive downstream behaviour today (return-flow vs cancel-flow vs
+    # goodwill-credit). Free-form sub-reason goes in `reason`.
+    # @return [RefundType]
+    attr_accessor :refund_type
+
+    # Optional free-form note (e.g. "item arrived damaged").
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line_number'] = 'lineNumber'
+      @_hash['refund_amount'] = 'refundAmount'
+      @_hash['refund_type'] = 'refundType'
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line_number:, refund_amount:, refund_type:, reason: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @line_number = line_number
+      @refund_amount = refund_amount
+      @refund_type = refund_type
+      @reason = reason unless reason == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      line_number = hash.key?('lineNumber') ? hash['lineNumber'] : nil
+      refund_amount = Money.from_hash(hash['refundAmount']) if hash['refundAmount']
+      refund_type = hash.key?('refundType') ? hash['refundType'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      RefundOrderLine.new(line_number: line_number,
+                          refund_amount: refund_amount,
+                          refund_type: refund_type,
+                          reason: reason,
+                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line_number: #{@line_number}, refund_amount: #{@refund_amount},"\
+      " refund_type: #{@refund_type}, reason: #{@reason}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line_number: #{@line_number.inspect}, refund_amount:"\
+      " #{@refund_amount.inspect}, refund_type: #{@refund_type.inspect}, reason:"\
+      " #{@reason.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/refund_order_lines_request.rb

@@ -0,0 +1,83 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # RefundOrderLinesRequest Model.
+  class RefundOrderLinesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[RefundOrderLine]]
+    attr_accessor :order_lines
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['order_lines'] = 'orderLines'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(order_lines:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @order_lines = order_lines
+      @additional_properties = additional_properties
+    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
+      order_lines = nil
+      unless hash['orderLines'].nil?
+        order_lines = []
+        hash['orderLines'].each do |structure|
+          order_lines << (RefundOrderLine.from_hash(structure) if structure)
+        end
+      end
+
+      order_lines = nil unless hash.key?('orderLines')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      RefundOrderLinesRequest.new(order_lines: order_lines,
+                                  additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_lines: #{@order_lines}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_lines: #{@order_lines.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/refund_order_lines_response.rb

@@ -0,0 +1,110 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # RefundOrderLinesResponse Model.
+  class RefundOrderLinesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :purchase_order_id
+
+    # Seller-visible refund handle, generated server-side. Stable
+    # for the lifetime of the refund; future GET endpoints will
+    # accept it as a path variable.
+    # @return [String]
+    attr_accessor :refund_id
+
+    # Seller-visible refund handle, generated server-side. Stable
+    # for the lifetime of the refund; future GET endpoints will
+    # accept it as a path variable.
+    # @return [DateTime]
+    attr_accessor :refunded_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['purchase_order_id'] = 'purchaseOrderId'
+      @_hash['refund_id'] = 'refundId'
+      @_hash['refunded_at'] = 'refundedAt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        purchase_order_id
+        refund_id
+        refunded_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(purchase_order_id: SKIP, refund_id: SKIP, refunded_at: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @purchase_order_id = purchase_order_id unless purchase_order_id == SKIP
+      @refund_id = refund_id unless refund_id == SKIP
+      @refunded_at = refunded_at unless refunded_at == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      purchase_order_id =
+        hash.key?('purchaseOrderId') ? hash['purchaseOrderId'] : SKIP
+      refund_id = hash.key?('refundId') ? hash['refundId'] : SKIP
+      refunded_at = if hash.key?('refundedAt')
+                      (DateTimeHelper.from_rfc3339(hash['refundedAt']) if hash['refundedAt'])
+                    else
+                      SKIP
+                    end
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      RefundOrderLinesResponse.new(purchase_order_id: purchase_order_id,
+                                   refund_id: refund_id,
+                                   refunded_at: refunded_at,
+                                   additional_properties: additional_properties)
+    end
+
+    def to_custom_refunded_at
+      DateTimeHelper.to_rfc3339(refunded_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} purchase_order_id: #{@purchase_order_id}, refund_id: #{@refund_id},"\
+      " refunded_at: #{@refunded_at}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} purchase_order_id: #{@purchase_order_id.inspect}, refund_id:"\
+      " #{@refund_id.inspect}, refunded_at: #{@refunded_at.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/refund_type.rb

@@ -0,0 +1,43 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Why the refund is being issued. Compressed from gmp-orders-mono's 22-entry
+  # `RefundReason` enum to the three classes that actually drive downstream
+  # behaviour today (return-flow vs cancel-flow vs goodwill-credit). Free-form
+  # sub-reason goes in `reason`.
+  class RefundType
+    REFUND_TYPE = [
+      # TODO: Write general description for RETURN
+      RETURN = 'RETURN'.freeze,
+
+      # TODO: Write general description for CANCELLATION
+      CANCELLATION = 'CANCELLATION'.freeze,
+
+      # TODO: Write general description for GOODWILL
+      GOODWILL = 'GOODWILL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REFUND_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = RETURN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'return' then RETURN
+      when 'cancellation' then CANCELLATION
+      when 'goodwill' then GOODWILL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/region.rb

@@ -0,0 +1,95 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Representation of a location used within the inbounding experience.
+  class Region < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO 3166 standard alpha-2 country code.
+    # @return [String]
+    attr_accessor :country_code
+
+    # State.
+    # @return [String]
+    attr_accessor :state
+
+    # An identifier for a Ship Node.
+    # @return [String]
+    attr_accessor :warehouse_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country_code'] = 'countryCode'
+      @_hash['state'] = 'state'
+      @_hash['warehouse_id'] = 'warehouseId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        country_code
+        state
+        warehouse_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country_code: SKIP, state: SKIP, warehouse_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @country_code = country_code unless country_code == SKIP
+      @state = state unless state == SKIP
+      @warehouse_id = warehouse_id unless warehouse_id == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      country_code = hash.key?('countryCode') ? hash['countryCode'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      warehouse_id = hash.key?('warehouseId') ? hash['warehouseId'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Region.new(country_code: country_code,
+                 state: state,
+                 warehouse_id: warehouse_id,
+                 additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country_code: #{@country_code}, state: #{@state}, warehouse_id:"\
+      " #{@warehouse_id}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country_code: #{@country_code.inspect}, state: #{@state.inspect},"\
+      " warehouse_id: #{@warehouse_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/regulated_category.rb

@@ -0,0 +1,49 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Top-level category of regulation that applies. NOT_REGULATED means no
+  # verification is required and the rest of the fields are informational only.
+  class RegulatedCategory
+    REGULATED_CATEGORY = [
+      # TODO: Write general description for NOT_REGULATED
+      NOT_REGULATED = 'NOT_REGULATED'.freeze,
+
+      # TODO: Write general description for ALCOHOL
+      ALCOHOL = 'ALCOHOL'.freeze,
+
+      # TODO: Write general description for TOBACCO
+      TOBACCO = 'TOBACCO'.freeze,
+
+      # TODO: Write general description for AGE_RESTRICTED
+      AGE_RESTRICTED = 'AGE_RESTRICTED'.freeze,
+
+      # TODO: Write general description for PHARMACY
+      PHARMACY = 'PHARMACY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REGULATED_CATEGORY.include?(value)
+    end
+
+    def self.from_value(value, default_value = NOT_REGULATED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'not_regulated' then NOT_REGULATED
+      when 'alcohol' then ALCOHOL
+      when 'tobacco' then TOBACCO
+      when 'age_restricted' then AGE_RESTRICTED
+      when 'pharmacy' then PHARMACY
+      else
+        default_value
+      end
+    end
+  end
+end