increase 1.87.0 → 1.89.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/increase/client.rb +0 -4
  5. data/lib/increase/models/account_transfer.rb +32 -44
  6. data/lib/increase/models/account_transfer_create_params.rb +11 -8
  7. data/lib/increase/models/{card_detail_create_details_iframe_params.rb → card_create_details_iframe_params.rb} +8 -4
  8. data/lib/increase/models/card_details.rb +7 -7
  9. data/lib/increase/models/{card_detail_details_params.rb → card_details_params.rb} +2 -2
  10. data/lib/increase/models/card_iframe_url.rb +1 -1
  11. data/lib/increase/models/card_update_params.rb +1 -9
  12. data/lib/increase/models/{card_detail_update_params.rb → card_update_pin_params.rb} +2 -2
  13. data/lib/increase/models.rb +6 -6
  14. data/lib/increase/resources/account_transfers.rb +6 -6
  15. data/lib/increase/resources/cards.rb +75 -3
  16. data/lib/increase/version.rb +1 -1
  17. data/lib/increase.rb +3 -4
  18. data/rbi/increase/client.rbi +0 -3
  19. data/rbi/increase/models/account_transfer.rbi +36 -53
  20. data/rbi/increase/models/account_transfer_create_params.rbi +14 -8
  21. data/rbi/increase/models/{card_detail_create_details_iframe_params.rbi → card_create_details_iframe_params.rbi} +6 -4
  22. data/rbi/increase/models/card_details.rbi +8 -10
  23. data/rbi/increase/models/{card_detail_details_params.rbi → card_details_params.rbi} +2 -2
  24. data/rbi/increase/models/card_update_params.rbi +0 -11
  25. data/rbi/increase/models/{card_detail_update_params.rbi → card_update_pin_params.rbi} +2 -2
  26. data/rbi/increase/models.rbi +7 -7
  27. data/rbi/increase/resources/account_transfers.rbi +9 -6
  28. data/rbi/increase/resources/cards.rbi +52 -3
  29. data/sig/increase/client.rbs +0 -2
  30. data/sig/increase/models/account_transfer.rbs +2 -17
  31. data/sig/increase/models/{card_detail_create_details_iframe_params.rbs → card_create_details_iframe_params.rbs} +2 -2
  32. data/sig/increase/models/card_details.rbs +7 -7
  33. data/sig/increase/models/{card_detail_details_params.rbs → card_details_params.rbs} +2 -2
  34. data/sig/increase/models/card_update_params.rbs +0 -7
  35. data/sig/increase/models/{card_detail_update_params.rbs → card_update_pin_params.rbs} +2 -2
  36. data/sig/increase/models.rbs +6 -6
  37. data/sig/increase/resources/cards.rbs +17 -1
  38. metadata +11 -14
  39. data/lib/increase/resources/card_details.rb +0 -85
  40. data/rbi/increase/resources/card_details.rbi +0 -63
  41. data/sig/increase/resources/card_details.rbs +0 -24
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 651a08df9db757f9807b44084d880c18a72ba3b8d1b60a32fb21f494cf364f24
4
- data.tar.gz: 204a76e612b67a10971a315ba582a122ea93b24ed63cc9886b4a9875062e0097
3
+ metadata.gz: 7275a50335699dbca8dcdf0923eb6fba66c94f4d2fdc9de51b95e47eb1c7cdfa
4
+ data.tar.gz: 2c63e95248ae8a51fbdb5cc28129a858bfab693e5270a1224adbc7f1382bd370
5
5
  SHA512:
