lithic 0.1.0.pre.alpha.6 → 0.1.0.pre.alpha.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cc0455f8a47c113c091409b3b4ed5b5522a3ae3c2272f68701084ffbb4b35bf
-  data.tar.gz: 1bc14153bdcce95840ab82520a99ca49f9a943850313c0f73fa15a2a8d4cfc94
+  metadata.gz: f8d20c28e43fb2ec6fd932b2f8426228676e0be97ebfc29ae8001074f3caf752
+  data.tar.gz: 1d6a6a4a9aa2516d61ebd574340bc7c7588ab9bdcaa7e6a70f4d39794acc3d36
 SHA512:
-  metadata.gz: f8c91140b58743c9972ebb4d79a003844f242f076056a3c1ce7052125ec5c6941bf1033972b23f9c8637768123abc450c32efa651ea59c9acf571c673b021f14
-  data.tar.gz: 12ccc695ebb93e4df2aa828dbff4bece059d99ddd249dfa7e837229c01ca196a5a7956d832fc01557ffa33a524231e880aea6c8578d238713b58161b7cf1c04e
+  metadata.gz: 217b64c26b69a76811e6443c68eae64aa2af2e3d3ab5b51ad323fa9df8d5d38ea88dc92ca5f91d590f51f1397bc7df5292a414cb526e343128cf0f24bdb97c43
+  data.tar.gz: f6ddaa0850bf3f8f30e389a310ba0941689610642423fd7e6b32e8110019619ab5ec7cd16cac61c3accc290c1c5698e8bcd38f28eb1717b6b819d83264cd13c2

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "lithic", "~> 0.1.0.pre.alpha.5"
+gem "lithic", "~> 0.1.0.pre.alpha.6"
 ```
 
 <!-- x-release-please-end -->

data/lib/lithic/client.rb

@@ -129,10 +129,10 @@ module Lithic
     #
     # @param environment [:production, :sandbox, nil] Specifies the environment to use for the API.
     #
-    #   Each environment maps to a different base URL:
+    # Each environment maps to a different base URL:
     #
-    #   - `production` corresponds to `https://api.lithic.com`
-    #   - `sandbox` corresponds to `https://sandbox.lithic.com`
+    # - `production` corresponds to `https://api.lithic.com`
+    # - `sandbox` corresponds to `https://sandbox.lithic.com`
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
     #

data/lib/lithic/internal/transport/base_client.rb

@@ -393,7 +393,7 @@ module Lithic
         end
 
         # Execute the request specified by `req`. This is the method that all resource
-        #   methods call into.
+        # methods call into.
         #
         # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: Lithic::Internal::Type::Unknown, options: {})
         #

data/lib/lithic/internal/transport/pooled_net_requester.rb

@@ -6,7 +6,7 @@ module Lithic
       # @api private
       class PooledNetRequester
         # from the golang stdlib
-        #   https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
+        # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
         KEEP_ALIVE_TIMEOUT = 30
 
         class << self

data/lib/lithic/internal/type/base_model.rb

@@ -19,7 +19,7 @@ module Lithic
           # @api private
           #
           # Assumes superclass fields are totally defined before fields are accessed /
-          #   defined on subclasses.
+          # defined on subclasses.
           #
           # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
           def known_fields
@@ -143,7 +143,7 @@ module Lithic
           # @api private
           #
           # `request_only` attributes not excluded from `.#coerce` when receiving responses
-          #   even if well behaved servers should not send them
+          # even if well behaved servers should not send them
           #
           # @param blk [Proc]
           private def request_only(&blk)
@@ -258,7 +258,6 @@ module Lithic
               return super
             end
 
-            is_param = singleton_class <= Lithic::Internal::Type::RequestParameters::Converter
             acc = {}
 
             coerced.each do |key, val|
@@ -267,21 +266,19 @@ module Lithic
               in nil
                 acc.store(name, super(val))
               else
-                mode, type_fn = field.fetch_values(:mode, :type_fn)
+                api_name, mode, type_fn = field.fetch_values(:api_name, :mode, :type_fn)
                 case mode
                 in :coerce
                   next
                 else
                   target = type_fn.call
-                  api_name = is_param ? name : field.fetch(:api_name)
                   acc.store(api_name, Lithic::Internal::Type::Converter.dump(target, val))
                 end
               end
             end
 
