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

package/src/client.ts

@@ -11,6 +11,7 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
+import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Pagination from './core/pagination';
@@ -66,12 +67,37 @@ import {
   Compensations,
   CompensationsPageCursorURL,
 } from './resources/compensations';
+import {
+  CreateAppNotification,
+  CreateAppNotificationCreateParams,
+  CreateAppNotificationCreateResponse,
+} from './resources/create-app-notification';
+import {
+  CustomAppCreateParams,
+  CustomAppCreateResponse,
+  CustomAppListResponse,
+  CustomAppListResponsesPageCursorURL,
+  CustomAppRetrieveResponse,
+  CustomAppUpdateParams,
+  CustomAppUpdateResponse,
+  CustomApps,
+} from './resources/custom-apps';
 import {
   CustomFieldListParams,
   CustomFieldListResponse,
   CustomFieldListResponsesPageCursorURL,
   CustomFields,
 } from './resources/custom-fields';
+import {
+  CustomPageCreateParams,
+  CustomPageCreateResponse,
+  CustomPageListResponse,
+  CustomPageListResponsesPageCursorURL,
+  CustomPageRetrieveResponse,
+  CustomPageUpdateParams,
+  CustomPageUpdateResponse,
+  CustomPages,
+} from './resources/custom-pages';
 import {
   CustomSettingCreateParams,
   CustomSettingCreateResponse,
@@ -264,12 +290,18 @@ import {
   ObjectCategoryCreateParams,
   ObjectCategoryUpdateParams,
 } from './resources/object-categories';
+import {
+  PlatformCapabilities,
+  PlatformCapabilityListResponse,
+  PlatformCapabilityListResponsesPageCursorURL,
+} from './resources/platform-capabilities';
 import {
   ReportRunCreateParams,
   ReportRunCreateResponse,
   ReportRunRetrieveResponse,
   ReportRuns,
 } from './resources/report-runs';
+import { RunQuery, RunQueryCreateParams, RunQueryCreateResponse } from './resources/run-query';
 import {
   ScheduleCreateParams,
   ScheduleCreateResponse,
@@ -282,6 +314,8 @@ import {
   ScheduleUpdateResponse,
   Schedules,
 } from './resources/schedules';
+import { SendEmail, SendEmailCreateParams, SendEmailCreateResponse } from './resources/send-email';
+import { SendSlack, SendSlackCreateParams, SendSlackCreateResponse } from './resources/send-slack';
 import {
   ShiftAssignmentUpdateCustomfieldsParams,
   ShiftAssignmentUpdateCustomfieldsResponse,
@@ -312,7 +346,7 @@ import {
   ShiftassignmentUpdateResponse,
   Shiftassignments,
 } from './resources/shiftassignments';
-import { SSOMe, SSOMeResource, SSOMeRetrieveParams } from './resources/sso-me';
+import { SSOMe, SSOMeListParams, SSOMeResource } from './resources/sso-me';
 import {
   Team,
   TeamListParams,
@@ -414,6 +448,11 @@ import {
   Functions,
   FunctionsPageCursorURL,
 } from './resources/functions/functions';
+import {
+  Metadata,
+  MetadataListResponse,
+  MetadataListResponsesPageCursorURL,
+} from './resources/metadata/metadata';
 import {
   Supergroup,
   SupergroupListParams,
@@ -617,21 +656,8 @@ export class RipplingSDK {
   /**
    * Basic re-implementation of `qs.stringify` for primitive types.
    */
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return Object.entries(query)
-      .filter(([_, value]) => typeof value !== 'undefined')
-      .map(([key, value]) => {
-        if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-          return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-        }
-        if (value === null) {
-          return `${encodeURIComponent(key)}=`;
-        }
-        throw new Errors.RipplingSDKError(
-          `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
-        );
-      })
-      .join('&');
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   private getUserAgent(): string {
@@ -663,12 +689,13 @@ export class RipplingSDK {
       : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
-    if (!isEmptyObj(defaultQuery)) {
-      query = { ...defaultQuery, ...query };
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query };
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
@@ -852,7 +879,7 @@ export class RipplingSDK {
       loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
 
       const errText = await response.text().catch((err: any) => castToError(err).message);
-      const errJSON = safeJSON(errText);
+      const errJSON = safeJSON(errText) as any;
       const errMessage = errJSON ? undefined : errText;
 
       loggerFor(this).debug(
@@ -889,9 +916,14 @@ export class RipplingSDK {
   getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(
     path: string,
     Page: new (...args: any[]) => PageClass,
-    opts?: RequestOptions,
+    opts?: PromiseOrValue<RequestOptions>,
   ): Pagination.PagePromise<PageClass, Item> {
-    return this.requestAPIList(Page, { method: 'get', path, ...opts });
+    return this.requestAPIList(
+      Page,
+      opts && 'then' in opts ?
+        opts.then((opts) => ({ method: 'get', path, ...opts }))
+      : { method: 'get', path, ...opts },
+    );
   }
 
   requestAPIList<
@@ -899,7 +931,7 @@ export class RipplingSDK {
     PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>,
   >(
     Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass,
-    options: FinalRequestOptions,
+    options: PromiseOrValue<FinalRequestOptions>,
   ): Pagination.PagePromise<PageClass, Item> {
     const request = this.makeRequest(options, null, undefined);
     return new Pagination.PagePromise<PageClass, Item>(this as any as RipplingSDK, request, Page);
@@ -912,9 +944,10 @@ export class RipplingSDK {
     controller: AbortController,
   ): Promise<Response> {
     const { signal, method, ...options } = init || {};
-    if (signal) signal.addEventListener('abort', () => controller.abort());
+    const abort = this._makeAbort(controller);
+    if (signal) signal.addEventListener('abort', abort, { once: true });
 
-    const timeout = setTimeout(() => controller.abort(), ms);
+    const timeout = setTimeout(abort, ms);
 
     const isReadableBody =
       ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) ||
@@ -991,9 +1024,9 @@ export class RipplingSDK {
       }
     }
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says, but otherwise calculate a default
-    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+    // If the API asks us to wait a certain amount of time, just do what it
+    // says, but otherwise calculate a default
+    if (timeoutMillis === undefined) {
       const maxRetries = options.maxRetries ?? this.maxRetries;
       timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
     }
@@ -1082,6 +1115,12 @@ export class RipplingSDK {
     return headers.values;
   }
 
+  private _makeAbort(controller: AbortController) {
+    // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
+    //       would capture all request options, and cause a memory leak.
+    return () => controller.abort();
+  }
+
   private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
     bodyHeaders: HeadersLike;
     body: BodyInit | undefined;
@@ -1114,6 +1153,14 @@ export class RipplingSDK {
         (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))
     ) {
       return { bodyHeaders: undefined, body: Shims.ReadableStreamFrom(body as AsyncIterable<Uint8Array>) };
+    } else if (
+      typeof body === 'object' &&
+      headers.values.get('content-type') === 'application/x-www-form-urlencoded'
+    ) {
+      return {
+        bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
+        body: this.stringifyQuery(body),
+      };
     } else {
       return this.#encoder({ body, headers });
     }
@@ -1138,55 +1185,228 @@ export class RipplingSDK {
 
   static toFile = Uploads.toFile;
 
+  /**
+   * Companies on Rippling
+   */
   companies: API.Companies = new API.Companies(this);
+  /**
+   * Compensation associated with workers
+   */
   compensations: API.Compensations = new API.Compensations(this);
+  /**
+   * Custom objects defined by the company
+   */
   customObjects: API.CustomObjects = new API.CustomObjects(this);
+  /**
+   * Departments used by the company
+   */
   departments: API.Departments = new API.Departments(this);
+  /**
+   * Employment types used by the company
+   */
   employmentTypes: API.EmploymentTypes = new API.EmploymentTypes(this);
+  /**
+   * Job related information for the company
+   */
   jobCodes: API.JobCodes = new API.JobCodes(this);
+  /**
+   * Job related information for the company
+   */
   jobDimensions: API.JobDimensions = new API.JobDimensions(this);
+  /**
+   * A request for a job to be filled by a candidate
+   */
   jobRequisitions: API.JobRequisitions = new API.JobRequisitions(this);
+  /**
+   * Badge information used with Timeclock Kiosk
+   */
   kioskBadges: API.KioskBadges = new API.KioskBadges(this);
+  /**
+   * Leave balances for workers
+   */
   leaveBalances: API.LeaveBalances = new API.LeaveBalances(this);
+  /**
+   * Leave requests submitted by workers
+   */
   leaveRequests: API.LeaveRequests = new API.LeaveRequests(this);
+  /**
+   * Leave types used by the company
+   */
   leaveTypes: API.LeaveTypes = new API.LeaveTypes(this);
+  /**
+   * Legal entities registered by the company
+   */
   legalEntities: API.LegalEntities = new API.LegalEntities(this);
+  /**
+   * Levels and tracks used by the company for workers
+   */
   levels: API.Levels = new API.Levels(this);
+  /**
+   * Object Categories defined by the company
+   */
   objectCategories: API.ObjectCategories = new API.ObjectCategories(this);
+  /**
+   * Shift inputs used by the company
+   */
   shiftInputs: API.ShiftInputs = new API.ShiftInputs(this);
+  /**
+   * Provides the user's SSO information
+   */
   ssoMe: API.SSOMeResource = new API.SSOMeResource(this);
+  /**
+   * Supergroups used by the company
+   */
   supergroups: API.Supergroups = new API.Supergroups(this);
+  /**
+   * Teams at the company
+   */
   teams: API.Teams = new API.Teams(this);
+  /**
+   * Time entries submitted by workers
+   */
   timeCards: API.TimeCards = new API.TimeCards(this);
+  /**
+   * Time entries submitted by workers
+   */
   timeEntries: API.TimeEntries = new API.TimeEntries(this);
+  /**
+   * Levels and tracks used by the company for workers
+   */
   tracks: API.Tracks = new API.Tracks(this);
+  /**
+   * Users of the company
+   */
   users: API.Users = new API.Users(this);
+  /**
+   * Work locations used by the company
+   */
   workLocations: API.WorkLocations = new API.WorkLocations(this);
+  /**
+   * Workers who work or have worked at the company
+   */
   workers: API.Workers = new API.Workers(this);
+  /**
+   * Business partners of the company
+   */
   businessPartners: API.BusinessPartners = new API.BusinessPartners(this);
+  /**
+   * Business partners of the company
+   */
   businessPartnerGroups: API.BusinessPartnerGroups = new API.BusinessPartnerGroups(this);
+  /**
+   * Functions defined by the company
+   */
   functions: API.Functions = new API.Functions(this);
+  /**
+   * Job related information for the company
+   */
   jobAssignments: API.JobAssignments = new API.JobAssignments(this);
+  /**
+   * Job related information for the company
+   */
   jobPayRateExceptions: API.JobPayRateExceptions = new API.JobPayRateExceptions(this);
+  /**
+   * Someone who applies to a job requisition opened by the company
+   */
   candidates: API.Candidates = new API.Candidates(this);
+  /**
+   * An application by a candidate to a specific job requisition
+   */
   candidateApplications: API.CandidateApplications = new API.CandidateApplications(this);
+  /**
+   * Compensation bands details associated with workers
+   */
   compensationBandsDetails: API.CompensationBandsDetails = new API.CompensationBandsDetails(this);
+  /**
+   * Execute workflow actions like sending emails, Slack messages, and notifications
+   */
+  createAppNotification: API.CreateAppNotification = new API.CreateAppNotification(this);
+  customApps: API.CustomApps = new API.CustomApps(this);
+  /**
+   * Custom fields defined by the company
+   */
   customFields: API.CustomFields = new API.CustomFields(this);
+  customPages: API.CustomPages = new API.CustomPages(this);
   customSettings: API.CustomSettings = new API.CustomSettings(this);
+  /**
+   * Candidates who have not yet started work at the company
+   */
   draftHires: API.DraftHires = new API.DraftHires(this);
+  /**
+   * Availability of API features to the company or Partners.
+   */
   entitlements: API.Entitlements = new API.Entitlements(this);
+  /**
+   * Headcount allocations for the company
+   */
   headcountPositions: API.HeadcountPositions = new API.HeadcountPositions(this);
+  /**
+   * Organizational classifications used to categorize hiring needs based on business urgency and strategic importance
+   */
   headcountPriorities: API.HeadcountPriorities = new API.HeadcountPriorities(this);
+  /**
+   * Organizational job categories that group similar roles and responsibilities within a company
+   */
   jobFunctions: API.JobFunctions = new API.JobFunctions(this);
+  /**
+   * A request for a job to be filled by a candidate
+   */
   jobRequisitionsWrite: API.JobRequisitionsWrite = new API.JobRequisitionsWrite(this);
+  /**
+   * Leave accruals for workers
+   */
   leaveAccruals: API.LeaveAccruals = new API.LeaveAccruals(this);
+  /**
+   * Geographic compensation adjustment factors that modify base compensation based on location-specific market conditions and cost of living
+   */
   locationFactors: API.LocationFactors = new API.LocationFactors(this);
+  /**
+   * Custom objects defined by the company
+   */
+  metadata: API.Metadata = new API.Metadata(this);
+  /**
+   * Custom objects defined by the company
+   */
+  platformCapabilities: API.PlatformCapabilities = new API.PlatformCapabilities(this);
+  /**
+   * Report data for company
+   */
   reportRuns: API.ReportRuns = new API.ReportRuns(this);
+  /**
+   * Execute SQL queries and manage transformations
+   */
+  runQuery: API.RunQuery = new API.RunQuery(this);
+  /**
+   * Schedules used by the company
+   */
   schedules: API.Schedules = new API.Schedules(this);
+  /**
+   * Execute workflow actions like sending emails, Slack messages, and notifications
+   */
+  sendEmail: API.SendEmail = new API.SendEmail(this);
+  /**
+   * Execute workflow actions like sending emails, Slack messages, and notifications
+   */
+  sendSlack: API.SendSlack = new API.SendSlack(this);
+  /**
+   * Shift assignments assigned to workers
+   */
   shiftassignments: API.Shiftassignments = new API.Shiftassignments(this);
+  /**
+   * Job titles used by the company
+   */
   titles: API.Titles = new API.Titles(this);
+  /**
+   * Unassigned shifts that are part of a schedule
+   */
   unassignedshifts: API.Unassignedshifts = new API.Unassignedshifts(this);
+  /**
+   * Shift assignments assigned to workers
+   */
   shiftAssignments: API.ShiftAssignments = new API.ShiftAssignments(this);
+  /**
+   * Unassigned shifts that are part of a schedule
+   */
   unassignedShifts: API.UnassignedShifts = new API.UnassignedShifts(this);
 }
 
@@ -1223,7 +1443,10 @@ RipplingSDK.JobPayRateExceptions = JobPayRateExceptions;
 RipplingSDK.Candidates = Candidates;
 RipplingSDK.CandidateApplications = CandidateApplications;
 RipplingSDK.CompensationBandsDetails = CompensationBandsDetails;
+RipplingSDK.CreateAppNotification = CreateAppNotification;
+RipplingSDK.CustomApps = CustomApps;
 RipplingSDK.CustomFields = CustomFields;
+RipplingSDK.CustomPages = CustomPages;
 RipplingSDK.CustomSettings = CustomSettings;
 RipplingSDK.DraftHires = DraftHires;
 RipplingSDK.Entitlements = Entitlements;
@@ -1233,8 +1456,13 @@ RipplingSDK.JobFunctions = JobFunctions;
 RipplingSDK.JobRequisitionsWrite = JobRequisitionsWrite;
 RipplingSDK.LeaveAccruals = LeaveAccruals;
 RipplingSDK.LocationFactors = LocationFactors;
+RipplingSDK.Metadata = Metadata;
+RipplingSDK.PlatformCapabilities = PlatformCapabilities;
 RipplingSDK.ReportRuns = ReportRuns;
+RipplingSDK.RunQuery = RunQuery;
 RipplingSDK.Schedules = Schedules;
+RipplingSDK.SendEmail = SendEmail;
+RipplingSDK.SendSlack = SendSlack;
 RipplingSDK.Shiftassignments = Shiftassignments;
 RipplingSDK.Titles = Titles;
 RipplingSDK.Unassignedshifts = Unassignedshifts;
@@ -1406,11 +1634,7 @@ export declare namespace RipplingSDK {
     type ShiftInputUpdateParams as ShiftInputUpdateParams,
   };
 
-  export {
-    SSOMeResource as SSOMeResource,
-    type SSOMe as SSOMe,
-    type SSOMeRetrieveParams as SSOMeRetrieveParams,
-  };
+  export { SSOMeResource as SSOMeResource, type SSOMe as SSOMe, type SSOMeListParams as SSOMeListParams };
 
   export {
     Supergroups as Supergroups,
@@ -1566,6 +1790,23 @@ export declare namespace RipplingSDK {
     type CompensationBandsDetailRetrieveParams as CompensationBandsDetailRetrieveParams,
   };
 
+  export {
+    CreateAppNotification as CreateAppNotification,
+    type CreateAppNotificationCreateResponse as CreateAppNotificationCreateResponse,
+    type CreateAppNotificationCreateParams as CreateAppNotificationCreateParams,
+  };
+
+  export {
+    CustomApps as CustomApps,
+    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,
+  };
+
   export {
     CustomFields as CustomFields,
     type CustomFieldListResponse as CustomFieldListResponse,
@@ -1573,6 +1814,17 @@ export declare namespace RipplingSDK {
     type CustomFieldListParams as CustomFieldListParams,
   };
 
+  export {
+    CustomPages as CustomPages,
+    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,
+  };
+
   export {
     CustomSettings as CustomSettings,
     type CustomSettingListResponse as CustomSettingListResponse,
@@ -1647,6 +1899,18 @@ export declare namespace RipplingSDK {
     type LocationFactorListParams as LocationFactorListParams,
   };
 
+  export {
+    Metadata as Metadata,
+    type MetadataListResponse as MetadataListResponse,
+    type MetadataListResponsesPageCursorURL as MetadataListResponsesPageCursorURL,
+  };
+
+  export {
+    PlatformCapabilities as PlatformCapabilities,
+    type PlatformCapabilityListResponse as PlatformCapabilityListResponse,
+    type PlatformCapabilityListResponsesPageCursorURL as PlatformCapabilityListResponsesPageCursorURL,
+  };
+
   export {
     ReportRuns as ReportRuns,
     type ReportRunCreateResponse as ReportRunCreateResponse,
@@ -1654,6 +1918,12 @@ export declare namespace RipplingSDK {
     type ReportRunCreateParams as ReportRunCreateParams,
   };
 
+  export {
+    RunQuery as RunQuery,
+    type RunQueryCreateResponse as RunQueryCreateResponse,
+    type RunQueryCreateParams as RunQueryCreateParams,
+  };
+
   export {
     Schedules as Schedules,
     type ScheduleListResponse as ScheduleListResponse,
@@ -1667,6 +1937,18 @@ export declare namespace RipplingSDK {
     type ScheduleUpdateParams as ScheduleUpdateParams,
   };
 
+  export {
+    SendEmail as SendEmail,
+    type SendEmailCreateResponse as SendEmailCreateResponse,
+    type SendEmailCreateParams as SendEmailCreateParams,
+  };
+
+  export {
+    SendSlack as SendSlack,
+    type SendSlackCreateResponse as SendSlackCreateResponse,
+    type SendSlackCreateParams as SendSlackCreateParams,
+  };
+
   export {
     Shiftassignments as Shiftassignments,
     type ShiftassignmentListResponse as ShiftassignmentListResponse,

package/src/internal/parse.ts

@@ -29,6 +29,12 @@ export async function defaultParseResponse<T>(client: RipplingSDK, props: APIRes
     const mediaType = contentType?.split(';')[0]?.trim();
     const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
     if (isJSON) {
+      const contentLength = response.headers.get('content-length');
+      if (contentLength === '0') {
+        // if there is no content we can't do anything
+        return undefined as T;
+      }
+
       const json = await response.json();
       return json as T;
     }

package/src/internal/utils/query.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { RipplingSDKError } from '../../core/error';
+
+/**
+ * Basic re-implementation of `qs.stringify` for primitive types.
+ */
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return Object.entries(query)
+    .filter(([_, value]) => typeof value !== 'undefined')
+    .map(([key, value]) => {
+      if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+        return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
+      }
+      if (value === null) {
+        return `${encodeURIComponent(key)}=`;
+      }
+      throw new RipplingSDKError(
+        `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
+      );
+    })
+    .join('&');
+}

package/src/internal/utils.ts

@@ -6,3 +6,4 @@ export * from './utils/env';
 export * from './utils/log';
 export * from './utils/uuid';
 export * from './utils/sleep';
+export * from './utils/query';

package/src/resources/business-partner-groups.ts

@@ -9,6 +9,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Business partners of the company
+ */
 export class BusinessPartnerGroups extends APIResource {
   /**
    * A List of business partner groups
@@ -21,7 +24,7 @@ export class BusinessPartnerGroups extends APIResource {
     query: BusinessPartnerGroupListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<BusinessPartnerGroupsPageCursorURL, BusinessPartnerGroup> {
-    return this._client.getAPIList('/business-partner-groups', PageCursorURL<BusinessPartnerGroup>, {
+    return this._client.getAPIList('/business-partner-groups/', PageCursorURL<BusinessPartnerGroup>, {
       query,
       ...options,
     });
@@ -31,7 +34,7 @@ export class BusinessPartnerGroups extends APIResource {
    * Create a new business partner group
    */
   create(body: BusinessPartnerGroupCreateParams, options?: RequestOptions): APIPromise<BusinessPartnerGroup> {
-    return this._client.post('/business-partner-groups', { body, ...options });
+    return this._client.post('/business-partner-groups/', { body, ...options });
   }
 
   /**
@@ -42,14 +45,14 @@ export class BusinessPartnerGroups extends APIResource {
     query: BusinessPartnerGroupRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<BusinessPartnerGroupRetrieveResponse> {
-    return this._client.get(path`/business-partner-groups/${id}`, { query, ...options });
+    return this._client.get(path`/business-partner-groups/${id}/`, { query, ...options });
   }
 
   /**
    * Delete a business partner group
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/business-partner-groups/${id}`, {
+    return this._client.delete(path`/business-partner-groups/${id}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });