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

data/rbi/lib/lithic/models/payment_simulate_return_response.rbi

@@ -23,8 +23,14 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(debugging_request_id:, result:, transaction_event_token:); end
-
+      def self.new(
+        # Debugging Request Id
+        debugging_request_id:,
+        # Request Result
+        result:,
+        # Transaction Event Token
+        transaction_event_token:
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/reports/settlement/network_total_list_params.rbi

@@ -108,16 +108,32 @@ module Lithic
               .returns(T.attached_class)
           end
           def self.new(
+            # Datetime in RFC 3339 format. Only entries created after the specified time will
+            # be included. UTC time zone.
             begin_: nil,
+            # Datetime in RFC 3339 format. Only entries created before the specified time will
+            # be included. UTC time zone.
             end_: nil,
+            # A cursor representing an item's token before which a page of results should end.
+            # Used to retrieve the previous page of results before this item.
             ending_before: nil,
+            # Institution ID to filter on.
             institution_id: nil,
+            # Network to filter on.
             network: nil,
+            # Number of records per page.
             page_size: nil,
+            # Singular report date to filter on (YYYY-MM-DD). Cannot be populated in
+            # conjunction with report_date_begin or report_date_end.
             report_date: nil,
+            # Earliest report date to filter on, inclusive (YYYY-MM-DD).
             report_date_begin: nil,
+            # Latest report date to filter on, inclusive (YYYY-MM-DD).
             report_date_end: nil,
+            # Settlement institution ID to filter on.
             settlement_institution_id: nil,
+            # A cursor representing an item's token after which a page of results should
+            # begin. Used to retrieve the next page of results after this item.
             starting_after: nil,
             request_options: {}
           ); end

data/rbi/lib/lithic/models/reports/settlement/network_total_list_response.rbi

@@ -81,16 +81,31 @@ module Lithic
               .returns(T.attached_class)
           end
           def self.new(
+            # Globally unique identifier.
             token:,
             amounts:,
+            # RFC 3339 timestamp for when the record was created. UTC time zone.
             created:,
+            # 3-character alphabetic ISO 4217 code.
             currency:,
+            # The institution that activity occurred on. For Mastercard: ICA (Interbank Card
+            # Association). For Maestro: institution ID. For Visa: lowest level SRE
+            # (Settlement Reporting Entity).
             institution_id:,
+            # Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or
+            # INTERLINK.
             network:,
+            # Date that the network total record applies to. YYYY-MM-DD format.
             report_date:,
+            # The institution responsible for settlement. For Mastercard: same as
+            # `institution_id`. For Maestro: billing ICA. For Visa: Funds Transfer SRE
+            # (FTSRE).
             settlement_institution_id:,
+            # Settlement service.
             settlement_service:,
+            # RFC 3339 timestamp for when the record was last updated. UTC time zone.
             updated:,
+            # The clearing cycle that the network total record applies to. Mastercard only.
             cycle: nil
           ); end
           sig do
@@ -143,8 +158,17 @@ module Lithic
               )
                 .returns(T.attached_class)
             end
-            def self.new(gross_settlement:, interchange_fees:, net_settlement:, visa_charges: nil); end
-
+            def self.new(
+              # Total settlement amount excluding interchange, in currency's smallest unit.
+              gross_settlement:,
+              # Interchange amount, in currency's smallest unit.
+              interchange_fees:,
+              # `gross_settlement` net of `interchange_fees` and `visa_charges` (if applicable),
+              # in currency's smallest unit.
+              net_settlement:,
+              # Charges specific to Visa/Interlink, in currency's smallest unit.
+              visa_charges: nil
+            ); end
             sig do
               override
                 .returns(

data/rbi/lib/lithic/models/reports/settlement/network_total_retrieve_response.rbi

@@ -87,16 +87,31 @@ module Lithic
               .returns(T.attached_class)
           end
           def self.new(
+            # Globally unique identifier.
             token:,
             amounts:,
+            # RFC 3339 timestamp for when the record was created. UTC time zone.
             created:,
+            # 3-character alphabetic ISO 4217 code.
             currency:,
+            # The institution that activity occurred on. For Mastercard: ICA (Interbank Card
+            # Association). For Maestro: institution ID. For Visa: lowest level SRE
+            # (Settlement Reporting Entity).
             institution_id:,
+            # Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or
+            # INTERLINK.
             network:,
+            # Date that the network total record applies to. YYYY-MM-DD format.
             report_date:,
+            # The institution responsible for settlement. For Mastercard: same as
+            # `institution_id`. For Maestro: billing ICA. For Visa: Funds Transfer SRE
+            # (FTSRE).
             settlement_institution_id:,
+            # Settlement service.
             settlement_service:,
+            # RFC 3339 timestamp for when the record was last updated. UTC time zone.
             updated:,
+            # The clearing cycle that the network total record applies to. Mastercard only.
             cycle: nil
           ); end
           sig do
@@ -149,8 +164,17 @@ module Lithic
               )
                 .returns(T.attached_class)
             end
