starkbank 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b51d2704eb7609e1e76b616bbb3ac74bdb1a0ae8685db2c518c676a6005c7e16
-  data.tar.gz: 7f87b9c3f526aeb6ae7e2d7c20f1f1030954fa5db92cdac8247699085eb12914
+  metadata.gz: dbed048429aad2e04ad3226ed8cd597d988bc14763c3e226e577772bd27818cf
+  data.tar.gz: 2045245ba00583edbf1db41f3b2714f1a8d82ccc1e71db8832e45d2265f092ec
 SHA512:
-  metadata.gz: 1fd6a1aa52db6930d017f2406ab328b3d0e625c087e95cee42aa67d45f8973b5e29173f56d05f01ef7f0a8a540699be5be798b9232db7be1c955935baa5bb812
-  data.tar.gz: 29fcbe0b5670e70339b186354f9d58057e2cdfa7278c0e0ad895f30c7b2b73e1164566fac49ada85b49a251099d7c705932b245bd9ffdf986f550b0d31f74960
+  metadata.gz: d5bc2d1a572a759437fae2afb50b6a257212d1b8e65134ea431ee3fbc5a1fcac69871c26bf6e53e5beab2b8770ee93a153a790a76c08726242211c81aa4e48e8
+  data.tar.gz: dd18ce715eb83485f5dfadd56f03ad9f08b24d0c2ec27aa21416cfae3e924304cf8a2d7c52b3f40f6e55f0b7b14fab9ff53b91ec5f9083b5d50a43aa15e06285

data/lib/balance/balance.rb

@@ -31,7 +31,7 @@ module StarkBank
     # Receive the Balance object linked to your workspace in the Stark Bank API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Balance object with updated attributes

data/lib/boleto/boleto.rb

@@ -82,7 +82,7 @@ module StarkBank
     # - boletos [list of Boleto objects]: list of Boleto objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - list of Boleto objects with updated attributes
@@ -98,7 +98,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Boleto object with updated attributes
@@ -116,7 +116,7 @@ module StarkBank
     # ## Parameters (optional):
     # - layout [string]: Layout specification. Available options are "default" and "booklet"
     # - hidden_fields [list of strings, default nil]: List of string fields to be hidden in Boleto pdf. ex: ["customerAddress"]
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Boleto pdf file
@@ -135,7 +135,7 @@ module StarkBank
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
     # - 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']
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of Boleto objects with updated attributes
@@ -162,7 +162,7 @@ module StarkBank
     # - id [string]: Boleto unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - deleted Boleto object

data/lib/boleto/log.rb

@@ -38,7 +38,7 @@ module StarkBank
       # - id [string]: object unique id. ex: '5656565656565656'
       #
       # ## Parameters (optional):
-      # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
       #
       # ## Return:
       # - Log object with updated attributes
@@ -56,7 +56,7 @@ module StarkBank
       # - before [Date, DateTime, Time 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: 'paid' or 'registered'
       # - boleto_ids [list of strings, default nil]: list of Boleto ids to filter logs. ex: ['5656565656565656', '4545454545454545']
-      # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
       #
       # ## Return:
       # - list of Log objects with updated attributes

data/lib/boleto_holmes/boleto_holmes.rb

@@ -45,7 +45,7 @@ module StarkBank
     # - holmes [list of BoletoHolmes objects]: list of BoletoHolmes objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - list of BoletoHolmes objects with updated attributes
@@ -61,7 +61,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - BoletoHolmes object with updated attributes
@@ -81,7 +81,7 @@ module StarkBank
     # - 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']
     # - boleto_id [string, default nil]: filter for holmes that investigate a specific boleto by its ID. ex: '5656565656565656'
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of BoletoHolmes objects with updated attributes

data/lib/boleto_holmes/log.rb

@@ -36,7 +36,7 @@ module StarkBank
       # - id [string]: object unique id. ex: '5656565656565656'
       #
       # ## Parameters (optional):
