svix 1.30.0 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87c95bcfa216f8fd64498a21379c7acd075e79c11ef5619d0ba8d1f7c2330d98
-  data.tar.gz: 824c4aaa3488ad2f60389303ab751d926ecd8f8535dec358cdd32da3e0491e85
+  metadata.gz: 22bfe8f4a502306bc13437d46b40935eb41a7efe25ac096e1056ba9e6eca19c6
+  data.tar.gz: 9749c603d86b9401880aa577fc4ae2cba3e9f856f45a654f256179b4626cc483
 SHA512:
-  metadata.gz: cb01ce60809e2c0d8c9ced17be0ff901b27c0aef917fdb66467857e4ee8194fdca336219fab24cf58337842e22536c40299d9713a55ab6aac958678b617b7f23
-  data.tar.gz: 6fa418bb9d1f8d2de1c3ced7fd4ef97dfff61a65f5fc72d00e9787863ea566685a30d0d7cdcf63fb2bdbe5f71204b8c54b519a313e76bc0ef3ed654a4cc925c9
+  metadata.gz: 3a3ef6ce6ce7bf4f9ff383c2bb234a16fab5136822720eb7360b4ae3a75b4e200f0f76aa5751c9bbcd96a9dc124ae8bd88195bd01c550fd23a1765d8943a7ebe
+  data.tar.gz: ef6156f84b5f5b2233ac7c3a6430e6658f0022d155566d153354e78b16ebf78f6e4a9f64b4d52dd9e1729acc01749e911f7487db956960075f1756c7697621fd

data/Gemfile.lock

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

data/lib/svix/models/app_portal_access_in.rb

@@ -15,6 +15,8 @@ require 'time'
 
 module Svix
   class AppPortalAccessIn
+    attr_accessor :application
+
     # How long the token will be valid for, in seconds.  Valid values are between 1 hour and 7 days. The default is 7 days.
     attr_accessor :expiry
 
@@ -27,6 +29,7 @@ module Svix
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'application' => :'application',
         :'expiry' => :'expiry',
         :'feature_flags' => :'featureFlags',
         :'read_only' => :'readOnly'
@@ -41,6 +44,7 @@ module Svix
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'application' => :'ApplicationIn',
         :'expiry' => :'Integer',
         :'feature_flags' => :'Array<String>',
         :'read_only' => :'Boolean'
@@ -70,6 +74,10 @@ module Svix
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'application')
+        self.application = attributes[:'application']
+      end
+
       if attributes.key?(:'expiry')
         self.expiry = attributes[:'expiry']
       else
@@ -135,6 +143,7 @@ module Svix
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          application == o.application &&
           expiry == o.expiry &&
           feature_flags == o.feature_flags &&
           read_only == o.read_only
@@ -149,7 +158,7 @@ module Svix
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [expiry, feature_flags, read_only].hash
+      [application, expiry, feature_flags, read_only].hash
     end
 
     # Builds the object from hash

data/lib/svix/models/create_stream_in.rb

@@ -15,12 +15,12 @@ require 'time'
 
 module Svix
   class CreateStreamIn
-    attr_accessor :events
+    attr_accessor :messages
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'events' => :'events'
+        :'messages' => :'messages'
       }
     end
 
@@ -32,7 +32,7 @@ module Svix
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'events' => :'Array<EventIn>'
+        :'messages' => :'Array<EventIn>'
       }
     end
 
@@ -57,9 +57,9 @@ module Svix
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'events')
-        if (value = attributes[:'events']).is_a?(Array)
-          self.events = value
+      if attributes.key?(:'messages')
+        if (value = attributes[:'messages']).is_a?(Array)
+          self.messages = value
         end
       end
     end
@@ -68,8 +68,8 @@ module Svix
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @events.nil?
-        invalid_properties.push('invalid value for "events", events cannot be nil.')
+      if @messages.nil?
+        invalid_properties.push('invalid value for "messages", messages cannot be nil.')
       end
 
       invalid_properties
@@ -78,7 +78,7 @@ module Svix
     # 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 @events.nil?
+      return false if @messages.nil?
       true
     end
 
@@ -87,7 +87,7 @@ module Svix
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          events == o.events
+          messages == o.messages
     end
 
     # @see the `==` method
@@ -99,7 +99,7 @@ module Svix
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [events].hash
+      [messages].hash
     end
 
     # Builds the object from hash

data/lib/svix/models/list_response_stream_out.rb

