hookbridge 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b5c43ea6d4f602bbe765fda06433a5dba02afd8907b36bd3911934315ed75a7
-  data.tar.gz: d83dfdab5ae8ccc6e17a7743ad4c653787c27889eeea6d4f4856de1300fbd838
+  metadata.gz: 3eb78782e81c381238fa55e447688e3e58b437d1aeb531629b0c6d8388149f9b
+  data.tar.gz: 2343289ec20d2df8397137e7281dcce2d0d1920c1f1fad8e606071000c0eb26e
 SHA512:
-  metadata.gz: ce5a62d25e7ed153478d173afa953fcc38f639f3be61ed1d09229d1601a30361173bf80532bf8a5eeb4357faba22f07cc890412f7d9eb7280beef9ab60a52a27
-  data.tar.gz: 53c666698c37c8500059f98e6dde44bb72e90caffcadaa5211cd6eeb011bdedc8d3a72103bd9c6999ec501215bf827f00438172ca50de958e7b90c732889751b
+  metadata.gz: ddb04a28ba7ed43bfa39ed780e7d193793335498d8f9f40835720d05951395ebc78f6b1df4bfae9467a1c42fc8e573404c5742f77b2295391f26c03954bbf842
+  data.tar.gz: 439ffca58ae0d59f14f19efc0e7021279a4938152e2807e6a543cca6a7dc5597764d641072b5ef61a2a261981032232342a06a3bb2a2d4a1bdc7b60caa3744d2

data/lib/hookbridge/client.rb

@@ -224,6 +224,122 @@ module HookBridge
       create_endpoint_signing_key(endpoint_id)
     end
 
