starkbank 0.0.3 → 0.4.0

data/lib/{webhook → event}/event.rb

@@ -9,8 +9,8 @@ require_relative('../utils/cache')
 require_relative('../error')
 require_relative('../boleto/log')
 require_relative('../transfer/log')
-require_relative('../payment/boleto/log')
-require_relative('../payment/utility/log')
+require_relative('../boleto_payment/log')
+require_relative('../utility_payment/log')
 
 module StarkBank
   # # Webhook Event object
@@ -20,11 +20,11 @@ module StarkBank
   # list all generated updates on entities.
   #
   # ## Attributes:
-  # - id [string]: unique id returned when the log is created. ex: "5656565656565656"
+  # - id [string]: unique id returned when the event is created. ex: '5656565656565656'
   # - log [Log]: a Log object from one the subscription services (TransferLog, BoletoLog, BoletoPaymentlog or UtilityPaymentLog)
   # - created [DateTime]: creation datetime for the notification event. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - is_delivered [bool]: true if the event has been successfully delivered to the user url. ex: False
-  # - subscription [string]: service that triggered this event. ex: "transfer", "utility-payment"
+  # - subscription [string]: service that triggered this event. ex: 'transfer', 'utility-payment'
   class Event < StarkBank::Utils::Resource
     attr_reader :id, :log, :created, :is_delivered, :subscription
     def initialize(id:, log:, created:, is_delivered:, subscription:)
@@ -48,14 +48,14 @@ module StarkBank
     # Receive a single notification Event object previously created in the Stark Bank API by passing its id
     #
     # ## Parameters (required):
-    # - id [string]: object unique id. ex: "5656565656565656"
+    # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Event object with updated attributes
-    def self.get(id:, user: nil)
+    def self.get(id, user: nil)
       StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
     end
 
@@ -65,17 +65,24 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
     # - is_delivered [bool, default nil]: bool to filter successfully delivered events. ex: True or False
-    # - after [Date, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, default nil]: date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
     # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - generator of Event objects with updated attributes
-    def self.query(limit: nil, is_delivered: nil, after: nil, before: nil, user: nil)
+    def self.query(limit: nil, after: nil, before: nil, is_delivered: nil, user: nil)
       after = StarkBank::Utils::Checks.check_date(after)
       before = StarkBank::Utils::Checks.check_date(before)
-      StarkBank::Utils::Rest.get_list(user: user, limit: limit, is_delivered: is_delivered, after: after, before: before, **resource)
+      StarkBank::Utils::Rest.get_list(
+        user: user,
+        limit: limit,
+        after: after,
+        before: before,
+        is_delivered: is_delivered,
+        **resource
+      )
     end
 
     # # Delete a notification Event
@@ -83,14 +90,14 @@ module StarkBank
     # Delete a of notification Event entity previously created in the Stark Bank API by its ID
     #
     # ## Parameters (required):
-    # - id [string]: Event unique id. ex: "5656565656565656"
+    # - id [string]: Event unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - deleted Event with updated attributes
-    def self.delete(id:, user: nil)
+    def self.delete(id, user: nil)
       StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
     end
 
@@ -100,7 +107,7 @@ module StarkBank
     # If is_delivered is True, the event will no longer be returned on queries with is_delivered=False.
     #
     # ## Parameters (required):
-    # - id [list of strings]: Event unique ids. ex: "5656565656565656"
+    # - id [list of strings]: Event unique ids. ex: '5656565656565656'
     # - is_delivered [bool]: If True and event hasn't been delivered already, event will be set as delivered. ex: True
     #
     # ## Parameters (optional):
@@ -108,7 +115,7 @@ module StarkBank
     #
     # ## Return:
     # - target Event with updated attributes
-    def self.update(id:, is_delivered:, user: nil)
+    def self.update(id, is_delivered:, user: nil)
       StarkBank::Utils::Rest.patch_id(id: id, user: user, is_delivered: is_delivered, **resource)
     end
 
@@ -120,7 +127,7 @@ module StarkBank
     #
     # ## Parameters (required):
     # - content [string]: response content from request received at user endpoint (not parsed)
-    # - signature [string]: base-64 digital signature received at response header "Digital-Signature"
+    # - 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
@@ -130,6 +137,12 @@ module StarkBank
     def self.parse(content:, signature:, user: nil)
       event = StarkBank::Utils::API.from_api_json(resource[:resource_maker], JSON.parse(content)['event'])
 