@@ -0,0 +1,259 @@
+=begin
+#Svix API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.1.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Svix
+  class ListResponseStreamOut
+    attr_accessor :data
+
+    attr_accessor :done
+
+    attr_accessor :iterator
+
+    attr_accessor :prev_iterator
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'done' => :'done',
+        :'iterator' => :'iterator',
+        :'prev_iterator' => :'prevIterator'
+      }
+    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
+      {
+        :'data' => :'Array<StreamOut>',
+        :'done' => :'Boolean',
+        :'iterator' => :'String',
+        :'prev_iterator' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'iterator',
+        :'prev_iterator'
+      ])
+    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::ListResponseStreamOut` 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::ListResponseStreamOut`. 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?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+      if attributes.key?(:'done')
+        self.done = attributes[:'done']
+      end
+
+      if attributes.key?(:'iterator')
+        self.iterator = attributes[:'iterator']
+      end
+
+      if attributes.key?(:'prev_iterator')
+        self.prev_iterator = attributes[:'prev_iterator']
+      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 @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      end
+
+      if @done.nil?
+        invalid_properties.push('invalid value for "done", done 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 @data.nil?
+      return false if @done.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 &&
+          data == o.data &&
+          done == o.done &&
+          iterator == o.iterator &&
+          prev_iterator == o.prev_iterator
+    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
+      [data, done, iterator, prev_iterator].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_in.rb

@@ -26,6 +26,10 @@ module Svix
 
     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
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -35,6 +39,7 @@ module Svix
         :'event_id' => :'eventId',
         :'event_type' => :'eventType',
         :'payload' => :'payload',
+        :'payload_retention_hours' => :'payloadRetentionHours',
         :'payload_retention_period' => :'payloadRetentionPeriod'
       }
     end
@@ -51,6 +56,7 @@ module Svix
         :'event_id' => :'String',
         :'event_type' => :'String',
         :'payload' => :'Object',
+        :'payload_retention_hours' => :'Integer',
         :'payload_retention_period' => :'Integer'
       }
     end
@@ -60,6 +66,8 @@ module Svix
       Set.new([
         :'channels',
         :'event_id',
+        :'payload_retention_hours',
+        :'payload_retention_period'
       ])
     end
 
@@ -96,6 +104,10 @@ module Svix
         self.payload = attributes[:'payload']
       end
 
+      if attributes.key?(:'payload_retention_hours')
+        self.payload_retention_hours = attributes[:'payload_retention_hours']
+      end
+
       if attributes.key?(:'payload_retention_period')
         self.payload_retention_period = attributes[:'payload_retention_period']
       else
@@ -145,12 +157,20 @@ module Svix
         invalid_properties.push('invalid value for "payload", payload cannot be nil.')
       end
 
+      if !@payload_retention_hours.nil? && @payload_retention_hours > 2160
+        invalid_properties.push('invalid value for "payload_retention_hours", must be smaller than or equal to 2160.')
+      end
+
+      if !@payload_retention_hours.nil? && @payload_retention_hours < 1
+        invalid_properties.push('invalid value for "payload_retention_hours", must be greater than or equal to 1.')
+      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.')
+      if !@payload_retention_period.nil? && @payload_retention_period < 1
+        invalid_properties.push('invalid value for "payload_retention_period", must be greater than or equal to 1.')
       end
 
       invalid_properties
@@ -168,8 +188,10 @@ module Svix
       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_hours.nil? && @payload_retention_hours > 2160
+      return false if !@payload_retention_hours.nil? && @payload_retention_hours < 1
       return false if !@payload_retention_period.nil? && @payload_retention_period > 90
-      return false if !@payload_retention_period.nil? && @payload_retention_period < 5
+      return false if !@payload_retention_period.nil? && @payload_retention_period < 1
       true
     end
 
@@ -225,6 +247,20 @@ module Svix
       @event_type = event_type
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] payload_retention_hours Value to be assigned
+    def payload_retention_hours=(payload_retention_hours)
+      if !payload_retention_hours.nil? && payload_retention_hours > 2160
+        fail ArgumentError, 'invalid value for "payload_retention_hours", must be smaller than or equal to 2160.'
+      end
+
+      if !payload_retention_hours.nil? && payload_retention_hours < 1
+        fail ArgumentError, 'invalid value for "payload_retention_hours", must be greater than or equal to 1.'
+      end
+
+      @payload_retention_hours = payload_retention_hours
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] payload_retention_period Value to be assigned
     def payload_retention_period=(payload_retention_period)
@@ -232,8 +268,8 @@ module Svix
         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.'
+      if !payload_retention_period.nil? && payload_retention_period < 1
+        fail ArgumentError, 'invalid value for "payload_retention_period", must be greater than or equal to 1.'
       end
 
       @payload_retention_period = payload_retention_period
@@ -248,6 +284,7 @@ module Svix
           event_id == o.event_id &&
           event_type == o.event_type &&
           payload == o.payload &&
