@rippling/rippling-sdk 0.2.0-alpha.36 → 0.2.0-alpha.37

package/resources/payroll-runs.js

@@ -1,32 +1,6 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PayrollRuns = void 0;
-const resource_1 = require("../core/resource.js");
-const pagination_1 = require("../core/pagination.js");
-const path_1 = require("../internal/utils/path.js");
-/**
- * Payroll runs for the company
- */
-class PayrollRuns extends resource_1.APIResource {
-    /**
-     * A list of payroll-runs.
-     *
-     * - Requires: `Payroll API`
-     * - Sortable fields: `check_date`
-     */
-    list(query = {}, options) {
-        return this._client.getAPIList('/payroll-runs/', (pagination_1.PageCursorURL), {
-            query,
-            ...options,
-        });
-    }
-    /**
-     * Retrieve a specific payroll-run
-     */
-    retrieve(id, options) {
-        return this._client.get((0, path_1.path) `/payroll-runs/${id}/`, options);
-    }
-}
-exports.PayrollRuns = PayrollRuns;
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./payroll-runs/index.js"), exports);
 //# sourceMappingURL=payroll-runs.js.map

package/resources/payroll-runs.js.map

@@ -1 +1 @@
-{"version":3,"file":"payroll-runs.js","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAgE;AAEhE,oDAA8C;AAE9C;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;OAKG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,0BAAqC,CAAA,EAAE;YACtF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AAvBD,kCAuBC"}
+{"version":3,"file":"payroll-runs.js","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kEAAqC"}

package/resources/payroll-runs.mjs

@@ -1,28 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../core/resource.mjs";
-import { PageCursorURL } from "../core/pagination.mjs";
-import { path } from "../internal/utils/path.mjs";
-/**
- * Payroll runs for the company
- */
-export class PayrollRuns extends APIResource {
-    /**
-     * A list of payroll-runs.
-     *
-     * - Requires: `Payroll API`
-     * - Sortable fields: `check_date`
-     */
-    list(query = {}, options) {
-        return this._client.getAPIList('/payroll-runs/', (PageCursorURL), {
-            query,
-            ...options,
-        });
-    }
-    /**
-     * Retrieve a specific payroll-run
-     */
-    retrieve(id, options) {
-        return this._client.get(path `/payroll-runs/${id}/`, options);
-    }
-}
+export * from "./payroll-runs/index.mjs";
 //# sourceMappingURL=payroll-runs.mjs.map

package/resources/payroll-runs.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"payroll-runs.mjs","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,aAAa,EAAe;OAE9B,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;OAKG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,aAAqC,CAAA,EAAE;YACtF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF"}
+{"version":3,"file":"payroll-runs.mjs","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":"AAAA,sFAAsF"}

package/src/client.ts

@@ -51,6 +51,13 @@ import {
   Candidates,
 } from './resources/candidates';
 import { Companies, CompaniesPageCursorURL, Company, CompanyListParams } from './resources/companies';
