svix 0.85.1 → 1.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0fe9f147f53bc43e166174ddb691f6dcc637970ab33d2981fdc8eebec0e7b7f
-  data.tar.gz: f2b8385d9ef866052ad8807a0fe7666f44de79d69b630e2b65bc839819d8527d
+  metadata.gz: a0078884804b0032414b58570050441eabb2122593d71a6974c92ccca0e4e966
+  data.tar.gz: 9b3227ffff55d88bc3792557d70fbd30c243d16848c2cf7da95f1adde5e23f27
 SHA512:
-  metadata.gz: 1cfdeb5da10628616305e565fb2723e4019e1034065294ff23711cf506dc91aef9fe37b58f7d50569a45e3e6b32cccd468d1ba33f825a84486bc2c01a2434575
-  data.tar.gz: 33ac36357a3cefc7093587459b41ab3d49d9e25c1092e0621594079503c536ab94d4387ac4555b507aaf7e2a7a05384db60b4a7be11e53b35f6bad536d99190a
+  metadata.gz: ff430dfcc1aed28fb83a384b9eadd95c827f6f100a13f50e873a133c88424f456799a8c5f369f2fdf0294ebc61a54d6c105182185324801f8d25c0aec23a8e65
+  data.tar.gz: 48cdaf7229c8627bf7b3da7bb84fdf6b3c1baf9d108cb779c090820967d43f8f693709aa484fd95618c5dc1295641e044c50ae43d27e44c5f3d5571366965687

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    svix (0.85.1)
+    svix (1.4.12)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/lib/svix/api/broadcast_api.rb

