@rippling/rippling-sdk 0.2.0-alpha.95 → 0.2.0-alpha.97

package/src/resources/hire-requirements.ts

@@ -0,0 +1,140 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Baseline required fields for submitting hires by country and hire type
+ */
+export class HireRequirements extends APIResource {
+  /**
+   * Return baseline required fields for a country and hire type. POST /hires/
+   * remains authoritative for company-specific validation.
+   */
+  list(query: HireRequirementListParams, options?: RequestOptions): APIPromise<HireRequirementListResponse> {
+    return this._client.get('/hire-requirements/', { query, ...options });
+  }
+}
+
+/**
+ * Public GET /hire-requirements/ body. Shape matches hiring's catalog JSON.
+ */
+export interface HireRequirementListResponse {
+  /**
+   * ISO 3166-1 alpha-2 country code used for the lookup.
+   */
+  country_code: string;
+
+  /**
+   * Hiring-owned field catalog grouped by request section.
+   */
+  fields_by_group: Array<unknown>;
+
+  /**
+   * Hire type used for the lookup.
+   */
+  hire_type: string;
+
+  /**
+   * Catalog groups that apply for this selector tuple.
+   */
+  required_groups: Array<string>;
+
+  /**
+   * Baseline requirement contract version for this selector tuple.
+   */
+  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.
+   */
+  unsupported_fields?: Array<string>;
+
+  /**
+   * Non-fatal warnings for this lookup.
+   */
+  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.
+   */
+  country_code: string;
+
+  /**
+   * Hire type. First milestone supports direct_hire only.
+   */
+  hire_type: 'direct_hire';
+}
+
+export declare namespace HireRequirements {
+  export {
+    type HireRequirementListResponse as HireRequirementListResponse,
+    type HireRequirementListParams as HireRequirementListParams,
+  };
+}