starkinfra 0.0.1 → 0.1.0

data/lib/pixstatement/pixstatement.rb

@@ -12,17 +12,16 @@ module StarkInfra
   # accessed by the user. This feature is only available for direct participants.
   #
   # ## Parameters (required):
-  # - after [Date, DateTime, Time or string]: transactions that happened at this date are stored in the PixStatement, must be the same as before. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  # - before [Date, DateTime, Time or string]: transactions that happened at this date are stored in the PixStatement, must be the same as after. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  # - type [string]: types of entities to include in statement. Options: ["interchange", "interchangeTotal", "transaction"]
+  # - after [Date or string]: transactions that happened at this date are stored in the PixStatement, must be the same as before. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - before [Date or string]: transactions that happened at this date are stored in the PixStatement, must be the same as after. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - type [string]: type of entities to include in statement. Options: 'interchange', 'interchangeTotal', 'transaction'
   #
   # ## Attributes (return-only):
-  # - id [string, default nil]: unique id returned when the PixStatement is created. ex: "5656565656565656"
-  # - status [string, default nil]: current PixStatement status. ex: "success" or "failed"
-  # - transaction_count [integer]: number of transactions that happened during the day that the PixStatement was requested. ex 11
-  # - created [Datetime, default nil]: creation datetime for the PixStatement. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  # - updated [Datetime, default nil]: latest update datetime for the PixStatement. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  
+  # - id [string]: unique id returned when the PixStatement is created. ex: '5656565656565656'
+  # - status [string]: current PixStatement status. ex: 'success' or 'failed'
+  # - transaction_count [integer]: number of transactions that happened during the day that the PixStatement was requested. ex: 11
+  # - created [DateTime]: creation datetime for the PixStatement. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the PixStatement. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class PixStatement < StarkInfra::Utils::Resource
     attr_reader :after, :before, :type, :id, :status, :transaction_count, :created, :updated
     def initialize(after:, before:, type:, id: nil, status: nil, transaction_count: nil, created: nil, updated: nil)
@@ -40,11 +39,11 @@ module StarkInfra
     #
     # Create a PixStatements linked to your workspace in the Stark Infra API
     # 
-    # ## Parameters (requiered):
+    # ## Parameters (required):
     # - statement [PixStatement object]: PixStatement object to be created in the API.
     #
     # ## Parameters (optional):
-    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
     # - PixStatement object with updated attributes.
@@ -52,18 +51,18 @@ module StarkInfra
       StarkInfra::Utils::Rest.post_single(entity: statement, user: user, **resource)
     end
 
-    # # Retrieve a specific PixStatment object
+    # # Retrieve a specific PixStatement object
     #
-    # Receive a single PixStatment object previously created in the Stark Infra API by passing its id
+    # Receive a single PixStatement object previously created in the Stark Infra 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 StarkInfra.user was set before function call
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - PixStatment object with updated attributes
+    # - PixStatement object with updated attributes
     def self.get(id, user: nil)
       StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
     end
@@ -75,7 +74,7 @@ module StarkInfra
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
     # - 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 StarkInfra.user was set before function call
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
     # - generator of PixStatement objects with updated attributes
@@ -91,19 +90,19 @@ module StarkInfra
     # # Retrieve paged PixStatements
     #
     # Receive a list of up to 100 PixStatements objects previously created in the Stark infra API and the cursor to the next page.
-    # Use this function instead of query if you want to manually page your requests.
+    # Use this function instead of query if you want to manually page your statements.
     #
     # ## Parameters (optional):
     # - cursor [string, default nil]: cursor returned on the previous page function call
-    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
     # - 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 StarkInfra.user was set before function call
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
     # - list of PixStatement objects with updated attributes
-    # - Cursor to retrieve the next page of PixStatement objects
+    # - cursor to retrieve the next page of PixStatement objects
     def self.page(cursor: nil, limit: nil, ids: nil, user: nil)
-      return StarkInfra::Utils::Rest.get_page(
+      StarkInfra::Utils::Rest.get_page(
         cursor: cursor,
         limit: limit,
         ids: ids,
@@ -117,15 +116,15 @@ module StarkInfra
     # Retrieve a specific PixStatement by its ID in a .csv file.
     #
     # ## Parameters (required):
-    # - id [string]: object unique id. ex: "5656565656565656"
+    # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
     # - PixStatement .csv file
     def self.csv(id, user: nil)
-      return StarkInfra::Utils::Rest.get_content(id: id, user: user, sub_resource_name: "csv", **resource)
+      StarkInfra::Utils::Rest.get_content(id: id, user: user, sub_resource_name: 'csv', **resource)
     end
 
     def self.resource
@@ -140,7 +139,7 @@ module StarkInfra
             status: json['status'],
             transaction_count: json['transaction_count'],
             created: json['created'],
-            updated: json['updated'],
+            updated: json['updated']
           )
         }
       }