+      begin
+        signature = EllipticCurve::Signature.fromBase64(signature)
+      rescue
+        raise(StarkBank::Error::InvalidSignatureError, 'The provided signature is not valid')
+      end
+
       return event if verify_signature(content: content, signature: signature, user: user)
 
       return event if verify_signature(content: content, signature: signature, user: user, refresh: true)
@@ -141,7 +154,6 @@ module StarkBank
       private
 
       def verify_signature(content:, signature:, user:, refresh: false)
-        signature = EllipticCurve::Signature.fromBase64(signature)
         public_key = StarkBank::Utils::Cache.starkbank_public_key
         if public_key.nil? || refresh
           pem = get_public_key_pem(user)
@@ -152,7 +164,7 @@ module StarkBank
       end
 
       def get_public_key_pem(user)
-        StarkBank::Utils::Request.fetch(method: 'GET', path: 'public-key', query: {limit: 1}, user: user).json['publicKeys'][0]['content']
+        StarkBank::Utils::Request.fetch(method: 'GET', path: 'public-key', query: { limit: 1 }, user: user).json['publicKeys'][0]['content']
       end
 
       def resource

data/lib/starkbank.rb

@@ -2,21 +2,22 @@
 
 require_relative('key')
 require_relative('user/project')
-require_relative('ledger/balance')
-require_relative('ledger/transaction')
+require_relative('balance/balance')
+require_relative('transaction/transaction')
 require_relative('boleto/boleto')
 require_relative('boleto/log')
 require_relative('transfer/transfer')
 require_relative('transfer/log')
-require_relative('payment/boleto/boleto')
-require_relative('payment/boleto/log')
-require_relative('payment/utility/utility')
-require_relative('payment/utility/log')
+require_relative('boleto_payment/boleto_payment')
+require_relative('boleto_payment/log')
+require_relative('utility_payment/utility_payment')
+require_relative('utility_payment/log')
 require_relative('webhook/webhook')
-require_relative('webhook/event')
+require_relative('event/event')
 
 # SDK to facilitate Ruby integrations with Stark Bank
 module StarkBank
   @user = nil
-  class << self; attr_accessor :user; end
+  @language = 'en-US'
+  class << self; attr_accessor :user, :language; end
 end

data/lib/{ledger → transaction}/transaction.rb

@@ -17,22 +17,23 @@ module StarkBank
   #
   # ## Parameters (required):
   # - amount [integer]: amount in cents to be transferred. ex: 1234 (= R$ 12.34)
-  # - description [string]: text to be displayed in the receiver and the sender statements (Min. 10 characters). ex: "funds redistribution"
-  # - external_id [string]: unique id, generated by user, to avoid duplicated transactions. ex: "transaction ABC 2020-03-30"
-  # - received_id [string]: unique id of the receiving workspace. ex: "5656565656565656"
+  # - description [string]: text to be displayed in the receiver and the sender statements (Min. 10 characters). ex: 'funds redistribution'
+  # - external_id [string]: unique id, generated by user, to avoid duplicated transactions. ex: 'transaction ABC 2020-03-30'
+  # - received_id [string]: unique id of the receiving workspace. ex: '5656565656565656'
   #
   # ## Parameters (optional):
-  # - tags [list of strings]: list of strings for reference when searching transactions (may be empty). ex: ["abc", "test"]
+  # - tags [list of strings]: list of strings for reference when searching transactions (may be empty). ex: ['abc', 'test']
   #
   # ## Attributes (return-only):
-  # - sender_id [string]: unique id of the sending workspace. ex: "5656565656565656"
-  # - source [string, default nil]: locator of the entity that generated the transaction. ex: "charge/1827351876292", "transfer/92873912873/chargeback"
-  # - id [string, default nil]: unique id returned when Transaction is created. ex: "7656565656565656"
-  # - fee [integer, default nil]: fee charged when transfer is created. ex: 200 (= R$ 2.00)
+  # - sender_id [string]: unique id of the sending workspace. ex: '5656565656565656'
+  # - source [string, default nil]: locator of the entity that generated the transaction. ex: 'charge/1827351876292', 'transfer/92873912873/chargeback'
+  # - id [string, default nil]: unique id returned when Transaction is created. ex: '7656565656565656'
+  # - fee [integer, default nil]: fee charged when transaction is created. ex: 200 (= R$ 2.00)
+  # - balance [integer, default nil]: account balance after transaction was processed. ex: 100000000 (= R$ 1,000,000.00)
   # - created [DateTime, default nil]: creation datetime for the boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class Transaction < StarkBank::Utils::Resource
     attr_reader :amount, :description, :external_id, :receiver_id, :sender_id, :tags, :id, :fee, :created, :source
