Class: StarkBank::CorporateHolder::Log

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

Overview

# CorporateHolder::Log object

Every time a CorporateHolder entity is updated, a corresponding CorporateHolder::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 CorporateHolder.

## Attributes (return-only):

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

  • holder [CorporateHolder]: CorporateHolder entity to which the log refers to.

  • type [string]: type of the CorporateHolder event which triggered the log creation. ex: ‘blocked’, ‘canceled’, ‘created’, ‘unblocked’, ‘updated’

  • 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:, holder:) ⇒ Log

Returns a new instance of Log.



21
22
23
24
25
26
 
# File 'lib/corporate_holder/log.rb', line 21

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

Instance Attribute Details

#created ⇒ Object (readonly)

Returns the value of attribute created.



20
21
22
 
# File 'lib/corporate_holder/log.rb', line 20

def created
  @created
end

#holder ⇒ Object (readonly)

Returns the value of attribute holder.



20
21
22
 
# File 'lib/corporate_holder/log.rb', line 20

def holder
  @holder
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



20
21
22
 
# File 'lib/corporate_holder/log.rb', line 20

def id
  @id
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



20
21
22
 
# File 'lib/corporate_holder/log.rb', line 20

def type
  @type
end

Class Method Details

.get(id, user: nil) ⇒ Object

# Retrieve a specific CorporateHolder::Log

Receive a single CorporateHolder::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, default nil]: Organization or Project object. Not necessary if StarkBank.user was set before function call

## Return:

  • CorporateHolder::Log object with updated attributes



40
41
42
 
# File 'lib/corporate_holder/log.rb', line 40

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

# Retrieve paged CorporateHolder::Logs

Receive a list of up to 100 CorporateHolder::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 holders.

## 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 for log event types. ex: [‘created’, ‘blocked’]

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

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

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

## Return:

  • list of CorporateHolder::Log objects with updated attributes

  • cursor to retrieve the next page of Log objects



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

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

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

# Retrieve CorporateHolder::Logs

Receive a generator of CorporateHolder::Log objects previously created in the Stark Bank API

## Parameters (optional):

  • limit [integer, default nil]: 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 for log event types. ex: [‘created’, ‘blocked’]

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

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

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

## Return:

  • generator of CorporateHolder::Log objects with updated attributes



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/corporate_holder/log.rb', line 59

def self.query(limit: nil, after: nil, before: nil, types: nil, holder_ids: nil, user: nil)
  after = StarkCore::Utils::Checks.check_date(after)
  before = StarkCore::Utils::Checks.check_date(before)
  StarkBank::Utils::Rest.get_stream(
    limit: limit,
    after: after,
    before: before,
    types: types,
    holder_ids: holder_ids,
    user: user,
    **resource
  )
end

.resource ⇒ Object 



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

def self.resource
  request_maker = StarkBank::CorporateHolder.resource[:resource_maker]
  {
    resource_name: 'CorporateHolderLog',
    resource_maker: proc { |json|
      Log.new(
        id: json['id'],
        created: json['created'],
        type: json['type'],
        holder: StarkCore::Utils::API.from_api_json(request_maker, json['holder'])
      )
    }
  }
end