-            known_fields.each do |name, field|
-              mode, const = field.fetch_values(:mode, :const)
-              api_name = is_param ? name : field.fetch(:api_name)
+            known_fields.each_value do |field|
+              api_name, mode, const = field.fetch_values(:api_name, :mode, :const)
               next if mode == :coerce || acc.key?(api_name) || const == Lithic::Internal::OMIT
               acc.store(api_name, const)
             end
@@ -291,11 +288,11 @@ module Lithic
         end
 
         # Returns the raw value associated with the given key, if found. Otherwise, nil is
-        #   returned.
+        # returned.
         #
-        #   It is valid to lookup keys that are not in the API spec, for example to access
-        #   undocumented features. This method does not parse response data into
-        #   higher-level types. Lookup by anything other than a Symbol is an ArgumentError.
+        # It is valid to lookup keys that are not in the API spec, for example to access
+        # undocumented features. This method does not parse response data into
+        # higher-level types. Lookup by anything other than a Symbol is an ArgumentError.
         #
         # @param key [Symbol]
         #
@@ -310,12 +307,12 @@ module Lithic
 
         # Returns a Hash of the data underlying this object. O(1)
         #
-        #   Keys are Symbols and values are the raw values from the response. The return
-        #   value indicates which values were ever set on the object. i.e. there will be a
-        #   key in this hash if they ever were, even if the set value was nil.
+        # Keys are Symbols and values are the raw values from the response. The return
+        # value indicates which values were ever set on the object. i.e. there will be a
+        # key in this hash if they ever were, even if the set value was nil.
         #
-        #   This method is not recursive. The returned value is shared by the object, so it
-        #   should not be mutated.
+        # This method is not recursive. The returned value is shared by the object, so it
+        # should not be mutated.
         #
         # @return [Hash{Symbol=>Object}]
         def to_h = @data

data/lib/lithic/internal/type/converter.rb

@@ -3,7 +3,6 @@
 module Lithic
   module Internal
     module Type
-      # rubocop:disable Metrics/ModuleLength
       # @api private
       module Converter
         # rubocop:disable Lint/UnusedMethodArgument
@@ -76,37 +75,37 @@ module Lithic
           #
           # Based on `target`, transform `value` into `target`, to the extent possible:
           #
-          #   1. if the given `value` conforms to `target` already, return the given `value`
-          #   2. if it's possible and safe to convert the given `value` to `target`, then the
-          #      converted value
-          #   3. otherwise, the given `value` unaltered
+          # 1. if the given `value` conforms to `target` already, return the given `value`
+          # 2. if it's possible and safe to convert the given `value` to `target`, then the
+          #    converted value
+          # 3. otherwise, the given `value` unaltered
           #
-          #   The coercion process is subject to improvement between minor release versions.
-          #   See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode
+          # The coercion process is subject to improvement between minor release versions.
+          # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode
           #
           # @param target [Lithic::Internal::Type::Converter, Class]
           #
           # @param value [Object]
           #
           # @param state [Hash{Symbol=>Object}] The `strictness` is one of `true`, `false`, or `:strong`. This informs the
-          #   coercion strategy when we have to decide between multiple possible conversion
-          #   targets:
+          # coercion strategy when we have to decide between multiple possible conversion
+          # targets:
           #
-          #   - `true`: the conversion must be exact, with minimum coercion.
-          #   - `false`: the conversion can be approximate, with some coercion.
-          #   - `:strong`: the conversion must be exact, with no coercion, and raise an error
-          #     if not possible.
+          # - `true`: the conversion must be exact, with minimum coercion.
+          # - `false`: the conversion can be approximate, with some coercion.
+          # - `:strong`: the conversion must be exact, with no coercion, and raise an error
+          #   if not possible.
           #
-          #   The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
-          #   any given conversion attempt, the exactness will be updated based on how closely
-          #   the value recursively matches the target type:
+          # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
+          # any given conversion attempt, the exactness will be updated based on how closely
+          # the value recursively matches the target type:
           #
-          #   - `yes`: the value can be converted to the target type with minimum coercion.
-          #   - `maybe`: the value can be converted to the target type with some reasonable
-          #     coercion.
-          #   - `no`: the value cannot be converted to the target type.
+          # - `yes`: the value can be converted to the target type with minimum coercion.
+          # - `maybe`: the value can be converted to the target type with some reasonable
+          #   coercion.
+          # - `no`: the value cannot be converted to the target type.
           #
