lithic 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bf1f6b2ae2b269fcbe2e915e81c0729bb7d166f035b27dde8e72d6713733841
-  data.tar.gz: 0c0adcbd79d3f29d0092cd87f2c77e4136219d952544c634c5340014b9ea75bb
+  metadata.gz: d994bf8972c5500b7885b05e3d656c7dda04419796c1abb50218bbe4144e6a1a
+  data.tar.gz: 2f12393da601f3a7877b0b648bf6ff8bbe294cf690889934e9a9883c0ec9bc50
 SHA512:
-  metadata.gz: 9454d14be6e4f884e28b5767cdc99bb8eb90a95890e8f69cc9c328c371edaf7acae6a496fe2ae213adf40e85dc702f5e48f63f1258b2a6153e3e03fef5aa0ed1
-  data.tar.gz: e115e05933d7b77fe91f4705937c27edf9d03fcff923abbbb78a638d5be00a474c8937a327a00d5cb493beeb21b82ed79ebf1ec117ee9ee38f33391b99aea6f3
+  metadata.gz: 033661aaae27e014d00dc52cbb53c631ba2bfb5e604cc7a73d3a0a9e8fa9f00c9f88f34f288275fb548fac171de6c3920a6e88f76be0ba350f8312037a68b157
+  data.tar.gz: 6da37fe057e86fde01f7bbdaec2bbec7c36d9d474dc2c6cdc15cc093bedebe7a161cc222686d6fe53011a2077c8aa77109a8e28931a0087be936ed7ba55b51ae

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.0-alpha.17 (2025-04-21)
+
+Full Changelog: [v0.1.0-alpha.16...v0.1.0-alpha.17](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.16...v0.1.0-alpha.17)
+
+### Bug Fixes
+
+* **internals:** fix Card schema definition ([1a3d18b](https://github.com/lithic-com/lithic-ruby/commit/1a3d18be7e1817fad98013b032defbaa5663b354))
+
 ## 0.1.0-alpha.16 (2025-04-21)
 
 Full Changelog: [v0.1.0-alpha.15...v0.1.0-alpha.16](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.15...v0.1.0-alpha.16)

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.16"
+gem "lithic", "~> 0.1.0.pre.alpha.17"
 ```
 
 <!-- x-release-please-end -->

data/lib/lithic/models/card.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::Cards#create
+    class Card < Lithic::Models::NonPCICard
+      # @!attribute cvv
+      #   Three digit cvv printed on the back of the card.
+      #
+      #   @return [String, nil]
+      optional :cvv, String
+
+      # @!attribute pan
+      #   Primary Account Number (PAN) (i.e. the card number). Customers must be PCI
+      #   compliant to have PAN returned as a field in production. Please contact
+      #   support@lithic.com for questions.
+      #
+      #   @return [String, nil]
+      optional :pan, String
+
+      # @!method initialize(cvv: nil, pan: nil)
+      #   Card details with potentially PCI sensitive information for Enterprise customers
+      #
+      #   @param cvv [String]
+      #   @param pan [String]
+    end
+  end
+end

data/lib/lithic/models/{card_list_response.rb → non_pci_card.rb}

@@ -3,7 +3,7 @@
 module Lithic
   module Models
     # @see Lithic::Resources::Cards#list
-    class CardListResponse < Lithic::Internal::Type::BaseModel
+    class NonPCICard < Lithic::Internal::Type::BaseModel
       # @!attribute token
       #   Globally unique identifier.
       #
@@ -31,8 +31,8 @@ module Lithic
       # @!attribute funding
       #   Deprecated: Funding account for the card.
       #
-      #   @return [Lithic::Models::CardListResponse::Funding]
-      required :funding, -> { Lithic::Models::CardListResponse::Funding }
+      #   @return [Lithic::Models::NonPCICard::Funding]
+      required :funding, -> { Lithic::Models::NonPCICard::Funding }
 
       # @!attribute last_four
       #   Last four digits of the card number.
@@ -44,8 +44,8 @@ module Lithic
       #   Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
       #   attempts).
       #
-      #   @return [Symbol, Lithic::Models::CardListResponse::PinStatus]
-      required :pin_status, enum: -> { Lithic::Models::CardListResponse::PinStatus }
+      #   @return [Symbol, Lithic::Models::NonPCICard::PinStatus]
+      required :pin_status, enum: -> { Lithic::Models::NonPCICard::PinStatus }
 
       # @!attribute spend_limit
       #   Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
@@ -57,8 +57,8 @@ module Lithic
       # @!attribute spend_limit_duration
       #   Spend limit duration
       #
-      #   @return [Symbol, Lithic::Models::CardListResponse::SpendLimitDuration]
-      required :spend_limit_duration, enum: -> { Lithic::Models::CardListResponse::SpendLimitDuration }
+      #   @return [Symbol, Lithic::Models::NonPCICard::SpendLimitDuration]
+      required :spend_limit_duration, enum: -> { Lithic::Models::NonPCICard::SpendLimitDuration }
 
       # @!attribute state
       #   Card state values: _ `CLOSED` - Card will no longer approve authorizations.
@@ -77,8 +77,8 @@ module Lithic
       #   In sandbox, the same daily batch fulfillment occurs, but no cards are actually
       #   manufactured.
       #
-      #   @return [Symbol, Lithic::Models::CardListResponse::State]
-      required :state, enum: -> { Lithic::Models::CardListResponse::State }
+      #   @return [Symbol, Lithic::Models::NonPCICard::State]
+      required :state, enum: -> { Lithic::Models::NonPCICard::State }
 
       # @!attribute type
       #   Card types: _ `VIRTUAL` - Card will authorize at any merchant and can be added
@@ -92,8 +92,8 @@ module Lithic
       #   `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use
       #   VIRTUAL instead.
       #
-      #   @return [Symbol, Lithic::Models::CardListResponse::Type]
-      required :type, enum: -> { Lithic::Models::CardListResponse::Type }
+      #   @return [Symbol, Lithic::Models::NonPCICard::Type]
+      required :type, enum: -> { Lithic::Models::NonPCICard::Type }
 
       # @!attribute auth_rule_tokens
       #   @deprecated
@@ -174,13 +174,13 @@ module Lithic
       #   @param account_token [String]
       #   @param card_program_token [String]
       #   @param created [Time]
-      #   @param funding [Lithic::Models::CardListResponse::Funding]
+      #   @param funding [Lithic::Models::NonPCICard::Funding]
       #   @param last_four [String]
-      #   @param pin_status [Symbol, Lithic::Models::CardListResponse::PinStatus]
+      #   @param pin_status [Symbol, Lithic::Models::NonPCICard::PinStatus]
       #   @param spend_limit [Integer]
-      #   @param spend_limit_duration [Symbol, Lithic::Models::CardListResponse::SpendLimitDuration]
-      #   @param state [Symbol, Lithic::Models::CardListResponse::State]
-      #   @param type [Symbol, Lithic::Models::CardListResponse::Type]
+      #   @param spend_limit_duration [Symbol, Lithic::Models::NonPCICard::SpendLimitDuration]
+      #   @param state [Symbol, Lithic::Models::NonPCICard::State]
+      #   @param type [Symbol, Lithic::Models::NonPCICard::Type]
       #   @param auth_rule_tokens [Array<String>]
       #   @param cardholder_currency [String]
       #   @param digital_card_art_token [String]
@@ -192,7 +192,7 @@ module Lithic
       #   @param product_id [String]
       #   @param replacement_for [String, nil]
 
-      # @see Lithic::Models::CardListResponse#funding
+      # @see Lithic::Models::NonPCICard#funding
       class Funding < Lithic::Internal::Type::BaseModel
         # @!attribute token
         #   A globally unique identifier for this FundingAccount.
@@ -220,15 +220,15 @@ module Lithic
         #   The funding account is still being verified e.g. bank micro-deposits
         #   verification. \* `DELETED` - The founding account has been deleted.
         #
-        #   @return [Symbol, Lithic::Models::CardListResponse::Funding::State]
-        required :state, enum: -> { Lithic::Models::CardListResponse::Funding::State }
+        #   @return [Symbol, Lithic::Models::NonPCICard::Funding::State]
+        required :state, enum: -> { Lithic::Models::NonPCICard::Funding::State }
 
         # @!attribute type
         #   Types of funding source: _ `DEPOSITORY_CHECKING` - Bank checking account. _
         #   `DEPOSITORY_SAVINGS` - Bank savings account.
         #
-        #   @return [Symbol, Lithic::Models::CardListResponse::Funding::Type]
-        required :type, enum: -> { Lithic::Models::CardListResponse::Funding::Type }
+        #   @return [Symbol, Lithic::Models::NonPCICard::Funding::Type]
+        required :type, enum: -> { Lithic::Models::NonPCICard::Funding::Type }
 
         # @!attribute account_name
         #   Account name identifying the funding source. This may be `null`.
@@ -248,8 +248,8 @@ module Lithic
         #   @param token [String]
         #   @param created [Time]
         #   @param last_four [String]
-        #   @param state [Symbol, Lithic::Models::CardListResponse::Funding::State]
-        #   @param type [Symbol, Lithic::Models::CardListResponse::Funding::Type]
+        #   @param state [Symbol, Lithic::Models::NonPCICard::Funding::State]
+        #   @param type [Symbol, Lithic::Models::NonPCICard::Funding::Type]
         #   @param account_name [String]
         #   @param nickname [String]
 
@@ -258,7 +258,7 @@ module Lithic
         # The funding account is still being verified e.g. bank micro-deposits
         # verification. \* `DELETED` - The founding account has been deleted.
         #
-        # @see Lithic::Models::CardListResponse::Funding#state
+        # @see Lithic::Models::NonPCICard::Funding#state
         module State
           extend Lithic::Internal::Type::Enum
 
@@ -273,7 +273,7 @@ module Lithic
         # Types of funding source: _ `DEPOSITORY_CHECKING` - Bank checking account. _
         # `DEPOSITORY_SAVINGS` - Bank savings account.
         #
-        # @see Lithic::Models::CardListResponse::Funding#type
+        # @see Lithic::Models::NonPCICard::Funding#type
         module Type
           extend Lithic::Internal::Type::Enum
 
@@ -288,7 +288,7 @@ module Lithic
       # Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
       # attempts).
       #
-      # @see Lithic::Models::CardListResponse#pin_status
+      # @see Lithic::Models::NonPCICard#pin_status
       module PinStatus
         extend Lithic::Internal::Type::Enum
 
@@ -302,7 +302,7 @@ module Lithic
 
       # Spend limit duration
       #
-      # @see Lithic::Models::CardListResponse#spend_limit_duration
+      # @see Lithic::Models::NonPCICard#spend_limit_duration
       module SpendLimitDuration
         extend Lithic::Internal::Type::Enum
 
@@ -332,7 +332,7 @@ module Lithic
       # In sandbox, the same daily batch fulfillment occurs, but no cards are actually
       # manufactured.
       #
-      # @see Lithic::Models::CardListResponse#state
+      # @see Lithic::Models::NonPCICard#state
       module State
         extend Lithic::Internal::Type::Enum
 
@@ -357,7 +357,7 @@ module Lithic
       # `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use
       # VIRTUAL instead.
       #
-      # @see Lithic::Models::CardListResponse#type
+      # @see Lithic::Models::NonPCICard#type
       module Type
         extend Lithic::Internal::Type::Enum
 

data/lib/lithic/resources/cards.rb

@@ -36,7 +36,7 @@ module Lithic
       # @param state [Symbol, Lithic::Models::CardCreateParams::State]
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::CardCreateResponse]
+      # @return [Lithic::Models::Card]
       #
       # @see Lithic::Models::CardCreateParams
       def create(params)
@@ -45,7 +45,7 @@ module Lithic
           method: :post,
           path: "v1/cards",
           body: parsed,
-          model: Lithic::Models::CardCreateResponse,
+          model: Lithic::Models::Card,
           options: options
         )
       end