-      # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
       #
       # ## Return:
       # - Log object with updated attributes
@@ -54,7 +54,7 @@ module StarkBank
       # - before [Date, DateTime, Time 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: 'paid' or 'registered'
       # - holmes_ids [list of strings, default nil]: list of BoletoHolmes ids to filter logs. ex: ['5656565656565656', '4545454545454545']
-      # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
       #
       # ## Return:
       # - list of Log objects with updated attributes

data/lib/boleto_payment/boleto_payment.rb

@@ -53,7 +53,7 @@ module StarkBank
     # - payments [list of BoletoPayment objects]: list of BoletoPayment objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - list of BoletoPayment objects with updated attributes
@@ -69,7 +69,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - BoletoPayment object with updated attributes
@@ -86,7 +86,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - BoletoPayment pdf file
@@ -105,7 +105,7 @@ module StarkBank
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
     # - ids [list of strings, default nil]: list of strings to get specific entities by ids. ex: ['12376517623', '1928367198236']
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid'
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of BoletoPayment objects with updated attributes
@@ -131,7 +131,7 @@ module StarkBank
     # Parameters (required):
     # - id [string]: BoletoPayment unique id. ex: '5656565656565656'
     # Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     # Return:
     # - deleted BoletoPayment object
     def self.delete(id, user: nil)

data/lib/boleto_payment/log.rb

@@ -38,7 +38,7 @@ module StarkBank
       # - id [string]: object unique id. ex: '5656565656565656'
       #
       # ## Parameters (optional):
-      # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
       #
       # ## Return:
       # - Log object with updated attributes
@@ -56,7 +56,7 @@ module StarkBank
       # - before [Date, DateTime, Time 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 event types. ex: 'success' or 'failed'
       # - payment_ids [list of strings, default nil]: list of BoletoPayment ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-      # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
       #
       # ## Return:
       # - list of Log objects with updated attributes

data/lib/brcode_payment/brcode_payment.rb

@@ -55,7 +55,7 @@ module StarkBank
     # - payments [list of BrcodePayment objects]: list of BrcodePayment objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - list of BrcodePayment objects with updated attributes
@@ -71,7 +71,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - BrcodePayment object with updated attributes
@@ -87,7 +87,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - BrcodePayment pdf file
@@ -104,7 +104,7 @@ module StarkBank
     # - status [string, nil]: You may cancel the payment by passing 'canceled' in the status
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - updated BrcodePayment object
@@ -123,7 +123,7 @@ module StarkBank
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
     # - ids [list of strings, default nil]: list of strings to get specific entities by ids. ex: ['12376517623', '1928367198236']
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid'
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of BrcodePayment objects with updated attributes

data/lib/brcode_payment/log.rb

@@ -38,7 +38,7 @@ module StarkBank
       # - id [string]: object unique id. ex: '5656565656565656'
       #
       # ## Parameters (optional):
-      # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
       #
       # ## Return:
       # - Log object with updated attributes
@@ -56,7 +56,7 @@ module StarkBank
       # - before [Date, DateTime, Time 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 event types. ex: 'success' or 'failed'
       # - payment_ids [list of strings, default nil]: list of BrcodePayment ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-      # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
       #
       # ## Return:
       # - list of Log objects with updated attributes

data/lib/brcode_preview/brcode_preview.rb

@@ -41,7 +41,7 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - brcodes [list of strings]: List of brcodes to preview. ex: %w[00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A]
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of BrcodePreview objects with updated attributes

data/lib/deposit/deposit.rb

@@ -54,7 +54,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Deposit object with updated attributes
@@ -74,7 +74,7 @@ module StarkBank
     # - sort [string, default '-created']: sort order considered in response. Valid options are 'created' or '-created'.
     # - 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']
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of Deposit objects with updated attributes

data/lib/deposit/log.rb