-    def initialize(amount:, description:, external_id:, receiver_id:, sender_id: nil, tags: nil, id: nil, fee: nil, created: nil, source: nil)
+    def initialize(amount:, description:, external_id:, receiver_id:, sender_id: nil, tags: nil, id: nil, fee: nil, source: nil, balance: nil, created: nil)
       super(id)
       @amount = amount
       @description = description
@@ -42,6 +43,7 @@ module StarkBank
       @tags = tags
       @fee = fee
       @source = source
+      @balance = balance
       @created = StarkBank::Utils::Checks.check_datetime(created)
     end
 
@@ -57,7 +59,7 @@ module StarkBank
     #
     # ## Return:
     # - list of Transaction objects with updated attributes
-    def self.create(transactions:, user: nil)
+    def self.create(transactions, user: nil)
       StarkBank::Utils::Rest.post(entities: transactions, user: user, **resource)
     end
 
@@ -66,14 +68,14 @@ module StarkBank
     # Receive a single Transaction object previously created in the Stark Bank API by passing its id
     #
     # ## Parameters (required):
-    # - id [string]: object unique id. ex: "5656565656565656"
+    # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Transaction object with updated attributes
-    def self.get(id:, user: nil)
+    def self.get(id, user: nil)
       StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
     end
 
@@ -83,17 +85,17 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - external_ids [list of strings, default nil]: list of external ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
-    # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - 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)
+    # - external_ids [list of strings, default nil]: list of external 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
     #
     # ## Return:
     # - generator of Transaction objects with updated attributes
-    def self.query(limit: nil, external_ids: nil, after: nil, before: nil, user: nil)
+    def self.query(limit: nil, after: nil, before: nil, external_ids: nil, user: nil)
       after = StarkBank::Utils::Checks.check_date(after)
       before = StarkBank::Utils::Checks.check_date(before)
-      StarkBank::Utils::Rest.get_list(user: user, limit: limit, external_ids: external_ids, after: after, before: before, **resource)
+      StarkBank::Utils::Rest.get_list(user: user, limit: limit, after: after, before: before, external_ids: external_ids, **resource)
     end
 
     def self.resource
@@ -109,8 +111,9 @@ module StarkBank
             tags: json['tags'],
             id: json['id'],
             fee: json['fee'],
-            created: json['created'],
-            source: json['source']
+            source: json['source'],
+            balance: json['balance'],
+            created: json['created']
           )
         }
       }

data/lib/transfer/log.rb

@@ -14,11 +14,11 @@ module StarkBank
     # user.
     #
     # ## Attributes:
-    # - id [string]: unique id returned when the log is created. ex: "5656565656565656"
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
     # - transfer [Transfer]: Transfer entity to which the log refers to.
     # - errors [list of strings]: list of errors linked to this BoletoPayment event.
-    # - type [string]: type of the Transfer event which triggered the log creation. ex: "processing" or "success"
-    # - created [DateTime]: creation datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    # - type [string]: type of the Transfer event which triggered the log creation. ex: 'processing' or 'success'
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
     class Log < StarkBank::Utils::Resource
       attr_reader :id, :created, :type, :errors, :transfer
       def initialize(id:, created:, type:, errors:, transfer:)
@@ -34,14 +34,14 @@ module StarkBank
       # Receive a single Log object previously created by the Stark Bank API by passing its id
       #
       # ## Parameters (required):
-      # - id [string]: object unique id. ex: "5656565656565656"
+      # - id [string]: object unique id. ex: '5656565656565656'
       #
       # ## Parameters (optional):
       # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
       #
       # ## Return:
       # - Log object with updated attributes
-      def self.get(id:, user: nil)
+      def self.get(id, user: nil)
         StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
       end
 
@@ -51,18 +51,26 @@ module StarkBank
       #
       # ## Parameters (optional):
       # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-      # - transfer_ids [list of strings, default nil]: list of Transfer ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
-      # - types [list of strings, default nil]: filter retrieved objects by types. ex: "success" or "failed"
-      # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-      # - before [Date, default nil] date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
+      # - 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)
+      # - 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
       #
       # ## Return:
       # - list of Log objects with updated attributes
-      def self.query(limit: nil, transfer_ids: nil, types: nil, after: nil, before: nil, user: nil)
+      def self.query(limit: nil, after: nil, before: nil, types: nil, transfer_ids: nil, user: nil)
         after = StarkBank::Utils::Checks.check_date(after)
         before = StarkBank::Utils::Checks.check_date(before)
-        StarkBank::Utils::Rest.get_list(user: user, limit: limit, transfer_ids: transfer_ids, types: types, after: after, before: before, **resource)
+        StarkBank::Utils::Rest.get_list(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          transfer_ids: transfer_ids,
+          user: user,
+          **resource
+        )
       end
 
       def self.resource