@@ -0,0 +1,90 @@
+=begin
+#Svix API
+
+#Welcome to the Svix API documentation!  Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)  # Introduction  This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).  ## Main concepts  In Svix you have four important entities you will be interacting with:  - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.   ## Authentication  Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys).  <SecurityDefinitions />   ## Code samples  The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).   ## Idempotency  Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response.  To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions.  Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result.  Please note that idempotency is only supported for `POST` requests.   ## Cross-Origin Resource Sharing  This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. 
+
+The version of the OpenAPI document: 1.4.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.0
+
+=end
+
+require 'cgi'
+
+module Svix
+  class BroadcastApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Broadcast Message
+    # Creates a background task to send the same message to each application in your organization
+    # @param message_broadcast_in [MessageBroadcastIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
+    # @return [MessageBroadcastOut]
+    def create_broadcast_message(message_broadcast_in, opts = {})
+      data, _status_code, _headers = create_broadcast_message_with_http_info(message_broadcast_in, opts)
+      data
+    end
+
+    # Create Broadcast Message
+    # Creates a background task to send the same message to each application in your organization
+    # @param message_broadcast_in [MessageBroadcastIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
+    # @return [Array<(MessageBroadcastOut, Integer, Hash)>] MessageBroadcastOut data, response status code and response headers
+    def create_broadcast_message_with_http_info(message_broadcast_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastApi.create_broadcast_message ...'
+      end
+      # verify the required parameter 'message_broadcast_in' is set
+      if @api_client.config.client_side_validation && message_broadcast_in.nil?
+        fail ArgumentError, "Missing the required parameter 'message_broadcast_in' when calling BroadcastApi.create_broadcast_message"
+      end
+      # resource path
+      local_var_path = '/api/v1/msg/broadcast/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(message_broadcast_in)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MessageBroadcastOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastApi.create_broadcast_message",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BroadcastApi#create_broadcast_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/svix/api/message_api.rb

@@ -19,6 +19,112 @@ module Svix
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Create Message Attempt For Endpoint
+    # Creates and sends a message to the specified endpoint. The message attempt and response from the endpoint is returned. FIXME: use MessageIn for expediency, even though the `application` parameter is unused. Since this endpoint isn't publicly documented anyway, it should be fine
+    # @param app_id [String] The app's ID or UID
+    # @param endpoint_id [String] The ep's ID or UID
+    # @param message_in [MessageIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request's idempotency key
+    # @return [MessageAttemptOut]
+    def create_message_attempt_for_endpoint(app_id, endpoint_id, message_in, opts = {})
+      data, _status_code, _headers = create_message_attempt_for_endpoint_with_http_info(app_id, endpoint_id, message_in, opts)
+      data
+    end
+
+    # Create Message Attempt For Endpoint
+    # Creates and sends a message to the specified endpoint. The message attempt and response from the endpoint is returned. FIXME: use MessageIn for expediency, even though the `application` parameter is unused. Since this endpoint isn't publicly documented anyway, it should be fine
+    # @param app_id [String] The app's ID or UID
+    # @param endpoint_id [String] The ep's ID or UID
+    # @param message_in [MessageIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request's idempotency key
+    # @return [Array<(MessageAttemptOut, Integer, Hash)>] MessageAttemptOut data, response status code and response headers
+    def create_message_attempt_for_endpoint_with_http_info(app_id, endpoint_id, message_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MessageApi.create_message_attempt_for_endpoint ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling MessageApi.create_message_attempt_for_endpoint"
+      end
+      if @api_client.config.client_side_validation && app_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "app_id" when calling MessageApi.create_message_attempt_for_endpoint, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && app_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "app_id" when calling MessageApi.create_message_attempt_for_endpoint, the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
+      if @api_client.config.client_side_validation && app_id !~ pattern
+        fail ArgumentError, "invalid value for 'app_id' when calling MessageApi.create_message_attempt_for_endpoint, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'endpoint_id' is set
+      if @api_client.config.client_side_validation && endpoint_id.nil?
+        fail ArgumentError, "Missing the required parameter 'endpoint_id' when calling MessageApi.create_message_attempt_for_endpoint"
+      end
+      if @api_client.config.client_side_validation && endpoint_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "endpoint_id" when calling MessageApi.create_message_attempt_for_endpoint, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && endpoint_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "endpoint_id" when calling MessageApi.create_message_attempt_for_endpoint, the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
+      if @api_client.config.client_side_validation && endpoint_id !~ pattern
+        fail ArgumentError, "invalid value for 'endpoint_id' when calling MessageApi.create_message_attempt_for_endpoint, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'message_in' is set
+      if @api_client.config.client_side_validation && message_in.nil?
+        fail ArgumentError, "Missing the required parameter 'message_in' when calling MessageApi.create_message_attempt_for_endpoint"
+      end
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/endpoint/{endpoint_id}/msg/test-attempt/'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'endpoint_id' + '}', CGI.escape(endpoint_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(message_in)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MessageAttemptOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"MessageApi.create_message_attempt_for_endpoint",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MessageApi#create_message_attempt_for_endpoint\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create Message
     # Creates a new message and dispatches it to all of the application's endpoints.  The `eventId` is an optional custom unique ID. It's verified to be unique only up to a day, after that no verification will be made. If a message with the same `eventId` already exists for any application in your environment, a 409 conflict error will be returned.  The `eventType` indicates the type and schema of the event. All messages of a certain `eventType` are expected to have the same schema. Endpoints can choose to only listen to specific event types. Messages can also have `channels`, which similar to event types let endpoints filter by them. Unlike event types, messages can have multiple channels, and channels don't imply a specific message content or schema.  The `payload` property is the webhook's body (the actual webhook message). Svix supports payload sizes of up to ~350kb, though it's generally a good idea to keep webhook payloads small, probably no larger than 40kb.
     # @param app_id [String] The app&#39;s ID or UID
@@ -311,6 +417,7 @@ module Svix
     # @option opts [String] :channel 
     # @option opts [Time] :before 
     # @option opts [Time] :after 
+    # @option opts [Boolean] :with_content  (default to false)
     # @option opts [Array<String>] :event_types 
     # @return [ListResponseMessageOut]
     def v1_message_list(app_id, opts = {})
@@ -327,6 +434,7 @@ module Svix
     # @option opts [String] :channel 
     # @option opts [Time] :before 
     # @option opts [Time] :after 
+    # @option opts [Boolean] :with_content 
     # @option opts [Array<String>] :event_types 
     # @return [Array<(ListResponseMessageOut, Integer, Hash)>] ListResponseMessageOut data, response status code and response headers
     def v1_message_list_with_http_info(app_id, opts = {})
@@ -377,6 +485,7 @@ module Svix
       query_params[:'channel'] = opts[:'channel'] if !opts[:'channel'].nil?
       query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
       query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
+      query_params[:'with_content'] = opts[:'with_content'] if !opts[:'with_content'].nil?
       query_params[:'event_types'] = @api_client.build_collection_param(opts[:'event_types'], :multi) if !opts[:'event_types'].nil?
 
       # header parameters

data/lib/svix/api/message_attempt_api.rb

@@ -442,6 +442,7 @@ module Svix
     # @option opts [MessageStatus] :status 
     # @option opts [Time] :before 
     # @option opts [Time] :after 
+    # @option opts [Boolean] :with_content  (default to false)
     # @return [ListResponseEndpointMessageOut]
     def v1_message_attempt_list_attempted_messages(app_id, endpoint_id, opts = {})
       data, _status_code, _headers = v1_message_attempt_list_attempted_messages_with_http_info(app_id, endpoint_id, opts)
@@ -459,6 +460,7 @@ module Svix
     # @option opts [MessageStatus] :status 
     # @option opts [Time] :before 
     # @option opts [Time] :after 
+    # @option opts [Boolean] :with_content 
     # @return [Array<(ListResponseEndpointMessageOut, Integer, Hash)>] ListResponseEndpointMessageOut data, response status code and response headers
     def v1_message_attempt_list_attempted_messages_with_http_info(app_id, endpoint_id, opts = {})
       if @api_client.config.debugging
@@ -526,6 +528,7 @@ module Svix
       query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
       query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
       query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
+      query_params[:'with_content'] = opts[:'with_content'] if !opts[:'with_content'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/svix/background_tasks_api.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Svix
+  class BackgroundTasksAPI
+    def initialize(api_client)
+      @api = BackgroundTasksApi.new(api_client)
+    end
+
+    def list(options = {})
+      return @api.list_background_tasks(options)
+    end
+
+    def get(task_id, options = {})
+      return @api.get_background_task(task_id, options)
+    end
+  end
+end

data/lib/svix/endpoint_api.rb

@@ -51,8 +51,8 @@ module Svix
       return @api.v1_endpoint_patch_headers(app_id, endpoint_id, endpoint_headers_in)
     end
 
-    def get_stats(app_id, endpoint_id)
-      return @api.v1_endpoint_get_stats(app_id, endpoint_id)
+    def get_stats(app_id, endpoint_id, options = {})
+      return @api.v1_endpoint_get_stats(app_id, endpoint_id, options)
     end
 
     def replay_missing(app_id, endpoint_id, replay_in, options = {})

data/lib/svix/models/background_task_type.rb

@@ -18,6 +18,7 @@ module Svix
     ENDPOINT_REPLAY = "endpoint.replay".freeze
     ENDPOINT_RECOVER = "endpoint.recover".freeze
     APPLICATION_STATS = "application.stats".freeze
+    MESSAGE_BROADCAST = "message.broadcast".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

data/lib/svix/models/message_broadcast_in.rb

@@ -0,0 +1,386 @@
+=begin
+#Svix API
+
+#Welcome to the Svix API documentation!  Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)  # Introduction  This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).  ## Main concepts  In Svix you have four important entities you will be interacting with:  - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.   ## Authentication  Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys).  <SecurityDefinitions />   ## Code samples  The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).   ## Idempotency  Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response.  To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions.  Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result.  Please note that idempotency is only supported for `POST` requests.   ## Cross-Origin Resource Sharing  This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. 
+
+The version of the OpenAPI document: 1.4.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Svix
+  class MessageBroadcastIn
+    # 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 :payload
+
+    attr_accessor :payload_retention_period
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'channels' => :'channels',
+        :'event_id' => :'eventId',
+        :'event_type' => :'eventType',
+        :'payload' => :'payload',
+        :'payload_retention_period' => :'payloadRetentionPeriod'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'channels' => :'Array<String>',
+        :'event_id' => :'String',
+        :'event_type' => :'String',
+        :'payload' => :'Object',
+        :'payload_retention_period' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'channels',
+        :'event_id',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Svix::MessageBroadcastIn` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Svix::MessageBroadcastIn`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'channels')
+        if (value = attributes[:'channels']).is_a?(Array)
+          self.channels = value
+        end
+      end
+
+      if attributes.key?(:'event_id')
+        self.event_id = attributes[:'event_id']
+      end
+
+      if attributes.key?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      end
+
+      if attributes.key?(:'payload')
+        self.payload = attributes[:'payload']
+      end
+
+      if attributes.key?(:'payload_retention_period')
+        self.payload_retention_period = attributes[:'payload_retention_period']
+      else
+        self.payload_retention_period = 90
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@channels.nil? && @channels.length > 5
+        invalid_properties.push('invalid value for "channels", number of items must be less than or equal to 5.')
+      end
+
+      if !@channels.nil? && @channels.length < 1
+        invalid_properties.push('invalid value for "channels", number of items must be greater than or equal to 1.')
+      end
+
+      if !@event_id.nil? && @event_id.to_s.length > 256
+        invalid_properties.push('invalid value for "event_id", the character length must be smaller than or equal to 256.')
+      end
+
+      if !@event_id.nil? && @event_id.to_s.length < 1
+        invalid_properties.push('invalid value for "event_id", the character length must be great than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
+      if !@event_id.nil? && @event_id !~ pattern
+        invalid_properties.push("invalid value for \"event_id\", must conform to the pattern #{pattern}.")
+      end
+
+      if @event_type.nil?
+        invalid_properties.push('invalid value for "event_type", event_type cannot be nil.')
+      end
+
+      if @event_type.to_s.length > 256
+        invalid_properties.push('invalid value for "event_type", the character length must be smaller than or equal to 256.')
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
+      if @event_type !~ pattern
+        invalid_properties.push("invalid value for \"event_type\", must conform to the pattern #{pattern}.")
+      end
+
+      if @payload.nil?
+        invalid_properties.push('invalid value for "payload", payload cannot be nil.')
+      end
+
+      if !@payload_retention_period.nil? && @payload_retention_period > 90
+        invalid_properties.push('invalid value for "payload_retention_period", must be smaller than or equal to 90.')
+      end
+
+      if !@payload_retention_period.nil? && @payload_retention_period < 5
+        invalid_properties.push('invalid value for "payload_retention_period", must be greater than or equal to 5.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if !@channels.nil? && @channels.length > 5
+      return false if !@channels.nil? && @channels.length < 1
+      return false if !@event_id.nil? && @event_id.to_s.length > 256
+      return false if !@event_id.nil? && @event_id.to_s.length < 1
+      return false if !@event_id.nil? && @event_id !~ Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
+      return false if @event_type.nil?
+      return false if @event_type.to_s.length > 256
+      return false if @event_type !~ Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
+      return false if @payload.nil?
+      return false if !@payload_retention_period.nil? && @payload_retention_period > 90
+      return false if !@payload_retention_period.nil? && @payload_retention_period < 5
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] channels Value to be assigned
+    def channels=(channels)
+      if !channels.nil? && channels.length > 5
+        fail ArgumentError, 'invalid value for "channels", number of items must be less than or equal to 5.'
+      end
+
+      if !channels.nil? && channels.length < 1
+        fail ArgumentError, 'invalid value for "channels", number of items must be greater than or equal to 1.'
+      end
+
+      @channels = channels
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event_id Value to be assigned
+    def event_id=(event_id)
+      if !event_id.nil? && event_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "event_id", the character length must be smaller than or equal to 256.'
+      end
+
+      if !event_id.nil? && event_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "event_id", the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
+      if !event_id.nil? && event_id !~ pattern
+        fail ArgumentError, "invalid value for \"event_id\", must conform to the pattern #{pattern}."
+      end
+
+      @event_id = event_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event_type Value to be assigned
+    def event_type=(event_type)
+      if event_type.nil?
+        fail ArgumentError, 'event_type cannot be nil'
+      end
+
+      if event_type.to_s.length > 256
+        fail ArgumentError, 'invalid value for "event_type", the character length must be smaller than or equal to 256.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
+      if event_type !~ pattern
+        fail ArgumentError, "invalid value for \"event_type\", must conform to the pattern #{pattern}."
+      end
+
+      @event_type = event_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] payload_retention_period Value to be assigned
+    def payload_retention_period=(payload_retention_period)
+      if !payload_retention_period.nil? && payload_retention_period > 90
+        fail ArgumentError, 'invalid value for "payload_retention_period", must be smaller than or equal to 90.'
+      end
+
+      if !payload_retention_period.nil? && payload_retention_period < 5
+        fail ArgumentError, 'invalid value for "payload_retention_period", must be greater than or equal to 5.'
+      end
+
+      @payload_retention_period = payload_retention_period
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          channels == o.channels &&
+          event_id == o.event_id &&
+          event_type == o.event_type &&
+          payload == o.payload &&
+          payload_retention_period == o.payload_retention_period
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [channels, event_id, event_type, payload, payload_retention_period].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Svix.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/svix/models/message_broadcast_out.rb

@@ -0,0 +1,251 @@
+=begin
+#Svix API
+
+#Welcome to the Svix API documentation!  Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)  # Introduction  This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).  ## Main concepts  In Svix you have four important entities you will be interacting with:  - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.   ## Authentication  Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys).  <SecurityDefinitions />   ## Code samples  The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).   ## Idempotency  Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response.  To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions.  Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result.  Please note that idempotency is only supported for `POST` requests.   ## Cross-Origin Resource Sharing  This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. 
+
+The version of the OpenAPI document: 1.4.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Svix
+  class MessageBroadcastOut
+    attr_accessor :id
+
+    attr_accessor :status
+
+    attr_accessor :task
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'status' => :'status',
+        :'task' => :'task'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'status' => :'BackgroundTaskStatus',
+        :'task' => :'BackgroundTaskType'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Svix::MessageBroadcastOut` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Svix::MessageBroadcastOut`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'task')
+        self.task = attributes[:'task']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @task.nil?
+        invalid_properties.push('invalid value for "task", task cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @id.nil?
+      return false if @status.nil?
+      return false if @task.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          status == o.status &&
+          task == o.task
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, status, task].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Svix.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/svix/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: svix
 version: !ruby/object:Gem::Version