+    def create_pull_endpoint(name: nil, description: nil, retention_days: nil, event_type_source: nil, event_type_path: nil,
+                             verify_static_token: nil, token_header_name: nil, token_query_param: nil, token_value: nil,
+                             verify_hmac: nil, hmac_header_name: nil, hmac_secret: nil, timestamp_header_name: nil,
+                             timestamp_ttl_seconds: nil, verify_ip_allowlist: nil, allowed_cidrs: nil,
+                             idempotency_header_names: nil, ingest_response_code: nil)
+      body = compact_hash(
+        name: name,
+        description: description,
+        retention_days: retention_days,
+        event_type_source: event_type_source,
+        event_type_path: event_type_path,
+        verify_static_token: verify_static_token,
+        token_header_name: token_header_name,
+        token_query_param: token_query_param,
+        token_value: token_value,
+        verify_hmac: verify_hmac,
+        hmac_header_name: hmac_header_name,
+        hmac_secret: hmac_secret,
+        timestamp_header_name: timestamp_header_name,
+        timestamp_ttl_seconds: timestamp_ttl_seconds,
+        verify_ip_allowlist: verify_ip_allowlist,
+        allowed_cidrs: allowed_cidrs,
+        idempotency_header_names: idempotency_header_names,
+        ingest_response_code: ingest_response_code
+      )
+      CreatePullEndpointResponse.new(extract_data(request(:post, "/v1/pull-endpoints", body)))
+    end
+
+    def list_pull_endpoints(limit: nil, cursor: nil)
+      params = {}
+      params[:limit] = limit if limit
+      params[:cursor] = cursor if cursor
+      response = request(:get, "/v1/pull-endpoints", nil, params)
+      ListPullEndpointsResponse.new(
+        "data" => extract_data(response),
+        "next_cursor" => extract_meta(response)["next_cursor"] || response["next_cursor"]
+      )
+    end
+
+    def get_pull_endpoint(endpoint_id)
+      PullEndpoint.new(extract_data(request(:get, "/v1/pull-endpoints/#{endpoint_id}")))
+    end
+
+    def update_pull_endpoint(endpoint_id, **attributes)
+      PullEndpoint.new(extract_data(request(:patch, "/v1/pull-endpoints/#{endpoint_id}", compact_hash(attributes))))
+    end
+
+    def delete_pull_endpoint(endpoint_id)
+      DeleteResult.new(extract_data(request(:delete, "/v1/pull-endpoints/#{endpoint_id}")))
+    end
+
+    def pause_pull_endpoint(endpoint_id)
+      PauseState.new(extract_data(request(:post, "/v1/pull-endpoints/#{endpoint_id}/pause")))
+    end
+
+    def resume_pull_endpoint(endpoint_id)
+      PauseState.new(extract_data(request(:post, "/v1/pull-endpoints/#{endpoint_id}/resume")))
+    end
+
+    def list_pull_events(endpoint_id, status: nil, event_type: nil, since: nil, before: nil, limit: nil, cursor: nil)
+      params = {}
+      params[:status] = status if status
+      params[:event_type] = event_type if event_type
+      params[:since] = format_time(since) if since
+      params[:before] = format_time(before) if before
+      params[:limit] = limit if limit
+      params[:cursor] = cursor if cursor
+      response = request(:get, "/v1/pull-endpoints/#{endpoint_id}/events", nil, params)
+      ListPullEventsResponse.new(
+        "data" => extract_data(response),
+        "has_more" => extract_meta(response)["has_more"] || response["has_more"],
+        "next_cursor" => extract_meta(response)["next_cursor"] || response["next_cursor"]
+      )
+    end
+
+    def get_pull_event(endpoint_id, event_id, preview: false)
+      params = {}
+      params[:preview] = "true" if preview
+      PullEventDetail.new(extract_data(request(:get, "/v1/pull-endpoints/#{endpoint_id}/events/#{event_id}", nil, params)))
+    end
+
+    def ack_pull_events(endpoint_id, event_ids)
+      AckPullEventsResponse.new(
+        extract_data(request(:post, "/v1/pull-endpoints/#{endpoint_id}/events/ack", { event_ids: event_ids }))
+      )
+    end
+
+    def get_pull_logs(pull_endpoint_id: nil, status: nil, event_type: nil, start_time: nil, end_time: nil, limit: nil, cursor: nil)
+      params = {}
+      params[:pull_endpoint_id] = pull_endpoint_id if pull_endpoint_id
+      params[:status] = status if status
+      params[:event_type] = event_type if event_type
+      params[:start_time] = format_time(start_time) if start_time
+      params[:end_time] = format_time(end_time) if end_time
+      params[:limit] = limit if limit
+      params[:cursor] = cursor if cursor
+      response = request(:get, "/v1/pull-logs", nil, params)
+      PullLogsResponse.new(
+        "data" => extract_data(response),
+        "has_more" => extract_meta(response)["has_more"] || response["has_more"],
+        "next_cursor" => extract_meta(response)["next_cursor"] || response["next_cursor"]
+      )
+    end
+
+    def get_pull_metrics(window: MetricsWindow::TWENTY_FOUR_HOURS, pull_endpoint_id: nil)
+      params = { window: window }
+      params[:pull_endpoint_id] = pull_endpoint_id if pull_endpoint_id
+      Metrics.new(extract_data(request(:get, "/v1/pull-metrics", nil, params)))
+    end
+
+    def get_pull_timeseries_metrics(window: MetricsWindow::TWENTY_FOUR_HOURS, pull_endpoint_id: nil)
+      params = { window: window }
+      params[:pull_endpoint_id] = pull_endpoint_id if pull_endpoint_id
+      PullTimeSeriesMetrics.new(extract_data(request(:get, "/v1/pull-metrics/timeseries", nil, params)))
+    end
+
     def create_checkout(plan:, interval:)
       CheckoutSession.new(extract_data(request(:post, "/v1/billing/checkout", { plan: plan, interval: interval })))
     end
@@ -305,6 +421,21 @@ module HookBridge
       PauseState.new(extract_data(request(:post, "/v1/inbound-endpoints/#{endpoint_id}/resume")))
     end
 
