@rippling/rippling-sdk 0.2.0-alpha.21 → 0.2.0-alpha.23

package/src/resources/business-partners.ts

@@ -11,24 +11,6 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 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 });
-  }
-
-  /**
-   * Retrieve a specific business partner
-   */
-  retrieve(
-    id: string,
-    query: BusinessPartnerRetrieveParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<BusinessPartnerRetrieveResponse> {
-    return this._client.get(path`/business-partners/${id}`, { query, ...options });
-  }
-
   /**
    * A List of business partners
    *
@@ -47,6 +29,24 @@ 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 });
+  }
+
+  /**
+   * Retrieve a specific business partner
+   */
+  retrieve(
+    id: string,
+    query: BusinessPartnerRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BusinessPartnerRetrieveResponse> {
+    return this._client.get(path`/business-partners/${id}`, { query, ...options });
+  }
+
   /**
    * Delete a business partner
    */
@@ -153,6 +153,14 @@ export namespace Meta {
  */
 export interface BusinessPartnerRetrieveResponse extends Meta, BusinessPartner {}
 
+export interface BusinessPartnerListParams {
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
 export interface BusinessPartnerCreateParams {
   /**
    * Identifier of business partner group the business parter is a part of
@@ -169,22 +177,14 @@ export interface BusinessPartnerRetrieveParams {
   expand?: string;
 }
 
-export interface BusinessPartnerListParams {
-  expand?: string;
-
-  filter?: string;
-
-  order_by?: string;
-}
-
 export declare namespace BusinessPartners {
   export {
     type BusinessPartner as BusinessPartner,
     type Meta as Meta,
     type BusinessPartnerRetrieveResponse as BusinessPartnerRetrieveResponse,
     type BusinessPartnersPageCursorURL as BusinessPartnersPageCursorURL,
+    type BusinessPartnerListParams as BusinessPartnerListParams,
     type BusinessPartnerCreateParams as BusinessPartnerCreateParams,
     type BusinessPartnerRetrieveParams as BusinessPartnerRetrieveParams,
-    type BusinessPartnerListParams as BusinessPartnerListParams,
   };
 }

package/src/resources/compensations.ts

@@ -9,17 +9,6 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class Compensations extends APIResource {
-  /**
-   * Retrieves the Compensation for the Worker with the ID provided in the URL path.
-   */
-  retrieve(
-    id: string,
-    query: CompensationRetrieveParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<CompensationRetrieveResponse> {
-    return this._client.get(path`/compensations/${id}`, { query, ...options });
-  }
-
   /**
    * A List of compensations
    *
@@ -33,6 +22,17 @@ export class Compensations extends APIResource {
   ): PagePromise<CompensationsPageCursorURL, Compensation> {
     return this._client.getAPIList('/compensations', PageCursorURL<Compensation>, { query, ...options });
   }
+
+  /**
+   * Retrieves the Compensation for the Worker with the ID provided in the URL path.
+   */
+  retrieve(
+    id: string,
+    query: CompensationRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CompensationRetrieveResponse> {
+    return this._client.get(path`/compensations/${id}`, { query, ...options });
+  }
 }
 
 export type CompensationsPageCursorURL = PageCursorURL<Compensation>;
@@ -292,22 +292,22 @@ export namespace Compensation {
  */
 export interface CompensationRetrieveResponse extends BusinessPartnersAPI.Meta, Compensation {}
 
-export interface CompensationRetrieveParams {
-  expand?: string;
-}
-
 export interface CompensationListParams {
   expand?: string;
 
   order_by?: string;
 }
 
+export interface CompensationRetrieveParams {
+  expand?: string;
+}
+
 export declare namespace Compensations {
   export {
     type Compensation as Compensation,
     type CompensationRetrieveResponse as CompensationRetrieveResponse,
     type CompensationsPageCursorURL as CompensationsPageCursorURL,
-    type CompensationRetrieveParams as CompensationRetrieveParams,
     type CompensationListParams as CompensationListParams,
+    type CompensationRetrieveParams as CompensationRetrieveParams,
   };
 }

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

@@ -36,6 +36,15 @@ export class CustomObjects extends APIResource {
   fields: FieldsAPI.Fields = new FieldsAPI.Fields(this._client);
   records: RecordsAPI.Records = new RecordsAPI.Records(this._client);
 
+  /**
+   * A List of custom objects
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(options?: RequestOptions): PagePromise<CustomObjectsPageCursorURL, CustomObject> {
+    return this._client.getAPIList('/custom-objects/', PageCursorURL<CustomObject>, options);
+  }
+
   /**
    * Create a new custom object
    */
@@ -64,15 +73,6 @@ export class CustomObjects extends APIResource {
     return this._client.patch(path`/custom-objects/${customObjectAPIName}/`, { body, ...options });
   }
 
-  /**
-   * A List of custom objects
-   *
-   * - Requires: `API Tier 1`
-   */
-  list(options?: RequestOptions): PagePromise<CustomObjectsPageCursorURL, CustomObject> {
-    return this._client.getAPIList('/custom-objects/', PageCursorURL<CustomObject>, options);
-  }
-
   /**
    * Delete a custom object
    */
@@ -191,16 +191,16 @@ export declare namespace CustomObjects {
     Records as Records,
     type CustomObjectDataRow as CustomObjectDataRow,
     type RecordCreateResponse as RecordCreateResponse,
+    type RecordQueryResponse as RecordQueryResponse,
     type RecordUpdateResponse as RecordUpdateResponse,
     type RecordBulkCreateResponse as RecordBulkCreateResponse,
     type RecordBulkUpdateResponse as RecordBulkUpdateResponse,
-    type RecordQueryResponse as RecordQueryResponse,
     type CustomObjectDataRowsPageCursorURL as CustomObjectDataRowsPageCursorURL,
     type RecordCreateParams as RecordCreateParams,
+    type RecordQueryParams as RecordQueryParams,
     type RecordUpdateParams as RecordUpdateParams,
     type RecordBulkCreateParams as RecordBulkCreateParams,
-    type RecordBulkDeleteParams as RecordBulkDeleteParams,
     type RecordBulkUpdateParams as RecordBulkUpdateParams,
-    type RecordQueryParams as RecordQueryParams,
+    type RecordBulkDeleteParams as RecordBulkDeleteParams,
   };
 }

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

@@ -8,6 +8,22 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class Fields extends APIResource {
+  /**
+   * A List of custom object fields
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(
+    customObjectAPIName: string,
+    options?: RequestOptions,
+  ): PagePromise<CustomObjectFieldsPageCursorURL, CustomObjectField> {
+    return this._client.getAPIList(
+      path`/custom-objects/${customObjectAPIName}/fields/`,
+      PageCursorURL<CustomObjectField>,
+      options,
+    );
+  }
+
   /**
    * Create a new custom object field
    */
@@ -45,22 +61,6 @@ export class Fields extends APIResource {
     });
   }
 
-  /**
-   * A List of custom object fields
-   *
-   * - Requires: `API Tier 1`
-   */
-  list(
-    customObjectAPIName: string,
-    options?: RequestOptions,
-  ): PagePromise<CustomObjectFieldsPageCursorURL, CustomObjectField> {
-    return this._client.getAPIList(
-      path`/custom-objects/${customObjectAPIName}/fields/`,
-      PageCursorURL<CustomObjectField>,
-      options,
-    );
-  }
-
   /**
    * Delete a custom object field
    */

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

@@ -18,15 +18,15 @@ export {
   Records,
   type CustomObjectDataRow,
   type RecordCreateResponse,
+  type RecordQueryResponse,
   type RecordUpdateResponse,
   type RecordBulkCreateResponse,
   type RecordBulkUpdateResponse,
-  type RecordQueryResponse,
   type RecordCreateParams,
+  type RecordQueryParams,
   type RecordUpdateParams,
   type RecordBulkCreateParams,
-  type RecordBulkDeleteParams,
   type RecordBulkUpdateParams,
-  type RecordQueryParams,
+  type RecordBulkDeleteParams,
   type CustomObjectDataRowsPageCursorURL,
 } from './records';

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

@@ -8,6 +8,22 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class Records extends APIResource {
+  /**
+   * A List of custom object records
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(
+    customObjectAPIName: string,
+    options?: RequestOptions,
+  ): PagePromise<CustomObjectDataRowsPageCursorURL, CustomObjectDataRow> {
+    return this._client.getAPIList(
+      path`/custom-objects/${customObjectAPIName}/records/`,
+      PageCursorURL<CustomObjectDataRow>,
+      options,
+    );
+  }
+
   /**
    * Create a new custom object record
    */
@@ -19,6 +35,20 @@ export class Records extends APIResource {
     return this._client.post(path`/custom-objects/${customObjectAPIName}/records/`, { body, ...options });
   }
 
+  /**
+   * A List of custom object records filtered by querying
+   */
+  query(
+    customObjectAPIName: string,
+    body: RecordQueryParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RecordQueryResponse> {
+    return this._client.post(path`/custom-objects/${customObjectAPIName}/records/query/`, {
+      body,
+      ...options,
+    });
+  }
+
   /**
    * Retrieve a specific custom object record
    */
@@ -45,22 +75,6 @@ export class Records extends APIResource {
     });
   }
 
-  /**
-   * A List of custom object records
-   *
-   * - Requires: `API Tier 1`
-   */
-  list(
-    customObjectAPIName: string,
-    options?: RequestOptions,
-  ): PagePromise<CustomObjectDataRowsPageCursorURL, CustomObjectDataRow> {
-    return this._client.getAPIList(
-      path`/custom-objects/${customObjectAPIName}/records/`,
-      PageCursorURL<CustomObjectDataRow>,
-      options,
-    );
-  }
-
   /**
    * Delete a custom object record
    */
@@ -72,31 +86,30 @@ export class Records extends APIResource {
   }
 
   /**
-   * bulk create new custom object records
+   * Retrieve a specific custom object record by its external_id
    */
-  bulkCreate(
+  retrieveByExternalID(
     customObjectAPIName: string,
-    body: RecordBulkCreateParams | null | undefined = {},
+    externalID: string,
     options?: RequestOptions,
-  ): APIPromise<RecordBulkCreateResponse> {
-    return this._client.post(path`/custom-objects/${customObjectAPIName}/records/bulk/`, {
-      body,
-      ...options,
-    });
+  ): APIPromise<CustomObjectDataRow> {
+    return this._client.get(
+      path`/custom-objects/${customObjectAPIName}/records/external_id/${externalID}/`,
+      options,
+    );
   }
 
   /**
-   * Bulk Delete custom object records
+   * bulk create new custom object records
    */
-  bulkDelete(
+  bulkCreate(
     customObjectAPIName: string,
-    body: RecordBulkDeleteParams | null | undefined = {},
+    body: RecordBulkCreateParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<void> {
-    return this._client.post(path`/custom-objects/${customObjectAPIName}/records/bulk-delete/`, {
+  ): APIPromise<RecordBulkCreateResponse> {
+    return this._client.post(path`/custom-objects/${customObjectAPIName}/records/bulk/`, {
       body,
       ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
@@ -115,32 +128,19 @@ export class Records extends APIResource {
   }
 
   /**
-   * A List of custom object records filtered by querying
+   * Bulk Delete custom object records
    */
-  query(
+  bulkDelete(
     customObjectAPIName: string,
-    body: RecordQueryParams | null | undefined = {},
+    body: RecordBulkDeleteParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<RecordQueryResponse> {
-    return this._client.post(path`/custom-objects/${customObjectAPIName}/records/query/`, {
+  ): APIPromise<void> {
+    return this._client.post(path`/custom-objects/${customObjectAPIName}/records/bulk-delete/`, {
       body,
       ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
-
-  /**
-   * Retrieve a specific custom object record by its external_id
-   */
-  retrieveByExternalID(
-    customObjectAPIName: string,
-    externalID: string,
-    options?: RequestOptions,
-  ): APIPromise<CustomObjectDataRow> {
-    return this._client.get(
-      path`/custom-objects/${customObjectAPIName}/records/external_id/${externalID}/`,
-      options,
-    );
-  }
 }
 
 export type CustomObjectDataRowsPageCursorURL = PageCursorURL<CustomObjectDataRow>;
@@ -212,6 +212,12 @@ export interface RecordCreateResponse {
   data?: CustomObjectDataRow;
 }
 
+export interface RecordQueryResponse {
+  cursor?: string;
+
+  results?: Array<CustomObjectDataRow>;
+}
+
 export interface RecordUpdateResponse {
   data?: CustomObjectDataRow;
 }
@@ -224,13 +230,15 @@ export interface RecordBulkUpdateResponse {
   data?: Array<CustomObjectDataRow>;
 }
 
-export interface RecordQueryResponse {
+export type RecordCreateParams = { [key: string]: unknown };
+
+export interface RecordQueryParams {
   cursor?: string;
 
-  results?: Array<CustomObjectDataRow>;
-}
+  limit?: number;
 
-export type RecordCreateParams = { [key: string]: unknown };
+  query?: string;
+}
 
 export type RecordUpdateParams = { [key: string]: unknown };
 
@@ -240,43 +248,35 @@ export interface RecordBulkCreateParams {
   rows_to_write?: Array<{ [key: string]: unknown }>;
 }
 
-export interface RecordBulkDeleteParams {
-  all_or_nothing?: boolean;
-
-  /**
-   * a list of ids, e.g. [id_1, id_2].
-   */
-  rows_to_delete?: Array<string>;
-}
-
 export interface RecordBulkUpdateParams {
   all_or_nothing?: boolean;
 
   rows_to_update?: Array<{ [key: string]: unknown }>;
 }
 
-export interface RecordQueryParams {
-  cursor?: string;
-
-  limit?: number;
+export interface RecordBulkDeleteParams {
+  all_or_nothing?: boolean;
 
-  query?: string;
+  /**
+   * a list of ids, e.g. [id_1, id_2].
+   */
+  rows_to_delete?: Array<string>;
 }
 
 export declare namespace Records {
   export {
     type CustomObjectDataRow as CustomObjectDataRow,
     type RecordCreateResponse as RecordCreateResponse,
+    type RecordQueryResponse as RecordQueryResponse,
     type RecordUpdateResponse as RecordUpdateResponse,
     type RecordBulkCreateResponse as RecordBulkCreateResponse,
     type RecordBulkUpdateResponse as RecordBulkUpdateResponse,
-    type RecordQueryResponse as RecordQueryResponse,
     type CustomObjectDataRowsPageCursorURL as CustomObjectDataRowsPageCursorURL,
     type RecordCreateParams as RecordCreateParams,
+    type RecordQueryParams as RecordQueryParams,
     type RecordUpdateParams as RecordUpdateParams,
     type RecordBulkCreateParams as RecordBulkCreateParams,
-    type RecordBulkDeleteParams as RecordBulkDeleteParams,
     type RecordBulkUpdateParams as RecordBulkUpdateParams,
-    type RecordQueryParams as RecordQueryParams,
+    type RecordBulkDeleteParams as RecordBulkDeleteParams,
   };
 }

package/src/resources/departments.ts

@@ -8,17 +8,6 @@ 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
    *
@@ -32,6 +21,17 @@ export class Departments extends APIResource {
   ): PagePromise<DepartmentsPageCursorURL, Department> {
     return this._client.getAPIList('/departments', PageCursorURL<Department>, { query, ...options });
   }
+
+  /**
+   * Retrieve a specific department
+   */
+  retrieve(
+    id: string,
+    query: DepartmentRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DepartmentRetrieveResponse> {
+    return this._client.get(path`/departments/${id}`, { query, ...options });
+  }
 }
 
 export type DepartmentsPageCursorURL = PageCursorURL<Department>;
@@ -94,22 +94,22 @@ export interface Department {
  */
 export interface DepartmentRetrieveResponse extends BusinessPartnersAPI.Meta, Department {}
 
-export interface DepartmentRetrieveParams {
-  expand?: string;
-}
-
 export interface DepartmentListParams {
   expand?: string;
 
   order_by?: string;
 }
 
+export interface DepartmentRetrieveParams {
+  expand?: 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,
+    type DepartmentRetrieveParams as DepartmentRetrieveParams,
   };
 }