6
- metadata.gz: ee3739c424b428642147a8e6be0f1fbc9813b7cb57769dbf8f98302afb3df755ae9bf33fee8ccb64cb45b3a3f78316d6e9510b07d0b04f3bc98ddb4e2d898fc9
7
- data.tar.gz: c41e29246c83630864f1ce2a2b95154c666f9153957d891a206a5a9f68c3eda800d2c6eabaf57e7f9880e138404a6750b307e6847c6dd9bc57ab8431c7dc6145
6
+ metadata.gz: cd47cadc3ae99bc005107f1306016c7e2e96598b515c1f13727e54747c03017d11084f35a256c76c88dc51f4af21fa62c5b153c8451e9078ba08f73d97eea964
7
+ data.tar.gz: a4f3e10c76f5ad48f5064a28eedc301a1fe656893647ad821f68862cd175fbf48d8a9cd23a1c231dab7a09178b5857c8ad5b5fb505603f6cc6e674c086fc755b
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.89.0 (2025-09-24)
4
+
5
+ Full Changelog: [v1.88.0...v1.89.0](https://github.com/Increase/increase-ruby/compare/v1.88.0...v1.89.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([603e760](https://github.com/Increase/increase-ruby/commit/603e760be76b7ef00f4f13c32e4f79b33a1753e2))
10
+
11
+ ## 1.88.0 (2025-09-24)
12
+
13
+ Full Changelog: [v1.87.0...v1.88.0](https://github.com/Increase/increase-ruby/compare/v1.87.0...v1.88.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** api update ([3f9bdb7](https://github.com/Increase/increase-ruby/commit/3f9bdb780f32cc60a80b2db10cf3eea3f7872330))
18
+
3
19
  ## 1.87.0 (2025-09-23)
4
20
 
5
21
  Full Changelog: [v1.86.0...v1.87.0](https://github.com/Increase/increase-ruby/compare/v1.86.0...v1.87.0)
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "increase", "~> 1.87.0"
18
+ gem "increase", "~> 1.89.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -35,9 +35,6 @@ module Increase
35
35
  # @return [Increase::Resources::Cards]
36
36
  attr_reader :cards
37
37
 
38
- # @return [Increase::Resources::CardDetails]
39
- attr_reader :card_details
40
-
41
38
  # @return [Increase::Resources::CardPayments]
42
39
  attr_reader :card_payments
43
40
 
@@ -254,7 +251,6 @@ module Increase
254
251
  @account_numbers = Increase::Resources::AccountNumbers.new(client: self)
255
252
  @account_transfers = Increase::Resources::AccountTransfers.new(client: self)
256
253
  @cards = Increase::Resources::Cards.new(client: self)
257
- @card_details = Increase::Resources::CardDetails.new(client: self)
258
254
  @card_payments = Increase::Resources::CardPayments.new(client: self)
259
255
  @card_purchase_supplements = Increase::Resources::CardPurchaseSupplements.new(client: self)
260
256
  @physical_cards = Increase::Resources::PhysicalCards.new(client: self)
@@ -5,20 +5,20 @@ module Increase
5
5
  # @see Increase::Resources::AccountTransfers#create
6
6
  class AccountTransfer < Increase::Internal::Type::BaseModel
7
7
  # @!attribute id
8
- # The account transfer's identifier.
8
+ # The Account Transfer's identifier.
9
9
  #
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
13
  # @!attribute account_id
14
- # The Account to which the transfer belongs.
14
+ # The Account from which the transfer originated.
15
15
  #
16
16
  # @return [String]
17
17
  required :account_id, String
18
18
 
19
19
  # @!attribute amount
20
- # The transfer amount in the minor unit of the destination account currency. For
21
- # dollars, for example, this is cents.
20
+ # The transfer amount in cents. This will always be positive and indicates the
21
+ # amount of money leaving the originating account.
22
22
  #
23
23
  # @return [Integer]
24
24
  required :amount, Integer
@@ -51,26 +51,28 @@ module Increase
51
51
  required :created_by, -> { Increase::AccountTransfer::CreatedBy }, nil?: true
52
52
 
53
53
  # @!attribute currency
54
- # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
55
- # account currency.
54
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
55
+ # currency.
56
56
  #
57
57
  # @return [Symbol, Increase::Models::AccountTransfer::Currency]
58
58
  required :currency, enum: -> { Increase::AccountTransfer::Currency }
59
59
 
60
60
  # @!attribute description
61
- # The description that will show on the transactions.
61
+ # An internal-facing description for the transfer for display in the API and
62
+ # dashboard. This will also show in the description of the created Transactions.
62
63
  #
63
64
  # @return [String]
64
65
  required :description, String
65
66
 
66
67
  # @!attribute destination_account_id
67
- # The destination account's identifier.
68
+ # The destination Account's identifier.
68
69
  #
69
70
  # @return [String]
70
71
  required :destination_account_id, String
71
72
 
72
73
  # @!attribute destination_transaction_id
73
- # The ID for the transaction receiving the transfer.
74
+ # The identifier of the Transaction on the destination Account representing the
75
+ # received funds.
74
76
  #
75
77
  # @return [String, nil]
76
78
  required :destination_transaction_id, String, nil?: true
@@ -83,12 +85,6 @@ module Increase
83
85
  # @return [String, nil]
84
86
  required :idempotency_key, String, nil?: true
85
87
 
86
- # @!attribute network
87
- # The transfer's network.
88
- #
89
- # @return [Symbol, Increase::Models::AccountTransfer::Network]
90
- required :network, enum: -> { Increase::AccountTransfer::Network }
91
-
92
88
  # @!attribute pending_transaction_id
93
89
  # The ID for the pending transaction representing the transfer. A pending
94
90
  # transaction is created when the transfer
@@ -105,7 +101,8 @@ module Increase
105
101
  required :status, enum: -> { Increase::AccountTransfer::Status }
106
102
 
107
103
  # @!attribute transaction_id
108
- # The ID for the transaction funding the transfer.
104
+ # The identifier of the Transaction on the originating account representing the
105
+ # transferred funds.
109
106
  #
110
107
  # @return [String, nil]
111
108
  required :transaction_id, String, nil?: true
@@ -117,17 +114,22 @@ module Increase
117
114
  # @return [Symbol, Increase::Models::AccountTransfer::Type]
118
115
  required :type, enum: -> { Increase::AccountTransfer::Type }
119
116
 
120
- # @!method initialize(id:, account_id:, amount:, approval:, cancellation:, created_at:, created_by:, currency:, description:, destination_account_id:, destination_transaction_id:, idempotency_key:, network:, pending_transaction_id:, status:, transaction_id:, type:)
117
+ # @!method initialize(id:, account_id:, amount:, approval:, cancellation:, created_at:, created_by:, currency:, description:, destination_account_id:, destination_transaction_id:, idempotency_key:, pending_transaction_id:, status:, transaction_id:, type:)
121
118
  # Some parameter documentations has been truncated, see
122
119
  # {Increase::Models::AccountTransfer} for more details.
123
120
  #
124
- # Account transfers move funds between your own accounts at Increase.
121
+ # Account transfers move funds between your own accounts at Increase (accounting
122
+ # systems often refer to these as Book Transfers). Account Transfers are free and
123
+ # synchronous. Upon creation they create two Transactions, one negative on the
124
+ # originating account and one positive on the destination account (unless the
125
+ # transfer requires approval, in which case the Transactions will be created when
126
+ # the transfer is approved).
125
127
  #
126
- # @param id [String] The account transfer's identifier.
128
+ # @param id [String] The Account Transfer's identifier.
127
129
  #
128
- # @param account_id [String] The Account to which the transfer belongs.
130
+ # @param account_id [String] The Account from which the transfer originated.
129
131
  #
130
- # @param amount [Integer] The transfer amount in the minor unit of the destination account currency. For d
132
+ # @param amount [Integer] The transfer amount in cents. This will always be positive and indicates the amo
131
133
  #
132
134
  # @param approval [Increase::Models::AccountTransfer::Approval, nil] If your account requires approvals for transfers and the transfer was approved,
133
135
  #
@@ -137,23 +139,21 @@ module Increase
137
139
  #
138
140
  # @param created_by [Increase::Models::AccountTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard.
139
141
  #
140
- # @param currency [Symbol, Increase::Models::AccountTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
142
+ # @param currency [Symbol, Increase::Models::AccountTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c
141
143
  #
142
- # @param description [String] The description that will show on the transactions.
144
+ # @param description [String] An internal-facing description for the transfer for display in the API and dashb
143
145
  #
144
- # @param destination_account_id [String] The destination account's identifier.
146
+ # @param destination_account_id [String] The destination Account's identifier.
145
147
  #
146
- # @param destination_transaction_id [String, nil] The ID for the transaction receiving the transfer.
148
+ # @param destination_transaction_id [String, nil] The identifier of the Transaction on the destination Account representing the re
147
149
  #
148
150
  # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
149
151
  #
150
- # @param network [Symbol, Increase::Models::AccountTransfer::Network] The transfer's network.
151
- #
152
152
  # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer. A pending transact
153
153
  #
154
154
  # @param status [Symbol, Increase::Models::AccountTransfer::Status] The lifecycle status of the transfer.
155
155
  #
156
- # @param transaction_id [String, nil] The ID for the transaction funding the transfer.
156
+ # @param transaction_id [String, nil] The identifier of the Transaction on the originating account representing the tr
157
157
  #
158
158
  # @param type [Symbol, Increase::Models::AccountTransfer::Type] A constant representing the object's type. For this resource it will always be `
159
159
 
@@ -312,8 +312,8 @@ module Increase
312
312
  end
313
313
  end
314
314
 
315
- # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
316
- # account currency.
315
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
316
+ # currency.
317
317
  #
318
318
  # @see Increase::Models::AccountTransfer#currency
319
319
  module Currency
@@ -341,28 +341,16 @@ module Increase
341
341
  # @return [Array<Symbol>]
342
342
  end
343
343
 
344
- # The transfer's network.
345
- #
346
- # @see Increase::Models::AccountTransfer#network
347
- module Network
348
- extend Increase::Internal::Type::Enum
349
-
350
- ACCOUNT = :account
351
-
352
- # @!method self.values
353
- # @return [Array<Symbol>]
354
- end
355
-
356
344
  # The lifecycle status of the transfer.
357
345
  #
358
346
  # @see Increase::Models::AccountTransfer#status
359
347
  module Status
360
348
  extend Increase::Internal::Type::Enum
361
349
 
362
- # The transfer is pending approval.
350
+ # The transfer is pending approval from your team.
363
351
  PENDING_APPROVAL = :pending_approval
364
352
 
365
- # The transfer has been canceled.
353
+ # The transfer was pending approval from your team and has been canceled.
366
354
  CANCELED = :canceled
367
355
 
368
356
  # The transfer has been completed.
@@ -8,7 +8,7 @@ module Increase
8
8
  include Increase::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute account_id
11
- # The identifier for the account that will send the transfer.
11
+ # The identifier for the originating Account that will send the transfer.
12
12
  #
13
13
  # @return [String]
14
14
  required :account_id, String
@@ -21,19 +21,22 @@ module Increase
21
21
  required :amount, Integer
22
22
 
23
23
  # @!attribute description
24
- # The description you choose to give the transfer.
24
+ # An internal-facing description for the transfer for display in the API and
25
+ # dashboard. This will also show in the description of the created Transactions.
25
26
  #
26
27
  # @return [String]
27
28
  required :description, String
28
29
 
29
30
  # @!attribute destination_account_id
30
- # The identifier for the account that will receive the transfer.
31
+ # The identifier for the destination Account that will receive the transfer.
31
32
  #
32
33
  # @return [String]
33
34
  required :destination_account_id, String
34
35
 
35
36
  # @!attribute require_approval
36
- # Whether the transfer requires explicit approval via the dashboard or API.
37
+ # Whether the transfer should require explicit approval via the dashboard or API.
38
+ # For more information, see
39
+ # [Transfer Approvals](/documentation/transfer-approvals).
37
40
  #
38
41
  # @return [Boolean, nil]
39
42
  optional :require_approval, Increase::Internal::Type::Boolean
@@ -42,15 +45,15 @@ module Increase
42
45
  # Some parameter documentations has been truncated, see
43
46
  # {Increase::Models::AccountTransferCreateParams} for more details.
44
47
  #
45
- # @param account_id [String] The identifier for the account that will send the transfer.
48
+ # @param account_id [String] The identifier for the originating Account that will send the transfer.
46
49
  #
47
50
  # @param amount [Integer] The transfer amount in the minor unit of the account currency. For dollars, for
48
51
  #
49
- # @param description [String] The description you choose to give the transfer.
52
+ # @param description [String] An internal-facing description for the transfer for display in the API and dashb
50
53
  #
51
- # @param destination_account_id [String] The identifier for the account that will receive the transfer.
54
+ # @param destination_account_id [String] The identifier for the destination Account that will receive the transfer.
52
55
  #
53
- # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
56
+ # @param require_approval [Boolean] Whether the transfer should require explicit approval via the dashboard or API.
54
57
  #
55
58
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
56
59
  end
@@ -2,19 +2,23 @@
2
2
 
3
3
  module Increase
4
4
  module Models
5
- # @see Increase::Resources::CardDetails#create_details_iframe
6
- class CardDetailCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
5
+ # @see Increase::Resources::Cards#create_details_iframe
6
+ class CardCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
7
7
  extend Increase::Internal::Type::RequestParameters::Converter
8
8
  include Increase::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute physical_card_id
11
- # The identifier of the Physical Card to retrieve details for.
11
+ # The identifier of the Physical Card to create an iframe for. This will inform
12
+ # the appearance of the card rendered in the iframe.
12
13
  #
13
14
  # @return [String, nil]
14
15
  optional :physical_card_id, String
15
16
 
16
17
  # @!method initialize(physical_card_id: nil, request_options: {})
17
- # @param physical_card_id [String] The identifier of the Physical Card to retrieve details for.
18
+ # Some parameter documentations has been truncated, see
19
+ # {Increase::Models::CardCreateDetailsIframeParams} for more details.
20
+ #
21
+ # @param physical_card_id [String] The identifier of the Physical Card to create an iframe for. This will inform th
18
22
  #
19
23
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
20
24
  end
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Increase
4
4
  module Models
5
- # @see Increase::Resources::CardDetails#update
6
- class CardDetailsAPI < Increase::Internal::Type::BaseModel
5
+ # @see Increase::Resources::Cards#details
6
+ class CardDetails < Increase::Internal::Type::BaseModel
7
7
  # @!attribute card_id
8
8
  # The identifier for the Card for which sensitive details have been returned.
9
9
  #
@@ -38,8 +38,8 @@ module Increase
38
38
  # A constant representing the object's type. For this resource it will always be
39
39
  # `card_details`.
40
40
  #
41
- # @return [Symbol, Increase::Models::CardDetailsAPI::Type]
42
- required :type, enum: -> { Increase::CardDetailsAPI::Type }
41
+ # @return [Symbol, Increase::Models::CardDetails::Type]
42
+ required :type, enum: -> { Increase::CardDetails::Type }
43
43
 
44
44
  # @!attribute verification_code
45
45
  # The three-digit verification code for the card. It's also known as the Card
@@ -51,7 +51,7 @@ module Increase
51
51
 
52
52
  # @!method initialize(card_id:, expiration_month:, expiration_year:, pin:, primary_account_number:, type:, verification_code:)
53
53
  # Some parameter documentations has been truncated, see
54
- # {Increase::Models::CardDetailsAPI} for more details.
54
+ # {Increase::Models::CardDetails} for more details.
55
55
  #
56
56
  # An object containing the sensitive details (card number, CVC, PIN, etc) for a
57
57
  # Card. These details are not included in the Card object. If you'd prefer to
@@ -69,14 +69,14 @@ module Increase
69
69
  #
70
70
  # @param primary_account_number [String] The card number.
71
71
  #
72
- # @param type [Symbol, Increase::Models::CardDetailsAPI::Type] A constant representing the object's type. For this resource it will always be `
72
+ # @param type [Symbol, Increase::Models::CardDetails::Type] A constant representing the object's type. For this resource it will always be `
73
73
  #
74
74
  # @param verification_code [String] The three-digit verification code for the card. It's also known as the Card Veri
75
75
 
76
76
  # A constant representing the object's type. For this resource it will always be
77
77
  # `card_details`.
78
78
  #
79
- # @see Increase::Models::CardDetailsAPI#type
79
+ # @see Increase::Models::CardDetails#type
80
80
  module Type
81
81
  extend Increase::Internal::Type::Enum
82
82
 
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Increase
4
4
  module Models
5
- # @see Increase::Resources::CardDetails#details
6
- class CardDetailDetailsParams < Increase::Internal::Type::BaseModel
5
+ # @see Increase::Resources::Cards#details
6
+ class CardDetailsParams < Increase::Internal::Type::BaseModel
7
7
  extend Increase::Internal::Type::RequestParameters::Converter
8
8
  include Increase::Internal::Type::RequestParameters
9
9
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  module Increase
4
4
  module Models
5
- # @see Increase::Resources::CardDetails#create_details_iframe
5
+ # @see Increase::Resources::Cards#create_details_iframe
6
6
  class CardIframeURL < Increase::Internal::Type::BaseModel
7
7
  # @!attribute expires_at
8
8
  # The time the iframe URL will expire.
@@ -34,19 +34,13 @@ module Increase
34
34
  # @return [String, nil]
35
35
  optional :entity_id, String
36
36
 
37
- # @!attribute pin
38
- # The 4-digit PIN for the card, for use with ATMs.
39
- #
40
- # @return [String, nil]
41
- optional :pin, String
42
-
43
37
  # @!attribute status
44
38
  # The status to update the Card with.
45
39
  #
46
40
  # @return [Symbol, Increase::Models::CardUpdateParams::Status, nil]
47
41
  optional :status, enum: -> { Increase::CardUpdateParams::Status }
48
42
 
49
- # @!method initialize(billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, pin: nil, status: nil, request_options: {})
43
+ # @!method initialize(billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, status: nil, request_options: {})
50
44
  # Some parameter documentations has been truncated, see
51
45
  # {Increase::Models::CardUpdateParams} for more details.
52
46
  #
@@ -58,8 +52,6 @@ module Increase
58
52
  #
59
53
  # @param entity_id [String] The Entity the card belongs to. You only need to supply this in rare situations
60
54
  #
61
- # @param pin [String] The 4-digit PIN for the card, for use with ATMs.
62
- #
63
55
  # @param status [Symbol, Increase::Models::CardUpdateParams::Status] The status to update the Card with.
64
56
  #
65
57
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Increase
4
4
  module Models
5
- # @see Increase::Resources::CardDetails#update
6
- class CardDetailUpdateParams < Increase::Internal::Type::BaseModel
5
+ # @see Increase::Resources::Cards#update_pin
6
+ class CardUpdatePinParams < Increase::Internal::Type::BaseModel
7
7
  extend Increase::Internal::Type::RequestParameters::Converter
8
8
  include Increase::Internal::Type::RequestParameters
9
9
 
@@ -131,15 +131,13 @@ module Increase
131
131
 
132
132
  Card = Increase::Models::Card
133
133
 
134
- CardCreateParams = Increase::Models::CardCreateParams
135
-
136
- CardDetailCreateDetailsIframeParams = Increase::Models::CardDetailCreateDetailsIframeParams
134
+ CardCreateDetailsIframeParams = Increase::Models::CardCreateDetailsIframeParams
137
135
 
138
- CardDetailDetailsParams = Increase::Models::CardDetailDetailsParams
136
+ CardCreateParams = Increase::Models::CardCreateParams
139
137
 
140
- CardDetailsAPI = Increase::Models::CardDetailsAPI
138
+ CardDetails = Increase::Models::CardDetails
141
139
 
142
- CardDetailUpdateParams = Increase::Models::CardDetailUpdateParams
140
+ CardDetailsParams = Increase::Models::CardDetailsParams
143
141
 
144
142
  CardIframeURL = Increase::Models::CardIframeURL
145
143
 
@@ -183,6 +181,8 @@ module Increase
183
181
 
184
182
  CardUpdateParams = Increase::Models::CardUpdateParams
185
183
 
184
+ CardUpdatePinParams = Increase::Models::CardUpdatePinParams
185
+
186
186
  CardValidation = Increase::Models::CardValidation
187
187
 
188
188
  CardValidationCreateParams = Increase::Models::CardValidationCreateParams
@@ -10,15 +10,15 @@ module Increase
10
10
  #
11
11
  # @overload create(account_id:, amount:, description:, destination_account_id:, require_approval: nil, request_options: {})
12
12
  #
13
- # @param account_id [String] The identifier for the account that will send the transfer.
13
+ # @param account_id [String] The identifier for the originating Account that will send the transfer.
14
14
  #
15
15
  # @param amount [Integer] The transfer amount in the minor unit of the account currency. For dollars, for
16
16
  #
17
- # @param description [String] The description you choose to give the transfer.
17
+ # @param description [String] An internal-facing description for the transfer for display in the API and dashb
18
18
  #
19
- # @param destination_account_id [String] The identifier for the account that will receive the transfer.
19
+ # @param destination_account_id [String] The identifier for the destination Account that will receive the transfer.
20
20
  #
21
- # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
21
+ # @param require_approval [Boolean] Whether the transfer should require explicit approval via the dashboard or API.
22
22
  #
23
23
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
24
24
  #
@@ -90,7 +90,7 @@ module Increase
90
90
  )
91
91
  end
92
92
 
93
- # Approve an Account Transfer
93
+ # Approves an Account Transfer in status `pending_approval`.
94
94
  #
95
95
  # @overload approve(account_transfer_id, request_options: {})
96
96
  #
@@ -110,7 +110,7 @@ module Increase
110
110
  )
111
111
  end
112
112
 
113
- # Cancel an Account Transfer
113
+ # Cancels an Account Transfer in status `pending_approval`.
114
114
  #
115
115
  # @overload cancel(account_transfer_id, request_options: {})
116
116
  #
@@ -55,7 +55,7 @@ module Increase
55
55
  #
56
56
  # Update a Card
57
57
  #
58
- # @overload update(card_id, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, pin: nil, status: nil, request_options: {})
58
+ # @overload update(card_id, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, status: nil, request_options: {})
59
59
  #
60
60
  # @param card_id [String] The card identifier.
61
61
  #
@@ -67,8 +67,6 @@ module Increase
67
67
  #
68
68
  # @param entity_id [String] The Entity the card belongs to. You only need to supply this in rare situations
69
69
  #
70
- # @param pin [String] The 4-digit PIN for the card, for use with ATMs.
71
- #
72
70
  # @param status [Symbol, Increase::Models::CardUpdateParams::Status] The status to update the Card with.
73
71
  #
74
72
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -123,6 +121,80 @@ module Increase
123
121
  )
