@rippling/rippling-sdk 0.2.0-alpha.27 → 0.2.0-alpha.29

package/src/resources/candidates.ts

@@ -18,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

@@ -21,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

@@ -26,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 },
     );
@@ -40,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

@@ -23,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 });
   }
 
   /**
@@ -34,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

@@ -9,13 +9,13 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class CreateAppNotification extends APIResource {
   /**
-   * Create an in-app notification for the specified recipients.
+   * Execute the app notification action.
    */
   create(
     body: CreateAppNotificationCreateParams,
     options?: RequestOptions,
   ): APIPromise<CreateAppNotificationCreateResponse> {
-    return this._client.post('/create-app-notification', { body, ...options });
+    return this._client.post('/create-app-notification/', { body, ...options });
   }
 }
 

package/src/resources/create-gcal-event.ts

@@ -0,0 +1,86 @@
+// 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 CreateGcalEvent extends APIResource {
+  /**
+   * Execute the gcal event action.
+   */
+  create(
+    body: CreateGcalEventCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<CreateGcalEventCreateResponse> {
+    return this._client.post('/create-gcal-event/', { body, ...options });
+  }
+}
+
+export interface CreateGcalEventCreateResponse {
+  /**
+   * Result of the create Google Calendar event action
+   */
+  result: unknown;
+}
+
+export interface CreateGcalEventCreateParams {
+  attendees: Array<string>;
+
+  description: string;
+
+  end_date: string;
+
+  end_time: string;
+
+  organizer: Array<string>;
+
+  /**
+   * An enumeration.
+   */
+  organizer_type: 'SUPERGROUP' | 'WORKFLOW_OWNER';
+
+  start_date: string;
+
+  start_time: string;
+
+  timezone: string;
+
+  title: string;
+
+  all_day_event?: boolean | null;
+
+  guestsCanInviteOthers?: boolean | null;
+
+  guestsCanModify?: boolean | null;
+
+  guestsCanSeeOtherGuests?: boolean | null;
+
+  recurrence_count?: number | null;
+
+  /**
+   * An enumeration.
+   */
+  recurrence_frequency?: 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY' | null;
+
+  recurrence_has_end?: boolean | null;
+
+  /**
+   * An enumeration.
+   */
+  transparency?: 'opaque' | 'transparent' | null;
+
+  /**
+   * An enumeration.
+   */
+  visibility?: 'default' | 'public' | 'private' | null;
+}
+
+export declare namespace CreateGcalEvent {
+  export {
+    type CreateGcalEventCreateResponse as CreateGcalEventCreateResponse,
+    type CreateGcalEventCreateParams as CreateGcalEventCreateParams,
+  };
+}

package/src/resources/custom-apps.ts