+    def create_inbound_signing_key(endpoint_id)
+      RotateSecretResponse.new(extract_data(request(:post, "/v1/inbound-endpoints/#{endpoint_id}/signing-keys")))
+    end
+
+    def list_inbound_signing_keys(endpoint_id)
+      extract_data(request(:get, "/v1/inbound-endpoints/#{endpoint_id}/signing-keys")).map do |entry|
+        SigningKey.new(entry)
+      end
+    end
+
+    def delete_inbound_signing_key(endpoint_id, key_id)
+      request(:delete, "/v1/inbound-endpoints/#{endpoint_id}/signing-keys/#{key_id}")
+      true
+    end
+
     def listen_inbound_endpoint(endpoint_id, after: nil)
       params = {}
       params[:after] = after if after
@@ -405,6 +536,73 @@ module HookBridge
       true
     end
 
+    def delete_message(message_id)
+      DeleteMessageResult.new(extract_data(request(:delete, "/v1/messages/#{message_id}")))
+    end
+
+    def delete_messages_batch(message_ids)
+      DeleteBatchResult.new(
+        extract_data(request(:post, "/v1/messages/delete-batch", { message_ids: message_ids }))
+      )
+    end
+
+    def delete_messages_all(status: nil, endpoint_id: nil, created_after: nil, created_before: nil, limit: nil)
+      params = {}
+      params[:status] = status if status
+      params[:endpoint_id] = endpoint_id if endpoint_id
+      params[:created_after] = format_time(created_after) if created_after
+      params[:created_before] = format_time(created_before) if created_before
+      params[:limit] = limit if limit
+      DeleteAllResult.new(request(:post, "/v1/messages/delete-all", nil, params))
+    end
+
+    def delete_inbound_message(message_id)
+      DeleteMessageResult.new(extract_data(request(:delete, "/v1/inbound-messages/#{message_id}")))
+    end
+
+    def delete_inbound_messages_batch(message_ids)
+      DeleteBatchResult.new(
+        extract_data(request(:post, "/v1/inbound-messages/delete-batch", { message_ids: message_ids }))
+      )
+    end
+
+    def delete_inbound_messages_all(status: nil, inbound_endpoint_id: nil, received_after: nil, received_before: nil, limit: nil)
+      params = {}
+      params[:status] = status if status
+      params[:inbound_endpoint_id] = inbound_endpoint_id if inbound_endpoint_id
+      params[:received_after] = format_time(received_after) if received_after
+      params[:received_before] = format_time(received_before) if received_before
+      params[:limit] = limit if limit
+      DeleteAllResult.new(request(:post, "/v1/inbound-messages/delete-all", nil, params))
+    end
+
+    def delete_pull_event(endpoint_id, event_id)
+      DeleteEventResult.new(extract_data(request(:delete, "/v1/pull-endpoints/#{endpoint_id}/events/#{event_id}")))
+    end
+
+    def delete_pull_events_batch(endpoint_id, event_ids)
+      DeleteEventBatchResult.new(
+        extract_data(request(:post, "/v1/pull-endpoints/#{endpoint_id}/events/delete-batch", { message_ids: event_ids }))
+      )
+    end
+
+    def delete_pull_events_all(endpoint_id, status: nil, event_type: nil, received_after: nil, received_before: nil, limit: nil)
+      params = {}
+      params[:status] = status if status
+      params[:event_type] = event_type if event_type
+      params[:received_after] = format_time(received_after) if received_after
+      params[:received_before] = format_time(received_before) if received_before
+      params[:limit] = limit if limit
+      DeletePullEventsAllResult.new(request(:post, "/v1/pull-endpoints/#{endpoint_id}/events/delete-all", nil, params))
+    end
+
+    def lookup_actors(user_ids: nil, api_key_ids: nil)
+      params = {}
+      params[:user_id] = user_ids.join(",") if user_ids && !user_ids.empty?
+      params[:api_key_id] = api_key_ids.join(",") if api_key_ids && !api_key_ids.empty?
+      ActorLookupResult.new(extract_data(request(:get, "/v1/actors/lookup", nil, params)))
+    end
+
     private
 
     def build_connection(url)

