svix 1.56.0 → 1.58.0

data/lib/svix/models/background_task_finished_event2.rb

@@ -0,0 +1,331 @@
+=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
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Svix
+  class BackgroundTaskFinishedEvent2
+    attr_accessor :data
+
+    attr_accessor :status
+
+    attr_accessor :task
+
+    # The QueueBackgroundTask's ID.
+    attr_accessor :task_id
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'status' => :'status',
+        :'task' => :'task',
+        :'task_id' => :'taskId'
+      }
+    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' => :'Data',
+        :'status' => :'BackgroundTaskStatus',
+        :'task' => :'BackgroundTaskType',
+        :'task_id' => :'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::BackgroundTaskFinishedEvent2` 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::BackgroundTaskFinishedEvent2`. 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')
+        self.data = attributes[:'data']
+      else
+        self.data = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'task')
+        self.task = attributes[:'task']
+      else
+        self.task = nil
+      end
+
+      if attributes.key?(:'task_id')
+        self.task_id = attributes[:'task_id']
+      else
+        self.task_id = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data 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
+
+      if @task_id.nil?
+        invalid_properties.push('invalid value for "task_id", task_id cannot be nil.')
+      end
+
+      if @task_id.to_s.length > 33
+        invalid_properties.push('invalid value for "task_id", the character length must be smaller than or equal to 33.')
+      end
+
+      if @task_id.to_s.length < 33
+        invalid_properties.push('invalid value for "task_id", the character length must be great than or equal to 33.')
+      end
+
+      pattern = Regexp.new(/^qtask_[A-Za-z0-9]{27}$/)
+      if @task_id !~ pattern
+        invalid_properties.push("invalid value for \"task_id\", must conform to the pattern #{pattern}.")
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @data.nil?
+      return false if @status.nil?
+      return false if @task.nil?
+      return false if @task_id.nil?
+      return false if @task_id.to_s.length > 33
+      return false if @task_id.to_s.length < 33
+      return false if @task_id !~ Regexp.new(/^qtask_[A-Za-z0-9]{27}$/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] task_id Value to be assigned
+    def task_id=(task_id)
+      if task_id.nil?
+        fail ArgumentError, 'task_id cannot be nil'
+      end
+
+      if task_id.to_s.length > 33
+        fail ArgumentError, 'invalid value for "task_id", the character length must be smaller than or equal to 33.'
+      end
+
+      if task_id.to_s.length < 33
+        fail ArgumentError, 'invalid value for "task_id", the character length must be great than or equal to 33.'
+      end
+
+      pattern = Regexp.new(/^qtask_[A-Za-z0-9]{27}$/)
+      if task_id !~ pattern
+        fail ArgumentError, "invalid value for \"task_id\", must conform to the pattern #{pattern}."
+      end
+
+      @task_id = task_id
+    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 &&
+          status == o.status &&
+          task == o.task &&
+          task_id == o.task_id
+    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, status, task, task_id].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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_any_of) || 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/background_task_out.rb

@@ -17,6 +17,7 @@ module Svix
   class BackgroundTaskOut
     attr_accessor :data
 
+    # The QueueBackgroundTask's ID.
     attr_accessor :id
 
     attr_accessor :status
@@ -129,6 +130,19 @@ module Svix
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
+      if @id.to_s.length > 33
+        invalid_properties.push('invalid value for "id", the character length must be smaller than or equal to 33.')
+      end
+
+      if @id.to_s.length < 33
+        invalid_properties.push('invalid value for "id", the character length must be great than or equal to 33.')
+      end
+
+      pattern = Regexp.new(/^qtask_[A-Za-z0-9]{27}$/)
+      if @id !~ pattern
+        invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
+      end
+
       if @status.nil?
         invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
@@ -146,11 +160,37 @@ module Svix
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @data.nil?
       return false if @id.nil?
+      return false if @id.to_s.length > 33
+      return false if @id.to_s.length < 33
+      return false if @id !~ Regexp.new(/^qtask_[A-Za-z0-9]{27}$/)
       return false if @status.nil?
       return false if @task.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      if id.to_s.length > 33
+        fail ArgumentError, 'invalid value for "id", the character length must be smaller than or equal to 33.'
+      end
+
+      if id.to_s.length < 33
+        fail ArgumentError, 'invalid value for "id", the character length must be great than or equal to 33.'
+      end
+
+      pattern = Regexp.new(/^qtask_[A-Za-z0-9]{27}$/)
+      if id !~ pattern
+        fail ArgumentError, "invalid value for \"id\", must conform to the pattern #{pattern}."
+      end
+
+      @id = id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/svix/models/background_task_type.rb

