starkbank 2.1.0 → 2.4.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 21f296f6ce46e6451eb4650fcc5bd8f77b657184b10662daae70c79c4df26cc3
4
- data.tar.gz: 2a0355e608aa51c1302ea55c8491741981afbfefd2bb86f56fb606fc4ab38c76
3
+ metadata.gz: 865e407d8c6cc8b02de3bbe91e5303ae996234867282f163a14f495fcdb5408c
4
+ data.tar.gz: 96d199d34eabfd9694a55b1b435d84aa008a71dd697141b106b2373b11625070
5
5
  SHA512:
6
- metadata.gz: cce7c99b52dc834e4110caa9861a89dbb039d02d080d17631995666298798f6c1ca7024796958cc170d7f08d5a594a8f8ee4bb98078f8897e75a8455dad55987
7
- data.tar.gz: 2e5c9d0a3d0f33b050f08b29e35453db3011190760145aec59a87a993a1086c038e9d430004cd8bdf7fe1ef657d08554d4eea4fec14d5e9d2692f57df71808c5
6
+ metadata.gz: db7c4ff0fb3fc908b2d68c16f984b685a9181e0fc7d43bb2ae5e6085c10778ff91e4fee4575b37ca03379ca976a131039d5a4fdb626757f9b53427336740b621
7
+ data.tar.gz: e3b1397b1b8b494f22469d6c8a3b74cd8165498096958d748bbbfeca4d7511efa6c599854b06a6be6d48af7aac1afb2184924d845894a72a08ed0084b4b8b85f
@@ -31,7 +31,7 @@ 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
@@ -58,7 +58,7 @@ module StarkBank
58
58
  @city = city
59
59
  @state_code = state_code
60
60
  @zip_code = zip_code
61
- @due = due
61
+ @due = StarkBank::Utils::Checks.check_date(due)
62
62
  @fine = fine
63
63
  @interest = interest
64
64
  @overdue_limit = overdue_limit
@@ -82,7 +82,7 @@ module StarkBank
82
82
  # - boletos [list of Boleto objects]: list of Boleto objects to be created in the API
83
83
  #
84
84
  # ## Parameters (optional):
85
- # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
85
+ # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
86
86
  #
87
87
  # ## Return:
88
88
  # - list of Boleto objects with updated attributes
@@ -98,7 +98,7 @@ module StarkBank
98
98
  # - id [string]: object unique id. ex: '5656565656565656'
99
99
  #
100
100
  # ## Parameters (optional):
101
- # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
101
+ # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
102
102
  #
103
103
  # ## Return:
104
104
  # - Boleto object with updated attributes
@@ -115,12 +115,13 @@ module StarkBank
115
115
  #
116
116
  # ## Parameters (optional):
117
117
  # - layout [string]: Layout specification. Available options are "default" and "booklet"
118
- # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
118
+ # - hidden_fields [list of strings, default nil]: List of string fields to be hidden in Boleto pdf. ex: ["customerAddress"]
119
+ # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
119
120
  #
120
121
  # ## Return:
121
122
  # - Boleto pdf file
122
- def self.pdf(id, layout: nil, user: nil)
123
- StarkBank::Utils::Rest.get_pdf(id: id, layout: layout, user: user, **resource)
123
+ def self.pdf(id, layout: nil, hidden_fields: nil, user: nil)
124
+ StarkBank::Utils::Rest.get_pdf(id: id, layout: layout, hidden_fields: hidden_fields, user: user, **resource)
124
125
  end
125
126
 
126
127
  # # Retrieve Boletos
@@ -134,7 +135,7 @@ module StarkBank
134
135
  # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
135
136
  # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
136
137
  # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
137
- # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
138
+ # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
138
139
  #
139
140
  # ## Return:
140
141
  # - generator of Boleto objects with updated attributes
@@ -161,7 +162,7 @@ module StarkBank
161
162
  # - id [string]: Boleto unique id. ex: '5656565656565656'
162
163
  #
163
164
  # ## Parameters (optional):
164
- # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
165
+ # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
165
166
  #
166
167
  # ## Return:
167
168
  # - deleted Boleto object
