lithic 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

data/rbi/lib/lithic/models/transaction_simulate_credit_authorization_response.rbi

@@ -18,8 +18,12 @@ module Lithic
       attr_writer :debugging_request_id
 
       sig { params(token: String, debugging_request_id: String).returns(T.attached_class) }
-      def self.new(token: nil, debugging_request_id: nil); end
-
+      def self.new(
+        # A unique token to reference this transaction.
+        token: nil,
+        # Debugging request ID to share with Lithic Support team.
+        debugging_request_id: nil
+      ); end
       sig { override.returns({token: String, debugging_request_id: String}) }
       def to_hash; end
     end

data/rbi/lib/lithic/models/transaction_simulate_return_params.rbi

@@ -27,8 +27,15 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(amount:, descriptor:, pan:, request_options: {}); end
-
+      def self.new(
+        # Amount (in cents) to authorize.
+        amount:,
+        # Merchant descriptor.
+        descriptor:,
+        # Sixteen digit card number.
+        pan:,
+        request_options: {}
+      ); end
       sig do
         override
           .returns({

data/rbi/lib/lithic/models/transaction_simulate_return_response.rbi

@@ -18,8 +18,12 @@ module Lithic
       attr_writer :debugging_request_id
 
       sig { params(token: String, debugging_request_id: String).returns(T.attached_class) }
-      def self.new(token: nil, debugging_request_id: nil); end
-
+      def self.new(
+        # A unique token to reference this transaction.
+        token: nil,
+        # Debugging request ID to share with Lithic Support team.
+        debugging_request_id: nil
+      ); end
       sig { override.returns({token: String, debugging_request_id: String}) }
       def to_hash; end
     end

data/rbi/lib/lithic/models/transaction_simulate_return_reversal_params.rbi

@@ -14,8 +14,11 @@ module Lithic
         params(token: String, request_options: T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash))
           .returns(T.attached_class)
       end
-      def self.new(token:, request_options: {}); end
-
+      def self.new(
+        # The transaction token returned from the /v1/simulate/authorize response.
+        token:,
+        request_options: {}
+      ); end
       sig { override.returns({token: String, request_options: Lithic::RequestOptions}) }
       def to_hash; end
     end

data/rbi/lib/lithic/models/transaction_simulate_return_reversal_response.rbi

@@ -11,8 +11,10 @@ module Lithic
       attr_writer :debugging_request_id
 
       sig { params(debugging_request_id: String).returns(T.attached_class) }
-      def self.new(debugging_request_id: nil); end
-
+      def self.new(
+        # Debugging request ID to share with Lithic Support team.
+        debugging_request_id: nil
+      ); end
       sig { override.returns({debugging_request_id: String}) }
       def to_hash; end
     end

data/rbi/lib/lithic/models/transaction_simulate_void_params.rbi

@@ -38,8 +38,20 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(token:, amount: nil, type: nil, request_options: {}); end
-
+      def self.new(
+        # The transaction token returned from the /v1/simulate/authorize response.
+        token:,
+        # Amount (in cents) to void. Typically this will match the amount in the original
+        # authorization, but can be less.
+        amount: nil,
+        # Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.
+        #
+        # - `AUTHORIZATION_EXPIRY` indicates authorization has expired and been reversed
+        #   by Lithic.
+        # - `AUTHORIZATION_REVERSAL` indicates authorization was reversed by the merchant.
+        type: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/transaction_simulate_void_response.rbi

@@ -11,8 +11,10 @@ module Lithic
       attr_writer :debugging_request_id
 
       sig { params(debugging_request_id: String).returns(T.attached_class) }
-      def self.new(debugging_request_id: nil); end
-
+      def self.new(
+        # Debugging request ID to share with Lithic Support team.
+        debugging_request_id: nil
+      ); end
       sig { override.returns({debugging_request_id: String}) }
       def to_hash; end
     end

data/rbi/lib/lithic/models/transactions/events/enhanced_data.rbi

@@ -41,8 +41,16 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(token:, common:, event_token:, fleet:, transaction_token:); end
-
+          def self.new(
+            # A unique identifier for the enhanced commercial data.
+            token:,
+            common:,
+            # The token of the event that the enhanced data is associated with.
+            event_token:,
+            fleet:,
+            # The token of the transaction that the enhanced data is associated with.
+            transaction_token:
+          ); end
           sig do
             override
               .returns(
@@ -106,12 +114,13 @@ module Lithic
             def self.new(
               line_items:,
               tax:,
+              # A customer identifier.
               customer_reference_number: nil,
+              # A merchant identifier.
               merchant_reference_number: nil,
+              # The date of the order.
               order_date: nil
-            )
-            end
-
+            ); end
             sig do
               override
                 .returns(
@@ -164,8 +173,16 @@ module Lithic
                   quantity: Float
                 ).returns(T.attached_class)
               end
-              def self.new(amount: nil, description: nil, product_code: nil, quantity: nil); end
-
+              def self.new(
+                # The price of the item purchased in merchant currency.
+                amount: nil,
+                # A human-readable description of the item.
+                description: nil,
+                # An identifier for the item purchased.
+                product_code: nil,
+                # The quantity of the item purchased.
+                quantity: nil
+              ); end
               sig do
                 override.returns({amount: Float, description: String, product_code: String, quantity: Float})
               end
@@ -202,8 +219,14 @@ module Lithic
                 )
                   .returns(T.attached_class)
               end
-              def self.new(amount: nil, exempt: nil, merchant_tax_id: nil); end
-
+              def self.new(
+                # The amount of tax collected.
+                amount: nil,
+                # A flag indicating whether the transaction is tax exempt or not.
+                exempt: nil,
+                # The tax ID of the merchant.
+                merchant_tax_id: nil
+              ); end
               sig do
                 override
                   .returns(
@@ -318,13 +341,17 @@ module Lithic
             def self.new(
               amount_totals:,
               fuel:,
+              # The driver number entered into the terminal at the time of sale, with leading
+              # zeros stripped.
               driver_number: nil,
+              # The odometer reading entered into the terminal at the time of sale.
               odometer: nil,
+              # The type of fuel service.
               service_type: nil,
+              # The vehicle number entered into the terminal at the time of sale, with leading
+              # zeros stripped.
               vehicle_number: nil
-            )
-            end
-
+            ); end
             sig do
               override
                 .returns(
@@ -365,8 +392,14 @@ module Lithic
               sig do
                 params(discount: Integer, gross_sale: Integer, net_sale: Integer).returns(T.attached_class)
               end
-              def self.new(discount: nil, gross_sale: nil, net_sale: nil); end
-
+              def self.new(
+                # The discount applied to the gross sale amount.
+                discount: nil,
+                # The gross sale amount.
+                gross_sale: nil,
+                # The amount after discount.
+                net_sale: nil
+              ); end
               sig { override.returns({discount: Integer, gross_sale: Integer, net_sale: Integer}) }
               def to_hash; end
             end
@@ -418,8 +451,16 @@ module Lithic
                 )
                   .returns(T.attached_class)
               end
-              def self.new(quantity: nil, type: nil, unit_of_measure: nil, unit_price: nil); end
-
+              def self.new(
+                # The quantity of fuel purchased.
+                quantity: nil,
+                # The type of fuel purchased.
+                type: nil,
+                # Unit of measure for fuel disbursement.
+                unit_of_measure: nil,
+                # The price per unit of fuel.
+                unit_price: nil
+              ); end
               sig do
                 override
                   .returns(

data/rbi/lib/lithic/models/transfer.rbi

@@ -128,18 +128,46 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Globally unique identifier for the transfer event.
         token: nil,
+        # Status types:
+        #
+        # - `TRANSFER` - Internal transfer of funds between financial accounts in your
+        #   program.
         category: nil,
+        # Date and time when the transfer occurred. UTC time zone.
         created: nil,
+        # 3-character alphabetic ISO 4217 code for the settling currency of the
+        # transaction.
         currency: nil,
+        # A string that provides a description of the transfer; may be useful to display
+        # to users.
         descriptor: nil,
+        # A list of all financial events that have modified this trasnfer.
         events: nil,
+        # The updated balance of the sending financial account.
         from_balance: nil,
+        # Pending amount of the transaction in the currency's smallest unit (e.g., cents),
+        # including any acquirer fees. The value of this field will go to zero over time
+        # once the financial transaction is settled.
         pending_amount: nil,
+        # APPROVED transactions were successful while DECLINED transactions were declined
+        # by user, Lithic, or the network.
         result: nil,
+        # Amount of the transaction that has been settled in the currency's smallest unit
+        # (e.g., cents).
         settled_amount: nil,
+        # Status types:
+        #
+        # - `DECLINED` - The transfer was declined.
+        # - `EXPIRED` - The transfer was held in pending for too long and expired.
+        # - `PENDING` - The transfer is pending release from a hold.
+        # - `SETTLED` - The transfer is completed.
+        # - `VOIDED` - The transfer was reversed before it settled.
         status: nil,
+        # The updated balance of the receiving financial account.
         to_balance: nil,
+        # Date and time when the financial transaction was last updated. UTC time zone.
         updated: nil
       ); end
       sig do
@@ -227,8 +255,19 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(token: nil, amount: nil, created: nil, result: nil, type: nil); end
-
+        def self.new(
+          # Globally unique identifier.
+          token: nil,
+          # Amount of the financial event that has been settled in the currency's smallest
+          # unit (e.g., cents).
+          amount: nil,
+          # Date and time when the financial event occurred. UTC time zone.
+          created: nil,
+          # APPROVED financial events were successful while DECLINED financial events were
+          # declined by user, Lithic, or the network.
+          result: nil,
+          type: nil
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/transfer_create_params.rbi

@@ -47,8 +47,23 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(amount:, from:, to:, token: nil, memo: nil, request_options: {}); end
-
+      def self.new(
+        # Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
+        # This should always be a positive value.
+        amount:,
+        # Globally unique identifier for the financial account or card that will send the
+        # funds. Accepted type dependent on the program's use case.
+        from:,
+        # Globally unique identifier for the financial account or card that will receive
+        # the funds. Accepted type dependent on the program's use case.
+        to:,
+        # Customer-provided token that will serve as an idempotency token. This token will
+        # become the transaction token.
+        token: nil,
+        # Optional descriptor for the transfer.
+        memo: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/resources/cards.rbi

@@ -35,7 +35,7 @@ module Lithic
           state: Lithic::Models::CardCreateParams::State::OrSymbol,
           request_options: T.nilable(T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash))
         )
-          .returns(Lithic::Models::CardCreateResponse)
+          .returns(Lithic::Models::Card)
       end
       def create(
         # Card types:
@@ -147,7 +147,7 @@ module Lithic
           card_token: String,
           request_options: T.nilable(T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash))
         )
