svix 0.56.0 → 0.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 999f9ef3bed7cf438ed92938fe75853bb8f703c32ed2fd324bedf9820f13da49
-  data.tar.gz: 0c7a697c590244a390ba0ae2e5e3c230178f707f669ab6417338845b5482e636
+  metadata.gz: d985c30c15c4150663804aaf8153ce5c610abb55de45ac585f99122d75374bb1
+  data.tar.gz: 0c6f108f008f567491455101a3a5b86287220db28a8247f2bfa378d12fac91d0
 SHA512:
-  metadata.gz: 530c165ecaf4d0cd7140f6f421a1add8e47037275afcb7996eaa96c97f3f89f989dc25cbc17995f107be97b03e8286c393f29ed24237222797604b4a26b940f4
-  data.tar.gz: 6741ace4501b2e3955d84788d9b80e3a39c48ee40025f9c217f583b01d8735384d3655f724fe854aea7b7b002a6b98dfb1311ddd9062d75595c01a9776d79d5a
+  metadata.gz: df2b3d3575c197b038becabeb4523d75015d26e66d8f3466eb335ad6849e29a15a2b1173739cec52fcdf33d8c7cfd5cf41c05fb0f4af9725d7d0d4fe1a2ae717
+  data.tar.gz: eaeb2352bb256fcaffe9583e6762faabe60566718a3ee446bd2e13cdf4fa0c9657351088cf15da989523e5efcda4173cf615a57e7e511b527a3df1fa10c53080

data/Gemfile.lock

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

data/lib/svix/api/application_api.rb

@@ -23,7 +23,7 @@ module Svix
     # Create a new application.
     # @param application_in [ApplicationIn] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :get_if_exists  (default to false)
+    # @option opts [Boolean] :get_if_exists Get an existing application, or create a new one if doesn't exist. It's two separate functions in the libs. (default to false)
     # @option opts [String] :idempotency_key The request's idempotency key
     # @return [ApplicationOut]
     def create_application_api_v1_app_post(application_in, opts = {})
@@ -35,7 +35,7 @@ module Svix
     # Create a new application.
     # @param application_in [ApplicationIn] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :get_if_exists 
+    # @option opts [Boolean] :get_if_exists Get an existing application, or create a new one if doesn't exist. It's two separate functions in the libs.
     # @option opts [String] :idempotency_key The request's idempotency key
     # @return [Array<(ApplicationOut, Integer, Hash)>] ApplicationOut data, response status code and response headers
     def create_application_api_v1_app_post_with_http_info(application_in, opts = {})

data/lib/svix/api/authentication_api.rb

@@ -19,8 +19,8 @@ module Svix
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Get Dashboard Access
-    # Use this function to get magic links (and authentication codes) for connecting your users to the management UIs.
+    # Get App Portal Access
+    # Use this function to get magic links (and authentication codes) for connecting your users to the Application Portal.
     # @param app_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request's idempotency key
@@ -30,8 +30,8 @@ module Svix
       data
     end
 
-    # Get Dashboard Access
-    # Use this function to get magic links (and authentication codes) for connecting your users to the management UIs.
+    # Get App Portal Access
+    # Use this function to get magic links (and authentication codes) for connecting your users to the Application Portal.
     # @param app_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request's idempotency key

data/lib/svix/api/message_api.rb

@@ -20,7 +20,7 @@ module Svix
       @api_client = api_client
     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.
+    # 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).
     # @param app_id [String] 
     # @param message_in [MessageIn] 
     # @param [Hash] opts the optional parameters
@@ -33,7 +33,7 @@ module Svix
     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.
+    # 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).
     # @param app_id [String] 
     # @param message_in [MessageIn] 
     # @param [Hash] opts the optional parameters

data/lib/svix/api/message_attempt_api.rb

@@ -123,6 +123,110 @@ module Svix
       return data, status_code, headers
     end
 
+    # Get Attempt Headers
+    # Calculate and return headers used on a given message attempt
+    # @param app_id [String] 
+    # @param msg_id [String] 
+    # @param attempt_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request's idempotency key
+    # @return [MessageAttemptHeadersOut]
+    def get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get(app_id, msg_id, attempt_id, opts = {})
+      data, _status_code, _headers = get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get_with_http_info(app_id, msg_id, attempt_id, opts)
+      data
+    end
+
+    # Get Attempt Headers
+    # Calculate and return headers used on a given message attempt
+    # @param app_id [String] 
+    # @param msg_id [String] 
+    # @param attempt_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request's idempotency key
+    # @return [Array<(MessageAttemptHeadersOut, Integer, Hash)>] MessageAttemptHeadersOut data, response status code and response headers
+    def get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get_with_http_info(app_id, msg_id, attempt_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MessageAttemptApi.get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get ...'
+      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 MessageAttemptApi.get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get"
+      end
+      if @api_client.config.client_side_validation && app_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "app_id" when calling MessageAttemptApi.get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get, 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 MessageAttemptApi.get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get, 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 MessageAttemptApi.get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'msg_id' is set
+      if @api_client.config.client_side_validation && msg_id.nil?
+        fail ArgumentError, "Missing the required parameter 'msg_id' when calling MessageAttemptApi.get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get"
+      end
+      if @api_client.config.client_side_validation && msg_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "msg_id" when calling MessageAttemptApi.get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && msg_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "msg_id" when calling MessageAttemptApi.get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get, 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 && msg_id !~ pattern
+        fail ArgumentError, "invalid value for 'msg_id' when calling MessageAttemptApi.get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'attempt_id' is set
+      if @api_client.config.client_side_validation && attempt_id.nil?
+        fail ArgumentError, "Missing the required parameter 'attempt_id' when calling MessageAttemptApi.get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get"
+      end
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}/headers/'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'msg_id' + '}', CGI.escape(msg_id.to_s)).sub('{' + 'attempt_id' + '}', CGI.escape(attempt_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'])
+      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]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MessageAttemptHeadersOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"MessageAttemptApi.get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MessageAttemptApi#get_attempt_headers_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_headers_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List Attempted Destinations
     # `msg_id`: Use a message id or a message `eventId`
     # @param msg_id [String] 

data/lib/svix/models/message_attempt_headers_out.rb

@@ -0,0 +1,225 @@
+=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}`.  <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
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Svix
+  class MessageAttemptHeadersOut
+    attr_accessor :sent_headers
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sent_headers' => :'sentHeaders'
+      }
+    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
+      {
+        :'sent_headers' => :'Hash<String, String>'
+      }
+    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::MessageAttemptHeadersOut` 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::MessageAttemptHeadersOut`. 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?(:'sent_headers')
+        if (value = attributes[:'sent_headers']).is_a?(Hash)
+          self.sent_headers = value
+        end
+      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 @sent_headers.nil?
+        invalid_properties.push('invalid value for "sent_headers", sent_headers 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 @sent_headers.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 &&
+          sent_headers == o.sent_headers
+    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
+      [sent_headers].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.56.0"
+  VERSION = "0.57.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: svix
 version: !ruby/object:Gem::Version
-  version: 0.56.0
+  version: 0.57.0
 platform: ruby
 authors:
 - Svix
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-11 00:00:00.000000000 Z
+date: 2022-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -163,6 +163,7 @@ files:
 - lib/svix/models/message_attempt_failed_data.rb
 - lib/svix/models/message_attempt_failing_event.rb
 - lib/svix/models/message_attempt_failing_event_data.rb
+- 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_endpoint_out.rb