starkbank 0.4.2 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: dc0ef90a981378566198155d680a105ea7984c30c3b8ccb738af68bdeb4facb2
4
- data.tar.gz: f9108a3e66d17bf8a639b76b92cc7bcdd14bfa4343f97c490c8dc83a05b3db77
3
+ metadata.gz: '0509d964f6d6ff483444229021b1ac146d3c27ca7930e1d906fc51ba7ef49541'
4
+ data.tar.gz: f0a14115c5b83db21dffcc339df07038c6ef21234547602e44e825d9c4b6aea4
5
5
  SHA512:
6
- metadata.gz: 11c46f92372727cfbed6afe6f5c72204f470cbda209db011ea354b554319644dc2e3c6a5f9c77aefee0cd155d4571ac4b06db0bec6e4b31dbee8bd59725ee1fe
7
- data.tar.gz: 56a3d5bc265aa1c1a0f7395deab9ad4837391016e227784e1fae81bd5878f0a4a08755bf14c15089cb0b04a9a178747ade0bc6b51f7f3a5f09d9cb46ee567d36
6
+ metadata.gz: d74d8dbc64191c7ad538b0d7529372860cc23cf8b429158d130911dd2e7a568207ccd635c929b0fe106805036110e72e16567686cb4a161c250fcde4d7cf0811
7
+ data.tar.gz: e7737c06154ce9430e4345682fdc7efbffc297e95aa18f6ca6583512a5183dbbbb6ee054a3e1c7a3c3d9834d6fe1efbb3ced9a40c7fdb1dde943cc0422ac5384
@@ -164,7 +164,7 @@ module StarkBank
164
164
  # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
165
165
  #
166
166
  # ## Return:
167
- # - deleted Boleto with updated attributes
167
+ # - deleted Boleto object
168
168
  def self.delete(id, user: nil)
169
169
  StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
170
170
  end
@@ -133,7 +133,7 @@ module StarkBank
133
133
  # Parameters (optional):
134
134
  # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
135
135
  # Return:
136
- # - deleted BoletoPayment with updated attributes
136
+ # - deleted BoletoPayment object
137
137
  def self.delete(id, user: nil)
138
138
  StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
139
139
  end
@@ -97,7 +97,7 @@ module StarkBank
97
97
  # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
98
98
  #
99
99
  # ## Return:
100
- # - deleted Event with updated attributes
100
+ # - deleted Event object
101
101
  def self.delete(id, user: nil)
102
102
  StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
103
103
  end
@@ -87,15 +87,16 @@ module StarkBank
87
87
  # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
88
88
  # - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
89
89
  # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
90
+ # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
90
91
  # - external_ids [list of strings, default nil]: list of external ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
91
92
  # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
92
93
  #
93
94
  # ## Return:
94
95
  # - generator of Transaction objects with updated attributes
95
- def self.query(limit: nil, after: nil, before: nil, external_ids: nil, user: nil)
96
+ def self.query(limit: nil, after: nil, before: nil, tags: nil, external_ids: nil, user: nil)
96
97
  after = StarkBank::Utils::Checks.check_date(after)
97
98
  before = StarkBank::Utils::Checks.check_date(before)
98
- StarkBank::Utils::Rest.get_list(user: user, limit: limit, after: after, before: before, external_ids: external_ids, **resource)
99
+ StarkBank::Utils::Rest.get_list(user: user, limit: limit, after: after, before: before, tags: tags, external_ids: external_ids, **resource)
99
100
  end
100
101
 
101
102
  def self.resource
@@ -21,6 +21,7 @@ module StarkBank
21
21
  #
22
22
  # ## Parameters (optional):
23
23
  # - tags [list of strings]: list of strings for reference when searching for transfers. ex: ['employees', 'monthly']
24
+ # - scheduled [string, default now]: datetime when the transfer will be processed. May be pushed to next business day if necessary. ex: DateTime.new(2020, 3, 11, 8, 0, 0, 0)
24
25
  #
