walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/query.rb

@@ -0,0 +1,161 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # Query Model.
+  class Query < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :query_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :query
+
+    # TODO: Write general description for this method
+    # @return [ProcessingStatus]
+    attr_accessor :processing_status
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # Present only when processingStatus is DONE
+    # @return [Array[DocumentSummary]]
+    attr_accessor :data_documents
+
+    # Present only when processingStatus is DONE
+    # @return [Pagination3]
+    attr_accessor :pagination
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['query_id'] = 'queryId'
+      @_hash['query'] = 'query'
+      @_hash['processing_status'] = 'processingStatus'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['updated_at'] = 'updatedAt'
+      @_hash['data_documents'] = 'dataDocuments'
+      @_hash['pagination'] = 'pagination'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        query
+        created_at
+        updated_at
+        data_documents
+        pagination
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(query_id:, processing_status:, query: SKIP, created_at: SKIP,
+                   updated_at: SKIP, data_documents: SKIP, pagination: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @query_id = query_id
+      @query = query unless query == SKIP
+      @processing_status = processing_status
+      @created_at = created_at unless created_at == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @data_documents = data_documents unless data_documents == SKIP
+      @pagination = pagination unless pagination == 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.
+      query_id = hash.key?('queryId') ? hash['queryId'] : nil
+      processing_status =
+        hash.key?('processingStatus') ? hash['processingStatus'] : nil
+      query = hash.key?('query') ? hash['query'] : SKIP
+      created_at = if hash.key?('createdAt')
+                     (DateTimeHelper.from_rfc3339(hash['createdAt']) if hash['createdAt'])
+                   else
+                     SKIP
+                   end
+      updated_at = if hash.key?('updatedAt')
+                     (DateTimeHelper.from_rfc3339(hash['updatedAt']) if hash['updatedAt'])
+                   else
+                     SKIP
+                   end
+      # Parameter is an array, so we need to iterate through it
+      data_documents = nil
+      unless hash['dataDocuments'].nil?
+        data_documents = []
+        hash['dataDocuments'].each do |structure|
+          data_documents << (DocumentSummary.from_hash(structure) if structure)
+        end
+      end
+
+      data_documents = SKIP unless hash.key?('dataDocuments')
+      pagination = Pagination3.from_hash(hash['pagination']) if hash['pagination']
+
+      # 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.
+      Query.new(query_id: query_id,
+                processing_status: processing_status,
+                query: query,
+                created_at: created_at,
+                updated_at: updated_at,
+                data_documents: data_documents,
+                pagination: pagination,
+                additional_properties: additional_properties)
+    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} query_id: #{@query_id}, query: #{@query}, processing_status:"\
+      " #{@processing_status}, created_at: #{@created_at}, updated_at: #{@updated_at},"\
+      " data_documents: #{@data_documents}, pagination: #{@pagination}, 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} query_id: #{@query_id.inspect}, query: #{@query.inspect},"\
+      " processing_status: #{@processing_status.inspect}, created_at: #{@created_at.inspect},"\
+      " updated_at: #{@updated_at.inspect}, data_documents: #{@data_documents.inspect},"\
+      " pagination: #{@pagination.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/quote.rb