+import {
+  CompanyLegalEntities,
+  CompanyLegalEntityListParams,
+  CompanyLegalEntityListResponse,
+  CompanyLegalEntityListResponsesPageCursorURL,
+  CompanyLegalEntityRetrieveResponse,
+} from './resources/company-legal-entities';
 import {
   CompanyLegalEntityWorkerListParams,
   CompanyLegalEntityWorkerListResponse,
@@ -305,13 +312,6 @@ import {
   ObjectCategoryCreateParams,
   ObjectCategoryUpdateParams,
 } from './resources/object-categories';
-import {
-  PayrollRunListParams,
-  PayrollRunListResponse,
-  PayrollRunListResponsesPageCursorURL,
-  PayrollRunRetrieveResponse,
-  PayrollRuns,
-} from './resources/payroll-runs';
 import {
   PlatformCapabilities,
   PlatformCapabilityListResponse,
@@ -478,6 +478,13 @@ import {
   MetadataListResponse,
   MetadataListResponsesPageCursorURL,
 } from './resources/metadata/metadata';
+import {
+  PayrollRunListParams,
+  PayrollRunListResponse,
+  PayrollRunListResponsesPageCursorURL,
+  PayrollRunRetrieveResponse,
+  PayrollRuns,
+} from './resources/payroll-runs/payroll-runs';
 import { ReportRetrieveResponse, Reports } from './resources/reports/reports';
 import {
   Supergroup,
@@ -1351,6 +1358,10 @@ export class RipplingSDK {
    * An application by a candidate to a specific job requisition
    */
   candidateApplications: API.CandidateApplications = new API.CandidateApplications(this);
+  /**
+   * Legal entities registered by the company
+   */
+  companyLegalEntities: API.CompanyLegalEntities = new API.CompanyLegalEntities(this);
   /**
    * Workers who work or have worked at the company
    */
@@ -1492,6 +1503,7 @@ RipplingSDK.JobAssignments = JobAssignments;
 RipplingSDK.JobPayRateExceptions = JobPayRateExceptions;
 RipplingSDK.Candidates = Candidates;
 RipplingSDK.CandidateApplications = CandidateApplications;
+RipplingSDK.CompanyLegalEntities = CompanyLegalEntities;
 RipplingSDK.CompanyLegalEntityWorkers = CompanyLegalEntityWorkers;
 RipplingSDK.CompensationBandsDetails = CompensationBandsDetails;
 RipplingSDK.CustomApps = CustomApps;
@@ -1835,6 +1847,14 @@ export declare namespace RipplingSDK {
     type CandidateApplicationListParams as CandidateApplicationListParams,
   };
 
+  export {
+    CompanyLegalEntities as CompanyLegalEntities,
+    type CompanyLegalEntityListResponse as CompanyLegalEntityListResponse,
+    type CompanyLegalEntityRetrieveResponse as CompanyLegalEntityRetrieveResponse,
+    type CompanyLegalEntityListResponsesPageCursorURL as CompanyLegalEntityListResponsesPageCursorURL,
+    type CompanyLegalEntityListParams as CompanyLegalEntityListParams,
+  };
+
   export {
     CompanyLegalEntityWorkers as CompanyLegalEntityWorkers,
     type CompanyLegalEntityWorkerListResponse as CompanyLegalEntityWorkerListResponse,

package/src/internal/utils/log.ts

@@ -107,6 +107,8 @@ export const formatRequestDetails = (details: {
           name,
           (
             name.toLowerCase() === 'authorization' ||
+            name.toLowerCase() === 'api-key' ||
+            name.toLowerCase() === 'x-api-key' ||
             name.toLowerCase() === 'cookie' ||
             name.toLowerCase() === 'set-cookie'
           ) ?

package/src/lib/manifest/custom-object-field-section.ts

@@ -70,6 +70,13 @@ export class CustomObjectFieldSection {
     return this._sectionId;
   }
 
+  /**
+   * Returns the display name of this field section.
+   */
+  getName(): string {
+    return this._name;
+  }
+
   /**
    * Returns the api_name of the custom object this section belongs to.
    */

package/src/lib/manifest/custom-object-page-layout.ts

@@ -1,4 +1,5 @@
 import { generateId } from './_helpers';
+import { CustomObjectFieldSection } from './custom-object-field-section';
 import type { CustomObject } from './custom-object';
 import type { Field } from './field';
 
@@ -65,10 +66,8 @@ export interface HeaderEdits {
 // tab_edits — TabEditsDTO + section/tab DTOs
 // ---------------------------------------------------------------------------
 
-/** One field entry inside a `fields_section`. */
-export interface SectionField {
-  /** RQL name of the field to display. Required. */
-  fieldRqlName: string;
+/** Options for one field entry inside a `fields_section`. */
+export interface SectionFieldOptions {
   /** Hide this field from view. Optional. */
   hidden?: boolean;
   /** Allow inline editing of this field. Optional. */
@@ -77,13 +76,24 @@ export interface SectionField {
   movementOption?: 'tab' | 'free';
 }
 
+/** A typed field entry inside a `fields_section`. */
+export interface SectionFieldRef extends SectionFieldOptions {
+  /** Field to display. Required. */
+  field: Field;
+}
+
+/** One field entry inside a `fields_section`. */
+export type SectionField = Field | SectionFieldRef;
+
 /** A standard field-grid section inside a tab. */
 export interface FieldsSection {
   type: 'fields_section';
-  /** Stable key for this section. Required. */
-  key: string;
-  /** Display name of the section. Required. */
-  name: string;
+  /** Field section metadata for the fields displayed in this layout section. Required. */
+  section: CustomObjectFieldSection;
+  /** Stable layout key for this section. Optional. Defaults to the field section id. */
+  key?: string;
+  /** Display name of the layout section. Optional. Defaults to the field section name. */
+  name?: string;
   /** Fields to display in this section. Required. */
   fields: SectionField[];
 }
@@ -255,6 +265,194 @@ export interface CustomObjectPageLayoutProps {
   blueprintKey?: string;
 }
 
+interface SerializedSectionField extends SectionFieldOptions {
+  fieldRqlName: string;
+}
+
+interface SerializedFieldsSection {
+  type: 'fields_section';
+  key: string;
+  name: string;
+  fields: SerializedSectionField[];
+}
+
+interface SerializedTabWithSections {
+  type: 'tab_with_sections';
+  key: string;
+  name: string;
+  sections: SerializedFieldsSection[];
+}
+
+type SerializedPageLayoutTab = SerializedTabWithSections | CustomTab;
+
+interface SerializedSystemSectionEdit extends Omit<SystemSectionEdit, 'newFields'> {
+  newFields?: SerializedSectionField[];
+}
+
+interface SerializedSystemTabEdit extends Omit<SystemTabEdit, 'newSections' | 'systemSectionEdits'> {
+  newSections?: SerializedFieldsSection[];
+  systemSectionEdits?: Record<string, SerializedSystemSectionEdit>;
+}
+
+interface SerializedTabEdits extends Omit<TabEdits, 'newTabs' | 'systemTabEdits'> {
+  newTabs?: SerializedPageLayoutTab[];
+  systemTabEdits?: Record<string, SerializedSystemTabEdit>;
+}
+
+function isField(value: unknown): value is Field {
+  const candidate = value as {
+    getApiName?: unknown;
+    getCustomObjectApiName?: unknown;
+    getSectionId?: unknown;
+    _assignSection?: unknown;
+  } | null;
+  return (
+    candidate != null &&
+    typeof candidate.getApiName === 'function' &&
+    typeof candidate.getCustomObjectApiName === 'function' &&
+    typeof candidate.getSectionId === 'function' &&
+    typeof candidate._assignSection === 'function'
+  );
+}
+
+function isFieldRef(value: SectionField): value is SectionFieldRef {
+  const candidate = value as { field?: unknown } | null;
+  return candidate != null && typeof candidate === 'object' && isField(candidate.field);
+}
+
+function assertSameObject(customObject: CustomObject, field: Field, sectionKey: string): void {
+  if (field.getCustomObjectApiName() !== customObject.getApiName()) {
+    throw new Error(
+      `CustomObjectPageLayout fields_section "${sectionKey}" references field "${field.getApiName()}" ` +
+        `from "${field.getCustomObjectApiName()}", but the layout belongs to "${customObject.getApiName()}".`,
+    );
+  }
+}
+
+function assertSectionBelongsTo(customObject: CustomObject, section: CustomObjectFieldSection): void {
+  if (section.getModelApiName() !== customObject.getApiName()) {
+    throw new Error(
+      `CustomObjectPageLayout section "${section.getSectionId()}" belongs to "${section.getModelApiName()}", ` +
+        `but the layout belongs to "${customObject.getApiName()}".`,
+    );
+  }
+}
+
+function toSerializedSectionField(
+  fieldRqlName: string,
+  options: SectionFieldOptions = {},
+): SerializedSectionField {
+  const normalized: SerializedSectionField = { fieldRqlName };
+  if (options.hidden != null) normalized.hidden = options.hidden;
+  if (options.editable != null) normalized.editable = options.editable;
+  if (options.movementOption != null) normalized.movementOption = options.movementOption;
+  return normalized;
+}
+
+function normalizeSectionField(
+  customObject: CustomObject,
+  section: CustomObjectFieldSection | string,
+  sectionKey: string,
+  entry: SectionField,
+): SerializedSectionField {
+  if (isField(entry)) {
+    assertSameObject(customObject, entry, sectionKey);
+    entry._assignSection(section);
+    return toSerializedSectionField(entry.getApiName());
+  }
+
+  if (isFieldRef(entry)) {
+    assertSameObject(customObject, entry.field, sectionKey);
+    entry.field._assignSection(section);
+    return toSerializedSectionField(entry.field.getApiName(), entry);
+  }
+
+  throw new Error(
+    `CustomObjectPageLayout fields_section "${sectionKey}" has an invalid field entry; ` +
+      'pass a Field instance or { field }.',
+  );
+}
+
+function normalizeFieldsSection(
+  customObject: CustomObject,
+  input: PageLayoutSection,
+): SerializedFieldsSection {
+  assertSectionBelongsTo(customObject, input.section);
+  const key = input.key ?? input.section.getSectionId();
+  const name = input.name ?? input.section.getName();
+  return {
+    key,
+    name,
+    type: 'fields_section',
+    fields: input.fields.map((field) => normalizeSectionField(customObject, input.section, key, field)),
+  };
+}
+
+function normalizeTab(customObject: CustomObject, tab: PageLayoutTab): SerializedPageLayoutTab {
+  if (tab.type === 'custom_tab') return tab;
+  return {
+    ...tab,
+    sections: tab.sections.map((section) => normalizeFieldsSection(customObject, section)),
+  };
+}
+
+function normalizeSystemSectionEdit(
+  customObject: CustomObject,
+  tabKey: string,
+  sectionKey: string,
+  edit: SystemSectionEdit,
+): SerializedSystemSectionEdit {
+  const { newFields: _newFields, ...rest } = edit;
+  const normalized: SerializedSystemSectionEdit = { ...rest };
+  if (edit.newFields != null) {
+    normalized.newFields = edit.newFields.map((field) =>
+      normalizeSectionField(customObject, sectionKey, `${tabKey}.${sectionKey}`, field),
+    );
+  }
+  return normalized;
+}
+
+function normalizeSystemTabEdit(
+  customObject: CustomObject,
+  tabKey: string,
+  edit: SystemTabEdit,
+): SerializedSystemTabEdit {
+  const { newSections: _newSections, systemSectionEdits: _systemSectionEdits, ...rest } = edit;
+  const normalized: SerializedSystemTabEdit = { ...rest };
+  if (edit.newSections != null) {
+    normalized.newSections = edit.newSections.map((section) => normalizeFieldsSection(customObject, section));
+  }
+  if (edit.systemSectionEdits != null) {
+    const systemSectionEdits: Record<string, SerializedSystemSectionEdit> = {};
+    for (const [sectionKey, sectionEdit] of Object.entries(edit.systemSectionEdits)) {
+      systemSectionEdits[sectionKey] = normalizeSystemSectionEdit(
+        customObject,
+        tabKey,
+        sectionKey,
+        sectionEdit,
+      );
+    }
+    normalized.systemSectionEdits = systemSectionEdits;
+  }
+  return normalized;
+}
+
+function normalizeTabEdits(customObject: CustomObject, tabEdits: TabEdits): SerializedTabEdits {
+  const { newTabs: _newTabs, systemTabEdits: _systemTabEdits, ...rest } = tabEdits;
+  const normalized: SerializedTabEdits = { ...rest };
+  if (tabEdits.newTabs != null) {
+    normalized.newTabs = tabEdits.newTabs.map((tab) => normalizeTab(customObject, tab));
+  }
+  if (tabEdits.systemTabEdits != null) {
+    const systemTabEdits: Record<string, SerializedSystemTabEdit> = {};
+    for (const [tabKey, tabEdit] of Object.entries(tabEdits.systemTabEdits)) {
+      systemTabEdits[tabKey] = normalizeSystemTabEdit(customObject, tabKey, tabEdit);
+    }
+    normalized.systemTabEdits = systemTabEdits;
+  }
+  return normalized;
+}
+
 // ---------------------------------------------------------------------------
 // Class
 // ---------------------------------------------------------------------------
@@ -283,11 +481,11 @@ export interface CustomObjectPageLayoutProps {
  *     newTabs: [{
  *       key: 'member', name: 'Member', type: 'tab_with_sections',
  *       sections: [{
- *         key: 'profile', name: 'Profile', type: 'fields_section',
- *         fields: [
- *           { fieldRqlName: memberFirstName.getApiName() },
- *           { fieldRqlName: memberEmail.getApiName() },
- *         ],
+ *         key: 'profile',
+ *         name: 'Profile',
+ *         type: 'fields_section',
+ *         section: profileSection,
+ *         fields: [memberFirstName, memberEmail],
  *       }],
  *     }],
  *     systemTabEdits: {},
@@ -304,7 +502,7 @@ export class CustomObjectPageLayout {
   private readonly _apiName: string;
   private readonly _customObjectApiName: string;
   private readonly _name: string;
-  private readonly _tabEdits: TabEdits;
+  private readonly _tabEdits: SerializedTabEdits;
   private readonly _headerEdits: HeaderEdits;
   private readonly _visibilityConditions: VisibilityConditions;
   private readonly _blueprintKey: string | undefined;
@@ -321,7 +519,7 @@ export class CustomObjectPageLayout {
     this._apiName = props.apiName;
     this._customObjectApiName = customObject.getApiName();
     this._name = props.name;
-    this._tabEdits = props.tabEdits ?? {};
+    this._tabEdits = normalizeTabEdits(customObject, props.tabEdits ?? {});
     this._headerEdits = props.headerEdits ?? {};
     this._visibilityConditions = props.visibilityConditions ?? {};
     this._blueprintKey = props.blueprintKey;
@@ -396,6 +594,11 @@ export class CustomObjectPageLayout {
   ): CustomObjectPageLayout {
     const coApiName = customObject.getApiName();
     const coName = customObject.getName();
+    const sectionPrefix = coApiName.replace(/__c$/, '').replace(/[^a-zA-Z0-9]+/g, '_');
+    const generalSection = new CustomObjectFieldSection(customObject, {
+      sectionId: `sec_${sectionPrefix}_general`,
+      name: 'General',
+    });
     return new CustomObjectPageLayout(customObject, {
       apiName: 'default',
       name: `${coName} Layout`,
@@ -410,9 +613,8 @@ export class CustomObjectPageLayout {
                 key: 'general',
                 name: 'General',
                 type: 'fields_section',
-                fields: (props.fields ?? []).map((f: Field) => ({
-                  fieldRqlName: f.getApiName(),
-                })),
+                section: generalSection,
+                fields: props.fields ?? [],
               },
             ],
           },

package/src/lib/manifest/field.ts

@@ -130,7 +130,7 @@ export class Field {
   private readonly _rqlFormula: string | null;
   private readonly _formulaAttrMetas: Record<string, any> | null;
   private readonly _derivedFieldFormula: string | null;
-  private readonly _section: string | null;
+  private _section: string | null;
   private readonly _summarySpec: SummarySpec | null;
   private readonly _derivedAggregatedFieldStatic: Record<string, any> | null;
 
@@ -202,6 +202,14 @@ export class Field {
   isSummary(): boolean {
     return this._summarySpec != null;
   }
+  /** Returns the field section id assigned to this field, if any. */
+  getSectionId(): string | null {
+    return this._section;
+  }
+  /** @internal Assigns this field to a field section during page-layout normalization. */
+  _assignSection(section: CustomObjectFieldSection | string): void {
+    this._section = typeof section === 'string' ? section : section.getSectionId();
+  }
 
   // ── Serialization ──────────────────────────────────────────────────────
 

package/src/lib/manifest/index.ts

@@ -35,6 +35,8 @@ export {
   type PageLayoutSection,
   type PageLayoutTab,
   type SectionField,
+  type SectionFieldOptions,
+  type SectionFieldRef,
   type SectionFieldsLayout,
   type SystemHeaderFieldEdit,
   type SystemSectionEdit,