svix 0.83.0 → 0.84.0

data/lib/svix/models/replay_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}`.  <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 ReplayOut
+    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::ReplayOut` 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::ReplayOut`. 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/models/transformation_http_method.rb

@@ -15,8 +15,8 @@ require 'time'
 
 module Svix
   class TransformationHttpMethod
-    PUT = "PUT".freeze
     POST = "POST".freeze
+    PUT = "PUT".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

data/lib/svix/models/validation_error.rb

@@ -14,11 +14,15 @@ require 'date'
 require 'time'
 
 module Svix
+  # Validation errors have their own schema to provide context for invalid requests eg. mismatched types and out of bounds values. There may be any number of these per 422 UNPROCESSABLE ENTITY error.
   class ValidationError
+    # The location as a [`Vec`] of [`String`]s -- often in the form `[\"body\", \"field_name\"]`, `[\"query\", \"field_name\"]`, etc. They may, however, be arbitarily deep.
     attr_accessor :loc
 
+    # The message accompanying the validation error item.
     attr_accessor :msg
 
+    # The type of error, often \"type_error\" or \"value_error\", but sometimes with more context like as \"value_error.number.not_ge\"
     attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/svix/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: svix
 version: !ruby/object:Gem::Version
-  version: 0.83.0
+  version: 0.84.0
 platform: ruby
 authors:
 - Svix
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -86,6 +86,7 @@ files:
 - lib/svix.rb
 - lib/svix/api/application_api.rb
 - lib/svix/api/authentication_api.rb
+- lib/svix/api/background_tasks_api.rb
 - lib/svix/api/endpoint_api.rb
 - lib/svix/api/environment_api.rb
 - lib/svix/api/environment_settings_api.rb
@@ -111,12 +112,18 @@ files:
 - lib/svix/models/app_portal_access_out.rb
 - lib/svix/models/application_in.rb
 - lib/svix/models/application_out.rb
+- lib/svix/models/application_patch.rb
 - lib/svix/models/application_stats.rb
 - lib/svix/models/application_token_expire_in.rb
 - lib/svix/models/attempt_statistics_data.rb
 - lib/svix/models/attempt_statistics_response.rb
+- lib/svix/models/background_task_out.rb
+- lib/svix/models/background_task_out_common.rb
+- lib/svix/models/background_task_status.rb
+- lib/svix/models/background_task_type.rb
 - lib/svix/models/border_radius_config.rb
 - lib/svix/models/border_radius_enum.rb
+- lib/svix/models/calculate_app_stats_in.rb
 - lib/svix/models/custom_color_palette.rb
 - lib/svix/models/custom_theme_override.rb
 - lib/svix/models/dashboard_access_out.rb
@@ -132,6 +139,7 @@ files:
 - lib/svix/models/endpoint_in.rb
 - lib/svix/models/endpoint_message_out.rb
 - lib/svix/models/endpoint_out.rb
+- lib/svix/models/endpoint_patch.rb
 - lib/svix/models/endpoint_secret_out.rb
 - lib/svix/models/endpoint_secret_rotate_in.rb
 - lib/svix/models/endpoint_stats.rb
@@ -149,6 +157,7 @@ files:
 - lib/svix/models/event_type_example_out.rb
 - lib/svix/models/event_type_in.rb
 - lib/svix/models/event_type_out.rb
+- lib/svix/models/event_type_patch.rb
 - lib/svix/models/event_type_schema_in.rb
 - lib/svix/models/event_type_update.rb
 - lib/svix/models/font_size_config.rb
@@ -160,6 +169,7 @@ files:
 - lib/svix/models/integration_update.rb
 - lib/svix/models/list_response_application_out.rb
 - lib/svix/models/list_response_application_stats.rb
+- lib/svix/models/list_response_background_task_out.rb
 - lib/svix/models/list_response_endpoint_message_out.rb
 - lib/svix/models/list_response_endpoint_out.rb
 - lib/svix/models/list_response_event_type_out.rb
@@ -183,14 +193,15 @@ files:
 - lib/svix/models/message_status.rb
 - lib/svix/models/ordering.rb
 - lib/svix/models/recover_in.rb
+- lib/svix/models/recover_out.rb
 - lib/svix/models/replay_in.rb
+- lib/svix/models/replay_out.rb
 - lib/svix/models/settings_in.rb
 - lib/svix/models/settings_out.rb
 - lib/svix/models/statistics_period.rb
 - lib/svix/models/status_code_class.rb
 - lib/svix/models/transformation_http_method.rb
 - lib/svix/models/validation_error.rb
-- lib/svix/models/webhook_types.rb
 - lib/svix/svix.rb
 - lib/svix/util.rb
 - lib/svix/version.rb