@rippling/rippling-sdk 0.2.0-alpha.20

package/src/resources/departments.ts

@@ -0,0 +1,115 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Departments extends APIResource {
+  /**
+   * Retrieve a specific department
+   */
+  retrieve(
+    id: string,
+    query: DepartmentRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DepartmentRetrieveResponse> {
+    return this._client.get(path`/departments/${id}`, { query, ...options });
+  }
+
+  /**
+   * A List of departments
+   *
+   * - Requires: `API Tier 1`
+   * - Expandable fields: `parent`, `department_hierarchy`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: DepartmentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DepartmentsPageCursorURL, Department> {
+    return this._client.getAPIList('/departments', PageCursorURL<Department>, { query, ...options });
+  }
+}
+
+export type DepartmentsPageCursorURL = PageCursorURL<Department>;
+
+export interface Department {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The name of the department.
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * List of departments in the department hierarchy. Refer department_hierarchy_ids
+   * for department hierarchy order.
+   *
+   * Expandable field
+   */
+  department_hierarchy?: Array<Department>;
+
+  /**
+   * The identifier of departments in the department hierarchy ordered from parent
+   * department to child department.
+   */
+  department_hierarchy_id?: Array<string>;
+
+  /**
+   * The parent department.
+   *
+   * Expandable field
+   */
+  parent?: Department;
+
+  /**
+   * The parent department.
+   */
+  parent_id?: string;
+
+  /**
+   * Reference code of the department.
+   */
+  reference_code?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface DepartmentRetrieveResponse extends BusinessPartnersAPI.Meta, Department {}
+
+export interface DepartmentRetrieveParams {
+  expand?: string;
+}
+
+export interface DepartmentListParams {
+  expand?: string;
+
+  order_by?: string;
+}
+
+export declare namespace Departments {
+  export {
+    type Department as Department,
+    type DepartmentRetrieveResponse as DepartmentRetrieveResponse,
+    type DepartmentsPageCursorURL as DepartmentsPageCursorURL,
+    type DepartmentRetrieveParams as DepartmentRetrieveParams,
+    type DepartmentListParams as DepartmentListParams,
+  };
+}

package/src/resources/employment-types.ts

@@ -0,0 +1,107 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class EmploymentTypes extends APIResource {
+  /**
+   * Retrieve a specific employment type
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<EmploymentTypeRetrieveResponse> {
+    return this._client.get(path`/employment-types/${id}`, options);
+  }
+
+  /**
+   * A List of employment types
+   *
+   * - Requires: `API Tier 1`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: EmploymentTypeListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CompanyEmploymentTypesPageCursorURL, CompanyEmploymentType> {
+    return this._client.getAPIList('/employment-types', PageCursorURL<CompanyEmploymentType>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type CompanyEmploymentTypesPageCursorURL = PageCursorURL<CompanyEmploymentType>;
+
+export interface CompanyEmploymentType {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The display label of the employment type.
+   */
+  label: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The amount worked for the employment type. _ `FULL-TIME`: Full-time is at least
+   * 30 hours per week. Full-time workers will typically be eligible for benefits. _
+   * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be
+   * eligible for benefits, depending on company settings and hours worked. \*
+   * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how
+   * each worker with this employment type will be paid individually.
+   */
+  amount_worked?: 'PART-TIME' | 'FULL-TIME' | 'TEMPORARY';
+
+  /**
+   * The compensation period for the employment type. _ `SALARIED`: Employees that
+   * are paid a fixed amount per year. _ `HOURLY`: Employees that are paid a wage per
+   * hour worked.
+   */
+  compensation_time_period?: 'HOURLY' | 'SALARIED';
+
+  /**
+   * The name of the employment type for non-custom employment types.
+   */
+  name?: string;
+
+  /**
+   * The classification of the worker by the company. _ `CONTRACTOR`: Contractors are
+   * self-employed workers who provide services on a short-term or per-project basis
+   * and are not eligible for tax-withholding or benefits. _ `EMPLOYEE`: Employees
+   * are hired and managed by an employer, work under the employer's direct
+   * supervision and control, and are protected by law for wages and employment
+   * rights.
+   */
+  type?: 'CONTRACTOR' | 'EMPLOYEE';
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface EmploymentTypeRetrieveResponse extends BusinessPartnersAPI.Meta, CompanyEmploymentType {}
+
+export interface EmploymentTypeListParams {
+  order_by?: string;
+}
+
+export declare namespace EmploymentTypes {
+  export {
+    type CompanyEmploymentType as CompanyEmploymentType,
+    type EmploymentTypeRetrieveResponse as EmploymentTypeRetrieveResponse,
+    type CompanyEmploymentTypesPageCursorURL as CompanyEmploymentTypesPageCursorURL,
+    type EmploymentTypeListParams as EmploymentTypeListParams,
+  };
+}

package/src/resources/entitlements.ts

@@ -0,0 +1,44 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+
+export class Entitlements extends APIResource {
+  /**
+   * A List of entitlements
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(
+    options?: RequestOptions,
+  ): PagePromise<EntitlementListResponsesPageCursorURL, EntitlementListResponse> {
+    return this._client.getAPIList('/entitlements', PageCursorURL<EntitlementListResponse>, options);
+  }
+}
+
+export type EntitlementListResponsesPageCursorURL = PageCursorURL<EntitlementListResponse>;
+
+export interface EntitlementListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Description of the entitlement
+   */
+  description: string;
+
+  /**
+   * Display name of the entitlement
+   */
+  display_name: string;
+}
+
+export declare namespace Entitlements {
+  export {
+    type EntitlementListResponse as EntitlementListResponse,
+    type EntitlementListResponsesPageCursorURL as EntitlementListResponsesPageCursorURL,
+  };
+}

package/src/resources/functions/deployments.ts

@@ -0,0 +1,209 @@
+// 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';
+import { path } from '../../internal/utils/path';
+
+export class Deployments extends APIResource {
+  /**
+   * Create a new function deployment
+   */
+  create(
+    functionAPIName: string,
+    body: DeploymentCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FunctionDeployment> {
+    return this._client.post(path`/functions/${functionAPIName}/deployments/`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific function deployment
+   */
+  retrieve(
+    deploymentID: string,
+    params: DeploymentRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<FunctionDeployment> {
+    const { function_api_name } = params;
+    return this._client.get(path`/functions/${function_api_name}/deployments/${deploymentID}/`, options);
+  }
+
+  /**
+   * A List of function deployments
+   *
+   * - Requires: `Functions API`
+   */
+  list(functionAPIName: string, options?: RequestOptions): APIPromise<DeploymentListResponse> {
+    return this._client.get(path`/functions/${functionAPIName}/deployments/`, options);
+  }
+
+  /**
+   * A List of function deployment logs
+   *
+   * - Requires: `Functions API`
+   */
+  listLogs(
+    deploymentID: string,
+    params: DeploymentListLogsParams,
+    options?: RequestOptions,
+  ): APIPromise<DeploymentListLogsResponse> {
+    const { function_api_name } = params;
+    return this._client.get(path`/functions/${function_api_name}/deployments/${deploymentID}/logs/`, options);
+  }
+}
+
+export interface FunctionDeployment {
+  /**
+   * The ID of the deployment
+   */
+  id: string;
+
+  /**
+   * The creation date of the deployment
+   */
+  created_at: string;
+
+  /**
+   * The last updated date of the deployment
+   */
+  updated_at: string;
+
+  /**
+   * Domains that function runs from this deployment are allowed to access
+   */
+  allowed_domains?: Array<string>;
+
+  /**
+   * The code for the deployment
+   */
+  code?: string;
+
+  /**
+   * The dependencies of the deployment
+   */
+  dependencies?: unknown;
+
+  /**
+   * The external ID of the deployment
+   */
+  external_id?: string;
+
+  /**
+   * The API name of the function that this deployment is associated with
+   */
+  function_api_name?: string;
+
+  /**
+   * The ID of the function that this deployment is associated with
+   */
+  function_id?: string;
+
+  /**
+   * The human friendly ID of version that this deployment is associated with
+   */
+  function_version_human_friendly_id?: number;
+
+  /**
+   * The ID of the version that this deployment is associated with
+   */
+  function_version_id?: string;
+
+  /**
+   * Additional, runtime-specific options for the deployment
+   */
+  options?: unknown;
+
+  /**
+   * The runtime for the deployment
+   */
+  runtime?: string;
+
+  /**
+   * The status of the deployment
+   */
+  status?: string;
+}
+
+export interface DeploymentListResponse {
+  results?: Array<FunctionDeployment>;
+}
+
+export interface DeploymentListLogsResponse {
+  results?: Array<DeploymentListLogsResponse.Result>;
+}
+
+export namespace DeploymentListLogsResponse {
+  export interface Result {
+    /**
+     * The log message
+     */
+    message: string;
+
+    /**
+     * The sequence number of the log line
+     */
+    sequence_num: number;
+
+    /**
+     * The log level
+     */
+    level?: string;
+
+    /**
+     * Parameters associated with the log line
+     */
+    params?: unknown;
+
+    /**
+     * The log timestamp
+     */
+    timestamp?: string;
+  }
+}
+
+export interface DeploymentCreateParams {
+  /**
+   * Domains that function runs from this deployment are allowed to access
+   */
+  allowed_domains?: Array<string>;
+
+  /**
+   * The code for the deployment
+   */
+  code?: string;
+
+  /**
+   * The dependencies of the deployment
+   */
+  dependencies?: unknown;
+
+  /**
+   * Additional, runtime-specific options for the deployment
+   */
+  options?: unknown;
+
+  /**
+   * The runtime for the deployment
+   */
+  runtime?: string;
+}
+
+export interface DeploymentRetrieveParams {
+  function_api_name: string;
+}
+
+export interface DeploymentListLogsParams {
+  function_api_name: string;
+}
+
+export declare namespace Deployments {
+  export {
+    type FunctionDeployment as FunctionDeployment,
+    type DeploymentListResponse as DeploymentListResponse,
+    type DeploymentListLogsResponse as DeploymentListLogsResponse,
+    type DeploymentCreateParams as DeploymentCreateParams,
+    type DeploymentRetrieveParams as DeploymentRetrieveParams,
+    type DeploymentListLogsParams as DeploymentListLogsParams,
+  };
+}