data/lib/transfer/transfer.rb

@@ -13,20 +13,20 @@ module StarkBank
   #
   # ## Parameters (required):
   # - 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]: receiver 1 to 3 digits of the bank institution in Brazil. ex: "200" or "341"
-  # - 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"
+  # - 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'
+  # - 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"]
+  # - tags [list of strings]: list of strings for reference when searching for transfers. ex: ['employees', 'monthly']
   #
   # ## Attributes (return-only):
-  # - id [string, default nil]: unique id returned when Transfer is created. ex: "5656565656565656"
+  # - id [string, default nil]: unique id returned when Transfer is created. ex: '5656565656565656'
   # - fee [integer, default nil]: fee charged when transfer is created. ex: 200 (= R$ 2.00)
-  # - status [string, default nil]: current boleto status. ex: "registered" or "paid"
-  # - transaction_ids [list of strings, default nil]: ledger transaction ids linked to this transfer (if there are two, second is the chargeback). ex: ["19827356981273"]
+  # - status [string, default nil]: current transfer status. ex: 'success' or 'failed'
+  # - transaction_ids [list of strings, default nil]: ledger transaction ids linked to this transfer (if there are two, second is the chargeback). ex: ['19827356981273']
   # - created [DateTime, default nil]: creation datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - updated [DateTime, default nil]: latest update datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class Transfer < StarkBank::Utils::Resource
@@ -59,7 +59,7 @@ module StarkBank
     #
     # ## Return:
     # - list of Transfer objects with updated attributes
-    def self.create(transfers:, user: nil)
+    def self.create(transfers, user: nil)
       StarkBank::Utils::Rest.post(entities: transfers, user: user, **resource)
     end
 
@@ -68,31 +68,31 @@ module StarkBank
     # Receive a single Transfer object previously created in the Stark Bank API by passing its id
     #
     # ## Parameters (required):
-    # - id [string]: object unique id. ex: "5656565656565656"
+    # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Transfer object with updated attributes
-    def self.get(id:, user: nil)
+    def self.get(id, user: nil)
       StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
     end
 
     # # Retrieve a specific Transfer pdf file
     #
     # Receive a single Transfer pdf receipt file generated in the Stark Bank API by passing its id.
-    # Only valid for transfers with "processing" and "success" status.
+    # Only valid for transfers with 'processing' and 'success' status.
     #
     # ## Parameters (required):
-    # - id [string]: object unique id. ex: "5656565656565656"
+    # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Transfer pdf file
-    def self.pdf(id:, user: nil)
+    def self.pdf(id, user: nil)
       StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
     end
 
@@ -102,19 +102,31 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - 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"]
-    # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, default nil] date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
+    # - after [Date, DateTime, Time or string, default nil] date filter for objects created or updated only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, DateTime, Time or string, default nil] date filter for objects created or updated only before specified date. ex: Date.new(2020, 3, 10)
+    # - transactionIds [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: 'success' or 'failed'
+    # - 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']
     # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - generator of Transfer objects with updated attributes
-    def self.query(limit: nil, status: nil, tags: nil, transaction_ids: nil, sort: nil, after: nil, before: nil, user: nil)
+    def self.query(limit: nil, after: nil, before: nil, transaction_ids: nil, status: nil, tax_id: nil, sort: nil, tags: nil, user: nil)
       after = StarkBank::Utils::Checks.check_date(after)
       before = StarkBank::Utils::Checks.check_date(before)
-      StarkBank::Utils::Rest.get_list(user: user, limit: limit, status: status, tags: tags, transaction_ids: transaction_ids, sort: sort, after: after, before: before, **resource)
+      StarkBank::Utils::Rest.get_list(
+        limit: limit,
+        after: after,
+        before: before,
+        transaction_ids: transaction_ids,
+        status: status,
+        tax_id: tax_id,
+        sort: sort,
+        tags: tags,
+        user: user,
+        **resource
+      )
     end
 
     def self.resource

data/lib/user/project.rb

@@ -13,14 +13,14 @@ module StarkBank
   # 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-----"
-  # - environment [string]: environment where the project is being used. ex: "sandbox" or "production"
+  # - 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-----'
+  # - environment [string]: environment where the project is being used. ex: 'sandbox' or 'production'
   #
   # ## Attributes (return-only):
-  # - 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-----"
+  # - 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
     attr_reader :name, :allowed_ips
     def initialize(environment:, id:, private_key:, name: '', allowed_ips: nil)