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

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/custom-settings.ts

@@ -0,0 +1,371 @@
+// 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 CustomSettings extends APIResource {
+  /**
+   * A List of Setting
+   *
+   * - Requires: `Functions API`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: CustomSettingListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CustomSettingListResponsesPageCursorURL, CustomSettingListResponse> {
+    return this._client.getAPIList('/custom-settings', PageCursorURL<CustomSettingListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Create a new Setting
+   */
+  create(
+    body: CustomSettingCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomSettingCreateResponse> {
+    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);
+  }
+
+  /**
+   * Updated a specific Setting
+   */
+  update(
+    id: string,
+    body: CustomSettingUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomSettingUpdateResponse> {
+    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}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type CustomSettingListResponsesPageCursorURL = PageCursorURL<CustomSettingListResponse>;
+
+export interface CustomSettingListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The unique api name of the setting
+   */
+  api_name?: string;
+
+  /**
+   * Boolean value of the setting, if it has boolean data type
+   */
+  boolean_value?: boolean;
+
+  /**
+   * Data type of the setting
+   */
+  data_type?: string;
+
+  /**
+   * The display name of setting
+   */
+  display_name?: string;
+
+  /**
+   * Number value of the setting, if it has number data type
+   */
+  number_value?: number;
+
+  /**
+   * Secret value of the setting, if it has secret data type
+   */
+  secret_value?: string;
+
+  /**
+   * String value of the setting, if it has string data type
+   */
+  string_value?: string;
+}
+
+export interface CustomSettingCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The unique api name of the setting
+   */
+  api_name?: string;
+
+  /**
+   * Boolean value of the setting, if it has boolean data type
+   */
+  boolean_value?: boolean;
+
+  /**
+   * Data type of the setting
+   */
+  data_type?: string;
+
+  /**
+   * The display name of setting
+   */
+  display_name?: string;
+
+  /**
+   * Number value of the setting, if it has number data type
+   */
+  number_value?: number;
+
+  /**
+   * Secret value of the setting, if it has secret data type
+   */
+  secret_value?: string;
+
+  /**
+   * String value of the setting, if it has string data type
+   */
+  string_value?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface CustomSettingRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The unique api name of the setting
+   */
+  api_name?: string;
+
+  /**
+   * Boolean value of the setting, if it has boolean data type
+   */
+  boolean_value?: boolean;
+
+  /**
+   * Data type of the setting
+   */
+  data_type?: string;
+
+  /**
+   * The display name of setting
+   */
+  display_name?: string;
+
+  /**
+   * Number value of the setting, if it has number data type
+   */
+  number_value?: number;
+
+  /**
+   * Secret value of the setting, if it has secret data type
+   */
+  secret_value?: string;
+
+  /**
+   * String value of the setting, if it has string data type
+   */
+  string_value?: string;
+}
+
+export interface CustomSettingUpdateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The unique api name of the setting
+   */
+  api_name?: string;
+
+  /**
+   * Boolean value of the setting, if it has boolean data type
+   */
+  boolean_value?: boolean;
+
+  /**
+   * Data type of the setting
+   */
+  data_type?: string;
+
+  /**
+   * The display name of setting
+   */
+  display_name?: string;
+
+  /**
+   * Number value of the setting, if it has number data type
+   */
+  number_value?: number;
+
+  /**
+   * Secret value of the setting, if it has secret data type
+   */
+  secret_value?: string;
+
+  /**
+   * String value of the setting, if it has string data type
+   */
+  string_value?: string;
+}
+
+export interface CustomSettingListParams {
+  cursor?: string;
+
+  order_by?: string;
+}
+
+export interface CustomSettingCreateParams {
+  /**
+   * The unique api name of the setting
+   */
+  api_name?: string;
+
+  /**
+   * Boolean value of the setting, if it has boolean data type
+   */
+  boolean_value?: boolean;
+
+  /**
+   * Data type of the setting
+   */
+  data_type?: string;
+
+  /**
+   * The display name of setting
+   */
+  display_name?: string;
+
+  /**
+   * Number value of the setting, if it has number data type
+   */
+  number_value?: number;
+
+  /**
+   * Secret value of the setting, if it has secret data type
+   */
+  secret_value?: string;
+
+  /**
+   * String value of the setting, if it has string data type
+   */
+  string_value?: string;
+}
+
+export interface CustomSettingUpdateParams {
+  /**
+   * The unique api name of the setting
+   */
+  api_name?: string;
+
+  /**
+   * Boolean value of the setting, if it has boolean data type
+   */
+  boolean_value?: boolean;
+
+  /**
+   * Data type of the setting
+   */
+  data_type?: string;
+
+  /**
+   * The display name of setting
+   */
+  display_name?: string;
+
+  /**
+   * Number value of the setting, if it has number data type
+   */
+  number_value?: number;
+
+  /**
+   * Secret value of the setting, if it has secret data type
+   */
+  secret_value?: string;
+
+  /**
+   * String value of the setting, if it has string data type
+   */
+  string_value?: string;
+}
+
+export declare namespace CustomSettings {
+  export {
+    type CustomSettingListResponse as CustomSettingListResponse,
+    type CustomSettingCreateResponse as CustomSettingCreateResponse,
+    type CustomSettingRetrieveResponse as CustomSettingRetrieveResponse,
+    type CustomSettingUpdateResponse as CustomSettingUpdateResponse,
+    type CustomSettingListResponsesPageCursorURL as CustomSettingListResponsesPageCursorURL,
+    type CustomSettingListParams as CustomSettingListParams,
+    type CustomSettingCreateParams as CustomSettingCreateParams,
+    type CustomSettingUpdateParams as CustomSettingUpdateParams,
+  };
+}

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
@@ -22,6 +25,13 @@ export class Departments extends APIResource {
     return this._client.getAPIList('/departments', PageCursorURL<Department>, { query, ...options });
   }
 