@@ -38,7 +38,7 @@ module StarkBank
       # - id [string]: object unique id. ex: '5656565656565656'
       #
       # ## Parameters (optional):
-      # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
       #
       # ## Return:
       # - Log object with updated attributes
@@ -56,7 +56,7 @@ module StarkBank
       # - before [Date, DateTime, Time 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: 'paid' or 'canceled'
       # - deposit_ids [list of strings, default nil]: list of Deposit ids to filter logs. ex: ['5656565656565656', '4545454545454545']
-      # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
       #
       # ## Return:
       # - list of Log objects with updated attributes

data/lib/dict_key/dict_key.rb

@@ -54,7 +54,7 @@ module StarkBank
     # - id [string]: DictKey object unique id and PIX key itself. ex: 'tony@starkbank.com', '722.461.430-04', '20.018.183/0001-80', '+5511988887777', 'b6295ee1-f054-47d1-9e90-ee57b74f60d9'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - DictKey object with updated attributes
@@ -73,7 +73,7 @@ module StarkBank
     # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
     # - 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: 'canceled', 'registered'
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of DitcKey objects with updated attributes

data/lib/event/event.rb

@@ -60,7 +60,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Event object with updated attributes
@@ -77,7 +77,7 @@ module StarkBank
     # - 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)
     # - is_delivered [bool, default nil]: bool to filter successfully delivered events. ex: True or False
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of Event objects with updated attributes
@@ -102,7 +102,7 @@ module StarkBank
     # - id [string]: Event unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - deleted Event object
@@ -120,7 +120,7 @@ module StarkBank
     # - is_delivered [bool]: If True and event hasn't been delivered already, event will be set as delivered. ex: True
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - target Event with updated attributes
@@ -139,7 +139,7 @@ module StarkBank
     # - signature [string]: base-64 digital signature received at response header 'Digital-Signature'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Parsed Event object

data/lib/invoice/invoice.rb

@@ -73,7 +73,7 @@ module StarkBank
     # - invoices [list of Invoice objects]: list of Invoice objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - list of Invoice objects with updated attributes
@@ -89,7 +89,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Invoice object with updated attributes
@@ -105,7 +105,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Invoice pdf file
@@ -121,7 +121,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Invoice QR Code png blob
@@ -140,7 +140,7 @@ module StarkBank
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
     # - 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']
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of Invoice objects with updated attributes

data/lib/invoice/log.rb

@@ -38,7 +38,7 @@ module StarkBank
       # - id [string]: object unique id. ex: '5656565656565656'
       #
       # ## Parameters (optional):
-      # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
       #
       # ## Return:
       # - Log object with updated attributes
@@ -56,7 +56,7 @@ module StarkBank
       # - before [Date, DateTime, Time 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: 'paid' or 'canceled'
       # - invoice_ids [list of strings, default nil]: list of Invoice ids to filter logs. ex: ['5656565656565656', '4545454545454545']
-      # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
       #
       # ## Return:
       # - list of Log objects with updated attributes

data/lib/payment_request/payment_request.rb

@@ -7,17 +7,17 @@ require_relative('../utils/checks')
 module StarkBank
   # # PaymentRequest object
   # A PaymentRequest is an indirect request to access a specific cash-out service
-  # (such as Transfer, BoletoPayments, etc.) which goes through the cost center
+  # (such as Transfer, BrcodePayments, etc.) which goes through the cost center
   #  approval flow on our website. To emit a PaymentRequest, you must direct it to
   #  a specific cost center by its ID, which can be retrieved on our website at the
   #  cost center page.
   #
   # ## Parameters (required):
   # - center_id [String]: target cost center ID. ex: '5656565656565656'
-  # - payment [Transfer, BoletoPayment, UtilityPayment, Transaction or dictionary]: payment entity that should be approved and executed.
+  # - payment [Transfer, BrcodePayment, BoletoPayment, UtilityPayment, Transaction or dictionary]: payment entity that should be approved and executed.
   #
   # ## Parameters (optional):
