Class: StarkBank::Invoice::Log

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

Overview

# Invoice::Log object

Every time an Invoice entity is updated, a corresponding Invoice::Log is generated for the entity. This log is never generated by the user, but it can be retrieved to check additional information on the Invoice.

## Attributes:

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

  • invoice [Invoice]: Invoice entity to which the log refers to.

  • errors [list of strings]: list of errors linked to this Invoice event

  • type [string]: type of the Invoice event which triggered the log creation. ex: ‘canceled’ or ‘paid’

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Utils::SubResource

#inspect, #to_s

Constructor Details

#initialize(id:, created:, type:, errors:, invoice:) ⇒ Log

Returns a new instance of Log.



25
26
27
28
29
30
31
 
# File 'lib/invoice/log.rb', line 25

def initialize(id:, created:, type:, errors:, invoice:)
  super(id)
  @type = type
  @errors = errors
  @invoice = invoice
  @created = StarkBank::Utils::Checks.check_datetime(created)
end

Instance Attribute Details

#created ⇒ Object (readonly)

Returns the value of attribute created.



24
25
26
 
# File 'lib/invoice/log.rb', line 24

def created
  @created
end

#errors ⇒ Object (readonly)

Returns the value of attribute errors.



24
25
26
 
# File 'lib/invoice/log.rb', line 24

def errors
  @errors
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



24
25
26
 
# File 'lib/invoice/log.rb', line 24

def id
  @id
end

#invoice ⇒ Object (readonly)

Returns the value of attribute invoice.



24
25
26
 
# File 'lib/invoice/log.rb', line 24

def invoice
  @invoice
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



24
25
26
 
# File 'lib/invoice/log.rb', line 24

def type
  @type
end

Class Method Details

.get(id, user: nil) ⇒ Object

# Retrieve a specific Log

Receive a single Log 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 or Project object. Not necessary if StarkBank.user was set before function call

## Return:

  • Log object with updated attributes



45
46
47
 
# File 'lib/invoice/log.rb', line 45

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

.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, invoice_ids: nil, user: nil) ⇒ Object

# Retrieve paged Logs

Receive a list of up to 100 Log 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)

  • types [list of strings, default nil]: filter for log event types. ex: ‘paid’ or ‘registered’

  • boleto_ids [list of strings, default nil]: list of Boleto ids to filter logs. ex: [‘5656565656565656’, ‘4545454545454545’]

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

## Return:

  • list of Log objects with updated attributes and cursor to retrieve the next page of Log objects



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/invoice/log.rb', line 93

def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, invoice_ids: 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,
    types: types,
    invoice_ids: invoice_ids,
    user: user,
    **resource
  )
end

.pdf(id, user: nil) ⇒ Object

# Retrieve a specific Invoice::Log pdf file

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

## Parameters (required):

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

## Parameters (optional):

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

## Return:

  • Invoice::Log pdf file



120
121
122
 
# File 'lib/invoice/log.rb', line 120

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, types: nil, invoice_ids: nil, user: nil) ⇒ Object

# Retrieve Logs

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

  • types [list of strings, default nil]: filter for log event types. ex: ‘paid’ or ‘canceled’

  • invoice_ids [list of strings, default nil]: list of Invoice ids to filter logs. ex: [‘5656565656565656’, ‘4545454545454545’]

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

## Return:

  • list of Log objects with updated attributes



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/invoice/log.rb', line 63

def self.query(limit: nil, after: nil, before: nil, types: nil, invoice_ids: 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,
    types: types,
    invoice_ids: invoice_ids,
    user: user,
    **resource
  )
end

.resource ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/invoice/log.rb', line 124

def self.resource
  invoice_maker = StarkBank::Invoice.resource[:resource_maker]
  {
    resource_name: 'InvoiceLog',
    resource_maker: proc { |json|
      Log.new(
        id: json['id'],
        created: json['created'],
        type: json['type'],
        errors: json['errors'],
        invoice: StarkBank::Utils::API.from_api_json(invoice_maker, json['invoice'])
      )
    }
  }
end