+          payload_retention_hours == o.payload_retention_hours &&
           payload_retention_period == o.payload_retention_period
     end
 
@@ -260,7 +297,7 @@ module Svix
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [channels, event_id, event_type, payload, payload_retention_period].hash
+      [channels, event_id, event_type, payload, payload_retention_hours, payload_retention_period].hash
     end
 
     # Builds the object from hash

data/lib/svix/models/message_in.rb

@@ -26,8 +26,13 @@ module Svix
     # 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
@@ -44,6 +49,7 @@ module Svix
         :'event_id' => :'eventId',
         :'event_type' => :'eventType',
         :'payload' => :'payload',
+        :'payload_retention_hours' => :'payloadRetentionHours',
         :'payload_retention_period' => :'payloadRetentionPeriod',
         :'tags' => :'tags',
         :'transformations_params' => :'transformationsParams'
@@ -63,6 +69,7 @@ module Svix
         :'event_id' => :'String',
         :'event_type' => :'String',
         :'payload' => :'Object',
+        :'payload_retention_hours' => :'Integer',
         :'payload_retention_period' => :'Integer',
         :'tags' => :'Array<String>',
         :'transformations_params' => :'Object'
@@ -74,6 +81,8 @@ module Svix
       Set.new([
         :'channels',
         :'event_id',
+        :'payload_retention_hours',
+        :'payload_retention_period',
         :'tags',
         :'transformations_params'
       ])
@@ -116,6 +125,10 @@ module Svix
         self.payload = attributes[:'payload']
       end
 
+      if attributes.key?(:'payload_retention_hours')
+        self.payload_retention_hours = attributes[:'payload_retention_hours']
+      end
+
       if attributes.key?(:'payload_retention_period')
         self.payload_retention_period = attributes[:'payload_retention_period']
       else
@@ -175,12 +188,20 @@ module Svix
         invalid_properties.push('invalid value for "payload", payload cannot be nil.')
       end
 
+      if !@payload_retention_hours.nil? && @payload_retention_hours > 2160
+        invalid_properties.push('invalid value for "payload_retention_hours", must be smaller than or equal to 2160.')
+      end
+
+      if !@payload_retention_hours.nil? && @payload_retention_hours < 1
+        invalid_properties.push('invalid value for "payload_retention_hours", must be greater than or equal to 1.')
+      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.')
+      if !@payload_retention_period.nil? && @payload_retention_period < 1
+        invalid_properties.push('invalid value for "payload_retention_period", must be greater than or equal to 1.')
       end
 
       if !@tags.nil? && @tags.length > 5
@@ -206,8 +227,10 @@ module Svix
       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_hours.nil? && @payload_retention_hours > 2160
+      return false if !@payload_retention_hours.nil? && @payload_retention_hours < 1
       return false if !@payload_retention_period.nil? && @payload_retention_period > 90
-      return false if !@payload_retention_period.nil? && @payload_retention_period < 5
+      return false if !@payload_retention_period.nil? && @payload_retention_period < 1
       return false if !@tags.nil? && @tags.length > 5
       return false if !@tags.nil? && @tags.length < 1
       true
@@ -265,6 +288,20 @@ module Svix
       @event_type = event_type
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] payload_retention_hours Value to be assigned
+    def payload_retention_hours=(payload_retention_hours)
+      if !payload_retention_hours.nil? && payload_retention_hours > 2160
+        fail ArgumentError, 'invalid value for "payload_retention_hours", must be smaller than or equal to 2160.'
+      end
+
+      if !payload_retention_hours.nil? && payload_retention_hours < 1
+        fail ArgumentError, 'invalid value for "payload_retention_hours", must be greater than or equal to 1.'
+      end
+
+      @payload_retention_hours = payload_retention_hours
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] payload_retention_period Value to be assigned
     def payload_retention_period=(payload_retention_period)
@@ -272,8 +309,8 @@ module Svix
         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.'
+      if !payload_retention_period.nil? && payload_retention_period < 1
+        fail ArgumentError, 'invalid value for "payload_retention_period", must be greater than or equal to 1.'
       end
 
       @payload_retention_period = payload_retention_period
@@ -303,6 +340,7 @@ module Svix
           event_id == o.event_id &&
           event_type == o.event_type &&
           payload == o.payload &&
+          payload_retention_hours == o.payload_retention_hours &&
           payload_retention_period == o.payload_retention_period &&
           tags == o.tags &&
           transformations_params == o.transformations_params
@@ -317,7 +355,7 @@ module Svix
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [application, channels, event_id, event_type, payload, payload_retention_period, tags, transformations_params].hash
+      [application, channels, event_id, event_type, payload, payload_retention_hours, payload_retention_period, tags, transformations_params].hash
     end
 
     # Builds the object from hash