increase 1.87.0 → 1.88.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +1 -1
- data/lib/increase/models/account_transfer.rb +32 -44
- data/lib/increase/models/account_transfer_create_params.rb +11 -8
- data/lib/increase/resources/account_transfers.rb +6 -6
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/account_transfer.rbi +36 -53
- data/rbi/increase/models/account_transfer_create_params.rbi +14 -8
- data/rbi/increase/resources/account_transfers.rbi +9 -6
- data/sig/increase/models/account_transfer.rbs +2 -17
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 28e4e918e75be24fe1c8de97de0357a7163a0631b1741e72de4af80978c6ad81
|
4
|
+
data.tar.gz: bba9eed9fd83096412760d61ee04a654c5a369232b3be140f46727f78062298a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a6f5eccbb57c9f4d38188a656ebf86bc2226a8427f0fc6fd67f3dfbd127a57827d24f69895c855054328002c7dc5ed82c8a3d5e8a702d7a1317bd92309c125c8
|
7
|
+
data.tar.gz: 4e228422b0e4f07e4051c7b96d7276bf280bd37ff1570f4d73c845842f1dc713a9a1f0a31989886332ee642e7eac5c2f643e38e5de45c2d5530b250382aa2b12
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 1.88.0 (2025-09-24)
|
4
|
+
|
5
|
+
Full Changelog: [v1.87.0...v1.88.0](https://github.com/Increase/increase-ruby/compare/v1.87.0...v1.88.0)
|
6
|
+
|
7
|
+
### Features
|
8
|
+
|
9
|
+
* **api:** api update ([3f9bdb7](https://github.com/Increase/increase-ruby/commit/3f9bdb780f32cc60a80b2db10cf3eea3f7872330))
|
10
|
+
|
3
11
|
## 1.87.0 (2025-09-23)
|
4
12
|
|
5
13
|
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
@@ -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
|
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
|
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
|
21
|
-
#
|
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
|
55
|
-
#
|
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
|
-
#
|
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
|
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
|
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
|
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:,
|
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
|
128
|
+
# @param id [String] The Account Transfer's identifier.
|
127
129
|
#
|
128
|
-
# @param account_id [String] The Account
|
130
|
+
# @param account_id [String] The Account from which the transfer originated.
|
129
131
|
#
|
130
|
-
# @param amount [Integer] The transfer amount in
|
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
|
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]
|
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
|
146
|
+
# @param destination_account_id [String] The destination Account's identifier.
|
145
147
|
#
|
146
|
-
# @param destination_transaction_id [String, nil] The
|
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
|
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
|
316
|
-
#
|
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
|
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
|
-
#
|
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
|
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
|
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
|
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]
|
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
|
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
|
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
|
@@ -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
|
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]
|
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
|
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
|
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
|
-
#
|
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
|
-
#
|
113
|
+
# Cancels an Account Transfer in status `pending_approval`.
|
114
114
|
#
|
115
115
|
# @overload cancel(account_transfer_id, request_options: {})
|
116
116
|
#
|
data/lib/increase/version.rb
CHANGED
@@ -8,16 +8,16 @@ module Increase
|
|
8
8
|
T.any(Increase::AccountTransfer, Increase::Internal::AnyHash)
|
9
9
|
end
|
10
10
|
|
11
|
-
# The
|
11
|
+
# The Account Transfer's identifier.
|
12
12
|
sig { returns(String) }
|
13
13
|
attr_accessor :id
|
14
14
|
|
15
|
-
# The Account
|
15
|
+
# The Account from which the transfer originated.
|
16
16
|
sig { returns(String) }
|
17
17
|
attr_accessor :account_id
|
18
18
|
|
19
|
-
# The transfer amount in
|
20
|
-
#
|
19
|
+
# The transfer amount in cents. This will always be positive and indicates the
|
20
|
+
# amount of money leaving the originating account.
|
21
21
|
sig { returns(Integer) }
|
22
22
|
attr_accessor :amount
|
23
23
|
|
@@ -62,20 +62,22 @@ module Increase
|
|
62
62
|
end
|
63
63
|
attr_writer :created_by
|
64
64
|
|
65
|
-
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
66
|
-
#
|
65
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
|
66
|
+
# currency.
|
67
67
|
sig { returns(Increase::AccountTransfer::Currency::TaggedSymbol) }
|
68
68
|
attr_accessor :currency
|
69
69
|
|
70
|
-
#
|
70
|
+
# An internal-facing description for the transfer for display in the API and
|
71
|
+
# dashboard. This will also show in the description of the created Transactions.
|
71
72
|
sig { returns(String) }
|
72
73
|
attr_accessor :description
|
73
74
|
|
74
|
-
# The destination
|
75
|
+
# The destination Account's identifier.
|
75
76
|
sig { returns(String) }
|
76
77
|
attr_accessor :destination_account_id
|
77
78
|
|
78
|
-
# The
|
79
|
+
# The identifier of the Transaction on the destination Account representing the
|
80
|
+
# received funds.
|
79
81
|
sig { returns(T.nilable(String)) }
|
80
82
|
attr_accessor :destination_transaction_id
|
81
83
|
|
@@ -85,10 +87,6 @@ module Increase
|
|
85
87
|
sig { returns(T.nilable(String)) }
|
86
88
|
attr_accessor :idempotency_key
|
87
89
|
|
88
|
-
# The transfer's network.
|
89
|
-
sig { returns(Increase::AccountTransfer::Network::TaggedSymbol) }
|
90
|
-
attr_accessor :network
|
91
|
-
|
92
90
|
# The ID for the pending transaction representing the transfer. A pending
|
93
91
|
# transaction is created when the transfer
|
94
92
|
# [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
|
@@ -100,7 +98,8 @@ module Increase
|
|
100
98
|
sig { returns(Increase::AccountTransfer::Status::TaggedSymbol) }
|
101
99
|
attr_accessor :status
|
102
100
|
|
103
|
-
# The
|
101
|
+
# The identifier of the Transaction on the originating account representing the
|
102
|
+
# transferred funds.
|
104
103
|
sig { returns(T.nilable(String)) }
|
105
104
|
attr_accessor :transaction_id
|
106
105
|
|
@@ -109,7 +108,12 @@ module Increase
|
|
109
108
|
sig { returns(Increase::AccountTransfer::Type::TaggedSymbol) }
|
110
109
|
attr_accessor :type
|
111
110
|
|
112
|
-
# Account transfers move funds between your own accounts at Increase
|
111
|
+
# Account transfers move funds between your own accounts at Increase (accounting
|
112
|
+
# systems often refer to these as Book Transfers). Account Transfers are free and
|
113
|
+
# synchronous. Upon creation they create two Transactions, one negative on the
|
114
|
+
# originating account and one positive on the destination account (unless the
|
115
|
+
# transfer requires approval, in which case the Transactions will be created when
|
116
|
+
# the transfer is approved).
|
113
117
|
sig do
|
114
118
|
params(
|
115
119
|
id: String,
|
@@ -125,7 +129,6 @@ module Increase
|
|
125
129
|
destination_account_id: String,
|
126
130
|
destination_transaction_id: T.nilable(String),
|
127
131
|
idempotency_key: T.nilable(String),
|
128
|
-
network: Increase::AccountTransfer::Network::OrSymbol,
|
129
132
|
pending_transaction_id: T.nilable(String),
|
130
133
|
status: Increase::AccountTransfer::Status::OrSymbol,
|
131
134
|
transaction_id: T.nilable(String),
|
@@ -133,12 +136,12 @@ module Increase
|
|
133
136
|
).returns(T.attached_class)
|
134
137
|
end
|
135
138
|
def self.new(
|
136
|
-
# The
|
139
|
+
# The Account Transfer's identifier.
|
137
140
|
id:,
|
138
|
-
# The Account
|
141
|
+
# The Account from which the transfer originated.
|
139
142
|
account_id:,
|
140
|
-
# The transfer amount in
|
141
|
-
#
|
143
|
+
# The transfer amount in cents. This will always be positive and indicates the
|
144
|
+
# amount of money leaving the originating account.
|
142
145
|
amount:,
|
143
146
|
# If your account requires approvals for transfers and the transfer was approved,
|
144
147
|
# this will contain details of the approval.
|
@@ -151,21 +154,21 @@ module Increase
|
|
151
154
|
created_at:,
|
152
155
|
# What object created the transfer, either via the API or the dashboard.
|
153
156
|
created_by:,
|
154
|
-
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
155
|
-
#
|
157
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
|
158
|
+
# currency.
|
156
159
|
currency:,
|
157
|
-
#
|
160
|
+
# An internal-facing description for the transfer for display in the API and
|
161
|
+
# dashboard. This will also show in the description of the created Transactions.
|
158
162
|
description:,
|
159
|
-
# The destination
|
163
|
+
# The destination Account's identifier.
|
160
164
|
destination_account_id:,
|
161
|
-
# The
|
165
|
+
# The identifier of the Transaction on the destination Account representing the
|
166
|
+
# received funds.
|
162
167
|
destination_transaction_id:,
|
163
168
|
# The idempotency key you chose for this object. This value is unique across
|
164
169
|
# Increase and is used to ensure that a request is only processed once. Learn more
|
165
170
|
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
166
171
|
idempotency_key:,
|
167
|
-
# The transfer's network.
|
168
|
-
network:,
|
169
172
|
# The ID for the pending transaction representing the transfer. A pending
|
170
173
|
# transaction is created when the transfer
|
171
174
|
# [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
|
@@ -173,7 +176,8 @@ module Increase
|
|
173
176
|
pending_transaction_id:,
|
174
177
|
# The lifecycle status of the transfer.
|
175
178
|
status:,
|
176
|
-
# The
|
179
|
+
# The identifier of the Transaction on the originating account representing the
|
180
|
+
# transferred funds.
|
177
181
|
transaction_id:,
|
178
182
|
# A constant representing the object's type. For this resource it will always be
|
179
183
|
# `account_transfer`.
|
@@ -196,7 +200,6 @@ module Increase
|
|
196
200
|
destination_account_id: String,
|
197
201
|
destination_transaction_id: T.nilable(String),
|
198
202
|
idempotency_key: T.nilable(String),
|
199
|
-
network: Increase::AccountTransfer::Network::TaggedSymbol,
|
200
203
|
pending_transaction_id: T.nilable(String),
|
201
204
|
status: Increase::AccountTransfer::Status::TaggedSymbol,
|
202
205
|
transaction_id: T.nilable(String),
|
@@ -518,8 +521,8 @@ module Increase
|
|
518
521
|
end
|
519
522
|
end
|
520
523
|
|
521
|
-
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
522
|
-
#
|
524
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
|
525
|
+
# currency.
|
523
526
|
module Currency
|
524
527
|
extend Increase::Internal::Type::Enum
|
525
528
|
|
@@ -554,26 +557,6 @@ module Increase
|
|
554
557
|
end
|
555
558
|
end
|
556
559
|
|
557
|
-
# The transfer's network.
|
558
|
-
module Network
|
559
|
-
extend Increase::Internal::Type::Enum
|
560
|
-
|
561
|
-
TaggedSymbol =
|
562
|
-
T.type_alias { T.all(Symbol, Increase::AccountTransfer::Network) }
|
563
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
564
|
-
|
565
|
-
ACCOUNT =
|
566
|
-
T.let(:account, Increase::AccountTransfer::Network::TaggedSymbol)
|
567
|
-
|
568
|
-
sig do
|
569
|
-
override.returns(
|
570
|
-
T::Array[Increase::AccountTransfer::Network::TaggedSymbol]
|
571
|
-
)
|
572
|
-
end
|
573
|
-
def self.values
|
574
|
-
end
|
575
|
-
end
|
576
|
-
|
577
560
|
# The lifecycle status of the transfer.
|
578
561
|
module Status
|
579
562
|
extend Increase::Internal::Type::Enum
|
@@ -582,14 +565,14 @@ module Increase
|
|
582
565
|
T.type_alias { T.all(Symbol, Increase::AccountTransfer::Status) }
|
583
566
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
584
567
|
|
585
|
-
# The transfer is pending approval.
|
568
|
+
# The transfer is pending approval from your team.
|
586
569
|
PENDING_APPROVAL =
|
587
570
|
T.let(
|
588
571
|
:pending_approval,
|
589
572
|
Increase::AccountTransfer::Status::TaggedSymbol
|
590
573
|
)
|
591
574
|
|
592
|
-
# The transfer has been canceled.
|
575
|
+
# The transfer was pending approval from your team and has been canceled.
|
593
576
|
CANCELED =
|
594
577
|
T.let(:canceled, Increase::AccountTransfer::Status::TaggedSymbol)
|
595
578
|
|
@@ -14,7 +14,7 @@ module Increase
|
|
14
14
|
)
|
15
15
|
end
|
16
16
|
|
17
|
-
# The identifier for the
|
17
|
+
# The identifier for the originating Account that will send the transfer.
|
18
18
|
sig { returns(String) }
|
19
19
|
attr_accessor :account_id
|
20
20
|
|
@@ -23,15 +23,18 @@ module Increase
|
|
23
23
|
sig { returns(Integer) }
|
24
24
|
attr_accessor :amount
|
25
25
|
|
26
|
-
#
|
26
|
+
# An internal-facing description for the transfer for display in the API and
|
27
|
+
# dashboard. This will also show in the description of the created Transactions.
|
27
28
|
sig { returns(String) }
|
28
29
|
attr_accessor :description
|
29
30
|
|
30
|
-
# The identifier for the
|
31
|
+
# The identifier for the destination Account that will receive the transfer.
|
31
32
|
sig { returns(String) }
|
32
33
|
attr_accessor :destination_account_id
|
33
34
|
|
34
|
-
# Whether the transfer
|
35
|
+
# Whether the transfer should require explicit approval via the dashboard or API.
|
36
|
+
# For more information, see
|
37
|
+
# [Transfer Approvals](/documentation/transfer-approvals).
|
35
38
|
sig { returns(T.nilable(T::Boolean)) }
|
36
39
|
attr_reader :require_approval
|
37
40
|
|
@@ -49,16 +52,19 @@ module Increase
|
|
49
52
|
).returns(T.attached_class)
|
50
53
|
end
|
51
54
|
def self.new(
|
52
|
-
# The identifier for the
|
55
|
+
# The identifier for the originating Account that will send the transfer.
|
53
56
|
account_id:,
|
54
57
|
# The transfer amount in the minor unit of the account currency. For dollars, for
|
55
58
|
# example, this is cents.
|
56
59
|
amount:,
|
57
|
-
#
|
60
|
+
# An internal-facing description for the transfer for display in the API and
|
61
|
+
# dashboard. This will also show in the description of the created Transactions.
|
58
62
|
description:,
|
59
|
-
# The identifier for the
|
63
|
+
# The identifier for the destination Account that will receive the transfer.
|
60
64
|
destination_account_id:,
|
61
|
-
# Whether the transfer
|
65
|
+
# Whether the transfer should require explicit approval via the dashboard or API.
|
66
|
+
# For more information, see
|
67
|
+
# [Transfer Approvals](/documentation/transfer-approvals).
|
62
68
|
require_approval: nil,
|
63
69
|
request_options: {}
|
64
70
|
)
|
@@ -15,16 +15,19 @@ module Increase
|
|
15
15
|
).returns(Increase::AccountTransfer)
|
16
16
|
end
|
17
17
|
def create(
|
18
|
-
# The identifier for the
|
18
|
+
# The identifier for the originating Account that will send the transfer.
|
19
19
|
account_id:,
|
20
20
|
# The transfer amount in the minor unit of the account currency. For dollars, for
|
21
21
|
# example, this is cents.
|
22
22
|
amount:,
|
23
|
-
#
|
23
|
+
# An internal-facing description for the transfer for display in the API and
|
24
|
+
# dashboard. This will also show in the description of the created Transactions.
|
24
25
|
description:,
|
25
|
-
# The identifier for the
|
26
|
+
# The identifier for the destination Account that will receive the transfer.
|
26
27
|
destination_account_id:,
|
27
|
-
# Whether the transfer
|
28
|
+
# Whether the transfer should require explicit approval via the dashboard or API.
|
29
|
+
# For more information, see
|
30
|
+
# [Transfer Approvals](/documentation/transfer-approvals).
|
28
31
|
require_approval: nil,
|
29
32
|
request_options: {}
|
30
33
|
)
|
@@ -73,7 +76,7 @@ module Increase
|
|
73
76
|
)
|
74
77
|
end
|
75
78
|
|
76
|
-
#
|
79
|
+
# Approves an Account Transfer in status `pending_approval`.
|
77
80
|
sig do
|
78
81
|
params(
|
79
82
|
account_transfer_id: String,
|
@@ -87,7 +90,7 @@ module Increase
|
|
87
90
|
)
|
88
91
|
end
|
89
92
|
|
90
|
-
#
|
93
|
+
# Cancels an Account Transfer in status `pending_approval`.
|
91
94
|
sig do
|
92
95
|
params(
|
93
96
|
account_transfer_id: String,
|
@@ -14,7 +14,6 @@ module Increase
|
|
14
14
|
destination_account_id: String,
|
15
15
|
destination_transaction_id: String?,
|
16
16
|
idempotency_key: String?,
|
17
|
-
network: Increase::Models::AccountTransfer::network,
|
18
17
|
pending_transaction_id: String?,
|
19
18
|
status: Increase::Models::AccountTransfer::status,
|
20
19
|
transaction_id: String?,
|
@@ -46,8 +45,6 @@ module Increase
|
|
46
45
|
|
47
46
|
attr_accessor idempotency_key: String?
|
48
47
|
|
49
|
-
attr_accessor network: Increase::Models::AccountTransfer::network
|
50
|
-
|
51
48
|
attr_accessor pending_transaction_id: String?
|
52
49
|
|
53
50
|
attr_accessor status: Increase::Models::AccountTransfer::status
|
@@ -69,7 +66,6 @@ module Increase
|
|
69
66
|
destination_account_id: String,
|
70
67
|
destination_transaction_id: String?,
|
71
68
|
idempotency_key: String?,
|
72
|
-
network: Increase::Models::AccountTransfer::network,
|
73
69
|
pending_transaction_id: String?,
|
74
70
|
status: Increase::Models::AccountTransfer::status,
|
75
71
|
transaction_id: String?,
|
@@ -89,7 +85,6 @@ module Increase
|
|
89
85
|
destination_account_id: String,
|
90
86
|
destination_transaction_id: String?,
|
91
87
|
idempotency_key: String?,
|
92
|
-
network: Increase::Models::AccountTransfer::network,
|
93
88
|
pending_transaction_id: String?,
|
94
89
|
status: Increase::Models::AccountTransfer::status,
|
95
90
|
transaction_id: String?,
|
@@ -225,25 +220,15 @@ module Increase
|
|
225
220
|
def self?.values: -> ::Array[Increase::Models::AccountTransfer::currency]
|
226
221
|
end
|
227
222
|
|
228
|
-
type network = :account
|
229
|
-
|
230
|
-
module Network
|
231
|
-
extend Increase::Internal::Type::Enum
|
232
|
-
|
233
|
-
ACCOUNT: :account
|
234
|
-
|
235
|
-
def self?.values: -> ::Array[Increase::Models::AccountTransfer::network]
|
236
|
-
end
|
237
|
-
|
238
223
|
type status = :pending_approval | :canceled | :complete
|
239
224
|
|
240
225
|
module Status
|
241
226
|
extend Increase::Internal::Type::Enum
|
242
227
|
|
243
|
-
# The transfer is pending approval.
|
228
|
+
# The transfer is pending approval from your team.
|
244
229
|
PENDING_APPROVAL: :pending_approval
|
245
230
|
|
246
|
-
# The transfer has been canceled.
|
231
|
+
# The transfer was pending approval from your team and has been canceled.
|
247
232
|
CANCELED: :canceled
|
248
233
|
|
249
234
|
# The transfer has been completed.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: increase
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.88.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Increase
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-09-
|
11
|
+
date: 2025-09-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: connection_pool
|