svix 1.64.1 → 1.65.0

data/lib/svix/models/ingest_source_consumer_portal_access_in.rb

@@ -4,7 +4,11 @@ require "json"
 
 module Svix
   class IngestSourceConsumerPortalAccessIn
+    # 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
+    # Whether the app portal should be in read-only mode.
     attr_accessor :read_only
 
     ALL_FIELD ||= ["expiry", "read_only"].freeze

data/lib/svix/models/ingest_source_in.rb

@@ -107,6 +107,7 @@ module Svix
 
   class IngestSourceIn
     attr_accessor :name
+    # The Source's UID.
     attr_accessor :uid
     attr_accessor :config
 

data/lib/svix/models/ingest_source_out.rb

@@ -107,9 +107,11 @@ module Svix
 
   class IngestSourceOut
     attr_accessor :created_at
+    # The Source's ID.
     attr_accessor :id
     attr_accessor :ingest_url
     attr_accessor :name
+    # The Source's UID.
     attr_accessor :uid
     attr_accessor :updated_at
     attr_accessor :config

data/lib/svix/models/integration_in.rb

@@ -4,6 +4,7 @@ require "json"
 
 module Svix
   class IntegrationIn
+    # The set of feature flags the integration will have access to.
     attr_accessor :feature_flags
     attr_accessor :name
 

data/lib/svix/models/integration_out.rb

@@ -5,7 +5,9 @@ require "json"
 module Svix
   class IntegrationOut
     attr_accessor :created_at
+    # The set of feature flags the integration has access to.
     attr_accessor :feature_flags
+    # The Integration's ID.
     attr_accessor :id
     attr_accessor :name
     attr_accessor :updated_at

data/lib/svix/models/integration_update.rb

@@ -4,6 +4,7 @@ require "json"
 
 module Svix
   class IntegrationUpdate
+    # The set of feature flags the integration will have access to.
     attr_accessor :feature_flags
     attr_accessor :name
 

data/lib/svix/models/message_attempt_exhausted_event_data.rb

@@ -5,11 +5,16 @@ require "json"
 module Svix
   # Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "message.attempt.exhausted" type or after it's failed four times as a "message.attempt.failing" event.
   class MessageAttemptExhaustedEventData
+    # The Application's ID.
     attr_accessor :app_id
+    # The Application's UID.
     attr_accessor :app_uid
+    # The Endpoint's ID.
     attr_accessor :endpoint_id
     attr_accessor :last_attempt
+    # The Message's UID.
     attr_accessor :msg_event_id
+    # The Message's ID.
     attr_accessor :msg_id
 
     ALL_FIELD ||= ["app_id", "app_uid", "endpoint_id", "last_attempt", "msg_event_id", "msg_id"].freeze

data/lib/svix/models/message_attempt_failed_data.rb

@@ -4,6 +4,7 @@ require "json"
 
 module Svix
   class MessageAttemptFailedData
+    # The MessageAttempt's ID.
     attr_accessor :id
     attr_accessor :response_status_code
     attr_accessor :timestamp

data/lib/svix/models/message_attempt_failing_event_data.rb

@@ -5,11 +5,16 @@ require "json"
 module Svix
   # Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "message.attempt.exhausted" type or after it's failed four times as a "message.attempt.failing" event.
   class MessageAttemptFailingEventData
+    # The Application's ID.
     attr_accessor :app_id
+    # The Application's UID.
     attr_accessor :app_uid
+    # The Endpoint's ID.
     attr_accessor :endpoint_id
     attr_accessor :last_attempt
+    # The Message's UID.
     attr_accessor :msg_event_id
+    # The Message's ID.
     attr_accessor :msg_id
 
     ALL_FIELD ||= ["app_id", "app_uid", "endpoint_id", "last_attempt", "msg_event_id", "msg_id"].freeze

data/lib/svix/models/message_attempt_out.rb

@@ -4,11 +4,15 @@ require "json"
 
 module Svix
   class MessageAttemptOut
+    # The Endpoint's ID.
     attr_accessor :endpoint_id
+    # The MessageAttempt's ID.
     attr_accessor :id
     attr_accessor :msg
