kombo 1.2.8 → 1.2.10

data/lib/kombo/hris.rb

@@ -2290,8 +2290,6 @@ module Kombo
       #
       # Retrieve attendance data and timesheets from HRIS tools.
       #
-      # <Warning>**Open Beta Feature:** This endpoint is currently in beta. Please reach out to our support team if you need assistance with implementation.</Warning>
-      #
       # For a detailed explanation of the data model, validation rules, time zones, payable hours, approvals, and break patterns, see the [Time & Attendance guide](/hris/features/time-and-attendance).
       #
       # <Note>
@@ -2924,6 +2922,328 @@ module Kombo
           end
 
 
+          return response
+        else
+          raise ::Kombo::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      else
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::KomboHrisError)
+          obj.raw_response = http_response
+          raise obj
+        else
+          raise ::Kombo::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      end
+    end
+
+
+    sig { params(integration_id: T.nilable(::String), cursor: T.nilable(::String), page_size: T.nilable(::Integer), updated_after: T.nilable(::DateTime), include_deleted: T.nilable(T::Boolean), ignore_unsupported_filters: T.nilable(T::Boolean), ids: T.nilable(T::Array[::String]), remote_ids: T.nilable(T::Array[::String]), legal_entity_ids: T.nilable(T::Array[::String]), timeout_ms: T.nilable(Integer), http_headers: T.nilable(T::Hash[T.any(String, Symbol), String])).returns(Models::Operations::GetHrisPayRunsResponse) }
+    def get_hris_pay_runs(integration_id: nil, cursor: nil, page_size: nil, updated_after: nil, include_deleted: nil, ignore_unsupported_filters: nil, ids: nil, remote_ids: nil, legal_entity_ids: nil, timeout_ms: nil, http_headers: nil)
+      # get_hris_pay_runs - Pay Runs
+      # Retrieve all pay runs for all legal entities, across all time.
+      #
+      # A pay run represents one payroll cycle for a legal entity, covering a single pay period and grouping the payslips paid out through it. Use this endpoint to reconcile payroll periods and read the totals paid out across each run. Filter by `legal_entity_ids` to scope the results to specific legal entities.
+      #
+      # Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`
+      request = Models::Operations::GetHrisPayRunsRequest.new(
+        integration_id: integration_id,
+        cursor: cursor,
+        page_size: page_size,
+        updated_after: updated_after,
+        include_deleted: include_deleted,
+        ignore_unsupported_filters: ignore_unsupported_filters,
+        ids: ids,
+        remote_ids: remote_ids,
+        legal_entity_ids: legal_entity_ids
+      )
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/hris/pay-runs"
+      headers = Utils.get_headers(request, @sdk_configuration.globals)
+      headers = T.cast(headers, T::Hash[String, String])
+      query_params = Utils.get_query_params(Models::Operations::GetHrisPayRunsRequest, request, nil, @sdk_configuration.globals)
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      security = @sdk_configuration.security_source&.call
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+
+
+      connection = @sdk_configuration.client
+
+      hook_ctx = SDKHooks::HookContext.new(
+        config: @sdk_configuration,
+        base_url: base_url,
+        oauth2_scopes: nil,
+        operation_id: 'GetHrisPayRuns',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = T.let(nil, T.nilable(StandardError))
+      http_response = T.let(nil, T.nilable(Faraday::Response))
+      
+
+      begin
+        http_response = T.must(connection).get(url) do |req|
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          req.params = query_params
+          Utils.configure_request_security(req, security)
+          http_headers&.each do |key, value|
+            req.headers[key.to_s] = value
+          end
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if http_response.nil? || Utils.error_status?(http_response.status)
+          http_response = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        else
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        end
+
+        if http_response.nil?
+          raise error if !error.nil?
+          raise 'no response'
+        end
+      end
+
+      content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
+      if Utils.match_status_code(http_response.status, ['200'])
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Shared::GetHrisPayRunsPositiveResponse)
+          response = Models::Operations::GetHrisPayRunsResponse.new(
+            status_code: http_response.status,
+            content_type: content_type,
+            raw_response: http_response,
+            get_hris_pay_runs_positive_response: T.unsafe(obj)
+          )
+          sdk = self
+
+          response.next_page = proc do 
+            next_cursor = Janeway.enum_for('$.data.next', JSON.parse(response_data)).search
+            if next_cursor.nil?
+              next nil
+            else
+              next_cursor = next_cursor[0]
+              if next_cursor.nil?
+                next nil
+              end
+            end
+
+            sdk.get_hris_pay_runs(
+              integration_id: request.integration_id,
+              cursor: next_cursor,
+              page_size: request.page_size,
+              updated_after: request.updated_after,
+              include_deleted: request.include_deleted,
+              ignore_unsupported_filters: request.ignore_unsupported_filters,
+              ids: request.ids,
+              remote_ids: request.remote_ids,
+              legal_entity_ids: request.legal_entity_ids,
+              http_headers: http_headers
+            )
+          end
+
+
+          return response
+        else
+          raise ::Kombo::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      else
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::KomboHrisError)
+          obj.raw_response = http_response
+          raise obj
+        else
+          raise ::Kombo::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      end
+    end
+
+
+    sig { params(integration_id: T.nilable(::String), cursor: T.nilable(::String), page_size: T.nilable(::Integer), updated_after: T.nilable(::DateTime), include_deleted: T.nilable(T::Boolean), ignore_unsupported_filters: T.nilable(T::Boolean), ids: T.nilable(T::Array[::String]), remote_ids: T.nilable(T::Array[::String]), legal_entity_ids: T.nilable(T::Array[::String]), employee_ids: T.nilable(T::Array[::String]), payrun_ids: T.nilable(T::Array[::String]), timeout_ms: T.nilable(Integer), http_headers: T.nilable(T::Hash[T.any(String, Symbol), String])).returns(Models::Operations::GetHrisPayslipsResponse) }
+    def get_hris_payslips(integration_id: nil, cursor: nil, page_size: nil, updated_after: nil, include_deleted: nil, ignore_unsupported_filters: nil, ids: nil, remote_ids: nil, legal_entity_ids: nil, employee_ids: nil, payrun_ids: nil, timeout_ms: nil, http_headers: nil)
+      # get_hris_payslips - Payslips
+      # Retrieve all payslips for all employees, across all time.
+      #
+      # A payslip is the individual pay statement an employee receives for one pay run, detailing what they were paid. Each payslip embeds the `employee` it belongs to and the `pay_run` it was paid out through, its `totals`, and the `line_items` that make it up (earnings, deductions, and contributions). Filter by `employee_ids`, `payrun_ids`, or `legal_entity_ids` to narrow the results.
+      #
+      # Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`
+      request = Models::Operations::GetHrisPayslipsRequest.new(
+        integration_id: integration_id,
+        cursor: cursor,
+        page_size: page_size,
+        updated_after: updated_after,
+        include_deleted: include_deleted,
+        ignore_unsupported_filters: ignore_unsupported_filters,
+        ids: ids,
+        remote_ids: remote_ids,
+        legal_entity_ids: legal_entity_ids,
+        employee_ids: employee_ids,
+        payrun_ids: payrun_ids
+      )
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/hris/payslips"
+      headers = Utils.get_headers(request, @sdk_configuration.globals)
+      headers = T.cast(headers, T::Hash[String, String])
+      query_params = Utils.get_query_params(Models::Operations::GetHrisPayslipsRequest, request, nil, @sdk_configuration.globals)
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      security = @sdk_configuration.security_source&.call
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+
+
+      connection = @sdk_configuration.client
+
+      hook_ctx = SDKHooks::HookContext.new(
+        config: @sdk_configuration,
+        base_url: base_url,
+        oauth2_scopes: nil,
+        operation_id: 'GetHrisPayslips',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = T.let(nil, T.nilable(StandardError))
+      http_response = T.let(nil, T.nilable(Faraday::Response))
+      
+
+      begin
+        http_response = T.must(connection).get(url) do |req|
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          req.params = query_params
+          Utils.configure_request_security(req, security)
+          http_headers&.each do |key, value|
+            req.headers[key.to_s] = value
+          end
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if http_response.nil? || Utils.error_status?(http_response.status)
+          http_response = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        else
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        end
+
+        if http_response.nil?
+          raise error if !error.nil?
+          raise 'no response'
+        end
+      end
+
+      content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
+      if Utils.match_status_code(http_response.status, ['200'])
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Shared::GetHrisPayslipsPositiveResponse)
+          response = Models::Operations::GetHrisPayslipsResponse.new(
+            status_code: http_response.status,
+            content_type: content_type,
+            raw_response: http_response,
+            get_hris_payslips_positive_response: T.unsafe(obj)
+          )
+          sdk = self
+
+          response.next_page = proc do 
+            next_cursor = Janeway.enum_for('$.data.next', JSON.parse(response_data)).search
+            if next_cursor.nil?
+              next nil
+            else
+              next_cursor = next_cursor[0]
+              if next_cursor.nil?
+                next nil
+              end
+            end
+
+            sdk.get_hris_payslips(
+              integration_id: request.integration_id,
+              cursor: next_cursor,
+              page_size: request.page_size,
+              updated_after: request.updated_after,
+              include_deleted: request.include_deleted,
+              ignore_unsupported_filters: request.ignore_unsupported_filters,
+              ids: request.ids,
+              remote_ids: request.remote_ids,
+              legal_entity_ids: request.legal_entity_ids,
+              employee_ids: request.employee_ids,
+              payrun_ids: request.payrun_ids,
+              http_headers: http_headers
+            )
+          end
+
+
           return response
         else
           raise ::Kombo::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'