-  # - type [String]: payment type, inferred from the payment parameter if it is not a dictionary. ex: 'transfer', 'boleto-payment'
+  # - type [String]: payment type, inferred from the payment parameter if it is not a dictionary. ex: 'transfer', 'brcode-payment'
   # - due [Date, DateTime, Time or string]: Payment target date in ISO format. ex: 2020-12-31
   # - tags [list of strings]: list of strings for tagging
   #
@@ -53,7 +53,7 @@ module StarkBank
     #
     # ## Parameters
     # - payment_requests [list of PaymentRequest objects]: list of PaymentRequest objects to be created in the API
-    # - user [Project object]: Project object. Not necessary if StarkBank.User.Default was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return
     # - list of PaymentRequest objects with updated attributes
@@ -73,11 +73,11 @@ module StarkBank
     # - 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)
     # - status [string, default '-created']: sort order considered in response. Valid options are '-created' or '-due'.
-    # - type [string, default nil]: payment type, inferred from the payment parameter if it is not a dictionary. ex: 'transfer', 'boleto-payment'
+    # - type [string, default nil]: payment type, inferred from the payment parameter if it is not a dictionary. ex: 'transfer', 'brcode-payment'
     # - sort [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
     # - 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']
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of PaymentRequest objects with updated attributes
@@ -102,14 +102,16 @@ module StarkBank
     def parse_payment(payment:, type:)
       return [payment, 'transfer'] if payment.is_a?(StarkBank::Transfer)
       return [payment, 'transaction'] if payment.is_a?(StarkBank::Transaction)
+      return [payment, 'brcode-payment'] if payment.is_a?(StarkBank::BrcodePayment)
       return [payment, 'boleto-payment'] if payment.is_a?(StarkBank::BoletoPayment)
       return [payment, 'utility-payment'] if payment.is_a?(StarkBank::UtilityPayment)
 
-      raise(Exception('Payment must either be a Transfer, a Transaction, a BoletoPayment, a UtilityPayment or a hash.')) unless payment.is_a?(Hash)
+      raise(Exception('Payment must either be a Transfer, a Transaction, a BrcodePayment, BoletoPayment, a UtilityPayment or a hash.')) unless payment.is_a?(Hash)
 
       resource = {
         'transfer': StarkBank::Transfer.resource,
         'transaction': StarkBank::Transaction.resource,
+        'brcode-payment': StarkBank::BrcodePayment.resource,
         'boleto-payment': StarkBank::BoletoPayment.resource,
         'utility-payment': StarkBank::UtilityPayment.resource
       }[type.to_sym]

data/lib/starkbank.rb

@@ -2,6 +2,8 @@
 
 require_relative('key')
 require_relative('user/project')
+require_relative('user/organization')
+require_relative('workspace/workspace')
 require_relative('balance/balance')
 require_relative('transaction/transaction')
 require_relative('invoice/invoice')

data/lib/transaction/transaction.rb

@@ -55,7 +55,7 @@ module StarkBank
     # - transactions [list of Transaction objects]: list of Transaction objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - list of Transaction objects with updated attributes
@@ -71,7 +71,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Transaction object with updated attributes
@@ -90,7 +90,7 @@ module StarkBank
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
     # - external_ids [list of strings, default nil]: list of external ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
     # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of Transaction objects with updated attributes

data/lib/transfer/log.rb

@@ -37,7 +37,7 @@ module StarkBank
       # - id [string]: object unique id. ex: '5656565656565656'
       #
       # ## Parameters (optional):
-      # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
       #
       # ## Return:
       # - Log object with updated attributes
@@ -55,7 +55,7 @@ module StarkBank
       # - before [Date, DateTime, Time 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. ex: 'success' or 'failed'
       # - transfer_ids [list of strings, default nil]: list of Transfer ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-      # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
       #
       # ## Return:
       # - list of Log objects with updated attributes