124
122
  end
125
123
 
124
+ # Some parameter documentations has been truncated, see
125
+ # {Increase::Models::CardCreateDetailsIframeParams} for more details.
126
+ #
127
+ # Create an iframe URL for a Card to display the card details. More details about
128
+ # styling and usage can be found in the
129
+ # [documentation](/documentation/embedded-card-component).
130
+ #
131
+ # @overload create_details_iframe(card_id, physical_card_id: nil, request_options: {})
132
+ #
133
+ # @param card_id [String] The identifier of the Card to create an iframe for.
134
+ #
135
+ # @param physical_card_id [String] The identifier of the Physical Card to create an iframe for. This will inform th
136
+ #
137
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
138
+ #
139
+ # @return [Increase::Models::CardIframeURL]
140
+ #
141
+ # @see Increase::Models::CardCreateDetailsIframeParams
142
+ def create_details_iframe(card_id, params = {})
143
+ parsed, options = Increase::CardCreateDetailsIframeParams.dump_request(params)
144
+ @client.request(
145
+ method: :post,
146
+ path: ["cards/%1$s/create_details_iframe", card_id],
147
+ body: parsed,
148
+ model: Increase::CardIframeURL,
149
+ options: options
150
+ )
151
+ end
152
+
153
+ # Sensitive details for a Card include the primary account number, expiry, card
154
+ # verification code, and PIN.
155
+ #
156
+ # @overload details(card_id, request_options: {})
157
+ #
158
+ # @param card_id [String] The identifier of the Card to retrieve details for.
159
+ #
160
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
161
+ #
162
+ # @return [Increase::Models::CardDetails]
163
+ #
164
+ # @see Increase::Models::CardDetailsParams
165
+ def details(card_id, params = {})
166
+ @client.request(
167
+ method: :get,
168
+ path: ["cards/%1$s/details", card_id],
169
+ model: Increase::CardDetails,
170
+ options: params[:request_options]
171
+ )
172
+ end
173
+
174
+ # Update a Card's PIN
175
+ #
176
+ # @overload update_pin(card_id, pin:, request_options: {})
177
+ #
178
+ # @param card_id [String] The identifier of the Card to update the PIN for.
179
+ #
180
+ # @param pin [String] The 4-digit PIN for the card, for use with ATMs.
181
+ #
182
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
183
+ #
184
+ # @return [Increase::Models::CardDetails]
185
+ #
186
+ # @see Increase::Models::CardUpdatePinParams
187
+ def update_pin(card_id, params)
188
+ parsed, options = Increase::CardUpdatePinParams.dump_request(params)
189
+ @client.request(
190
+ method: :post,
191
+ path: ["cards/%1$s/update_pin", card_id],
192
+ body: parsed,
193
+ model: Increase::CardDetails,
194
+ options: options
195
+ )
196
+ end
197
+
126
198
  # @api private