@@ -57,14 +57,14 @@ module Lithic
       # @param card_token [String]
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::CardRetrieveResponse]
+      # @return [Lithic::Models::Card]
       #
       # @see Lithic::Models::CardRetrieveParams
       def retrieve(card_token, params = {})
         @client.request(
           method: :get,
           path: ["v1/cards/%1$s", card_token],
-          model: Lithic::Models::CardRetrieveResponse,
+          model: Lithic::Models::Card,
           options: params[:request_options]
         )
       end
@@ -87,7 +87,7 @@ module Lithic
       # @param state [Symbol, Lithic::Models::CardUpdateParams::State]
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::CardUpdateResponse]
+      # @return [Lithic::Models::Card]
       #
       # @see Lithic::Models::CardUpdateParams
       def update(card_token, params = {})
@@ -96,7 +96,7 @@ module Lithic
           method: :patch,
           path: ["v1/cards/%1$s", card_token],
           body: parsed,
-          model: Lithic::Models::CardUpdateResponse,
+          model: Lithic::Models::Card,
           options: options
         )
       end
@@ -114,7 +114,7 @@ module Lithic
       # @param state [Symbol, Lithic::Models::CardListParams::State]
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Internal::CursorPage<Lithic::Models::CardListResponse>]
+      # @return [Lithic::Internal::CursorPage<Lithic::Models::NonPCICard>]
       #
       # @see Lithic::Models::CardListParams
       def list(params = {})