data/lib/transfer/transfer.rb

@@ -57,7 +57,7 @@ module StarkBank
     # - transfers [list of Transfer objects]: list of Transfer objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - list of Transfer objects with updated attributes
@@ -73,7 +73,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Transfer object with updated attributes
@@ -89,7 +89,7 @@ module StarkBank
     # - id [string]: Transfer unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - deleted Transfer object
@@ -106,7 +106,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Transfer pdf file
@@ -127,7 +127,7 @@ module StarkBank
     # - tax_id [string, default nil]: filter for transfers sent to the specified tax ID. ex: "012.345.678-90"
     # - 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']
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of Transfer objects with updated attributes

data/lib/user/organization.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative('user')
+
+module StarkBank
+  # # Organization object
+  # The Organization object is an authentication entity for the SDK that
+  # represents your entire Organization, being able to access any Workspace
+  # underneath it and even create new Workspaces. Only a legal representative
+  # of your organization can register or change the Organization credentials.
+  # All requests to the Stark Bank API must be authenticated via an SDK user,
+  # which must have been previously created at the Stark Bank website
+  # [https://sandbox.web.starkbank.com] or [https://web.starkbank.com]
+  # before you can use it in this SDK. Organizations may be passed as the user parameter on
+  # each request or may be defined as the default user at the start (See README).
+  # If you are accessing a specific Workspace using Organization credentials, you should
+  # specify the workspace ID when building the Organization object or by request, using
+  # the Organization.replace(organization, workspace_id) method, which creates a copy of the organization
+  # object with the altered workspace ID. If you are listing or creating new Workspaces, the
+  # workspace_id should be nil.
+  #
+  # ## Parameters (required):
+  # - environment [string]: environment where the organization is being used. ex: 'sandbox' or 'production'
+  # - id [string]: unique id required to identify organization. ex: '5656565656565656'
+  # - private_key [string]: PEM string of the private key linked to the organization. ex: '-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----'
+  # - workspace_id [string]: unique id of the accessed Workspace, if any. ex: nil or '4848484848484848'
+  #
+  # ## Attributes (return-only):
+  # - pem [string]: private key in pem format. ex: '-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----'
+  class Organization < StarkBank::User
+    attr_reader :workspace_id
+    def initialize(id:, environment:, private_key:, workspace_id: nil)
+      super(environment, id, private_key)
+      @workspace_id = workspace_id
+    end
+
+    def access_id
+      if @workspace_id
+        "organization/#{@id}/workspace/#{@workspace_id}"
+      else
+        "organization/#{@id}"
+      end
+    end
+
+    def self.replace(organization, workspace_id)
+      Organization.new(
+        environment: organization.environment,
+        id: organization.id,
+        private_key: organization.pem,
+        workspace_id: workspace_id
+      )
+    end
+  end
+end

data/lib/user/project.rb

@@ -5,20 +5,21 @@ require_relative('user')
 module StarkBank
   # # Project object
   #
-  # The Project object is the main authentication entity for the SDK.
-  # All requests to the Stark Bank API must be authenticated via a project,
+  # The Project object is an authentication entity for the SDK that is permanently
+  # linked to a specific Workspace.
+  # All requests to the Stark Bank API must be authenticated via an SDK user,
   # which must have been previously created at the Stark Bank website
   # [https://sandbox.web.starkbank.com] or [https://web.starkbank.com]
-  # before you can use it in this SDK. Projects may be passed as a parameter on
+  # before you can use it in this SDK. Projects may be passed as the user parameter on
   # each request or may be defined as the default user at the start (See README).
   #
   # ## Parameters (required):
   # - id [string]: unique id required to identify project. ex: '5656565656565656'
-  # - private_key [EllipticCurve.Project()]: PEM string of the private key linked to the project. ex: '-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----'
+  # - private_key [string]: PEM string of the private key linked to the project. ex: '-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----'
   # - environment [string]: environment where the project is being used. ex: 'sandbox' or 'production'
   #
   # ## Attributes (return-only):
