increase 1.303.0 → 1.305.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 +22 -0
- data/README.md +1 -1
- data/lib/increase/client.rb +7 -15
- data/lib/increase/models/card_push_transfer.rb +3 -0
- data/lib/increase/models/card_token_capabilities.rb +3 -0
- data/lib/increase/models/card_validation.rb +3 -0
- data/lib/increase/models/check_deposit.rb +7 -6
- data/lib/increase/models/inbound_mail_item.rb +22 -7
- data/lib/increase/models/inbound_mail_item_list_params.rb +13 -5
- data/lib/increase/models/lockbox_address.rb +162 -0
- data/lib/increase/models/lockbox_address_create_params.rb +22 -0
- data/lib/increase/models/{lockbox_list_params.rb → lockbox_address_list_params.rb} +8 -16
- data/lib/increase/models/lockbox_address_retrieve_params.rb +22 -0
- data/lib/increase/models/lockbox_address_update_params.rb +55 -0
- data/lib/increase/models/lockbox_recipient.rb +135 -0
- data/lib/increase/models/lockbox_recipient_create_params.rb +49 -0
- data/lib/increase/models/lockbox_recipient_list_params.rb +110 -0
- data/lib/increase/models/lockbox_recipient_retrieve_params.rb +22 -0
- data/lib/increase/models/lockbox_recipient_update_params.rb +63 -0
- data/lib/increase/models/simulations/card_token_create_params.rb +3 -0
- data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +17 -9
- data/lib/increase/models.rb +15 -31
- data/lib/increase/resources/inbound_mail_items.rb +4 -2
- data/lib/increase/resources/lockbox_addresses.rb +115 -0
- data/lib/increase/resources/lockbox_recipients.rb +130 -0
- data/lib/increase/resources/simulations/inbound_mail_items.rb +5 -3
- data/lib/increase/version.rb +1 -1
- data/lib/increase.rb +12 -22
- data/rbi/increase/client.rbi +5 -11
- data/rbi/increase/models/card_push_transfer.rbi +3 -0
- data/rbi/increase/models/card_token_capabilities.rbi +7 -0
- data/rbi/increase/models/card_validation.rbi +3 -0
- data/rbi/increase/models/check_deposit.rbi +10 -8
- data/rbi/increase/models/inbound_mail_item.rbi +32 -9
- data/rbi/increase/models/inbound_mail_item_list_params.rbi +19 -8
- data/rbi/increase/models/lockbox_address.rbi +228 -0
- data/rbi/increase/models/lockbox_address_create_params.rbi +46 -0
- data/rbi/increase/models/{lockbox_list_params.rbi → lockbox_address_list_params.rbi} +9 -18
- data/rbi/increase/models/{bookkeeping_entry_set_retrieve_params.rbi → lockbox_address_retrieve_params.rbi} +8 -8
- data/rbi/increase/models/lockbox_address_update_params.rbi +116 -0
- data/rbi/increase/models/lockbox_recipient.rbi +182 -0
- data/rbi/increase/models/{lockbox_create_params.rbi → lockbox_recipient_create_params.rbi} +19 -8
- data/rbi/increase/models/lockbox_recipient_list_params.rbi +190 -0
- data/rbi/increase/models/{bookkeeping_entry_retrieve_params.rbi → lockbox_recipient_retrieve_params.rbi} +8 -8
- data/rbi/increase/models/lockbox_recipient_update_params.rbi +129 -0
- data/rbi/increase/models/simulations/card_token_create_params.rbi +7 -0
- data/rbi/increase/models/simulations/inbound_mail_item_create_params.rbi +22 -8
- data/rbi/increase/models.rbi +16 -38
- data/rbi/increase/resources/inbound_mail_items.rbi +6 -3
- data/rbi/increase/resources/{bookkeeping_entry_sets.rbi → lockbox_addresses.rbi} +35 -24
- data/rbi/increase/resources/{lockboxes.rbi → lockbox_recipients.rbi} +31 -26
- data/rbi/increase/resources/simulations/inbound_mail_items.rbi +6 -3
- data/sig/increase/client.rbs +3 -7
- data/sig/increase/models/card_push_transfer.rbs +4 -1
- data/sig/increase/models/card_token_capabilities.rbs +4 -1
- data/sig/increase/models/card_validation.rbs +4 -1
- data/sig/increase/models/check_deposit.rbs +4 -4
- data/sig/increase/models/inbound_mail_item.rbs +20 -5
- data/sig/increase/models/inbound_mail_item_list_params.rbs +12 -5
- data/sig/increase/models/lockbox_address.rbs +117 -0
- data/sig/increase/models/{lockbox_retrieve_params.rbs → lockbox_address_create_params.rbs} +8 -6
- data/sig/increase/models/{lockbox_list_params.rbs → lockbox_address_list_params.rbs} +8 -15
- data/sig/increase/models/{bookkeeping_entry_set_retrieve_params.rbs → lockbox_address_retrieve_params.rbs} +6 -6
- data/sig/increase/models/lockbox_address_update_params.rbs +59 -0
- data/sig/increase/models/lockbox_recipient.rbs +92 -0
- data/sig/increase/models/{lockbox_create_params.rbs → lockbox_recipient_create_params.rbs} +12 -3
- data/sig/increase/models/lockbox_recipient_list_params.rbs +100 -0
- data/sig/increase/models/{bookkeeping_entry_retrieve_params.rbs → lockbox_recipient_retrieve_params.rbs} +6 -6
- data/sig/increase/models/lockbox_recipient_update_params.rbs +66 -0
- data/sig/increase/models/simulations/card_token_create_params.rbs +4 -1
- data/sig/increase/models/simulations/inbound_mail_item_create_params.rbs +18 -5
- data/sig/increase/models.rbs +15 -31
- data/sig/increase/resources/inbound_mail_items.rbs +2 -1
- data/sig/increase/resources/lockbox_addresses.rbs +32 -0
- data/sig/increase/resources/{lockboxes.rbs → lockbox_recipients.rbs} +11 -9
- data/sig/increase/resources/simulations/inbound_mail_items.rbs +2 -1
- metadata +38 -68
- data/lib/increase/models/bookkeeping_account.rb +0 -104
- data/lib/increase/models/bookkeeping_account_balance_params.rb +0 -30
- data/lib/increase/models/bookkeeping_account_create_params.rb +0 -60
- data/lib/increase/models/bookkeeping_account_list_params.rb +0 -45
- data/lib/increase/models/bookkeeping_account_update_params.rb +0 -30
- data/lib/increase/models/bookkeeping_balance_lookup.rb +0 -54
- data/lib/increase/models/bookkeeping_entry.rb +0 -79
- data/lib/increase/models/bookkeeping_entry_list_params.rb +0 -42
- data/lib/increase/models/bookkeeping_entry_retrieve_params.rb +0 -22
- data/lib/increase/models/bookkeeping_entry_set.rb +0 -116
- data/lib/increase/models/bookkeeping_entry_set_create_params.rb +0 -67
- data/lib/increase/models/bookkeeping_entry_set_list_params.rb +0 -53
- data/lib/increase/models/bookkeeping_entry_set_retrieve_params.rb +0 -22
- data/lib/increase/models/lockbox.rb +0 -185
- data/lib/increase/models/lockbox_create_params.rb +0 -38
- data/lib/increase/models/lockbox_retrieve_params.rb +0 -22
- data/lib/increase/models/lockbox_update_params.rb +0 -63
- data/lib/increase/resources/bookkeeping_accounts.rb +0 -122
- data/lib/increase/resources/bookkeeping_entries.rb +0 -65
- data/lib/increase/resources/bookkeeping_entry_sets.rb +0 -96
- data/lib/increase/resources/lockboxes.rb +0 -123
- data/rbi/increase/models/bookkeeping_account.rbi +0 -165
- data/rbi/increase/models/bookkeeping_account_balance_params.rbi +0 -57
- data/rbi/increase/models/bookkeeping_account_create_params.rbi +0 -130
- data/rbi/increase/models/bookkeeping_account_list_params.rbi +0 -79
- data/rbi/increase/models/bookkeeping_account_update_params.rbi +0 -54
- data/rbi/increase/models/bookkeeping_balance_lookup.rbi +0 -85
- data/rbi/increase/models/bookkeeping_entry.rbi +0 -108
- data/rbi/increase/models/bookkeeping_entry_list_params.rbi +0 -73
- data/rbi/increase/models/bookkeeping_entry_set.rbi +0 -162
- data/rbi/increase/models/bookkeeping_entry_set_create_params.rbi +0 -110
- data/rbi/increase/models/bookkeeping_entry_set_list_params.rbi +0 -90
- data/rbi/increase/models/lockbox.rbi +0 -251
- data/rbi/increase/models/lockbox_retrieve_params.rbi +0 -40
- data/rbi/increase/models/lockbox_update_params.rbi +0 -131
- data/rbi/increase/resources/bookkeeping_accounts.rbi +0 -94
- data/rbi/increase/resources/bookkeeping_entries.rbi +0 -47
- data/sig/increase/models/bookkeeping_account.rbs +0 -74
- data/sig/increase/models/bookkeeping_account_balance_params.rbs +0 -30
- data/sig/increase/models/bookkeeping_account_create_params.rbs +0 -63
- data/sig/increase/models/bookkeeping_account_list_params.rbs +0 -38
- data/sig/increase/models/bookkeeping_account_update_params.rbs +0 -28
- data/sig/increase/models/bookkeeping_balance_lookup.rbs +0 -40
- data/sig/increase/models/bookkeeping_entry.rbs +0 -55
- data/sig/increase/models/bookkeeping_entry_list_params.rbs +0 -38
- data/sig/increase/models/bookkeeping_entry_set.rbs +0 -78
- data/sig/increase/models/bookkeeping_entry_set_create_params.rbs +0 -52
- data/sig/increase/models/bookkeeping_entry_set_list_params.rbs +0 -49
- data/sig/increase/models/lockbox.rbs +0 -129
- data/sig/increase/models/lockbox_update_params.rbs +0 -66
- data/sig/increase/resources/bookkeeping_accounts.rbs +0 -34
- data/sig/increase/resources/bookkeeping_entries.rbs +0 -19
- data/sig/increase/resources/bookkeeping_entry_sets.rbs +0 -27
|
@@ -1,116 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Increase
|
|
4
|
-
module Models
|
|
5
|
-
# @see Increase::Resources::BookkeepingEntrySets#create
|
|
6
|
-
class BookkeepingEntrySet < Increase::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute id
|
|
8
|
-
# The entry set identifier.
|
|
9
|
-
#
|
|
10
|
-
# @return [String]
|
|
11
|
-
required :id, String
|
|
12
|
-
|
|
13
|
-
# @!attribute created_at
|
|
14
|
-
# When the entry set was created.
|
|
15
|
-
#
|
|
16
|
-
# @return [Time]
|
|
17
|
-
required :created_at, Time
|
|
18
|
-
|
|
19
|
-
# @!attribute date
|
|
20
|
-
# The timestamp of the entry set.
|
|
21
|
-
#
|
|
22
|
-
# @return [Time]
|
|
23
|
-
required :date, Time
|
|
24
|
-
|
|
25
|
-
# @!attribute entries
|
|
26
|
-
# The entries.
|
|
27
|
-
#
|
|
28
|
-
# @return [Array<Increase::Models::BookkeepingEntrySet::Entry>]
|
|
29
|
-
required :entries, -> { Increase::Internal::Type::ArrayOf[Increase::BookkeepingEntrySet::Entry] }
|
|
30
|
-
|
|
31
|
-
# @!attribute idempotency_key
|
|
32
|
-
# The idempotency key you chose for this object. This value is unique across
|
|
33
|
-
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
34
|
-
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
35
|
-
#
|
|
36
|
-
# @return [String, nil]
|
|
37
|
-
required :idempotency_key, String, nil?: true
|
|
38
|
-
|
|
39
|
-
# @!attribute transaction_id
|
|
40
|
-
# The transaction identifier, if any.
|
|
41
|
-
#
|
|
42
|
-
# @return [String, nil]
|
|
43
|
-
required :transaction_id, String, nil?: true
|
|
44
|
-
|
|
45
|
-
# @!attribute type
|
|
46
|
-
# A constant representing the object's type. For this resource it will always be
|
|
47
|
-
# `bookkeeping_entry_set`.
|
|
48
|
-
#
|
|
49
|
-
# @return [Symbol, Increase::Models::BookkeepingEntrySet::Type]
|
|
50
|
-
required :type, enum: -> { Increase::BookkeepingEntrySet::Type }
|
|
51
|
-
|
|
52
|
-
# @!method initialize(id:, created_at:, date:, entries:, idempotency_key:, transaction_id:, type:)
|
|
53
|
-
# Some parameter documentations has been truncated, see
|
|
54
|
-
# {Increase::Models::BookkeepingEntrySet} for more details.
|
|
55
|
-
#
|
|
56
|
-
# Entry Sets are accounting entries that are transactionally applied. Your
|
|
57
|
-
# compliance setup might require annotating money movements using this API. Learn
|
|
58
|
-
# more in our
|
|
59
|
-
# [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping).
|
|
60
|
-
#
|
|
61
|
-
# @param id [String] The entry set identifier.
|
|
62
|
-
#
|
|
63
|
-
# @param created_at [Time] When the entry set was created.
|
|
64
|
-
#
|
|
65
|
-
# @param date [Time] The timestamp of the entry set.
|
|
66
|
-
#
|
|
67
|
-
# @param entries [Array<Increase::Models::BookkeepingEntrySet::Entry>] The entries.
|
|
68
|
-
#
|
|
69
|
-
# @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
|
|
70
|
-
#
|
|
71
|
-
# @param transaction_id [String, nil] The transaction identifier, if any.
|
|
72
|
-
#
|
|
73
|
-
# @param type [Symbol, Increase::Models::BookkeepingEntrySet::Type] A constant representing the object's type. For this resource it will always be `
|
|
74
|
-
|
|
75
|
-
class Entry < Increase::Internal::Type::BaseModel
|
|
76
|
-
# @!attribute id
|
|
77
|
-
# The entry identifier.
|
|
78
|
-
#
|
|
79
|
-
# @return [String]
|
|
80
|
-
required :id, String
|
|
81
|
-
|
|
82
|
-
# @!attribute account_id
|
|
83
|
-
# The bookkeeping account impacted by the entry.
|
|
84
|
-
#
|
|
85
|
-
# @return [String]
|
|
86
|
-
required :account_id, String
|
|
87
|
-
|
|
88
|
-
# @!attribute amount
|
|
89
|
-
# The amount of the entry in minor units.
|
|
90
|
-
#
|
|
91
|
-
# @return [Integer]
|
|
92
|
-
required :amount, Integer
|
|
93
|
-
|
|
94
|
-
# @!method initialize(id:, account_id:, amount:)
|
|
95
|
-
# @param id [String] The entry identifier.
|
|
96
|
-
#
|
|
97
|
-
# @param account_id [String] The bookkeeping account impacted by the entry.
|
|
98
|
-
#
|
|
99
|
-
# @param amount [Integer] The amount of the entry in minor units.
|
|
100
|
-
end
|
|
101
|
-
|
|
102
|
-
# A constant representing the object's type. For this resource it will always be
|
|
103
|
-
# `bookkeeping_entry_set`.
|
|
104
|
-
#
|
|
105
|
-
# @see Increase::Models::BookkeepingEntrySet#type
|
|
106
|
-
module Type
|
|
107
|
-
extend Increase::Internal::Type::Enum
|
|
108
|
-
|
|
109
|
-
BOOKKEEPING_ENTRY_SET = :bookkeeping_entry_set
|
|
110
|
-
|
|
111
|
-
# @!method self.values
|
|
112
|
-
# @return [Array<Symbol>]
|
|
113
|
-
end
|
|
114
|
-
end
|
|
115
|
-
end
|
|
116
|
-
end
|
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Increase
|
|
4
|
-
module Models
|
|
5
|
-
# @see Increase::Resources::BookkeepingEntrySets#create
|
|
6
|
-
class BookkeepingEntrySetCreateParams < Increase::Internal::Type::BaseModel
|
|
7
|
-
extend Increase::Internal::Type::RequestParameters::Converter
|
|
8
|
-
include Increase::Internal::Type::RequestParameters
|
|
9
|
-
|
|
10
|
-
# @!attribute entries
|
|
11
|
-
# The bookkeeping entries.
|
|
12
|
-
#
|
|
13
|
-
# @return [Array<Increase::Models::BookkeepingEntrySetCreateParams::Entry>]
|
|
14
|
-
required :entries,
|
|
15
|
-
-> { Increase::Internal::Type::ArrayOf[Increase::BookkeepingEntrySetCreateParams::Entry] }
|
|
16
|
-
|
|
17
|
-
# @!attribute date
|
|
18
|
-
# The date of the transaction. Optional if `transaction_id` is provided, in which
|
|
19
|
-
# case we use the `date` of that transaction. Required otherwise.
|
|
20
|
-
#
|
|
21
|
-
# @return [Time, nil]
|
|
22
|
-
optional :date, Time
|
|
23
|
-
|
|
24
|
-
# @!attribute transaction_id
|
|
25
|
-
# The identifier of the Transaction related to this entry set, if any.
|
|
26
|
-
#
|
|
27
|
-
# @return [String, nil]
|
|
28
|
-
optional :transaction_id, String
|
|
29
|
-
|
|
30
|
-
# @!method initialize(entries:, date: nil, transaction_id: nil, request_options: {})
|
|
31
|
-
# Some parameter documentations has been truncated, see
|
|
32
|
-
# {Increase::Models::BookkeepingEntrySetCreateParams} for more details.
|
|
33
|
-
#
|
|
34
|
-
# @param entries [Array<Increase::Models::BookkeepingEntrySetCreateParams::Entry>] The bookkeeping entries.
|
|
35
|
-
#
|
|
36
|
-
# @param date [Time] The date of the transaction. Optional if `transaction_id` is provided, in which
|
|
37
|
-
#
|
|
38
|
-
# @param transaction_id [String] The identifier of the Transaction related to this entry set, if any.
|
|
39
|
-
#
|
|
40
|
-
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
41
|
-
|
|
42
|
-
class Entry < Increase::Internal::Type::BaseModel
|
|
43
|
-
# @!attribute account_id
|
|
44
|
-
# The identifier for the Bookkeeping Account impacted by this entry.
|
|
45
|
-
#
|
|
46
|
-
# @return [String]
|
|
47
|
-
required :account_id, String
|
|
48
|
-
|
|
49
|
-
# @!attribute amount
|
|
50
|
-
# The entry amount in the minor unit of the account currency. For dollars, for
|
|
51
|
-
# example, this is cents. Debit entries have positive amounts; credit entries have
|
|
52
|
-
# negative amounts.
|
|
53
|
-
#
|
|
54
|
-
# @return [Integer]
|
|
55
|
-
required :amount, Integer
|
|
56
|
-
|
|
57
|
-
# @!method initialize(account_id:, amount:)
|
|
58
|
-
# Some parameter documentations has been truncated, see
|
|
59
|
-
# {Increase::Models::BookkeepingEntrySetCreateParams::Entry} for more details.
|
|
60
|
-
#
|
|
61
|
-
# @param account_id [String] The identifier for the Bookkeeping Account impacted by this entry.
|
|
62
|
-
#
|
|
63
|
-
# @param amount [Integer] The entry amount in the minor unit of the account currency. For dollars, for exa
|
|
64
|
-
end
|
|
65
|
-
end
|
|
66
|
-
end
|
|
67
|
-
end
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Increase
|
|
4
|
-
module Models
|
|
5
|
-
# @see Increase::Resources::BookkeepingEntrySets#list
|
|
6
|
-
class BookkeepingEntrySetListParams < Increase::Internal::Type::BaseModel
|
|
7
|
-
extend Increase::Internal::Type::RequestParameters::Converter
|
|
8
|
-
include Increase::Internal::Type::RequestParameters
|
|
9
|
-
|
|
10
|
-
# @!attribute cursor
|
|
11
|
-
# Return the page of entries after this one.
|
|
12
|
-
#
|
|
13
|
-
# @return [String, nil]
|
|
14
|
-
optional :cursor, String
|
|
15
|
-
|
|
16
|
-
# @!attribute idempotency_key
|
|
17
|
-
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
18
|
-
# that object. This value is unique across Increase and is used to ensure that a
|
|
19
|
-
# request is only processed once. Learn more about
|
|
20
|
-
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
21
|
-
#
|
|
22
|
-
# @return [String, nil]
|
|
23
|
-
optional :idempotency_key, String
|
|
24
|
-
|
|
25
|
-
# @!attribute limit
|
|
26
|
-
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
27
|
-
# objects.
|
|
28
|
-
#
|
|
29
|
-
# @return [Integer, nil]
|
|
30
|
-
optional :limit, Integer
|
|
31
|
-
|
|
32
|
-
# @!attribute transaction_id
|
|
33
|
-
# Filter to the Bookkeeping Entry Set that maps to this Transaction.
|
|
34
|
-
#
|
|
35
|
-
# @return [String, nil]
|
|
36
|
-
optional :transaction_id, String
|
|
37
|
-
|
|
38
|
-
# @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, transaction_id: nil, request_options: {})
|
|
39
|
-
# Some parameter documentations has been truncated, see
|
|
40
|
-
# {Increase::Models::BookkeepingEntrySetListParams} for more details.
|
|
41
|
-
#
|
|
42
|
-
# @param cursor [String] Return the page of entries after this one.
|
|
43
|
-
#
|
|
44
|
-
# @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
|
|
45
|
-
#
|
|
46
|
-
# @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
|
|
47
|
-
#
|
|
48
|
-
# @param transaction_id [String] Filter to the Bookkeeping Entry Set that maps to this Transaction.
|
|
49
|
-
#
|
|
50
|
-
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
51
|
-
end
|
|
52
|
-
end
|
|
53
|
-
end
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Increase
|
|
4
|
-
module Models
|
|
5
|
-
# @see Increase::Resources::BookkeepingEntrySets#retrieve
|
|
6
|
-
class BookkeepingEntrySetRetrieveParams < Increase::Internal::Type::BaseModel
|
|
7
|
-
extend Increase::Internal::Type::RequestParameters::Converter
|
|
8
|
-
include Increase::Internal::Type::RequestParameters
|
|
9
|
-
|
|
10
|
-
# @!attribute bookkeeping_entry_set_id
|
|
11
|
-
# The identifier of the Bookkeeping Entry Set.
|
|
12
|
-
#
|
|
13
|
-
# @return [String]
|
|
14
|
-
required :bookkeeping_entry_set_id, String
|
|
15
|
-
|
|
16
|
-
# @!method initialize(bookkeeping_entry_set_id:, request_options: {})
|
|
17
|
-
# @param bookkeeping_entry_set_id [String] The identifier of the Bookkeeping Entry Set.
|
|
18
|
-
#
|
|
19
|
-
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
-
end
|
|
21
|
-
end
|
|
22
|
-
end
|
|
@@ -1,185 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Increase
|
|
4
|
-
module Models
|
|
5
|
-
# @see Increase::Resources::Lockboxes#create
|
|
6
|
-
class Lockbox < Increase::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute id
|
|
8
|
-
# The Lockbox identifier.
|
|
9
|
-
#
|
|
10
|
-
# @return [String]
|
|
11
|
-
required :id, String
|
|
12
|
-
|
|
13
|
-
# @!attribute account_id
|
|
14
|
-
# The identifier for the Account checks sent to this lockbox will be deposited
|
|
15
|
-
# into.
|
|
16
|
-
#
|
|
17
|
-
# @return [String]
|
|
18
|
-
required :account_id, String
|
|
19
|
-
|
|
20
|
-
# @!attribute address
|
|
21
|
-
# The mailing address for the Lockbox.
|
|
22
|
-
#
|
|
23
|
-
# @return [Increase::Models::Lockbox::Address]
|
|
24
|
-
required :address, -> { Increase::Lockbox::Address }
|
|
25
|
-
|
|
26
|
-
# @!attribute check_deposit_behavior
|
|
27
|
-
# Indicates if checks mailed to this lockbox will be deposited.
|
|
28
|
-
#
|
|
29
|
-
# @return [Symbol, Increase::Models::Lockbox::CheckDepositBehavior]
|
|
30
|
-
required :check_deposit_behavior, enum: -> { Increase::Lockbox::CheckDepositBehavior }
|
|
31
|
-
|
|
32
|
-
# @!attribute created_at
|
|
33
|
-
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
|
|
34
|
-
# was created.
|
|
35
|
-
#
|
|
36
|
-
# @return [Time]
|
|
37
|
-
required :created_at, Time
|
|
38
|
-
|
|
39
|
-
# @!attribute description
|
|
40
|
-
# The description you choose for the Lockbox.
|
|
41
|
-
#
|
|
42
|
-
# @return [String, nil]
|
|
43
|
-
required :description, String, nil?: true
|
|
44
|
-
|
|
45
|
-
# @!attribute idempotency_key
|
|
46
|
-
# The idempotency key you chose for this object. This value is unique across
|
|
47
|
-
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
48
|
-
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
49
|
-
#
|
|
50
|
-
# @return [String, nil]
|
|
51
|
-
required :idempotency_key, String, nil?: true
|
|
52
|
-
|
|
53
|
-
# @!attribute recipient_name
|
|
54
|
-
# The recipient name you choose for the Lockbox.
|
|
55
|
-
#
|
|
56
|
-
# @return [String, nil]
|
|
57
|
-
required :recipient_name, String, nil?: true
|
|
58
|
-
|
|
59
|
-
# @!attribute type
|
|
60
|
-
# A constant representing the object's type. For this resource it will always be
|
|
61
|
-
# `lockbox`.
|
|
62
|
-
#
|
|
63
|
-
# @return [Symbol, Increase::Models::Lockbox::Type]
|
|
64
|
-
required :type, enum: -> { Increase::Lockbox::Type }
|
|
65
|
-
|
|
66
|
-
# @!method initialize(id:, account_id:, address:, check_deposit_behavior:, created_at:, description:, idempotency_key:, recipient_name:, type:)
|
|
67
|
-
# Some parameter documentations has been truncated, see
|
|
68
|
-
# {Increase::Models::Lockbox} for more details.
|
|
69
|
-
#
|
|
70
|
-
# Lockboxes are physical locations that can receive mail containing paper checks.
|
|
71
|
-
# Increase will automatically create a Check Deposit for checks received this way.
|
|
72
|
-
#
|
|
73
|
-
# @param id [String] The Lockbox identifier.
|
|
74
|
-
#
|
|
75
|
-
# @param account_id [String] The identifier for the Account checks sent to this lockbox will be deposited int
|
|
76
|
-
#
|
|
77
|
-
# @param address [Increase::Models::Lockbox::Address] The mailing address for the Lockbox.
|
|
78
|
-
#
|
|
79
|
-
# @param check_deposit_behavior [Symbol, Increase::Models::Lockbox::CheckDepositBehavior] Indicates if checks mailed to this lockbox will be deposited.
|
|
80
|
-
#
|
|
81
|
-
# @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
|
|
82
|
-
#
|
|
83
|
-
# @param description [String, nil] The description you choose for the Lockbox.
|
|
84
|
-
#
|
|
85
|
-
# @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
|
|
86
|
-
#
|
|
87
|
-
# @param recipient_name [String, nil] The recipient name you choose for the Lockbox.
|
|
88
|
-
#
|
|
89
|
-
# @param type [Symbol, Increase::Models::Lockbox::Type] A constant representing the object's type. For this resource it will always be `
|
|
90
|
-
|
|
91
|
-
# @see Increase::Models::Lockbox#address
|
|
92
|
-
class Address < Increase::Internal::Type::BaseModel
|
|
93
|
-
# @!attribute city
|
|
94
|
-
# The city of the address.
|
|
95
|
-
#
|
|
96
|
-
# @return [String]
|
|
97
|
-
required :city, String
|
|
98
|
-
|
|
99
|
-
# @!attribute line1
|
|
100
|
-
# The first line of the address.
|
|
101
|
-
#
|
|
102
|
-
# @return [String]
|
|
103
|
-
required :line1, String
|
|
104
|
-
|
|
105
|
-
# @!attribute line2
|
|
106
|
-
# The second line of the address.
|
|
107
|
-
#
|
|
108
|
-
# @return [String]
|
|
109
|
-
required :line2, String
|
|
110
|
-
|
|
111
|
-
# @!attribute postal_code
|
|
112
|
-
# The postal code of the address.
|
|
113
|
-
#
|
|
114
|
-
# @return [String]
|
|
115
|
-
required :postal_code, String
|
|
116
|
-
|
|
117
|
-
# @!attribute recipient
|
|
118
|
-
# The recipient line of the address. This will include the recipient name you
|
|
119
|
-
# provide when creating the address, as well as an ATTN suffix to help route the
|
|
120
|
-
# mail to your lockbox. Mail senders must include this ATTN line to receive mail
|
|
121
|
-
# at this Lockbox.
|
|
122
|
-
#
|
|
123
|
-
# @return [String, nil]
|
|
124
|
-
required :recipient, String, nil?: true
|
|
125
|
-
|
|
126
|
-
# @!attribute state
|
|
127
|
-
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
|
128
|
-
# the address.
|
|
129
|
-
#
|
|
130
|
-
# @return [String]
|
|
131
|
-
required :state, String
|
|
132
|
-
|
|
133
|
-
# @!method initialize(city:, line1:, line2:, postal_code:, recipient:, state:)
|
|
134
|
-
# Some parameter documentations has been truncated, see
|
|
135
|
-
# {Increase::Models::Lockbox::Address} for more details.
|
|
136
|
-
#
|
|
137
|
-
# The mailing address for the Lockbox.
|
|
138
|
-
#
|
|
139
|
-
# @param city [String] The city of the address.
|
|
140
|
-
#
|
|
141
|
-
# @param line1 [String] The first line of the address.
|
|
142
|
-
#
|
|
143
|
-
# @param line2 [String] The second line of the address.
|
|
144
|
-
#
|
|
145
|
-
# @param postal_code [String] The postal code of the address.
|
|
146
|
-
#
|
|
147
|
-
# @param recipient [String, nil] The recipient line of the address. This will include the recipient name you prov
|
|
148
|
-
#
|
|
149
|
-
# @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
|
|
150
|
-
end
|
|
151
|
-
|
|
152
|
-
# Indicates if checks mailed to this lockbox will be deposited.
|
|
153
|
-
#
|
|
154
|
-
# @see Increase::Models::Lockbox#check_deposit_behavior
|
|
155
|
-
module CheckDepositBehavior
|
|
156
|
-
extend Increase::Internal::Type::Enum
|
|
157
|
-
|
|
158
|
-
# Checks mailed to this Lockbox will be deposited.
|
|
159
|
-
ENABLED = :enabled
|
|
160
|
-
|
|
161
|
-
# Checks mailed to this Lockbox will not be deposited.
|
|
162
|
-
DISABLED = :disabled
|
|
163
|
-
|
|
164
|
-
# Checks mailed to this Lockbox will be pending until actioned.
|
|
165
|
-
PEND_FOR_PROCESSING = :pend_for_processing
|
|
166
|
-
|
|
167
|
-
# @!method self.values
|
|
168
|
-
# @return [Array<Symbol>]
|
|
169
|
-
end
|
|
170
|
-
|
|
171
|
-
# A constant representing the object's type. For this resource it will always be
|
|
172
|
-
# `lockbox`.
|
|
173
|
-
#
|
|
174
|
-
# @see Increase::Models::Lockbox#type
|
|
175
|
-
module Type
|
|
176
|
-
extend Increase::Internal::Type::Enum
|
|
177
|
-
|
|
178
|
-
LOCKBOX = :lockbox
|
|
179
|
-
|
|
180
|
-
# @!method self.values
|
|
181
|
-
# @return [Array<Symbol>]
|
|
182
|
-
end
|
|
183
|
-
end
|
|
184
|
-
end
|
|
185
|
-
end
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Increase
|
|
4
|
-
module Models
|
|
5
|
-
# @see Increase::Resources::Lockboxes#create
|
|
6
|
-
class LockboxCreateParams < Increase::Internal::Type::BaseModel
|
|
7
|
-
extend Increase::Internal::Type::RequestParameters::Converter
|
|
8
|
-
include Increase::Internal::Type::RequestParameters
|
|
9
|
-
|
|
10
|
-
# @!attribute account_id
|
|
11
|
-
# The Account checks sent to this Lockbox should be deposited into.
|
|
12
|
-
#
|
|
13
|
-
# @return [String]
|
|
14
|
-
required :account_id, String
|
|
15
|
-
|
|
16
|
-
# @!attribute description
|
|
17
|
-
# The description you choose for the Lockbox, for display purposes.
|
|
18
|
-
#
|
|
19
|
-
# @return [String, nil]
|
|
20
|
-
optional :description, String
|
|
21
|
-
|
|
22
|
-
# @!attribute recipient_name
|
|
23
|
-
# The name of the recipient that will receive mail at this location.
|
|
24
|
-
#
|
|
25
|
-
# @return [String, nil]
|
|
26
|
-
optional :recipient_name, String
|
|
27
|
-
|
|
28
|
-
# @!method initialize(account_id:, description: nil, recipient_name: nil, request_options: {})
|
|
29
|
-
# @param account_id [String] The Account checks sent to this Lockbox should be deposited into.
|
|
30
|
-
#
|
|
31
|
-
# @param description [String] The description you choose for the Lockbox, for display purposes.
|
|
32
|
-
#
|
|
33
|
-
# @param recipient_name [String] The name of the recipient that will receive mail at this location.
|
|
34
|
-
#
|
|
35
|
-
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
36
|
-
end
|
|
37
|
-
end
|
|
38
|
-
end
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Increase
|
|
4
|
-
module Models
|
|
5
|
-
# @see Increase::Resources::Lockboxes#retrieve
|
|
6
|
-
class LockboxRetrieveParams < Increase::Internal::Type::BaseModel
|
|
7
|
-
extend Increase::Internal::Type::RequestParameters::Converter
|
|
8
|
-
include Increase::Internal::Type::RequestParameters
|
|
9
|
-
|
|
10
|
-
# @!attribute lockbox_id
|
|
11
|
-
# The identifier of the Lockbox to retrieve.
|
|
12
|
-
#
|
|
13
|
-
# @return [String]
|
|
14
|
-
required :lockbox_id, String
|
|
15
|
-
|
|
16
|
-
# @!method initialize(lockbox_id:, request_options: {})
|
|
17
|
-
# @param lockbox_id [String] The identifier of the Lockbox to retrieve.
|
|
18
|
-
#
|
|
19
|
-
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
-
end
|
|
21
|
-
end
|
|
22
|
-
end
|
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Increase
|
|
4
|
-
module Models
|
|
5
|
-
# @see Increase::Resources::Lockboxes#update
|
|
6
|
-
class LockboxUpdateParams < Increase::Internal::Type::BaseModel
|
|
7
|
-
extend Increase::Internal::Type::RequestParameters::Converter
|
|
8
|
-
include Increase::Internal::Type::RequestParameters
|
|
9
|
-
|
|
10
|
-
# @!attribute lockbox_id
|
|
11
|
-
# The identifier of the Lockbox.
|
|
12
|
-
#
|
|
13
|
-
# @return [String]
|
|
14
|
-
required :lockbox_id, String
|
|
15
|
-
|
|
16
|
-
# @!attribute check_deposit_behavior
|
|
17
|
-
# This indicates if checks mailed to this lockbox will be deposited.
|
|
18
|
-
#
|
|
19
|
-
# @return [Symbol, Increase::Models::LockboxUpdateParams::CheckDepositBehavior, nil]
|
|
20
|
-
optional :check_deposit_behavior, enum: -> { Increase::LockboxUpdateParams::CheckDepositBehavior }
|
|
21
|
-
|
|
22
|
-
# @!attribute description
|
|
23
|
-
# The description you choose for the Lockbox.
|
|
24
|
-
#
|
|
25
|
-
# @return [String, nil]
|
|
26
|
-
optional :description, String
|
|
27
|
-
|
|
28
|
-
# @!attribute recipient_name
|
|
29
|
-
# The recipient name you choose for the Lockbox.
|
|
30
|
-
#
|
|
31
|
-
# @return [String, nil]
|
|
32
|
-
optional :recipient_name, String
|
|
33
|
-
|
|
34
|
-
# @!method initialize(lockbox_id:, check_deposit_behavior: nil, description: nil, recipient_name: nil, request_options: {})
|
|
35
|
-
# @param lockbox_id [String] The identifier of the Lockbox.
|
|
36
|
-
#
|
|
37
|
-
# @param check_deposit_behavior [Symbol, Increase::Models::LockboxUpdateParams::CheckDepositBehavior] This indicates if checks mailed to this lockbox will be deposited.
|
|
38
|
-
#
|
|
39
|
-
# @param description [String] The description you choose for the Lockbox.
|
|
40
|
-
#
|
|
41
|
-
# @param recipient_name [String] The recipient name you choose for the Lockbox.
|
|
42
|
-
#
|
|
43
|
-
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
44
|
-
|
|
45
|
-
# This indicates if checks mailed to this lockbox will be deposited.
|
|
46
|
-
module CheckDepositBehavior
|
|
47
|
-
extend Increase::Internal::Type::Enum
|
|
48
|
-
|
|
49
|
-
# Checks mailed to this Lockbox will be deposited.
|
|
50
|
-
ENABLED = :enabled
|
|
51
|
-
|
|
52
|
-
# Checks mailed to this Lockbox will not be deposited.
|
|
53
|
-
DISABLED = :disabled
|
|
54
|
-
|
|
55
|
-
# Checks mailed to this Lockbox will be pending until actioned.
|
|
56
|
-
PEND_FOR_PROCESSING = :pend_for_processing
|
|
57
|
-
|
|
58
|
-
# @!method self.values
|
|
59
|
-
# @return [Array<Symbol>]
|
|
60
|
-
end
|
|
61
|
-
end
|
|
62
|
-
end
|
|
63
|
-
end
|
|
@@ -1,122 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Increase
|
|
4
|
-
module Resources
|
|
5
|
-
class BookkeepingAccounts
|
|
6
|
-
# Create a Bookkeeping Account
|
|
7
|
-
#
|
|
8
|
-
# @overload create(name:, account_id: nil, compliance_category: nil, entity_id: nil, request_options: {})
|
|
9
|
-
#
|
|
10
|
-
# @param name [String] The name you choose for the account.
|
|
11
|
-
#
|
|
12
|
-
# @param account_id [String] The account, if `compliance_category` is `commingled_cash`.
|
|
13
|
-
#
|
|
14
|
-
# @param compliance_category [Symbol, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory] The account compliance category.
|
|
15
|
-
#
|
|
16
|
-
# @param entity_id [String] The entity, if `compliance_category` is `customer_balance`.
|
|
17
|
-
#
|
|
18
|
-
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
19
|
-
#
|
|
20
|
-
# @return [Increase::Models::BookkeepingAccount]
|
|
21
|
-
#
|
|
22
|
-
# @see Increase::Models::BookkeepingAccountCreateParams
|
|
23
|
-
def create(params)
|
|
24
|
-
parsed, options = Increase::BookkeepingAccountCreateParams.dump_request(params)
|
|
25
|
-
@client.request(
|
|
26
|
-
method: :post,
|
|
27
|
-
path: "bookkeeping_accounts",
|
|
28
|
-
body: parsed,
|
|
29
|
-
model: Increase::BookkeepingAccount,
|
|
30
|
-
options: options
|
|
31
|
-
)
|
|
32
|
-
end
|
|
33
|
-
|
|
34
|
-
# Update a Bookkeeping Account
|
|
35
|
-
#
|
|
36
|
-
# @overload update(bookkeeping_account_id, name:, request_options: {})
|
|
37
|
-
#
|
|
38
|
-
# @param bookkeeping_account_id [String] The bookkeeping account you would like to update.
|
|
39
|
-
#
|
|
40
|
-
# @param name [String] The name you choose for the account.
|
|
41
|
-
#
|
|
42
|
-
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
43
|
-
#
|
|
44
|
-
# @return [Increase::Models::BookkeepingAccount]
|
|
45
|
-
#
|
|
46
|
-
# @see Increase::Models::BookkeepingAccountUpdateParams
|
|
47
|
-
def update(bookkeeping_account_id, params)
|
|
48
|
-
parsed, options = Increase::BookkeepingAccountUpdateParams.dump_request(params)
|
|
49
|
-
@client.request(
|
|
50
|
-
method: :patch,
|
|
51
|
-
path: ["bookkeeping_accounts/%1$s", bookkeeping_account_id],
|
|
52
|
-
body: parsed,
|
|
53
|
-
model: Increase::BookkeepingAccount,
|
|
54
|
-
options: options
|
|
55
|
-
)
|
|
56
|
-
end
|
|
57
|
-
|
|
58
|
-
# Some parameter documentations has been truncated, see
|
|
59
|
-
# {Increase::Models::BookkeepingAccountListParams} for more details.
|
|
60
|
-
#
|
|
61
|
-
# List Bookkeeping Accounts
|
|
62
|
-
#
|
|
63
|
-
# @overload list(cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
64
|
-
#
|
|
65
|
-
# @param cursor [String] Return the page of entries after this one.
|
|
66
|
-
#
|
|
67
|
-
# @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
|
|
68
|
-
#
|
|
69
|
-
# @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
|
|
70
|
-
#
|
|
71
|
-
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
72
|
-
#
|
|
73
|
-
# @return [Increase::Internal::Page<Increase::Models::BookkeepingAccount>]
|
|
74
|
-
#
|
|
75
|
-
# @see Increase::Models::BookkeepingAccountListParams
|
|
76
|
-
def list(params = {})
|
|
77
|
-
parsed, options = Increase::BookkeepingAccountListParams.dump_request(params)
|
|
78
|
-
query = Increase::Internal::Util.encode_query_params(parsed)
|
|
79
|
-
@client.request(
|
|
80
|
-
method: :get,
|
|
81
|
-
path: "bookkeeping_accounts",
|
|
82
|
-
query: query,
|
|
83
|
-
page: Increase::Internal::Page,
|
|
84
|
-
model: Increase::BookkeepingAccount,
|
|
85
|
-
options: options
|
|
86
|
-
)
|
|
87
|
-
end
|
|
88
|
-
|
|
89
|
-
# Retrieve a Bookkeeping Account Balance
|
|
90
|
-
#
|
|
91
|
-
# @overload balance(bookkeeping_account_id, at_time: nil, request_options: {})
|
|
92
|
-
#
|
|
93
|
-
# @param bookkeeping_account_id [String] The identifier of the Bookkeeping Account to retrieve.
|
|
94
|
-
#
|
|
95
|
-
# @param at_time [Time] The moment to query the balance at. If not set, returns the current balances.
|
|
96
|
-
#
|
|
97
|
-
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
98
|
-
#
|
|
99
|
-
# @return [Increase::Models::BookkeepingBalanceLookup]
|
|
100
|
-
#
|
|
101
|
-
# @see Increase::Models::BookkeepingAccountBalanceParams
|
|
102
|
-
def balance(bookkeeping_account_id, params = {})
|
|
103
|
-
parsed, options = Increase::BookkeepingAccountBalanceParams.dump_request(params)
|
|
104
|
-
query = Increase::Internal::Util.encode_query_params(parsed)
|
|
105
|
-
@client.request(
|
|
106
|
-
method: :get,
|
|
107
|
-
path: ["bookkeeping_accounts/%1$s/balance", bookkeeping_account_id],
|
|
108
|
-
query: query,
|
|
109
|
-
model: Increase::BookkeepingBalanceLookup,
|
|
110
|
-
options: options
|
|
111
|
-
)
|
|
112
|
-
end
|
|
113
|
-
|
|
114
|
-
# @api private
|
|
115
|
-
#
|
|
116
|
-
# @param client [Increase::Client]
|
|
117
|
-
def initialize(client:)
|
|
118
|
-
@client = client
|
|
119
|
-
end
|
|
120
|
-
end
|
|
121
|
-
end
|
|
122
|
-
end
|