-          #   See implementation below for more details.
+          # See implementation below for more details.
           #
           #   @option state [Boolean, :strong] :strictness
           #
@@ -218,7 +217,6 @@ module Lithic
           end
         end
       end
-      # rubocop:enable Metrics/ModuleLength
     end
   end
 end

data/lib/lithic/internal/type/enum.rb

@@ -6,15 +6,15 @@ module Lithic
       # @api private
       #
       # A value from among a specified list of options. OpenAPI enum values map to Ruby
-      #   values in the SDK as follows:
+      # values in the SDK as follows:
       #
-      #   1. boolean => true | false
-      #   2. integer => Integer
-      #   3. float => Float
-      #   4. string => Symbol
+      # 1. boolean => true | false
+      # 2. integer => Integer
+      # 3. float => Float
+      # 4. string => Symbol
       #
-      #   We can therefore convert string values to Symbols, but can't convert other
-      #   values safely.
+      # We can therefore convert string values to Symbols, but can't convert other
+      # values safely.
       #
       # @example
       #   # `account_financial_account_type` is a `Lithic::Models::AccountFinancialAccountType`
@@ -66,7 +66,7 @@ module Lithic
         # @api private
         #
         # Unlike with primitives, `Enum` additionally validates that the value is a member
-        #   of the enum.
+        # of the enum.
         #
         # @param value [String, Symbol, Object]
         #

data/lib/lithic/internal/util.rb

@@ -2,8 +2,6 @@
 
 module Lithic
   module Internal
-    # rubocop:disable Metrics/ModuleLength
-
     # @api private
     module Util
       # @api private
@@ -154,7 +152,7 @@ module Lithic
         # @api private
         #
         # Recursively merge one hash with another. If the values at a given key are not
-        #   both hashes, just take the new value.
+        # both hashes, just take the new value.
         #
         # @param values [Array<Object>]
         #
@@ -694,7 +692,5 @@ module Lithic
         end
       end
     end
-
-    # rubocop:enable Metrics/ModuleLength
   end
 end

data/lib/lithic/models/account.rb

@@ -6,25 +6,25 @@ module Lithic
     class Account < Lithic::Internal::Type::BaseModel
       # @!attribute token
       #   Globally unique identifier for the account. This is the same as the
-      #     account_token returned by the enroll endpoint. If using this parameter, do not
-      #     include pagination.
+      #   account_token returned by the enroll endpoint. If using this parameter, do not
+      #   include pagination.
       #
       #   @return [String]
       required :token, String
 
       # @!attribute created
       #   Timestamp of when the account was created. For accounts created before
-      #     2023-05-11, this field will be null.
+      #   2023-05-11, this field will be null.
       #
       #   @return [Time, nil]
       required :created, Time, nil?: true
 
       # @!attribute spend_limit
       #   Spend limit information for the user containing the daily, monthly, and lifetime
-      #     spend limit of the account. Any charges to a card owned by this account will be
-      #     declined once their transaction volume has surpassed the value in the applicable
-      #     time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit
-      #     feature is disabled.
+      #   spend limit of the account. Any charges to a card owned by this account will be
+      #   declined once their transaction volume has surpassed the value in the applicable
+      #   time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit
+      #   feature is disabled.
       #
       #   @return [Lithic::Models::Account::SpendLimit]
       required :spend_limit, -> { Lithic::Models::Account::SpendLimit }
@@ -32,15 +32,15 @@ module Lithic
       # @!attribute state
       #   Account state:
       #
-      #     - `ACTIVE` - Account is able to transact and create new cards.
-      #     - `PAUSED` - Account will not be able to transact or create new cards. It can be
-      #       set back to `ACTIVE`.
-      #     - `CLOSED` - Account will not be able to transact or create new cards. `CLOSED`
-      #       accounts are also unable to be transitioned to `ACTIVE` or `PAUSED` states.
-      #       `CLOSED` accounts result from failing to pass KYB/KYC or Lithic closing for
-      #       risk/compliance reasons. Please contact
-      #       [support@lithic.com](mailto:support@lithic.com) if you believe this was in
-      #       error.
+      #   - `ACTIVE` - Account is able to transact and create new cards.
+      #   - `PAUSED` - Account will not be able to transact or create new cards. It can be
+      #     set back to `ACTIVE`.
+      #   - `CLOSED` - Account will not be able to transact or create new cards. `CLOSED`
+      #     accounts are also unable to be transitioned to `ACTIVE` or `PAUSED` states.
+      #     `CLOSED` accounts result from failing to pass KYB/KYC or Lithic closing for
+      #     risk/compliance reasons. Please contact
+      #     [support@lithic.com](mailto:support@lithic.com) if you believe this was in
+      #     error.
       #
       #   @return [Symbol, Lithic::Models::Account::State]
       required :state, enum: -> { Lithic::Models::Account::State }
