Class: StarkInfra::IssuingInvoice

Inherits:
StarkCore::Utils::Resource
  • Object
show all
Defined in:
lib/issuing_invoice/issuing_invoice.rb,
lib/issuing_invoice/log.rb

Overview

# IssuingInvoice object

The IssuingInvoice objects created in your Workspace load your Issuing balance when paid.

When you initialize a IssuingInvoice, the entity will not be automatically created in the Stark Infra API. The ‘create’ function sends the objects to the Stark Infra API and returns the created object.

## Parameters (required):

  • amount [integer]: IssuingInvoice value in cents. ex: 1234 (= R$ 12.34)

## Parameters (optional):

  • tax_id [string, default sub-issuer tax ID]: payer tax ID (CPF or CNPJ) with or without formatting. ex: ‘01234567890’ or ‘20.018.183/0001-80’

  • name [string, default sub-issuer name]: payer name. ex: ‘Iron Bank S.A.’

  • tags [list of strings, default nil]: list of strings for tagging. ex: [‘travel’, ‘food’]

## Attributes (return-only):

  • id [string]: unique id returned when IssuingInvoice is created. ex: ‘5656565656565656’

  • brcode [string]: BR Code for the Invoice payment. ex: ‘00020101021226930014br.gov.bcb.pix2571brcode-h.development.starkinfra.com/v2/d7f6546e194d4c64a153e8f79f1c41ac5204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63042109’

  • due [DateTime, Date or string]: Invoice due and expiration date in UTC ISO format. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0), Date.new(2020, 3, 10) or ‘2020-03-10T10:30:00.000000+00:00’

  • link [string]: public Invoice webpage URL. ex: ‘starkbank-card-issuer.development.starkbank.com/invoicelink/d7f6546e194d4c64a153e8f79f1c41ac’

  • status [string]: current IssuingInvoice status. ex: ‘created’, ‘expired’, ‘overdue’, ‘paid’

  • issuing_transaction_id [string]: ledger transaction ids linked to this IssuingInvoice. ex: ‘issuing-invoice/5656565656565656’

  • updated [DateTime]: latest update datetime for the IssuingInvoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)

  • created [DateTime]: creation datetime for the IssuingInvoice. 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

Constructor Details

#initialize(amount:, id: nil, tax_id: nil, name: nil, tags: nil, brcode: nil, due: nil, link: nil, status: nil, issuing_transaction_id: nil, updated: nil, created: nil) ⇒ IssuingInvoice

Returns a new instance of IssuingInvoice.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 34

def initialize(
  amount:, id: nil, tax_id: nil, name: nil, tags: nil, brcode: nil, due: nil, link: nil, status: nil, issuing_transaction_id: nil,
  updated: nil, created: nil
)
  super(id)
  @amount = amount
  @tax_id = tax_id
  @name = name
  @tags = tags
  @brcode = brcode
  @due = due
  @link = link
  @status = status
  @issuing_transaction_id = issuing_transaction_id
  @updated = StarkCore::Utils::Checks.check_datetime(updated)
  @created = StarkCore::Utils::Checks.check_datetime(created)
end

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



33
34
35
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 33

def amount
  @amount
end

#brcode ⇒ Object (readonly)

Returns the value of attribute brcode.



33
34
35
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 33

def brcode
  @brcode
end

#created ⇒ Object (readonly)

Returns the value of attribute created.



33
34
35
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 33

def created
  @created
end

#due ⇒ Object (readonly)

Returns the value of attribute due.



33
34
35
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 33

def due
  @due
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



33
34
35
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 33

def id
  @id
end

#issuing_transaction_id ⇒ Object (readonly)

Returns the value of attribute issuing_transaction_id.



33
34
35
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 33

def issuing_transaction_id
  @issuing_transaction_id
end

#link ⇒ Object (readonly)

Returns the value of attribute link.



33
34
35
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 33

def link
  @link
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



33
34
35
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 33

