relentless_identity 1.0.0

data/lib/relentless_identity/models/client_usage_response.rb

@@ -0,0 +1,506 @@
+=begin
+#Relentless Identity API
+
+#Public client API for Finder and Probe workflows. This spec is generated from the FastAPI app, then narrowed to the supported bearer-authenticated routes used by SDKs and the API reference.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module RelentlessIdentity
+  # Current authenticated account usage, free-tier windows, and paid balance snapshot.
+  class ClientUsageResponse < ApiModelBase
+    # Current plan family, such as free or paid.
+    attr_accessor :plan_tier
+
+    attr_accessor :billing_mode
+
+    attr_accessor :billing_status
+
+    attr_accessor :free_window_limit
+
+    attr_accessor :free_window_hours
+
+    attr_accessor :free_weekly_limit
+
+    attr_accessor :window_requests_used
+
+    attr_accessor :weekly_requests_used
+
+    attr_accessor :window_requests_remaining
+
+    attr_accessor :weekly_requests_remaining
+
+    attr_accessor :billing_cycle_value_micros
+
+    attr_accessor :billing_extra_value_micros
+
+    attr_accessor :billing_value_micros_used
+
+    # Paid usage value currently reserved by queued or running background jobs.
+    attr_accessor :billing_value_micros_reserved
+
+    attr_accessor :billing_value_micros_remaining
+
+    attr_accessor :usage_percent_remaining
+
+    attr_accessor :current_plan_finder_deliverable_cost_micros
+
+    attr_accessor :current_plan_finder_undeliverable_cost_micros
+
+    attr_accessor :current_plan_probe_cost_micros
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'plan_tier' => :'plan_tier',
+        :'billing_mode' => :'billing_mode',
+        :'billing_status' => :'billing_status',
+        :'free_window_limit' => :'free_window_limit',
+        :'free_window_hours' => :'free_window_hours',
+        :'free_weekly_limit' => :'free_weekly_limit',
+        :'window_requests_used' => :'window_requests_used',
+        :'weekly_requests_used' => :'weekly_requests_used',
+        :'window_requests_remaining' => :'window_requests_remaining',
+        :'weekly_requests_remaining' => :'weekly_requests_remaining',
+        :'billing_cycle_value_micros' => :'billing_cycle_value_micros',
+        :'billing_extra_value_micros' => :'billing_extra_value_micros',
+        :'billing_value_micros_used' => :'billing_value_micros_used',
+        :'billing_value_micros_reserved' => :'billing_value_micros_reserved',
+        :'billing_value_micros_remaining' => :'billing_value_micros_remaining',
+        :'usage_percent_remaining' => :'usage_percent_remaining',
+        :'current_plan_finder_deliverable_cost_micros' => :'current_plan_finder_deliverable_cost_micros',
+        :'current_plan_finder_undeliverable_cost_micros' => :'current_plan_finder_undeliverable_cost_micros',
+        :'current_plan_probe_cost_micros' => :'current_plan_probe_cost_micros'
+      }
+    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
+      {
+        :'plan_tier' => :'String',
+        :'billing_mode' => :'String',
+        :'billing_status' => :'String',
+        :'free_window_limit' => :'Integer',
+        :'free_window_hours' => :'Integer',
+        :'free_weekly_limit' => :'Integer',
+        :'window_requests_used' => :'Integer',
+        :'weekly_requests_used' => :'Integer',
+        :'window_requests_remaining' => :'Integer',
+        :'weekly_requests_remaining' => :'Integer',
+        :'billing_cycle_value_micros' => :'Integer',
+        :'billing_extra_value_micros' => :'Integer',
+        :'billing_value_micros_used' => :'Integer',
+        :'billing_value_micros_reserved' => :'Integer',
+        :'billing_value_micros_remaining' => :'Integer',
+        :'usage_percent_remaining' => :'Float',
+        :'current_plan_finder_deliverable_cost_micros' => :'Integer',
+        :'current_plan_finder_undeliverable_cost_micros' => :'Integer',
+        :'current_plan_probe_cost_micros' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'billing_status',
+        :'billing_cycle_value_micros',
+        :'billing_value_micros_remaining',
+        :'usage_percent_remaining',
+        :'current_plan_finder_deliverable_cost_micros',
+        :'current_plan_finder_undeliverable_cost_micros',
+        :'current_plan_probe_cost_micros'
+      ])
+    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 `RelentlessIdentity::ClientUsageResponse` 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 `RelentlessIdentity::ClientUsageResponse`. 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?(:'plan_tier')
+        self.plan_tier = attributes[:'plan_tier']
+      else
+        self.plan_tier = nil
+      end
+
+      if attributes.key?(:'billing_mode')
+        self.billing_mode = attributes[:'billing_mode']
+      else
+        self.billing_mode = nil
+      end
+
+      if attributes.key?(:'billing_status')
+        self.billing_status = attributes[:'billing_status']
+      end
+
+      if attributes.key?(:'free_window_limit')
+        self.free_window_limit = attributes[:'free_window_limit']
+      else
+        self.free_window_limit = nil
+      end
+
+      if attributes.key?(:'free_window_hours')
+        self.free_window_hours = attributes[:'free_window_hours']
+      else
+        self.free_window_hours = nil
+      end
+
+      if attributes.key?(:'free_weekly_limit')
+        self.free_weekly_limit = attributes[:'free_weekly_limit']
+      else
+        self.free_weekly_limit = nil
+      end
+
+      if attributes.key?(:'window_requests_used')
+        self.window_requests_used = attributes[:'window_requests_used']
+      else
+        self.window_requests_used = nil
+      end
+
+      if attributes.key?(:'weekly_requests_used')
+        self.weekly_requests_used = attributes[:'weekly_requests_used']
+      else
+        self.weekly_requests_used = nil
+      end
+
+      if attributes.key?(:'window_requests_remaining')
+        self.window_requests_remaining = attributes[:'window_requests_remaining']
+      else
+        self.window_requests_remaining = nil
+      end
+
+      if attributes.key?(:'weekly_requests_remaining')
+        self.weekly_requests_remaining = attributes[:'weekly_requests_remaining']
+      else
+        self.weekly_requests_remaining = nil
+      end
+
+      if attributes.key?(:'billing_cycle_value_micros')
+        self.billing_cycle_value_micros = attributes[:'billing_cycle_value_micros']
+      end
+
+      if attributes.key?(:'billing_extra_value_micros')
+        self.billing_extra_value_micros = attributes[:'billing_extra_value_micros']
+      else
+        self.billing_extra_value_micros = nil
+      end
+
+      if attributes.key?(:'billing_value_micros_used')
+        self.billing_value_micros_used = attributes[:'billing_value_micros_used']
+      else
+        self.billing_value_micros_used = nil
+      end
+
+      if attributes.key?(:'billing_value_micros_reserved')
+        self.billing_value_micros_reserved = attributes[:'billing_value_micros_reserved']
+      end
+
+      if attributes.key?(:'billing_value_micros_remaining')
+        self.billing_value_micros_remaining = attributes[:'billing_value_micros_remaining']
+      end
+
+      if attributes.key?(:'usage_percent_remaining')
+        self.usage_percent_remaining = attributes[:'usage_percent_remaining']
+      end
+
+      if attributes.key?(:'current_plan_finder_deliverable_cost_micros')
+        self.current_plan_finder_deliverable_cost_micros = attributes[:'current_plan_finder_deliverable_cost_micros']
+      end
+
+      if attributes.key?(:'current_plan_finder_undeliverable_cost_micros')
+        self.current_plan_finder_undeliverable_cost_micros = attributes[:'current_plan_finder_undeliverable_cost_micros']
+      end
+
+      if attributes.key?(:'current_plan_probe_cost_micros')
+        self.current_plan_probe_cost_micros = attributes[:'current_plan_probe_cost_micros']
+      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 @plan_tier.nil?
+        invalid_properties.push('invalid value for "plan_tier", plan_tier cannot be nil.')
+      end
+
+      if @billing_mode.nil?
+        invalid_properties.push('invalid value for "billing_mode", billing_mode cannot be nil.')
+      end
+
+      if @free_window_limit.nil?
+        invalid_properties.push('invalid value for "free_window_limit", free_window_limit cannot be nil.')
+      end
+
+      if @free_window_hours.nil?
+        invalid_properties.push('invalid value for "free_window_hours", free_window_hours cannot be nil.')
+      end
+
+      if @free_weekly_limit.nil?
+        invalid_properties.push('invalid value for "free_weekly_limit", free_weekly_limit cannot be nil.')
+      end
+
+      if @window_requests_used.nil?
+        invalid_properties.push('invalid value for "window_requests_used", window_requests_used cannot be nil.')
+      end
+
+      if @weekly_requests_used.nil?
+        invalid_properties.push('invalid value for "weekly_requests_used", weekly_requests_used cannot be nil.')
+      end
+
+      if @window_requests_remaining.nil?
+        invalid_properties.push('invalid value for "window_requests_remaining", window_requests_remaining cannot be nil.')
+      end
+
+      if @weekly_requests_remaining.nil?
+        invalid_properties.push('invalid value for "weekly_requests_remaining", weekly_requests_remaining cannot be nil.')
+      end
+
+      if @billing_extra_value_micros.nil?
+        invalid_properties.push('invalid value for "billing_extra_value_micros", billing_extra_value_micros cannot be nil.')
+      end
+
+      if @billing_value_micros_used.nil?
+        invalid_properties.push('invalid value for "billing_value_micros_used", billing_value_micros_used 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 @plan_tier.nil?
+      return false if @billing_mode.nil?
+      return false if @free_window_limit.nil?
+      return false if @free_window_hours.nil?
+      return false if @free_weekly_limit.nil?
+      return false if @window_requests_used.nil?
+      return false if @weekly_requests_used.nil?
+      return false if @window_requests_remaining.nil?
+      return false if @weekly_requests_remaining.nil?
+      return false if @billing_extra_value_micros.nil?
+      return false if @billing_value_micros_used.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] plan_tier Value to be assigned
+    def plan_tier=(plan_tier)
+      if plan_tier.nil?
+        fail ArgumentError, 'plan_tier cannot be nil'
+      end
+
+      @plan_tier = plan_tier
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] billing_mode Value to be assigned
+    def billing_mode=(billing_mode)
+      if billing_mode.nil?
+        fail ArgumentError, 'billing_mode cannot be nil'
+      end
+
+      @billing_mode = billing_mode
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] free_window_limit Value to be assigned
+    def free_window_limit=(free_window_limit)
+      if free_window_limit.nil?
+        fail ArgumentError, 'free_window_limit cannot be nil'
+      end
+
+      @free_window_limit = free_window_limit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] free_window_hours Value to be assigned
+    def free_window_hours=(free_window_hours)
+      if free_window_hours.nil?
+        fail ArgumentError, 'free_window_hours cannot be nil'
+      end
+
+      @free_window_hours = free_window_hours
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] free_weekly_limit Value to be assigned
+    def free_weekly_limit=(free_weekly_limit)
+      if free_weekly_limit.nil?
+        fail ArgumentError, 'free_weekly_limit cannot be nil'
+      end
+
+      @free_weekly_limit = free_weekly_limit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] window_requests_used Value to be assigned
+    def window_requests_used=(window_requests_used)
+      if window_requests_used.nil?
+        fail ArgumentError, 'window_requests_used cannot be nil'
+      end
+
+      @window_requests_used = window_requests_used
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] weekly_requests_used Value to be assigned
+    def weekly_requests_used=(weekly_requests_used)
+      if weekly_requests_used.nil?
+        fail ArgumentError, 'weekly_requests_used cannot be nil'
+      end
+
+      @weekly_requests_used = weekly_requests_used
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] window_requests_remaining Value to be assigned
+    def window_requests_remaining=(window_requests_remaining)
+      if window_requests_remaining.nil?
+        fail ArgumentError, 'window_requests_remaining cannot be nil'
+      end
+
+      @window_requests_remaining = window_requests_remaining
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] weekly_requests_remaining Value to be assigned
+    def weekly_requests_remaining=(weekly_requests_remaining)
+      if weekly_requests_remaining.nil?
+        fail ArgumentError, 'weekly_requests_remaining cannot be nil'
+      end
+
+      @weekly_requests_remaining = weekly_requests_remaining
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] billing_extra_value_micros Value to be assigned
+    def billing_extra_value_micros=(billing_extra_value_micros)
+      if billing_extra_value_micros.nil?
+        fail ArgumentError, 'billing_extra_value_micros cannot be nil'
+      end
+
+      @billing_extra_value_micros = billing_extra_value_micros
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] billing_value_micros_used Value to be assigned
+    def billing_value_micros_used=(billing_value_micros_used)
+      if billing_value_micros_used.nil?
+        fail ArgumentError, 'billing_value_micros_used cannot be nil'
+      end
+
+      @billing_value_micros_used = billing_value_micros_used
+    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 &&
+          plan_tier == o.plan_tier &&
+          billing_mode == o.billing_mode &&
+          billing_status == o.billing_status &&
+          free_window_limit == o.free_window_limit &&
+          free_window_hours == o.free_window_hours &&
+          free_weekly_limit == o.free_weekly_limit &&
+          window_requests_used == o.window_requests_used &&
+          weekly_requests_used == o.weekly_requests_used &&
+          window_requests_remaining == o.window_requests_remaining &&
+          weekly_requests_remaining == o.weekly_requests_remaining &&
+          billing_cycle_value_micros == o.billing_cycle_value_micros &&
+          billing_extra_value_micros == o.billing_extra_value_micros &&
+          billing_value_micros_used == o.billing_value_micros_used &&
+          billing_value_micros_reserved == o.billing_value_micros_reserved &&
+          billing_value_micros_remaining == o.billing_value_micros_remaining &&
+          usage_percent_remaining == o.usage_percent_remaining &&
+          current_plan_finder_deliverable_cost_micros == o.current_plan_finder_deliverable_cost_micros &&
+          current_plan_finder_undeliverable_cost_micros == o.current_plan_finder_undeliverable_cost_micros &&
+          current_plan_probe_cost_micros == o.current_plan_probe_cost_micros
+    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
+      [plan_tier, billing_mode, billing_status, free_window_limit, free_window_hours, free_weekly_limit, window_requests_used, weekly_requests_used, window_requests_remaining, weekly_requests_remaining, billing_cycle_value_micros, billing_extra_value_micros, billing_value_micros_used, billing_value_micros_reserved, billing_value_micros_remaining, usage_percent_remaining, current_plan_finder_deliverable_cost_micros, current_plan_finder_undeliverable_cost_micros, current_plan_probe_cost_micros].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/relentless_identity/models/error_response.rb

