lithic 0.1.0.pre.alpha.14 → 0.1.0.pre.alpha.16

data/rbi/lib/lithic/resources/account_holders.rbi

@@ -6,10 +6,11 @@ module Lithic
       # Create an account holder and initiate the appropriate onboarding workflow.
       # Account holders and accounts have a 1:1 relationship. When an account holder is
       # successfully created an associated account is also created. All calls to this
-      # endpoint will return an immediate response - though in some cases, the response
-      # may indicate the enrollment is under review or further action will be needed to
-      # complete the account enrollment process. This endpoint can only be used on
-      # accounts that are part of the program that the calling API key manages.
+      # endpoint will return a synchronous response. The response time will depend on
+      # the workflow. In some cases, the response may indicate the workflow is under
+      # review or further action will be needed to complete the account creation
+      # process. This endpoint can only be used on accounts that are part of the program
+      # that the calling API key manages.
       sig do
         params(
           beneficial_owner_individuals: T::Array[T.any(Lithic::Models::AccountHolderCreateParams::BeneficialOwnerIndividual, Lithic::Internal::AnyHash)],
@@ -36,9 +37,10 @@ module Lithic
           .returns(Lithic::Models::AccountHolderCreateResponse)
       end
       def create(
-        # List of all direct and indirect individuals with 25% or more ownership in the
-        # company. If no individual owns 25% of the company, please identify the largest
-        # shareholder in this field. See
+        # You must submit a list of all direct and indirect individuals with 25% or more
+        # ownership in the company. A maximum of 4 beneficial owners can be submitted. If
+        # no individual owns 25% of the company you do not need to send beneficial owner
+        # information. See
         # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
         # (Section I) for more background on individuals that should be included.
         beneficial_owner_individuals:,
@@ -121,10 +123,11 @@ module Lithic
       # is performing KYB or KYC and additional verification is required we will run the
       # individual's or business's updated information again and return whether the
       # status is accepted or pending (i.e., further action required). All calls to this
-      # endpoint will return an immediate response - though in some cases, the response
-      # may indicate the workflow is under review or further action will be needed to
-      # complete the evaluation process. This endpoint can only be used on existing
-      # accounts that are part of the program that the calling API key manages.
+      # endpoint will return a synchronous response. The response time will depend on
+      # the workflow. In some cases, the response may indicate the workflow is under
+      # review or further action will be needed to complete the account creation
+      # process. This endpoint can only be used on existing accounts that are part of
+      # the program that the calling API key manages.
       sig do
         params(
           account_holder_token: String,
@@ -157,9 +160,10 @@ module Lithic
         account_holder_token,
         # Deprecated.
         beneficial_owner_entities: nil,
-        # List of all direct and indirect individuals with 25% or more ownership in the
-        # company. If no individual owns 25% of the company, please identify the largest
-        # shareholder in this field. See
+        # You must submit a list of all direct and indirect individuals with 25% or more
+        # ownership in the company. A maximum of 4 beneficial owners can be submitted. If
+        # no individual owns 25% of the company you do not need to send beneficial owner
+        # information. See
         # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
         # (Section I) for more background on individuals that should be included.
         beneficial_owner_individuals: nil,

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::Card)
+          .returns(Lithic::Models::CardCreateResponse)
       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::Card)
+          .returns(Lithic::Models::CardRetrieveResponse)
       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::Card)
+          .returns(Lithic::Models::CardUpdateResponse)
       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::Card])
+          .returns(Lithic::Internal::CursorPage[Lithic::Models::CardListResponse])
       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::Card)
+          .returns(Lithic::Models::CardConvertPhysicalResponse)
       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::Card)
+          .returns(Lithic::Models::CardReissueResponse)
       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::Card)
+          .returns(Lithic::Models::CardRenewResponse)
       end
       def renew(
         card_token,
@@ -508,7 +508,7 @@ module Lithic
             )
           )
         )