@@ -124,7 +124,7 @@ module Lithic
           path: "v1/cards",
           query: parsed.transform_keys(begin_: "begin", end_: "end"),
           page: Lithic::Internal::CursorPage,
-          model: Lithic::Models::CardListResponse,
+          model: Lithic::Models::NonPCICard,
           options: options
         )
       end
@@ -149,7 +149,7 @@ module Lithic
       # @param shipping_method [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod]
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::CardConvertPhysicalResponse]
+      # @return [Lithic::Models::Card]
       #
       # @see Lithic::Models::CardConvertPhysicalParams
       def convert_physical(card_token, params)
@@ -158,7 +158,7 @@ module Lithic
           method: :post,
           path: ["v1/cards/%1$s/convert_physical", card_token],
           body: parsed,
-          model: Lithic::Models::CardConvertPhysicalResponse,
+          model: Lithic::Models::Card,
           options: options
         )
       end
@@ -259,7 +259,7 @@ module Lithic
       # @param shipping_method [Symbol, Lithic::Models::CardReissueParams::ShippingMethod]
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::CardReissueResponse]
+      # @return [Lithic::Models::Card]
       #
       # @see Lithic::Models::CardReissueParams
       def reissue(card_token, params = {})
@@ -268,7 +268,7 @@ module Lithic
           method: :post,
           path: ["v1/cards/%1$s/reissue", card_token],
           body: parsed,