data/lib/starkinfra.rb

@@ -1,19 +1,48 @@
 # frozen_string_literal: true
 
-require('starkbank')
 require_relative('key')
-require_relative('workspace/workspace')
+require_relative('user/project')
+require_relative('user/organization')
+require_relative('issuingauthorization/issuingauthorization')
+require_relative('issuingbalance/issuingbalance')
+require_relative('issuingbin/issuingbin')
+require_relative('issuingcard/issuingcard')
+require_relative('issuingcard/log')
+require_relative('issuingholder/issuingholder')
+require_relative('issuingholder/log')
+require_relative('issuinginvoice/issuinginvoice')
+require_relative('issuinginvoice/log')
+require_relative('issuingpurchase/issuingpurchase')
+require_relative('issuingpurchase/log')
+require_relative('issuingtransaction/issuingtransaction')
+require_relative('issuingwithdrawal/issuingwithdrawal')
+require_relative('issuingrule/issuingrule')
 require_relative('pixrequest/pixrequest')
 require_relative('pixrequest/log')
 require_relative('pixreversal/pixreversal')
 require_relative('pixreversal/log')
 require_relative('pixbalance/pixbalance')
 require_relative('pixstatement/pixstatement')
+require_relative('pixinfraction/pixinfraction')
+require_relative('pixinfraction/log')
+require_relative('pixchargeback/pixchargeback')
+require_relative('pixchargeback/log')
+require_relative('pixkey/pixkey')
+require_relative('pixkey/log')
+require_relative('pixclaim/pixclaim')
+require_relative('pixclaim/log')
+require_relative('pixdomain/pixdomain')
+require_relative('pixdirector/pixdirector')
+require_relative('webhook/webhook')
 require_relative('event/event')
+require_relative('event/attempt')
+require_relative('utils/endtoendid')
+require_relative('utils/returnid')
+require_relative('creditnote/creditnote')
+require_relative('creditnote/log')
 
 # SDK to facilitate Ruby integrations with Stark Infra
 module StarkInfra
-  include StarkBank
   @user = nil
   @language = 'en-US'
   class << self; attr_accessor :user, :language; end

data/lib/user/organization.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative('user')
+
+module StarkInfra
+  # # 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 Infra API must be authenticated via an SDK user,
+  # which must have been previously created at the Stark Infra website
+  # [https://web.sandbox.starkinfra.com] or [https://web.starkinfra.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 < StarkInfra::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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative('user')
+
+module StarkInfra
+  # # Project object
+  #
+  # The Project object is an authentication entity for the SDK that is permanently
+  # linked to a specific Workspace.
+  # All requests to the Stark Infra API must be authenticated via an SDK user,
+  # which must have been previously created at the Stark Infra website
+  # [https://web.sandbox.starkinfra.com] or [https://web.starkinfra.com]
+  # 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 [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'
+  # - 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 < StarkInfra::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
+
+    def access_id
+      "project/#{@id}"
+    end
+  end
+end

data/lib/user/user.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require('starkbank-ecdsa')
+require_relative('../utils/resource')
+
+module StarkInfra
+  class User < StarkInfra::Utils::Resource
+    attr_reader :pem, :environment
+    def initialize(environment, id, private_key)
+      require_relative('../utils/checks')
+      super(id)
+      @pem = StarkInfra::Utils::Checks.check_private_key(private_key)
+      @environment = StarkInfra::Utils::Checks.check_environment(environment)
+    end
+
+    def private_key
+      EllipticCurve::PrivateKey.fromPem(@pem)
+    end
+  end
+end

data/lib/utils/api.rb

@@ -41,7 +41,15 @@ module StarkInfra
 
         list = []
         value.each do |v|
-          list << (v.is_a?(Hash) ? cast_json_to_api_format(v) : v)
+          if v.is_a?(Hash)
+            list << cast_json_to_api_format(v)
+            next
+          end
+          if v.is_a?(SubResource)
+            list << api_json(v)
+            next
+          end
+          list << v
         end
         list
       end
@@ -51,7 +59,7 @@ module StarkInfra
         json.each do |key, value|
           snakes[StarkInfra::Utils::Case.camel_to_snake(key)] = value
         end
-      
+
         resource_maker.call(snakes)
       end
 