25
26
  # ## Attributes (return-only):
26
27
  # - id [string, default nil]: unique id returned when Transfer is created. ex: '5656565656565656'
@@ -30,8 +31,8 @@ module StarkBank
30
31
  # - created [DateTime, default nil]: creation datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
31
32
  # - updated [DateTime, default nil]: latest update datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
32
33
  class Transfer < StarkBank::Utils::Resource
33
- attr_reader :amount, :name, :tax_id, :bank_code, :branch_code, :account_number, :transaction_ids, :fee, :tags, :status, :id, :created, :updated
34
- def initialize(amount:, name:, tax_id:, bank_code:, branch_code:, account_number:, transaction_ids: nil, fee: nil, tags: nil, status: nil, id: nil, created: nil, updated: nil)
34
+ attr_reader :amount, :name, :tax_id, :bank_code, :branch_code, :account_number, :scheduled, :transaction_ids, :fee, :tags, :status, :id, :created, :updated
35
+ def initialize(amount:, name:, tax_id:, bank_code:, branch_code:, account_number:, scheduled: nil, transaction_ids: nil, fee: nil, tags: nil, status: nil, id: nil, created: nil, updated: nil)
35
36
  super(id)
36
37
  @amount = amount
37
38
  @name = name
@@ -39,6 +40,7 @@ module StarkBank
39
40
  @bank_code = bank_code
40
41
  @branch_code = branch_code
41
42
  @account_number = account_number
43
+ @scheduled = StarkBank::Utils::Checks.check_datetime(scheduled)
42
44
  @transaction_ids = transaction_ids
43
45
  @fee = fee
44
46
  @tags = tags
@@ -79,6 +81,22 @@ module StarkBank
79
81
  StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
80
82
  end
81
83
 
84
+ # # Delete a Transfer entity
85
+ #
86
+ # Delete a Transfer entity previously created in the Stark Bank API
87
+ #
88
+ # ## Parameters (required):
89
+ # - id [string]: Transfer unique id. ex: '5656565656565656'
90
+ #
91
+ # ## Parameters (optional):
92
+ # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
93
+ #
94
+ # ## Return:
95
+ # - deleted Transfer object
96
+ def self.delete(id, user: nil)
97
+ StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
98
+ end
99
+
82
100
  # # Retrieve a specific Transfer pdf file
83
101
  #
84
102
  # Receive a single Transfer pdf receipt file generated in the Stark Bank API by passing its id.
@@ -141,6 +159,7 @@ module StarkBank
141
159
  bank_code: json['bank_code'],
142
160
  branch_code: json['branch_code'],
143
161
  account_number: json['account_number'],
162
+ scheduled: json['scheduled'],
144
163
  transaction_ids: json['transaction_ids'],
145
164
  fee: json['fee'],
146
165
  tags: json['tags'],
@@ -133,7 +133,7 @@ module StarkBank
133
133
  # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
134
134
  #
135
135
  # ## Return:
136
- # - deleted UtilityPayment with updated attributes
136
+ # - deleted UtilityPayment object
137
137
  def self.delete(id, user: nil)
138
138
  StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
139
139
  end
@@ -61,7 +61,7 @@ module StarkBank
61
61
  req['Access-Time'] = access_time
62
62
  req['Access-Signature'] = signature
63
63
  req['Content-Type'] = 'application/json'
64
- req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-0.4.2"
64
+ req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-0.5.0"
65
65
  req['Accept-Language'] = language
66
66
 
67
67
  request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }
@@ -83,7 +83,7 @@ module StarkBank
83
83
  # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
84
84
  #
85
85
  # ## Return:
86
- # - deleted Webhook with updated attributes
86
+ # - deleted Webhook object
87
87
  def self.delete(id, user: nil)
88
88
  StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
89
89
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: starkbank
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.2
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - starkbank