@rippling/rippling-sdk 0.2.0-alpha.26 → 0.2.0-alpha.28

package/src/resources/business-partners.ts

@@ -10,6 +10,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Business partners of the company
+ */
 export class BusinessPartners extends APIResource {
   /**
    * A List of business partners
@@ -23,7 +26,7 @@ export class BusinessPartners extends APIResource {
     query: BusinessPartnerListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<BusinessPartnersPageCursorURL, BusinessPartner> {
-    return this._client.getAPIList('/business-partners', PageCursorURL<BusinessPartner>, {
+    return this._client.getAPIList('/business-partners/', PageCursorURL<BusinessPartner>, {
       query,
       ...options,
     });
@@ -33,7 +36,7 @@ export class BusinessPartners extends APIResource {
    * Create a new business partner
    */
   create(body: BusinessPartnerCreateParams, options?: RequestOptions): APIPromise<BusinessPartner> {
-    return this._client.post('/business-partners', { body, ...options });
+    return this._client.post('/business-partners/', { body, ...options });
   }
 
   /**
@@ -44,14 +47,14 @@ export class BusinessPartners extends APIResource {
     query: BusinessPartnerRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<BusinessPartnerRetrieveResponse> {
-    return this._client.get(path`/business-partners/${id}`, { query, ...options });
+    return this._client.get(path`/business-partners/${id}/`, { query, ...options });
   }
 
   /**
    * Delete a business partner
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/business-partners/${id}`, {
+    return this._client.delete(path`/business-partners/${id}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });

package/src/resources/candidate-applications.ts

@@ -5,6 +5,9 @@ import * as JobRequisitionsAPI from './job-requisitions';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * An application by a candidate to a specific job requisition
+ */
 export class CandidateApplications extends APIResource {
   /**
    * A List of candidate applications
@@ -18,7 +21,7 @@ export class CandidateApplications extends APIResource {
     options?: RequestOptions,
   ): PagePromise<CandidateApplicationListResponsesPageCursorURL, CandidateApplicationListResponse> {
     return this._client.getAPIList(
-      '/candidate-applications',
+      '/candidate-applications/',
       PageCursorURL<CandidateApplicationListResponse>,
       { query, ...options },
     );

package/src/resources/candidates.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Someone who applies to a job requisition opened by the company
+ */
 export class Candidates extends APIResource {
   /**
    * A List of candidates
@@ -15,7 +18,7 @@ export class Candidates extends APIResource {
     query: CandidateListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<CandidateListResponsesPageCursorURL, CandidateListResponse> {
-    return this._client.getAPIList('/candidates', PageCursorURL<CandidateListResponse>, {
+    return this._client.getAPIList('/candidates/', PageCursorURL<CandidateListResponse>, {
       query,
       ...options,
     });

package/src/resources/companies.ts

@@ -6,6 +6,9 @@ import * as Shared from './shared';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Companies on Rippling
+ */
 export class Companies extends APIResource {
   /**
    * A List of companies
@@ -18,7 +21,7 @@ export class Companies extends APIResource {
     query: CompanyListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<CompaniesPageCursorURL, Company> {
-    return this._client.getAPIList('/companies', PageCursorURL<Company>, { query, ...options });
+    return this._client.getAPIList('/companies/', PageCursorURL<Company>, { query, ...options });
   }
 }
 

package/src/resources/compensation-bands-details.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Compensation bands details associated with workers
+ */
 export class CompensationBandsDetails extends APIResource {
   /**
    * A List of compensation bands details
@@ -23,7 +26,7 @@ export class CompensationBandsDetails extends APIResource {
     options?: RequestOptions,
   ): PagePromise<CompensationBandsDetailListResponsesPageCursorURL, CompensationBandsDetailListResponse> {
     return this._client.getAPIList(
-      '/compensation-bands-details',
+      '/compensation-bands-details/',
       PageCursorURL<CompensationBandsDetailListResponse>,
       { query, ...options },
     );
@@ -37,7 +40,7 @@ export class CompensationBandsDetails extends APIResource {
     query: CompensationBandsDetailRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<CompensationBandsDetailRetrieveResponse> {
-    return this._client.get(path`/compensation-bands-details/${id}`, { query, ...options });
+    return this._client.get(path`/compensation-bands-details/${id}/`, { query, ...options });
   }
 }
 

package/src/resources/compensations.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Compensation associated with workers
+ */
 export class Compensations extends APIResource {
   /**
    * A List of compensations
@@ -20,7 +23,7 @@ export class Compensations extends APIResource {
     query: CompensationListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<CompensationsPageCursorURL, Compensation> {
-    return this._client.getAPIList('/compensations', PageCursorURL<Compensation>, { query, ...options });
+    return this._client.getAPIList('/compensations/', PageCursorURL<Compensation>, { query, ...options });
   }
 
   /**
@@ -31,7 +34,7 @@ export class Compensations extends APIResource {
     query: CompensationRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<CompensationRetrieveResponse> {
-    return this._client.get(path`/compensations/${id}`, { query, ...options });
+    return this._client.get(path`/compensations/${id}/`, { query, ...options });
   }
 }
 

package/src/resources/create-app-notification.ts

@@ -0,0 +1,46 @@
+// 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';
+
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+export class CreateAppNotification extends APIResource {
+  /**
+   * Create an in-app notification for the specified recipients.
+   */
+  create(
+    body: CreateAppNotificationCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<CreateAppNotificationCreateResponse> {
+    return this._client.post('/create-app-notification/', { body, ...options });
+  }
+}
+
+export interface CreateAppNotificationCreateResponse {
+  /**
+   * Result of the create app notification action
+   */
+  result: unknown;
+}
+
+export interface CreateAppNotificationCreateParams {
+  description: string;
+
+  recipients: Array<string>;
+
+  subject: string;
+
+  days_from_now?: number | null;
+
+  due_date?: string | null;
+}
+
+export declare namespace CreateAppNotification {
+  export {
+    type CreateAppNotificationCreateResponse as CreateAppNotificationCreateResponse,
+    type CreateAppNotificationCreateParams as CreateAppNotificationCreateParams,
+  };
+}

package/src/resources/custom-apps.ts

@@ -0,0 +1,442 @@
+// 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 { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class CustomApps extends APIResource {
+  /**
+   * A List of CustomApp
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(options?: RequestOptions): PagePromise<CustomAppListResponsesPageCursorURL, CustomAppListResponse> {
+    return this._client.getAPIList('/custom-apps/', PageCursorURL<CustomAppListResponse>, options);
+  }
+
+  /**
+   * Create a new CustomApp
+   */
+  create(body: CustomAppCreateParams, options?: RequestOptions): APIPromise<CustomAppCreateResponse> {
+    return this._client.post('/custom-apps/', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific CustomApp
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<CustomAppRetrieveResponse> {
+    return this._client.get(path`/custom-apps/${id}/`, options);
+  }
+
+  /**
+   * Updated a specific CustomApp
+   */
+  update(
+    id: string,
+    body: CustomAppUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<CustomAppUpdateResponse> {
+    return this._client.patch(path`/custom-apps/${id}/`, { body, ...options });
+  }
+
+  /**
+   * Delete a CustomApp
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/custom-apps/${id}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type CustomAppListResponsesPageCursorURL = PageCursorURL<CustomAppListResponse>;
+
+export interface CustomAppListResponse {
+  /**
+   * The unique api name of the custom app
+   */
+  api_name: string;
+
+  /**
+   * The display name of the custom app
+   */
+  name: string;
+
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The description of the custom app
+   */
+  description?: string;
+
+  /**
+   * The icon URL of the custom app
+   */
+  icon?: string;
+
+  /**
+   * The pages of the custom app
+   */
+  pages?: Array<CustomAppListResponse.Page>;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+}
+
+export namespace CustomAppListResponse {
+  /**
+   * Summary of a page attached to a custom app.
+   */
+  export interface Page {
+    /**
+     * The unique name of the page within the app
+     */
+    api_name?: string;
+
+    /**
+     * The ID of the canvas instance backing this page (canvas_page only)
+     */
+    canvas_instance_id?: string;
+
+    /**
+     * The ID of the role that created the page
+     */
+    created_by?: string;
+
+    /**
+     * The ID of the Rippling Function rendering this page (sdui_page only)
+     */
+    function_id?: string;
+
+    /**
+     * The type of page (e.g. 'canvas_page', 'sdui_page', 'object_page')
+     */
+    page_type?: string;
+
+    /**
+     * The ID of the SDUI page instance (sdui_page only)
+     */
+    sdui_page_id?: string;
+
+    /**
+     * The ID of the role that last modified the page
+     */
+    updated_by?: string;
+  }
+}
+
+export interface CustomAppCreateResponse {
+  /**
+   * The unique api name of the custom app
+   */
+  api_name: string;
+
+  /**
+   * The display name of the custom app
+   */
+  name: string;
+
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The description of the custom app
+   */
+  description?: string;
+
+  /**
+   * The icon URL of the custom app
+   */
+  icon?: string;
+
+  /**
+   * The pages of the custom app
+   */
+  pages?: Array<CustomAppCreateResponse.Page>;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+}
+
+export namespace CustomAppCreateResponse {
+  /**
+   * Summary of a page attached to a custom app.
+   */
+  export interface Page {
+    /**
+     * The unique name of the page within the app
+     */
+    api_name?: string;
+
+    /**
+     * The ID of the canvas instance backing this page (canvas_page only)
+     */
+    canvas_instance_id?: string;
+
+    /**
+     * The ID of the role that created the page
+     */
+    created_by?: string;
+
+    /**
+     * The ID of the Rippling Function rendering this page (sdui_page only)
+     */
+    function_id?: string;
+
+    /**
+     * The type of page (e.g. 'canvas_page', 'sdui_page', 'object_page')
+     */
+    page_type?: string;
+
+    /**
+     * The ID of the SDUI page instance (sdui_page only)
+     */
+    sdui_page_id?: string;
+
+    /**
+     * The ID of the role that last modified the page
+     */
+    updated_by?: string;
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface CustomAppRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * The unique api name of the custom app
+   */
+  api_name: string;
+
+  /**
+   * The display name of the custom app
+   */
+  name: string;
+
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The description of the custom app
+   */
+  description?: string;
+
+  /**
+   * The icon URL of the custom app
+   */
+  icon?: string;
+
+  /**
+   * The pages of the custom app
+   */
+  pages?: Array<CustomAppRetrieveResponse.Page>;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+}
+
+export namespace CustomAppRetrieveResponse {
+  /**
+   * Summary of a page attached to a custom app.
+   */
+  export interface Page {
+    /**
+     * The unique name of the page within the app
+     */
+    api_name?: string;
+
+    /**
+     * The ID of the canvas instance backing this page (canvas_page only)
+     */
+    canvas_instance_id?: string;
+
+    /**
+     * The ID of the role that created the page
+     */
+    created_by?: string;
+
+    /**
+     * The ID of the Rippling Function rendering this page (sdui_page only)
+     */
+    function_id?: string;
+
+    /**
+     * The type of page (e.g. 'canvas_page', 'sdui_page', 'object_page')
+     */
+    page_type?: string;
+
+    /**
+     * The ID of the SDUI page instance (sdui_page only)
+     */
+    sdui_page_id?: string;
+
+    /**
+     * The ID of the role that last modified the page
+     */
+    updated_by?: string;
+  }
+}
+
+export interface CustomAppUpdateResponse {
+  /**
+   * The unique api name of the custom app
+   */
+  api_name: string;
+
+  /**
+   * The display name of the custom app
+   */
+  name: string;
+
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The description of the custom app
+   */
+  description?: string;
+
+  /**
+   * The icon URL of the custom app
+   */
+  icon?: string;
+
+  /**
+   * The pages of the custom app
+   */
+  pages?: Array<CustomAppUpdateResponse.Page>;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+}
+
+export namespace CustomAppUpdateResponse {
+  /**
+   * Summary of a page attached to a custom app.
+   */
+  export interface Page {
+    /**
+     * The unique name of the page within the app
+     */
+    api_name?: string;
+
+    /**
+     * The ID of the canvas instance backing this page (canvas_page only)
+     */
+    canvas_instance_id?: string;
+
+    /**
+     * The ID of the role that created the page
+     */
+    created_by?: string;
+
+    /**
+     * The ID of the Rippling Function rendering this page (sdui_page only)
+     */
+    function_id?: string;
+
+    /**
+     * The type of page (e.g. 'canvas_page', 'sdui_page', 'object_page')
+     */
+    page_type?: string;
+
+    /**
+     * The ID of the SDUI page instance (sdui_page only)
+     */
+    sdui_page_id?: string;
+
+    /**
+     * The ID of the role that last modified the page
+     */
+    updated_by?: string;
+  }
+}
+
+export interface CustomAppCreateParams {
+  /**
+   * The unique api name of the custom app
+   */
+  api_name: string;
+
+  /**
+   * The display name of the custom app
+   */
+  name: string;
+
+  /**
+   * The description of the custom app
+   */
+  description?: string;
+}
+
+export interface CustomAppUpdateParams {
+  /**
+   * The unique api name of the custom app
+   */
+  api_name: string;
+
+  /**
+   * The display name of the custom app
+   */
+  name: string;
+
+  /**
+   * The description of the custom app
+   */
+  description?: string;
+}
+
+export declare namespace CustomApps {
+  export {
+    type CustomAppListResponse as CustomAppListResponse,
+    type CustomAppCreateResponse as CustomAppCreateResponse,
+    type CustomAppRetrieveResponse as CustomAppRetrieveResponse,
+    type CustomAppUpdateResponse as CustomAppUpdateResponse,
+    type CustomAppListResponsesPageCursorURL as CustomAppListResponsesPageCursorURL,
+    type CustomAppCreateParams as CustomAppCreateParams,
+    type CustomAppUpdateParams as CustomAppUpdateParams,
+  };
+}

package/src/resources/custom-fields.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Custom fields defined by the company
+ */
 export class CustomFields extends APIResource {
   /**
    * A List of custom fields
@@ -15,7 +18,7 @@ export class CustomFields extends APIResource {
     query: CustomFieldListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<CustomFieldListResponsesPageCursorURL, CustomFieldListResponse> {
-    return this._client.getAPIList('/custom-fields', PageCursorURL<CustomFieldListResponse>, {
+    return this._client.getAPIList('/custom-fields/', PageCursorURL<CustomFieldListResponse>, {
       query,
       ...options,
     });

package/src/resources/custom-objects/custom-objects.ts

@@ -32,6 +32,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Custom objects defined by the company
+ */
 export class CustomObjects extends APIResource {
   fields: FieldsAPI.Fields = new FieldsAPI.Fields(this._client);
   records: RecordsAPI.Records = new RecordsAPI.Records(this._client);

package/src/resources/custom-objects/fields.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Custom object fields defined by the company
+ */
 export class Fields extends APIResource {
   /**
    * A List of custom object fields

package/src/resources/custom-objects/records.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Custom object datarows defined by the company
+ */
 export class Records extends APIResource {
   /**
    * A List of custom object records