+    # The Message's ID.
     attr_accessor :msg_id
     attr_accessor :response
+    # Response duration in milliseconds.
     attr_accessor :response_duration_ms
     attr_accessor :response_status_code
     attr_accessor :status

data/lib/svix/models/message_attempt_recovered_event_data.rb

@@ -5,11 +5,16 @@ require "json"
 module Svix
   # Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "message.attempt.exhausted" type or after it's failed four times as a "message.attempt.failing" event.
   class MessageAttemptRecoveredEventData
+    # The Application's ID.
     attr_accessor :app_id
+    # The Application's UID.
     attr_accessor :app_uid
+    # The Endpoint's ID.
     attr_accessor :endpoint_id
     attr_accessor :last_attempt
+    # The Message's UID.
     attr_accessor :msg_event_id
+    # The Message's ID.
     attr_accessor :msg_id
 
     ALL_FIELD ||= ["app_id", "app_uid", "endpoint_id", "last_attempt", "msg_event_id", "msg_id"].freeze

data/lib/svix/models/message_endpoint_out.rb

@@ -4,15 +4,19 @@ require "json"
 
 module Svix
   class MessageEndpointOut
+    # 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 :next_attempt
     attr_accessor :rate_limit
     attr_accessor :status
+    # Optional unique identifier for the endpoint.
     attr_accessor :uid
     attr_accessor :updated_at
     attr_accessor :url

data/lib/svix/models/message_in.rb

@@ -4,14 +4,27 @@ require "json"
 
 module Svix
   class MessageIn
+    # Optionally creates a new application alongside the message.
+    #
+    # If the application id or uid that is used in the path already exists, this argument is ignored.
     attr_accessor :application
+    # 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
+    # JSON payload to send as the request body of the webhook.
+    #
+    # We also support sending non-JSON payloads. Please contact us for more information.
     attr_accessor :payload
+    # Optional number of hours to retain the message payload. Note that this is mutually exclusive with `payloadRetentionPeriod`.
     attr_accessor :payload_retention_hours
+    # Optional number of days to retain the message payload. Defaults to 90. Note that this is mutually exclusive with `payloadRetentionHours`.
     attr_accessor :payload_retention_period
+    # List of free-form tags that can be filtered by when listing messages
     attr_accessor :tags
