Class: StarkBank::Boleto

Inherits:
Utils::Resource show all
Defined in:
lib/boleto/boleto.rb,
lib/boleto/log.rb

Overview

# Boleto object

When you initialize a Boleto, the entity will not be automatically sent to the Stark Bank API. The ‘create’ function sends the objects to the Stark Bank API and returns the list of created objects.

## Parameters (required):

  • amount [integer]: Boleto value in cents. Minimum = 200 (R$2,00). ex: 1234 (= R$ 12.34)

  • name [string]: payer full name. ex: “Anthony Edward Stark”

  • tax_id [string]: payer tax ID (CPF or CNPJ) with or without formatting. ex: “01234567890” or “20.018.183/0001-80”

  • street_line_1 [string]: payer main address. ex: Av. Paulista, 200

  • street_line_2 [string]: payer address complement. ex: Apto. 123

  • district [string]: payer address district / neighbourhood. ex: Bela Vista

  • city [string]: payer address city. ex: Rio de Janeiro

  • state_code [string]: payer address state. ex: GO

  • zip_code [string]: payer address zip code. ex: 01311-200

## Parameters (optional):

  • due [Date, DateTime, Time or string, default today + 2 days]: Boleto due date in ISO format. ex: 2020-04-30

  • fine [float, default 0.0]: Boleto fine for overdue payment in %. ex: 2.5

  • interest [float, default 0.0]: Boleto monthly interest for overdue payment in %. ex: 5.2

  • overdue_limit [integer, default 59]: limit in days for automatic Boleto cancellation after due date. ex: 7 (max: 59)

  • descriptions [list of dictionaries, default nil]: list of dictionaries with “text”:string and (optional) “amount”:int pairs

  • discounts [list of dictionaries, default nil]: list of dictionaries with “percentage”:float and “date”:Date or string pairs

  • tags [list of strings]: list of strings for tagging

## Attributes (return-only):

  • id [string, default nil]: unique id returned when Boleto is created. ex: “5656565656565656”

  • fee [integer, default nil]: fee charged when Boleto is paid. ex: 200 (= R$ 2.00)

  • line [string, default nil]: generated Boleto line for payment. ex: “34191.09008 63571.277308 71444.640008 5 81960000000062”

  • bar_code [string, default nil]: generated Boleto bar-code for payment. ex: “34195819600000000621090063571277307144464000”

  • status [string, default nil]: current Boleto status. ex: “registered” or “paid”

  • created [DateTime, default nil]: creation datetime for the Boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)

Defined Under Namespace

Classes: Log

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Utils::Resource

#inspect, #to_s

Constructor Details

#initialize(amount:, name:, tax_id:, street_line_1:, street_line_2:, district:, city:, state_code:, zip_code:, due: nil, fine: nil, interest: nil, overdue_limit: nil, tags: nil, descriptions: nil, discounts: nil, id: nil, fee: nil, line: nil, bar_code: nil, status: nil, created: nil) ⇒ Boleto

Returns a new instance of Boleto.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/boleto/boleto.rb', line 43

def initialize(
  amount:, name:, tax_id:, street_line_1:, street_line_2:, district:, city:, state_code:, zip_code:,
  due: nil, fine: nil, interest: nil, overdue_limit: nil, tags: nil, descriptions: nil, discounts: nil,
  id: nil, fee: nil, line: nil, bar_code: nil, status: nil, created: nil
)
  super(id)
  @amount = amount
  @name = name
  @tax_id = tax_id
  @street_line_1 = street_line_1
  @street_line_2 = street_line_2
  @district = district
  @city = city
  @state_code = state_code
  @zip_code = zip_code
  @due = due
  @fine = fine
  @interest = interest
  @overdue_limit = overdue_limit
  @tags = tags
  @descriptions = descriptions
  @discounts = discounts
  @fee = fee
  @line = line
  @bar_code = bar_code
  @status = status
  @created = StarkBank::Utils::Checks.check_datetime(created)
end

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def amount
  @amount
end

#bar_code ⇒ Object (readonly)

Returns the value of attribute bar_code.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def bar_code
  @bar_code
end

#city ⇒ Object (readonly)

Returns the value of attribute city.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def city
  @city
end

#created ⇒ Object (readonly)

Returns the value of attribute created.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def created
  @created
end

#descriptions ⇒ Object (readonly)

Returns the value of attribute descriptions.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def descriptions
  @descriptions
end

#discounts ⇒ Object (readonly)

Returns the value of attribute discounts.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def discounts
  @discounts
end

#district ⇒ Object (readonly)

Returns the value of attribute district.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def district
  @district
end

#due ⇒ Object (readonly)

Returns the value of attribute due.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def due
  @due
end

#fee ⇒ Object (readonly)

Returns the value of attribute fee.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def fee
  @fee
end

#fine ⇒ Object (readonly)

Returns the value of attribute fine.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def fine
  @fine
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def id
  @id