-  version: 0.85.1
+  version: 1.4.12
 platform: ruby
 authors:
 - Svix
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-10 00:00:00.000000000 Z
+date: 2023-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -87,6 +87,7 @@ files:
 - lib/svix/api/application_api.rb
 - lib/svix/api/authentication_api.rb
 - lib/svix/api/background_tasks_api.rb
+- lib/svix/api/broadcast_api.rb
 - lib/svix/api/endpoint_api.rb
 - lib/svix/api/environment_api.rb
 - lib/svix/api/environment_settings_api.rb
@@ -100,6 +101,7 @@ files:
 - lib/svix/api_error.rb
 - lib/svix/application_api.rb
 - lib/svix/authentication_api.rb
+- lib/svix/background_tasks_api.rb
 - lib/svix/configuration.rb
 - lib/svix/endpoint_api.rb
 - lib/svix/errors.rb
@@ -187,6 +189,8 @@ files:
 - lib/svix/models/message_attempt_headers_out.rb
 - lib/svix/models/message_attempt_out.rb
 - lib/svix/models/message_attempt_trigger_type.rb
+- lib/svix/models/message_broadcast_in.rb
+- lib/svix/models/message_broadcast_out.rb
 - lib/svix/models/message_endpoint_out.rb
 - lib/svix/models/message_in.rb
 - lib/svix/models/message_out.rb