-          model: Lithic::Models::CardReissueResponse,
+          model: Lithic::Models::Card,
           options: options
         )
       end
@@ -294,7 +294,7 @@ module Lithic
       # @param shipping_method [Symbol, Lithic::Models::CardRenewParams::ShippingMethod]
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::CardRenewResponse]
+      # @return [Lithic::Models::Card]
       #
       # @see Lithic::Models::CardRenewParams
       def renew(card_token, params)
@@ -303,7 +303,7 @@ module Lithic
           method: :post,
           path: ["v1/cards/%1$s/renew", card_token],
           body: parsed,
-          model: Lithic::Models::CardRenewResponse,
+          model: Lithic::Models::Card,
           options: options
         )
       end
@@ -341,7 +341,7 @@ module Lithic
       # @param pan [String]
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::CardSearchByPanResponse]
+      # @return [Lithic::Models::Card]
       #
       # @see Lithic::Models::CardSearchByPanParams
       def search_by_pan(params)
@@ -350,7 +350,7 @@ module Lithic
           method: :post,
           path: "v1/cards/search_by_pan",
           body: parsed,
-          model: Lithic::Models::CardSearchByPanResponse,
+          model: Lithic::Models::Card,
           options: options
         )
       end

data/lib/lithic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lithic
-  VERSION = "0.1.0.pre.alpha.16"
+  VERSION = "0.1.0.pre.alpha.17"
 end

