rocket_stack_sdk 1.0.3 → 1.0.4

data/lib/rocket_stack_sdk/models/create_cron_job_request_delivery_target_any_of.rb

@@ -0,0 +1,351 @@
+=begin
+#Rocketstack Control Plane API
+
+#Combined API for Functions, Queues, KV, Storage, Cron, and Scheduler.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module RocketStackSdk
+  class CreateCronJobRequestDeliveryTargetAnyOf < ApiModelBase
+    # Deliver to a RocketStack function.
+    attr_accessor :type
+
+    # Function resource ID. Required when type is function.
+    attr_accessor :function_id
+
+    # Optional webhook headers (max 10). Authorization, Cookie, Host, and Content-Length are forbidden.
+    attr_accessor :webhook_headers
+
+    attr_accessor :timeout_seconds
+
+    attr_accessor :max_in_flight
+
+    attr_accessor :max_per_second
+
+    # HTTP status codes that trigger delivery retries.
+    attr_accessor :retryable_status_codes
+
+    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
+      {
+        :'type' => :'type',
+        :'function_id' => :'functionId',
+        :'webhook_headers' => :'webhookHeaders',
+        :'timeout_seconds' => :'timeoutSeconds',
+        :'max_in_flight' => :'maxInFlight',
+        :'max_per_second' => :'maxPerSecond',
+        :'retryable_status_codes' => :'retryableStatusCodes'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'function_id' => :'String',
+        :'webhook_headers' => :'Hash<String, String>',
+        :'timeout_seconds' => :'Float',
+        :'max_in_flight' => :'Float',
+        :'max_per_second' => :'Float',
+        :'retryable_status_codes' => :'Array<Float>'
+      }
+    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 `RocketStackSdk::CreateCronJobRequestDeliveryTargetAnyOf` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `RocketStackSdk::CreateCronJobRequestDeliveryTargetAnyOf`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'function_id')
+        self.function_id = attributes[:'function_id']
+      else
+        self.function_id = nil
+      end
+
+      if attributes.key?(:'webhook_headers')
+        if (value = attributes[:'webhook_headers']).is_a?(Hash)
+          self.webhook_headers = value
+        end
+      end
+
+      if attributes.key?(:'timeout_seconds')
+        self.timeout_seconds = attributes[:'timeout_seconds']
+      end
+
+      if attributes.key?(:'max_in_flight')
+        self.max_in_flight = attributes[:'max_in_flight']
+      end
+
+      if attributes.key?(:'max_per_second')
+        self.max_per_second = attributes[:'max_per_second']
+      end
+
+      if attributes.key?(:'retryable_status_codes')
+        if (value = attributes[:'retryable_status_codes']).is_a?(Array)
+          self.retryable_status_codes = 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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @function_id.nil?
+        invalid_properties.push('invalid value for "function_id", function_id cannot be nil.')
+      end
+
+      if !@timeout_seconds.nil? && @timeout_seconds > 30
+        invalid_properties.push('invalid value for "timeout_seconds", must be smaller than or equal to 30.')
+      end
+
+      if !@timeout_seconds.nil? && @timeout_seconds < 1
+        invalid_properties.push('invalid value for "timeout_seconds", must be greater than or equal to 1.')
+      end
+
+      if !@max_in_flight.nil? && @max_in_flight > 50
+        invalid_properties.push('invalid value for "max_in_flight", must be smaller than or equal to 50.')
+      end
+
+      if !@max_in_flight.nil? && @max_in_flight < 1
+        invalid_properties.push('invalid value for "max_in_flight", must be greater than or equal to 1.')
+      end
+
+      if !@max_per_second.nil? && @max_per_second > 200
+        invalid_properties.push('invalid value for "max_per_second", must be smaller than or equal to 200.')
+      end
+
+      if !@max_per_second.nil? && @max_per_second < 1
+        invalid_properties.push('invalid value for "max_per_second", must be greater 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["function"])
+      return false unless type_validator.valid?(@type)
+      return false if @function_id.nil?
+      return false if !@timeout_seconds.nil? && @timeout_seconds > 30
+      return false if !@timeout_seconds.nil? && @timeout_seconds < 1
+      return false if !@max_in_flight.nil? && @max_in_flight > 50
+      return false if !@max_in_flight.nil? && @max_in_flight < 1
+      return false if !@max_per_second.nil? && @max_per_second > 200
+      return false if !@max_per_second.nil? && @max_per_second < 1
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["function"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] function_id Value to be assigned
+    def function_id=(function_id)
+      if function_id.nil?
+        fail ArgumentError, 'function_id cannot be nil'
+      end
+
+      @function_id = function_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] timeout_seconds Value to be assigned
+    def timeout_seconds=(timeout_seconds)
+      if timeout_seconds.nil?
+        fail ArgumentError, 'timeout_seconds cannot be nil'
+      end
+
+      if timeout_seconds > 30
+        fail ArgumentError, 'invalid value for "timeout_seconds", must be smaller than or equal to 30.'
+      end
+
+      if timeout_seconds < 1
+        fail ArgumentError, 'invalid value for "timeout_seconds", must be greater than or equal to 1.'
+      end
+
+      @timeout_seconds = timeout_seconds
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_in_flight Value to be assigned
+    def max_in_flight=(max_in_flight)
+      if max_in_flight.nil?
+        fail ArgumentError, 'max_in_flight cannot be nil'
+      end
+
+      if max_in_flight > 50
+        fail ArgumentError, 'invalid value for "max_in_flight", must be smaller than or equal to 50.'
+      end
+
+      if max_in_flight < 1
+        fail ArgumentError, 'invalid value for "max_in_flight", must be greater than or equal to 1.'
+      end
+
+      @max_in_flight = max_in_flight
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_per_second Value to be assigned
+    def max_per_second=(max_per_second)
+      if max_per_second.nil?
+        fail ArgumentError, 'max_per_second cannot be nil'
+      end
+
+      if max_per_second > 200
+        fail ArgumentError, 'invalid value for "max_per_second", must be smaller than or equal to 200.'
+      end
+
+      if max_per_second < 1
+        fail ArgumentError, 'invalid value for "max_per_second", must be greater than or equal to 1.'
+      end
+
+      @max_per_second = max_per_second
+    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 &&
+          type == o.type &&
+          function_id == o.function_id &&
+          webhook_headers == o.webhook_headers &&
+          timeout_seconds == o.timeout_seconds &&
+          max_in_flight == o.max_in_flight &&
+          max_per_second == o.max_per_second &&
+          retryable_status_codes == o.retryable_status_codes
+    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
+      [type, function_id, webhook_headers, timeout_seconds, max_in_flight, max_per_second, retryable_status_codes].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
+
+    # 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
+
+  end
+
+end