-            def self.new(gross_settlement:, interchange_fees:, net_settlement:, visa_charges: nil); end
-
+            def self.new(
+              # Total settlement amount excluding interchange, in currency's smallest unit.
+              gross_settlement:,
+              # Interchange amount, in currency's smallest unit.
+              interchange_fees:,
+              # `gross_settlement` net of `interchange_fees` and `visa_charges` (if applicable),
+              # in currency's smallest unit.
+              net_settlement:,
+              # Charges specific to Visa/Interlink, in currency's smallest unit.
+              visa_charges: nil
+            ); end
             sig do
               override
                 .returns(

data/rbi/lib/lithic/models/reports/settlement_list_details_params.rbi

@@ -39,8 +39,17 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(ending_before: nil, page_size: nil, starting_after: nil, request_options: {}); end
-
+        def self.new(
+          # A cursor representing an item's token before which a page of results should end.
+          # Used to retrieve the previous page of results before this item.
+          ending_before: nil,
+          # Page size (for pagination).
+          page_size: nil,
+          # A cursor representing an item's token after which a page of results should
+          # begin. Used to retrieve the next page of results after this item.
+          starting_after: nil,
+          request_options: {}
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/required_document.rbi

@@ -21,8 +21,16 @@ module Lithic
         params(entity_token: String, status_reasons: T::Array[String], valid_documents: T::Array[String])
           .returns(T.attached_class)
       end
-      def self.new(entity_token:, status_reasons:, valid_documents:); end
-
+      def self.new(
+        # Globally unique identifier for an entity.
+        entity_token:,
+        # rovides the status reasons that will be satisfied by providing one of the valid
+        # documents.
+        status_reasons:,
+        # A list of valid documents that will satisfy the KYC requirements for the
+        # specified entity.
+        valid_documents:
+      ); end
       sig do
         override
           .returns({

data/rbi/lib/lithic/models/responder_endpoint_check_status_params.rbi

@@ -17,8 +17,11 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(type:, request_options: {}); end
-
+      def self.new(
+        # The type of the endpoint.
+        type:,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/responder_endpoint_create_params.rbi

@@ -28,8 +28,13 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(type: nil, url: nil, request_options: {}); end
-
+      def self.new(
+        # The type of the endpoint.
+        type: nil,
+        # The URL for the responder endpoint (must be http(s)).
+        url: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/responder_endpoint_create_response.rbi

@@ -11,8 +11,10 @@ module Lithic
       attr_writer :enrolled
 
       sig { params(enrolled: T::Boolean).returns(T.attached_class) }
-      def self.new(enrolled: nil); end
-
+      def self.new(
+        # True if the endpoint was enrolled successfully.
+        enrolled: nil
+      ); end
       sig { override.returns({enrolled: T::Boolean}) }
       def to_hash; end
     end

data/rbi/lib/lithic/models/responder_endpoint_delete_params.rbi

@@ -17,8 +17,11 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(type:, request_options: {}); end
-
+      def self.new(
+        # The type of the endpoint.
+        type:,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/responder_endpoint_status.rbi

@@ -15,8 +15,12 @@ module Lithic
       attr_accessor :url
 
       sig { params(enrolled: T::Boolean, url: T.nilable(String)).returns(T.attached_class) }
-      def self.new(enrolled: nil, url: nil); end
-
+      def self.new(
+        # True if the instance has an endpoint enrolled.
+        enrolled: nil,
+        # The URL of the currently enrolled endpoint or null.
+        url: nil
+      ); end
       sig { override.returns({enrolled: T::Boolean, url: T.nilable(String)}) }
       def to_hash; end
     end

data/rbi/lib/lithic/models/settlement_detail.rbi

@@ -130,26 +130,52 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Globally unique identifier denoting the Settlement Detail.
         token:,
+        # The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE
+        # for Visa).
         account_token:,
+        # Globally unique identifier denoting the card program that the associated
+        # Transaction occurred on.
         card_program_token:,
+        # Globally unique identifier denoting the card that the associated Transaction
+        # occurred on.
         card_token:,
+        # Date and time when the transaction first occurred. UTC time zone.
         created:,
+        # Three-character alphabetic ISO 4217 code.
         currency:,
+        # The total gross amount of disputes settlements.
         disputes_gross_amount:,
+        # Globally unique identifiers denoting the Events associated with this settlement.
         event_tokens:,
+        # The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE
+        # for Visa).
         institution:,
+        # The total amount of interchange in six-digit extended precision.
         interchange_fee_extended_precision:,
+        # The total amount of interchange.
         interchange_gross_amount:,
+        # Card network where the transaction took place.
         network:,
+        # The total gross amount of other fees by type.
         other_fees_details:,
+        # Total amount of gross other fees outside of interchange.
         other_fees_gross_amount:,
+        # Date of when the report was first generated.
         report_date:,
+        # Date of when money movement is triggered for the transaction.
         settlement_date:,
+        # Globally unique identifier denoting the associated Transaction object.
         transaction_token:,
+        # The total amount of settlement impacting transactions (excluding interchange,
+        # fees, and disputes).
         transactions_gross_amount:,
+        # The type of settlement record.
         type:,
+        # Date and time when the transaction first occurred. UTC time zone.
         updated:,
+        # Network's description of a fee, only present on records with type `FEE`.
         fee_description: nil
       ); end
       sig do

data/rbi/lib/lithic/models/settlement_report.rbi

@@ -78,16 +78,41 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Date and time when the transaction first occurred. UTC time zone.
         created:,
+        # 3-character alphabetic ISO 4217 code. (This field is deprecated and will be
+        # removed in a future version of the API.)
         currency:,
         details:,
+        # The total gross amount of disputes settlements. (This field is deprecated and
+        # will be removed in a future version of the API. To compute total amounts, Lithic
+        # recommends that customers sum the relevant settlement amounts found within
+        # `details`.)
         disputes_gross_amount:,
+        # The total amount of interchange. (This field is deprecated and will be removed
+        # in a future version of the API. To compute total amounts, Lithic recommends that
+        # customers sum the relevant settlement amounts found within `details`.)
         interchange_gross_amount:,
+        # Indicates that all data expected on the given report date is available.
         is_complete:,
+        # Total amount of gross other fees outside of interchange. (This field is
+        # deprecated and will be removed in a future version of the API. To compute total
+        # amounts, Lithic recommends that customers sum the relevant settlement amounts
+        # found within `details`.)
         other_fees_gross_amount:,
+        # Date of when the report was first generated.
         report_date:,
+        # The total net amount of cash moved. (net value of settled_gross_amount,
+        # interchange, fees). (This field is deprecated and will be removed in a future
+        # version of the API. To compute total amounts, Lithic recommends that customers
+        # sum the relevant settlement amounts found within `details`.)
         settled_net_amount:,
+        # The total amount of settlement impacting transactions (excluding interchange,
+        # fees, and disputes). (This field is deprecated and will be removed in a future
+        # version of the API. To compute total amounts, Lithic recommends that customers
+        # sum the relevant settlement amounts found within `details`.)
         transactions_gross_amount:,
+        # Date and time when the transaction first occurred. UTC time zone.
         updated:
       ); end
       sig do

data/rbi/lib/lithic/models/settlement_summary_details.rbi

@@ -76,13 +76,24 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # 3-character alphabetic ISO 4217 code.
         currency: nil,
+        # The total gross amount of disputes settlements.
         disputes_gross_amount: nil,
+        # The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE
+        # for Visa).
         institution: nil,
+        # The total amount of interchange.
         interchange_gross_amount: nil,
+        # Card network where the transaction took place
         network: nil,
+        # Total amount of gross other fees outside of interchange.
         other_fees_gross_amount: nil,
+        # The total net amount of cash moved. (net value of settled_gross_amount,
+        # interchange, fees).
         settled_net_amount: nil,
+        # The total amount of settlement impacting transactions (excluding interchange,
+        # fees, and disputes).
         transactions_gross_amount: nil
       ); end
       sig do

data/rbi/lib/lithic/models/shipping_address.rbi

@@ -85,16 +85,36 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Valid USPS routable address.
         address1:,
+        # City
         city:,
+        # Uppercase ISO 3166-1 alpha-3 three character abbreviation.
         country:,
+        # Customer's first name. This will be the first name printed on the physical card.
+        # The combined length of `first_name` and `last_name` may not exceed 25
+        # characters.
         first_name:,
+        # Customer's surname (family name). This will be the last name printed on the
+        # physical card. The combined length of `first_name` and `last_name` may not
+        # exceed 25 characters.
         last_name:,
+        # Postal code (formerly zipcode). For US addresses, either five-digit postal code
+        # or nine-digit postal code (ZIP+4) using the format 12345-1234.
         postal_code:,
+        # Uppercase ISO 3166-2 two character abbreviation for US and CA. Optional with a
+        # limit of 24 characters for other countries.
         state:,
+        # Unit number (if applicable).
         address2: nil,
+        # Email address to be contacted for expedited shipping process purposes. Required
+        # if `shipping_method` is `EXPEDITED`.
         email: nil,
+        # Text to be printed on line two of the physical card. Use of this field requires
+        # additional permissions.
         line2_text: nil,
+        # Cardholder's phone number in E.164 format to be contacted for expedited shipping
+        # process purposes. Required if `shipping_method` is `EXPEDITED`.
         phone_number: nil
       ); end
       sig do