Class: StarkInfra::PixClaim::Log

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

Overview

# PixClaim::Log object

Every time a PixClaim entity is modified, a corresponding PixClaim::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’

  • claim [PixClaim]: PixClaim entity to which the log refers to.

  • type [string]: type of the PixClaim event which triggered the log creation. Options: ‘created’, ‘failed’, ‘delivering’, ‘delivered’, ‘confirming’, ‘confirmed’, ‘success’, ‘canceling’, ‘canceled’.

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

  • reason [string]: reason why the PixClaim was modified, resulting in the Log. Options: ‘fraud’, ‘userRequested’, ‘accountClosure’, ‘defaultOperation’, ‘reconciliation’

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

Returns a new instance of Log.



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

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

Instance Attribute Details

#claim ⇒ Object (readonly)

Returns the value of attribute claim.



23
24
25
 
# File 'lib/pixclaim/log.rb', line 23

def claim
  @claim
end

#created ⇒ Object (readonly)

Returns the value of attribute created.



23
24
25
 
# File 'lib/pixclaim/log.rb', line 23

def created
  @created
end

#errors ⇒ Object (readonly)

Returns the value of attribute errors.



23
24
25
 
# File 'lib/pixclaim/log.rb', line 23

def errors
  @errors
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



23
24
25
 
# File 'lib/pixclaim/log.rb', line 23

def id
  @id
end

#reason ⇒ Object (readonly)

Returns the value of attribute reason.



23
24
25
 
# File 'lib/pixclaim/log.rb', line 23

def reason
  @reason
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



23
24
25
 
# File 'lib/pixclaim/log.rb', line 23

def type
  @type
end

Class Method Details

.get(id, user: nil) ⇒ Object

# Retrieve a specific PixClaim::Log

Receive a single PixClaim::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:

  • PixClaim::Log object with updated attributes



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

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

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

# Retrieve paged PixClaim::Logs

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

## 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 PixClaim Logs by their types. Options: ‘created’, ‘failed’, ‘delivering’, ‘delivered’, ‘confirming’, ‘confirmed’, ‘success’, ‘canceling’, ‘canceled’.

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

  • ids [list of strings, default nil]: Log ids to filter PixClaim Logs. ex: [‘5656565656565656’]

  • 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



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

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

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

# Retrieve PixClaim::Logs

Receive a generator of PixClaim::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 PixClaim Logs by their types. Options: ‘created’, ‘failed’, ‘delivering’, ‘delivered’, ‘confirming’, ‘confirmed’, ‘success’, ‘canceling’, ‘canceled’.

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

  • ids [list of strings, default nil]: Log ids to filter PixClaim Logs. ex: [‘5656565656565656’]

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

## Return:

  • generator of PixClaim::Log objects with updated attributes



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

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

.resource ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/pixclaim/log.rb', line 113

def self.resource
  claim_maker = StarkInfra::PixClaim.resource[:resource_maker]
  {
    resource_name: 'PixClaimLog',
    resource_maker: proc { |json|
      Log.new(
        id: json['id'],
        created: json['created'],
        type: json['type'],
        errors: json['errors'],
        reason: json['reason'],
        claim: StarkCore::Utils::API.from_api_json(claim_maker, json['claim'])
      )
    }
  }
end