@vitable-inc/vitable-connect 0.3.0 → 2.0.0

package/src/resources/employees.ts

@@ -1,297 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../core/resource';
-import * as EnrollmentsAPI from './enrollments';
-import { EnrollmentsPageNumberPage } from './enrollments';
-import { APIPromise } from '../core/api-promise';
-import { PageNumberPage, type PageNumberPageParams, PagePromise } from '../core/pagination';
-import { RequestOptions } from '../internal/request-options';
-import { path } from '../internal/utils/path';
-
-export class Employees extends APIResource {
-  /**
-   * Retrieves detailed information for a specific employee by ID. Returns employee
-   * details including personal information, employment status, and payroll
-   * deductions from the most recent statement period. Deductions reflect a snapshot
-   * of the current period and are replaced when a new statement is generated.
-   */
-  retrieve(employeeID: string, options?: RequestOptions): APIPromise<EmployeeRetrieveResponse> {
-    return this._client.get(path`/v1/employees/${employeeID}`, options);
-  }
-
-  /**
-   * Retrieves a paginated list of benefit enrollments for an employee.
-   */
-  listEnrollments(
-    employeeID: string,
-    query: EmployeeListEnrollmentsParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<EnrollmentsPageNumberPage, EnrollmentsAPI.Enrollment> {
-    return this._client.getAPIList(
-      path`/v1/employees/${employeeID}/enrollments`,
-      PageNumberPage<EnrollmentsAPI.Enrollment>,
-      { query, ...options },
-    );
-  }
-}
-
-export type EmployeesPageNumberPage = PageNumberPage<Employee>;
-
-export interface Employee {
-  /**
-   * Unique employee identifier with 'empl\_' prefix
-   */
-  id: string;
-
-  /**
-   * Timestamp when the employee was created
-   */
-  created_at: string;
-
-  /**
-   * Date of birth (YYYY-MM-DD)
-   */
-  date_of_birth: string;
-
-  /**
-   * Payroll deductions from the most recent statement period. Replaced when a new
-   * statement is generated.
-   */
-  deductions: Array<Employee.Deduction>;
-
-  /**
-   * Email address
-   */
-  email: string;
-
-  /**
-   * Benefit enrollments for this employee
-   */
-  enrollments: Array<Employee.Enrollment>;
-
-  /**
-   * Employee's legal first name
-   */
-  first_name: string;
-
-  /**
-   * Employee's legal last name
-   */
-  last_name: string;
-
-  /**
-   * Unique member identifier with 'mbr\_' prefix
-   */
-  member_id: string;
-
-  /**
-   * Employee status (active or terminated)
-   */
-  status: string;
-
-  /**
-   * Timestamp when the employee was last updated
-   */
-  updated_at: string;
-
-  /**
-   * Employee's residential address
-   */
-  address?: Employee.Address | null;
-
-  /**
-   * - `Full Time` - Full Time
-   * - `Part Time` - Part Time
-   * - `Temporary` - Temporary
-   * - `Intern` - Intern
-   * - `Seasonal` - Seasonal
-   * - `Individual Contractor` - Individual Contractor
-   */
-  employee_class?: EmployeeClass | null;
-
-  /**
-   * Gender identity, if provided
-   */
-  gender?: string | null;
-
-  /**
-   * Employee's hire date with the employer
-   */
-  hire_date?: string | null;
-
-  /**
-   * Phone number (10-digit US domestic string)
-   */
-  phone?: string | null;
-
-  /**
-   * Partner-assigned reference ID for the employee
-   */
-  reference_id?: string | null;
-
-  /**
-   * Name suffix (e.g., Jr., Sr., III)
-   */
-  suffix?: string | null;
-
-  /**
-   * Employee's termination date, if terminated
-   */
-  termination_date?: string | null;
-}
-
-export namespace Employee {
-  export interface Deduction {
-    /**
-     * Name of the benefit plan
-     */
-    benefit_name: string;
-
-    /**
-     * Employee deduction amount in cents
-     */
-    deduction_amount_in_cents: number;
-
-    /**
-     * Deduction category (reserved for future use)
-     */
-    deduction_category: string | null;
-
-    /**
-     * - `weekly` - Weekly
-     * - `bi_weekly` - Bi Weekly
-     * - `semi_monthly` - Semi Monthly
-     * - `monthly` - Monthly
-     */
-    frequency: 'weekly' | 'bi_weekly' | 'semi_monthly' | 'monthly';
-
-    /**
-     * Period end date (YYYY-MM-DD)
-     */
-    period_end_date: string;
-
-    /**
-     * Period start date (YYYY-MM-DD)
-     */
-    period_start_date: string;
-
-    /**
-     * - `Unknown` - Unknown
-     * - `Pre-tax` - Pre Tax
-     * - `Post-tax` - Post Tax
-     */
-    tax_classification: 'Unknown' | 'Pre-tax' | 'Post-tax';
-  }
-
-  export interface Enrollment {
-    /**
-     * Unique enrollment identifier with 'enrl\_' prefix
-     */
-    id: string;
-
-    /**
-     * - `pending` - Pending
-     * - `enrolled` - Enrolled
-     * - `waived` - Waived
-     * - `inactive` - Inactive
-     */
-    status: EnrollmentsAPI.EnrollmentStatus;
-
-    /**
-     * Timestamp when the enrollment decision was made
-     */
-    answered_at?: string | null;
-  }
-
-  /**
-   * Employee's residential address
-   */
-  export interface Address {
-    /**
-     * Primary street address
-     */
-    address_line_1: string;
-
-    /**
-     * City name
-     */
-    city: string;
-
-    /**
-     * Two-letter state code (e.g., CA, NY)
-     */
-    state: string;
-
-    /**
-     * ZIP code (5 or 9 digit)
-     */
-    zipcode: string;
-
-    /**
-     * Secondary street address (apt, suite, etc.)
-     */
-    address_line_2?: string | null;
-  }
-}
-
-/**
- * - `Full Time` - Full Time
- * - `Part Time` - Part Time
- * - `Temporary` - Temporary
- * - `Intern` - Intern
- * - `Seasonal` - Seasonal
- * - `Individual Contractor` - Individual Contractor
- */
-export type EmployeeClass =
-  | 'Full Time'
-  | 'Part Time'
-  | 'Temporary'
-  | 'Intern'
-  | 'Seasonal'
-  | 'Individual Contractor';
-
-/**
- * Pagination metadata for list responses.
- */
-export interface Pagination {
-  /**
-   * Items per page
-   */
-  limit: number;
-
-  /**
-   * Current page number
-   */
-  page: number;
-
-  /**
-   * Total number of items
-   */
-  total: number;
-
-  /**
-   * Total number of pages
-   */
-  total_pages: number;
-}
-
-/**
- * Response containing a single employee resource.
- */
-export interface EmployeeRetrieveResponse {
-  data: Employee;
-}
-
-export interface EmployeeListEnrollmentsParams extends PageNumberPageParams {}
-
-export declare namespace Employees {
-  export {
-    type Employee as Employee,
-    type EmployeeClass as EmployeeClass,
-    type Pagination as Pagination,
-    type EmployeeRetrieveResponse as EmployeeRetrieveResponse,
-    type EmployeeListEnrollmentsParams as EmployeeListEnrollmentsParams,
-  };
-}
-
-export { type EnrollmentsPageNumberPage };