+    # Extra parameters to pass to Transformations (for future use)
     attr_accessor :transformations_params
 
     ALL_FIELD ||= [

data/lib/svix/models/message_out.rb

@@ -4,9 +4,13 @@ require "json"
 
 module Svix
   class MessageOut
+    # 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 :payload
     attr_accessor :tags

data/lib/svix/models/operational_webhook_endpoint_in.rb

@@ -9,7 +9,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
+    # Optional unique identifier for the endpoint.
     attr_accessor :uid
     attr_accessor :url
 

data/lib/svix/models/operational_webhook_endpoint_out.rb

@@ -5,12 +5,15 @@ require "json"
 module Svix
   class OperationalWebhookEndpointOut
     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/operational_webhook_endpoint_secret_in.rb

@@ -4,6 +4,10 @@ require "json"
 
 module Svix
   class OperationalWebhookEndpointSecretIn
+    # 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/operational_webhook_endpoint_secret_out.rb

@@ -4,6 +4,10 @@ require "json"
 
 module Svix
   class OperationalWebhookEndpointSecretOut
+    # 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/operational_webhook_endpoint_update.rb

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

data/lib/svix/models/polling_endpoint_message_out.rb

@@ -5,10 +5,14 @@ require "json"
 module Svix
   # The MessageOut equivalent of polling endpoint
   class PollingEndpointMessageOut
+    # 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
     attr_accessor :headers
+    # The Message's ID.
     attr_accessor :id
     attr_accessor :payload
     attr_accessor :tags

data/lib/svix/models/recover_out.rb

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

data/lib/svix/models/replay_out.rb

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

data/lib/svix/svix.rb

@@ -36,6 +36,10 @@ module Svix
         regional_url = "https://api.eu.svix.com"
       elsif region == "in"
         regional_url = "https://api.in.svix.com"
+      elsif region == "ca"
+        regional_url = "https://api.ca.svix.com"
+      elsif region == "au"
+        regional_url = "https://api.au.svix.com"
       else
         regional_url = "https://api.svix.com"
       end

data/lib/svix/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Svix
-  VERSION = "1.64.1"
+  VERSION = "1.65.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: svix
 version: !ruby/object:Gem::Version
-  version: 1.64.1
+  version: 1.65.0
 platform: ruby
 authors:
 - Svix
 bindir: exe
 cert_chain: []
-date: 2025-04-16 00:00:00.000000000 Z
+date: 2025-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -69,7 +69,6 @@ files:
 - lib/svix/api/endpoint.rb
 - lib/svix/api/environment.rb
 - lib/svix/api/event_type.rb
-- lib/svix/api/events_public.rb
 - lib/svix/api/health.rb
 - lib/svix/api/ingest.rb
 - lib/svix/api/ingest_endpoint.rb
@@ -224,7 +223,6 @@ files:
 - lib/svix/models/stripe_config_out.rb
 - lib/svix/models/svix_config.rb
 - lib/svix/models/svix_config_out.rb
-- lib/svix/models/template_out.rb
 - lib/svix/models/zoom_config.rb
 - lib/svix/models/zoom_config_out.rb
 - lib/svix/svix.rb
@@ -234,17 +232,6 @@ files:
 - lib/svix/version.rb
 - lib/svix/webhook.rb
 - svix.gemspec
-- templates/api_extra/application_create.rb
-- templates/api_extra/authentication_expire_all.rb
-- templates/api_extra/message.rb
-- templates/api_resource.rb.jinja
-- templates/component_type.rb.jinja
-- templates/summary.rb.jinja
-- templates/types/integer_enum.rb.jinja
-- templates/types/macros.rb.jinja
-- templates/types/string_enum.rb.jinja
-- templates/types/struct.rb.jinja
-- templates/types/struct_enum.rb.jinja
 homepage: https://www.svix.com
 licenses:
 - MIT

data/lib/svix/api/events_public.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-# This file is @generated
-
-require "net/http"
-
-module Svix
-  class EventsPublic
-    def initialize(client)
-      @client = client
-    end
-
-    def consumer(app_id, sink_id, consumer_id, options = {})
-      options = options.transform_keys(&:to_s)
-      res = @client.execute_request(
-        "GET",
-        "/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"]
-        }
-      )
-      PollingEndpointOut.deserialize(res)
-    end
-
-    def consumer_seek(app_id, sink_id, consumer_id, polling_endpoint_consumer_seek_in, options = {})
-      options = options.transform_keys(&:to_s)
-      res = @client.execute_request(
-        "POST",
-        "/api/v1/app/#{app_id}/poller/#{sink_id}/consumer/#{consumer_id}/seek",
-        headers: {
-          "idempotency-key" => options["idempotency-key"]
-        },
-        body: polling_endpoint_consumer_seek_in
-      )
-      PollingEndpointConsumerSeekOut.deserialize(res)
-    end
-
-  end
-end

