starkbank 0.0.1

data/lib/payment/boleto/log.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative('../../utils/resource')
+require_relative('../../utils/rest')
+require_relative('../../utils/checks')
+require_relative('boleto')
+
+module StarkBank
+  class BoletoPayment
+    # # BoletoPayment::Log object
+    #
+    # Every time a BoletoPayment entity is modified, a corresponding BoletoPayment::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 BoletoPayment.
+    #
+    # ## Attributes:
+    # - id [string]: unique id returned when the log is created. ex: "5656565656565656"
+    # - payment [BoletoPayment]: BoletoPayment entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this BoletoPayment event.
+    # - type [string]: type of the BoletoPayment event which triggered the log creation. ex: "registered" or "paid"
+    # - created [DateTime]: creation datetime for the payment. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Log < StarkBank::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :payment
+      def initialize(id:, created:, type:, errors:, payment:)
+        super(id)
+        @type = type
+        @errors = errors
+        @payment = payment
+        @created = StarkBank::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific Log
+      #
+      # 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"
+      #
+      # ## 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)
+        StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve Logs
+      #
+      # Receive a generator of Log objects previously created in the Stark Bank API
+      #
+      # ## Parameters (optional):
+      # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+      # - payment_ids [list of strings, default nil]: list of BoletoPayment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
+      # - types [list of strings, default nil]: filter retrieved objects by event types. ex: "paid" or "registered"
+      # - 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, payment_ids: nil, types: nil, user: nil)
+        StarkBank::Utils::Rest.get_list(user: user, limit: limit, payment_ids: payment_ids, types: types, **resource)
+      end
+
+      def self.resource
+        payment_maker = StarkBank::BoletoPayment.resource[:resource_maker]
+        {
+          resource_name: 'BoletoPaymentLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              errors: json['errors'],
+              payment: StarkBank::Utils::API.from_api_json(payment_maker, json['payment'])
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/payment/utility/log.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative('../../utils/resource')
+require_relative('../../utils/rest')
+require_relative('../../utils/checks')
+require_relative('utility')
+
+module StarkBank
+  class UtilityPayment
+    # # UtilityPayment::Log object
+    #
+    # Every time a UtilityPayment entity is modified, a corresponding UtilityPayment::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 UtilityPayment.
+    #
+    # ## Attributes:
+    # - id [string]: unique id returned when the log is created. ex: "5656565656565656"
+    # - payment [UtilityPayment]: UtilityPayment entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this BoletoPayment event.
+    # - type [string]: type of the UtilityPayment event which triggered the log creation. ex: "registered" or "paid"
+    # - created [DateTime]: creation datetime for the payment. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Log < StarkBank::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :payment
+      def initialize(id:, created:, type:, errors:, payment:)
+        super(id)
+        @type = type
+        @errors = errors
+        @payment = payment
+        @created = StarkBank::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific Log
+      #
+      # 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"
+      #
+      # ## 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)
+        StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve Logs
+      #
+      # Receive a generator of Log objects previously created in the Stark Bank API
+      #
+      # ## Parameters (optional):
+      # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+      # - payment_ids [list of strings, default nil]: list of UtilityPayment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
+      # - types [list of strings, default nil]: filter retrieved objects by event types. ex: "paid" or "registered"
+      # - 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, payment_ids: nil, types: nil, user: nil)
+        StarkBank::Utils::Rest.get_list(user: user, limit: limit, payment_ids: payment_ids, types: types, **resource)
+      end
+
+      def self.resource
+        payment_maker = StarkBank::UtilityPayment.resource[:resource_maker]
+        {
+          resource_name: 'UtilityPaymentLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              errors: json['errors'],
+              payment: StarkBank::Utils::API.from_api_json(payment_maker, json['payment'])
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/payment/utility/utility.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require_relative('../../utils/resource')
+require_relative('../../utils/rest')
+require_relative('../../utils/checks')
+
+module StarkBank
+  # # UtilityPayment object
+  #
+  # When you initialize a UtilityPayment, the entity will not be automatically
+  # created in the Stark Bank API. The 'create' function sends the objects
+  # to the Stark Bank API and returns the list of created objects.
+  #
+  # ## Parameters (conditionally required):
+  # - line [string, default nil]: Number sequence that describes the payment. Either 'line' or 'bar_code' parameters are required. If both are sent, they must match. ex: "34191.09008 63571.277308 71444.640008 5 81960000000062"
+  # - bar_code [string, default nil]: Bar code number that describes the payment. Either 'line' or 'barCode' parameters are required. If both are sent, they must match. ex: "34195819600000000621090063571277307144464000"
+  #
+  # ## Parameters (required):
+  # - description [string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC"
+  #
+  # ## Parameters (optional):
+  # - scheduled [Date, default today]: payment scheduled date. ex: Date.new(2020, 3, 10)
+  # - tags [list of strings]: list of strings for tagging
+  #
+  # ## Attributes (return-only):
+  # - id [string, default nil]: unique id returned when payment is created. ex: "5656565656565656"
+  # - status [string, default nil]: current payment status. ex: "registered" or "paid"
+  # - amount [int, default nil]: amount automatically calculated from line or bar_code. ex: 23456 (= R$ 234.56)
+  # - fee [integer, default nil]: fee charged when utility payment is created. ex: 200 (= R$ 2.00)
+  # - created [DateTime, default nil]: creation datetime for the payment. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class UtilityPayment < StarkBank::Utils::Resource
+    attr_reader :description, :line, :bar_code, :tags, :scheduled, :id, :amount, :fee, :status, :created
+    def initialize(description:, line: nil, bar_code: nil, tags: nil, scheduled: nil, id: nil, amount: nil, fee: nil, status: nil, created: nil)
+      super(id)
+      @description = description
+      @line = line
+      @bar_code = bar_code
+      @tags = tags
+      @scheduled = StarkBank::Utils::Checks.check_datetime(scheduled)
+      @amount = amount
+      @fee = fee
+      @status = status
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+    end
+
+    # # Create UtilityPayments
+    #
+    # Send a list of UtilityPayment objects for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - payments [list of UtilityPayment objects]: list of UtilityPayment objects to be created in the API
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - list of UtilityPayment objects with updated attributes
+    def self.create(payments:, user: nil)
+      StarkBank::Utils::Rest.post(entities: payments, user: user, **resource)
+    end
+
+    # # Retrieve a specific UtilityPayment
+    #
+    # Receive a single UtilityPayment object previously created by the Stark Bank API by passing its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: "5656565656565656"
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - UtilityPayment object with updated attributes
+    def self.get(id:, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve a specific UtilityPayment pdf file
+    #
+    # Receive a single UtilityPayment pdf file generated in the Stark Bank API by passing its id.
+    # Only valid for utility payments with "success" status.
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: "5656565656565656"
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - UtilityPayment pdf file
+    def self.pdf(id:, user: nil)
+      StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
+    end
+
+    # # Retrieve UtilityPayments
+    #
+    # Receive a generator of UtilityPayment objects previously created in the Stark Bank API
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - status [string, default nil]: filter for status of retrieved objects. ex: "paid"
+    # - 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)
+    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of UtilityPayment objects with updated attributes
+    def self.query(limit: nil, status: nil, tags: nil, ids: nil, after: nil, before: 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, ids: ids, after: after, before: before, **resource)
+    end
+
+    # # Delete a UtilityPayment entity
+    #
+    # Delete a UtilityPayment entity previously created in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - id [string]: UtilityPayment unique id. ex: "5656565656565656"
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - deleted UtilityPayment with updated attributes
+    def self.delete(id:, user: nil)
+      StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'UtilityPayment',
+        resource_maker: proc { |json|
+          UtilityPayment.new(
+            id: json['id'],
+            description: json['description'],
+            line: json['line'],
+            bar_code: json['bar_code'],
+            tags: json['tags'],
+            scheduled: json['scheduled'],
+            amount: json['amount'],
+            fee: json['fee'],
+            status: json['status'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/starkbank.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative('key')
+require_relative('user/project')
+require_relative('ledger/balance')
+require_relative('ledger/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('webhook/webhook')
+require_relative('webhook/event')
+
+# SDK to facilitate Ruby integrations with Stark Bank
+module StarkBank
+  @user = nil
+  class << self; attr_accessor :user; end
+end

data/lib/transfer/log.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('transfer')
+
+module StarkBank
+  class Transfer
+    # # Transfer::Log object
+    #
+    # Every time a Transfer entity is modified, a corresponding Transfer::Log
+    # is generated for the entity. This log is never generated by the
+    # user.
+    #
+    # ## Attributes:
+    # - 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)
+    class Log < StarkBank::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :transfer
+      def initialize(id:, created:, type:, errors:, transfer:)
+        super(id)
+        @type = type
+        @errors = errors
+        @transfer = transfer
+        @created = StarkBank::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific Log
+      #
+      # 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"
+      #
+      # ## 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)
+        StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve Logs
+      #
+      # Receive a generator of Log objects previously created in the Stark Bank API
+      #
+      # ## Parameters (optional):
+      # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+      # - 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)
+      # - 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)
+        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)
+      end
+
+      def self.resource
+        transfer_maker = StarkBank::Transfer.resource[:resource_maker]
+        {
+          resource_name: 'TransferLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              errors: json['errors'],
+              transfer: StarkBank::Utils::API.from_api_json(transfer_maker, json['transfer'])
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/transfer/transfer.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # Transfer object
+  #
+  # When you initialize a Transfer, the entity will not be automatically
+  # created in the Stark Bank API. The 'create' function sends the objects
+  # to the Stark Bank API and returns the list of created objects.
+  #
+  # ## Parameters (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"
+  #
+  # ## Parameters (optional):
+  # - 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"
+  # - 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"]
+  # - 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
+    attr_reader :amount, :name, :tax_id, :bank_code, :branch_code, :account_number, :transaction_ids, :fee, :tags, :status, :id, :created, :updated
+    def initialize(amount:, name:, tax_id:, bank_code:, branch_code:, account_number:, transaction_ids: nil, fee: nil, tags: nil, status: nil, id: nil, created: nil, updated: nil)
+      super(id)
+      @amount = amount
+      @name = name
+      @tax_id = tax_id
+      @bank_code = bank_code
+      @branch_code = branch_code
+      @account_number = account_number
+      @transaction_ids = transaction_ids
+      @fee = fee
+      @tags = tags
+      @status = status
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+      @updated = StarkBank::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create Transfers
+    #
+    # Send a list of Transfer objects for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - 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
+    #
+    # ## Return:
+    # - list of Transfer objects with updated attributes
+    def self.create(transfers:, user: nil)
+      StarkBank::Utils::Rest.post(entities: transfers, user: user, **resource)
+    end
+
+    # # Retrieve a specific Transfer
+    #
+    # 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"
+    #
+    # ## 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)
+      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.
+    #
+    # ## Parameters (required):
+    # - 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)
+      StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
+    end
+
+    # # Retrieve Transfers
+    #
+    # Receive a generator of Transfer objects previously created in the Stark Bank API
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - 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)
+    # - 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)
+      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)
+    end
+
+    def self.resource
+      {
+        resource_name: 'Transfer',
+        resource_maker: proc { |json|
+          Transfer.new(
+            id: json['id'],
+            amount: json['amount'],
+            name: json['name'],
+            tax_id: json['tax_id'],
+            bank_code: json['bank_code'],
+            branch_code: json['branch_code'],
+            account_number: json['account_number'],
+            transaction_ids: json['transaction_ids'],
+            fee: json['fee'],
+            tags: json['tags'],
+            status: json['status'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/user/project.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+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,
+  # 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
+  # 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"
+  #
+  # ## 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-----"
+  class Project < StarkBank::User
+    attr_reader :name, :allowed_ips
+    def initialize(environment:, id:, private_key:, name: '', allowed_ips: nil)
+      super(environment, id, private_key)
+      @name = name
+      @allowed_ips = allowed_ips
+    end
+  end
+end

data/lib/user/user.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require('starkbank-ecdsa')
+require_relative('../utils/resource')
+require_relative('../utils/checks')
+
+module StarkBank
+  class User < StarkBank::Utils::Resource
+    attr_reader :pem, :environment
+    def initialize(environment, id, private_key)
+      super(id)
+      @pem = StarkBank::Utils::Checks.check_private_key(private_key)
+      @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
+  end
+end

data/lib/utils/api.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative('case')
+
+module StarkBank
+  module Utils
+    module API
+      def self.api_json(entity)
+        entity_hash = {}
+        entity.instance_variables.each do |key|
+          entity_hash[key[1..-1]] = entity.instance_variable_get(key)
+        end
+        cast_json_to_api_format(entity_hash)
+      end
+
+      def self.cast_json_to_api_format(hash)
+        entity_hash = {}
+        hash.each do |key, value|
+          next if value.nil?
+
+          value = value.is_a?(Date) || value.is_a?(DateTime) || value.is_a?(Time) ? value.strftime('%Y-%m-%d') : value
+          entity_hash[StarkBank::Utils::Case.snake_to_camel(key)] = value
+        end
+        entity_hash
+      end
+
+      def self.from_api_json(resource_maker, json)
+        snakes = {}
+        json.each do |key, value|
+          snakes[StarkBank::Utils::Case.camel_to_snake(key)] = value
+        end
+        resource_maker.call(snakes)
+      end
+
+      def self.endpoint(resource_name)
+        kebab = StarkBank::Utils::Case.camel_to_kebab(resource_name)
+        kebab.sub!('-log', '/log')
+        kebab
+      end
+
+      def self.last_name_plural(resource_name)
+        "#{last_name(resource_name)}s"
+      end
+
+      def self.last_name(resource_name)
+        StarkBank::Utils::Case.camel_to_kebab(resource_name).split('-').last
+      end
+    end
+  end
+end