@@ -21,9 +21,10 @@ module Svix
     MESSAGE_BROADCAST = "message.broadcast".freeze
     SDK_GENERATE = "sdk.generate".freeze
     EVENT_TYPE_AGGREGATE = "event-type.aggregate".freeze
+    APPLICATION_PURGE_CONTENT = "application.purge_content".freeze
 
     def self.all_vars
-      @all_vars ||= [ENDPOINT_REPLAY, ENDPOINT_RECOVER, APPLICATION_STATS, MESSAGE_BROADCAST, SDK_GENERATE, EVENT_TYPE_AGGREGATE].freeze
+      @all_vars ||= [ENDPOINT_REPLAY, ENDPOINT_RECOVER, APPLICATION_STATS, MESSAGE_BROADCAST, SDK_GENERATE, EVENT_TYPE_AGGREGATE, APPLICATION_PURGE_CONTENT].freeze
     end
 
     # Builds the enum from string

data/lib/svix/models/{template_in.rb → connector_in.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Svix
-  class TemplateIn
+  class ConnectorIn
     attr_accessor :description
 
     attr_accessor :feature_flag
@@ -83,7 +83,7 @@ module Svix
         :'filter_types' => :'Array<String>',
         :'instructions' => :'String',
         :'instructions_link' => :'String',
-        :'kind' => :'TransformationTemplateKind',
+        :'kind' => :'ConnectorKind',
         :'logo' => :'String',
         :'name' => :'String',
         :'transformation' => :'String'
@@ -103,13 +103,13 @@ module Svix
     # @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::TemplateIn` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Svix::ConnectorIn` 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::TemplateIn`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Svix::ConnectorIn`. 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
       }

data/lib/svix/models/{transformation_template_kind.rb → connector_kind.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Svix
-  class TransformationTemplateKind
+  class ConnectorKind
     CUSTOM = "Custom".freeze
     CUSTOMER_IO = "CustomerIO".freeze
     DISCORD = "Discord".freeze
@@ -43,8 +43,8 @@ module Svix
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      return value if TransformationTemplateKind.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #TransformationTemplateKind"
+      return value if ConnectorKind.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ConnectorKind"
     end
   end
 end

data/lib/svix/models/create_stream_in.rb

@@ -15,14 +15,14 @@ require 'time'
 
 module Svix
   class CreateStreamIn
-    attr_accessor :messages
+    attr_accessor :events
 
     attr_accessor :stream
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'messages' => :'messages',
+        :'events' => :'events',
         :'stream' => :'stream'
       }
     end
@@ -35,7 +35,7 @@ module Svix
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'messages' => :'Array<EventIn>',
+        :'events' => :'Array<EventIn>',
         :'stream' => :'StreamIn'
       }
     end
@@ -61,12 +61,12 @@ module Svix
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'messages')
-        if (value = attributes[:'messages']).is_a?(Array)
-          self.messages = value
+      if attributes.key?(:'events')
+        if (value = attributes[:'events']).is_a?(Array)
+          self.events = value
         end
       else
-        self.messages = nil
+        self.events = nil
       end
 
       if attributes.key?(:'stream')
@@ -79,8 +79,8 @@ module Svix
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @messages.nil?
-        invalid_properties.push('invalid value for "messages", messages cannot be nil.')
+      if @events.nil?
+        invalid_properties.push('invalid value for "events", events cannot be nil.')
       end
 
       invalid_properties
@@ -90,7 +90,7 @@ module Svix
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @messages.nil?
+      return false if @events.nil?
       true
     end
 
@@ -99,7 +99,7 @@ module Svix
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          messages == o.messages &&
+          events == o.events &&
           stream == o.stream
     end
 
@@ -112,7 +112,7 @@ module Svix
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [messages, stream].hash
+      [events, stream].hash
     end
 
     # Builds the object from hash

data/lib/svix/models/data.rb

@@ -0,0 +1,108 @@
+=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
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Svix
+  # A copy of [`backgroundtask::Data`], but serialized with camelCase fields for customers.
+  module Data
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'DataAnyOf',
+          :'DataAnyOf1',
+          :'DataAnyOf2',
+          :'DataAnyOf3',
+          :'DataAnyOf4'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of anyOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_any_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_any_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.parse(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = Svix.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_any_of) # nested anyOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end