data/lib/kombo/models/operations/getatsattachments_request.rb

@@ -0,0 +1,74 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Kombo
+  module Models
+    module Operations
+
+      class GetAtsAttachmentsRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # ID of the integration you want to interact with.
+        field :integration_id, Crystalline::Nilable.new(::String), { 'header': { 'field_name': 'X-Integration-Id', 'style': 'simple', 'explode': false } }
+        # An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response.
+        field :cursor, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'cursor', 'style': 'form', 'explode': true } }
+        # Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.
+        #
+        # If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.
+        #
+        # For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).
+        #
+        # For this endpoint, only changes to the returned record itself are considered.
+        field :updated_after, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } }
+        # Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`.
+        field :ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'ids', 'style': 'form', 'explode': false } }
+        # Filter by a comma-separated list of remote IDs.
+        field :remote_ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'remote_ids', 'style': 'form', 'explode': false } }
+        # Filter by a comma-separated list of candidate IDs. Prefer filtering by `candidate_ids` when you want every file a candidate has, across all their applications.
+        field :candidate_ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'candidate_ids', 'style': 'form', 'explode': false } }
+        # Filter by a comma-separated list of application IDs. We will only return attachments that the ATS filed under _any_ of these applications, which excludes the files that hang off the candidate directly.
+        field :application_ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'application_ids', 'style': 'form', 'explode': false } }
+        # The number of results to return per page. Maximum is 250.
+        field :page_size, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'page_size', 'style': 'form', 'explode': true } }
+        # By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.
+        field :include_deleted, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'query_param': { 'field_name': 'include_deleted', 'style': 'form', 'explode': true } }
+        # When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
+        field :ignore_unsupported_filters, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'query_param': { 'field_name': 'ignore_unsupported_filters', 'style': 'form', 'explode': true } }
+
+        sig { params(integration_id: T.nilable(::String), cursor: T.nilable(::String), updated_after: T.nilable(::DateTime), ids: T.nilable(T::Array[::String]), remote_ids: T.nilable(T::Array[::String]), candidate_ids: T.nilable(T::Array[::String]), application_ids: T.nilable(T::Array[::String]), page_size: T.nilable(::Integer), include_deleted: T.nilable(T::Boolean), ignore_unsupported_filters: T.nilable(T::Boolean)).void }
+        def initialize(integration_id: nil, cursor: nil, updated_after: nil, ids: nil, remote_ids: nil, candidate_ids: nil, application_ids: nil, page_size: 100, include_deleted: false, ignore_unsupported_filters: false)
+          @integration_id = integration_id
+          @cursor = cursor
+          @updated_after = updated_after
+          @ids = ids
+          @remote_ids = remote_ids
+          @candidate_ids = candidate_ids
+          @application_ids = application_ids
+          @page_size = page_size
+          @include_deleted = include_deleted
+          @ignore_unsupported_filters = ignore_unsupported_filters
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @integration_id == other.integration_id
+          return false unless @cursor == other.cursor
+          return false unless @updated_after == other.updated_after
+          return false unless @ids == other.ids
+          return false unless @remote_ids == other.remote_ids
+          return false unless @candidate_ids == other.candidate_ids
+          return false unless @application_ids == other.application_ids
+          return false unless @page_size == other.page_size
+          return false unless @include_deleted == other.include_deleted
+          return false unless @ignore_unsupported_filters == other.ignore_unsupported_filters
+          true
+        end
+      end
+    end
+  end
+end