-          .returns(Lithic::Models::Card)
+          .returns(Lithic::Models::CardSearchByPanResponse)
       end
       def search_by_pan(
         # The PAN for the card being retrieved.

data/rbi/lib/lithic/resources/payments.rbi

@@ -128,7 +128,7 @@ module Lithic
           .returns(Lithic::Models::PaymentSimulateReceiptResponse)
       end
       def simulate_receipt(
-        # Payment token
+        # Customer-generated payment token used to uniquely identify the simulated payment
         token:,
         # Amount
         amount:,

data/sig/lithic/internal/type/array_of.rbs

@@ -15,6 +15,8 @@ module Lithic
 
         def ==: (top other) -> bool
 
+        def hash: -> Integer
+
         def coerce: (
           ::Array[top] | top value,
           state: Lithic::Internal::Type::Converter::coerce_state

data/sig/lithic/internal/type/base_model.rbs

@@ -49,8 +49,12 @@ module Lithic
 
         def self.==: (top other) -> bool
 
+        def self.hash: -> Integer
+
         def ==: (top other) -> bool
 
+        def hash: -> Integer
+
         def self.coerce: (
           Lithic::Internal::Type::BaseModel | ::Hash[top, top] | top value,
           state: Lithic::Internal::Type::Converter::coerce_state
@@ -69,6 +73,10 @@ module Lithic
 
         def deconstruct_keys: (::Array[Symbol]? keys) -> ::Hash[Symbol, top]
 
+        def self.walk: (
+          Lithic::Internal::Type::BaseModel model
+        ) -> ::Hash[Symbol, top]
+
         def to_json: (*top a) -> String
 
         def to_yaml: (*top a) -> String
@@ -77,6 +85,8 @@ module Lithic
 
         def self.inspect: (?depth: Integer) -> String
 
+        def to_s: -> String
+
         def inspect: -> String
       end
     end

data/sig/lithic/internal/type/enum.rbs

@@ -6,12 +6,12 @@ module Lithic
 
         def self.values: -> ::Array[(nil | bool | Integer | Float | Symbol)]
 
-        private def self.finalize!: -> void
-
         def ===: (top other) -> bool
 
         def ==: (top other) -> bool
 
+        def hash: -> Integer
+
         def coerce: (
           String | Symbol | top value,
           state: Lithic::Internal::Type::Converter::coerce_state

data/sig/lithic/internal/type/hash_of.rbs

@@ -15,6 +15,8 @@ module Lithic
 
         def ==: (top other) -> bool
 
+        def hash: -> Integer
+
         def coerce: (
           ::Hash[top, top] | top value,
           state: Lithic::Internal::Type::Converter::coerce_state

data/sig/lithic/internal/type/union.rbs

@@ -30,6 +30,8 @@ module Lithic
 
         def ==: (top other) -> bool
 
+        def hash: -> Integer
+
         def coerce: (
           top value,
           state: Lithic::Internal::Type::Converter::coerce_state

data/sig/lithic/models/card_convert_physical_response.rbs

@@ -0,0 +1,257 @@
+module Lithic
+  module Models
+    type card_convert_physical_response =
+      {
+        token: String,
+        account_token: String,
+        card_program_token: String,
+        created: Time,
+        funding: Lithic::Models::CardConvertPhysicalResponse::Funding,
+        last_four: String,
+        pin_status: Lithic::Models::CardConvertPhysicalResponse::pin_status,
+        spend_limit: Integer,
+        spend_limit_duration: Lithic::Models::CardConvertPhysicalResponse::spend_limit_duration,
+        state: Lithic::Models::CardConvertPhysicalResponse::state,
+        type: Lithic::Models::CardConvertPhysicalResponse::type_,
+        auth_rule_tokens: ::Array[String],
+        cardholder_currency: String,
+        cvv: String,
+        digital_card_art_token: String,
+        exp_month: String,
+        exp_year: String,
+        hostname: String,
+        memo: String,
+        pan: String,
+        pending_commands: ::Array[String],
+        product_id: String,
+        replacement_for: String?
+      }
+
+    class CardConvertPhysicalResponse < Lithic::Internal::Type::BaseModel
+      attr_accessor token: String
+
+      attr_accessor account_token: String
+
+      attr_accessor card_program_token: String
+
+      attr_accessor created: Time
+
+      attr_accessor funding: Lithic::Models::CardConvertPhysicalResponse::Funding
+
+      attr_accessor last_four: String
+
+      attr_accessor pin_status: Lithic::Models::CardConvertPhysicalResponse::pin_status
+
+      attr_accessor spend_limit: Integer
+
+      attr_accessor spend_limit_duration: Lithic::Models::CardConvertPhysicalResponse::spend_limit_duration
+
+      attr_accessor state: Lithic::Models::CardConvertPhysicalResponse::state
+
+      attr_accessor type: Lithic::Models::CardConvertPhysicalResponse::type_
+
+      attr_reader auth_rule_tokens: ::Array[String]?
+
+      def auth_rule_tokens=: (::Array[String]) -> ::Array[String]
+
+      attr_reader cardholder_currency: String?
+
+      def cardholder_currency=: (String) -> String
+
+      attr_reader cvv: String?
+
+      def cvv=: (String) -> String
+
+      attr_reader digital_card_art_token: String?
+
+      def digital_card_art_token=: (String) -> String
+
+      attr_reader exp_month: String?
+
+      def exp_month=: (String) -> String
+
+      attr_reader exp_year: String?
+
+      def exp_year=: (String) -> String
+
+      attr_reader hostname: String?
+
+      def hostname=: (String) -> String
+
+      attr_reader memo: String?
+
+      def memo=: (String) -> String
+
+      attr_reader pan: String?
+
+      def pan=: (String) -> String
+
+      attr_reader pending_commands: ::Array[String]?
+
+      def pending_commands=: (::Array[String]) -> ::Array[String]
+
+      attr_reader product_id: String?
+
+      def product_id=: (String) -> String
+
+      attr_accessor replacement_for: String?
+
+      def initialize: (
+        token: String,
+        account_token: String,
+        card_program_token: String,
+        created: Time,
+        funding: Lithic::Models::CardConvertPhysicalResponse::Funding,
+        last_four: String,
+        pin_status: Lithic::Models::CardConvertPhysicalResponse::pin_status,
+        spend_limit: Integer,
+        spend_limit_duration: Lithic::Models::CardConvertPhysicalResponse::spend_limit_duration,
+        state: Lithic::Models::CardConvertPhysicalResponse::state,
+        type: Lithic::Models::CardConvertPhysicalResponse::type_,
+        ?auth_rule_tokens: ::Array[String],
+        ?cardholder_currency: String,
+        ?cvv: String,
+        ?digital_card_art_token: String,
+        ?exp_month: String,
+        ?exp_year: String,
+        ?hostname: String,
+        ?memo: String,
+        ?pan: String,
+        ?pending_commands: ::Array[String],
+        ?product_id: String,
+        ?replacement_for: String?
+      ) -> void
+
+      def to_hash: -> Lithic::Models::card_convert_physical_response
+
+      type funding =
+        {
+          token: String,
+          created: Time,
+          last_four: String,
+          state: Lithic::Models::CardConvertPhysicalResponse::Funding::state,
+          type: Lithic::Models::CardConvertPhysicalResponse::Funding::type_,
+          account_name: String,
+          nickname: String
+        }
+
+      class Funding < Lithic::Internal::Type::BaseModel
+        attr_accessor token: String
+
+        attr_accessor created: Time
+
+        attr_accessor last_four: String
+
+        attr_accessor state: Lithic::Models::CardConvertPhysicalResponse::Funding::state
+
+        attr_accessor type: Lithic::Models::CardConvertPhysicalResponse::Funding::type_
+
+        attr_reader account_name: String?
+
+        def account_name=: (String) -> String
+
+        attr_reader nickname: String?
+
+        def nickname=: (String) -> String
+
+        def initialize: (
+          token: String,
+          created: Time,
+          last_four: String,
+          state: Lithic::Models::CardConvertPhysicalResponse::Funding::state,
+          type: Lithic::Models::CardConvertPhysicalResponse::Funding::type_,
+          ?account_name: String,
+          ?nickname: String
+        ) -> void
+
+        def to_hash: -> Lithic::Models::CardConvertPhysicalResponse::funding
+
+        type state = :DELETED | :ENABLED | :PENDING
+
+        module State
+          extend Lithic::Internal::Type::Enum
+
+          DELETED: :DELETED
+          ENABLED: :ENABLED
+          PENDING: :PENDING
+
+          def self?.values: -> ::Array[Lithic::Models::CardConvertPhysicalResponse::Funding::state]
+        end
+
+        type type_ = :DEPOSITORY_CHECKING | :DEPOSITORY_SAVINGS
+
+        module Type
+          extend Lithic::Internal::Type::Enum
+
+          DEPOSITORY_CHECKING: :DEPOSITORY_CHECKING
+          DEPOSITORY_SAVINGS: :DEPOSITORY_SAVINGS
+
+          def self?.values: -> ::Array[Lithic::Models::CardConvertPhysicalResponse::Funding::type_]
+        end
+      end
+
+      type pin_status = :OK | :BLOCKED | :NOT_SET
+
+      module PinStatus
+        extend Lithic::Internal::Type::Enum
+
+        OK: :OK
+        BLOCKED: :BLOCKED
+        NOT_SET: :NOT_SET
+
+        def self?.values: -> ::Array[Lithic::Models::CardConvertPhysicalResponse::pin_status]
+      end
+
+      type spend_limit_duration =
+        :ANNUALLY | :FOREVER | :MONTHLY | :TRANSACTION | :DAILY
+
+      module SpendLimitDuration
+        extend Lithic::Internal::Type::Enum
+
+        ANNUALLY: :ANNUALLY
+        FOREVER: :FOREVER
+        MONTHLY: :MONTHLY
+        TRANSACTION: :TRANSACTION
+        DAILY: :DAILY
+
+        def self?.values: -> ::Array[Lithic::Models::CardConvertPhysicalResponse::spend_limit_duration]
+      end
+
+      type state =
+        :CLOSED | :OPEN | :PAUSED | :PENDING_ACTIVATION | :PENDING_FULFILLMENT
+
+      module State
+        extend Lithic::Internal::Type::Enum
+
+        CLOSED: :CLOSED
+        OPEN: :OPEN
+        PAUSED: :PAUSED
+        PENDING_ACTIVATION: :PENDING_ACTIVATION
+        PENDING_FULFILLMENT: :PENDING_FULFILLMENT
+
+        def self?.values: -> ::Array[Lithic::Models::CardConvertPhysicalResponse::state]
+      end
+
+      type type_ =
+        :MERCHANT_LOCKED
+        | :PHYSICAL
+        | :SINGLE_USE
+        | :VIRTUAL
+        | :UNLOCKED
+        | :DIGITAL_WALLET
+
+      module Type
+        extend Lithic::Internal::Type::Enum
+
+        MERCHANT_LOCKED: :MERCHANT_LOCKED
+        PHYSICAL: :PHYSICAL
+        SINGLE_USE: :SINGLE_USE
+        VIRTUAL: :VIRTUAL
+        UNLOCKED: :UNLOCKED
+        DIGITAL_WALLET: :DIGITAL_WALLET
+
+        def self?.values: -> ::Array[Lithic::Models::CardConvertPhysicalResponse::type_]
+      end
+    end
+  end
+end