data/lib/utils/bacenid.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: false
+
+require('date')
+
+module StarkInfra
+  module Utils
+    module BacenId
+      def self._create(bank_code)
+        random_source = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890'.split('')
+        random_string = ''
+
+        11.times do
+          random_string << random_source[rand(random_source.length)]
+        end
+        bank_code + DateTime.now.strftime('%Y%m%d%H%M') << random_string
+      end
+    end
+  end
+end

data/lib/utils/checks.rb

@@ -2,14 +2,13 @@
 
 require('date')
 require('starkbank-ecdsa')
-require('starkbank')
 require_relative('environment')
 
 module StarkInfra
   module Utils
     class Checks
       def self.check_user(user)
-        return user if user.is_a?(StarkBank::User)
+        return user if user.is_a?(StarkInfra::User)
 
         user = user.nil? ? StarkInfra.user : user
         raise(ArgumentError, 'A user is required to access our API. Check our README: https://github.com/starkinfra/sdk-ruby/') if user.nil?
@@ -90,7 +89,7 @@ module StarkInfra
           end
 
           begin
-            return [DateTime.strptime(data, '%Y-%m-%d'), 'date']
+            [DateTime.strptime(data, '%Y-%m-%d'), 'date']
           rescue ArgumentError
             raise(ArgumentError, 'invalid datetime string ' + data)
           end

data/lib/utils/endtoendid.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: false
+
+require_relative('bacenid')
+
+module StarkInfra
+  module EndToEndId
+    def self.create(bank_code)
+      'E' << StarkInfra::Utils::BacenId._create(bank_code)
+    end
+  end
+end

data/lib/utils/parse.rb

@@ -5,28 +5,30 @@ require('starkbank-ecdsa')
 require_relative('api')
 require_relative('cache')
 require_relative('request')
-require_relative('../error')\
-
+require_relative('../error')
 
 module StarkInfra
   module Utils
     module Parse
       def self.parse_and_verify(content:, signature:, user: nil, resource:, key: nil)
-        event = StarkInfra::Utils::API.from_api_json(resource[:resource_maker], JSON.parse(content))
-        if key != nil
-          event = StarkInfra::Utils::API.from_api_json(resource[:resource_maker], JSON.parse(content)[key])
-        end
+        json = JSON.parse(content)
+        json = JSON.parse(content)[key] unless key.nil?
+        event = StarkInfra::Utils::API.from_api_json(resource[:resource_maker], json)
 
         begin
           signature = EllipticCurve::Signature.fromBase64(signature)
         rescue
           raise(StarkInfra::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)
-  
+
+        if verify_signature(content: content, signature: signature, user: user)
+          return event
+        end
+
+        if verify_signature(content: content, signature: signature, user: user, refresh: true)
+          return event
+        end
+
         raise(StarkInfra::Error::InvalidSignatureError, 'The provided signature and content do not match the Stark Infra public key')
       end
 
@@ -46,5 +48,3 @@ module StarkInfra
     end
   end
 end
-
-

data/lib/utils/request.rb

@@ -28,7 +28,7 @@ module StarkInfra
 
         base_url = {
           Environment::PRODUCTION => 'https://api.starkinfra.com/',
-          Environment::SANDBOX => 'https://sandbox.api.starkinfra.com/',
+          Environment::SANDBOX => 'https://sandbox.api.starkinfra.com/'
         }[user.environment] + 'v2'
 
         url = "#{base_url}/#{path}#{StarkInfra::Utils::URL.urlencode(query)}"
@@ -61,7 +61,7 @@ module StarkInfra
         req['Access-Time'] = access_time
         req['Access-Signature'] = signature
         req['Content-Type'] = 'application/json'
-        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-2.6.0"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-Infra-0.1.0"
         req['Accept-Language'] = language
 
         request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }

data/lib/utils/rest.rb

@@ -50,26 +50,26 @@ module StarkInfra
         end
       end
 
-      def self.get_id(resource_name:, resource_maker:, id:, user: nil)
+      def self.get_id(resource_name:, resource_maker:, id:, user: nil, **query)
         json = StarkInfra::Utils::Request.fetch(
           method: 'GET',
           path: "#{StarkInfra::Utils::API.endpoint(resource_name)}/#{id}",
+          query: query,
           user: user
         ).json
         entity = json[StarkInfra::Utils::API.last_name(resource_name)]
         StarkInfra::Utils::API.from_api_json(resource_maker, entity)
       end
 