data/lib/lithic.rb

@@ -47,6 +47,7 @@ require_relative "lithic/internal/transport/pooled_net_requester"
 require_relative "lithic/client"
 require_relative "lithic/internal/cursor_page"
 require_relative "lithic/internal/single_page"
+require_relative "lithic/models/non_pci_card"
 require_relative "lithic/models/payment"
 require_relative "lithic/models/three_ds/challenge_response"
 require_relative "lithic/models/account"
@@ -112,24 +113,19 @@ require_relative "lithic/models/book_transfer_list_params"
 require_relative "lithic/models/book_transfer_response"
 require_relative "lithic/models/book_transfer_retrieve_params"
 require_relative "lithic/models/book_transfer_reverse_params"
+require_relative "lithic/models/card"
 require_relative "lithic/models/card_convert_physical_params"
-require_relative "lithic/models/card_convert_physical_response"
 require_relative "lithic/models/card_create_params"
-require_relative "lithic/models/card_create_response"
 require_relative "lithic/models/card_embed_params"
 require_relative "lithic/models/card_list_params"
-require_relative "lithic/models/card_list_response"
 require_relative "lithic/models/card_program"
 require_relative "lithic/models/card_program_list_params"
 require_relative "lithic/models/card_program_retrieve_params"
 require_relative "lithic/models/card_provision_params"
 require_relative "lithic/models/card_provision_response"
 require_relative "lithic/models/card_reissue_params"
-require_relative "lithic/models/card_reissue_response"
 require_relative "lithic/models/card_renew_params"
-require_relative "lithic/models/card_renew_response"
 require_relative "lithic/models/card_retrieve_params"
-require_relative "lithic/models/card_retrieve_response"
 require_relative "lithic/models/card_retrieve_spend_limits_params"
 require_relative "lithic/models/cards/aggregate_balance_list_params"
 require_relative "lithic/models/cards/aggregate_balance_list_response"
@@ -138,10 +134,8 @@ require_relative "lithic/models/cards/balance_list_response"
 require_relative "lithic/models/cards/financial_transaction_list_params"
 require_relative "lithic/models/cards/financial_transaction_retrieve_params"
 require_relative "lithic/models/card_search_by_pan_params"
-require_relative "lithic/models/card_search_by_pan_response"
 require_relative "lithic/models/card_spend_limits"
 require_relative "lithic/models/card_update_params"
-require_relative "lithic/models/card_update_response"
 require_relative "lithic/models/carrier"
 require_relative "lithic/models/client_api_status_params"
 require_relative "lithic/models/credit_products/extended_credit"

data/rbi/lib/lithic/models/card.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class Card < Lithic::Models::NonPCICard
+      # Three digit cvv printed on the back of the card.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cvv
+
+      sig { params(cvv: String).void }
+      attr_writer :cvv
+
+      # Primary Account Number (PAN) (i.e. the card number). Customers must be PCI
+      # compliant to have PAN returned as a field in production. Please contact
+      # support@lithic.com for questions.
+      sig { returns(T.nilable(String)) }
+      attr_reader :pan
+
+      sig { params(pan: String).void }
+      attr_writer :pan
+
+      # Card details with potentially PCI sensitive information for Enterprise customers
+      sig { params(cvv: String, pan: String).returns(T.attached_class) }
+      def self.new(cvv: nil, pan: nil); end
+
+      sig { override.returns({cvv: String, pan: String}) }
+      def to_hash; end
+    end
+  end
+end