-          .returns(Lithic::Models::CardRetrieveResponse)
+          .returns(Lithic::Models::Card)
       end
       def retrieve(card_token, request_options: {}); end
 
@@ -168,7 +168,7 @@ module Lithic
           state: Lithic::Models::CardUpdateParams::State::OrSymbol,
           request_options: T.nilable(T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash))
         )
-          .returns(Lithic::Models::CardUpdateResponse)
+          .returns(Lithic::Models::Card)
       end
       def update(
         card_token,
@@ -228,7 +228,7 @@ module Lithic
           state: Lithic::Models::CardListParams::State::OrSymbol,
           request_options: T.nilable(T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash))
         )
-          .returns(Lithic::Internal::CursorPage[Lithic::Models::CardListResponse])
+          .returns(Lithic::Internal::CursorPage[Lithic::Models::NonPCICard])
       end
       def list(
         # Returns cards associated with the specified account.
@@ -270,7 +270,7 @@ module Lithic
           shipping_method: Lithic::Models::CardConvertPhysicalParams::ShippingMethod::OrSymbol,
           request_options: T.nilable(T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash))
         )
-          .returns(Lithic::Models::CardConvertPhysicalResponse)
+          .returns(Lithic::Models::Card)
       end
       def convert_physical(
         card_token,
@@ -400,7 +400,7 @@ module Lithic
           shipping_method: Lithic::Models::CardReissueParams::ShippingMethod::OrSymbol,
           request_options: T.nilable(T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash))
         )