-  # - name [string, default ']: project name. ex: 'MyProject'
+  # - name [string, default '']: project name. ex: 'MyProject'
   # - allowed_ips [list of strings]: list containing the strings of the ips allowed to make requests on behalf of this project. ex: ['190.190.0.50']
   # - pem [string]: private key in pem format. ex: '-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----'
   class Project < StarkBank::User
@@ -28,5 +29,9 @@ module StarkBank
       @name = name
       @allowed_ips = allowed_ips
     end
+
+    def access_id
+      "project/#{@id}"
+    end
   end
 end

data/lib/user/user.rb

@@ -13,10 +13,6 @@ module StarkBank
       @environment = StarkBank::Utils::Checks.check_environment(environment)
     end
 
-    def access_id
-      "#{self.class.name.split('::').last.downcase}/#{@id}"
-    end
-
     def private_key
       EllipticCurve::PrivateKey.fromPem(@pem)
     end

data/lib/utility_payment/log.rb

@@ -37,7 +37,7 @@ module StarkBank
       # - id [string]: object unique id. ex: '5656565656565656'
       #
       # ## Parameters (optional):
-      # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
       #
       # ## Return:
       # - Log object with updated attributes
@@ -55,7 +55,7 @@ module StarkBank
       # - before [Date, DateTime, Time 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 event types. ex: 'paid' or 'registered'
       # - payment_ids [list of strings, default nil]: list of UtilityPayment ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-      # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
       #
       # ## Return:
       # - list of Log objects with updated attributes

data/lib/utility_payment/utility_payment.rb

@@ -51,7 +51,7 @@ module StarkBank
     # - payments [list of UtilityPayment objects]: list of UtilityPayment objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - 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
@@ -67,7 +67,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - UtilityPayment object with updated attributes
@@ -84,7 +84,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - UtilityPayment pdf file
@@ -103,7 +103,7 @@ module StarkBank
     # - 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 [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - 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
@@ -130,7 +130,7 @@ module StarkBank
     # - id [string]: UtilityPayment unique id. ex:'5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - deleted UtilityPayment object

data/lib/utils/request.rb

@@ -61,7 +61,7 @@ module StarkBank
         req['Access-Time'] = access_time
         req['Access-Signature'] = signature
         req['Content-Type'] = 'application/json'
-        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-2.2.1"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-2.3.0"
         req['Accept-Language'] = language
 
         request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }

data/lib/utils/rest.rb

@@ -31,8 +31,7 @@ module StarkBank
 
             cursor = json['cursor']
             query['cursor'] = cursor
-
-            break if cursor.nil? || (!limit.nil? && limit <= 0)
+            break if cursor.nil? || cursor.empty? || (!limit.nil? && limit <= 0)
           end
         end
       end

data/lib/webhook/webhook.rb

@@ -8,12 +8,12 @@ module StarkBank
   # # Webhook subscription object
   #
   # A Webhook is used to subscribe to notification events on a user-selected endpoint.
-  # Currently available services for subscription are transfer, boleto, boleto-payment,
-  # and utility-payment
+  # Currently available services for subscription are transfer, invoice, deposit, brcode-payment,
+  # boleto, boleto-payment and utility-payment
   #
   # ## Parameters (required):
   # - url [string]: Url that will be notified when an event occurs.
-  # - subscriptions [list of strings]: list of any non-empty combination of the available services. ex: ['transfer', 'boleto-payment']
+  # - subscriptions [list of strings]: list of any non-empty combination of the available services. ex: ['transfer', 'deposit']
   #
   # ## Attributes:
   # - id [string, default nil]: unique id returned when the webhook is created. ex: '5656565656565656'