@@ -15,21 +15,21 @@ export class CustomApps extends APIResource {
    * - Requires: `API Tier 1`
    */
   list(options?: RequestOptions): PagePromise<CustomAppListResponsesPageCursorURL, CustomAppListResponse> {
-    return this._client.getAPIList('/custom-apps', PageCursorURL<CustomAppListResponse>, options);
+    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 });
+    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);
+    return this._client.get(path`/custom-apps/${id}/`, options);
   }
 
   /**
@@ -40,14 +40,14 @@ export class CustomApps extends APIResource {
     body: CustomAppUpdateParams,
     options?: RequestOptions,
   ): APIPromise<CustomAppUpdateResponse> {
-    return this._client.patch(path`/custom-apps/${id}`, { body, ...options });
+    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}`, {
+    return this._client.delete(path`/custom-apps/${id}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -109,9 +109,34 @@ export namespace CustomAppListResponse {
     api_name?: string;
 
     /**
-     * The ID of the canvas instance backing this page
+     * 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;
   }
 }
 
@@ -168,9 +193,34 @@ export namespace CustomAppCreateResponse {
     api_name?: string;
 
     /**
-     * The ID of the canvas instance backing this page
+     * 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;
   }
 }
 
@@ -230,9 +280,34 @@ export namespace CustomAppRetrieveResponse {
     api_name?: string;
 
     /**
-     * The ID of the canvas instance backing this page
+     * 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;
   }
 }
 
@@ -289,9 +364,34 @@ export namespace CustomAppUpdateResponse {
     api_name?: string;
 
     /**
-     * The ID of the canvas instance backing this page
+     * 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;
   }
 }
 

package/src/resources/custom-fields.ts

@@ -18,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-pages.ts

@@ -15,7 +15,7 @@ export class CustomPages extends APIResource {
    * - Requires: `API Tier 1`
    */
   list(options?: RequestOptions): PagePromise<CustomPageListResponsesPageCursorURL, CustomPageListResponse> {
-    return this._client.getAPIList('/custom-pages', PageCursorURL<CustomPageListResponse>, options);
+    return this._client.getAPIList('/custom-pages/', PageCursorURL<CustomPageListResponse>, options);
   }
 
   /**
@@ -25,14 +25,14 @@ export class CustomPages extends APIResource {
     body: CustomPageCreateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<CustomPageCreateResponse> {
-    return this._client.post('/custom-pages', { body, ...options });
+    return this._client.post('/custom-pages/', { body, ...options });
   }
 
   /**
    * Retrieve a specific CustomPage
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<CustomPageRetrieveResponse> {
-    return this._client.get(path`/custom-pages/${id}`, options);
+    return this._client.get(path`/custom-pages/${id}/`, options);
   }
 
   /**
@@ -43,14 +43,14 @@ export class CustomPages extends APIResource {
     body: CustomPageUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<CustomPageUpdateResponse> {
-    return this._client.patch(path`/custom-pages/${id}`, { body, ...options });
+    return this._client.patch(path`/custom-pages/${id}/`, { body, ...options });
   }
 
   /**
    * Delete a CustomPage
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/custom-pages/${id}`, {
+    return this._client.delete(path`/custom-pages/${id}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -66,29 +66,19 @@ export interface CustomPageListResponse {
   id?: string;
 
   /**
-   * Canvas actions
-   */
-  actions?: Array<unknown>;
-
-  /**
-   * Canvas actions (v2)
-   */
-  canvas_actions?: Array<unknown>;
-
-  /**
-   * The canvas component tree
+   * Record creation date
    */
-  components?: Array<unknown>;
+  created_at?: string;
 
   /**
-   * Record creation date
+   * The ID of the role that created the page
    */
-  created_at?: string;
+  created_by?: string;
 
   /**
-   * Media assets
+   * The ID of the Rippling Function that renders this page
    */
-  media?: unknown;
+  function_id?: string;
 
   /**
    * The display name of the custom page
@@ -101,9 +91,9 @@ export interface CustomPageListResponse {
   updated_at?: string;
 
   /**
-   * Canvas variables
+   * The ID of the role that last modified the page
    */