data/lib/hookbridge/types.rb

@@ -75,13 +75,13 @@ module HookBridge
 
   class Message < BaseModel
     def initialize(data)
-      super(data, time_fields: %w[next_attempt_at created_at updated_at])
+      super(data, time_fields: %w[next_attempt_at created_at updated_at deleted_at])
     end
   end
 
   class MessageSummary < BaseModel
     def initialize(data)
-      super(data, time_fields: %w[created_at delivered_at next_attempt_at])
+      super(data, time_fields: %w[created_at delivered_at next_attempt_at deleted_at])
     end
   end
 
@@ -283,6 +283,21 @@ module HookBridge
     end
   end
 
+  class PullTimeSeriesBucket < BaseModel
+    def initialize(data)
+      super(data, time_fields: %w[timestamp])
+    end
+  end
+
+  class PullTimeSeriesMetrics
+    attr_reader :window, :buckets
+
+    def initialize(data)
+      @window = data["window"]
+      @buckets = (data["buckets"] || []).map { |entry| PullTimeSeriesBucket.new(entry) }
+    end
+  end
+
   class SubscriptionLimits < BaseModel
   end
 
@@ -357,9 +372,89 @@ module HookBridge
   class PauseState < BaseModel
   end
 
+  class PullEndpointCounts < BaseModel
+  end
+
+  class PullEndpoint < BaseModel
+    def initialize(data)
+      attributes = (data || {}).dup
+      attributes["counts"] = PullEndpointCounts.new(attributes["counts"]) if attributes["counts"].is_a?(Hash)
+      super(attributes, time_fields: %w[created_at updated_at])
+    end
+  end
+
+  class CreatePullEndpointResponse < PullEndpoint
+  end
+
+  class PullEndpointSummary < BaseModel
+    def initialize(data)
+      super(data, time_fields: %w[created_at])
+    end
+  end
+
+  class ListPullEndpointsResponse
+    attr_reader :endpoints, :has_more, :next_cursor
+
+    def initialize(data)
+      @endpoints = (data["data"] || data || []).map { |entry| PullEndpointSummary.new(entry) }
+      @has_more = !data["next_cursor"].nil? && data["next_cursor"] != ""
+      @next_cursor = data["next_cursor"]
+    end
+  end
+
+  class PullTimingBreakdown < BaseModel
+  end
+
+  class PullEventSummary < BaseModel
+    def initialize(data)
+      attributes = (data || {}).dup
+      attributes["timing"] = PullTimingBreakdown.new(attributes["timing"]) if attributes["timing"].is_a?(Hash)
+      super(attributes, time_fields: %w[received_at fetched_at delivered_at deleted_at])
+    end
+  end
+
+  class PullEventDetail < BaseModel
+    def initialize(data)
+      attributes = (data || {}).dup
+      attributes["timing"] = PullTimingBreakdown.new(attributes["timing"]) if attributes["timing"].is_a?(Hash)
+      super(attributes, time_fields: %w[received_at fetched_at delivered_at deleted_at])
+    end
+  end
+
+  class ListPullEventsResponse
+    attr_reader :events, :has_more, :next_cursor
+
+    def initialize(data)
+      @events = (data["data"] || data || []).map { |entry| PullEventSummary.new(entry) }
+      @has_more = data["has_more"] || false
+      @next_cursor = data["next_cursor"]
+    end
+  end
+
+  class AckPullEventsResponse < BaseModel
+  end
+
+  class PullLogEntry < BaseModel
+    def initialize(data)
+      attributes = (data || {}).dup
+      attributes["timing"] = PullTimingBreakdown.new(attributes["timing"]) if attributes["timing"].is_a?(Hash)
+      super(attributes, time_fields: %w[received_at fetched_at delivered_at deleted_at])
+    end
+  end
+
+  class PullLogsResponse
+    attr_reader :entries, :has_more, :next_cursor
+
+    def initialize(data)
+      @entries = (data["data"] || data || []).map { |entry| PullLogEntry.new(entry) }
+      @has_more = data["has_more"] || false
+      @next_cursor = data["next_cursor"]
+    end
+  end
+
   class InboundLogEntry < BaseModel
     def initialize(data)