end

#interest ⇒ Object (readonly)

Returns the value of attribute interest.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def interest
  @interest
end

#line ⇒ Object (readonly)

Returns the value of attribute line.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def line
  @line
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def name
  @name
end

#overdue_limit ⇒ Object (readonly)

Returns the value of attribute overdue_limit.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def overdue_limit
  @overdue_limit
end

#state_code ⇒ Object (readonly)

Returns the value of attribute state_code.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def state_code
  @state_code
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def status
  @status
end

#street_line_1 ⇒ Object (readonly)

Returns the value of attribute street_line_1.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def street_line_1
  @street_line_1
end

#street_line_2 ⇒ Object (readonly)

Returns the value of attribute street_line_2.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def street_line_2
  @street_line_2
end

#tags ⇒ Object (readonly)

Returns the value of attribute tags.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def tags
  @tags
end

#tax_id ⇒ Object (readonly)

Returns the value of attribute tax_id.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def tax_id
  @tax_id
end

#zip_code ⇒ Object (readonly)

Returns the value of attribute zip_code.



42
43
44
 
# File 'lib/boleto/boleto.rb', line 42

def zip_code
  @zip_code
end

Class Method Details

.create(boletos, user: nil) ⇒ Object

# Create Boletos

Send a list of Boleto objects for creation in the Stark Bank API

## Parameters (required):

  • boletos [list of Boleto objects]: list of Boleto objects to be created in the API

## Parameters (optional):

  • user [Project object]: Project object. Not necessary if StarkBank.user was set before function call

## Return:

  • list of Boleto objects with updated attributes



84
85
86
 
# File 'lib/boleto/boleto.rb', line 84

def self.create(boletos, user: nil)
  StarkBank::Utils::Rest.post(entities: boletos, user: user, **resource)
end

.delete(id, user: nil) ⇒ Object

# Delete a Boleto entity

Delete a Boleto entity previously created in the Stark Bank API

## Parameters (required):

  • id [string]: Boleto unique id. ex: “5656565656565656”

## Parameters (optional):

  • user [Project object]: Project object. Not necessary if StarkBank.user was set before function call

## Return:

  • deleted Boleto with updated attributes



162
163
164
 
# File 'lib/boleto/boleto.rb', line 162

def self.delete(id, user: nil)
  StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
end

.get(id, user: nil) ⇒ Object

# Retrieve a specific Boleto

Receive a single Boleto object previously created in the Stark Bank API by passing its id

## Parameters (required):

  • id [string]: object unique id. ex: “5656565656565656”

## Parameters (optional):

  • user [Project object]: Project object. Not necessary if StarkBank.user was set before function call

## Return:

  • Boleto object with updated attributes



100
101
102
 
# File 'lib/boleto/boleto.rb', line 100

def self.get(id, user: nil)
  StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
end

.pdf(id, user: nil) ⇒ Object

# Retrieve a specific Boleto pdf file

Receive a single Boleto pdf file generated in the Stark Bank API by passing its id.

## Parameters (required):

  • id [string]: object unique id. ex: “5656565656565656”

## Parameters (optional):

  • user [Project object]: Project object. Not necessary if StarkBank.user was set before function call

## Return:

  • Boleto pdf file



116
117
118
 
# File 'lib/boleto/boleto.rb', line 116

def self.pdf(id, user: nil)
  StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
end

.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, user: nil) ⇒ Object

# Retrieve Boletos

Receive a generator of Boleto 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)

  • status [string, default nil]: filter for status of retrieved objects. ex: ‘paid’ or ‘registered’

  • 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’]

  • user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call

## Return:

  • generator of Boleto objects with updated attributes



135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/boleto/boleto.rb', line 135

def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, user: nil)
  after = StarkBank::Utils::Checks.check_date(after)
  before = StarkBank::Utils::Checks.check_date(before)
  StarkBank::Utils::Rest.get_list(
    limit: limit,
    after: after,
    before: before,
    status: status,
    tags: tags,
    ids: ids,
    user: user,
    **resource
  )
end

.resource ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/boleto/boleto.rb', line 166

def self.resource
  {
    resource_name: 'Boleto',
    resource_maker: proc { |json|
      Boleto.new(
        amount: json['amount'],
        name: json['name'],
        tax_id: json['tax_id'],
        street_line_1: json['street_line_1'],
        street_line_2: json['street_line_2'],
        district: json['district'],
        city: json['city'],
        state_code: json['state_code'],
        zip_code: json['zip_code'],
        due: json['due'],
        fine: json['fine'],
        interest: json['interest'],
        overdue_limit: json['overdue_limit'],
        tags: json['tags'],
        descriptions: json['descriptions'],
        discounts: json['discounts'],
        id: json['id'],
        fee: json['fee'],
        line: json['line'],
        bar_code: json['bar_code'],
        status: json['status'],
        created: json['created']
      )
    }
  }
end