smplkit 3.0.117 → 3.0.119

data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/retry_policy.rb

@@ -0,0 +1,396 @@
+=begin
+#smplkit Jobs API
+
+#Scheduled HTTP job execution API for smplkit.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SmplkitGeneratedClient::Jobs
+  # A named, reusable automatic-retry policy.  A policy decides whether and how a failed run is retried. Reference it from a job's `retry_policy` (and optionally override it per environment). A job that references nothing uses the built-in `Default` policy, which never retries.
+  class RetryPolicy < ApiModelBase
+    # Human-readable name for the policy.
+    attr_accessor :name
+
+    # How many times a failed run is retried, after the initial attempt — so `max_retries` of 3 means up to 4 attempts in total. `0` disables retries. Maximum 10.
+    attr_accessor :max_retries
+
+    # How the wait between retries grows. `fixed` waits `delay_seconds` before every retry. `exponential` doubles the wait each time — `delay_seconds`, then `2×`, `4×`, … — capped at `max_delay_seconds`.
+    attr_accessor :backoff
+
+    # The wait before a retry, in seconds. For `fixed` backoff it is the constant wait before every retry; for `exponential` it is the base wait that doubles each retry.
+    attr_accessor :delay_seconds
+
+    # The ceiling on the wait between retries, in seconds, for `exponential` backoff — once the doubling reaches it, every subsequent retry waits this long. Only valid with `exponential` backoff; omit it for `fixed`.
+    attr_accessor :max_delay_seconds
+
+    # Which failures are retried. A run is retried only when its failure matches this set; an empty set retries nothing. Some failures are never retried regardless of this value.
+    attr_accessor :retry_on
+
+    # When the policy was created.
+    attr_accessor :created_at
+
+    # When the policy was last modified.
+    attr_accessor :updated_at
+
+    # When the policy was deleted. `null` for active policies.
+    attr_accessor :deleted_at
+
+    # Monotonic counter incremented on every update, starting at 1.
+    attr_accessor :version
+
+    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
+      {
+        :'name' => :'name',
+        :'max_retries' => :'max_retries',
+        :'backoff' => :'backoff',
+        :'delay_seconds' => :'delay_seconds',
+        :'max_delay_seconds' => :'max_delay_seconds',
+        :'retry_on' => :'retry_on',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at',
+        :'deleted_at' => :'deleted_at',
+        :'version' => :'version'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'max_retries' => :'Integer',
+        :'backoff' => :'String',
+        :'delay_seconds' => :'Integer',
+        :'max_delay_seconds' => :'Integer',
+        :'retry_on' => :'RetryOn',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time',
+        :'deleted_at' => :'Time',
+        :'version' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'max_delay_seconds',
+        :'created_at',
+        :'updated_at',
+        :'deleted_at',
+        :'version'
+      ])
+    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 `SmplkitGeneratedClient::Jobs::RetryPolicy` 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 `SmplkitGeneratedClient::Jobs::RetryPolicy`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'max_retries')
+        self.max_retries = attributes[:'max_retries']
+      else
+        self.max_retries = nil
+      end
+
+      if attributes.key?(:'backoff')
+        self.backoff = attributes[:'backoff']
+      else
+        self.backoff = nil
+      end
+
+      if attributes.key?(:'delay_seconds')
+        self.delay_seconds = attributes[:'delay_seconds']
+      else
+        self.delay_seconds = nil
+      end
+
+      if attributes.key?(:'max_delay_seconds')
+        self.max_delay_seconds = attributes[:'max_delay_seconds']
+      end
+
+      if attributes.key?(:'retry_on')
+        self.retry_on = attributes[:'retry_on']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'deleted_at')
+        self.deleted_at = attributes[:'deleted_at']
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 200
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 200.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
+      end
+
+      if @max_retries.nil?
+        invalid_properties.push('invalid value for "max_retries", max_retries cannot be nil.')
+      end
+
+      if @max_retries > 10
+        invalid_properties.push('invalid value for "max_retries", must be smaller than or equal to 10.')
+      end
+
+      if @max_retries < 0
+        invalid_properties.push('invalid value for "max_retries", must be greater than or equal to 0.')
+      end
+
+      if @backoff.nil?
+        invalid_properties.push('invalid value for "backoff", backoff cannot be nil.')
+      end
+
+      if @delay_seconds.nil?
+        invalid_properties.push('invalid value for "delay_seconds", delay_seconds cannot be nil.')
+      end
+
+      if @delay_seconds < 1
+        invalid_properties.push('invalid value for "delay_seconds", must be greater than or equal to 1.')
+      end
+
+      if !@max_delay_seconds.nil? && @max_delay_seconds < 1
+        invalid_properties.push('invalid value for "max_delay_seconds", 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 @name.nil?
+      return false if @name.to_s.length > 200
+      return false if @name.to_s.length < 1
+      return false if @max_retries.nil?
+      return false if @max_retries > 10
+      return false if @max_retries < 0
+      return false if @backoff.nil?
+      backoff_validator = EnumAttributeValidator.new('String', ["fixed", "exponential"])
+      return false unless backoff_validator.valid?(@backoff)
+      return false if @delay_seconds.nil?
+      return false if @delay_seconds < 1
+      return false if !@max_delay_seconds.nil? && @max_delay_seconds < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 200
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 200.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_retries Value to be assigned
+    def max_retries=(max_retries)
+      if max_retries.nil?
+        fail ArgumentError, 'max_retries cannot be nil'
+      end
+
+      if max_retries > 10
+        fail ArgumentError, 'invalid value for "max_retries", must be smaller than or equal to 10.'
+      end
+
+      if max_retries < 0
+        fail ArgumentError, 'invalid value for "max_retries", must be greater than or equal to 0.'
+      end
+
+      @max_retries = max_retries
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] backoff Object to be assigned
+    def backoff=(backoff)
+      validator = EnumAttributeValidator.new('String', ["fixed", "exponential"])
+      unless validator.valid?(backoff)
+        fail ArgumentError, "invalid value for \"backoff\", must be one of #{validator.allowable_values}."
+      end
+      @backoff = backoff
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] delay_seconds Value to be assigned
+    def delay_seconds=(delay_seconds)
+      if delay_seconds.nil?
+        fail ArgumentError, 'delay_seconds cannot be nil'
+      end
+
+      if delay_seconds < 1
+        fail ArgumentError, 'invalid value for "delay_seconds", must be greater than or equal to 1.'
+      end
+
+      @delay_seconds = delay_seconds
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_delay_seconds Value to be assigned
+    def max_delay_seconds=(max_delay_seconds)
+      if !max_delay_seconds.nil? && max_delay_seconds < 1
+        fail ArgumentError, 'invalid value for "max_delay_seconds", must be greater than or equal to 1.'
+      end
+
+      @max_delay_seconds = max_delay_seconds
+    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 &&
+          name == o.name &&
+          max_retries == o.max_retries &&
+          backoff == o.backoff &&
+          delay_seconds == o.delay_seconds &&
+          max_delay_seconds == o.max_delay_seconds &&
+          retry_on == o.retry_on &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          deleted_at == o.deleted_at &&
+          version == o.version
+    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
+      [name, max_retries, backoff, delay_seconds, max_delay_seconds, retry_on, created_at, updated_at, deleted_at, version].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/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/retry_policy_create_request.rb

@@ -0,0 +1,165 @@
+=begin
+#smplkit Jobs API
+
+#Scheduled HTTP job execution API for smplkit.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SmplkitGeneratedClient::Jobs
+  # JSON:API request envelope for creating a retry policy (caller-supplied `data.id`).
+  class RetryPolicyCreateRequest < ApiModelBase
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    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
+      {
+        :'data' => :'RetryPolicyCreateResource'
+      }
+    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 `SmplkitGeneratedClient::Jobs::RetryPolicyCreateRequest` 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 `SmplkitGeneratedClient::Jobs::RetryPolicyCreateRequest`. 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?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = 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
+
+      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?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    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
+    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].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