walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/http/auth/wallet_auth.rb

@@ -0,0 +1,156 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Utility class for OAuth 2 authorization and token management.
+  class WalletAuth < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'WalletAuth: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(wallet_auth_credentials, config)
+      @_oauth_client_id = wallet_auth_credentials.oauth_client_id unless
+        wallet_auth_credentials.nil? || wallet_auth_credentials.oauth_client_id.nil?
+      @_oauth_client_secret = wallet_auth_credentials.oauth_client_secret unless
+        wallet_auth_credentials.nil? || wallet_auth_credentials.oauth_client_secret.nil?
+      @_oauth_token = wallet_auth_credentials.oauth_token unless
+        wallet_auth_credentials.nil? || wallet_auth_credentials.oauth_token.nil?
+      @_oauth_scopes = wallet_auth_credentials.oauth_scopes unless
+        wallet_auth_credentials.nil? || wallet_auth_credentials.oauth_scopes.nil?
+      @_oauth_clock_skew = wallet_auth_credentials.oauth_clock_skew unless
+        wallet_auth_credentials.nil? || wallet_auth_credentials.oauth_clock_skew.nil?
+      @_oauth_token_provider = wallet_auth_credentials.oauth_token_provider unless
+        wallet_auth_credentials.nil? || wallet_auth_credentials.oauth_token_provider.nil?
+      @_oauth_on_token_update = wallet_auth_credentials.oauth_on_token_update unless
+        wallet_auth_credentials.nil? || wallet_auth_credentials.oauth_on_token_update.nil?
+      @_o_auth_api = OauthAuthorizationApi.new(config)
+      super({})
+    end
+
+    # Validates the oAuth token.
+    # @return [Boolean] true if the token is present and not expired.
+    def valid
+      @_oauth_token = get_token_from_provider
+      @_oauth_token.is_a?(OAuthToken) && !token_expired?(@_oauth_token)
+    end
+
+    # Builds the basic auth header for endpoints in the OAuth Authorization Controller.
+    # @return [String] The value of the Authentication header.
+    def build_basic_auth_header
+      "Basic #{AuthHelper.get_base64_encoded_value(@_oauth_client_id, @_oauth_client_secret)}"
+    end
+
+    # Fetches the token.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def fetch_token(additional_params: nil)
+      token = @_o_auth_api.request_token_wallet_auth(
+        build_basic_auth_header,
+        scope: !@_oauth_scopes.nil? ? Array(@_oauth_scopes).compact.join(' ') : @_oauth_scopes,
+        _field_parameters: additional_params
+      ).data
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    end
+
+    # Checks if OAuth token has expired.
+    # @param [OAuthToken] token The oAuth token instance.
+    # @return [Boolean] true if the token's expiry exist and also the token is expired, false otherwise.
+    def token_expired?(token)
+      token.respond_to?('expiry') && AuthHelper.token_expired?(token.expiry, @_oauth_clock_skew)
+    end
+
+    def apply(http_request)
+      auth_params = { 'Authorization' => "Bearer #{@_oauth_token.access_token}" }
+      AuthHelper.apply(auth_params, http_request.method(:add_header))
+    end
+
+    private
+
+    # This provides the OAuth Token from either the user configured callbacks or from default provider.
+    # @return [OAuthToken] The fetched oauth token.
+    def get_token_from_provider
+      return @_oauth_token if @_oauth_token && !token_expired?(@_oauth_token)
+
+      if @_o_auth_token_provider
+        o_auth_token = @_o_auth_token_provider.call(@_oauth_token, self)
+        @_o_auth_on_token_update&.call(o_auth_token)
+        return o_auth_token
+      end
+      begin
+        o_auth_token = fetch_token
+        @_o_auth_on_token_update&.call(o_auth_token)
+        o_auth_token
+      rescue ApiException
+        @_o_auth_token
+      end
+    end
+  end
+
+  # Data class for WalletAuthCredentials.
+  class WalletAuthCredentials
+    attr_reader :oauth_client_id, :oauth_client_secret, :oauth_token,
+                :oauth_scopes, :oauth_token_provider, :oauth_on_token_update,
+                :oauth_clock_skew
+
+    def initialize(oauth_client_id:, oauth_client_secret:, oauth_token: nil,
+                   oauth_scopes: nil, oauth_token_provider: nil,
+                   oauth_on_token_update: nil, oauth_clock_skew: 0)
+      raise ArgumentError, 'oauth_client_id cannot be nil' if oauth_client_id.nil?
+      raise ArgumentError, 'oauth_client_secret cannot be nil' if oauth_client_secret.nil?
+
+      @oauth_client_id = oauth_client_id
+      @oauth_client_secret = oauth_client_secret
+      @oauth_token = oauth_token
+      @oauth_scopes = oauth_scopes
+      @oauth_token_provider = oauth_token_provider
+      @oauth_on_token_update = oauth_on_token_update
+      @oauth_clock_skew = oauth_clock_skew
+    end
+
+    def self.from_env
+      oauth_client_id = ENV['WALLET_AUTH_OAUTH_CLIENT_ID']
+      oauth_client_secret = ENV['WALLET_AUTH_OAUTH_CLIENT_SECRET']
+      oauth_scopes = ENV['WALLET_AUTH_OAUTH_SCOPES']
+      oauth_clock_skew = ENV['WALLET_AUTH_OAUTH_CLOCK_SKEW']
+      all_nil = [
+        oauth_client_id,
+        oauth_client_secret
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(oauth_client_id: oauth_client_id,
+          oauth_client_secret: oauth_client_secret, oauth_scopes: oauth_scopes,
+          oauth_clock_skew: oauth_clock_skew)
+    end
+
+    def clone_with(oauth_client_id: nil, oauth_client_secret: nil,
+                   oauth_token: nil, oauth_scopes: nil,
+                   oauth_token_provider: nil, oauth_on_token_update: nil,
+                   oauth_clock_skew: nil)
+      oauth_client_id ||= self.oauth_client_id
+      oauth_client_secret ||= self.oauth_client_secret
+      oauth_token ||= self.oauth_token
+      oauth_scopes ||= self.oauth_scopes
+      oauth_token_provider ||= self.oauth_token_provider
+      oauth_on_token_update ||= self.oauth_on_token_update
+      oauth_clock_skew ||= self.oauth_clock_skew
+
+      WalletAuthCredentials.new(oauth_client_id: oauth_client_id,
+                                oauth_client_secret: oauth_client_secret,
+                                oauth_token: oauth_token,
+                                oauth_scopes: oauth_scopes,
+                                oauth_token_provider: oauth_token_provider,
+                                oauth_on_token_update: oauth_on_token_update,
+                                oauth_clock_skew: oauth_clock_skew)
+    end
+  end
+end

data/lib/walmart_ap_is/http/http_call_back.rb

@@ -1,10 +1,10 @@
-# walmart_ap_is
-#
-# This file was automatically generated by APIMATIC v3.0 (
-# https://www.apimatic.io ).
-
-module WalmartApIs
-  # HttpCallBack allows defining callables for pre and post API calls.
-  class HttpCallBack < CoreLibrary::HttpCallback
-  end
-end
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/walmart_ap_is/http/http_method_enum.rb

@@ -1,10 +1,10 @@
-# walmart_ap_is
-#
-# This file was automatically generated by APIMATIC v3.0 (
-# https://www.apimatic.io ).
-
-module WalmartApIs
-  # HTTP Methods Enumeration.
-  class HttpMethodEnum < CoreLibrary::HttpMethod
-  end
-end
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/walmart_ap_is/http/http_request.rb

@@ -1,10 +1,10 @@
-# walmart_ap_is
-#
-# This file was automatically generated by APIMATIC v3.0 (
-# https://www.apimatic.io ).
-
-module WalmartApIs
-  # Represents a single Http Request.
-  class HttpRequest < CoreLibrary::HttpRequest
-  end
-end
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/walmart_ap_is/http/http_response.rb

@@ -1,10 +1,10 @@
-# walmart_ap_is
-#
-# This file was automatically generated by APIMATIC v3.0 (
-# https://www.apimatic.io ).
-
-module WalmartApIs
-  # Http response received.
-  class HttpResponse < CoreLibrary::HttpResponse
-  end
-end
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/walmart_ap_is/http/proxy_settings.rb

@@ -1,8 +1,8 @@
-# walmart_ap_is
-#
-# This file was automatically generated by APIMATIC v3.0 (
-# https://www.apimatic.io ).
-
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
 module WalmartApIs
   ##
   # ProxySettings encapsulates HTTP proxy configuration for Faraday,

data/lib/walmart_ap_is/logging/configuration/api_logging_configuration.rb

@@ -1,8 +1,8 @@
-# walmart_ap_is
-#
-# This file was automatically generated by APIMATIC v3.0 (
-# https://www.apimatic.io ).
-
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
 module WalmartApIs
   # Initializes a new instance of RequestLoggingConfiguration.
   class RequestLoggingConfiguration < CoreLibrary::ApiRequestLoggingConfiguration

data/lib/walmart_ap_is/logging/sdk_logger.rb

@@ -1,8 +1,8 @@
-# walmart_ap_is
-#
-# This file was automatically generated by APIMATIC v3.0 (
-# https://www.apimatic.io ).
-
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
 module WalmartApIs
   # Represents the generic logger facade
   class AbstractLogger < Logger

data/lib/walmart_ap_is/models/access_point.rb

@@ -0,0 +1,125 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # AccessPoint Model.
+  class AccessPoint < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :access_point_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [Type11]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [Address2]
+    attr_accessor :address
+
+    # Per-day operating hours. Compressed shape; full
+    # DayOfWeekTimeMap fidelity tracked in a follow-up PR.
+    # @return [Object]
+    attr_accessor :operating_hours
+
+    # IANA timezone name (e.g. America/Los_Angeles).
+    # @return [String]
+    attr_accessor :timezone
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_point_id'] = 'accessPointId'
+      @_hash['name'] = 'name'
+      @_hash['type'] = 'type'
+      @_hash['address'] = 'address'
+      @_hash['operating_hours'] = 'operatingHours'
+      @_hash['timezone'] = 'timezone'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        operating_hours
+        timezone
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_point_id:, name:, address:, type: SKIP,
+                   operating_hours: SKIP, timezone: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @access_point_id = access_point_id
+      @name = name
+      @type = type unless type == SKIP
+      @address = address
+      @operating_hours = operating_hours unless operating_hours == SKIP
+      @timezone = timezone unless timezone == 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_point_id = hash.key?('accessPointId') ? hash['accessPointId'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      address = Address2.from_hash(hash['address']) if hash['address']
+      type = hash.key?('type') ? hash['type'] : SKIP
+      operating_hours =
+        hash.key?('operatingHours') ? hash['operatingHours'] : SKIP
+      timezone = hash.key?('timezone') ? hash['timezone'] : 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.
+      AccessPoint.new(access_point_id: access_point_id,
+                      name: name,
+                      address: address,
+                      type: type,
+                      operating_hours: operating_hours,
+                      timezone: timezone,
+                      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_point_id: #{@access_point_id}, name: #{@name}, type: #{@type},"\
+      " address: #{@address}, operating_hours: #{@operating_hours}, timezone: #{@timezone},"\
+      " 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_point_id: #{@access_point_id.inspect}, name: #{@name.inspect}, type:"\
+      " #{@type.inspect}, address: #{@address.inspect}, operating_hours:"\
+      " #{@operating_hours.inspect}, timezone: #{@timezone.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/account_status.rb

@@ -0,0 +1,40 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # AccountStatus.
+  class AccountStatus
+    ACCOUNT_STATUS = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'Active'.freeze,
+
+      # TODO: Write general description for INACTIVE
+      INACTIVE = 'Inactive'.freeze,
+
+      # TODO: Write general description for SUSPENDED
+      SUSPENDED = 'Suspended'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'inactive' then INACTIVE
+      when 'suspended' then SUSPENDED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/acknowledge_order_line.rb

@@ -0,0 +1,93 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # AcknowledgeOrderLine Model.
+  class AcknowledgeOrderLine < 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 [String]
+    attr_reader :status_code
+
+    # TODO: Write general description for this method
+    # @return [QuantityWithUnit]
+    attr_accessor :status_quantity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line_number'] = 'lineNumber'
+      @_hash['status_code'] = 'statusCode'
+      @_hash['status_quantity'] = 'statusQuantity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status_quantity
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line_number:, status_quantity: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @line_number = line_number
+      @status_code = 'Acknowledged'
+      @status_quantity = status_quantity unless status_quantity == 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
+      status_quantity = QuantityWithUnit.from_hash(hash['statusQuantity']) if
+        hash['statusQuantity']
+
+      # 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.
+      AcknowledgeOrderLine.new(line_number: line_number,
+                               status_quantity: status_quantity,
+                               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}, status_code: #{@status_code},"\
+      " status_quantity: #{@status_quantity}, 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}, status_code: #{@status_code.inspect},"\
+      " status_quantity: #{@status_quantity.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/acknowledge_order_request.rb

@@ -0,0 +1,83 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # AcknowledgeOrderRequest Model.
+  class AcknowledgeOrderRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[AcknowledgeOrderLine]]
+    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 << (AcknowledgeOrderLine.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.
+      AcknowledgeOrderRequest.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