pescheck-client 0.4.1 → 0.4.3

data/lib/pescheck-client/models/v2_screening_create.rb

@@ -21,12 +21,15 @@ module Pescheck
 
     attr_accessor :checks
 
+    attr_accessor :screening_notes
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'profile_id' => :'profile_id',
         :'candidate' => :'candidate',
-        :'checks' => :'checks'
+        :'checks' => :'checks',
+        :'screening_notes' => :'screening_notes'
       }
     end
 
@@ -45,7 +48,8 @@ module Pescheck
       {
         :'profile_id' => :'String',
         :'candidate' => :'V2Candidate',
-        :'checks' => :'Array<V2ScreeningCheck>'
+        :'checks' => :'Array<V2ScreeningCheck>',
+        :'screening_notes' => :'Array<V2ScreeningNoteInput>'
       }
     end
 
@@ -88,6 +92,12 @@ module Pescheck
           self.checks = value
         end
       end
+
+      if attributes.key?(:'screening_notes')
+        if (value = attributes[:'screening_notes']).is_a?(Array)
+          self.screening_notes = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -142,7 +152,8 @@ module Pescheck
       self.class == o.class &&
           profile_id == o.profile_id &&
           candidate == o.candidate &&
-          checks == o.checks
+          checks == o.checks &&
+          screening_notes == o.screening_notes
     end
 
     # @see the `==` method
@@ -154,7 +165,7 @@ module Pescheck
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [profile_id, candidate, checks].hash
+      [profile_id, candidate, checks, screening_notes].hash
     end
 
     # Builds the object from hash

data/lib/pescheck-client/models/v2_screening_detail.rb

@@ -25,6 +25,8 @@ module Pescheck
 
     attr_accessor :checks
 
+    attr_accessor :screening_notes
+
     # Public wizard URL for the candidate. Null when no check needs candidate input.
     attr_accessor :candidate_wizard_url
 
@@ -43,6 +45,7 @@ module Pescheck
         :'profile' => :'profile',
         :'candidate' => :'candidate',
         :'checks' => :'checks',
+        :'screening_notes' => :'screening_notes',
         :'candidate_wizard_url' => :'candidate_wizard_url',
         :'dashboard_url' => :'dashboard_url',
         :'created_at' => :'created_at',
@@ -68,6 +71,7 @@ module Pescheck
         :'profile' => :'V2ScreeningDetailProfile',
         :'candidate' => :'V2Candidate',
         :'checks' => :'Array<V2ScreeningCheckEntry>',
+        :'screening_notes' => :'Array<V2ScreeningNote>',
         :'candidate_wizard_url' => :'String',
         :'dashboard_url' => :'String',
         :'created_at' => :'Time',
@@ -131,6 +135,14 @@ module Pescheck
         self.checks = nil
       end
 
+      if attributes.key?(:'screening_notes')
+        if (value = attributes[:'screening_notes']).is_a?(Array)
+          self.screening_notes = value
+        end
+      else
+        self.screening_notes = nil
+      end
+
       if attributes.key?(:'candidate_wizard_url')
         self.candidate_wizard_url = attributes[:'candidate_wizard_url']
       else
@@ -177,6 +189,10 @@ module Pescheck
         invalid_properties.push('invalid value for "checks", checks cannot be nil.')
       end
 
+      if @screening_notes.nil?
+        invalid_properties.push('invalid value for "screening_notes", screening_notes cannot be nil.')
+      end
+
       if @dashboard_url.nil?
         invalid_properties.push('invalid value for "dashboard_url", dashboard_url cannot be nil.')
       end
@@ -200,6 +216,7 @@ module Pescheck
       return false if @status.nil?
       return false if @candidate.nil?
       return false if @checks.nil?
+      return false if @screening_notes.nil?
       return false if @dashboard_url.nil?
       return false if @created_at.nil?
       return false if @updated_at.nil?
@@ -246,6 +263,16 @@ module Pescheck
       @checks = checks
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] screening_notes Value to be assigned
+    def screening_notes=(screening_notes)
+      if screening_notes.nil?
+        fail ArgumentError, 'screening_notes cannot be nil'
+      end
+
+      @screening_notes = screening_notes
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] dashboard_url Value to be assigned
     def dashboard_url=(dashboard_url)
@@ -286,6 +313,7 @@ module Pescheck
           profile == o.profile &&
           candidate == o.candidate &&
           checks == o.checks &&
+          screening_notes == o.screening_notes &&
           candidate_wizard_url == o.candidate_wizard_url &&
           dashboard_url == o.dashboard_url &&
           created_at == o.created_at &&