@@ -0,0 +1,112 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # The estimated shipping cost associated with the transportation option.
+  class Quote < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type and amount of currency.
+    # @return [Currency]
+    attr_accessor :cost
+
+    # The time at which this transportation option quote expires. In ISO 8601
+    # datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.
+    # @return [DateTime]
+    attr_accessor :expiration
+
+    # Voidable until timestamp.
+    # @return [DateTime]
+    attr_accessor :voidable_until
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cost'] = 'cost'
+      @_hash['expiration'] = 'expiration'
+      @_hash['voidable_until'] = 'voidableUntil'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expiration
+        voidable_until
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cost:, expiration: SKIP, voidable_until: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cost = cost
+      @expiration = expiration unless expiration == SKIP
+      @voidable_until = voidable_until unless voidable_until == 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.
+      cost = Currency.from_hash(hash['cost']) if hash['cost']
+      expiration = if hash.key?('expiration')
+                     (DateTimeHelper.from_rfc3339(hash['expiration']) if hash['expiration'])
+                   else
+                     SKIP
+                   end
+      voidable_until = if hash.key?('voidableUntil')
+                         (DateTimeHelper.from_rfc3339(hash['voidableUntil']) if hash['voidableUntil'])
+                       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.
+      Quote.new(cost: cost,
+                expiration: expiration,
+                voidable_until: voidable_until,
+                additional_properties: additional_properties)
+    end
+
+    def to_custom_expiration
+      DateTimeHelper.to_rfc3339(expiration)
+    end
+
+    def to_custom_voidable_until
+      DateTimeHelper.to_rfc3339(voidable_until)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cost: #{@cost}, expiration: #{@expiration}, voidable_until:"\
+      " #{@voidable_until}, 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} cost: #{@cost.inspect}, expiration: #{@expiration.inspect}, voidable_until:"\
+      " #{@voidable_until.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/rate.rb