@@ -56,9 +56,9 @@ module Lithic
 
       # @!attribute [r] auth_rule_tokens
       #   List of identifiers for the Auth Rule(s) that are applied on the account. This
-      #     field is deprecated and will no longer be populated in the `account_holder`
-      #     object. The key will be removed from the schema in a future release. Use the
-      #     `/auth_rules` endpoints to fetch Auth Rule information instead.
+      #   field is deprecated and will no longer be populated in the `account_holder`
+      #   object. The key will be removed from the schema in a future release. Use the
+      #   `/auth_rules` endpoints to fetch Auth Rule information instead.
       #
       #   @return [Array<String>, nil]
       optional :auth_rule_tokens, Lithic::Internal::Type::ArrayOf[String]
@@ -134,10 +134,10 @@ module Lithic
 
         # @!parse
         #   # Spend limit information for the user containing the daily, monthly, and lifetime
-        #   #   spend limit of the account. Any charges to a card owned by this account will be
-        #   #   declined once their transaction volume has surpassed the value in the applicable
-        #   #   time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit
-        #   #   feature is disabled.
+        #   # spend limit of the account. Any charges to a card owned by this account will be
+        #   # declined once their transaction volume has surpassed the value in the applicable
+        #   # time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit
+        #   # feature is disabled.
         #   #
         #   # @param daily [Integer]
         #   # @param lifetime [Integer]
@@ -150,15 +150,15 @@ module Lithic
 
       # Account state:
       #
-      #   - `ACTIVE` - Account is able to transact and create new cards.
-      #   - `PAUSED` - Account will not be able to transact or create new cards. It can be
-      #     set back to `ACTIVE`.
-      #   - `CLOSED` - Account will not be able to transact or create new cards. `CLOSED`
-      #     accounts are also unable to be transitioned to `ACTIVE` or `PAUSED` states.
-      #     `CLOSED` accounts result from failing to pass KYB/KYC or Lithic closing for
-      #     risk/compliance reasons. Please contact
-      #     [support@lithic.com](mailto:support@lithic.com) if you believe this was in
-      #     error.
+      # - `ACTIVE` - Account is able to transact and create new cards.
+      # - `PAUSED` - Account will not be able to transact or create new cards. It can be
+      #   set back to `ACTIVE`.
+      # - `CLOSED` - Account will not be able to transact or create new cards. `CLOSED`
+      #   accounts are also unable to be transitioned to `ACTIVE` or `PAUSED` states.
+      #   `CLOSED` accounts result from failing to pass KYB/KYC or Lithic closing for
+      #   risk/compliance reasons. Please contact
+      #   [support@lithic.com](mailto:support@lithic.com) if you believe this was in
+      #   error.
       #
       # @see Lithic::Models::Account#state
       module State
@@ -185,8 +185,8 @@ module Lithic
 
         # @!attribute business_account_token
         #   Only applicable for customers using the KYC-Exempt workflow to enroll authorized
-        #     users of businesses. Account_token of the enrolled business associated with an
-        #     enrolled AUTHORIZED_USER individual.
+        #   users of businesses. Account_token of the enrolled business associated with an
+        #   enrolled AUTHORIZED_USER individual.
         #
         #   @return [String]
         required :business_account_token, String
@@ -238,15 +238,15 @@ module Lithic
 
         # @!attribute postal_code
         #   Valid postal code. Only USA postal codes (ZIP codes) are currently supported,
-        #     entered as a five-digit postal code or nine-digit postal code (ZIP+4) using the
-        #     format 12345-1234.
+        #   entered as a five-digit postal code or nine-digit postal code (ZIP+4) using the
+        #   format 12345-1234.
         #
         #   @return [String]
         required :postal_code, String
 
         # @!attribute state
         #   Valid state code. Only USA state codes are currently supported, entered in
-        #     uppercase ISO 3166-2 two-character format.
+        #   uppercase ISO 3166-2 two-character format.
         #
         #   @return [String]
         required :state, String