data/lib/kombo/models/operations/getatsattachments_request.rbi

@@ -0,0 +1,31 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Kombo::Models::Operations::GetAtsAttachmentsRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Kombo::Models::Operations::GetAtsAttachmentsRequest
+  def integration_id(); end
+  def integration_id=(str_); end
+  def cursor(); end
+  def cursor=(str_); end
+  def updated_after(); end
+  def updated_after=(str_); end
+  def ids(); end
+  def ids=(str_); end
+  def remote_ids(); end
+  def remote_ids=(str_); end
+  def candidate_ids(); end
+  def candidate_ids=(str_); end
+  def application_ids(); end
+  def application_ids=(str_); end
+  def page_size(); end
+  def page_size=(str_); end
+  def include_deleted(); end
+  def include_deleted=(str_); end
+  def ignore_unsupported_filters(); end
+  def ignore_unsupported_filters=(str_); end
+end

data/lib/kombo/models/operations/getatsattachments_response.rb

@@ -0,0 +1,56 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Kombo
+  module Models
+    module Operations
+
+      class GetAtsAttachmentsResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+        sig { returns(T.proc.returns(T.nilable(GetAtsAttachmentsResponse))) }
+        attr_accessor :next_page
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+        # GET /ats/attachments Positive response
+        field :get_ats_attachments_positive_response, Crystalline::Nilable.new(Models::Shared::GetAtsAttachmentsPositiveResponse)
+
+        sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, get_ats_attachments_positive_response: T.nilable(Models::Shared::GetAtsAttachmentsPositiveResponse)).void }
+        def initialize(content_type:, status_code:, raw_response:, get_ats_attachments_positive_response: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @get_ats_attachments_positive_response = get_ats_attachments_positive_response
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @get_ats_attachments_positive_response == other.get_ats_attachments_positive_response
+          true
+        end
+
+        def each
+          page = self
+          loop do
+            yield page
+            next_page = page.next_page.call if page.next_page
+            break if next_page.nil?
+            page = T.must(next_page)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kombo/models/operations/getatsattachments_response.rbi

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Kombo::Models::Operations::GetAtsAttachmentsResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Kombo::Models::Operations::GetAtsAttachmentsResponse
+  def content_type(); end
+  def content_type=(str_); end
+  def status_code(); end
+  def status_code=(str_); end
+  def raw_response(); end
+  def raw_response=(str_); end
+  def get_ats_attachments_positive_response(); end
+  def get_ats_attachments_positive_response=(str_); end
+end

data/lib/kombo/models/operations/getatsscorecards_request.rb

@@ -0,0 +1,83 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Kombo
+  module Models
+    module Operations
+
+      class GetAtsScorecardsRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # ID of the integration you want to interact with.
+        field :integration_id, Crystalline::Nilable.new(::String), { 'header': { 'field_name': 'X-Integration-Id', 'style': 'simple', 'explode': false } }
+        # An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response.
+        field :cursor, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'cursor', 'style': 'form', 'explode': true } }
+        # Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.
+        #
+        # If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.
+        #
+        # For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).
+        #
+        # For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.
+        #
+        # | Path | Added/Removed | Linked Record |
+        # | --- | --- | --- |
+        # | `author` | ✗ No | ✗ No |
+        # | `application` | ✗ No | ✗ No |
+        # | `candidate` | ✗ No | ✗ No |
+        # | `interview` | ✗ No | ✗ No |
+        #
+        # _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._
+        field :updated_after, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } }
+        # Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`.
+        field :ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'ids', 'style': 'form', 'explode': false } }
+        # Filter by a comma-separated list of remote IDs.
+        field :remote_ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'remote_ids', 'style': 'form', 'explode': false } }
+        # Filter by a comma-separated list of candidate IDs. Prefer filtering by `candidate_ids` when you want to download the full interview feedback available for a candidate, across all their applications.
+        field :candidate_ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'candidate_ids', 'style': 'form', 'explode': false } }
+        # Filter by a comma-separated list of application IDs. We will only return scorecards that belong to _any_ of these applications.
+        field :application_ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'application_ids', 'style': 'form', 'explode': false } }
+        # The number of results to return per page. Maximum is 250.
+        field :page_size, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'page_size', 'style': 'form', 'explode': true } }
+        # By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.
+        field :include_deleted, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'query_param': { 'field_name': 'include_deleted', 'style': 'form', 'explode': true } }
+        # When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
+        field :ignore_unsupported_filters, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'query_param': { 'field_name': 'ignore_unsupported_filters', 'style': 'form', 'explode': true } }
+
+        sig { params(integration_id: T.nilable(::String), cursor: T.nilable(::String), updated_after: T.nilable(::DateTime), ids: T.nilable(T::Array[::String]), remote_ids: T.nilable(T::Array[::String]), candidate_ids: T.nilable(T::Array[::String]), application_ids: T.nilable(T::Array[::String]), page_size: T.nilable(::Integer), include_deleted: T.nilable(T::Boolean), ignore_unsupported_filters: T.nilable(T::Boolean)).void }
+        def initialize(integration_id: nil, cursor: nil, updated_after: nil, ids: nil, remote_ids: nil, candidate_ids: nil, application_ids: nil, page_size: 100, include_deleted: false, ignore_unsupported_filters: false)
+          @integration_id = integration_id
+          @cursor = cursor
+          @updated_after = updated_after
+          @ids = ids
+          @remote_ids = remote_ids
+          @candidate_ids = candidate_ids
+          @application_ids = application_ids
+          @page_size = page_size
+          @include_deleted = include_deleted
+          @ignore_unsupported_filters = ignore_unsupported_filters
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @integration_id == other.integration_id
+          return false unless @cursor == other.cursor
+          return false unless @updated_after == other.updated_after
+          return false unless @ids == other.ids
+          return false unless @remote_ids == other.remote_ids
+          return false unless @candidate_ids == other.candidate_ids
+          return false unless @application_ids == other.application_ids
+          return false unless @page_size == other.page_size
+          return false unless @include_deleted == other.include_deleted
+          return false unless @ignore_unsupported_filters == other.ignore_unsupported_filters
+          true
+        end
+      end
+    end
+  end
+end

data/lib/kombo/models/operations/getatsscorecards_request.rbi

@@ -0,0 +1,31 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Kombo::Models::Operations::GetAtsScorecardsRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Kombo::Models::Operations::GetAtsScorecardsRequest
+  def integration_id(); end
+  def integration_id=(str_); end
+  def cursor(); end
+  def cursor=(str_); end
+  def updated_after(); end
+  def updated_after=(str_); end
+  def ids(); end
+  def ids=(str_); end
+  def remote_ids(); end
+  def remote_ids=(str_); end
+  def candidate_ids(); end
+  def candidate_ids=(str_); end
+  def application_ids(); end
+  def application_ids=(str_); end
+  def page_size(); end
+  def page_size=(str_); end
+  def include_deleted(); end
+  def include_deleted=(str_); end
+  def ignore_unsupported_filters(); end
+  def ignore_unsupported_filters=(str_); end
+end