@@ -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
@@ -56,7 +56,7 @@ module StarkBank
56
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, default nil]: Project object. Not necessary if StarkBank.user was set before function call
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
@@ -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
@@ -81,7 +81,7 @@ module StarkBank
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, default nil]: Project object. Not necessary if StarkBank.user was set before function call
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
@@ -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
@@ -54,7 +54,7 @@ module StarkBank
54
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, default nil]: Project object. Not necessary if StarkBank.user was set before function call
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
@@ -37,7 +37,7 @@ module StarkBank
37
37
  @description = description
38
38
  @line = line
39
39
  @bar_code = bar_code
40
- @scheduled = StarkBank::Utils::Checks.check_datetime(scheduled)
40
+ @scheduled = StarkBank::Utils::Checks.check_date(scheduled)
41
41
  @tags = tags
42
42
  @status = status
43
43
  @amount = amount
@@ -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,7 +86,7 @@ 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
@@ -105,7 +105,7 @@ module StarkBank
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, default nil]: Project object. Not necessary if StarkBank.user was set before function call
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
@@ -131,7 +131,7 @@ module StarkBank
131
131
  # Parameters (required):
132
132
  # - id [string]: BoletoPayment unique id. ex: '5656565656565656'
133
133
  # Parameters (optional):
134
- # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
134
+ # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
135
135
  # Return:
136
136
  # - deleted BoletoPayment object
137
137
  def self.delete(id, user: nil)
@@ -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
@@ -54,9 +54,9 @@ module StarkBank
54
54
  # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
55
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
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
- # - types [list of strings, default nil]: filter retrieved objects by event types. ex: 'paid' or 'registered'
57
+ # - types [list of strings, default nil]: filter retrieved objects by event types. ex: 'success' or 'failed'
58
58
  # - payment_ids [list of strings, default nil]: list of BoletoPayment ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
