Class: StarkBank::UtilityPayment

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

Overview

# UtilityPayment object

When you initialize a UtilityPayment, the entity will not be automatically created in the Stark Bank API. The ‘create’ function sends the objects to the Stark Bank API and returns the list of created objects.

## Parameters (conditionally required):

  • line [string, default nil]: Number sequence that describes the payment. Either ‘line’ or ‘bar_code’ parameters are required. If both are sent, they must match. ex: ‘34191.09008 63571.277308 71444.640008 5 81960000000062’

  • bar_code [string, default nil]: Bar code number that describes the payment. Either ‘line’ or ‘barCode’ parameters are required. If both are sent, they must match. ex: ‘34195819600000000621090063571277307144464000’

## Parameters (required):

  • description [string]: Text to be displayed in your statement (min. 10 characters). ex: ‘payment ABC’

## Parameters (optional):

  • scheduled [Date, DateTime, Time or string, default today]: payment scheduled date. ex: Date.new(2020, 3, 10)

  • tags [list of strings]: list of strings for tagging

## Attributes (return-only):

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

  • status [string]: current payment status. ex: ‘success’ or ‘failed’

  • amount [int]: amount automatically calculated from line or bar_code. ex: 23456 (= R$ 234.56)

  • fee [integer]: fee charged when utility payment is created. ex: 200 (= R$ 2.00)

  • type [string]: payment type. ex: “utility”

  • transaction_ids [list of strings]: ledger transaction ids linked to this UtilityPayment. ex: [“19827356981273”]

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

  • updated [DateTime]: latest update datetime for the payment. 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(description:, line: nil, bar_code: nil, tags: nil, scheduled: nil, id: nil, amount: nil, fee: nil, type: nil, transaction_ids: nil, status: nil, created: nil, updated: nil) ⇒ UtilityPayment

Returns a new instance of UtilityPayment.



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

def initialize(description:, line: nil, bar_code: nil, tags: nil, scheduled: nil, id: nil, amount: nil, fee: nil, type: nil, transaction_ids: nil, status: nil, created: nil, updated: nil)
  super(id)
  @description = description
  @line = line
  @bar_code = bar_code
  @tags = tags
  @scheduled = StarkCore::Utils::Checks.check_date(scheduled)
  @amount = amount
  @fee = fee
  @status = status
  @type = type
  @transaction_ids = transaction_ids
  @created = StarkCore::Utils::Checks.check_datetime(created)
  @updated = StarkCore::Utils::Checks.check_datetime(updated)
end

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



35
36
37
 
# File 'lib/utility_payment/utility_payment.rb', line 35

def amount
  @amount
end

#bar_code ⇒ Object (readonly)

Returns the value of attribute bar_code.



35
36
37
 
# File 'lib/utility_payment/utility_payment.rb', line 35

def bar_code
  @bar_code
end

#created ⇒ Object (readonly)

Returns the value of attribute created.



35
36
37
 
# File 'lib/utility_payment/utility_payment.rb', line 35

def created
  @created
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



35
36
37
 
# File 'lib/utility_payment/utility_payment.rb', line 35

def description
  @description
end

#fee ⇒ Object (readonly)

Returns the value of attribute fee.



35
36
37
 
# File 'lib/utility_payment/utility_payment.rb', line 35

def fee
  @fee
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



35
36
37
 
# File 'lib/utility_payment/utility_payment.rb', line 35

def id
  @id
end

#line ⇒ Object (readonly)

Returns the value of attribute line.



35
36
37
 
# File 'lib/utility_payment/utility_payment.rb', line 35

def line
  @line
end

#scheduled ⇒ Object (readonly)

Returns the value of attribute scheduled.



35
36
37
 
# File 'lib/utility_payment/utility_payment.rb', line 35

def scheduled
  @scheduled
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



35
36
37
 
# File 'lib/utility_payment/utility_payment.rb', line 35

def status
  @status
end

#tags ⇒ Object (readonly)

Returns the value of attribute tags.



35
36
37
 
# File 'lib/utility_payment/utility_payment.rb', line 35

def tags
  @tags
end

#transaction_ids ⇒ Object (readonly)

Returns the value of attribute transaction_ids.



35
36
37
 
# File 'lib/utility_payment/utility_payment.rb', line 35

def transaction_ids
  @transaction_ids
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



35
36
37
 
# File 'lib/utility_payment/utility_payment.rb', line 35

def type
  @type
end

#updated ⇒ Object (readonly)

Returns the value of attribute updated.



35
36
37
 
# File 'lib/utility_payment/utility_payment.rb', line 35

def updated
  @updated
end

Class Method Details

.create(payments, user: nil) ⇒ Object

# Create UtilityPayments

Send a list of UtilityPayment objects for creation in the Stark Bank API

## Parameters (required):

  • payments [list of UtilityPayment objects]: list of UtilityPayment objects to be created in the API

## Parameters (optional):

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

## Return:

  • list of UtilityPayment objects with updated attributes



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

def self.create(payments, user: nil)
  StarkBank::Utils::Rest.post(entities: payments, user: user, **resource)
end

.delete(id, user: nil) ⇒ Object

# Delete a UtilityPayment entity

Delete a UtilityPayment entity previously created in the Stark Bank API

## Parameters (required):

  • id [string]: UtilityPayment 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:

  • deleted UtilityPayment object



176
177
178
 
# File 'lib/utility_payment/utility_payment.rb', line 176

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

.get(id, user: nil) ⇒ Object

# Retrieve a specific UtilityPayment

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

  • UtilityPayment object with updated attributes



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

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, tags: nil, ids: nil, status: nil, user: nil) ⇒ Object

# Retrieve paged UtilityPayments

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

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

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

  • status [string, default nil]: filter for status of retrieved objects. ex: ‘paid’

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

## Return:

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/utility_payment/utility_payment.rb', line 148

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

.pdf(id, user: nil) ⇒ Object

# Retrieve a specific UtilityPayment pdf file

Receive a single UtilityPayment pdf file generated in the Stark Bank API by passing its id. Only valid for utility payments with ‘success’ status.

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

  • UtilityPayment pdf file



97
98
99
 
# File 'lib/utility_payment/utility_payment.rb', line 97

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, tags: nil, ids: nil, status: nil, user: nil) ⇒ Object

# Retrieve UtilityPayments

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

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

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

  • status [string, default nil]: filter for status of retrieved objects. ex: ‘paid’

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

## Return:

  • generator of UtilityPayment objects with updated attributes



116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/utility_payment/utility_payment.rb', line 116

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

.resource ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/utility_payment/utility_payment.rb', line 180

def self.resource
  {
    resource_name: 'UtilityPayment',
    resource_maker: proc { |json|
      UtilityPayment.new(
        id: json['id'],
        description: json['description'],
        line: json['line'],
        bar_code: json['bar_code'],
        tags: json['tags'],
        scheduled: json['scheduled'],
        amount: json['amount'],
        fee: json['fee'],
        type: json['type'],
        transaction_ids: json['transaction_ids'],
        status: json['status'],
        created: json['created'],
        updated: json['updated']
      )
    }
  }
end