@rippling/rippling-sdk 0.2.0-alpha.105 → 0.2.0-alpha.106

package/src/resources/hire-requirements.ts

@@ -9,8 +9,9 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class HireRequirements extends APIResource {
   /**
-   * Return baseline required fields for a country and hire type. POST /hires/
-   * remains authoritative for company-specific validation.
+   * Return baseline required fields for a country and hire type.
+   * requirements_version identifies this catalog snapshot. POST /hires/ does not
+   * accept it. POST /hires/ remains authoritative for company-specific validation.
    *
    * @example HTTP
    * Representative request and response shapes.
@@ -30,23 +31,6 @@ export class HireRequirements extends APIResource {
    *   "required_groups": [
    *     "string"
    *   ],
-   *   "top_level_fields": [
-   *     {
-   *       "field": "string",
-   *       "type": {},
-   *       "requiredness": "string",
-   *       "required_when": {
-   *         "field": "string",
-   *         "operator": "string",
-   *         "value": {}
-   *       },
-   *       "format": "string",
-   *       "items": null,
-   *       "fields": [
-   *         "string"
-   *       ]
-   *     }
-   *   ],
    *   "fields_by_group": [
    *     null
    *   ],
@@ -79,12 +63,13 @@ export interface HireRequirementListResponse {
   fields_by_group: Array<unknown>;
 
   /**
-   * Hire type used for the lookup.
+   * Hire type for this catalog. POST /hires/ uses the same value. An omitted POST
+   * value defaults to direct_hire.
    */
   hire_type: string;
 
   /**
-   * Catalog groups that apply for this selector tuple.
+   * Groups you must send for this country.
    */
   required_groups: Array<string>;
 
@@ -93,11 +78,6 @@ export interface HireRequirementListResponse {
    */
   requirements_version: string;
 
-  /**
-   * Item-level fields such as client_request_id.
-   */
-  top_level_fields?: Array<HireRequirementListResponse.TopLevelField>;
-
   /**
    * Public field paths that are not writable for this selector tuple.
    */
@@ -109,67 +89,10 @@ export interface HireRequirementListResponse {
   warnings?: Array<string>;
 }
 
-export namespace HireRequirementListResponse {
-  export interface TopLevelField {
-    /**
-     * JSON type string, or a list of allowed types for custom-field values.
-     */
-    type: unknown;
-
-    /**
-     * Public field name relative to its group, or omitted for array item descriptors.
-     */
-    field?: string;
-
-    /**
-     * Nested object fields when type is object.
-     */
-    fields?: Array<unknown>;
-
-    /**
-     * date means YYYY-MM-DD.
-     */
-    format?: string;
-
-    items?: unknown;
-
-    /**
-     * Sibling-field condition when requiredness is dependent.
-     */
-    required_when?: TopLevelField.RequiredWhen;
-
-    /**
-     * required, optional, or dependent.
-     */
-    requiredness?: string;
-  }
-
-  export namespace TopLevelField {
-    /**
-     * Sibling-field condition when requiredness is dependent.
-     */
-    export interface RequiredWhen {
-      /**
-       * Sibling field in the same object that this condition inspects.
-       */
-      field: string;
-
-      /**
-       * equals, not_equals, present, or absent.
-       */
-      operator: string;
-
-      /**
-       * Comparison value for equals and not_equals. Omitted for present and absent.
-       */
-      value?: unknown;
-    }
-  }
-}
-
 export interface HireRequirementListParams {
   /**
-   * ISO 3166-1 alpha-2 country code. First milestone supports US and CA.
+   * ISO 3166-1 alpha-2 country code. Direct hire is supported in AU, CA, CH, CN, DE,
+   * ES, FR, GB, HK, IE, IN, NL, NZ, and US.
    */
   country_code: string;