class StarkBank::UtilityPayment
# UtilityPayment
object
When you initialize a UtilityPayment
, the entity will not be automatically created in the Stark Bank API. The 'create' function sends the objects to the Stark Bank API and returns the list of created objects.
## Parameters (conditionally required):
-
line [string, default nil]: Number sequence that describes the payment. Either 'line' or 'bar_code' parameters are required. If both are sent, they must match. ex: '34191.09008 63571.277308 71444.640008 5 81960000000062'
-
bar_code
[string, default nil]: Bar code number that describes the payment. Either 'line' or 'barCode' parameters are required. If both are sent, they must match. ex: '34195819600000000621090063571277307144464000'
## Parameters (required):
-
description [string]: Text to be displayed in your statement (min. 10 characters). ex: 'payment ABC'
## Parameters (optional):
-
scheduled [Date, DateTime, Time or string, default today]: payment scheduled date. ex: Date.new(2020, 3, 10)
-
tags [list of strings]: list of strings for tagging
## Attributes (return-only):
-
id [string, default nil]: unique id returned when payment is created. ex: '5656565656565656'
-
status [string, default nil]: current payment status. ex: 'success' or 'failed'
-
amount [int, default nil]: amount automatically calculated from line or bar_code. ex: 23456 (= R$ 234.56)
-
fee [integer, default nil]: fee charged when utility payment is created. ex: 200 (= R$ 2.00)
-
created [DateTime, default nil]: creation datetime for the payment. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
Attributes
Public Class Methods
# Create UtilityPayments
Send a list of UtilityPayment
objects for creation in the Stark Bank API
## Parameters (required):
-
payments [list of
UtilityPayment
objects]: list ofUtilityPayment
objects to be created in the API
## Parameters (optional):
-
user [Organization/Project object]:
Organization
orProject
object. Not necessary ifStarkBank.user
was set before function call
## Return:
-
list of
UtilityPayment
objects with updated attributes
# File lib/utility_payment/utility_payment.rb, line 58 def self.create(payments, user: nil) StarkBank::Utils::Rest.post(entities: payments, user: user, **resource) end
# Delete a UtilityPayment
entity
Delete a UtilityPayment
entity previously created in the Stark Bank API
## Parameters (required):
-
id [string]:
UtilityPayment
unique id. ex:'5656565656565656'
## Parameters (optional):
-
user [Organization/Project object]:
Organization
orProject
object. Not necessary ifStarkBank.user
was set before function call
## Return:
-
deleted
UtilityPayment
object
# File lib/utility_payment/utility_payment.rb, line 170 def self.delete(id, user: nil) StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource) end
# Retrieve a specific UtilityPayment
Receive a single UtilityPayment
object previously created by the Stark Bank API by passing its id
## Parameters (required):
-
id [string]: object unique id. ex: '5656565656565656'
## Parameters (optional):
-
user [Organization/Project object]:
Organization
orProject
object. Not necessary ifStarkBank.user
was set before function call
## Return:
-
UtilityPayment
object with updated attributes
# File lib/utility_payment/utility_payment.rb, line 74 def self.get(id, user: nil) StarkBank::Utils::Rest.get_id(id: id, user: user, **resource) end
StarkBank::Utils::Resource::new
# File lib/utility_payment/utility_payment.rb, line 33 def initialize(description:, line: nil, bar_code: nil, tags: nil, scheduled: nil, id: nil, amount: nil, fee: nil, status: nil, created: nil) super(id) @description = description @line = line @bar_code = bar_code @tags = tags @scheduled = StarkBank::Utils::Checks.check_date(scheduled) @amount = amount @fee = fee @status = status @created = StarkBank::Utils::Checks.check_datetime(created) end
# Retrieve paged UtilityPayments
Receive a list of up to 100 UtilityPayment
objects previously created in the Stark Bank API and the cursor to the next page. Use this function instead of query if you want to manually page your requests.
## Parameters (optional):
-
cursor [string, default nil]: cursor returned on the previous page function call
-
limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-
after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-
before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
-
tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
-
ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-
status [string, default nil]: filter for status of retrieved objects. ex: 'paid'
-
user [Organization/Project object]:
Organization
orProject
object. Not necessary ifStarkBank.user
was set before function call
## Return:
-
list of
UtilityPayment
objects with updated attributes and cursor to retrieve the next page ofUtilityPayment
objects
# File lib/utility_payment/utility_payment.rb, line 142 def self.page(cursor: nil, limit: nil, after: nil, before: nil, tags: nil, ids: nil, status: nil, user: nil) after = StarkBank::Utils::Checks.check_date(after) before = StarkBank::Utils::Checks.check_date(before) return StarkBank::Utils::Rest.get_page( cursor: cursor, limit: limit, after: after, before: before, tags: tags, ids: ids, status: status, user: user, **resource ) end
# Retrieve a specific UtilityPayment
pdf file
Receive a single UtilityPayment
pdf file generated in the Stark Bank API by passing its id. Only valid for utility payments with 'success' status.
## Parameters (required):
-
id [string]: object unique id. ex: '5656565656565656'
## Parameters (optional):
-
user [Organization/Project object]:
Organization
orProject
object. Not necessary ifStarkBank.user
was set before function call
## Return:
-
UtilityPayment
pdf file
# File lib/utility_payment/utility_payment.rb, line 91 def self.pdf(id, user: nil) StarkBank::Utils::Rest.get_content(id: id, user: user, sub_resource_name: 'pdf', **resource) end
# Retrieve UtilityPayments
Receive a generator of UtilityPayment
objects previously created in the Stark Bank API
## Parameters (optional):
-
limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-
after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-
before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
-
tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
-
ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-
status [string, default nil]: filter for status of retrieved objects. ex: 'paid'
-
user [Organization/Project object]:
Organization
orProject
object. Not necessary ifStarkBank.user
was set before function call
## Return:
-
generator of
UtilityPayment
objects with updated attributes
# File lib/utility_payment/utility_payment.rb, line 110 def self.query(limit: nil, after: nil, before: nil, tags: nil, ids: nil, status: nil, user: nil) after = StarkBank::Utils::Checks.check_date(after) before = StarkBank::Utils::Checks.check_date(before) StarkBank::Utils::Rest.get_stream( limit: limit, after: after, before: before, tags: tags, ids: ids, status: status, user: user, **resource ) end
# File lib/utility_payment/utility_payment.rb, line 174 def self.resource { resource_name: 'UtilityPayment', resource_maker: proc { |json| UtilityPayment.new( id: json['id'], description: json['description'], line: json['line'], bar_code: json['bar_code'], tags: json['tags'], scheduled: json['scheduled'], amount: json['amount'], fee: json['fee'], status: json['status'], created: json['created'] ) } } end