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
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
# @see Increase::Resources::LockboxRecipients#create
|
|
6
|
+
class LockboxRecipient < Increase::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The Lockbox Recipient identifier.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute account_id
|
|
14
|
+
# The identifier for the Account that checks sent to this Lockbox Recipient will
|
|
15
|
+
# be deposited into.
|
|
16
|
+
#
|
|
17
|
+
# @return [String]
|
|
18
|
+
required :account_id, String
|
|
19
|
+
|
|
20
|
+
# @!attribute created_at
|
|
21
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
|
|
22
|
+
# Recipient was created.
|
|
23
|
+
#
|
|
24
|
+
# @return [Time]
|
|
25
|
+
required :created_at, Time
|
|
26
|
+
|
|
27
|
+
# @!attribute description
|
|
28
|
+
# The description of the Lockbox Recipient.
|
|
29
|
+
#
|
|
30
|
+
# @return [String, nil]
|
|
31
|
+
required :description, String, nil?: true
|
|
32
|
+
|
|
33
|
+
# @!attribute idempotency_key
|
|
34
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
35
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
36
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
37
|
+
#
|
|
38
|
+
# @return [String, nil]
|
|
39
|
+
required :idempotency_key, String, nil?: true
|
|
40
|
+
|
|
41
|
+
# @!attribute lockbox_address_id
|
|
42
|
+
# The identifier for the Lockbox Address where this Lockbox Recipient may receive
|
|
43
|
+
# physical mail.
|
|
44
|
+
#
|
|
45
|
+
# @return [String]
|
|
46
|
+
required :lockbox_address_id, String
|
|
47
|
+
|
|
48
|
+
# @!attribute mail_stop_code
|
|
49
|
+
# The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox
|
|
50
|
+
# Address. It should be included in the mailing address intended for this Lockbox
|
|
51
|
+
# Recipient.
|
|
52
|
+
#
|
|
53
|
+
# @return [String]
|
|
54
|
+
required :mail_stop_code, String
|
|
55
|
+
|
|
56
|
+
# @!attribute recipient_name
|
|
57
|
+
# The name of the Lockbox Recipient.
|
|
58
|
+
#
|
|
59
|
+
# @return [String, nil]
|
|
60
|
+
required :recipient_name, String, nil?: true
|
|
61
|
+
|
|
62
|
+
# @!attribute status
|
|
63
|
+
# The status of the Lockbox Recipient.
|
|
64
|
+
#
|
|
65
|
+
# @return [Symbol, Increase::Models::LockboxRecipient::Status, nil]
|
|
66
|
+
required :status, enum: -> { Increase::LockboxRecipient::Status }, nil?: true
|
|
67
|
+
|
|
68
|
+
# @!attribute type
|
|
69
|
+
# A constant representing the object's type. For this resource it will always be
|
|
70
|
+
# `lockbox_recipient`.
|
|
71
|
+
#
|
|
72
|
+
# @return [Symbol, Increase::Models::LockboxRecipient::Type]
|
|
73
|
+
required :type, enum: -> { Increase::LockboxRecipient::Type }
|
|
74
|
+
|
|
75
|
+
# @!method initialize(id:, account_id:, created_at:, description:, idempotency_key:, lockbox_address_id:, mail_stop_code:, recipient_name:, status:, type:)
|
|
76
|
+
# Some parameter documentations has been truncated, see
|
|
77
|
+
# {Increase::Models::LockboxRecipient} for more details.
|
|
78
|
+
#
|
|
79
|
+
# Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for
|
|
80
|
+
# a Lockbox Recipient are deposited into its associated Account.
|
|
81
|
+
#
|
|
82
|
+
# @param id [String] The Lockbox Recipient identifier.
|
|
83
|
+
#
|
|
84
|
+
# @param account_id [String] The identifier for the Account that checks sent to this Lockbox Recipient will b
|
|
85
|
+
#
|
|
86
|
+
# @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
|
|
87
|
+
#
|
|
88
|
+
# @param description [String, nil] The description of the Lockbox Recipient.
|
|
89
|
+
#
|
|
90
|
+
# @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
|
|
91
|
+
#
|
|
92
|
+
# @param lockbox_address_id [String] The identifier for the Lockbox Address where this Lockbox Recipient may receive
|
|
93
|
+
#
|
|
94
|
+
# @param mail_stop_code [String] The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox Ad
|
|
95
|
+
#
|
|
96
|
+
# @param recipient_name [String, nil] The name of the Lockbox Recipient.
|
|
97
|
+
#
|
|
98
|
+
# @param status [Symbol, Increase::Models::LockboxRecipient::Status, nil] The status of the Lockbox Recipient.
|
|
99
|
+
#
|
|
100
|
+
# @param type [Symbol, Increase::Models::LockboxRecipient::Type] A constant representing the object's type. For this resource it will always be `
|
|
101
|
+
|
|
102
|
+
# The status of the Lockbox Recipient.
|
|
103
|
+
#
|
|
104
|
+
# @see Increase::Models::LockboxRecipient#status
|
|
105
|
+
module Status
|
|
106
|
+
extend Increase::Internal::Type::Enum
|
|
107
|
+
|
|
108
|
+
# This Lockbox Recipient is active.
|
|
109
|
+
ACTIVE = :active
|
|
110
|
+
|
|
111
|
+
# This Lockbox Recipient is disabled. Checks mailed to this Lockbox Recipient will be rejected.
|
|
112
|
+
DISABLED = :disabled
|
|
113
|
+
|
|
114
|
+
# This Lockbox Recipient is canceled and cannot be modified. Checks mailed to this Lockbox Recipient will be rejected.
|
|
115
|
+
CANCELED = :canceled
|
|
116
|
+
|
|
117
|
+
# @!method self.values
|
|
118
|
+
# @return [Array<Symbol>]
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
# A constant representing the object's type. For this resource it will always be
|
|
122
|
+
# `lockbox_recipient`.
|
|
123
|
+
#
|
|
124
|
+
# @see Increase::Models::LockboxRecipient#type
|
|
125
|
+
module Type
|
|
126
|
+
extend Increase::Internal::Type::Enum
|
|
127
|
+
|
|
128
|
+
LOCKBOX_RECIPIENT = :lockbox_recipient
|
|
129
|
+
|
|
130
|
+
# @!method self.values
|
|
131
|
+
# @return [Array<Symbol>]
|
|
132
|
+
end
|
|
133
|
+
end
|
|
134
|
+
end
|
|
135
|
+
end
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
# @see Increase::Resources::LockboxRecipients#create
|
|
6
|
+
class LockboxRecipientCreateParams < 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 that checks sent to this Lockbox Recipient should be deposited into.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :account_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute lockbox_address_id
|
|
17
|
+
# The Lockbox Address where this Lockbox Recipient may receive mail.
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :lockbox_address_id, String
|
|
21
|
+
|
|
22
|
+
# @!attribute description
|
|
23
|
+
# The description you choose for the Lockbox Recipient.
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :description, String
|
|
27
|
+
|
|
28
|
+
# @!attribute recipient_name
|
|
29
|
+
# The name of the Lockbox Recipient
|
|
30
|
+
#
|
|
31
|
+
# @return [String, nil]
|
|
32
|
+
optional :recipient_name, String
|
|
33
|
+
|
|
34
|
+
# @!method initialize(account_id:, lockbox_address_id:, description: nil, recipient_name: nil, request_options: {})
|
|
35
|
+
# Some parameter documentations has been truncated, see
|
|
36
|
+
# {Increase::Models::LockboxRecipientCreateParams} for more details.
|
|
37
|
+
#
|
|
38
|
+
# @param account_id [String] The Account that checks sent to this Lockbox Recipient should be deposited into.
|
|
39
|
+
#
|
|
40
|
+
# @param lockbox_address_id [String] The Lockbox Address where this Lockbox Recipient may receive mail.
|
|
41
|
+
#
|
|
42
|
+
# @param description [String] The description you choose for the Lockbox Recipient.
|
|
43
|
+
#
|
|
44
|
+
# @param recipient_name [String] The name of the Lockbox Recipient
|
|
45
|
+
#
|
|
46
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
end
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
# @see Increase::Resources::LockboxRecipients#list
|
|
6
|
+
class LockboxRecipientListParams < Increase::Internal::Type::BaseModel
|
|
7
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Increase::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute account_id
|
|
11
|
+
# Filter Lockbox Recipients to those associated with the provided Account.
|
|
12
|
+
#
|
|
13
|
+
# @return [String, nil]
|
|
14
|
+
optional :account_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute created_at
|
|
17
|
+
#
|
|
18
|
+
# @return [Increase::Models::LockboxRecipientListParams::CreatedAt, nil]
|
|
19
|
+
optional :created_at, -> { Increase::LockboxRecipientListParams::CreatedAt }
|
|
20
|
+
|
|
21
|
+
# @!attribute cursor
|
|
22
|
+
# Return the page of entries after this one.
|
|
23
|
+
#
|
|
24
|
+
# @return [String, nil]
|
|
25
|
+
optional :cursor, String
|
|
26
|
+
|
|
27
|
+
# @!attribute idempotency_key
|
|
28
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
29
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
30
|
+
# request is only processed once. Learn more about
|
|
31
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
32
|
+
#
|
|
33
|
+
# @return [String, nil]
|
|
34
|
+
optional :idempotency_key, String
|
|
35
|
+
|
|
36
|
+
# @!attribute limit
|
|
37
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
38
|
+
# objects.
|
|
39
|
+
#
|
|
40
|
+
# @return [Integer, nil]
|
|
41
|
+
optional :limit, Integer
|
|
42
|
+
|
|
43
|
+
# @!attribute lockbox_address_id
|
|
44
|
+
# Filter Lockbox Recipients to those associated with the provided Lockbox Address.
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
optional :lockbox_address_id, String
|
|
48
|
+
|
|
49
|
+
# @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, lockbox_address_id: nil, request_options: {})
|
|
50
|
+
# Some parameter documentations has been truncated, see
|
|
51
|
+
# {Increase::Models::LockboxRecipientListParams} for more details.
|
|
52
|
+
#
|
|
53
|
+
# @param account_id [String] Filter Lockbox Recipients to those associated with the provided Account.
|
|
54
|
+
#
|
|
55
|
+
# @param created_at [Increase::Models::LockboxRecipientListParams::CreatedAt]
|
|
56
|
+
#
|
|
57
|
+
# @param cursor [String] Return the page of entries after this one.
|
|
58
|
+
#
|
|
59
|
+
# @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
|
|
60
|
+
#
|
|
61
|
+
# @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
|
|
62
|
+
#
|
|
63
|
+
# @param lockbox_address_id [String] Filter Lockbox Recipients to those associated with the provided Lockbox Address.
|
|
64
|
+
#
|
|
65
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
66
|
+
|
|
67
|
+
class CreatedAt < Increase::Internal::Type::BaseModel
|
|
68
|
+
# @!attribute after
|
|
69
|
+
# Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
70
|
+
# timestamp.
|
|
71
|
+
#
|
|
72
|
+
# @return [Time, nil]
|
|
73
|
+
optional :after, Time
|
|
74
|
+
|
|
75
|
+
# @!attribute before
|
|
76
|
+
# Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
77
|
+
# timestamp.
|
|
78
|
+
#
|
|
79
|
+
# @return [Time, nil]
|
|
80
|
+
optional :before, Time
|
|
81
|
+
|
|
82
|
+
# @!attribute on_or_after
|
|
83
|
+
# Return results on or after this
|
|
84
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
85
|
+
#
|
|
86
|
+
# @return [Time, nil]
|
|
87
|
+
optional :on_or_after, Time
|
|
88
|
+
|
|
89
|
+
# @!attribute on_or_before
|
|
90
|
+
# Return results on or before this
|
|
91
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
92
|
+
#
|
|
93
|
+
# @return [Time, nil]
|
|
94
|
+
optional :on_or_before, Time
|
|
95
|
+
|
|
96
|
+
# @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
|
|
97
|
+
# Some parameter documentations has been truncated, see
|
|
98
|
+
# {Increase::Models::LockboxRecipientListParams::CreatedAt} for more details.
|
|
99
|
+
#
|
|
100
|
+
# @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
|
|
101
|
+
#
|
|
102
|
+
# @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
|
|
103
|
+
#
|
|
104
|
+
# @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
|
|
105
|
+
#
|
|
106
|
+
# @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
|
|
107
|
+
end
|
|
108
|
+
end
|
|
109
|
+
end
|
|
110
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
# @see Increase::Resources::LockboxRecipients#retrieve
|
|
6
|
+
class LockboxRecipientRetrieveParams < Increase::Internal::Type::BaseModel
|
|
7
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Increase::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute lockbox_recipient_id
|
|
11
|
+
# The identifier of the Lockbox Recipient to retrieve.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :lockbox_recipient_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(lockbox_recipient_id:, request_options: {})
|
|
17
|
+
# @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient to retrieve.
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
# @see Increase::Resources::LockboxRecipients#update
|
|
6
|
+
class LockboxRecipientUpdateParams < Increase::Internal::Type::BaseModel
|
|
7
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Increase::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute lockbox_recipient_id
|
|
11
|
+
# The identifier of the Lockbox Recipient.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :lockbox_recipient_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute description
|
|
17
|
+
# The description you choose for the Lockbox Recipient.
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :description, String
|
|
21
|
+
|
|
22
|
+
# @!attribute recipient_name
|
|
23
|
+
# The name of the Lockbox Recipient.
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :recipient_name, String
|
|
27
|
+
|
|
28
|
+
# @!attribute status
|
|
29
|
+
# The status of the Lockbox Recipient.
|
|
30
|
+
#
|
|
31
|
+
# @return [Symbol, Increase::Models::LockboxRecipientUpdateParams::Status, nil]
|
|
32
|
+
optional :status, enum: -> { Increase::LockboxRecipientUpdateParams::Status }
|
|
33
|
+
|
|
34
|
+
# @!method initialize(lockbox_recipient_id:, description: nil, recipient_name: nil, status: nil, request_options: {})
|
|
35
|
+
# @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient.
|
|
36
|
+
#
|
|
37
|
+
# @param description [String] The description you choose for the Lockbox Recipient.
|
|
38
|
+
#
|
|
39
|
+
# @param recipient_name [String] The name of the Lockbox Recipient.
|
|
40
|
+
#
|
|
41
|
+
# @param status [Symbol, Increase::Models::LockboxRecipientUpdateParams::Status] The status of the Lockbox Recipient.
|
|
42
|
+
#
|
|
43
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
44
|
+
|
|
45
|
+
# The status of the Lockbox Recipient.
|
|
46
|
+
module Status
|
|
47
|
+
extend Increase::Internal::Type::Enum
|
|
48
|
+
|
|
49
|
+
# This Lockbox Recipient is active.
|
|
50
|
+
ACTIVE = :active
|
|
51
|
+
|
|
52
|
+
# This Lockbox Recipient is disabled. Checks mailed to this Lockbox Recipient will be rejected.
|
|
53
|
+
DISABLED = :disabled
|
|
54
|
+
|
|
55
|
+
# This Lockbox Recipient is canceled and cannot be modified. Checks mailed to this Lockbox Recipient will be rejected.
|
|
56
|
+
CANCELED = :canceled
|
|
57
|
+
|
|
58
|
+
# @!method self.values
|
|
59
|
+
# @return [Array<Symbol>]
|
|
60
|
+
end
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
@@ -14,12 +14,6 @@ module Increase
|
|
|
14
14
|
# @return [Integer]
|
|
15
15
|
required :amount, Integer
|
|
16
16
|
|
|
17
|
-
# @!attribute lockbox_id
|
|
18
|
-
# The identifier of the Lockbox to simulate inbound mail to.
|
|
19
|
-
#
|
|
20
|
-
# @return [String]
|
|
21
|
-
required :lockbox_id, String
|
|
22
|
-
|
|
23
17
|
# @!attribute contents_file_id
|
|
24
18
|
# The file containing the PDF contents. If not present, a default check image file
|
|
25
19
|
# will be used.
|
|
@@ -27,16 +21,30 @@ module Increase
|
|
|
27
21
|
# @return [String, nil]
|
|
28
22
|
optional :contents_file_id, String
|
|
29
23
|
|
|
30
|
-
# @!
|
|
24
|
+
# @!attribute lockbox_address_id
|
|
25
|
+
# The identifier of the Lockbox Address to simulate inbound mail to.
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :lockbox_address_id, String
|
|
29
|
+
|
|
30
|
+
# @!attribute lockbox_recipient_id
|
|
31
|
+
# The identifier of the Lockbox Recipient to simulate inbound mail to.
|
|
32
|
+
#
|
|
33
|
+
# @return [String, nil]
|
|
34
|
+
optional :lockbox_recipient_id, String
|
|
35
|
+
|
|
36
|
+
# @!method initialize(amount:, contents_file_id: nil, lockbox_address_id: nil, lockbox_recipient_id: nil, request_options: {})
|
|
31
37
|
# Some parameter documentations has been truncated, see
|
|
32
38
|
# {Increase::Models::Simulations::InboundMailItemCreateParams} for more details.
|
|
33
39
|
#
|
|
34
40
|
# @param amount [Integer] The amount of the check to be simulated, in cents.
|
|
35
41
|
#
|
|
36
|
-
# @param lockbox_id [String] The identifier of the Lockbox to simulate inbound mail to.
|
|
37
|
-
#
|
|
38
42
|
# @param contents_file_id [String] The file containing the PDF contents. If not present, a default check image file
|
|
39
43
|
#
|
|
44
|
+
# @param lockbox_address_id [String] The identifier of the Lockbox Address to simulate inbound mail to.
|
|
45
|
+
#
|
|
46
|
+
# @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient to simulate inbound mail to.
|
|
47
|
+
#
|
|
40
48
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
41
49
|
end
|
|
42
50
|
end
|
data/lib/increase/models.rb
CHANGED
|
@@ -113,32 +113,6 @@ module Increase
|
|
|
113
113
|
|
|
114
114
|
BeneficialOwnerUpdateParams = Increase::Models::BeneficialOwnerUpdateParams
|
|
115
115
|
|
|
116
|
-
BookkeepingAccount = Increase::Models::BookkeepingAccount
|
|
117
|
-
|
|
118
|
-
BookkeepingAccountBalanceParams = Increase::Models::BookkeepingAccountBalanceParams
|
|
119
|
-
|
|
120
|
-
BookkeepingAccountCreateParams = Increase::Models::BookkeepingAccountCreateParams
|
|
121
|
-
|
|
122
|
-
BookkeepingAccountListParams = Increase::Models::BookkeepingAccountListParams
|
|
123
|
-
|
|
124
|
-
BookkeepingAccountUpdateParams = Increase::Models::BookkeepingAccountUpdateParams
|
|
125
|
-
|
|
126
|
-
BookkeepingBalanceLookup = Increase::Models::BookkeepingBalanceLookup
|
|
127
|
-
|
|
128
|
-
BookkeepingEntry = Increase::Models::BookkeepingEntry
|
|
129
|
-
|
|
130
|
-
BookkeepingEntryListParams = Increase::Models::BookkeepingEntryListParams
|
|
131
|
-
|
|
132
|
-
BookkeepingEntryRetrieveParams = Increase::Models::BookkeepingEntryRetrieveParams
|
|
133
|
-
|
|
134
|
-
BookkeepingEntrySet = Increase::Models::BookkeepingEntrySet
|
|
135
|
-
|
|
136
|
-
BookkeepingEntrySetCreateParams = Increase::Models::BookkeepingEntrySetCreateParams
|
|
137
|
-
|
|
138
|
-
BookkeepingEntrySetListParams = Increase::Models::BookkeepingEntrySetListParams
|
|
139
|
-
|
|
140
|
-
BookkeepingEntrySetRetrieveParams = Increase::Models::BookkeepingEntrySetRetrieveParams
|
|
141
|
-
|
|
142
116
|
Card = Increase::Models::Card
|
|
143
117
|
|
|
144
118
|
CardCreateDetailsIframeParams = Increase::Models::CardCreateDetailsIframeParams
|
|
@@ -431,15 +405,25 @@ module Increase
|
|
|
431
405
|
|
|
432
406
|
IntrafiExclusionRetrieveParams = Increase::Models::IntrafiExclusionRetrieveParams
|
|
433
407
|
|
|
434
|
-
|
|
408
|
+
LockboxAddress = Increase::Models::LockboxAddress
|
|
409
|
+
|
|
410
|
+
LockboxAddressCreateParams = Increase::Models::LockboxAddressCreateParams
|
|
411
|
+
|
|
412
|
+
LockboxAddressListParams = Increase::Models::LockboxAddressListParams
|
|
413
|
+
|
|
414
|
+
LockboxAddressRetrieveParams = Increase::Models::LockboxAddressRetrieveParams
|
|
415
|
+
|
|
416
|
+
LockboxAddressUpdateParams = Increase::Models::LockboxAddressUpdateParams
|
|
417
|
+
|
|
418
|
+
LockboxRecipient = Increase::Models::LockboxRecipient
|
|
435
419
|
|
|
436
|
-
|
|
420
|
+
LockboxRecipientCreateParams = Increase::Models::LockboxRecipientCreateParams
|
|
437
421
|
|
|
438
|
-
|
|
422
|
+
LockboxRecipientListParams = Increase::Models::LockboxRecipientListParams
|
|
439
423
|
|
|
440
|
-
|
|
424
|
+
LockboxRecipientRetrieveParams = Increase::Models::LockboxRecipientRetrieveParams
|
|
441
425
|
|
|
442
|
-
|
|
426
|
+
LockboxRecipientUpdateParams = Increase::Models::LockboxRecipientUpdateParams
|
|
443
427
|
|
|
444
428
|
OAuthApplication = Increase::Models::OAuthApplication
|
|
445
429
|
|
|
@@ -28,7 +28,7 @@ module Increase
|
|
|
28
28
|
#
|
|
29
29
|
# List Inbound Mail Items
|
|
30
30
|
#
|
|
31
|
-
# @overload list(created_at: nil, cursor: nil, limit: nil,
|
|
31
|
+
# @overload list(created_at: nil, cursor: nil, limit: nil, lockbox_address_id: nil, lockbox_recipient_id: nil, request_options: {})
|
|
32
32
|
#
|
|
33
33
|
# @param created_at [Increase::Models::InboundMailItemListParams::CreatedAt]
|
|
34
34
|
#
|
|
@@ -36,7 +36,9 @@ module Increase
|
|
|
36
36
|
#
|
|
37
37
|
# @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
|
|
38
38
|
#
|
|
39
|
-
# @param
|
|
39
|
+
# @param lockbox_address_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox Address.
|
|
40
|
+
#
|
|
41
|
+
# @param lockbox_recipient_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.
|
|
40
42
|
#
|
|
41
43
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
42
44
|
#
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Resources
|
|
5
|
+
class LockboxAddresses
|
|
6
|
+
# Create a Lockbox Address
|
|
7
|
+
#
|
|
8
|
+
# @overload create(description: nil, request_options: {})
|
|
9
|
+
#
|
|
10
|
+
# @param description [String] The description you choose for the Lockbox Address.
|
|
11
|
+
#
|
|
12
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
13
|
+
#
|
|
14
|
+
# @return [Increase::Models::LockboxAddress]
|
|
15
|
+
#
|
|
16
|
+
# @see Increase::Models::LockboxAddressCreateParams
|
|
17
|
+
def create(params = {})
|
|
18
|
+
parsed, options = Increase::LockboxAddressCreateParams.dump_request(params)
|
|
19
|
+
@client.request(
|
|
20
|
+
method: :post,
|
|
21
|
+
path: "lockbox_addresses",
|
|
22
|
+
body: parsed,
|
|
23
|
+
model: Increase::LockboxAddress,
|
|
24
|
+
options: options
|
|
25
|
+
)
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
# Retrieve a Lockbox Address
|
|
29
|
+
#
|
|
30
|
+
# @overload retrieve(lockbox_address_id, request_options: {})
|
|
31
|
+
#
|
|
32
|
+
# @param lockbox_address_id [String] The identifier of the Lockbox Address to retrieve.
|
|
33
|
+
#
|
|
34
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
35
|
+
#
|
|
36
|
+
# @return [Increase::Models::LockboxAddress]
|
|
37
|
+
#
|
|
38
|
+
# @see Increase::Models::LockboxAddressRetrieveParams
|
|
39
|
+
def retrieve(lockbox_address_id, params = {})
|
|
40
|
+
@client.request(
|
|
41
|
+
method: :get,
|
|
42
|
+
path: ["lockbox_addresses/%1$s", lockbox_address_id],
|
|
43
|
+
model: Increase::LockboxAddress,
|
|
44
|
+
options: params[:request_options]
|
|
45
|
+
)
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# Update a Lockbox Address
|
|
49
|
+
#
|
|
50
|
+
# @overload update(lockbox_address_id, description: nil, status: nil, request_options: {})
|
|
51
|
+
#
|
|
52
|
+
# @param lockbox_address_id [String] The identifier of the Lockbox Address.
|
|
53
|
+
#
|
|
54
|
+
# @param description [String] The description you choose for the Lockbox Address.
|
|
55
|
+
#
|
|
56
|
+
# @param status [Symbol, Increase::Models::LockboxAddressUpdateParams::Status] The status of the Lockbox Address.
|
|
57
|
+
#
|
|
58
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
59
|
+
#
|
|
60
|
+
# @return [Increase::Models::LockboxAddress]
|
|
61
|
+
#
|
|
62
|
+
# @see Increase::Models::LockboxAddressUpdateParams
|
|
63
|
+
def update(lockbox_address_id, params = {})
|
|
64
|
+
parsed, options = Increase::LockboxAddressUpdateParams.dump_request(params)
|
|
65
|
+
@client.request(
|
|
66
|
+
method: :patch,
|
|
67
|
+
path: ["lockbox_addresses/%1$s", lockbox_address_id],
|
|
68
|
+
body: parsed,
|
|
69
|
+
model: Increase::LockboxAddress,
|
|
70
|
+
options: options
|
|
71
|
+
)
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# Some parameter documentations has been truncated, see
|
|
75
|
+
# {Increase::Models::LockboxAddressListParams} for more details.
|
|
76
|
+
#
|
|
77
|
+
# List Lockbox Addresses
|
|
78
|
+
#
|
|
79
|
+
# @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
80
|
+
#
|
|
81
|
+
# @param created_at [Increase::Models::LockboxAddressListParams::CreatedAt]
|
|
82
|
+
#
|
|
83
|
+
# @param cursor [String] Return the page of entries after this one.
|
|
84
|
+
#
|
|
85
|
+
# @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
|
|
86
|
+
#
|
|
87
|
+
# @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
|
|
88
|
+
#
|
|
89
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
90
|
+
#
|
|
91
|
+
# @return [Increase::Internal::Page<Increase::Models::LockboxAddress>]
|
|
92
|
+
#
|
|
93
|
+
# @see Increase::Models::LockboxAddressListParams
|
|
94
|
+
def list(params = {})
|
|
95
|
+
parsed, options = Increase::LockboxAddressListParams.dump_request(params)
|
|
96
|
+
query = Increase::Internal::Util.encode_query_params(parsed)
|
|
97
|
+
@client.request(
|
|
98
|
+
method: :get,
|
|
99
|
+
path: "lockbox_addresses",
|
|
100
|
+
query: query,
|
|
101
|
+
page: Increase::Internal::Page,
|
|
102
|
+
model: Increase::LockboxAddress,
|
|
103
|
+
options: options
|
|
104
|
+
)
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
# @api private
|
|
108
|
+
#
|
|
109
|
+
# @param client [Increase::Client]
|
|
110
|
+
def initialize(client:)
|
|
111
|
+
@client = client
|
|
112
|
+
end
|
|
113
|
+
end
|
|
114
|
+
end
|
|
115
|
+
end
|