lithic 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.18

data/lib/lithic/models/required_document.rb

@@ -24,9 +24,16 @@ module Lithic
       required :valid_documents, Lithic::Internal::Type::ArrayOf[String]
 
       # @!method initialize(entity_token:, status_reasons:, valid_documents:)
-      #   @param entity_token [String]
-      #   @param status_reasons [Array<String>]
-      #   @param valid_documents [Array<String>]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::RequiredDocument} for more details.
+      #
+      #   @param entity_token [String] Globally unique identifier for an entity.
+      #
+      #   @param status_reasons [Array<String>] rovides the status reasons that will be satisfied by providing one of the valid
+      #   ...
+      #
+      #   @param valid_documents [Array<String>] A list of valid documents that will satisfy the KYC requirements for the specifi
+      #   ...
     end
   end
 end

data/lib/lithic/models/responder_endpoint_check_status_params.rb

@@ -14,7 +14,8 @@ module Lithic
       required :type, enum: -> { Lithic::Models::ResponderEndpointCheckStatusParams::Type }
 
       # @!method initialize(type:, request_options: {})
-      #   @param type [Symbol, Lithic::Models::ResponderEndpointCheckStatusParams::Type]
+      #   @param type [Symbol, Lithic::Models::ResponderEndpointCheckStatusParams::Type] The type of the endpoint.
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # The type of the endpoint.

data/lib/lithic/models/responder_endpoint_create_params.rb

@@ -20,8 +20,10 @@ module Lithic
       optional :url, String
 
       # @!method initialize(type: nil, url: nil, request_options: {})
-      #   @param type [Symbol, Lithic::Models::ResponderEndpointCreateParams::Type]
-      #   @param url [String]
+      #   @param type [Symbol, Lithic::Models::ResponderEndpointCreateParams::Type] The type of the endpoint.
+      #
+      #   @param url [String] The URL for the responder endpoint (must be http(s)).
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # The type of the endpoint.

data/lib/lithic/models/responder_endpoint_create_response.rb

@@ -11,7 +11,7 @@ module Lithic
       optional :enrolled, Lithic::Internal::Type::Boolean
 
       # @!method initialize(enrolled: nil)
-      #   @param enrolled [Boolean]
+      #   @param enrolled [Boolean] True if the endpoint was enrolled successfully.
     end
   end
 end

data/lib/lithic/models/responder_endpoint_delete_params.rb

@@ -14,7 +14,8 @@ module Lithic
       required :type, enum: -> { Lithic::Models::ResponderEndpointDeleteParams::Type }
 
       # @!method initialize(type:, request_options: {})
-      #   @param type [Symbol, Lithic::Models::ResponderEndpointDeleteParams::Type]
+      #   @param type [Symbol, Lithic::Models::ResponderEndpointDeleteParams::Type] The type of the endpoint.
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # The type of the endpoint.

data/lib/lithic/models/responder_endpoint_status.rb

@@ -17,8 +17,9 @@ module Lithic
       optional :url, String, nil?: true
 
       # @!method initialize(enrolled: nil, url: nil)
-      #   @param enrolled [Boolean]
-      #   @param url [String, nil]
+      #   @param enrolled [Boolean] True if the instance has an endpoint enrolled.
+      #
+      #   @param url [String, nil] The URL of the currently enrolled endpoint or null.
     end
   end
 end

data/lib/lithic/models/settlement_detail.rb

@@ -135,27 +135,56 @@ module Lithic
       optional :fee_description, String
 
       # @!method initialize(token:, account_token:, card_program_token:, card_token:, created:, currency:, disputes_gross_amount:, event_tokens:, institution:, interchange_fee_extended_precision:, interchange_gross_amount:, network:, other_fees_details:, other_fees_gross_amount:, report_date:, settlement_date:, transaction_token:, transactions_gross_amount:, type:, updated:, fee_description: nil)
