=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}`. ## 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 SettingsOut attr_accessor :color_palette_dark attr_accessor :color_palette_light attr_accessor :custom_base_font_size attr_accessor :custom_color attr_accessor :custom_font_family attr_accessor :custom_logo_url attr_accessor :custom_theme_override attr_accessor :disable_endpoint_on_failure attr_accessor :display_name attr_accessor :enable_channels attr_accessor :enable_integration_management attr_accessor :enable_transformations attr_accessor :enforce_https attr_accessor :event_catalog_published attr_accessor :read_only # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'color_palette_dark' => :'colorPaletteDark', :'color_palette_light' => :'colorPaletteLight', :'custom_base_font_size' => :'customBaseFontSize', :'custom_color' => :'customColor', :'custom_font_family' => :'customFontFamily', :'custom_logo_url' => :'customLogoUrl', :'custom_theme_override' => :'customThemeOverride', :'disable_endpoint_on_failure' => :'disableEndpointOnFailure', :'display_name' => :'displayName', :'enable_channels' => :'enableChannels', :'enable_integration_management' => :'enableIntegrationManagement', :'enable_transformations' => :'enableTransformations', :'enforce_https' => :'enforceHttps', :'event_catalog_published' => :'eventCatalogPublished', :'read_only' => :'readOnly' } 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 { :'color_palette_dark' => :'CustomColorPalette', :'color_palette_light' => :'CustomColorPalette', :'custom_base_font_size' => :'Integer', :'custom_color' => :'String', :'custom_font_family' => :'String', :'custom_logo_url' => :'String', :'custom_theme_override' => :'CustomThemeOverride', :'disable_endpoint_on_failure' => :'Boolean', :'display_name' => :'String', :'enable_channels' => :'Boolean', :'enable_integration_management' => :'Boolean', :'enable_transformations' => :'Boolean', :'enforce_https' => :'Boolean', :'event_catalog_published' => :'Boolean', :'read_only' => :'Boolean' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ :'custom_base_font_size', :'custom_color', :'custom_font_family', :'custom_logo_url', :'display_name', :'event_catalog_published', ]) 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::SettingsOut` 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::SettingsOut`. 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?(:'color_palette_dark') self.color_palette_dark = attributes[:'color_palette_dark'] end if attributes.key?(:'color_palette_light') self.color_palette_light = attributes[:'color_palette_light'] end if attributes.key?(:'custom_base_font_size') self.custom_base_font_size = attributes[:'custom_base_font_size'] end if attributes.key?(:'custom_color') self.custom_color = attributes[:'custom_color'] end if attributes.key?(:'custom_font_family') self.custom_font_family = attributes[:'custom_font_family'] end if attributes.key?(:'custom_logo_url') self.custom_logo_url = attributes[:'custom_logo_url'] end if attributes.key?(:'custom_theme_override') self.custom_theme_override = attributes[:'custom_theme_override'] end if attributes.key?(:'disable_endpoint_on_failure') self.disable_endpoint_on_failure = attributes[:'disable_endpoint_on_failure'] else self.disable_endpoint_on_failure = true end if attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] end if attributes.key?(:'enable_channels') self.enable_channels = attributes[:'enable_channels'] else self.enable_channels = false end if attributes.key?(:'enable_integration_management') self.enable_integration_management = attributes[:'enable_integration_management'] else self.enable_integration_management = false end if attributes.key?(:'enable_transformations') self.enable_transformations = attributes[:'enable_transformations'] else self.enable_transformations = false end if attributes.key?(:'enforce_https') self.enforce_https = attributes[:'enforce_https'] else self.enforce_https = true end if attributes.key?(:'event_catalog_published') self.event_catalog_published = attributes[:'event_catalog_published'] else self.event_catalog_published = false end if attributes.key?(:'read_only') self.read_only = attributes[:'read_only'] else self.read_only = false 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 pattern = Regexp.new(/^[a-zA-Z0-9\-_ ]+$/) if !@custom_font_family.nil? && @custom_font_family !~ pattern invalid_properties.push("invalid value for \"custom_font_family\", must conform to the pattern #{pattern}.") end if !@custom_logo_url.nil? && @custom_logo_url.to_s.length > 65536 invalid_properties.push('invalid value for "custom_logo_url", the character length must be smaller than or equal to 65536.') end if !@custom_logo_url.nil? && @custom_logo_url.to_s.length < 1 invalid_properties.push('invalid value for "custom_logo_url", the character length must be great than or equal to 1.') 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 !@custom_font_family.nil? && @custom_font_family !~ Regexp.new(/^[a-zA-Z0-9\-_ ]+$/) return false if !@custom_logo_url.nil? && @custom_logo_url.to_s.length > 65536 return false if !@custom_logo_url.nil? && @custom_logo_url.to_s.length < 1 true end # Custom attribute writer method with validation # @param [Object] custom_font_family Value to be assigned def custom_font_family=(custom_font_family) pattern = Regexp.new(/^[a-zA-Z0-9\-_ ]+$/) if !custom_font_family.nil? && custom_font_family !~ pattern fail ArgumentError, "invalid value for \"custom_font_family\", must conform to the pattern #{pattern}." end @custom_font_family = custom_font_family end # Custom attribute writer method with validation # @param [Object] custom_logo_url Value to be assigned def custom_logo_url=(custom_logo_url) if !custom_logo_url.nil? && custom_logo_url.to_s.length > 65536 fail ArgumentError, 'invalid value for "custom_logo_url", the character length must be smaller than or equal to 65536.' end if !custom_logo_url.nil? && custom_logo_url.to_s.length < 1 fail ArgumentError, 'invalid value for "custom_logo_url", the character length must be great than or equal to 1.' end @custom_logo_url = custom_logo_url 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 && color_palette_dark == o.color_palette_dark && color_palette_light == o.color_palette_light && custom_base_font_size == o.custom_base_font_size && custom_color == o.custom_color && custom_font_family == o.custom_font_family && custom_logo_url == o.custom_logo_url && custom_theme_override == o.custom_theme_override && disable_endpoint_on_failure == o.disable_endpoint_on_failure && display_name == o.display_name && enable_channels == o.enable_channels && enable_integration_management == o.enable_integration_management && enable_transformations == o.enable_transformations && enforce_https == o.enforce_https && event_catalog_published == o.event_catalog_published && read_only == o.read_only 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 [color_palette_dark, color_palette_light, custom_base_font_size, custom_color, custom_font_family, custom_logo_url, custom_theme_override, disable_endpoint_on_failure, display_name, enable_channels, enable_integration_management, enable_transformations, enforce_https, event_catalog_published, read_only].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<(?.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?.+?), (?.+)>\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