data/lib/rocket_stack_sdk/models/create_cron_job_request_delivery_target_any_of1.rb

@@ -0,0 +1,351 @@
+=begin
+#Rocketstack Control Plane API
+
+#Combined API for Functions, Queues, KV, Storage, Cron, and Scheduler.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module RocketStackSdk
+  class CreateCronJobRequestDeliveryTargetAnyOf1 < ApiModelBase
+    # Deliver to an HTTPS webhook.
+    attr_accessor :type
+
+    # HTTPS webhook URL. Must not contain credentials in the URL.
+    attr_accessor :webhook_url
+
+    # Optional webhook headers (max 10). Authorization, Cookie, Host, and Content-Length are forbidden.
+    attr_accessor :webhook_headers
+
+    attr_accessor :timeout_seconds
+
+    attr_accessor :max_in_flight
+
+    attr_accessor :max_per_second
+
+    # HTTP status codes that trigger delivery retries.
+    attr_accessor :retryable_status_codes
+
+    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
+      {
+        :'type' => :'type',
+        :'webhook_url' => :'webhookUrl',
+        :'webhook_headers' => :'webhookHeaders',
+        :'timeout_seconds' => :'timeoutSeconds',
+        :'max_in_flight' => :'maxInFlight',
+        :'max_per_second' => :'maxPerSecond',
+        :'retryable_status_codes' => :'retryableStatusCodes'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'webhook_url' => :'String',
+        :'webhook_headers' => :'Hash<String, String>',
+        :'timeout_seconds' => :'Float',
+        :'max_in_flight' => :'Float',
+        :'max_per_second' => :'Float',
+        :'retryable_status_codes' => :'Array<Float>'
+      }
+    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 `RocketStackSdk::CreateCronJobRequestDeliveryTargetAnyOf1` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `RocketStackSdk::CreateCronJobRequestDeliveryTargetAnyOf1`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'webhook_url')
+        self.webhook_url = attributes[:'webhook_url']
+      else
+        self.webhook_url = nil
+      end
+
+      if attributes.key?(:'webhook_headers')
+        if (value = attributes[:'webhook_headers']).is_a?(Hash)
+          self.webhook_headers = value
+        end
+      end
+
+      if attributes.key?(:'timeout_seconds')
+        self.timeout_seconds = attributes[:'timeout_seconds']
+      end
+
+      if attributes.key?(:'max_in_flight')
+        self.max_in_flight = attributes[:'max_in_flight']
+      end
+
+      if attributes.key?(:'max_per_second')
+        self.max_per_second = attributes[:'max_per_second']
+      end
+
+      if attributes.key?(:'retryable_status_codes')
+        if (value = attributes[:'retryable_status_codes']).is_a?(Array)
+          self.retryable_status_codes = 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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @webhook_url.nil?
+        invalid_properties.push('invalid value for "webhook_url", webhook_url cannot be nil.')
+      end
+
+      if !@timeout_seconds.nil? && @timeout_seconds > 30
+        invalid_properties.push('invalid value for "timeout_seconds", must be smaller than or equal to 30.')
+      end
+
+      if !@timeout_seconds.nil? && @timeout_seconds < 1
+        invalid_properties.push('invalid value for "timeout_seconds", must be greater than or equal to 1.')
+      end
+
+      if !@max_in_flight.nil? && @max_in_flight > 50
+        invalid_properties.push('invalid value for "max_in_flight", must be smaller than or equal to 50.')
+      end
+
+      if !@max_in_flight.nil? && @max_in_flight < 1
+        invalid_properties.push('invalid value for "max_in_flight", must be greater than or equal to 1.')
+      end
+
+      if !@max_per_second.nil? && @max_per_second > 200
+        invalid_properties.push('invalid value for "max_per_second", must be smaller than or equal to 200.')
+      end
+
+      if !@max_per_second.nil? && @max_per_second < 1
+        invalid_properties.push('invalid value for "max_per_second", must be greater 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["webhook"])
+      return false unless type_validator.valid?(@type)
+      return false if @webhook_url.nil?
+      return false if !@timeout_seconds.nil? && @timeout_seconds > 30
+      return false if !@timeout_seconds.nil? && @timeout_seconds < 1
+      return false if !@max_in_flight.nil? && @max_in_flight > 50
+      return false if !@max_in_flight.nil? && @max_in_flight < 1
+      return false if !@max_per_second.nil? && @max_per_second > 200
+      return false if !@max_per_second.nil? && @max_per_second < 1
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["webhook"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] webhook_url Value to be assigned
+    def webhook_url=(webhook_url)
+      if webhook_url.nil?
+        fail ArgumentError, 'webhook_url cannot be nil'
+      end
+
+      @webhook_url = webhook_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] timeout_seconds Value to be assigned
+    def timeout_seconds=(timeout_seconds)
+      if timeout_seconds.nil?
+        fail ArgumentError, 'timeout_seconds cannot be nil'
+      end
+
+      if timeout_seconds > 30
+        fail ArgumentError, 'invalid value for "timeout_seconds", must be smaller than or equal to 30.'
+      end
+
+      if timeout_seconds < 1
+        fail ArgumentError, 'invalid value for "timeout_seconds", must be greater than or equal to 1.'
+      end
+
+      @timeout_seconds = timeout_seconds
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_in_flight Value to be assigned
+    def max_in_flight=(max_in_flight)
+      if max_in_flight.nil?
+        fail ArgumentError, 'max_in_flight cannot be nil'
+      end
+
+      if max_in_flight > 50
+        fail ArgumentError, 'invalid value for "max_in_flight", must be smaller than or equal to 50.'
+      end
+
+      if max_in_flight < 1
+        fail ArgumentError, 'invalid value for "max_in_flight", must be greater than or equal to 1.'
+      end
+
+      @max_in_flight = max_in_flight
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_per_second Value to be assigned
+    def max_per_second=(max_per_second)
+      if max_per_second.nil?
+        fail ArgumentError, 'max_per_second cannot be nil'
+      end
+
+      if max_per_second > 200
+        fail ArgumentError, 'invalid value for "max_per_second", must be smaller than or equal to 200.'
+      end
+
+      if max_per_second < 1
+        fail ArgumentError, 'invalid value for "max_per_second", must be greater than or equal to 1.'
+      end
+
+      @max_per_second = max_per_second
+    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 &&
+          type == o.type &&
+          webhook_url == o.webhook_url &&
+          webhook_headers == o.webhook_headers &&
+          timeout_seconds == o.timeout_seconds &&
+          max_in_flight == o.max_in_flight &&
+          max_per_second == o.max_per_second &&
+          retryable_status_codes == o.retryable_status_codes
+    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
+      [type, webhook_url, webhook_headers, timeout_seconds, max_in_flight, max_per_second, retryable_status_codes].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
+
+    # 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
+
+  end
+
+end