svix 1.64.1 → 1.65.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1b7773e171e2278071f12bb0255f7648c8932bca4049efdb64cc2db6aa81512
-  data.tar.gz: cd4440aa2761fd3f1a087d00241e1b1ae19c4621d4132b3a8ea7469800398a8c
+  metadata.gz: 6255d797d9fbb4cf43d08bb4fd1186204c68aad0faf85e6510747c65c1410bb9
+  data.tar.gz: 8b5c4e66576f3d93a9509103155f53111a5ab04a1d232ad9fad92ad9de6f668d
 SHA512:
-  metadata.gz: 78850d4d985e876fb159fa8d90e9b3fa496e356d022d9e3863a64bbda2843283f9693bf08cd01efce907d820eb299c6f6fdb7deaee8d82d41d848039746bff04
-  data.tar.gz: edfdd88de30d18a51e327c3d61fa236f5a4c299b510cfb4ae1cdc1ae8655aeddf8b3d1e65ee9646c4f8a2625f85985bc799480c0d05e55aaec7fc56edbb3505b
+  metadata.gz: 672c5925b296f1e07d1124ec6d9a3f46f6efa3d2205ecf2fb10ab1418223ffe0c78d64b0920225b60be5a103152e4694f6ac3ff07c87ce66ed606e36d885549e
+  data.tar.gz: 2ebb54d3dd23ee11dd8f329cede36352820b22c85db0a57f9d8f18ec236bdcff67bdb4c5e8db511d75c620fb700ef6ba3f3b2b8b7606b3235b5940967c228fb9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    svix (1.64.1)
+    svix (1.65.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/svix/api/ingest_endpoint.rb

@@ -9,11 +9,11 @@ module Svix
       @client = client
     end
 
-    def list(options = {})
+    def list(source_id, options = {})
       options = options.transform_keys(&:to_s)
       res = @client.execute_request(
         "GET",
-        "/ingest/api/v1/source/{source_id}/endpoint",
+        "/ingest/api/v1/source/#{source_id}/endpoint",
         query_params: {
           "limit" => options["limit"],
           "iterator" => options["iterator"],
@@ -23,11 +23,11 @@ module Svix
       ListResponseIngestEndpointOut.deserialize(res)
     end
 
-    def create(ingest_endpoint_in, options = {})
+    def create(source_id, ingest_endpoint_in, options = {})
       options = options.transform_keys(&:to_s)
       res = @client.execute_request(
         "POST",
-        "/ingest/api/v1/source/{source_id}/endpoint",
+        "/ingest/api/v1/source/#{source_id}/endpoint",
         headers: {
           "idempotency-key" => options["idempotency-key"]
         },
@@ -36,59 +36,59 @@ module Svix
       IngestEndpointOut.deserialize(res)
     end
 
-    def get(endpoint_id)
+    def get(source_id, endpoint_id)
       res = @client.execute_request(
         "GET",
-        "/ingest/api/v1/source/{source_id}/endpoint/#{endpoint_id}"
+        "/ingest/api/v1/source/#{source_id}/endpoint/#{endpoint_id}"
       )
       IngestEndpointOut.deserialize(res)
     end
 
-    def update(endpoint_id, ingest_endpoint_update)
+    def update(source_id, endpoint_id, ingest_endpoint_update)
       res = @client.execute_request(
         "PUT",
-        "/ingest/api/v1/source/{source_id}/endpoint/#{endpoint_id}",
+        "/ingest/api/v1/source/#{source_id}/endpoint/#{endpoint_id}",
         body: ingest_endpoint_update
       )
       IngestEndpointOut.deserialize(res)
     end
 
-    def delete(endpoint_id)
+    def delete(source_id, endpoint_id)
       @client.execute_request(
         "DELETE",
-        "/ingest/api/v1/source/{source_id}/endpoint/#{endpoint_id}"
+        "/ingest/api/v1/source/#{source_id}/endpoint/#{endpoint_id}"
       )
     end
 
-    def get_headers(endpoint_id)
+    def get_headers(source_id, endpoint_id)
       res = @client.execute_request(
         "GET",
-        "/ingest/api/v1/source/{source_id}/endpoint/#{endpoint_id}/headers"
+        "/ingest/api/v1/source/#{source_id}/endpoint/#{endpoint_id}/headers"
       )
       IngestEndpointHeadersOut.deserialize(res)
     end
 
-    def update_headers(endpoint_id, ingest_endpoint_headers_in)
+    def update_headers(source_id, endpoint_id, ingest_endpoint_headers_in)
       @client.execute_request(
         "PUT",
-        "/ingest/api/v1/source/{source_id}/endpoint/#{endpoint_id}/headers",
+        "/ingest/api/v1/source/#{source_id}/endpoint/#{endpoint_id}/headers",
         body: ingest_endpoint_headers_in
       )
     end
 
-    def get_secret(endpoint_id)
+    def get_secret(source_id, endpoint_id)
       res = @client.execute_request(
         "GET",
-        "/ingest/api/v1/source/{source_id}/endpoint/#{endpoint_id}/secret"
+        "/ingest/api/v1/source/#{source_id}/endpoint/#{endpoint_id}/secret"
       )
       IngestEndpointSecretOut.deserialize(res)
     end
 
-    def rotate_secret(endpoint_id, ingest_endpoint_secret_in, options = {})
+    def rotate_secret(source_id, endpoint_id, ingest_endpoint_secret_in, options = {})
       options = options.transform_keys(&:to_s)
       @client.execute_request(
         "POST",
-        "/ingest/api/v1/source/{source_id}/endpoint/#{endpoint_id}/secret/rotate",
+        "/ingest/api/v1/source/#{source_id}/endpoint/#{endpoint_id}/secret/rotate",
         headers: {
           "idempotency-key" => options["idempotency-key"]
         },

data/lib/svix/api/message_poller.rb

@@ -32,9 +32,7 @@ module Svix
         "/api/v1/app/#{app_id}/poller/#{sink_id}/consumer/#{consumer_id}",
         query_params: {
           "limit" => options["limit"],
-          "iterator" => options["iterator"],
-          "event_type" => options["event_type"],
-          "channel" => options["channel"]
+          "iterator" => options["iterator"]
         }
       )
       PollingEndpointOut.deserialize(res)

data/lib/svix/models/aggregate_event_types_out.rb

@@ -4,6 +4,7 @@ require "json"
 
 module Svix
   class AggregateEventTypesOut
+    # The QueueBackgroundTask's ID.
     attr_accessor :id
     attr_accessor :status
     attr_accessor :task

data/lib/svix/models/api_token_censored_out.rb

@@ -7,6 +7,7 @@ module Svix
     attr_accessor :censored_token
     attr_accessor :created_at
     attr_accessor :expires_at
+    # The ApplicationToken's ID.
     attr_accessor :id
     attr_accessor :name
     attr_accessor :scopes

data/lib/svix/models/api_token_expire_in.rb

@@ -4,6 +4,7 @@ require "json"
 
 module Svix
   class ApiTokenExpireIn
+    # How many seconds until the old key is expired.
     attr_accessor :expiry
 
     ALL_FIELD ||= ["expiry"].freeze

data/lib/svix/models/api_token_out.rb

@@ -6,6 +6,7 @@ module Svix
   class ApiTokenOut
     attr_accessor :created_at
     attr_accessor :expires_at
+    # The GlobalApplicationToken's ID.
     attr_accessor :id
     attr_accessor :name
     attr_accessor :scopes

data/lib/svix/models/app_portal_access_in.rb

@@ -4,9 +4,17 @@ require "json"
 
 module Svix
   class AppPortalAccessIn
+    # Optionally creates a new application while generating the access link.
+    #
+    # If the application id or uid that is used in the path already exists, this argument is ignored.
     attr_accessor :application
+    # How long the token will be valid for, in seconds.
+    #
+    # Valid values are between 1 hour and 7 days. The default is 7 days.
     attr_accessor :expiry
+    # The set of feature flags the created token will have access to.
     attr_accessor :feature_flags
+    # Whether the app portal should be in read-only mode.
     attr_accessor :read_only
 
     ALL_FIELD ||= ["application", "expiry", "feature_flags", "read_only"].freeze

data/lib/svix/models/app_usage_stats_in.rb

@@ -4,6 +4,9 @@ require "json"
 
 module Svix
   class AppUsageStatsIn
+    # Specific app IDs or UIDs to aggregate stats for.
+    #
+    # Note that if none of the given IDs or UIDs are resolved, a 422 response will be given.
     attr_accessor :app_ids
     attr_accessor :since
     attr_accessor :until

data/lib/svix/models/app_usage_stats_out.rb

@@ -4,9 +4,13 @@ require "json"
 
 module Svix
   class AppUsageStatsOut
+    # The QueueBackgroundTask's ID.
     attr_accessor :id
     attr_accessor :status
     attr_accessor :task
+    # Any app IDs or UIDs received in the request that weren't found.
+    #
+    # Stats will be produced for all the others.
     attr_accessor :unresolved_app_ids
 
     ALL_FIELD ||= ["id", "status", "task", "unresolved_app_ids"].freeze

data/lib/svix/models/application_in.rb

@@ -7,6 +7,7 @@ module Svix
     attr_accessor :metadata
     attr_accessor :name
     attr_accessor :rate_limit
+    # Optional unique identifier for the application.
     attr_accessor :uid
 
     ALL_FIELD ||= ["metadata", "name", "rate_limit", "uid"].freeze

data/lib/svix/models/application_out.rb

@@ -5,10 +5,12 @@ require "json"
 module Svix
   class ApplicationOut
     attr_accessor :created_at
+    # The Application's ID.
     attr_accessor :id
     attr_accessor :metadata
     attr_accessor :name
     attr_accessor :rate_limit
+    # The Application's UID.
     attr_accessor :uid
     attr_accessor :updated_at
 

data/lib/svix/models/application_patch.rb

@@ -7,6 +7,7 @@ module Svix
     attr_accessor :metadata
     attr_accessor :name
     attr_accessor :rate_limit
+    # The Application's UID.
     attr_accessor :uid
 
     ALL_FIELD ||= ["metadata", "name", "rate_limit", "uid"].freeze

data/lib/svix/models/application_token_expire_in.rb

@@ -4,6 +4,7 @@ require "json"
 
 module Svix
   class ApplicationTokenExpireIn
+    # How many seconds until the old key is expired.
     attr_accessor :expiry
 
     ALL_FIELD ||= ["expiry"].freeze

data/lib/svix/models/background_task_finished_event2.rb

@@ -7,6 +7,7 @@ module Svix
     attr_accessor :data
     attr_accessor :status
     attr_accessor :task
+    # The QueueBackgroundTask's ID.
     attr_accessor :task_id
 
     ALL_FIELD ||= ["data", "status", "task", "task_id"].freeze

data/lib/svix/models/background_task_out.rb

@@ -5,6 +5,7 @@ require "json"
 module Svix
   class BackgroundTaskOut
     attr_accessor :data
+    # The QueueBackgroundTask's ID.
     attr_accessor :id
     attr_accessor :status
     attr_accessor :task

data/lib/svix/models/connector_out.rb

@@ -8,12 +8,14 @@ module Svix
     attr_accessor :description
     attr_accessor :feature_flag
     attr_accessor :filter_types
+    # The Connector's ID.
     attr_accessor :id
     attr_accessor :instructions
     attr_accessor :instructions_link
     attr_accessor :kind
     attr_accessor :logo
     attr_accessor :name
+    # The Environment's ID.
     attr_accessor :org_id
     attr_accessor :transformation
     attr_accessor :updated_at

data/lib/svix/models/cron_config.rb

@@ -4,6 +4,9 @@ require "json"
 
 module Svix
   class CronConfig
+    # Override the default content-type.
+    #
+    # Recommended if the payload is not JSON.
     attr_accessor :content_type
     attr_accessor :payload
     attr_accessor :schedule

data/lib/svix/models/endpoint_created_event_data.rb

@@ -5,9 +5,13 @@ require "json"
 module Svix
   # Sent when an endpoint is created, updated, or deleted
   class EndpointCreatedEventData
+    # The Application's ID.
     attr_accessor :app_id
+    # The Application's UID.
     attr_accessor :app_uid
+    # The Endpoint's ID.
     attr_accessor :endpoint_id
+    # The Endpoint's UID.
     attr_accessor :endpoint_uid
 
     ALL_FIELD ||= ["app_id", "app_uid", "endpoint_id", "endpoint_uid"].freeze

data/lib/svix/models/endpoint_deleted_event_data.rb

@@ -5,9 +5,13 @@ require "json"
 module Svix
   # Sent when an endpoint is created, updated, or deleted
   class EndpointDeletedEventData
+    # The Application's ID.
     attr_accessor :app_id
+    # The Application's UID.
     attr_accessor :app_uid
+    # The Endpoint's ID.
     attr_accessor :endpoint_id
+    # The Endpoint's UID.
     attr_accessor :endpoint_uid
 
     ALL_FIELD ||= ["app_id", "app_uid", "endpoint_id", "endpoint_uid"].freeze

data/lib/svix/models/endpoint_disabled_event_data.rb

@@ -5,9 +5,13 @@ require "json"
 module Svix
   # Sent when an endpoint has been automatically disabled after continuous failures, or manually via an API call.
   class EndpointDisabledEventData
+    # The Application's ID.
     attr_accessor :app_id
+    # The Application's UID.
     attr_accessor :app_uid
+    # The Endpoint's ID.
     attr_accessor :endpoint_id
+    # The Endpoint's UID.
     attr_accessor :endpoint_uid
     attr_accessor :fail_since
     attr_accessor :trigger

data/lib/svix/models/endpoint_enabled_event_data.rb

@@ -5,9 +5,13 @@ require "json"
 module Svix
   # Sent when an endpoint has been enabled.
   class EndpointEnabledEventData
+    # The Application's ID.
     attr_accessor :app_id
+    # The Application's UID.
     attr_accessor :app_uid
+    # The Endpoint's ID.
     attr_accessor :endpoint_id
+    # The Endpoint's UID.
     attr_accessor :endpoint_uid
 
     ALL_FIELD ||= ["app_id", "app_uid", "endpoint_id", "endpoint_uid"].freeze

data/lib/svix/models/endpoint_in.rb

@@ -4,6 +4,7 @@ require "json"
 
 module Svix
   class EndpointIn
+    # List of message channels this endpoint listens to (omit for all).
     attr_accessor :channels
     attr_accessor :description
     attr_accessor :disabled
@@ -11,7 +12,12 @@ module Svix
     attr_accessor :headers
     attr_accessor :metadata
     attr_accessor :rate_limit
+    # The endpoint's verification secret.
+    #
+    # Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
+    # It is recommended to not set this and let the server generate the secret.
     attr_accessor :secret
+    # Optional unique identifier for the endpoint.
     attr_accessor :uid
     attr_accessor :url
     attr_accessor :version

data/lib/svix/models/endpoint_message_out.rb

@@ -5,9 +5,13 @@ require "json"
 module Svix
   # A model containing information on a given message plus additional fields on the last attempt for that message.
   class EndpointMessageOut
+    # List of free-form identifiers that endpoints can filter by
     attr_accessor :channels
+    # Optional unique identifier for the message
     attr_accessor :event_id
+    # The event type's name
     attr_accessor :event_type
+    # The Message's ID.
     attr_accessor :id
     attr_accessor :next_attempt
     attr_accessor :payload

data/lib/svix/models/endpoint_out.rb

@@ -4,14 +4,18 @@ require "json"
 
 module Svix
   class EndpointOut
+    # List of message channels this endpoint listens to (omit for all).
     attr_accessor :channels
     attr_accessor :created_at
+    # An example endpoint name.
     attr_accessor :description
     attr_accessor :disabled
     attr_accessor :filter_types
+    # The Endpoint's ID.
     attr_accessor :id
     attr_accessor :metadata
     attr_accessor :rate_limit
+    # Optional unique identifier for the endpoint.
     attr_accessor :uid
     attr_accessor :updated_at
     attr_accessor :url

data/lib/svix/models/endpoint_patch.rb

@@ -10,7 +10,12 @@ module Svix
     attr_accessor :filter_types
     attr_accessor :metadata
     attr_accessor :rate_limit
+    # The endpoint's verification secret.
+    #
+    # Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
+    # It is recommended to not set this and let the server generate the secret.
     attr_accessor :secret
+    # The Endpoint's UID.
     attr_accessor :uid
     attr_accessor :url
     attr_accessor :version

data/lib/svix/models/endpoint_secret_out.rb

@@ -4,6 +4,10 @@ require "json"
 
 module Svix
   class EndpointSecretOut
+    # The endpoint's verification secret.
+    #
+    # Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
+    # It is recommended to not set this and let the server generate the secret.
     attr_accessor :key
 
     ALL_FIELD ||= ["key"].freeze

data/lib/svix/models/endpoint_secret_rotate_in.rb

@@ -4,6 +4,10 @@ require "json"
 
 module Svix
   class EndpointSecretRotateIn
+    # The endpoint's verification secret.
+    #
+    # Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
+    # It is recommended to not set this and let the server generate the secret.
     attr_accessor :key
 
     ALL_FIELD ||= ["key"].freeze

data/lib/svix/models/endpoint_update.rb

@@ -4,12 +4,14 @@ require "json"
 
 module Svix
   class EndpointUpdate
+    # List of message channels this endpoint listens to (omit for all).
     attr_accessor :channels
     attr_accessor :description
     attr_accessor :disabled
     attr_accessor :filter_types
     attr_accessor :metadata
     attr_accessor :rate_limit
+    # Optional unique identifier for the endpoint.
     attr_accessor :uid
     attr_accessor :url
     attr_accessor :version

data/lib/svix/models/endpoint_updated_event_data.rb

@@ -5,9 +5,13 @@ require "json"
 module Svix
   # Sent when an endpoint is created, updated, or deleted
   class EndpointUpdatedEventData
+    # The Application's ID.
     attr_accessor :app_id
+    # The Application's UID.
     attr_accessor :app_uid
+    # The Endpoint's ID.
     attr_accessor :endpoint_id
+    # The Endpoint's UID.
     attr_accessor :endpoint_uid
 
     ALL_FIELD ||= ["app_id", "app_uid", "endpoint_id", "endpoint_uid"].freeze

data/lib/svix/models/event_example_in.rb

@@ -4,7 +4,11 @@ require "json"
 
 module Svix
   class EventExampleIn
+    # The event type's name
     attr_accessor :event_type
+    # If the event type schema contains an array of examples, chooses which one to send.
+    #
+    # Defaults to the first example. Ignored if the schema doesn't contain an array of examples.
     attr_accessor :example_index
 
     ALL_FIELD ||= ["event_type", "example_index"].freeze

data/lib/svix/models/event_type_from_open_api.rb

@@ -7,7 +7,9 @@ module Svix
     attr_accessor :deprecated
     attr_accessor :description
     attr_accessor :feature_flag
+    # The event type group's name
     attr_accessor :group_name
+    # The event type's name
     attr_accessor :name
     attr_accessor :schemas
 

data/lib/svix/models/event_type_import_open_api_in.rb

@@ -7,9 +7,13 @@ module Svix
   #
   # The OpenAPI spec can be specified as either `spec` given the spec as a JSON object, or as `specRaw` (a `string`) which will be parsed as YAML or JSON by the server. Sending neither or both is invalid, resulting in a `400` **Bad Request**.
   class EventTypeImportOpenApiIn
+    # If `true`, return the event types that would be modified without actually modifying them.
     attr_accessor :dry_run
+    # If `true`, all existing event types that are not in the spec will be archived.
     attr_accessor :replace_all
+    # A pre-parsed JSON spec.
     attr_accessor :spec
+    # A string, parsed by the server as YAML or JSON.
     attr_accessor :spec_raw
 
     ALL_FIELD ||= ["dry_run", "replace_all", "spec", "spec_raw"].freeze

data/lib/svix/models/event_type_in.rb

@@ -8,8 +8,11 @@ module Svix
     attr_accessor :deprecated
     attr_accessor :description
     attr_accessor :feature_flag
+    # The event type group's name
     attr_accessor :group_name
+    # The event type's name
     attr_accessor :name
+    # The schema for the event type for a specific version as a JSON schema.
     attr_accessor :schemas
 
     ALL_FIELD ||= ["archived", "deprecated", "description", "feature_flag", "group_name", "name", "schemas"].freeze

data/lib/svix/models/event_type_out.rb

@@ -9,8 +9,11 @@ module Svix
     attr_accessor :deprecated
     attr_accessor :description
     attr_accessor :feature_flag
+    # The event type group's name
     attr_accessor :group_name
+    # The event type's name
     attr_accessor :name
+    # The schema for the event type for a specific version as a JSON schema.
     attr_accessor :schemas
     attr_accessor :updated_at
 

data/lib/svix/models/event_type_patch.rb

@@ -8,6 +8,7 @@ module Svix
     attr_accessor :deprecated
     attr_accessor :description
     attr_accessor :feature_flag
+    # The event type group's name
     attr_accessor :group_name
     attr_accessor :schemas
 

data/lib/svix/models/event_type_update.rb

@@ -8,7 +8,9 @@ module Svix
     attr_accessor :deprecated
     attr_accessor :description
     attr_accessor :feature_flag
+    # The event type group's name
     attr_accessor :group_name
+    # The schema for the event type for a specific version as a JSON schema.
     attr_accessor :schemas
 
     ALL_FIELD ||= ["archived", "deprecated", "description", "feature_flag", "group_name", "schemas"].freeze

data/lib/svix/models/expunge_all_contents_out.rb

@@ -4,6 +4,7 @@ require "json"
 
 module Svix
   class ExpungeAllContentsOut
+    # The QueueBackgroundTask's ID.
     attr_accessor :id
     attr_accessor :status
     attr_accessor :task

data/lib/svix/models/ingest_endpoint_in.rb

@@ -8,7 +8,12 @@ module Svix
     attr_accessor :disabled
     attr_accessor :metadata
     attr_accessor :rate_limit
+    # The endpoint's verification secret.
+    #
+    # Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
+    # It is recommended to not set this and let the server generate the secret.
     attr_accessor :secret
+    # Optional unique identifier for the endpoint.
     attr_accessor :uid
     attr_accessor :url
 

data/lib/svix/models/ingest_endpoint_out.rb

@@ -5,11 +5,14 @@ require "json"
 module Svix
   class IngestEndpointOut
     attr_accessor :created_at
+    # An example endpoint name.
     attr_accessor :description
     attr_accessor :disabled
+    # The Endpoint's ID.
     attr_accessor :id
     attr_accessor :metadata
     attr_accessor :rate_limit
+    # Optional unique identifier for the endpoint.
     attr_accessor :uid
     attr_accessor :updated_at
     attr_accessor :url

data/lib/svix/models/ingest_endpoint_secret_in.rb

@@ -4,6 +4,10 @@ require "json"
 
 module Svix
   class IngestEndpointSecretIn
+    # The endpoint's verification secret.
+    #
+    # Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
+    # It is recommended to not set this and let the server generate the secret.
     attr_accessor :key
 
     ALL_FIELD ||= ["key"].freeze

data/lib/svix/models/ingest_endpoint_secret_out.rb

@@ -4,6 +4,10 @@ require "json"
 
 module Svix
   class IngestEndpointSecretOut
+    # The endpoint's verification secret.
+    #
+    # Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
+    # It is recommended to not set this and let the server generate the secret.
     attr_accessor :key
 
     ALL_FIELD ||= ["key"].freeze

data/lib/svix/models/ingest_endpoint_update.rb

@@ -8,6 +8,7 @@ module Svix
     attr_accessor :disabled
     attr_accessor :metadata
     attr_accessor :rate_limit
+    # Optional unique identifier for the endpoint.
     attr_accessor :uid
     attr_accessor :url