-          .returns(Lithic::Models::CardReissueResponse)
+          .returns(Lithic::Models::Card)
       end
       def reissue(
         card_token,
@@ -447,7 +447,7 @@ module Lithic
           shipping_method: Lithic::Models::CardRenewParams::ShippingMethod::OrSymbol,
           request_options: T.nilable(T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash))
         )
-          .returns(Lithic::Models::CardRenewResponse)
+          .returns(Lithic::Models::Card)
       end
       def renew(
         card_token,
@@ -508,7 +508,7 @@ module Lithic
             )
           )
         )
-          .returns(Lithic::Models::CardSearchByPanResponse)
+          .returns(Lithic::Models::Card)
       end
       def search_by_pan(
         # The PAN for the card being retrieved.

data/sig/lithic/file_part.rbs

@@ -0,0 +1,21 @@
+module Lithic
+  class FilePart
+    attr_reader content: Pathname | StringIO | IO | String
+
+    attr_reader content_type: String?
+
+    attr_reader filename: String?
+
+    private def read: -> String
+
+    def to_json: (*top a) -> String
+
+    def to_yaml: (*top a) -> String
+
+    def initialize: (
+      Pathname | StringIO | IO | String content,
+      ?filename: String?,
+      ?content_type: String?
+    ) -> void
+  end
+end

data/sig/lithic/internal/transport/base_client.rbs

@@ -11,7 +11,10 @@ module Lithic
             | Integer
             | ::Array[(String | Integer)?])?]?,
             body: top?,