-      super(data, time_fields: %w[received_at delivered_at])
+      super(data, time_fields: %w[received_at delivered_at deleted_at])
     end
   end
 
@@ -406,7 +501,7 @@ module HookBridge
 
   class InboundMessage < BaseModel
     def initialize(data)
-      super(data, time_fields: %w[received_at updated_at next_attempt_at delivered_at failed_at])
+      super(data, time_fields: %w[received_at updated_at next_attempt_at delivered_at failed_at deleted_at])
     end
   end
 
@@ -422,4 +517,86 @@ module HookBridge
       ])
     end
   end
+
+  class DeleteMessageResult < BaseModel
+    def initialize(data)
+      super(data, time_fields: %w[deleted_at])
+    end
+  end
+
+  class DeleteEventResult < BaseModel
+    def initialize(data)
+      super(data, time_fields: %w[deleted_at])
+    end
+  end
+
+  class DeleteBatchItemResult < BaseModel
+    def initialize(data)
+      super(data, time_fields: %w[deleted_at])
+    end
+  end
+
+  class DeleteBatchResult
+    attr_reader :results, :deleted_count, :already_deleted_count, :not_found_count
+
+    def initialize(data)
+      @results = (data["results"] || []).map { |item| DeleteBatchItemResult.new(item) }
+      @deleted_count = data["deleted_count"]
+      @already_deleted_count = data["already_deleted_count"]
+      @not_found_count = data["not_found_count"]
+    end
+  end
+
+  class DeleteEventBatchItemResult < BaseModel
+    def initialize(data)
+      super(data, time_fields: %w[deleted_at])
+    end
+  end
+
+  class DeleteEventBatchResult
+    attr_reader :results, :deleted_count, :already_deleted_count, :not_found_count
+
+    def initialize(data)
+      @results = (data["results"] || []).map { |item| DeleteEventBatchItemResult.new(item) }
+      @deleted_count = data["deleted_count"]
+      @already_deleted_count = data["already_deleted_count"]
+      @not_found_count = data["not_found_count"]
+    end
+  end
+
+  class DeletePartialError < BaseModel
+  end
+
+  class DeleteAllResult
+    attr_reader :deleted, :deleted_message_ids, :error
+
+    def initialize(response)
+      data = response["data"] || {}
+      @deleted = data["deleted"]
+      @deleted_message_ids = data["deleted_message_ids"] || []
+      err = response["error"]
+      @error = err ? DeletePartialError.new(err) : nil
+    end
+  end
+
+  class DeletePullEventsAllResult
+    attr_reader :deleted, :deleted_event_ids, :error
+
+    def initialize(response)
+      data = response["data"] || {}
+      @deleted = data["deleted"]
+      @deleted_event_ids = data["deleted_event_ids"] || []
+      err = response["error"]
+      @error = err ? DeletePartialError.new(err) : nil
+    end
+  end
+
+  class ActorLookupResult
+    attr_reader :users, :api_keys
+
+    def initialize(data)
+      @users = data["users"]
+      @api_keys = data["api_keys"]
+    end
+  end
 end

data/lib/hookbridge/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HookBridge
-  VERSION = "1.6.0"
+  VERSION = "1.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hookbridge
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - HookBridge