class StarkBank::BoletoPayment

# BoletoPayment object

When you initialize a BoletoPayment, 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):

## Parameters (required):

## Parameters (optional):

## Attributes (return-only):

Attributes

amount[R]
bar_code[R]
created[R]
description[R]
fee[R]
id[R]
line[R]
scheduled[R]
status[R]
tags[R]
tax_id[R]

Public Class Methods

create(payments, user: nil) click to toggle source

# Create BoletoPayments

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

## Parameters (required):

## Parameters (optional):

## Return:

# File lib/boleto_payment/boleto_payment.rb, line 60
def self.create(payments, user: nil)
  StarkBank::Utils::Rest.post(entities: payments, user: user, **resource)
end
delete(id, user: nil) click to toggle source

# Delete a BoletoPayment entity

Delete a BoletoPayment entity previously created in the Stark Bank API

Parameters (required):

Parameters (optional):

Return:

# File lib/boleto_payment/boleto_payment.rb, line 170
def self.delete(id, user: nil)
  StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
end
get(id, user: nil) click to toggle source

# Retrieve a specific BoletoPayment

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

## Parameters (required):

  • id [string]: object unique id. ex: '5656565656565656'

## Parameters (optional):

## Return:

# File lib/boleto_payment/boleto_payment.rb, line 76
def self.get(id, user: nil)
  StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
end
new(tax_id:, description:, line: nil, bar_code: nil, scheduled: nil, tags: nil, id: nil, status: nil, amount: nil, fee: nil, created: nil) click to toggle source
Calls superclass method StarkBank::Utils::Resource::new
# File lib/boleto_payment/boleto_payment.rb, line 34
def initialize(tax_id:, description:, line: nil, bar_code: nil, scheduled: nil, tags: nil, id: nil, status: nil, amount: nil, fee: nil, created: nil)
  super(id)
  @tax_id = tax_id
  @description = description
  @line = line
  @bar_code = bar_code
  @scheduled = StarkBank::Utils::Checks.check_date(scheduled)
  @tags = tags
  @status = status
  @amount = amount
  @fee = fee
  @created = StarkBank::Utils::Checks.check_datetime(created)
end
page(cursor: nil, limit: nil, after: nil, before: nil, tags: nil, ids: nil, status: nil, user: nil) click to toggle source

# Retrieve paged BoletoPayments

Receive a list of up to 100 BoletoPayment 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 strings to get specific entities by ids. ex: ['12376517623', '1928367198236']

  • status [string, default nil]: filter for status of retrieved objects. ex: 'paid'

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

## Return:

# File lib/boleto_payment/boleto_payment.rb, line 144
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,
    user: user,
    limit: limit,
    after: after,
    before: before,
    tags: tags,
    ids: ids,
    status: status,
    **resource
  )
end
pdf(id, user: nil) click to toggle source

# Retrieve a specific BoletoPayment pdf file

Receive a single BoletoPayment pdf file generated in the Stark Bank API by passing its id. Only valid for boleto payments with 'success' status.

## Parameters (required):

  • id [string]: object unique id. ex: '5656565656565656'

## Parameters (optional):

## Return:

# File lib/boleto_payment/boleto_payment.rb, line 93
def self.pdf(id, user: nil)
  StarkBank::Utils::Rest.get_content(id: id, user: user, sub_resource_name: 'pdf', **resource)
end
query(limit: nil, after: nil, before: nil, tags: nil, ids: nil, status: nil, user: nil) click to toggle source

# Retrieve BoletoPayments

Receive a generator of BoletoPayment 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 strings to get specific entities by ids. ex: ['12376517623', '1928367198236']

  • status [string, default nil]: filter for status of retrieved objects. ex: 'paid'

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

## Return:

# File lib/boleto_payment/boleto_payment.rb, line 112
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(
    user: user,
    limit: limit,
    after: after,
    before: before,
    tags: tags,
    ids: ids,
    status: status,
    **resource
  )
end
resource() click to toggle source
# File lib/boleto_payment/boleto_payment.rb, line 174
def self.resource
  {
    resource_name: 'BoletoPayment',
    resource_maker: proc { |json|
      BoletoPayment.new(
        id: json['id'],
        tax_id: json['tax_id'],
        description: json['description'],
        line: json['line'],
        bar_code: json['bar_code'],
        scheduled: json['scheduled'],
        tags: json['tags'],
        status: json['status'],
        amount: json['amount'],
        fee: json['fee'],
        created: json['created']
      )
    }
  }
end