def name
  @name
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



33
34
35
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 33

def status
  @status
end

#tags ⇒ Object (readonly)

Returns the value of attribute tags.



33
34
35
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 33

def tags
  @tags
end

#tax_id ⇒ Object (readonly)

Returns the value of attribute tax_id.



33
34
35
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 33

def tax_id
  @tax_id
end

#updated ⇒ Object (readonly)

Returns the value of attribute updated.



33
34
35
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 33

def updated
  @updated
end

Class Method Details

.create(invoice, user: nil) ⇒ Object

# Create an IssuingInvoice

Send a single IssuingInvoice object for creation in the Stark Infra API

## Parameters (required):

  • invoice [IssuingInvoice object]: IssuingInvoice object to be created in the API.

## Parameters (optional):

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • IssuingInvoice object with updated attributes



64
65
66
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 64

def self.create(invoice, user: nil)
  StarkInfra::Utils::Rest.post_single(entity: invoice, user: user, **resource)
end

.get(id, user: nil) ⇒ Object

# Retrieve a specific IssuingInvoice

Receive a single IssuingInvoice object previously created in the Stark Infra API by its id

## Parameters (required):

  • id [string]: object unique id. ex: ‘5656565656565656’

## Parameters (optional):

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • IssuingInvoice object with updated attributes



80
81
82
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 80

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

.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, user: nil) ⇒ Object

# Retrieve paged IssuingInvoices

Receive a list of up to 100 IssuingInvoices objects previously created in the Stark Infra API and the cursor to the next page. Use this function instead of query if you want to manually page your logs.

## Parameters (optional):

  • cursor [string, default nil]: cursor returned on the previous page function call.

  • limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35

  • after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)

  • before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)

  • status [list of strings, default nil]: filter for status of retrieved objects. ex: [‘created’, ‘expired’, ‘overdue’, ‘paid’]

  • tags [list of strings, default nil]: tags to filter retrieved objects. ex: [‘tony’, ‘stark’]

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call

## Return:

  • list of IssuingInvoice objects with updated attributes

  • cursor to retrieve the next page of IssuingInvoice objects



129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 129

def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, user: nil)
  after = StarkCore::Utils::Checks.check_date(after)
  before = StarkCore::Utils::Checks.check_date(before)
  StarkInfra::Utils::Rest.get_page(
    cursor: cursor,
    limit: limit,
    after: after,
    before: before,
    status: status,
    tags: tags,
    user: user,
    **resource
  )
end

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

# Retrieve IssuingInvoices

Receive a generator of IssuingInvoices objects previously created in the Stark Infra API

## Parameters (optional):

  • limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35

  • after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)

  • before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)

  • status [list of strings, default nil]: filter for status of retrieved objects. ex: [‘created’, ‘expired’, ‘overdue’, ‘paid’]

  • tags [list of strings, default nil]: tags to filter retrieved objects. ex: [‘tony’, ‘stark’]

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call

## Return:

  • generator of IssuingInvoices objects with updated attributes



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 98

def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, user: nil)
  after = StarkCore::Utils::Checks.check_date(after)
  before = StarkCore::Utils::Checks.check_date(before)
  StarkInfra::Utils::Rest.get_stream(
    limit: limit,
    after: after,
    before: before,
    status: status,
    tags: tags,
    user: user,
    **resource
  )
end

.resource ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/issuing_invoice/issuing_invoice.rb', line 144

def self.resource
  {
    resource_name: 'IssuingInvoice',
    resource_maker: proc { |json|
      IssuingInvoice.new(
        id: json['id'],
        amount: json['amount'],
        tax_id: json['tax_id'],
        name: json['name'],
        tags: json['tags'],
        brcode: json['brcode'],
        due: json['due'],
        link: json['link'],
        status: json['status'],
        issuing_transaction_id: json['issuing_transaction_id'],
        updated: json['updated'],
        created: json['created']
      )
    }
  }
end