-      #   @param token [String]
-      #   @param account_token [String]
-      #   @param card_program_token [String]
-      #   @param card_token [String]
-      #   @param created [Time]
-      #   @param currency [String]
-      #   @param disputes_gross_amount [Integer]
-      #   @param event_tokens [Array<String>]
-      #   @param institution [String]
-      #   @param interchange_fee_extended_precision [Integer]
-      #   @param interchange_gross_amount [Integer]
-      #   @param network [Symbol, Lithic::Models::SettlementDetail::Network]
-      #   @param other_fees_details [Lithic::Models::SettlementDetail::OtherFeesDetails]
-      #   @param other_fees_gross_amount [Integer]
-      #   @param report_date [String]
-      #   @param settlement_date [String]
-      #   @param transaction_token [String]
-      #   @param transactions_gross_amount [Integer]
-      #   @param type [Symbol, Lithic::Models::SettlementDetail::Type]
-      #   @param updated [Time]
-      #   @param fee_description [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::SettlementDetail} for more details.
+      #
+      #   @param token [String] Globally unique identifier denoting the Settlement Detail.
+      #
+      #   @param account_token [String] The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE f
+      #   ...
+      #
+      #   @param card_program_token [String] Globally unique identifier denoting the card program that the associated Transac
+      #   ...
+      #
+      #   @param card_token [String] Globally unique identifier denoting the card that the associated Transaction occ
+      #   ...
+      #
+      #   @param created [Time] Date and time when the transaction first occurred. UTC time zone.
+      #
+      #   @param currency [String] Three-character alphabetic ISO 4217 code.
+      #
+      #   @param disputes_gross_amount [Integer] The total gross amount of disputes settlements.
+      #
+      #   @param event_tokens [Array<String>] Globally unique identifiers denoting the Events associated with this settlement.
+      #   ...
+      #
+      #   @param institution [String] The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE f
+      #   ...
+      #
+      #   @param interchange_fee_extended_precision [Integer] The total amount of interchange in six-digit extended precision.
+      #
+      #   @param interchange_gross_amount [Integer] The total amount of interchange.
+      #
+      #   @param network [Symbol, Lithic::Models::SettlementDetail::Network] Card network where the transaction took place.
+      #
+      #   @param other_fees_details [Lithic::Models::SettlementDetail::OtherFeesDetails] The total gross amount of other fees by type.
+      #
+      #   @param other_fees_gross_amount [Integer] Total amount of gross other fees outside of interchange.
+      #
+      #   @param report_date [String] Date of when the report was first generated.
+      #
+      #   @param settlement_date [String] Date of when money movement is triggered for the transaction.
+      #
+      #   @param transaction_token [String] Globally unique identifier denoting the associated Transaction object.
+      #
+      #   @param transactions_gross_amount [Integer] The total amount of settlement impacting transactions (excluding interchange, fe
+      #   ...
+      #
+      #   @param type [Symbol, Lithic::Models::SettlementDetail::Type] The type of settlement record.
+      #
+      #   @param updated [Time] Date and time when the transaction first occurred. UTC time zone.
+      #
+      #   @param fee_description [String] Network's description of a fee, only present on records with type `FEE`.
 
       # Card network where the transaction took place.
       #

data/lib/lithic/models/settlement_report.rb

@@ -96,17 +96,36 @@ module Lithic
       required :updated, Time
 
       # @!method initialize(created:, currency:, details:, disputes_gross_amount:, interchange_gross_amount:, is_complete:, other_fees_gross_amount:, report_date:, settled_net_amount:, transactions_gross_amount:, updated:)
-      #   @param created [Time]
-      #   @param currency [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::SettlementReport} for more details.
+      #
+      #   @param created [Time] Date and time when the transaction first occurred. UTC time zone.
+      #
+      #   @param currency [String] 3-character alphabetic ISO 4217 code. (This field is deprecated and will be remo
+      #   ...
+      #
       #   @param details [Array<Lithic::Models::SettlementSummaryDetails>]
-      #   @param disputes_gross_amount [Integer]
-      #   @param interchange_gross_amount [Integer]
-      #   @param is_complete [Boolean]
-      #   @param other_fees_gross_amount [Integer]
-      #   @param report_date [String]
-      #   @param settled_net_amount [Integer]
-      #   @param transactions_gross_amount [Integer]
-      #   @param updated [Time]
+      #
+      #   @param disputes_gross_amount [Integer] The total gross amount of disputes settlements. (This field is deprecated and wi
+      #   ...
+      #
+      #   @param interchange_gross_amount [Integer] The total amount of interchange. (This field is deprecated and will be removed i
+      #   ...
+      #
+      #   @param is_complete [Boolean] Indicates that all data expected on the given report date is available.
+      #
+      #   @param other_fees_gross_amount [Integer] Total amount of gross other fees outside of interchange. (This field is deprecat
+      #   ...
+      #
+      #   @param report_date [String] Date of when the report was first generated.
+      #
+      #   @param settled_net_amount [Integer] The total net amount of cash moved. (net value of settled_gross_amount, intercha
+      #   ...
+      #
+      #   @param transactions_gross_amount [Integer] The total amount of settlement impacting transactions (excluding interchange, fe
+      #   ...
+      #
+      #   @param updated [Time] Date and time when the transaction first occurred. UTC time zone.
     end
   end
 end