-            unwrap: Symbol?,
+            unwrap: (Symbol
+            | Integer
+            | ::Array[(Symbol | Integer)]
+            | (^(top arg0) -> top))?,
             page: Class?,
             stream: Class?,
             model: Lithic::Internal::Type::Converter::input?,
@@ -53,7 +56,7 @@ module Lithic
         ) -> void
 
         # @api private
-        attr_accessor requester: Lithic::Internal::Transport::PooledNetRequester
+        attr_reader requester: Lithic::Internal::Transport::PooledNetRequester
 
         def initialize: (
           base_url: String,
@@ -96,7 +99,10 @@ module Lithic
           | Integer
           | ::Array[(String | Integer)?])?]?,
           ?body: top?,
-          ?unwrap: Symbol?,
+          ?unwrap: (Symbol
+          | Integer
+          | ::Array[(Symbol | Integer)]
+          | (^(top arg0) -> top))?,
           ?page: Class?,
           ?stream: Class?,
           ?model: Lithic::Internal::Type::Converter::input?,

data/sig/lithic/internal/type/{io_like.rbs → file_input.rbs}

@@ -1,7 +1,7 @@
 module Lithic
   module Internal
     module Type
-      class IOLike
+      class FileInput
         extend Lithic::Internal::Type::Converter
 
         def self.===: (top other) -> bool

data/sig/lithic/internal/util.rbs

@@ -29,8 +29,10 @@ module Lithic
 
       def self?.dig: (
         ::Hash[Symbol, top] | ::Array[top] | top data,
-        (Symbol | Integer | ::Array[(Symbol | Integer)])? pick,
-        ?top? sentinel
+        (Symbol
+        | Integer
+        | ::Array[(Symbol | Integer)]
+        | (^(top arg0) -> top))? pick
       ) {
         -> top?
       } -> top?
@@ -73,16 +75,6 @@ module Lithic
         | ::Array[(String | Integer)?])?] headers
       ) -> ::Hash[String, String]
 
-      class SerializationAdapter
-        attr_reader inner: Pathname | IO
-
-        def to_json: (*top a) -> String
-
-        def to_yaml: (*top a) -> String
-
-        def initialize: (Pathname | IO inner) -> void
-      end
-
       class ReadIOAdapter
         def close?: -> bool?
 
@@ -103,6 +95,16 @@ module Lithic
         (Enumerator::Yielder y) -> void
       } -> Enumerable[String]
 
+      JSON_CONTENT: Regexp
+      JSONL_CONTENT: Regexp
+
+      def self?.write_multipart_content: (
+        Enumerator::Yielder y,
+        val: top,
+        closing: ::Array[^-> void],
+        ?content_type: String?
+      ) -> void
+
       def self?.write_multipart_chunk: (
         Enumerator::Yielder y,
         boundary: String,

data/sig/lithic/models/card.rbs

@@ -0,0 +1,19 @@
+module Lithic
+  module Models
+    type card = { cvv: String, pan: String }
+
+    class Card < Lithic::Models::NonPCICard
+      def cvv: -> String?
+
+      def cvv=: (String _) -> String
+
+      def pan: -> String?
+
+      def pan=: (String _) -> String
+
+      def initialize: (?cvv: String, ?pan: String) -> void
+
+      def to_hash: -> Lithic::Models::card
+    end
+  end
+end