127
199
  #
128
200
  # @param client [Increase::Client]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.87.0"
4
+ VERSION = "1.89.0"
5
5
  end
data/lib/increase.rb CHANGED
@@ -97,11 +97,10 @@ require_relative "increase/models/bookkeeping_entry_set_create_params"
97
97
  require_relative "increase/models/bookkeeping_entry_set_list_params"
98
98
  require_relative "increase/models/bookkeeping_entry_set_retrieve_params"
99
99
  require_relative "increase/models/card"
100
+ require_relative "increase/models/card_create_details_iframe_params"
100
101
  require_relative "increase/models/card_create_params"
101
- require_relative "increase/models/card_detail_create_details_iframe_params"
102
- require_relative "increase/models/card_detail_details_params"
103
102
  require_relative "increase/models/card_details"
104
- require_relative "increase/models/card_detail_update_params"
103
+ require_relative "increase/models/card_details_params"
105
104
  require_relative "increase/models/card_iframe_url"
106
105
  require_relative "increase/models/card_list_params"
107
106
  require_relative "increase/models/card_payment"
@@ -123,6 +122,7 @@ require_relative "increase/models/card_token_capabilities_params"
123
122
  require_relative "increase/models/card_token_list_params"
124
123
  require_relative "increase/models/card_token_retrieve_params"
125
124
  require_relative "increase/models/card_update_params"
125
+ require_relative "increase/models/card_update_pin_params"
126
126
  require_relative "increase/models/card_validation"
127
127
  require_relative "increase/models/card_validation_create_params"
128
128
  require_relative "increase/models/card_validation_list_params"
@@ -335,7 +335,6 @@ require_relative "increase/resources/ach_transfers"
335
335
  require_relative "increase/resources/bookkeeping_accounts"
336
336
  require_relative "increase/resources/bookkeeping_entries"
337
337
  require_relative "increase/resources/bookkeeping_entry_sets"
338
- require_relative "increase/resources/card_details"
339
338
  require_relative "increase/resources/card_payments"
340
339
  require_relative "increase/resources/card_purchase_supplements"
341
340
  require_relative "increase/resources/card_push_transfers"
@@ -34,9 +34,6 @@ module Increase
34
34
  sig { returns(Increase::Resources::Cards) }
35
35
  attr_reader :cards
36
36
 
37
- sig { returns(Increase::Resources::CardDetails) }
38
- attr_reader :card_details
39
-
40
37
  sig { returns(Increase::Resources::CardPayments) }
41
38
  attr_reader :card_payments
42
39