@@ -0,0 +1,178 @@
+=begin
+#Relentless Identity API
+
+#Public client API for Finder and Probe workflows. This spec is generated from the FastAPI app, then narrowed to the supported bearer-authenticated routes used by SDKs and the API reference.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module RelentlessIdentity
+  class ErrorResponse < ApiModelBase
+    # Stable machine-readable error key.
+    attr_accessor :error
+
+    # Human-friendly error summary safe to show to an operator or end user.
+    attr_accessor :message
+
+    # Optional raw backend detail when available.
+    attr_accessor :detail
+
+    attr_accessor :retry_after_seconds
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'message' => :'message',
+        :'detail' => :'detail',
+        :'retry_after_seconds' => :'retry_after_seconds'
+      }
+    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
+      {
+        :'error' => :'String',
+        :'message' => :'String',
+        :'detail' => :'String',
+        :'retry_after_seconds' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'retry_after_seconds'
+      ])
+    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 `RelentlessIdentity::ErrorResponse` 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 `RelentlessIdentity::ErrorResponse`. 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?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'detail')
+        self.detail = attributes[:'detail']
+      end
+
+      if attributes.key?(:'retry_after_seconds')
+        self.retry_after_seconds = attributes[:'retry_after_seconds']
+      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
+      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'
+      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 &&
+          error == o.error &&
+          message == o.message &&
+          detail == o.detail &&
+          retry_after_seconds == o.retry_after_seconds
+    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
+      [error, message, detail, retry_after_seconds].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