-  variables?: Array<unknown>;
+  updated_by?: string;
 }
 
 export interface CustomPageCreateResponse {
@@ -113,29 +103,19 @@ export interface CustomPageCreateResponse {
   id?: string;
 
   /**
-   * Canvas actions
-   */
-  actions?: Array<unknown>;
-
-  /**
-   * Canvas actions (v2)
+   * Record creation date
    */
-  canvas_actions?: Array<unknown>;
+  created_at?: string;
 
   /**
-   * The canvas component tree
+   * The ID of the role that created the page
    */
-  components?: Array<unknown>;
+  created_by?: string;
 
   /**
-   * Record creation date
+   * The ID of the Rippling Function that renders this page
    */
-  created_at?: string;
-
-  /**
-   * Media assets
-   */
-  media?: unknown;
+  function_id?: string;
 
   /**
    * The display name of the custom page
@@ -148,9 +128,9 @@ export interface CustomPageCreateResponse {
   updated_at?: string;
 
   /**
-   * Canvas variables
+   * The ID of the role that last modified the page
    */
-  variables?: Array<unknown>;
+  updated_by?: string;
 }
 
 /**
@@ -163,29 +143,19 @@ export interface CustomPageRetrieveResponse extends BusinessPartnersAPI.Meta {
   id?: string;
 
   /**
-   * Canvas actions
-   */
-  actions?: Array<unknown>;
-
-  /**
-   * Canvas actions (v2)
-   */
-  canvas_actions?: Array<unknown>;
-
-  /**
-   * The canvas component tree
+   * Record creation date
    */
-  components?: Array<unknown>;
+  created_at?: string;
 
   /**
-   * Record creation date
+   * The ID of the role that created the page
    */
-  created_at?: string;
+  created_by?: string;
 
   /**
-   * Media assets
+   * The ID of the Rippling Function that renders this page
    */
-  media?: unknown;
+  function_id?: string;
 
   /**
    * The display name of the custom page
@@ -198,9 +168,9 @@ export interface CustomPageRetrieveResponse extends BusinessPartnersAPI.Meta {
   updated_at?: string;
 
   /**
-   * Canvas variables
+   * The ID of the role that last modified the page
    */
-  variables?: Array<unknown>;
+  updated_by?: string;
 }
 
 export interface CustomPageUpdateResponse {
@@ -210,29 +180,19 @@ export interface CustomPageUpdateResponse {
   id?: string;
 
   /**
-   * Canvas actions
-   */
-  actions?: Array<unknown>;
-
-  /**
-   * Canvas actions (v2)
-   */
-  canvas_actions?: Array<unknown>;
-
-  /**
-   * The canvas component tree
+   * Record creation date
    */
-  components?: Array<unknown>;
+  created_at?: string;
 
   /**
-   * Record creation date
+   * The ID of the role that created the page
    */
-  created_at?: string;
+  created_by?: string;
 
   /**
-   * Media assets
+   * The ID of the Rippling Function that renders this page
    */
-  media?: unknown;
+  function_id?: string;
 
   /**
    * The display name of the custom page
@@ -245,12 +205,17 @@ export interface CustomPageUpdateResponse {
   updated_at?: string;
 
   /**
-   * Canvas variables
+   * The ID of the role that last modified the page
    */
-  variables?: Array<unknown>;
+  updated_by?: string;
 }
 
 export interface CustomPageCreateParams {
+  /**
+   * The ID of the Rippling Function that renders this page
+   */
+  function_id?: string;
+
   /**
    * The display name of the custom page
    */
@@ -258,6 +223,11 @@ export interface CustomPageCreateParams {
 }
 
 export interface CustomPageUpdateParams {
+  /**
+   * The ID of the Rippling Function that renders this page
+   */
+  function_id?: string;
+
   /**
    * The display name of the custom page
    */

package/src/resources/custom-settings.ts

@@ -19,7 +19,7 @@ export class CustomSettings extends APIResource {
     query: CustomSettingListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<CustomSettingListResponsesPageCursorURL, CustomSettingListResponse> {
-    return this._client.getAPIList('/custom-settings', PageCursorURL<CustomSettingListResponse>, {
+    return this._client.getAPIList('/custom-settings/', PageCursorURL<CustomSettingListResponse>, {
       query,
       ...options,
     });
@@ -32,14 +32,14 @@ export class CustomSettings extends APIResource {
     body: CustomSettingCreateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<CustomSettingCreateResponse> {
-    return this._client.post('/custom-settings', { body, ...options });
+    return this._client.post('/custom-settings/', { body, ...options });
   }
 
   /**
    * Retrieve a specific Setting
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<CustomSettingRetrieveResponse> {
-    return this._client.get(path`/custom-settings/${id}`, options);
+    return this._client.get(path`/custom-settings/${id}/`, options);
   }
 
   /**
@@ -50,14 +50,14 @@ export class CustomSettings extends APIResource {
     body: CustomSettingUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<CustomSettingUpdateResponse> {
-    return this._client.patch(path`/custom-settings/${id}`, { body, ...options });
+    return this._client.patch(path`/custom-settings/${id}/`, { body, ...options });
   }
 
   /**
    * Delete a Setting
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/custom-settings/${id}`, {
+    return this._client.delete(path`/custom-settings/${id}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });

package/src/resources/delete-custom-object-record.ts

@@ -0,0 +1,40 @@
+// 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 DeleteCustomObjectRecord extends APIResource {
+  /**
+   * Execute the custom object record deletion action.
+   */
+  create(
+    body: DeleteCustomObjectRecordCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<DeleteCustomObjectRecordCreateResponse> {
+    return this._client.post('/delete-custom-object-record/', { body, ...options });
+  }
+}
+
+export interface DeleteCustomObjectRecordCreateResponse {
+  /**
+   * Result of the delete custom object record action
+   */
+  result: unknown;
+}
+
+export interface DeleteCustomObjectRecordCreateParams {
+  customObjectAPIName: string;
+
+  recordID: string;
+}
+
+export declare namespace DeleteCustomObjectRecord {
+  export {
+    type DeleteCustomObjectRecordCreateResponse as DeleteCustomObjectRecordCreateResponse,
+    type DeleteCustomObjectRecordCreateParams as DeleteCustomObjectRecordCreateParams,
+  };
+}