-      def self.get_content(resource_name:, resource_maker:, sub_resource_name:, id:, user: nil, **query)
+      def self.get_content(resource_name:, sub_resource_name:, id:, user: nil)
         StarkInfra::Utils::Request.fetch(
           method: 'GET',
           path: "#{StarkInfra::Utils::API.endpoint(resource_name)}/#{id}/#{sub_resource_name}",
-          query: StarkInfra::Utils::API.cast_json_to_api_format(query),
           user: user
         ).content
       end
 
-      def self.post(resource_name:, resource_maker:, entities:, user: nil)
+      def self.post(resource_name:, resource_maker:, entities:, user: nil, **query)
         jsons = []
         entities.each do |entity|
           jsons << StarkInfra::Utils::API.api_json(entity)
@@ -79,6 +79,7 @@ module StarkInfra
           method: 'POST',
           path: StarkInfra::Utils::API.endpoint(resource_name),
           payload: payload,
+          query: query,
           user: user
         ).json
         returned_jsons = json[StarkInfra::Utils::API.last_name_plural(resource_name)]
@@ -126,7 +127,7 @@ module StarkInfra
           method: 'GET',
           path: "#{StarkInfra::Utils::API.endpoint(resource_name)}/#{id}/#{StarkInfra::Utils::API.endpoint(sub_resource_name)}",
           user: user,
-          query: StarkInfra::Utils::API.cast_json_to_api_format(query)
+          query: query
         ).json
         entity = json[StarkInfra::Utils::API.last_name(sub_resource_name)]
         StarkInfra::Utils::API.from_api_json(sub_resource_maker, entity)

data/lib/utils/returnid.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: false
+
+require_relative('bacenid')
+
+module StarkInfra
+  module ReturnId
+    def self.create(bank_code)
+      'D' << StarkInfra::Utils::BacenId._create(bank_code)
+    end
+  end
+end

data/lib/webhook/webhook.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkInfra
+  # # Webhook subscription object
+  #
+  # A Webhook is used to subscribe to notification events on a user-selected endpoint.
+  # Currently available services for subscription are contract, credit-note, signer, issuing-card, issuing-invoice, issuing-purchase, pix-request.in, pix-request.out, pix-reversal.in, pix-reversal.out, pix-claim, pix-key, pix-chargeback, pix-infraction.
+  #
+  # ## 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: ['contract', 'credit-note', 'signer', 'issuing-card', 'issuing-invoice', 'issuing-purchase', 'pix-request.in', 'pix-request.out', 'pix-reversal.in', 'pix-reversal.out', 'pix-claim', 'pix-key', 'pix-chargeback', 'pix-infraction']
+  #
+  # ## Attributes:
+  # - id [string]: unique id returned when the webhook is created. ex: '5656565656565656'
+  class Webhook < StarkInfra::Utils::Resource
+    attr_reader :url, :subscriptions, :id
+    def initialize(url:, subscriptions:, id: nil)
+      super(id)
+      @url = url
+      @subscriptions = subscriptions
+    end
+
+    # # Create Webhook subscription
+    #
+    # Send a single Webhook subscription for creation in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - webhook [Webhook object or hash]: Webhook subscription to be created to receive Events. ex: Webhook.new()
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - Webhook object with updated attributes
+    def self.create(webhook, user: nil)
+      StarkInfra::Utils::Rest.post_single(entity: webhook, user: user, **resource)
+    end
+
+    # # Retrieve a specific Webhook subscription
+    #
+    # Receive a single Webhook subscription object previously created in the Stark Infra API by passing its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - Webhook object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve Webhook subscriptions
+    #
+    # Receive a generator of Webhook subscription objects previously created in the Stark Infra API
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of Webhook objects with updated attributes
+    def self.query(limit: nil, user: nil)
+      StarkInfra::Utils::Rest.get_stream(user: user, limit: limit, **resource)
+    end
+
+    # # Retrieve paged Webhooks
+    #
+    # Receive a list of up to 100 Webhook objects previously created in the Stark Infra API and the cursor to the next page.
+    # Use this function instead of query if you want to manually page your requests.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call
+    # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of Webhook objects with updated attributes
+    # - cursor to retrieve the next page of Webhook objects
+    def self.page(cursor: nil, limit: nil, user: nil)
+      return StarkInfra::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Delete a Webhook entity
+    #
+    # Delete a Webhook entity previously created in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - id [string]: Webhook unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - deleted Webhook object
+    def self.delete(id, user: nil)
+      StarkInfra::Utils::Rest.delete_id(id: id, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'Webhook',
+        resource_maker: proc { |json|
+          Webhook.new(
+            id: json['id'],
+            url: json['url'],
+            subscriptions: json['subscriptions']
+          )
+        }
+      }
+    end
+  end
+end