starkbank 2.1.0.beta2 → 2.3.0

data/lib/event/event.rb

@@ -8,7 +8,10 @@ require_relative('../utils/checks')
 require_relative('../utils/cache')
 require_relative('../error')
 require_relative('../boleto/log')
+require_relative('../boleto_holmes/log')
 require_relative('../invoice/log')
+require_relative('../deposit/log')
+require_relative('../brcode_payment/log')
 require_relative('../transfer/log')
 require_relative('../boleto_payment/log')
 require_relative('../utility_payment/log')
@@ -37,9 +40,12 @@ module StarkBank
       resource = {
         'transfer': StarkBank::Transfer::Log.resource,
         'invoice': StarkBank::Invoice::Log.resource,
+        'deposit': StarkBank::Deposit::Log.resource,
+        'brcode-payment': StarkBank::BrcodePayment::Log.resource,
         'boleto': StarkBank::Boleto::Log.resource,
         'boleto-payment': StarkBank::BoletoPayment::Log.resource,
-        'utility-payment': StarkBank::UtilityPayment::Log.resource
+        'utility-payment': StarkBank::UtilityPayment::Log.resource,
+        'boleto-holmes': StarkBank::BoletoHolmes::Log.resource
       }[subscription.to_sym]
 
       @log = log
@@ -54,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
@@ -71,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
@@ -96,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
@@ -114,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
@@ -133,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

@@ -17,7 +17,7 @@ module StarkBank
   # - name [string]: payer name. ex: 'Iron Bank S.A.'
   #
   # ## Parameters (optional):
-  # - due [DateTime or string, default today + 2 days]: Invoice due date in UTC ISO format. ex: '2020-10-28T17:59:26.249976+00:00'
+  # - due [DateTime or string, default now + 2 days]: Invoice due date in UTC ISO format. ex: '2020-10-28T17:59:26.249976+00:00'
   # - expiration [integer, default 5097600 (59 days)]: time interval in seconds between due date and expiration date. ex 123456789
   # - fine [float, default 0.0]: Invoice fine for overdue payment in %. ex: 2.5
   # - interest [float, default 0.0]: Invoice monthly interest for overdue payment in %. ex: 5.2
@@ -32,15 +32,16 @@ module StarkBank
   # - interest_amount [integer, default nil]: Invoice interest value calculated over nominal_amount. ex: 10000
   # - discount_amount [integer, default nil]: Invoice discount value calculated over nominal_amount. ex: 3000
   # - brcode [string, default nil]: BR Code for the Invoice payment. ex: '00020101021226800014br.gov.bcb.pix2558invoice.starkbank.com/f5333103-3279-4db2-8389-5efe335ba93d5204000053039865802BR5913Arya Stark6009Sao Paulo6220051656565656565656566304A9A0'
+  # - fee [integer, default nil]: fee charged by the Invoice. ex: 65 (= R$ 0.65)
   # - status [string, default nil]: current Invoice status. ex: 'registered' or 'paid'
   # - created [DateTime, default nil]: creation datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - updated [DateTime, default nil]: latest update datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class Invoice < StarkBank::Utils::Resource
-    attr_reader :amount, :due, :tax_id, :name, :expiration, :fine, :interest, :discounts, :tags, :descriptions, :nominal_amount, :fine_amount, :interest_amount, :discount_amount, :id, :brcode, :status, :created, :updated
+    attr_reader :amount, :tax_id, :name, :due, :expiration, :fine, :interest, :discounts, :tags, :descriptions, :nominal_amount, :fine_amount, :interest_amount, :discount_amount, :id, :brcode, :fee, :status, :created, :updated
     def initialize(
-      amount:, due:, tax_id:, name:, expiration: nil, fine: nil, interest: nil, discounts: nil,
+      amount:, tax_id:, name:, due: nil, expiration: nil, fine: nil, interest: nil, discounts: nil,
       tags: nil, descriptions: nil, nominal_amount: nil, fine_amount: nil, interest_amount: nil,
-      discount_amount: nil, id: nil, brcode: nil, status: nil, created: nil, updated: nil
+      discount_amount: nil, id: nil, brcode: nil, fee: nil, status: nil, created: nil, updated: nil
     )
       super(id)
       @amount = amount
@@ -58,6 +59,7 @@ module StarkBank
       @interest_amount = interest_amount
       @discount_amount = discount_amount
       @brcode = brcode
+      @fee = fee
       @status = status
       @updated = StarkBank::Utils::Checks.check_datetime(updated)
       @created = StarkBank::Utils::Checks.check_datetime(created)