data/lib/svix/models/template_out.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-# This file is @generated
-require "json"
-
-module Svix
-  class TemplateOut
-    attr_accessor :created_at
-    attr_accessor :description
-    attr_accessor :feature_flag
-    attr_accessor :filter_types
-    attr_accessor :id
-    attr_accessor :instructions
-    attr_accessor :instructions_link
-    attr_accessor :kind
-    attr_accessor :logo
-    attr_accessor :name
-    attr_accessor :org_id
-    attr_accessor :transformation
-    attr_accessor :updated_at
-
-    ALL_FIELD ||= [
-      "created_at",
-      "description",
-      "feature_flag",
-      "filter_types",
-      "id",
-      "instructions",
-      "instructions_link",
-      "kind",
-      "logo",
-      "name",
-      "org_id",
-      "transformation",
-      "updated_at"
-    ].freeze
-    private_constant :ALL_FIELD
-
-    def initialize(attributes = {})
-      unless attributes.is_a?(Hash)
-        fail(ArgumentError, "The input argument (attributes) must be a hash in `Svix::TemplateOut` new method")
-      end
-
-      attributes.each do |k, v|
-        unless ALL_FIELD.include?(k.to_s)
-          fail(ArgumentError, "The field #{k} is not part of Svix::TemplateOut")
-        end
-
-        instance_variable_set("@#{k}", v)
-        instance_variable_set("@__#{k}_is_defined", true)
-      end
-    end
-
-    def self.deserialize(attributes = {})
-      attributes = attributes.transform_keys(&:to_s)
-      attrs = Hash.new
-      attrs["created_at"] = DateTime.rfc3339(attributes["createdAt"]).to_time
-      attrs["description"] = attributes["description"]
-      attrs["feature_flag"] = attributes["featureFlag"]
-      attrs["filter_types"] = attributes["filterTypes"]
-      attrs["id"] = attributes["id"]
-      attrs["instructions"] = attributes["instructions"]
-      attrs["instructions_link"] = attributes["instructionsLink"]
-      attrs["kind"] = Svix::ConnectorKind.deserialize(attributes["kind"])
-      attrs["logo"] = attributes["logo"]
-      attrs["name"] = attributes["name"]
-      attrs["org_id"] = attributes["orgId"]
-      attrs["transformation"] = attributes["transformation"]
-      attrs["updated_at"] = DateTime.rfc3339(attributes["updatedAt"]).to_time
-      new(attrs)
-    end
-
-    def serialize
-      out = Hash.new
-      out["createdAt"] = Svix::serialize_primitive(@created_at) if @created_at
-      out["description"] = Svix::serialize_primitive(@description) if @description
-      out["featureFlag"] = Svix::serialize_primitive(@feature_flag) if @feature_flag
-      out["filterTypes"] = Svix::serialize_primitive(@filter_types) if @filter_types
-      out["id"] = Svix::serialize_primitive(@id) if @id
-      out["instructions"] = Svix::serialize_primitive(@instructions) if @instructions
-      out["instructionsLink"] = Svix::serialize_primitive(@instructions_link) if @instructions_link
-      out["kind"] = @kind.serialize if @kind
-      out["logo"] = Svix::serialize_primitive(@logo) if @logo
-      out["name"] = Svix::serialize_primitive(@name) if @name
-      out["orgId"] = Svix::serialize_primitive(@org_id) if @org_id
-      out["transformation"] = Svix::serialize_primitive(@transformation) if @transformation
-      out["updatedAt"] = Svix::serialize_primitive(@updated_at) if @updated_at
-      out
-    end
-
-    # Serializes the object to a json string
-    # @return String
-    def to_json
-      JSON.dump(serialize)
-    end
-  end
-end

data/templates/api_extra/application_create.rb

@@ -1,16 +0,0 @@
-def get_or_create(application_in, options = {})
-  options = options.transform_keys(&:to_s)
-  path = "/api/v1/app"
-  res = @client.execute_request(
-    "POST",
-    path,
-    query_params: {
-      "get_if_exists" => "true"
-    },
-    headers: {
-      "idempotency-key" => options["idempotency-key"]
-    },
-    body: application_in
-  )
-  ApplicationOut.deserialize(res)
-end

data/templates/api_extra/authentication_expire_all.rb

@@ -1,11 +0,0 @@
-def dashboard_access(app_id, options = {})
-  options = options.transform_keys(&:to_s)
-  res = @client.execute_request(
-    "POST",
-    "/api/v1/auth/dashboard-access/#{app_id}",
-    headers: {
-      "idempotency-key" => options["idempotency-key"]
-    }
-  )
-  DashboardAccessOut.deserialize(res)
-end

data/templates/api_extra/message.rb

