pescheck 0.0.1

data/lib/pescheck/models/v2_check_info.rb

@@ -0,0 +1,438 @@
+=begin
+#Pescheck API
+
+#API for Pescheck  ## Authentication This API supports three authentication methods: 1. **OAuth2** (recommended for API clients) - Use client credentials flow 2. **JWT Bearer** (for user-based access) - Obtain tokens via /api/jwt/ endpoint 3. **Cookie** (for browser-based access) - Session authentication via web login  ## Quick Start for API Clients 1. Select your environment from the servers dropdown 2. Use OAuth2 with client credentials flow 3. Scopes are automatically included: read:api, create:api, update:api
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Pescheck
+  # Everything a client needs to know to use a check type via the API.
+  class V2CheckInfo < ApiModelBase
+    attr_accessor :check_type
+
+    attr_accessor :display_name
+
+    attr_accessor :description
+
+    attr_accessor :has_config
+
+    # True for checks added automatically (e.g. as a dependency) - clients neither add nor configure these.
+    attr_accessor :is_system_managed
+
+    # Other check types this check pulls in automatically when added.
+    attr_accessor :requires_checks
+
+    attr_accessor :supported_countries_of_work
+
+    attr_accessor :supported_countries_of_residence
+
+    attr_accessor :default_price
+
+    attr_accessor :config_fields
+
+    attr_accessor :input_fields
+
+    # Screening-level candidate facts this check needs (name, email, sometimes date of birth, etc.).
+    attr_accessor :candidate_fields
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'check_type' => :'check_type',
+        :'display_name' => :'display_name',
+        :'description' => :'description',
+        :'has_config' => :'has_config',
+        :'is_system_managed' => :'is_system_managed',
+        :'requires_checks' => :'requires_checks',
+        :'supported_countries_of_work' => :'supported_countries_of_work',
+        :'supported_countries_of_residence' => :'supported_countries_of_residence',
+        :'default_price' => :'default_price',
+        :'config_fields' => :'config_fields',
+        :'input_fields' => :'input_fields',
+        :'candidate_fields' => :'candidate_fields'
+      }
+    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
+      {
+        :'check_type' => :'String',
+        :'display_name' => :'String',
+        :'description' => :'String',
+        :'has_config' => :'Boolean',
+        :'is_system_managed' => :'Boolean',
+        :'requires_checks' => :'Array<String>',
+        :'supported_countries_of_work' => :'Array<String>',
+        :'supported_countries_of_residence' => :'Array<String>',
+        :'default_price' => :'V2Money',
+        :'config_fields' => :'Array<V2CheckField>',
+        :'input_fields' => :'Array<V2CheckField>',
+        :'candidate_fields' => :'Array<V2CheckField>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'description',
+        :'default_price',
+      ])
+    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 `Pescheck::V2CheckInfo` 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 `Pescheck::V2CheckInfo`. 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?(:'check_type')
+        self.check_type = attributes[:'check_type']
+      else
+        self.check_type = nil
+      end
+
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      else
+        self.display_name = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'has_config')
+        self.has_config = attributes[:'has_config']
+      else
+        self.has_config = nil
+      end
+
+      if attributes.key?(:'is_system_managed')
+        self.is_system_managed = attributes[:'is_system_managed']
+      else
+        self.is_system_managed = nil
+      end
+
+      if attributes.key?(:'requires_checks')
+        if (value = attributes[:'requires_checks']).is_a?(Array)
+          self.requires_checks = value
+        end
+      else
+        self.requires_checks = nil
+      end
+
+      if attributes.key?(:'supported_countries_of_work')
+        if (value = attributes[:'supported_countries_of_work']).is_a?(Array)
+          self.supported_countries_of_work = value
+        end
+      else
+        self.supported_countries_of_work = nil
+      end
+
+      if attributes.key?(:'supported_countries_of_residence')
+        if (value = attributes[:'supported_countries_of_residence']).is_a?(Array)
+          self.supported_countries_of_residence = value
+        end
+      else
+        self.supported_countries_of_residence = nil
+      end
+
+      if attributes.key?(:'default_price')
+        self.default_price = attributes[:'default_price']
+      else
+        self.default_price = nil
+      end
+
+      if attributes.key?(:'config_fields')
+        if (value = attributes[:'config_fields']).is_a?(Array)
+          self.config_fields = value
+        end
+      else
+        self.config_fields = nil
+      end
+
+      if attributes.key?(:'input_fields')
+        if (value = attributes[:'input_fields']).is_a?(Array)
+          self.input_fields = value
+        end
+      else
+        self.input_fields = nil
+      end
+
+      if attributes.key?(:'candidate_fields')
+        if (value = attributes[:'candidate_fields']).is_a?(Array)
+          self.candidate_fields = value
+        end
+      else
+        self.candidate_fields = 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 @check_type.nil?
+        invalid_properties.push('invalid value for "check_type", check_type cannot be nil.')
+      end
+
+      if @display_name.nil?
+        invalid_properties.push('invalid value for "display_name", display_name cannot be nil.')
+      end
+
+      if @has_config.nil?
+        invalid_properties.push('invalid value for "has_config", has_config cannot be nil.')
+      end
+
+      if @is_system_managed.nil?
+        invalid_properties.push('invalid value for "is_system_managed", is_system_managed cannot be nil.')
+      end
+
+      if @requires_checks.nil?
+        invalid_properties.push('invalid value for "requires_checks", requires_checks cannot be nil.')
+      end
+
+      if @supported_countries_of_work.nil?
+        invalid_properties.push('invalid value for "supported_countries_of_work", supported_countries_of_work cannot be nil.')
+      end
+
+      if @supported_countries_of_residence.nil?
+        invalid_properties.push('invalid value for "supported_countries_of_residence", supported_countries_of_residence cannot be nil.')
+      end
+
+      if @config_fields.nil?
+        invalid_properties.push('invalid value for "config_fields", config_fields cannot be nil.')
+      end
+
+      if @input_fields.nil?
+        invalid_properties.push('invalid value for "input_fields", input_fields cannot be nil.')
+      end
+
+      if @candidate_fields.nil?
+        invalid_properties.push('invalid value for "candidate_fields", candidate_fields 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 @check_type.nil?
+      return false if @display_name.nil?
+      return false if @has_config.nil?
+      return false if @is_system_managed.nil?
+      return false if @requires_checks.nil?
+      return false if @supported_countries_of_work.nil?
+      return false if @supported_countries_of_residence.nil?
+      return false if @config_fields.nil?
+      return false if @input_fields.nil?
+      return false if @candidate_fields.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] check_type Value to be assigned
+    def check_type=(check_type)
+      if check_type.nil?
+        fail ArgumentError, 'check_type cannot be nil'
+      end
+
+      @check_type = check_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] display_name Value to be assigned
+    def display_name=(display_name)
+      if display_name.nil?
+        fail ArgumentError, 'display_name cannot be nil'
+      end
+
+      @display_name = display_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] has_config Value to be assigned
+    def has_config=(has_config)
+      if has_config.nil?
+        fail ArgumentError, 'has_config cannot be nil'
+      end
+
+      @has_config = has_config
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_system_managed Value to be assigned
+    def is_system_managed=(is_system_managed)
+      if is_system_managed.nil?
+        fail ArgumentError, 'is_system_managed cannot be nil'
+      end
+
+      @is_system_managed = is_system_managed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] requires_checks Value to be assigned
+    def requires_checks=(requires_checks)
+      if requires_checks.nil?
+        fail ArgumentError, 'requires_checks cannot be nil'
+      end
+
+      @requires_checks = requires_checks
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] supported_countries_of_work Value to be assigned
+    def supported_countries_of_work=(supported_countries_of_work)
+      if supported_countries_of_work.nil?
+        fail ArgumentError, 'supported_countries_of_work cannot be nil'
+      end
+
+      @supported_countries_of_work = supported_countries_of_work
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] supported_countries_of_residence Value to be assigned
+    def supported_countries_of_residence=(supported_countries_of_residence)
+      if supported_countries_of_residence.nil?
+        fail ArgumentError, 'supported_countries_of_residence cannot be nil'
+      end
+
+      @supported_countries_of_residence = supported_countries_of_residence
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] config_fields Value to be assigned
+    def config_fields=(config_fields)
+      if config_fields.nil?
+        fail ArgumentError, 'config_fields cannot be nil'
+      end
+
+      @config_fields = config_fields
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] input_fields Value to be assigned
+    def input_fields=(input_fields)
+      if input_fields.nil?
+        fail ArgumentError, 'input_fields cannot be nil'
+      end
+
+      @input_fields = input_fields
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] candidate_fields Value to be assigned
+    def candidate_fields=(candidate_fields)
+      if candidate_fields.nil?
+        fail ArgumentError, 'candidate_fields cannot be nil'
+      end
+
+      @candidate_fields = candidate_fields
+    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 &&
+          check_type == o.check_type &&
+          display_name == o.display_name &&
+          description == o.description &&
+          has_config == o.has_config &&
+          is_system_managed == o.is_system_managed &&
+          requires_checks == o.requires_checks &&
+          supported_countries_of_work == o.supported_countries_of_work &&
+          supported_countries_of_residence == o.supported_countries_of_residence &&
+          default_price == o.default_price &&
+          config_fields == o.config_fields &&
+          input_fields == o.input_fields &&
+          candidate_fields == o.candidate_fields
+    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
+      [check_type, display_name, description, has_config, is_system_managed, requires_checks, supported_countries_of_work, supported_countries_of_residence, default_price, config_fields, input_fields, candidate_fields].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