@@ -0,0 +1,179 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # Rate Model.
+  class Rate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :rate_id
+
+    # TODO: Write general description for this method
+    # @return [Carrier1]
+    attr_accessor :carrier
+
+    # TODO: Write general description for this method
+    # @return [Service]
+    attr_accessor :service
+
+    # TODO: Write general description for this method
+    # @return [Money]
+    attr_accessor :total_charge
+
+    # TODO: Write general description for this method
+    # @return [Weight1]
+    attr_accessor :billed_weight
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :expiration_time
+
+    # TODO: Write general description for this method
+    # @return [Promise]
+    attr_accessor :promise
+
+    # List of label/document formats supported by this rate.
+    # Each entry shape matches industry-standard
+    # SupportedDocumentSpecification; tier-1 fidelity is
+    # sufficient for v4 — see TODO at top of file.
+    # @return [Array[Object]]
+    attr_accessor :supported_document_specifications
+
+    # Value-added services available for purchase at this rate
+    # (signature, COD, dangerous goods, etc). Compressed shape;
+    # full fidelity tracked in a follow-up PR.
+    # @return [Array[Object]]
+    attr_accessor :available_value_added_services
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['rate_id'] = 'rateId'
+      @_hash['carrier'] = 'carrier'
+      @_hash['service'] = 'service'
+      @_hash['total_charge'] = 'totalCharge'
+      @_hash['billed_weight'] = 'billedWeight'
+      @_hash['expiration_time'] = 'expirationTime'
+      @_hash['promise'] = 'promise'
+      @_hash['supported_document_specifications'] =
+        'supportedDocumentSpecifications'
+      @_hash['available_value_added_services'] = 'availableValueAddedServices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        billed_weight
+        expiration_time
+        promise
+        supported_document_specifications
+        available_value_added_services
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(rate_id:, carrier:, service:, total_charge:,
+                   billed_weight: SKIP, expiration_time: SKIP, promise: SKIP,
+                   supported_document_specifications: SKIP,
+                   available_value_added_services: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @rate_id = rate_id
+      @carrier = carrier
+      @service = service
+      @total_charge = total_charge
+      @billed_weight = billed_weight unless billed_weight == SKIP
+      @expiration_time = expiration_time unless expiration_time == SKIP
+      @promise = promise unless promise == SKIP
+      unless supported_document_specifications == SKIP
+        @supported_document_specifications =
+          supported_document_specifications
+      end
+      unless available_value_added_services == SKIP
+        @available_value_added_services =
+          available_value_added_services
+      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.
+      rate_id = hash.key?('rateId') ? hash['rateId'] : nil
+      carrier = Carrier1.from_hash(hash['carrier']) if hash['carrier']
+      service = Service.from_hash(hash['service']) if hash['service']
+      total_charge = Money.from_hash(hash['totalCharge']) if hash['totalCharge']
+      billed_weight = Weight1.from_hash(hash['billedWeight']) if hash['billedWeight']
+      expiration_time = if hash.key?('expirationTime')
+                          (DateTimeHelper.from_rfc3339(hash['expirationTime']) if hash['expirationTime'])
+                        else
+                          SKIP
+                        end
+      promise = Promise.from_hash(hash['promise']) if hash['promise']
+      supported_document_specifications =
+        hash.key?('supportedDocumentSpecifications') ? hash['supportedDocumentSpecifications'] : SKIP
+      available_value_added_services =
+        hash.key?('availableValueAddedServices') ? hash['availableValueAddedServices'] : 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.
+      Rate.new(rate_id: rate_id,
+               carrier: carrier,
+               service: service,
+               total_charge: total_charge,
+               billed_weight: billed_weight,
+               expiration_time: expiration_time,
+               promise: promise,
+               supported_document_specifications: supported_document_specifications,
+               available_value_added_services: available_value_added_services,
+               additional_properties: additional_properties)
+    end
+
+    def to_custom_expiration_time
+      DateTimeHelper.to_rfc3339(expiration_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} rate_id: #{@rate_id}, carrier: #{@carrier}, service: #{@service},"\
+      " total_charge: #{@total_charge}, billed_weight: #{@billed_weight}, expiration_time:"\
+      " #{@expiration_time}, promise: #{@promise}, supported_document_specifications:"\
+      " #{@supported_document_specifications}, available_value_added_services:"\
+      " #{@available_value_added_services}, 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} rate_id: #{@rate_id.inspect}, carrier: #{@carrier.inspect}, service:"\
+      " #{@service.inspect}, total_charge: #{@total_charge.inspect}, billed_weight:"\
+      " #{@billed_weight.inspect}, expiration_time: #{@expiration_time.inspect}, promise:"\
+      " #{@promise.inspect}, supported_document_specifications:"\
+      " #{@supported_document_specifications.inspect}, available_value_added_services:"\
+      " #{@available_value_added_services.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/reason.rb

@@ -0,0 +1,102 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Reason Model.
+  class Reason < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Localized human-readable message explaining the restriction
+    # @return [String]
+    attr_accessor :message
+
+    # Localized human-readable message explaining the restriction
+    # @return [ReasonCode]
+    attr_accessor :reason_code
+
+    # Localized human-readable message explaining the restriction
+    # @return [Array[Link]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
+      @_hash['reason_code'] = 'reasonCode'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message:, reason_code:, links: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @message = message
+      @reason_code = reason_code
+      @links = links unless links == 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.
+      message = hash.key?('message') ? hash['message'] : nil
+      reason_code = hash.key?('reasonCode') ? hash['reasonCode'] : nil
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (Link.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+
+      # 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.
+      Reason.new(message: message,
+                 reason_code: reason_code,
+                 links: links,
+                 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} message: #{@message}, reason_code: #{@reason_code}, links: #{@links},"\
+      " 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} message: #{@message.inspect}, reason_code: #{@reason_code.inspect}, links:"\
+      " #{@links.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/reason_code.rb

@@ -0,0 +1,60 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # ReasonCode.
+  class ReasonCode
+    REASON_CODE = [
+      # TODO: Write general description for APPROVAL_REQUIRED
+      APPROVAL_REQUIRED = 'APPROVAL_REQUIRED'.freeze,
+
+      # TODO: Write general description for ASIN_NOT_APPLICABLE
+      ASIN_NOT_APPLICABLE = 'ASIN_NOT_APPLICABLE'.freeze,
+
+      # TODO: Write general description for NOT_ELIGIBLE
+      NOT_ELIGIBLE = 'NOT_ELIGIBLE'.freeze,
+
+      # TODO: Write general description for INELIGIBLE_ITEM_CONDITION
+      INELIGIBLE_ITEM_CONDITION = 'INELIGIBLE_ITEM_CONDITION'.freeze,
+
+      # TODO: Write general description for COMPLIANCE_BLOCKED
+      COMPLIANCE_BLOCKED = 'COMPLIANCE_BLOCKED'.freeze,
+
+      # TODO: Write general description for HAZMAT
+      HAZMAT = 'HAZMAT'.freeze,
+
+      # TODO: Write general description for RECALLED
+      RECALLED = 'RECALLED'.freeze,
+
+      # TODO: Write general description for RESTRICTED_CATEGORY
+      RESTRICTED_CATEGORY = 'RESTRICTED_CATEGORY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REASON_CODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = APPROVAL_REQUIRED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'approval_required' then APPROVAL_REQUIRED
+      when 'asin_not_applicable' then ASIN_NOT_APPLICABLE
+      when 'not_eligible' then NOT_ELIGIBLE
+      when 'ineligible_item_condition' then INELIGIBLE_ITEM_CONDITION
+      when 'compliance_blocked' then COMPLIANCE_BLOCKED
+      when 'hazmat' then HAZMAT
+      when 'recalled' then RECALLED
+      when 'restricted_category' then RESTRICTED_CATEGORY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/reason_comment.rb

@@ -0,0 +1,64 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Reason for cancelling or rescheduling a self-ship appointment.
+  class ReasonComment
+    REASON_COMMENT = [
+      # TODO: Write general description for APPOINTMENT_REQUESTED_BY_MISTAKE
+      APPOINTMENT_REQUESTED_BY_MISTAKE = 'APPOINTMENT_REQUESTED_BY_MISTAKE'.freeze,
+
+      # TODO: Write general description for VEHICLE_DELAY
+      VEHICLE_DELAY = 'VEHICLE_DELAY'.freeze,
+
+      # TODO: Write general description for SLOT_NOT_SUITABLE
+      SLOT_NOT_SUITABLE = 'SLOT_NOT_SUITABLE'.freeze,
+
+      # TODO: Write general description for OUTSIDE_CARRIER_BUSINESS_HOURS
+      OUTSIDE_CARRIER_BUSINESS_HOURS = 'OUTSIDE_CARRIER_BUSINESS_HOURS'.freeze,
+
+      # TODO: Write general description for UNFAVOURABLE_EXTERNAL_CONDITIONS
+      UNFAVOURABLE_EXTERNAL_CONDITIONS = 'UNFAVOURABLE_EXTERNAL_CONDITIONS'.freeze,
+
+      # TODO: Write general description for PROCUREMENT_DELAY
+      PROCUREMENT_DELAY = 'PROCUREMENT_DELAY'.freeze,
+
+      # TODO: Write general description for SHIPPING_PLAN_CHANGED
+      SHIPPING_PLAN_CHANGED = 'SHIPPING_PLAN_CHANGED'.freeze,
+
+      # TODO: Write general description for INCREASED_QUANTITY
+      INCREASED_QUANTITY = 'INCREASED_QUANTITY'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REASON_COMMENT.include?(value)
+    end
+
+    def self.from_value(value, default_value = APPOINTMENT_REQUESTED_BY_MISTAKE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'appointment_requested_by_mistake' then APPOINTMENT_REQUESTED_BY_MISTAKE
+      when 'vehicle_delay' then VEHICLE_DELAY
+      when 'slot_not_suitable' then SLOT_NOT_SUITABLE
+      when 'outside_carrier_business_hours' then OUTSIDE_CARRIER_BUSINESS_HOURS
+      when 'unfavourable_external_conditions' then UNFAVOURABLE_EXTERNAL_CONDITIONS
+      when 'procurement_delay' then PROCUREMENT_DELAY
+      when 'shipping_plan_changed' then SHIPPING_PLAN_CHANGED
+      when 'increased_quantity' then INCREASED_QUANTITY
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end