@@ -71,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
@@ -87,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
@@ -95,6 +97,38 @@ module StarkBank
       StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
     end
 
+    # # Retrieve a specific Invoice pdf file
+    #
+    # Receive a single Invoice pdf file generated 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:
+    # - Invoice pdf file
+    def self.pdf(id, user: nil)
+      StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
+    end
+
+    # # Retrieve a specific Invoice QR Code file
+    #
+    # Receive a single Invoice QR Code png file generated 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:
+    # - Invoice QR Code png blob
+    def self.qrcode(id, user: nil)
+      StarkBank::Utils::Rest.get_qrcode(id: id, user: user, **resource)
+    end
+
     # # Retrieve Invoices
     #
     # Receive a generator of Invoice objects previously created in the Stark Bank API
@@ -106,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
@@ -133,10 +167,13 @@ module StarkBank
     # - id [string]: Invoice unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - status [string, nil]: You may cancel the invoice by passing 'canceled' in the status
+    # - amount [string, nil]: Nominal amount charged by the invoice. ex: 100 (R$1.00)
+    # - due [datetime.date or string, default nil]: Invoice due date in UTC ISO format. ex: DateTime.new(2020, 3, 10, 10, 30, 12, 21)
+    # - expiration [number, default nil]: time interval in seconds between the due date and the expiration date. ex 123456789
     #
     # ## Return:
-    # - deleted Invoice object
+    # - updated Invoice object
     def self.update(id, status: nil, amount: nil, due: nil, expiration: nil, user: nil)
       StarkBank::Utils::Rest.patch_id(id: id, status: status, amount: amount, due: due, expiration: expiration, user: user, **resource)
     end
@@ -162,6 +199,7 @@ module StarkBank
             interest_amount: json['interest_amount'],
             discount_amount: json['discount_amount'],
             brcode: json['brcode'],
+            fee: json['fee'],
             status: json['status'],
             updated: json['updated'],
             created: json['created'],

data/lib/invoice/log.rb

@@ -9,7 +9,7 @@ module StarkBank
   class Invoice
     # # Invoice::Log object
     #
-    # Every time a Invoice entity is updated, a corresponding Invoice::Log
+    # Every time an Invoice entity is updated, a corresponding Invoice::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 Invoice.
@@ -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,10 +2,22 @@
 
 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')
+require_relative('invoice/log')
+require_relative('dict_key/dict_key')
+require_relative('deposit/deposit')
+require_relative('deposit/log')
+require_relative('brcode_preview/brcode_preview')
+require_relative('brcode_payment/brcode_payment')
+require_relative('brcode_payment/log')
 require_relative('boleto/boleto')
 require_relative('boleto/log')
+require_relative('boleto_holmes/boleto_holmes')
+require_relative('boleto_holmes/log')
 require_relative('transfer/transfer')
 require_relative('transfer/log')
 require_relative('boleto_payment/boleto_payment')

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

@@ -15,13 +15,13 @@ module StarkBank
   # - amount [integer]: amount in cents to be transferred. ex: 1234 (= R$ 12.34)
   # - name [string]: receiver full name. ex: 'Anthony Edward Stark'
   # - tax_id [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
-  # - bank_code [string]: 1 to 3 digits of the receiver bank institution in Brazil. ex: '200' or '341'
+  # - bank_code [string]: code of the receiver bank institution in Brazil. If an ISPB (8 digits) is informed, a PIX transfer will be created, else a TED will be issued. ex: '20018183' or '260'
   # - branch_code [string]: receiver bank account branch. Use '-' in case there is a verifier digit. ex: '1357-9'
   # - account_number [string]: Receiver Bank Account number. Use '-' before the verifier digit. ex: '876543-2'
   #
   # ## Parameters (optional):
   # - tags [list of strings]: list of strings for reference when searching for transfers. ex: ['employees', 'monthly']
-  # - 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)
+  # - 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, 13, 12, 11)
   #
   # ## Attributes (return-only):
   # - id [string, default nil]: unique id returned when Transfer is created. ex: '5656565656565656'
@@ -40,7 +40,7 @@ module StarkBank
       @bank_code = bank_code
       @branch_code = branch_code
       @account_number = account_number
-      @scheduled = StarkBank::Utils::Checks.check_date(scheduled)
+      @scheduled = StarkBank::Utils::Checks.check_date_or_datetime(scheduled)
       @transaction_ids = transaction_ids
       @fee = fee
       @tags = tags
@@ -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