@@ -1,26 +0,0 @@
-# Creates a [`MessageIn`] with a raw string payload.
-#
-# The payload is not normalized on the server. Normally, payloads are required
-# to be JSON, and Svix will minify the payload before sending the webhook
-# (for example, by removing extraneous whitespace or unnecessarily escaped
-# characters in strings). With this function, the payload will be sent
-# "as is", without any minification or other processing.
-#
-# `attributes[:payload]` must be a string. An extra attribute `content_type`
-# is accepted that sets the `content-type` header of the webhook sent by Svix,
-# overwriting the default of `application/json` if specified. Other than that,
-# the attributes are forwarded [`MessageIn.new`], so all the same ones are
-# accepted.
-def message_in_raw(attributes = {})
-  attributes[:transformations_params] ||= {}
-  attributes[:transformations_params][:rawPayload] = attributes[:payload]
-  attributes[:payload] = {}
-
-  content_type = attributes.delete(:content_type)
-  if content_type != nil
-    attributes[:transformations_params][:headers] ||= {}
-    attributes[:transformations_params][:headers][:"content-type"] = content_type
-  end
-
-  MessageIn.new(attributes)
-end

data/templates/api_resource.rb.jinja

@@ -1,78 +0,0 @@
-{% set resource_type_name = resource.name | to_upper_camel_case -%}
-# frozen_string_literal: true
-# This file is @generated
-
-require 'net/http'
-
-
-module Svix
-  {% if resource.name == "message" -%}
-  module_function
-    {% include "api_extra/message.rb" %}
-  {% endif -%}
-  class {{ resource_type_name }}
-    {% for name, _ in resource.subresources | items -%}
-    attr_accessor :{{ name | to_snake_case }}
-    {% endfor -%}
-
-    def initialize(client)
-      @client = client
-      {%- for name, sub in resource.subresources | items %}
-      @{{ name | to_snake_case }} = {{ sub.name | to_upper_camel_case }}.new(client)
-      {%- endfor %}
-    end
-{% for op in resource.operations %}
-    {% set func_args -%}
-      {# path params -#}
-      {%- for p in op.path_params -%}
-      {{ p | to_snake_case }},
-      {%- endfor -%}
-      {# request body -#}
-      {%- if op.request_body_schema_name is defined -%}
-      {{ op.request_body_schema_name | to_snake_case }},
-      {%- endif -%}
-      {# header/query params -#}
-      {%- if op | has_query_or_header_params -%}
-      options = {}
-      {%- endif -%}
-    {% endset -%}
-
-    def {{ op.name | to_snake_case }}({{ func_args | strip_trailing_comma }})
-      {% if op | has_query_or_header_params -%}
-      options = options.transform_keys(&:to_s)
-      {% endif -%}
-      {% if op.response_body_schema_name is defined -%}res = {% endif -%}
-      @client.execute_request(
-        "{{ op.method | upper }}",
-        "{{ op.path | generate_ruby_path_str(op.path_params) }}",
-        {% if op.query_params | length >0 -%}
-        query_params:{
-          {% for p in op.query_params -%}
-            "{{ p.name }}" => options["{{ p.name }}"],
-          {% endfor -%}
-        },
-        {% endif -%}
-        {% if op.header_params | length >0 -%}
-        headers:{
-          {% for p in op.header_params -%}
-            "{{ p.name }}" => options["{{ p.name }}"],
-          {% endfor -%}
-        },
-        {% endif -%}
-        {% if op.request_body_schema_name is defined -%}
-        body: {{ op.request_body_schema_name | to_snake_case }},
-        {% endif -%}
-        )
-      {% if op.response_body_schema_name is defined -%}
-      {{ op.response_body_schema_name | to_upper_camel_case }}.deserialize res
-      {% endif %}
-    end
-
-    {% set extra_path -%}
-        api_extra/{{ resource.name | to_snake_case }}_{{ op.name | to_snake_case }}.rb
-    {%- endset -%}
-    {% include extra_path ignore missing %}
-
-{% endfor -%}
-  end
-end

data/templates/component_type.rb.jinja

@@ -1,9 +0,0 @@
-{% if type.kind == "struct" -%}
-    {% include "types/struct.rb.jinja" -%}
-{%- elif type.kind == "string_enum"-%}
-    {% include "types/string_enum.rb.jinja" -%}
-{%- elif type.kind == "integer_enum" -%}
-    {% include "types/integer_enum.rb.jinja" -%}
-{%- elif type.kind == "struct_enum" -%}
-    {% include "types/struct_enum.rb.jinja" -%}
-{%- endif %}