walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/token_request.rb

@@ -0,0 +1,152 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Form-encoded token request. Fields required depend on `grant_type`:
+  # `client_credentials` (client auth only), `authorization_code` (`code` +
+  # `code_verifier`), `refresh_token` (`refresh_token`).
+  class TokenRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The OAuth grant type.
+    # @return [GrantType]
+    attr_accessor :grant_type
+
+    # Client identifier (client_secret_post / public clients). Omit if using
+    # HTTP Basic.
+    # @return [String]
+    attr_accessor :client_id
+
+    # Client secret (client_secret_post). Omit for public clients or HTTP Basic.
+    # @return [String]
+    attr_accessor :client_secret
+
+    # Authorization code from `/auth/v4/authorize` (authorization_code grant).
+    # @return [String]
+    attr_accessor :code
+
+    # PKCE verifier whose S256 hash equals the earlier `code_challenge`
+    # (authorization_code grant).
+    # @return [String]
+    attr_accessor :code_verifier
+
+    # A previously issued refresh token (refresh_token grant). Rotated on use.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # Accepted for OAuth 2.0 back-compat on authorization_code; not required in
+    # 2.1 (PKCE covers injection).
+    # @return [String]
+    attr_accessor :redirect_uri
+
+    # **client_credentials:** accepted for compatibility but **not honored**
+    # (ADR-012) — no down-scoping; not echoed. **refresh_token:** optional;
+    # MUST NOT exceed the originally granted scope.
+    # @return [String]
+    attr_accessor :scope
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grant_type'] = 'grant_type'
+      @_hash['client_id'] = 'client_id'
+      @_hash['client_secret'] = 'client_secret'
+      @_hash['code'] = 'code'
+      @_hash['code_verifier'] = 'code_verifier'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash['redirect_uri'] = 'redirect_uri'
+      @_hash['scope'] = 'scope'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        client_secret
+        code
+        code_verifier
+        refresh_token
+        redirect_uri
+        scope
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(grant_type:, client_id: SKIP, client_secret: SKIP,
+                   code: SKIP, code_verifier: SKIP, refresh_token: SKIP,
+                   redirect_uri: SKIP, scope: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @grant_type = grant_type
+      @client_id = client_id unless client_id == SKIP
+      @client_secret = client_secret unless client_secret == SKIP
+      @code = code unless code == SKIP
+      @code_verifier = code_verifier unless code_verifier == SKIP
+      @refresh_token = refresh_token unless refresh_token == SKIP
+      @redirect_uri = redirect_uri unless redirect_uri == SKIP
+      @scope = scope unless scope == 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.
+      grant_type = hash.key?('grant_type') ? hash['grant_type'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      client_secret = hash.key?('client_secret') ? hash['client_secret'] : SKIP
+      code = hash.key?('code') ? hash['code'] : SKIP
+      code_verifier = hash.key?('code_verifier') ? hash['code_verifier'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+      redirect_uri = hash.key?('redirect_uri') ? hash['redirect_uri'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : 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.
+      TokenRequest.new(grant_type: grant_type,
+                       client_id: client_id,
+                       client_secret: client_secret,
+                       code: code,
+                       code_verifier: code_verifier,
+                       refresh_token: refresh_token,
+                       redirect_uri: redirect_uri,
+                       scope: scope,
+                       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} grant_type: #{@grant_type}, client_id: #{@client_id}, client_secret:"\
+      " #{@client_secret}, code: #{@code}, code_verifier: #{@code_verifier}, refresh_token:"\
+      " #{@refresh_token}, redirect_uri: #{@redirect_uri}, scope: #{@scope},"\
+      " 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} grant_type: #{@grant_type.inspect}, client_id: #{@client_id.inspect},"\
+      " client_secret: #{@client_secret.inspect}, code: #{@code.inspect}, code_verifier:"\
+      " #{@code_verifier.inspect}, refresh_token: #{@refresh_token.inspect}, redirect_uri:"\
+      " #{@redirect_uri.inspect}, scope: #{@scope.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/{value1.rb → token_response.rb}

@@ -1,101 +1,113 @@
-# walmart_ap_is
-#
-# This file was automatically generated by APIMATIC v3.0 (
-# https://www.apimatic.io ).
-
-module WalmartApIs
-  # Value1 Model.
-  class Value1 < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :access_token
-
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :refresh_token
-
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :token_type
-
-    # TODO: Write general description for this method
-    # @return [Integer]
-    attr_accessor :expires_in
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['access_token'] = 'access_token'
-      @_hash['refresh_token'] = 'refresh_token'
-      @_hash['token_type'] = 'token_type'
-      @_hash['expires_in'] = 'expires_in'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      []
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(access_token:, refresh_token:, token_type:, expires_in:,
-                   additional_properties: nil)
-      # Add additional model properties to the instance
-      additional_properties = {} if additional_properties.nil?
-
-      @access_token = access_token
-      @refresh_token = refresh_token
-      @token_type = token_type
-      @expires_in = expires_in
-      @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.
-      access_token = hash.key?('access_token') ? hash['access_token'] : nil
-      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : nil
-      token_type = hash.key?('token_type') ? hash['token_type'] : nil
-      expires_in = hash.key?('expires_in') ? hash['expires_in'] : nil
-
-      # 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.
-      Value1.new(access_token: access_token,
-                 refresh_token: refresh_token,
-                 token_type: token_type,
-                 expires_in: expires_in,
-                 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} access_token: #{@access_token}, refresh_token: #{@refresh_token},"\
-      " token_type: #{@token_type}, expires_in: #{@expires_in}, 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} access_token: #{@access_token.inspect}, refresh_token:"\
-      " #{@refresh_token.inspect}, token_type: #{@token_type.inspect}, expires_in:"\
-      " #{@expires_in.inspect}, additional_properties: #{@additional_properties}>"
-    end
-  end
-end
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # TokenResponse Model.
+  class TokenResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque Bearer access token. Treat as a secret; never log.
+    # @return [String]
+    attr_accessor :access_token
+
+    # Always `Bearer` (RFC 6750).
+    # @return [String]
+    attr_reader :token_type
+
+    # Access-token lifetime in seconds (≈900 today).
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # Rotated refresh token — replaces the one presented (OAuth 2.1 §4.3.1).
+    # Present only on delegated grants when `offline_access` was granted.
+    # Treat as a secret; never log.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # Space-delimited granted scopes; present on delegated grants when narrowed
+    # from the original grant.
+    # @return [String]
+    attr_accessor :scope
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['token_type'] = 'token_type'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash['scope'] = 'scope'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        refresh_token
+        scope
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, expires_in:, refresh_token: SKIP, scope: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @access_token = access_token
+      @token_type = 'Bearer'
+      @expires_in = expires_in
+      @refresh_token = refresh_token unless refresh_token == SKIP
+      @scope = scope unless scope == 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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : nil
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : 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.
+      TokenResponse.new(access_token: access_token,
+                        expires_in: expires_in,
+                        refresh_token: refresh_token,
+                        scope: scope,
+                        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} access_token: #{@access_token}, token_type: #{@token_type}, expires_in:"\
+      " #{@expires_in}, refresh_token: #{@refresh_token}, scope: #{@scope}, 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} access_token: #{@access_token.inspect}, token_type: #{@token_type.inspect},"\
+      " expires_in: #{@expires_in.inspect}, refresh_token: #{@refresh_token.inspect}, scope:"\
+      " #{@scope.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/tracking_details.rb

@@ -0,0 +1,90 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Tracking information for LTL and SPD shipments.
+  class TrackingDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains information related to Less-Than-Truckload (LTL) shipment
+    # tracking.
+    # @return [LtlTrackingDetail]
+    attr_accessor :ltl_tracking_detail
+
+    # Contains information related to Small Parcel Delivery (SPD) shipment
+    # tracking.
+    # @return [SpdTrackingDetail]
+    attr_accessor :spd_tracking_detail
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ltl_tracking_detail'] = 'ltlTrackingDetail'
+      @_hash['spd_tracking_detail'] = 'spdTrackingDetail'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ltl_tracking_detail
+        spd_tracking_detail
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ltl_tracking_detail: SKIP, spd_tracking_detail: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @ltl_tracking_detail = ltl_tracking_detail unless ltl_tracking_detail == SKIP
+      @spd_tracking_detail = spd_tracking_detail unless spd_tracking_detail == 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.
+      ltl_tracking_detail = LtlTrackingDetail.from_hash(hash['ltlTrackingDetail']) if
+        hash['ltlTrackingDetail']
+      spd_tracking_detail = SpdTrackingDetail.from_hash(hash['spdTrackingDetail']) if
+        hash['spdTrackingDetail']
+
+      # 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.
+      TrackingDetails.new(ltl_tracking_detail: ltl_tracking_detail,
+                          spd_tracking_detail: spd_tracking_detail,
+                          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} ltl_tracking_detail: #{@ltl_tracking_detail}, spd_tracking_detail:"\
+      " #{@spd_tracking_detail}, 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} ltl_tracking_detail: #{@ltl_tracking_detail.inspect}, spd_tracking_detail:"\
+      " #{@spd_tracking_detail.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/tracking_details_input.rb

@@ -0,0 +1,88 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Tracking information input for LTL and SPD shipments.
+  class TrackingDetailsInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains input information to update LTL tracking information.
+    # @return [LtlTrackingDetailInput]
+    attr_accessor :ltl_tracking_detail
+
+    # Contains input information to update SPD tracking information.
+    # @return [SpdTrackingDetailInput]
+    attr_accessor :spd_tracking_detail
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ltl_tracking_detail'] = 'ltlTrackingDetail'
+      @_hash['spd_tracking_detail'] = 'spdTrackingDetail'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ltl_tracking_detail
+        spd_tracking_detail
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ltl_tracking_detail: SKIP, spd_tracking_detail: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @ltl_tracking_detail = ltl_tracking_detail unless ltl_tracking_detail == SKIP
+      @spd_tracking_detail = spd_tracking_detail unless spd_tracking_detail == 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.
+      ltl_tracking_detail = LtlTrackingDetailInput.from_hash(hash['ltlTrackingDetail']) if
+        hash['ltlTrackingDetail']
+      spd_tracking_detail = SpdTrackingDetailInput.from_hash(hash['spdTrackingDetail']) if
+        hash['spdTrackingDetail']
+
+      # 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.
+      TrackingDetailsInput.new(ltl_tracking_detail: ltl_tracking_detail,
+                               spd_tracking_detail: spd_tracking_detail,
+                               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} ltl_tracking_detail: #{@ltl_tracking_detail}, spd_tracking_detail:"\
+      " #{@spd_tracking_detail}, 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} ltl_tracking_detail: #{@ltl_tracking_detail.inspect}, spd_tracking_detail:"\
+      " #{@spd_tracking_detail.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/tracking_info.rb

@@ -0,0 +1,111 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # TrackingInfo Model.
+  class TrackingInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CarrierName]
+    attr_accessor :carrier
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tracking_number
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :shipped_date
+
+    # TODO: Write general description for this method
+    # @return [MethodCode]
+    attr_accessor :method_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier'] = 'carrier'
+      @_hash['tracking_number'] = 'trackingNumber'
+      @_hash['shipped_date'] = 'shippedDate'
+      @_hash['method_code'] = 'methodCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        method_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(carrier:, tracking_number:, shipped_date:, method_code: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @carrier = carrier
+      @tracking_number = tracking_number
+      @shipped_date = shipped_date
+      @method_code = method_code unless method_code == 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.
+      carrier = hash.key?('carrier') ? hash['carrier'] : nil
+      tracking_number =
+        hash.key?('trackingNumber') ? hash['trackingNumber'] : nil
+      shipped_date = if hash.key?('shippedDate')
+                       (DateTimeHelper.from_rfc3339(hash['shippedDate']) if hash['shippedDate'])
+                     end
+      method_code = hash.key?('methodCode') ? hash['methodCode'] : 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.
+      TrackingInfo.new(carrier: carrier,
+                       tracking_number: tracking_number,
+                       shipped_date: shipped_date,
+                       method_code: method_code,
+                       additional_properties: additional_properties)
+    end
+
+    def to_custom_shipped_date
+      DateTimeHelper.to_rfc3339(shipped_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier: #{@carrier}, tracking_number: #{@tracking_number}, shipped_date:"\
+      " #{@shipped_date}, method_code: #{@method_code}, 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} carrier: #{@carrier.inspect}, tracking_number: #{@tracking_number.inspect},"\
+      " shipped_date: #{@shipped_date.inspect}, method_code: #{@method_code.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end