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

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,342 @@
+// 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_instance_id?: 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_instance_id?: 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_instance_id?: 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_instance_id?: 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

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

package/src/resources/custom-pages.ts

@@ -0,0 +1,277 @@
+// 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 CustomPages extends APIResource {
+  /**
+   * A List of CustomPage
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(options?: RequestOptions): PagePromise<CustomPageListResponsesPageCursorURL, CustomPageListResponse> {
+    return this._client.getAPIList('/custom-pages', PageCursorURL<CustomPageListResponse>, options);
+  }
+
+  /**
+   * Create a new CustomPage
+   */
+  create(
+    body: CustomPageCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomPageCreateResponse> {
+    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);
+  }
+
+  /**
+   * Updated a specific CustomPage
+   */
+  update(
+    id: string,
+    body: CustomPageUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomPageUpdateResponse> {
+    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}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type CustomPageListResponsesPageCursorURL = PageCursorURL<CustomPageListResponse>;
+
+export interface CustomPageListResponse {
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Canvas actions
+   */
+  actions?: Array<unknown>;
+
+  /**
+   * Canvas actions (v2)
+   */
+  canvas_actions?: Array<unknown>;
+
+  /**
+   * The canvas component tree
+   */
+  components?: Array<unknown>;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * Media assets
+   */
+  media?: unknown;
+
+  /**
+   * The display name of the custom page
+   */
+  name?: string;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+
+  /**
+   * Canvas variables
+   */
+  variables?: Array<unknown>;
+}
+
+export interface CustomPageCreateResponse {
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Canvas actions
+   */
+  actions?: Array<unknown>;
+
+  /**
+   * Canvas actions (v2)
+   */
+  canvas_actions?: Array<unknown>;
+
+  /**
+   * The canvas component tree
+   */
+  components?: Array<unknown>;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * Media assets
+   */
+  media?: unknown;
+
+  /**
+   * The display name of the custom page
+   */
+  name?: string;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+
+  /**
+   * Canvas variables
+   */
+  variables?: Array<unknown>;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface CustomPageRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Canvas actions
+   */
+  actions?: Array<unknown>;
+
+  /**
+   * Canvas actions (v2)
+   */
+  canvas_actions?: Array<unknown>;
+
+  /**
+   * The canvas component tree
+   */
+  components?: Array<unknown>;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * Media assets
+   */
+  media?: unknown;
+
+  /**
+   * The display name of the custom page
+   */
+  name?: string;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+
+  /**
+   * Canvas variables
+   */
+  variables?: Array<unknown>;
+}
+
+export interface CustomPageUpdateResponse {
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Canvas actions
+   */
+  actions?: Array<unknown>;
+
+  /**
+   * Canvas actions (v2)
+   */
+  canvas_actions?: Array<unknown>;
+
+  /**
+   * The canvas component tree
+   */
+  components?: Array<unknown>;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * Media assets
+   */
+  media?: unknown;
+
+  /**
+   * The display name of the custom page
+   */
+  name?: string;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+
+  /**
+   * Canvas variables
+   */
+  variables?: Array<unknown>;
+}
+
+export interface CustomPageCreateParams {
+  /**
+   * The display name of the custom page
+   */
+  name?: string;
+}
+
+export interface CustomPageUpdateParams {
+  /**
+   * The display name of the custom page
+   */
+  name?: string;
+}
+
+export declare namespace CustomPages {
+  export {
+    type CustomPageListResponse as CustomPageListResponse,
+    type CustomPageCreateResponse as CustomPageCreateResponse,
+    type CustomPageRetrieveResponse as CustomPageRetrieveResponse,
+    type CustomPageUpdateResponse as CustomPageUpdateResponse,
+    type CustomPageListResponsesPageCursorURL as CustomPageListResponsesPageCursorURL,
+    type CustomPageCreateParams as CustomPageCreateParams,
+    type CustomPageUpdateParams as CustomPageUpdateParams,
+  };
+}

package/src/resources/departments.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Departments used by the company
+ */
 export class Departments extends APIResource {
   /**
    * A List of departments