Class: StarkInfra::CreditNote::Log

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

Overview

# CreditNote::Log object

Every time a CreditNote entity is modified, a corresponding CreditNote::Log is generated for the entity. This log is never generated by the user.

## Attributes (return-only):

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

  • note [CreditNote]: CreditNote entity to which the log refers to.

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

  • type [string]: type of the CreditNote event which triggered the log creation. Options: ‘canceled’, ‘created’, ‘expired’, ‘failed’, ‘refunded’, ‘registered’, ‘sending’, ‘sent’, ‘signed’, ‘success’

  • 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

Constructor Details

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

Returns a new instance of Log.



23
24
25
26
27
28
29
 
# File 'lib/credit_note/log.rb', line 23

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

Instance Attribute Details

#created ⇒ Object (readonly)

Returns the value of attribute created.



22
23
24
 
# File 'lib/credit_note/log.rb', line 22

def created
  @created
end

#errors ⇒ Object (readonly)

Returns the value of attribute errors.



22
23
24
 
# File 'lib/credit_note/log.rb', line 22

def errors
  @errors
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



22
23
24
 
# File 'lib/credit_note/log.rb', line 22

def id
  @id
end

#note ⇒ Object (readonly)

Returns the value of attribute note.



22
23
24
 
# File 'lib/credit_note/log.rb', line 22

def note
  @note
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



22
23
24
 
# File 'lib/credit_note/log.rb', line 22

def type
  @type
end

Class Method Details

.get(id, user: nil) ⇒ Object

# Retrieve a specific CreditNote::Log

Receive a single CreditNote::Log object previously created by the Stark Infra API by passing 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:

  • Log object with updated attributes



43
44
45
 
# File 'lib/credit_note/log.rb', line 43

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

# Retrieve paged CreditNote::Logs

Receive a list of up to 100 CreditNote::Log 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 notes.

## 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)

  • types [list of strings, default nil]: filter retrieved objects by types. Options: ‘canceled’, ‘created’, ‘expired’, ‘failed’, ‘refunded’, ‘registered’, ‘sending’, ‘sent’, ‘signed’, ‘success’

  • note_ids [list of strings, default nil]: list of CreditNote ids to filter retrieved objects. ex: [‘5656565656565656’, ‘4545454545454545’]

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

## Return:

  • list of Log objects with updated attributes

  • Cursor to retrieve the next page of Log objects



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

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

.query(limit: nil, after: nil, before: nil, types: nil, note_ids: nil, user: nil) ⇒ Object

# Retrieve CreditNote::Logs

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

  • types [list of strings, default nil]: filter retrieved objects by types. Options: ‘canceled’, ‘created’, ‘expired’, ‘failed’, ‘refunded’, ‘registered’, ‘sending’, ‘sent’, ‘signed’, ‘success’

  • note_ids [list of strings, default nil]: list of CreditNote ids to filter retrieved objects. ex: [‘5656565656565656’, ‘4545454545454545’]

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

## Return:

  • list of Log objects with updated attributes



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/credit_note/log.rb', line 61

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

.resource ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/credit_note/log.rb', line 107

def self.resource
  note_maker = StarkInfra::CreditNote.resource[:resource_maker]
  {
    resource_name: 'CreditNoteLog',
    resource_maker: proc { |json|
      Log.new(
        id: json['id'],
        note: StarkCore::Utils::API.from_api_json(note_maker, json['note']),
        errors: json['errors'],
        type: json['type'],
        created: json['created']
      )
    }
  }
end