+  /**
+   * Create a new department
+   */
+  create(body: DepartmentCreateParams, options?: RequestOptions): APIPromise<Department> {
+    return this._client.post('/departments', { body, ...options });
+  }
+
   /**
    * Retrieve a specific department
    */
@@ -32,6 +42,13 @@ export class Departments extends APIResource {
   ): APIPromise<DepartmentRetrieveResponse> {
     return this._client.get(path`/departments/${id}`, { query, ...options });
   }
+
+  /**
+   * Updated a specific department
+   */
+  update(id: string, body: DepartmentUpdateParams, options?: RequestOptions): APIPromise<Department> {
+    return this._client.patch(path`/departments/${id}`, { body, ...options });
+  }
 }
 
 export type DepartmentsPageCursorURL = PageCursorURL<Department>;
@@ -102,16 +119,52 @@ export interface DepartmentListParams {
   order_by?: string;
 }
 
+export interface DepartmentCreateParams {
+  /**
+   * The name of the department.
+   */
+  name: string;
+
+  /**
+   * The parent department.
+   */
+  parent_id?: string;
+
+  /**
+   * Reference code of the department.
+   */
+  reference_code?: string;
+}
+
 export interface DepartmentRetrieveParams {
   expand?: string;
 }
 
+export interface DepartmentUpdateParams {
+  /**
+   * The name of the department.
+   */
+  name: string;
+
+  /**
+   * The parent department.
+   */
+  parent_id?: string;
+
+  /**
+   * Reference code of the department.
+   */
+  reference_code?: string;
+}
+
 export declare namespace Departments {
   export {
     type Department as Department,
     type DepartmentRetrieveResponse as DepartmentRetrieveResponse,
     type DepartmentsPageCursorURL as DepartmentsPageCursorURL,
     type DepartmentListParams as DepartmentListParams,
+    type DepartmentCreateParams as DepartmentCreateParams,
     type DepartmentRetrieveParams as DepartmentRetrieveParams,
+    type DepartmentUpdateParams as DepartmentUpdateParams,
   };
 }