59
- # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
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
@@ -0,0 +1,167 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative('../utils/resource')
4
+ require_relative('../utils/rest')
5
+ require_relative('../utils/checks')
6
+
7
+ module StarkBank
8
+ # # BrcodePayment object
9
+ #
10
+ # When you initialize a BrcodePayment, the entity will not be automatically
11
+ # created in the Stark Bank API. The 'create' function sends the objects
12
+ # to the Stark Bank API and returns the list of created objects.
13
+ #
14
+ # ## Parameters (required):
15
+ # - brcode [string]: String loaded directly from the QRCode or copied from the invoice. ex: "00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A"
16
+ # - tax_id [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80"
17
+ # - description [string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC"
18
+ #
19
+ # ## Parameters (conditionally required):
20
+ # - amount [int, default nil]: If the BRCode does not provide an amount, this parameter is mandatory, else it is optional. ex: 23456 (= R$ 234.56)
21
+ #
22
+ # ## Parameters (optional):
23
+ # - scheduled [datetime.date, datetime.datetime or string, default now]: payment scheduled date or datetime. ex: datetime.datetime(2020, 3, 10, 15, 17, 3)
24
+ # - tags [list of strings, default nil]: list of strings for tagging
25
+ #
26
+ # ## Attributes (return-only):
27
+ # - id [string, default nil]: unique id returned when payment is created. ex: "5656565656565656"
28
+ # - status [string, default nil]: current payment status. ex: "success" or "failed"
29
+ # - type [string, default nil]: brcode type. ex: "static" or "dynamic"
30
+ # - fee [integer, default nil]: fee charged when the brcode payment is created. ex: 200 (= R$ 2.00)
31
+ # - updated [datetime.datetime, default nil]: latest update datetime for the payment. ex: datetime.datetime(2020, 3, 10, 10, 30, 0, 0)
32
+ # - created [datetime.datetime, default nil]: creation datetime for the payment. ex: datetime.datetime(2020, 3, 10, 10, 30, 0, 0)
33
+ class BrcodePayment < StarkBank::Utils::Resource
34
+ attr_reader :brcode, :tax_id, :description, :amount, :scheduled, :tags, :id, :status, :type, :fee, :updated, :created
35
+ def initialize(brcode:, tax_id:, description:, amount: nil, scheduled: nil, tags: nil, id: nil, status: nil, type: nil, fee: nil, updated: nil, created: nil)
36
+ super(id)
37
+ @brcode = brcode
38
+ @tax_id = tax_id
39
+ @description = description
40
+ @amount = amount
41
+ @scheduled = StarkBank::Utils::Checks.check_date_or_datetime(scheduled)
42
+ @tags = tags
43
+ @status = status
44
+ @type = type
45
+ @fee = fee
46
+ @updated = StarkBank::Utils::Checks.check_datetime(updated)
47
+ @created = StarkBank::Utils::Checks.check_datetime(created)
48
+ end
49
+
50
+ # # Create BrcodePayments
51
+ #
52
+ # Send a list of BrcodePayment objects for creation in the Stark Bank API
53
+ #
54
+ # ## Parameters (required):
55
+ # - payments [list of BrcodePayment objects]: list of BrcodePayment objects to be created in the API
56
+ #
57
+ # ## Parameters (optional):
58
+ # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
59
+ #
60
+ # ## Return:
61
+ # - list of BrcodePayment objects with updated attributes
62
+ def self.create(payments, user: nil)
63
+ StarkBank::Utils::Rest.post(entities: payments, user: user, **resource)
64
+ end
65
+
66
+ # # Retrieve a specific BrcodePayment
67
+ #
68
+ # Receive a single BrcodePayment object previously created by the Stark Bank API by passing its id
69
+ #
70
+ # ## Parameters (required):
71
+ # - id [string]: object unique id. ex: '5656565656565656'
72
+ #
73
+ # ## Parameters (optional):
74
+ # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
75
+ #
76
+ # ## Return:
77
+ # - BrcodePayment object with updated attributes
78
+ def self.get(id, user: nil)
79
+ StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
80
+ end
81
+
82
+ # # Retrieve a specific BrcodePayment pdf file
83
+ #
84
+ # Receive a single BrcodePayment pdf file generated in the Stark Bank API by passing its id.
85
+ #
86
+ # ## Parameters (required):
87
+ # - id [string]: object unique id. ex: '5656565656565656'
88
+ #
89
+ # ## Parameters (optional):
90
+ # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
91
+ #
92
+ # ## Return:
93
+ # - BrcodePayment pdf file
94
+ def self.pdf(id, user: nil)
95
+ StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
96
+ end
97
+
98
+ # # Update a BrcodePayment entity
99
+ #
100
+ # Update a BrcodePayment entity previously created in the Stark Bank API
101
+ #
102
+ # ## Parameters (required):
103
+ # - id [string]: BrcodePayment unique id. ex: '5656565656565656'
104
+ # - status [string, nil]: You may cancel the payment by passing 'canceled' in the status
105
+ #
106
+ # ## Parameters (optional):
107
+ # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
108
+ #
109
+ # ## Return:
110
+ # - updated BrcodePayment object
111
+ def self.update(id, status: nil, user: nil)
112
+ StarkBank::Utils::Rest.patch_id(id: id, status: status, user: user, **resource)
113
+ end
114
+
115
+ # # Retrieve BrcodePayments
116
+ #
117
+ # Receive a generator of BrcodePayment objects previously created in the Stark Bank API
118
+ #
119
+ # ## Parameters (optional):
120
+ # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
121
+ # - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
122
+ # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
123
+ # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
124
+ # - ids [list of strings, default nil]: list of strings to get specific entities by ids. ex: ['12376517623', '1928367198236']
125
+ # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid'
126
+ # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
127
+ #
128
+ # ## Return:
129
+ # - generator of BrcodePayment objects with updated attributes
130
+ def self.query(limit: nil, after: nil, before: nil, tags: nil, ids: nil, status: nil, user: nil)
131
+ after = StarkBank::Utils::Checks.check_date(after)
132
+ before = StarkBank::Utils::Checks.check_date(before)
133
+ StarkBank::Utils::Rest.get_list(
134
+ user: user,
135
+ limit: limit,
136
+ after: after,
137
+ before: before,
138
+ tags: tags,
139
+ ids: ids,
140
+ status: status,
141
+ **resource
142
+ )
143
+ end
144
+
145
+ def self.resource
146
+ {
147
+ resource_name: 'BrcodePayment',
148
+ resource_maker: proc { |json|
149
+ BrcodePayment.new(
150
+ brcode: json['brcode'],
151
+ tax_id: json['tax_id'],
152
+ description: json['description'],
153
+ amount: json['amount'],
154
+ scheduled: json['scheduled'],
155
+ tags: json['tags'],
156
+ id: json['id'],
157
+ status: json['status'],
158
+ type: json['type'],
159
+ fee: json['fee'],
160
+ updated: json['updated'],
161
+ created: json['created']
162
+ )
163
+ }
164
+ }
165
+ end
166
+ end
167
+ end
@@ -0,0 +1,94 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative('../utils/resource')
4
+ require_relative('../utils/rest')
5
+ require_relative('../utils/checks')
6
+ require_relative('brcode_payment')
7
+
8
+ module StarkBank
9
+ class BrcodePayment
10
+ # # BrcodePayment::Log object
11
+ #
12
+ # Every time a BrcodePayment entity is modified, a corresponding BrcodePayment::Log
13
+ # is generated for the entity. This log is never generated by the
14
+ # user, but it can be retrieved to check additional information
15
+ # on the BrcodePayment.
16
+ #
17
+ # ## Attributes:
18
+ # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
19
+ # - payment [BrcodePayment]: BrcodePayment entity to which the log refers to.
20
+ # - errors [list of strings]: list of errors linked to this BrcodePayment event.
21
+ # - type [string]: type of the BrcodePayment event which triggered the log creation. ex: 'processing' or 'success'
22
+ # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
23
+ class Log < StarkBank::Utils::Resource
24
+ attr_reader :id, :created, :type, :errors, :payment
25
+ def initialize(id:, created:, type:, errors:, payment:)
26
+ super(id)
27
+ @type = type
28
+ @errors = errors
29
+ @payment = payment
30
+ @created = StarkBank::Utils::Checks.check_datetime(created)
31
+ end
32
+
33
+ # # Retrieve a specific Log
34
+ #
35
+ # Receive a single Log object previously created by the Stark Bank API by passing its id
36
+ #
37
+ # ## Parameters (required):
38
+ # - id [string]: object unique id. ex: '5656565656565656'
39
+ #
40
+ # ## Parameters (optional):
41
+ # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
42
+ #
43
+ # ## Return:
44
+ # - Log object with updated attributes
45
+ def self.get(id, user: nil)
46
+ StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
47
+ end
48
+
49
+ # # Retrieve Logs
50
+ #
51
+ # Receive a generator of Log objects previously created in the Stark Bank API
52
+ #
53
+ # ## Parameters (optional):
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)
57
+ # - types [list of strings, default nil]: filter retrieved objects by event types. ex: 'success' or 'failed'
58
+ # - payment_ids [list of strings, default nil]: list of BrcodePayment ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
59
+ # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
60
+ #
61
+ # ## Return:
62
+ # - list of Log objects with updated attributes
63
+ def self.query(limit: nil, after: nil, before: nil, types: nil, payment_ids: nil, user: nil)
64
+ after = StarkBank::Utils::Checks.check_date(after)
65
+ before = StarkBank::Utils::Checks.check_date(before)
66
+ StarkBank::Utils::Rest.get_list(
67
+ limit: limit,
68
+ after: after,
69
+ before: before,
70
+ types: types,
71
+ payment_ids: payment_ids,
72
+ user: user,
73
+ **resource
74
+ )
75
+ end
76
+
77
+ def self.resource
78
+ payment_maker = StarkBank::BrcodePayment.resource[:resource_maker]
79
+ {
80
+ resource_name: 'BrcodePaymentLog',
81
+ resource_maker: proc { |json|
82
+ Log.new(
83
+ id: json['id'],
84
+ created: json['created'],
85
+ type: json['type'],
86
+ errors: json['errors'],
87
+ payment: StarkBank::Utils::API.from_api_json(payment_maker, json['payment'])
88
+ )
89
+ }
90
+ }
91
+ end
92
+ end
93
+ end
94
+ end