@@ -301,7 +329,7 @@ module Pescheck
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, status, profile, candidate, checks, candidate_wizard_url, dashboard_url, created_at, updated_at].hash
+      [id, status, profile, candidate, checks, screening_notes, candidate_wizard_url, dashboard_url, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/pescheck-client/models/v2_screening_note.rb

@@ -0,0 +1,229 @@
+=begin
+#Pescheck API
+
+#Official client library for the Pescheck API (v2), generated from the OpenAPI specification. Authenticate with OAuth2 client credentials and use the checks, profiles, screenings, webhooks and divisions endpoints. See https://github.com/pescheckit/pescheck-clients for installation and usage.
+
+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
+  # A note recorded on the screening. `check_id` is the Check the note targets (null for type-only or unscoped notes).
+  class V2ScreeningNote < ApiModelBase
+    attr_accessor :note
+
+    attr_accessor :check_type
+
+    attr_accessor :check_id
+
+    attr_accessor :created_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'note' => :'note',
+        :'check_type' => :'check_type',
+        :'check_id' => :'check_id',
+        :'created_at' => :'created_at'
+      }
+    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
+      {
+        :'note' => :'String',
+        :'check_type' => :'String',
+        :'check_id' => :'String',
+        :'created_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'check_id',
+      ])
+    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::V2ScreeningNote` 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::V2ScreeningNote`. 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?(:'note')
+        self.note = attributes[:'note']
+      else
+        self.note = nil
+      end
+
+      if attributes.key?(:'check_type')
+        self.check_type = attributes[:'check_type']
+      else
+        self.check_type = nil
+      end
+
+      if attributes.key?(:'check_id')
+        self.check_id = attributes[:'check_id']
+      else
+        self.check_id = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = 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 @note.nil?
+        invalid_properties.push('invalid value for "note", note cannot be nil.')
+      end
+
+      if @check_type.nil?
+        invalid_properties.push('invalid value for "check_type", check_type cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at 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 @note.nil?
+      return false if @check_type.nil?
+      return false if @created_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] note Value to be assigned
+    def note=(note)
+      if note.nil?
+        fail ArgumentError, 'note cannot be nil'
+      end
+
+      @note = note
+    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] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    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 &&
+          note == o.note &&
+          check_type == o.check_type &&
+          check_id == o.check_id &&
+          created_at == o.created_at
+    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
+      [note, check_type, check_id, created_at].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/pescheck-client/models/v2_screening_note_input.rb

@@ -0,0 +1,220 @@
+=begin
+#Pescheck API
+
+#Official client library for the Pescheck API (v2), generated from the OpenAPI specification. Authenticate with OAuth2 client credentials and use the checks, profiles, screenings, webhooks and divisions endpoints. See https://github.com/pescheckit/pescheck-clients for installation and usage.
+
+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
+  # A note to record on the screening at creation. Scope it to a specific check with `profile_check_id` (links the note to the Check spawned from that ProfileCheck) or to a `check_type`; `profile_check_id` wins when both are given. With neither, the note is recorded against the screening with no check (check_type 'other').
+  class V2ScreeningNoteInput < ApiModelBase
+    attr_accessor :note
+
+    # Links the note to the Check spawned from this ProfileCheck. Wins over check_type.
+    attr_accessor :profile_check_id
+
+    # Scope the note to a check type. Ignored when profile_check_id is given.  * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
+    attr_accessor :check_type
+
+    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
+      {
+        :'note' => :'note',
+        :'profile_check_id' => :'profile_check_id',
+        :'check_type' => :'check_type'
+      }
+    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
+      {
+        :'note' => :'String',
+        :'profile_check_id' => :'String',
+        :'check_type' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'profile_check_id',
+      ])
+    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::V2ScreeningNoteInput` 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::V2ScreeningNoteInput`. 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?(:'note')
+        self.note = attributes[:'note']
+      else
+        self.note = nil
+      end
+
+      if attributes.key?(:'profile_check_id')
+        self.profile_check_id = attributes[:'profile_check_id']
+      end
+
+      if attributes.key?(:'check_type')
+        self.check_type = attributes[:'check_type']
+      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 @note.nil?
+        invalid_properties.push('invalid value for "note", note 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 @note.nil?
+      check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck", ""])
+      return false unless check_type_validator.valid?(@check_type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] note Value to be assigned
+    def note=(note)
+      if note.nil?
+        fail ArgumentError, 'note cannot be nil'
+      end
+
+      @note = note
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] check_type Object to be assigned
+    def check_type=(check_type)
+      validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck", ""])
+      unless validator.valid?(check_type)
+        fail ArgumentError, "invalid value for \"check_type\", must be one of #{validator.allowable_values}."
+      end
+      @check_type = check_type
+    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 &&
+          note == o.note &&
+          profile_check_id == o.profile_check_id &&
+          check_type == o.check_type
+    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
+      [note, profile_check_id, check_type].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/pescheck-client/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.23.0
 =end
 
 module Pescheck
-  VERSION = '0.4.1'
+  VERSION = '0.4.3'
 end

data/lib/pescheck-client.rb

@@ -51,6 +51,8 @@ require 'pescheck-client/models/v2_screening_create'
 require 'pescheck-client/models/v2_screening_detail'
 require 'pescheck-client/models/v2_screening_detail_profile'
 require 'pescheck-client/models/v2_screening_list_item'
+require 'pescheck-client/models/v2_screening_note'
+require 'pescheck-client/models/v2_screening_note_input'
 require 'pescheck-client/models/verify_webhook'
 require 'pescheck-client/models/webhook'
 require 'pescheck-client/models/webhook_response'

data/spec/models/v2_screening_note_input_spec.rb

@@ -0,0 +1,52 @@
+=begin
+#Pescheck API
+
+#Official client library for the Pescheck API (v2), generated from the OpenAPI specification. Authenticate with OAuth2 client credentials and use the checks, profiles, screenings, webhooks and divisions endpoints. See https://github.com/pescheckit/pescheck-clients for installation and usage.
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Pescheck::V2ScreeningNoteInput
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Pescheck::V2ScreeningNoteInput do
+  #let(:instance) { Pescheck::V2ScreeningNoteInput.new }
+
+  describe 'test an instance of V2ScreeningNoteInput' do
+    it 'should create an instance of V2ScreeningNoteInput' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Pescheck::V2ScreeningNoteInput)
+    end
+  end
+
+  describe 'test attribute "note"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "profile_check_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "check_type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck", ""])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.check_type = value }.not_to raise_error
+      # end
+    end
+  end
+
+end