data/lib/lithic/models/settlement_summary_details.rb

@@ -55,14 +55,27 @@ module Lithic
       optional :transactions_gross_amount, Integer
 
       # @!method initialize(currency: nil, disputes_gross_amount: nil, institution: nil, interchange_gross_amount: nil, network: nil, other_fees_gross_amount: nil, settled_net_amount: nil, transactions_gross_amount: nil)
-      #   @param currency [String]
-      #   @param disputes_gross_amount [Integer]
-      #   @param institution [String]
-      #   @param interchange_gross_amount [Integer]
-      #   @param network [Symbol, Lithic::Models::SettlementSummaryDetails::Network]
-      #   @param other_fees_gross_amount [Integer]
-      #   @param settled_net_amount [Integer]
-      #   @param transactions_gross_amount [Integer]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::SettlementSummaryDetails} for more details.
+      #
+      #   @param currency [String] 3-character alphabetic ISO 4217 code.
+      #
+      #   @param disputes_gross_amount [Integer] The total gross amount of disputes settlements.
+      #
+      #   @param institution [String] The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE f
+      #   ...
+      #
+      #   @param interchange_gross_amount [Integer] The total amount of interchange.
+      #
+      #   @param network [Symbol, Lithic::Models::SettlementSummaryDetails::Network] Card network where the transaction took place
+      #
+      #   @param other_fees_gross_amount [Integer] Total amount of gross other fees outside of interchange.
+      #
+      #   @param settled_net_amount [Integer] The total net amount of cash moved. (net value of settled_gross_amount, intercha
+      #   ...
+      #
+      #   @param transactions_gross_amount [Integer] The total amount of settlement impacting transactions (excluding interchange, fe
+      #   ...
 
       # Card network where the transaction took place
       #

data/lib/lithic/models/shipping_address.rb

@@ -79,17 +79,37 @@ module Lithic
       optional :phone_number, String
 
       # @!method initialize(address1:, city:, country:, first_name:, last_name:, postal_code:, state:, address2: nil, email: nil, line2_text: nil, phone_number: nil)
-      #   @param address1 [String]
-      #   @param city [String]
-      #   @param country [String]
-      #   @param first_name [String]
-      #   @param last_name [String]
-      #   @param postal_code [String]
-      #   @param state [String]
-      #   @param address2 [String]
-      #   @param email [String]
-      #   @param line2_text [String]
-      #   @param phone_number [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::ShippingAddress} for more details.
+      #
+      #   @param address1 [String] Valid USPS routable address.
+      #
+      #   @param city [String] City
+      #
+      #   @param country [String] Uppercase ISO 3166-1 alpha-3 three character abbreviation.
+      #
+      #   @param first_name [String] Customer's first name. This will be the first name printed on the physical card.
+      #   ...
+      #
+      #   @param last_name [String] Customer's surname (family name). This will be the last name printed on the phys
+      #   ...
+      #
+      #   @param postal_code [String] Postal code (formerly zipcode). For US addresses, either five-digit postal code
+      #   ...
+      #
+      #   @param state [String] Uppercase ISO 3166-2 two character abbreviation for US and CA. Optional with a l
+      #   ...
+      #
+      #   @param address2 [String] Unit number (if applicable).
+      #
+      #   @param email [String] Email address to be contacted for expedited shipping process purposes. Required
+      #   ...
+      #
+      #   @param line2_text [String] Text to be printed on line two of the physical card. Use of this field requires
+      #   ...
+      #
+      #   @param phone_number [String] Cardholder's phone number in E.164 format to be contacted for expedited shipping
+      #   ...
     end
   end
 end