@@ -31,10 +31,10 @@ module StarkBank
     #
     # ## Parameters (required):
     # - url [string]: url to which notification events will be sent to. ex: 'https://webhook.site/60e9c18e-4b5c-4369-bda1-ab5fcd8e1b29'
-    # - subscriptions [list of strings]: list of any non-empty combination of the available services. ex: ['transfer', 'boleto-payment']
+    # - subscriptions [list of strings]: list of any non-empty combination of the available services. ex: ['transfer', 'invoice']
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Webhook object with updated attributes
@@ -50,7 +50,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Webhook object with updated attributes
@@ -64,7 +64,7 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of Webhook objects with updated attributes
@@ -80,7 +80,7 @@ module StarkBank
     # - id [string]: Webhook unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - deleted Webhook object

data/lib/workspace/workspace.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # Workspace object
+  #
+  # Workspaces are bank accounts. They have independent balances, statements, operations and permissions.
+  # The only property that is shared between your workspaces is that they are linked to your organization,
+  # which carries your basic informations, such as tax ID, name, etc..
+  #
+  # ## Parameters (required):
+  # - username [string]: Simplified name to define the workspace URL. This name must be unique across all Stark Bank Workspaces. Ex: 'starkbankworkspace'
+  # - name [string]: Full name that identifies the Workspace. This name will appear when people access the Workspace on our platform, for example. Ex: 'Stark Bank Workspace'
+  #
+  # ## Attributes:
+  # - id [string, default nil]: unique id returned when the workspace is created. ex: '5656565656565656'
+  class Workspace < StarkBank::Utils::Resource
+    attr_reader :username, :name, :id
+    def initialize(username:, name:, id: nil)
+      super(id)
+      @username = username
+      @name = name
+    end
+
+    # # Create Workspace
+    #
+    # Send a Workspace for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - username [string]: Simplified name to define the workspace URL. This name must be unique across all Stark Bank Workspaces. Ex: 'starkbankworkspace'
+    # - name [string]: Full name that identifies the Workspace. This name will appear when people access the Workspace on our platform, for example. Ex: 'Stark Bank Workspace'
+    #
+    # ## Parameters (optional):
+    # - user [Organization object]: Organization object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - Workspace object with updated attributes
+    def self.create(username:, name:, user: nil)
+      StarkBank::Utils::Rest.post_single(entity: Workspace.new(username: username, name: name), user: user, **resource)
+    end
+
+    # # Retrieve a specific Workspace
+    #
+    # Receive a single Workspace object previously created in 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:
+    # - Workspace object with updated attributes
+    def self.get(id, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve Workspaces
+    #
+    # Receive a generator of Workspace objects previously created in the Stark Bank API.
+    # If no filters are passed and the user is an Organization, all of the Organization Workspaces
+    # will be retrieved.
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - username [string]: query by the simplified name that defines the workspace URL. This name is always unique across all Stark Bank Workspaces. Ex: 'starkbankworkspace'
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
+    #
+    # ## Return:
+    # - generator of Workspace objects with updated attributes
+    def self.query(limit: nil, username: nil, ids: nil, user: nil)
+      StarkBank::Utils::Rest.get_list(limit: limit, username: username, ids: ids, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'Workspace',
+        resource_maker: proc { |json|
+          Workspace.new(
+            id: json['id'],
+            username: json['username'],
+            name: json['name']
+          )
+        }
+      }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: starkbank
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - starkbank
@@ -95,6 +95,7 @@ files:
 - lib/transaction/transaction.rb
 - lib/transfer/log.rb
 - lib/transfer/transfer.rb
+- lib/user/organization.rb
 - lib/user/project.rb
 - lib/user/user.rb
 - lib/utility_payment/log.rb
@@ -109,6 +110,7 @@ files:
 - lib/utils/rest.rb
 - lib/utils/url.rb
 - lib/webhook/webhook.rb
+- lib/workspace/workspace.rb
 homepage: https://github.com/starkbank/sdk-ruby
 licenses:
 - MIT