starkbank 2.2.0 → 2.5.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/lib/balance/balance.rb +2 -2
- data/lib/boleto/boleto.rb +53 -14
- data/lib/boleto/log.rb +36 -5
- data/lib/boleto_holmes/boleto_holmes.rb +41 -6
- data/lib/boleto_holmes/log.rb +36 -5
- data/lib/boleto_payment/boleto_payment.rb +42 -9
- data/lib/boleto_payment/log.rb +36 -5
- data/lib/brcode_payment/brcode_payment.rb +56 -17
- data/lib/brcode_payment/log.rb +36 -5
- data/lib/brcode_preview/brcode_preview.rb +2 -2
- data/lib/darf_payment/darf_payment.rb +218 -0
- data/lib/darf_payment/log.rb +125 -0
- data/lib/deposit/deposit.rb +46 -8
- data/lib/deposit/log.rb +36 -5
- data/lib/dict_key/dict_key.rb +45 -9
- data/lib/error.rb +13 -5
- data/lib/event/attempt.rb +125 -0
- data/lib/event/event.rb +44 -8
- data/lib/institution/institution.rb +67 -0
- data/lib/invoice/invoice.rb +72 -15
- data/lib/invoice/log.rb +52 -5
- data/lib/invoice/payment.rb +57 -0
- data/lib/payment_request/payment_request.rb +53 -11
- data/lib/starkbank.rb +9 -0
- data/lib/tax_payment/log.rb +125 -0
- data/lib/tax_payment/tax_payment.rb +203 -0
- data/lib/transaction/transaction.rb +39 -6
- data/lib/transfer/log.rb +36 -5
- data/lib/transfer/transfer.rb +59 -14
- data/lib/user/organization.rb +54 -0
- data/lib/user/project.rb +11 -6
- data/lib/user/user.rb +0 -4
- data/lib/utility_payment/log.rb +36 -5
- data/lib/utility_payment/utility_payment.rb +42 -9
- data/lib/utils/api.rb +1 -0
- data/lib/utils/request.rb +1 -1
- data/lib/utils/resource.rb +2 -21
- data/lib/utils/rest.rb +29 -14
- data/lib/utils/sub_resource.rb +28 -0
- data/lib/utils/url.rb +3 -1
- data/lib/webhook/webhook.rb +30 -9
- data/lib/workspace/workspace.rb +141 -0
- metadata +17 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: '08a72ad1389e8bcaa2f466c4fc6e3f0d299773da12d934449a389a36410b21eb'
|
4
|
+
data.tar.gz: 128f8bb159e098b3c1013332900e3cc949d05f4c62e4fcadead1c70b2f722581
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5811d6b08b2cd51589aee78ffb3b01193ff8df586af0ae7dcb401b1f0913448a420175090447cc4ace0cdbd318cc800664ea0d997ff2681a30426be0e0716b41
|
7
|
+
data.tar.gz: 00005b82bf82aaa0a2af6ec6df1b4001e2646848562688e874d8ea8a08d985c7ceacea0b34c4762d93c3fcc3aabc67d63594cb35752a49a71fe865c2f34e12e6
|
data/lib/balance/balance.rb
CHANGED
@@ -31,12 +31,12 @@ module StarkBank
|
|
31
31
|
# Receive the Balance object linked to your workspace in the Stark Bank API
|
32
32
|
#
|
33
33
|
# ## Parameters (optional):
|
34
|
-
# - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
|
34
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
35
35
|
#
|
36
36
|
# ## Return:
|
37
37
|
# - Balance object with updated attributes
|
38
38
|
def self.get(user: nil)
|
39
|
-
StarkBank::Utils::Rest.
|
39
|
+
StarkBank::Utils::Rest.get_stream(user: user, **resource).next
|
40
40
|
end
|
41
41
|
|
42
42
|
class << self
|
data/lib/boleto/boleto.rb
CHANGED
@@ -38,15 +38,17 @@ module StarkBank
|
|
38
38
|
# - fee [integer, default nil]: fee charged when Boleto is paid. ex: 200 (= R$ 2.00)
|
39
39
|
# - line [string, default nil]: generated Boleto line for payment. ex: '34191.09008 63571.277308 71444.640008 5 81960000000062'
|
40
40
|
# - bar_code [string, default nil]: generated Boleto bar-code for payment. ex: '34195819600000000621090063571277307144464000'
|
41
|
+
# - transaction_ids [list of strings, default nil]: ledger transaction ids linked to this boleto. ex: ['19827356981273']
|
41
42
|
# - status [string, default nil]: current Boleto status. ex: 'registered' or 'paid'
|
42
43
|
# - created [DateTime, default nil]: creation datetime for the Boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
|
44
|
+
# - our_number [string, default nil]: Reference number registered at the settlement bank. ex:'10131474'
|
43
45
|
class Boleto < StarkBank::Utils::Resource
|
44
|
-
attr_reader :amount, :name, :tax_id, :street_line_1, :street_line_2, :district, :city, :state_code, :zip_code, :due, :fine, :interest, :overdue_limit, :receiver_name, :receiver_tax_id, :tags, :descriptions, :discounts, :id, :fee, :line, :bar_code, :status, :created
|
46
|
+
attr_reader :amount, :name, :tax_id, :street_line_1, :street_line_2, :district, :city, :state_code, :zip_code, :due, :fine, :interest, :overdue_limit, :receiver_name, :receiver_tax_id, :tags, :descriptions, :discounts, :id, :fee, :line, :bar_code, :status, :transaction_ids, :created, :our_number
|
45
47
|
def initialize(
|
46
48
|
amount:, name:, tax_id:, street_line_1:, street_line_2:, district:, city:, state_code:, zip_code:,
|
47
49
|
due: nil, fine: nil, interest: nil, overdue_limit: nil, receiver_name: nil, receiver_tax_id: nil,
|
48
50
|
tags: nil, descriptions: nil, discounts: nil, id: nil, fee: nil, line: nil, bar_code: nil,
|
49
|
-
status: nil, created: nil
|
51
|
+
status: nil, transaction_ids: nil, created: nil, our_number: nil
|
50
52
|
)
|
51
53
|
super(id)
|
52
54
|
@amount = amount
|
@@ -71,7 +73,9 @@ module StarkBank
|
|
71
73
|
@line = line
|
72
74
|
@bar_code = bar_code
|
73
75
|
@status = status
|
76
|
+
@transaction_ids = transaction_ids
|
74
77
|
@created = StarkBank::Utils::Checks.check_datetime(created)
|
78
|
+
@our_number = our_number
|
75
79
|
end
|
76
80
|
|
77
81
|
# # Create Boletos
|
@@ -82,7 +86,7 @@ module StarkBank
|
|
82
86
|
# - boletos [list of Boleto objects]: list of Boleto objects to be created in the API
|
83
87
|
#
|
84
88
|
# ## Parameters (optional):
|
85
|
-
# - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
|
89
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
86
90
|
#
|
87
91
|
# ## Return:
|
88
92
|
# - list of Boleto objects with updated attributes
|
@@ -98,7 +102,7 @@ module StarkBank
|
|
98
102
|
# - id [string]: object unique id. ex: '5656565656565656'
|
99
103
|
#
|
100
104
|
# ## Parameters (optional):
|
101
|
-
# - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
|
105
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
102
106
|
#
|
103
107
|
# ## Return:
|
104
108
|
# - Boleto object with updated attributes
|
@@ -114,14 +118,14 @@ module StarkBank
|
|
114
118
|
# - id [string]: object unique id. ex: '5656565656565656'
|
115
119
|
#
|
116
120
|
# ## Parameters (optional):
|
117
|
-
# - layout [string]: Layout specification. Available options are
|
118
|
-
# - hidden_fields [list of strings, default nil]: List of string fields to be hidden in Boleto pdf. ex: [
|
119
|
-
# - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
|
121
|
+
# - layout [string]: Layout specification. Available options are 'default' and 'booklet'
|
122
|
+
# - hidden_fields [list of strings, default nil]: List of string fields to be hidden in Boleto pdf. ex: ['customerAddress']
|
123
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
120
124
|
#
|
121
125
|
# ## Return:
|
122
126
|
# - Boleto pdf file
|
123
127
|
def self.pdf(id, layout: nil, hidden_fields: nil, user: nil)
|
124
|
-
StarkBank::Utils::Rest.
|
128
|
+
StarkBank::Utils::Rest.get_content(id: id, layout: layout, hidden_fields: hidden_fields, sub_resource_name: 'pdf', user: user, **resource)
|
125
129
|
end
|
126
130
|
|
127
131
|
# # Retrieve Boletos
|
@@ -130,19 +134,52 @@ module StarkBank
|
|
130
134
|
#
|
131
135
|
# ## Parameters (optional):
|
132
136
|
# - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
|
133
|
-
# - after [Date
|
134
|
-
# - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
137
|
+
# - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
|
138
|
+
# - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
135
139
|
# - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
|
136
140
|
# - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
|
137
141
|
# - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
|
138
|
-
# - user [Project object
|
142
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
139
143
|
#
|
140
144
|
# ## Return:
|
141
145
|
# - generator of Boleto objects with updated attributes
|
142
146
|
def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, user: nil)
|
143
147
|
after = StarkBank::Utils::Checks.check_date(after)
|
144
148
|
before = StarkBank::Utils::Checks.check_date(before)
|
145
|
-
StarkBank::Utils::Rest.
|
149
|
+
StarkBank::Utils::Rest.get_stream(
|
150
|
+
limit: limit,
|
151
|
+
after: after,
|
152
|
+
before: before,
|
153
|
+
status: status,
|
154
|
+
tags: tags,
|
155
|
+
ids: ids,
|
156
|
+
user: user,
|
157
|
+
**resource
|
158
|
+
)
|
159
|
+
end
|
160
|
+
|
161
|
+
# # Retrieve paged Boletos
|
162
|
+
#
|
163
|
+
# Receive a list of up to 100 Boleto objects previously created in the Stark Bank API and the cursor to the next page.
|
164
|
+
# Use this function instead of query if you want to manually page your requests.
|
165
|
+
#
|
166
|
+
# ## Parameters (optional):
|
167
|
+
# - cursor [string, default nil]: cursor returned on the previous page function call
|
168
|
+
# - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
|
169
|
+
# - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
|
170
|
+
# - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
171
|
+
# - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
|
172
|
+
# - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
|
173
|
+
# - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
|
174
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
175
|
+
#
|
176
|
+
# ## Return:
|
177
|
+
# - list of Boleto objects with updated attributes and cursor to retrieve the next page of Boleto objects
|
178
|
+
def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, user: nil)
|
179
|
+
after = StarkBank::Utils::Checks.check_date(after)
|
180
|
+
before = StarkBank::Utils::Checks.check_date(before)
|
181
|
+
return StarkBank::Utils::Rest.get_page(
|
182
|
+
cursor: cursor,
|
146
183
|
limit: limit,
|
147
184
|
after: after,
|
148
185
|
before: before,
|
@@ -162,7 +199,7 @@ module StarkBank
|
|
162
199
|
# - id [string]: Boleto unique id. ex: '5656565656565656'
|
163
200
|
#
|
164
201
|
# ## Parameters (optional):
|
165
|
-
# - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
|
202
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
166
203
|
#
|
167
204
|
# ## Return:
|
168
205
|
# - deleted Boleto object
|
@@ -198,7 +235,9 @@ module StarkBank
|
|
198
235
|
line: json['line'],
|
199
236
|
bar_code: json['bar_code'],
|
200
237
|
status: json['status'],
|
201
|
-
|
238
|
+
transaction_ids: json['transaction_ids'],
|
239
|
+
created: json['created'],
|
240
|
+
our_number: json['our_number']
|
202
241
|
)
|
203
242
|
}
|
204
243
|
}
|
data/lib/boleto/log.rb
CHANGED
@@ -38,7 +38,7 @@ module StarkBank
|
|
38
38
|
# - id [string]: object unique id. ex: '5656565656565656'
|
39
39
|
#
|
40
40
|
# ## Parameters (optional):
|
41
|
-
# - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
|
41
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
42
42
|
#
|
43
43
|
# ## Return:
|
44
44
|
# - Log object with updated attributes
|
@@ -52,18 +52,49 @@ module StarkBank
|
|
52
52
|
#
|
53
53
|
# ## Parameters (optional):
|
54
54
|
# - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
|
55
|
-
# - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
|
56
|
-
# - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
55
|
+
# - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
|
56
|
+
# - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
57
57
|
# - types [list of strings, default nil]: filter for log event types. ex: 'paid' or 'registered'
|
58
58
|
# - boleto_ids [list of strings, default nil]: list of Boleto ids to filter logs. ex: ['5656565656565656', '4545454545454545']
|
59
|
-
# - user [Project object
|
59
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
60
60
|
#
|
61
61
|
# ## Return:
|
62
62
|
# - list of Log objects with updated attributes
|
63
63
|
def self.query(limit: nil, after: nil, before: nil, types: nil, boleto_ids: nil, user: nil)
|
64
64
|
after = StarkBank::Utils::Checks.check_date(after)
|
65
65
|
before = StarkBank::Utils::Checks.check_date(before)
|
66
|
-
StarkBank::Utils::Rest.
|
66
|
+
StarkBank::Utils::Rest.get_stream(
|
67
|
+
limit: limit,
|
68
|
+
after: after,
|
69
|
+
before: before,
|
70
|
+
types: types,
|
71
|
+
boleto_ids: boleto_ids,
|
72
|
+
user: user,
|
73
|
+
**resource
|
74
|
+
)
|
75
|
+
end
|
76
|
+
|
77
|
+
# # Retrieve paged Logs
|
78
|
+
#
|
79
|
+
# Receive a list of up to 100 Log objects previously created in the Stark Bank API and the cursor to the next page.
|
80
|
+
# Use this function instead of query if you want to manually page your requests.
|
81
|
+
#
|
82
|
+
# ## Parameters (optional):
|
83
|
+
# - cursor [string, default nil]: cursor returned on the previous page function call
|
84
|
+
# - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
|
85
|
+
# - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
|
86
|
+
# - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
87
|
+
# - types [list of strings, default nil]: filter for log event types. ex: 'paid' or 'registered'
|
88
|
+
# - boleto_ids [list of strings, default nil]: list of Boleto ids to filter logs. ex: ['5656565656565656', '4545454545454545']
|
89
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
90
|
+
#
|
91
|
+
# ## Return:
|
92
|
+
# - list of Log objects with updated attributes and cursor to retrieve the next page of Log objects
|
93
|
+
def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, boleto_ids: nil, user: nil)
|
94
|
+
after = StarkBank::Utils::Checks.check_date(after)
|
95
|
+
before = StarkBank::Utils::Checks.check_date(before)
|
96
|
+
return StarkBank::Utils::Rest.get_page(
|
97
|
+
cursor: cursor,
|
67
98
|
limit: limit,
|
68
99
|
after: after,
|
69
100
|
before: before,
|
@@ -45,7 +45,7 @@ module StarkBank
|
|
45
45
|
# - holmes [list of BoletoHolmes objects]: list of BoletoHolmes objects to be created in the API
|
46
46
|
#
|
47
47
|
# ## Parameters (optional):
|
48
|
-
# - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
|
48
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
49
49
|
#
|
50
50
|
# ## Return:
|
51
51
|
# - list of BoletoHolmes objects with updated attributes
|
@@ -61,7 +61,7 @@ module StarkBank
|
|
61
61
|
# - id [string]: object unique id. ex: '5656565656565656'
|
62
62
|
#
|
63
63
|
# ## Parameters (optional):
|
64
|
-
# - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
|
64
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
65
65
|
#
|
66
66
|
# ## Return:
|
67
67
|
# - BoletoHolmes object with updated attributes
|
@@ -75,20 +75,55 @@ module StarkBank
|
|
75
75
|
#
|
76
76
|
# ## Parameters (optional):
|
77
77
|
# - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
|
78
|
-
# - after [Date
|
79
|
-
# - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
78
|
+
# - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
|
79
|
+
# - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
80
80
|
# - status [string, default nil]: filter for status of retrieved objects. ex: 'solved'
|
81
81
|
# - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
|
82
82
|
# - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
|
83
83
|
# - boleto_id [string, default nil]: filter for holmes that investigate a specific boleto by its ID. ex: '5656565656565656'
|
84
|
-
# - user [Project object
|
84
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
85
85
|
#
|
86
86
|
# ## Return:
|
87
87
|
# - generator of BoletoHolmes objects with updated attributes
|
88
88
|
def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, boleto_id: nil, user: nil)
|
89
89
|
after = StarkBank::Utils::Checks.check_date(after)
|
90
90
|
before = StarkBank::Utils::Checks.check_date(before)
|
91
|
-
StarkBank::Utils::Rest.
|
91
|
+
StarkBank::Utils::Rest.get_stream(
|
92
|
+
limit: limit,
|
93
|
+
after: after,
|
94
|
+
before: before,
|
95
|
+
status: status,
|
96
|
+
tags: tags,
|
97
|
+
ids: ids,
|
98
|
+
boleto_id: boleto_id,
|
99
|
+
user: user,
|
100
|
+
**resource
|
101
|
+
)
|
102
|
+
end
|
103
|
+
|
104
|
+
# # Retrieve paged BoletoHolmes
|
105
|
+
#
|
106
|
+
# Receive a list of up to 100 BoletoHolmes objects previously created in the Stark Bank API and the cursor to the next page.
|
107
|
+
# Use this function instead of query if you want to manually page your requests.
|
108
|
+
#
|
109
|
+
# ## Parameters (optional):
|
110
|
+
# - cursor [string, default nil]: cursor returned on the previous page function call
|
111
|
+
# - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
|
112
|
+
# - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
|
113
|
+
# - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
114
|
+
# - status [string, default nil]: filter for status of retrieved objects. ex: 'solved'
|
115
|
+
# - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
|
116
|
+
# - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
|
117
|
+
# - boleto_id [string, default nil]: filter for holmes that investigate a specific boleto by its ID. ex: '5656565656565656'
|
118
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
119
|
+
#
|
120
|
+
# ## Return:
|
121
|
+
# - list of BoletoHolmes objects with updated attributes and cursor to retrieve the next page of BoletoHolmes objects
|
122
|
+
def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, boleto_id: nil, user: nil)
|
123
|
+
after = StarkBank::Utils::Checks.check_date(after)
|
124
|
+
before = StarkBank::Utils::Checks.check_date(before)
|
125
|
+
return StarkBank::Utils::Rest.get_page(
|
126
|
+
cursor: cursor,
|
92
127
|
limit: limit,
|
93
128
|
after: after,
|
94
129
|
before: before,
|
data/lib/boleto_holmes/log.rb
CHANGED
@@ -36,7 +36,7 @@ module StarkBank
|
|
36
36
|
# - id [string]: object unique id. ex: '5656565656565656'
|
37
37
|
#
|
38
38
|
# ## Parameters (optional):
|
39
|
-
# - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
|
39
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
40
40
|
#
|
41
41
|
# ## Return:
|
42
42
|
# - Log object with updated attributes
|
@@ -50,18 +50,49 @@ module StarkBank
|
|
50
50
|
#
|
51
51
|
# ## Parameters (optional):
|
52
52
|
# - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
|
53
|
-
# - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
|
54
|
-
# - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
53
|
+
# - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
|
54
|
+
# - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
55
55
|
# - types [list of strings, default nil]: filter for log event types. ex: 'paid' or 'registered'
|
56
56
|
# - holmes_ids [list of strings, default nil]: list of BoletoHolmes ids to filter logs. ex: ['5656565656565656', '4545454545454545']
|
57
|
-
# - user [Project object
|
57
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
58
58
|
#
|
59
59
|
# ## Return:
|
60
60
|
# - list of Log objects with updated attributes
|
61
61
|
def self.query(limit: nil, after: nil, before: nil, types: nil, holmes_ids: nil, user: nil)
|
62
62
|
after = StarkBank::Utils::Checks.check_date(after)
|
63
63
|
before = StarkBank::Utils::Checks.check_date(before)
|
64
|
-
StarkBank::Utils::Rest.
|
64
|
+
StarkBank::Utils::Rest.get_stream(
|
65
|
+
limit: limit,
|
66
|
+
after: after,
|
67
|
+
before: before,
|
68
|
+
types: types,
|
69
|
+
holmes_ids: holmes_ids,
|
70
|
+
user: user,
|
71
|
+
**resource
|
72
|
+
)
|
73
|
+
end
|
74
|
+
|
75
|
+
# # Retrieve paged Logs
|
76
|
+
#
|
77
|
+
# Receive a list of up to 100 Log objects previously created in the Stark Bank API and the cursor to the next page.
|
78
|
+
# Use this function instead of query if you want to manually page your requests.
|
79
|
+
#
|
80
|
+
# ## Parameters (optional):
|
81
|
+
# - cursor [string, default nil]: cursor returned on the previous page function call
|
82
|
+
# - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
|
83
|
+
# - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
|
84
|
+
# - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
85
|
+
# - types [list of strings, default nil]: filter for log event types. ex: 'paid' or 'registered'
|
86
|
+
# - holmes_ids [list of strings, default nil]: list of BoletoHolmes ids to filter logs. ex: ['5656565656565656', '4545454545454545']
|
87
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
88
|
+
#
|
89
|
+
# ## Return:
|
90
|
+
# - list of Log objects with updated attributes and cursor to retrieve the next page of Log objects
|
91
|
+
def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, holmes_ids: nil, user: nil)
|
92
|
+
after = StarkBank::Utils::Checks.check_date(after)
|
93
|
+
before = StarkBank::Utils::Checks.check_date(before)
|
94
|
+
return StarkBank::Utils::Rest.get_page(
|
95
|
+
cursor: cursor,
|
65
96
|
limit: limit,
|
66
97
|
after: after,
|
67
98
|
before: before,
|
@@ -53,7 +53,7 @@ module StarkBank
|
|
53
53
|
# - payments [list of BoletoPayment objects]: list of BoletoPayment objects to be created in the API
|
54
54
|
#
|
55
55
|
# ## Parameters (optional):
|
56
|
-
# - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
|
56
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
57
57
|
#
|
58
58
|
# ## Return:
|
59
59
|
# - list of BoletoPayment objects with updated attributes
|
@@ -69,7 +69,7 @@ module StarkBank
|
|
69
69
|
# - id [string]: object unique id. ex: '5656565656565656'
|
70
70
|
#
|
71
71
|
# ## Parameters (optional):
|
72
|
-
# - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
|
72
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
73
73
|
#
|
74
74
|
# ## Return:
|
75
75
|
# - BoletoPayment object with updated attributes
|
@@ -86,12 +86,12 @@ module StarkBank
|
|
86
86
|
# - id [string]: object unique id. ex: '5656565656565656'
|
87
87
|
#
|
88
88
|
# ## Parameters (optional):
|
89
|
-
# - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
|
89
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
90
90
|
#
|
91
91
|
# ## Return:
|
92
92
|
# - BoletoPayment pdf file
|
93
93
|
def self.pdf(id, user: nil)
|
94
|
-
StarkBank::Utils::Rest.
|
94
|
+
StarkBank::Utils::Rest.get_content(id: id, user: user, sub_resource_name: 'pdf', **resource)
|
95
95
|
end
|
96
96
|
|
97
97
|
# # Retrieve BoletoPayments
|
@@ -100,19 +100,52 @@ module StarkBank
|
|
100
100
|
#
|
101
101
|
# ## Parameters (optional):
|
102
102
|
# - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
|
103
|
-
# - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
|
104
|
-
# - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
103
|
+
# - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
|
104
|
+
# - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
105
105
|
# - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
|
106
106
|
# - ids [list of strings, default nil]: list of strings to get specific entities by ids. ex: ['12376517623', '1928367198236']
|
107
107
|
# - status [string, default nil]: filter for status of retrieved objects. ex: 'paid'
|
108
|
-
# - user [Project object
|
108
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
109
109
|
#
|
110
110
|
# ## Return:
|
111
111
|
# - generator of BoletoPayment objects with updated attributes
|
112
112
|
def self.query(limit: nil, after: nil, before: nil, tags: nil, ids: nil, status: nil, user: nil)
|
113
113
|
after = StarkBank::Utils::Checks.check_date(after)
|
114
114
|
before = StarkBank::Utils::Checks.check_date(before)
|
115
|
-
StarkBank::Utils::Rest.
|
115
|
+
StarkBank::Utils::Rest.get_stream(
|
116
|
+
user: user,
|
117
|
+
limit: limit,
|
118
|
+
after: after,
|
119
|
+
before: before,
|
120
|
+
tags: tags,
|
121
|
+
ids: ids,
|
122
|
+
status: status,
|
123
|
+
**resource
|
124
|
+
)
|
125
|
+
end
|
126
|
+
|
127
|
+
# # Retrieve paged BoletoPayments
|
128
|
+
#
|
129
|
+
# Receive a list of up to 100 BoletoPayment objects previously created in the Stark Bank API and the cursor to the next page.
|
130
|
+
# Use this function instead of query if you want to manually page your requests.
|
131
|
+
#
|
132
|
+
# ## Parameters (optional):
|
133
|
+
# - cursor [string, default nil]: cursor returned on the previous page function call
|
134
|
+
# - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
|
135
|
+
# - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
|
136
|
+
# - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
|
137
|
+
# - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
|
138
|
+
# - ids [list of strings, default nil]: list of strings to get specific entities by ids. ex: ['12376517623', '1928367198236']
|
139
|
+
# - status [string, default nil]: filter for status of retrieved objects. ex: 'paid'
|
140
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
141
|
+
#
|
142
|
+
# ## Return:
|
143
|
+
# - list of BoletoPayment objects with updated attributes and cursor to retrieve the next page of BoletoPayment objects
|
144
|
+
def self.page(cursor: nil, limit: nil, after: nil, before: nil, tags: nil, ids: nil, status: nil, user: nil)
|
145
|
+
after = StarkBank::Utils::Checks.check_date(after)
|
146
|
+
before = StarkBank::Utils::Checks.check_date(before)
|
147
|
+
return StarkBank::Utils::Rest.get_page(
|
148
|
+
cursor: cursor,
|
116
149
|
user: user,
|
117
150
|
limit: limit,
|
118
151
|
after: after,
|
@@ -131,7 +164,7 @@ module StarkBank
|
|
131
164
|
# Parameters (required):
|
132
165
|
# - id [string]: BoletoPayment unique id. ex: '5656565656565656'
|
133
166
|
# Parameters (optional):
|
134
|
-
# - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
|
167
|
+
# - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
|
135
168
|
# Return:
|
136
169
|
# - deleted BoletoPayment object
|
137
170
|
def self.delete(id, user: nil)
|