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

package/src/resources/job-codes.ts

@@ -15,6 +15,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Job related information for the company
+ */
 export class JobCodes extends APIResource {
   /**
    * A List of job codes
@@ -29,14 +32,14 @@ export class JobCodes extends APIResource {
     query: JobCodeListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<JobCodesPageCursorURL, JobCode> {
-    return this._client.getAPIList('/job-codes', PageCursorURL<JobCode>, { query, ...options });
+    return this._client.getAPIList('/job-codes/', PageCursorURL<JobCode>, { query, ...options });
   }
 
   /**
    * Create a new job code
    */
   create(body: JobCodeCreateParams, options?: RequestOptions): APIPromise<JobCode> {
-    return this._client.post('/job-codes', { body, ...options });
+    return this._client.post('/job-codes/', { body, ...options });
   }
 
   /**
@@ -47,21 +50,21 @@ export class JobCodes extends APIResource {
     query: JobCodeRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<JobCodeRetrieveResponse> {
-    return this._client.get(path`/job-codes/${id}`, { query, ...options });
+    return this._client.get(path`/job-codes/${id}/`, { query, ...options });
   }
 
   /**
    * Updated a specific job code
    */
   update(id: string, body: JobCodeUpdateParams, options?: RequestOptions): APIPromise<JobCode> {
-    return this._client.patch(path`/job-codes/${id}`, { body, ...options });
+    return this._client.patch(path`/job-codes/${id}/`, { body, ...options });
   }
 
   /**
    * Delete a job code
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/job-codes/${id}`, {
+    return this._client.delete(path`/job-codes/${id}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -80,7 +83,7 @@ export class JobCodes extends APIResource {
     options?: RequestOptions,
   ): PagePromise<AttributeChangeDetailsPageCursorURL, JobAssignmentsAPI.AttributeChangeDetails> {
     return this._client.getAPIList(
-      path`/job-codes/${jobCodeID}/change-log`,
+      path`/job-codes/${jobCodeID}/change-log/`,
       PageCursorURL<JobAssignmentsAPI.AttributeChangeDetails>,
       { query, ...options },
     );

package/src/resources/job-dimensions.ts

@@ -8,6 +8,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Job related information for the company
+ */
 export class JobDimensions extends APIResource {
   /**
    * A List of job dimensions
@@ -20,35 +23,35 @@ export class JobDimensions extends APIResource {
     query: JobDimensionListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<JobDimensionsPageCursorURL, JobDimension> {
-    return this._client.getAPIList('/job-dimensions', PageCursorURL<JobDimension>, { query, ...options });
+    return this._client.getAPIList('/job-dimensions/', PageCursorURL<JobDimension>, { query, ...options });
   }
 
   /**
    * Create a new job dimension
    */
   create(body: JobDimensionCreateParams, options?: RequestOptions): APIPromise<JobDimension> {
-    return this._client.post('/job-dimensions', { body, ...options });
+    return this._client.post('/job-dimensions/', { body, ...options });
   }
 
   /**
    * Retrieve a specific job dimension
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<JobDimensionRetrieveResponse> {
-    return this._client.get(path`/job-dimensions/${id}`, options);
+    return this._client.get(path`/job-dimensions/${id}/`, options);
   }
 
   /**
    * Updated a specific job dimension
    */
   update(id: string, body: JobDimensionUpdateParams, options?: RequestOptions): APIPromise<JobDimension> {
-    return this._client.patch(path`/job-dimensions/${id}`, { body, ...options });
+    return this._client.patch(path`/job-dimensions/${id}/`, { body, ...options });
   }
 
   /**
    * Delete a job dimension
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/job-dimensions/${id}`, {
+    return this._client.delete(path`/job-dimensions/${id}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });

package/src/resources/job-functions.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Organizational job categories that group similar roles and responsibilities within a company
+ */
 export class JobFunctions extends APIResource {
   /**
    * A List of job functions
@@ -18,7 +21,7 @@ export class JobFunctions extends APIResource {
     query: JobFunctionListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<JobFunctionListResponsesPageCursorURL, JobFunctionListResponse> {
-    return this._client.getAPIList('/job-functions', PageCursorURL<JobFunctionListResponse>, {
+    return this._client.getAPIList('/job-functions/', PageCursorURL<JobFunctionListResponse>, {
       query,
       ...options,
     });
@@ -28,7 +31,7 @@ export class JobFunctions extends APIResource {
    * Retrieve a specific job function
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<JobFunctionRetrieveResponse> {
-    return this._client.get(path`/job-functions/${id}`, options);
+    return this._client.get(path`/job-functions/${id}/`, options);
   }
 }
 

package/src/resources/job-pay-rate-exceptions.ts

@@ -10,6 +10,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Job related information for the company
+ */
 export class JobPayRateExceptions extends APIResource {
   /**
    * A List of job pay rate exceptions
@@ -23,7 +26,7 @@ export class JobPayRateExceptions extends APIResource {
     query: JobPayRateExceptionListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<JobPayRateExceptionsPageCursorURL, JobPayRateException> {
-    return this._client.getAPIList('/job-pay-rate-exceptions', PageCursorURL<JobPayRateException>, {
+    return this._client.getAPIList('/job-pay-rate-exceptions/', PageCursorURL<JobPayRateException>, {
       query,
       ...options,
     });
@@ -37,7 +40,7 @@ export class JobPayRateExceptions extends APIResource {
     query: JobPayRateExceptionRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<JobPayRateExceptionRetrieveResponse> {
-    return this._client.get(path`/job-pay-rate-exceptions/${id}`, { query, ...options });
+    return this._client.get(path`/job-pay-rate-exceptions/${id}/`, { query, ...options });
   }
 
   /**
@@ -53,7 +56,7 @@ export class JobPayRateExceptions extends APIResource {
     options?: RequestOptions,
   ): PagePromise<AttributeChangeDetailsPageCursorURL, JobAssignmentsAPI.AttributeChangeDetails> {
     return this._client.getAPIList(
-      path`/job-pay-rate-exceptions/${jobPayRateExceptionID}/change-log`,
+      path`/job-pay-rate-exceptions/${jobPayRateExceptionID}/change-log/`,
       PageCursorURL<JobAssignmentsAPI.AttributeChangeDetails>,
       { query, ...options },
     );

package/src/resources/job-requisitions-write.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * A request for a job to be filled by a candidate
+ */
 export class JobRequisitionsWrite extends APIResource {
   /**
    * Create a new job requisition
@@ -12,7 +15,7 @@ export class JobRequisitionsWrite extends APIResource {
     body: JobRequisitionsWriteCreateParams,
     options?: RequestOptions,
   ): APIPromise<JobRequisitionsWriteCreateResponse> {
-    return this._client.post('/job-requisitions-write', { body, ...options });
+    return this._client.post('/job-requisitions-write/', { body, ...options });
   }
 }
 

package/src/resources/job-requisitions.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * A request for a job to be filled by a candidate
+ */
 export class JobRequisitions extends APIResource {
   /**
    * A List of job requisitions
@@ -15,7 +18,10 @@ export class JobRequisitions extends APIResource {
     query: JobRequisitionListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<JobRequisitionsPageCursorURL, JobRequisition> {
-    return this._client.getAPIList('/job-requisitions', PageCursorURL<JobRequisition>, { query, ...options });
+    return this._client.getAPIList('/job-requisitions/', PageCursorURL<JobRequisition>, {
+      query,
+      ...options,
+    });
   }
 }
 

package/src/resources/kiosk-badges.ts

@@ -9,6 +9,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Badge information used with Timeclock Kiosk
+ */
 export class KioskBadges extends APIResource {
   /**
    * A List of kiosk badges
@@ -22,7 +25,7 @@ export class KioskBadges extends APIResource {
     query: KioskBadgeListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<KioskBadgeListResponsesPageCursorURL, KioskBadgeListResponse> {
-    return this._client.getAPIList('/kiosk-badges', PageCursorURL<KioskBadgeListResponse>, {
+    return this._client.getAPIList('/kiosk-badges/', PageCursorURL<KioskBadgeListResponse>, {
       query,
       ...options,
     });
@@ -32,7 +35,7 @@ export class KioskBadges extends APIResource {
    * Create a new kiosk badge
    */
   create(body: KioskBadgeCreateParams, options?: RequestOptions): APIPromise<KioskBadgeCreateResponse> {
-    return this._client.post('/kiosk-badges', { body, ...options });
+    return this._client.post('/kiosk-badges/', { body, ...options });
   }
 
   /**
@@ -43,7 +46,7 @@ export class KioskBadges extends APIResource {
     query: KioskBadgeRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<KioskBadgeRetrieveResponse> {
-    return this._client.get(path`/kiosk-badges/${id}`, { query, ...options });
+    return this._client.get(path`/kiosk-badges/${id}/`, { query, ...options });
   }
 
   /**
@@ -54,14 +57,14 @@ export class KioskBadges extends APIResource {
     body: KioskBadgeUpdateParams,
     options?: RequestOptions,
   ): APIPromise<KioskBadgeUpdateResponse> {
-    return this._client.patch(path`/kiosk-badges/${id}`, { body, ...options });
+    return this._client.patch(path`/kiosk-badges/${id}/`, { body, ...options });
   }
 
   /**
    * Delete a kiosk badge
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/kiosk-badges/${id}`, {
+    return this._client.delete(path`/kiosk-badges/${id}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });

package/src/resources/leave-accruals.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Leave accruals for workers
+ */
 export class LeaveAccruals extends APIResource {
   /**
    * A List of leave accruals
@@ -22,7 +25,7 @@ export class LeaveAccruals extends APIResource {
     query: LeaveAccrualListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<LeaveAccrualListResponsesPageCursorURL, LeaveAccrualListResponse> {
-    return this._client.getAPIList('/leave-accruals', PageCursorURL<LeaveAccrualListResponse>, {
+    return this._client.getAPIList('/leave-accruals/', PageCursorURL<LeaveAccrualListResponse>, {
       query,
       ...options,
     });
@@ -32,7 +35,7 @@ export class LeaveAccruals extends APIResource {
    * Create a new leave accrual
    */
   create(body: LeaveAccrualCreateParams, options?: RequestOptions): APIPromise<LeaveAccrualCreateResponse> {
-    return this._client.post('/leave-accruals', { body, ...options });
+    return this._client.post('/leave-accruals/', { body, ...options });
   }
 
   /**
@@ -43,7 +46,7 @@ export class LeaveAccruals extends APIResource {
     query: LeaveAccrualRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<LeaveAccrualRetrieveResponse> {
-    return this._client.get(path`/leave-accruals/${id}`, { query, ...options });
+    return this._client.get(path`/leave-accruals/${id}/`, { query, ...options });
   }
 }
 
@@ -114,7 +117,8 @@ export interface LeaveAccrualListResponse {
     | 'CARRYOVER_PENALTY_PAYOUT'
     | 'RESET_PENALTY_PAYOUT'
     | 'HOLIDAY_ADJUSTMENT'
-    | 'HOURS_WORKED_TANDA';
+    | 'HOURS_WORKED_TANDA'
+    | 'TENURE_MILESTONE';
 
   /**
    * The comment for this accrual. This is required if the leave policy requires a
@@ -224,7 +228,8 @@ export interface LeaveAccrualCreateResponse {
     | 'CARRYOVER_PENALTY_PAYOUT'
     | 'RESET_PENALTY_PAYOUT'
     | 'HOLIDAY_ADJUSTMENT'
-    | 'HOURS_WORKED_TANDA';
+    | 'HOURS_WORKED_TANDA'
+    | 'TENURE_MILESTONE';
 
   /**
    * The comment for this accrual. This is required if the leave policy requires a
@@ -331,7 +336,8 @@ export interface LeaveAccrualRetrieveResponse extends BusinessPartnersAPI.Meta {
     | 'CARRYOVER_PENALTY_PAYOUT'
     | 'RESET_PENALTY_PAYOUT'
     | 'HOLIDAY_ADJUSTMENT'
-    | 'HOURS_WORKED_TANDA';
+    | 'HOURS_WORKED_TANDA'
+    | 'TENURE_MILESTONE';
 
   /**
    * The comment for this accrual. This is required if the leave policy requires a
@@ -430,7 +436,8 @@ export interface LeaveAccrualCreateParams {
     | 'CARRYOVER_PENALTY_PAYOUT'
     | 'RESET_PENALTY_PAYOUT'
     | 'HOLIDAY_ADJUSTMENT'
-    | 'HOURS_WORKED_TANDA';
+    | 'HOURS_WORKED_TANDA'
+    | 'TENURE_MILESTONE';
 
   /**
    * The comment for this accrual. This is required if the leave policy requires a

package/src/resources/leave-balances.ts

@@ -9,6 +9,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Leave balances for workers
+ */
 export class LeaveBalances extends APIResource {
   /**
    * A List of leave balances
@@ -22,7 +25,7 @@ export class LeaveBalances extends APIResource {
     query: LeaveBalanceListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<LeaveBalancesPageCursorURL, LeaveBalance> {
-    return this._client.getAPIList('/leave-balances', PageCursorURL<LeaveBalance>, { query, ...options });
+    return this._client.getAPIList('/leave-balances/', PageCursorURL<LeaveBalance>, { query, ...options });
   }
 
   /**
@@ -33,7 +36,7 @@ export class LeaveBalances extends APIResource {
     query: LeaveBalanceRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<LeaveBalanceRetrieveResponse> {
-    return this._client.get(path`/leave-balances/${id}`, { query, ...options });
+    return this._client.get(path`/leave-balances/${id}/`, { query, ...options });
   }
 }
 

package/src/resources/leave-requests.ts

@@ -9,6 +9,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Leave requests submitted by workers
+ */
 export class LeaveRequests extends APIResource {
   /**
    * A List of leave requests
@@ -23,7 +26,7 @@ export class LeaveRequests extends APIResource {
     query: LeaveRequestListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<LeaveRequestListResponsesPageCursorURL, LeaveRequestListResponse> {
-    return this._client.getAPIList('/leave-requests', PageCursorURL<LeaveRequestListResponse>, {
+    return this._client.getAPIList('/leave-requests/', PageCursorURL<LeaveRequestListResponse>, {
       query,
       ...options,
     });
@@ -33,7 +36,7 @@ export class LeaveRequests extends APIResource {
    * Create a new leave request
    */
   create(body: LeaveRequestCreateParams, options?: RequestOptions): APIPromise<LeaveRequestCreateResponse> {
-    return this._client.post('/leave-requests', { body, ...options });
+    return this._client.post('/leave-requests/', { body, ...options });
   }
 
   /**
@@ -44,7 +47,7 @@ export class LeaveRequests extends APIResource {
     query: LeaveRequestRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<LeaveRequestRetrieveResponse> {
-    return this._client.get(path`/leave-requests/${id}`, { query, ...options });
+    return this._client.get(path`/leave-requests/${id}/`, { query, ...options });
   }
 
   /**
@@ -55,7 +58,7 @@ export class LeaveRequests extends APIResource {
     body: LeaveRequestUpdateParams,
     options?: RequestOptions,
   ): APIPromise<LeaveRequestUpdateResponse> {
-    return this._client.patch(path`/leave-requests/${id}`, { body, ...options });
+    return this._client.patch(path`/leave-requests/${id}/`, { body, ...options });
   }
 }
 

package/src/resources/leave-types.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Leave types used by the company
+ */
 export class LeaveTypes extends APIResource {
   /**
    * A List of leave types
@@ -19,14 +22,14 @@ export class LeaveTypes extends APIResource {
     query: LeaveTypeListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<LeaveTypesPageCursorURL, LeaveType> {
-    return this._client.getAPIList('/leave-types', PageCursorURL<LeaveType>, { query, ...options });
+    return this._client.getAPIList('/leave-types/', PageCursorURL<LeaveType>, { query, ...options });
   }
 
   /**
    * Retrieve a specific leave type
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<LeaveTypeRetrieveResponse> {
-    return this._client.get(path`/leave-types/${id}`, options);
+    return this._client.get(path`/leave-types/${id}/`, options);
   }
 }
 

package/src/resources/legal-entities.ts

@@ -9,6 +9,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Legal entities registered by the company
+ */
 export class LegalEntities extends APIResource {
   /**
    * A List of legal entities
@@ -21,7 +24,7 @@ export class LegalEntities extends APIResource {
     query: LegalEntityListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<LegalEntitiesPageCursorURL, LegalEntity> {
-    return this._client.getAPIList('/legal-entities', PageCursorURL<LegalEntity>, { query, ...options });
+    return this._client.getAPIList('/legal-entities/', PageCursorURL<LegalEntity>, { query, ...options });
   }
 
   /**
@@ -32,7 +35,7 @@ export class LegalEntities extends APIResource {
     query: LegalEntityRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<LegalEntityRetrieveResponse> {
-    return this._client.get(path`/legal-entities/${id}`, { query, ...options });
+    return this._client.get(path`/legal-entities/${id}/`, { query, ...options });
   }
 }
 

package/src/resources/levels.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Levels and tracks used by the company for workers
+ */
 export class Levels extends APIResource {
   /**
    * A List of levels
@@ -20,7 +23,7 @@ export class Levels extends APIResource {
     query: LevelListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<LevelsPageCursorURL, Level> {
-    return this._client.getAPIList('/levels', PageCursorURL<Level>, { query, ...options });
+    return this._client.getAPIList('/levels/', PageCursorURL<Level>, { query, ...options });
   }
 
   /**
@@ -31,7 +34,7 @@ export class Levels extends APIResource {
     query: LevelRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<LevelRetrieveResponse> {
-    return this._client.get(path`/levels/${id}`, { query, ...options });
+    return this._client.get(path`/levels/${id}/`, { query, ...options });
   }
 }
 

package/src/resources/location-factors.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Geographic compensation adjustment factors that modify base compensation based on location-specific market conditions and cost of living
+ */
 export class LocationFactors extends APIResource {
   /**
    * A List of location factors
@@ -18,7 +21,7 @@ export class LocationFactors extends APIResource {
     query: LocationFactorListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<LocationFactorListResponsesPageCursorURL, LocationFactorListResponse> {
-    return this._client.getAPIList('/location-factors', PageCursorURL<LocationFactorListResponse>, {
+    return this._client.getAPIList('/location-factors/', PageCursorURL<LocationFactorListResponse>, {
       query,
       ...options,
     });
@@ -28,7 +31,7 @@ export class LocationFactors extends APIResource {
    * Retrieve a specific location factor
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<LocationFactorRetrieveResponse> {
-    return this._client.get(path`/location-factors/${id}`, options);
+    return this._client.get(path`/location-factors/${id}/`, options);
   }
 }
 

package/src/resources/metadata/components.ts

@@ -0,0 +1,38 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { PageCursorURL, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Custom objects defined by the company
+ */
+export class Components extends APIResource {
+  /**
+   * A List of metadata components
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(options?: RequestOptions): PagePromise<ComponentListResponsesPageCursorURL, ComponentListResponse> {
+    return this._client.getAPIList('/metadata/components/', PageCursorURL<ComponentListResponse>, options);
+  }
+}
+
+export type ComponentListResponsesPageCursorURL = PageCursorURL<ComponentListResponse>;
+
+/**
+ * Base DTO model shared across metadata endpoints.
+ */
+export interface ComponentListResponse {
+  /**
+   * Status of the operation
+   */
+  status?: string;
+}
+
+export declare namespace Components {
+  export {
+    type ComponentListResponse as ComponentListResponse,
+    type ComponentListResponsesPageCursorURL as ComponentListResponsesPageCursorURL,
+  };
+}

package/src/resources/metadata/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Components,
+  type ComponentListResponse,
+  type ComponentListResponsesPageCursorURL,
+} from './components';
+export { Metadata, type MetadataListResponse, type MetadataListResponsesPageCursorURL } from './metadata';
+export { Summary, type SummaryListResponse, type SummaryListResponsesPageCursorURL } from './summary';
+export { Types, type TypeListResponse, type TypeListResponsesPageCursorURL } from './types';

package/src/resources/metadata/metadata.ts

@@ -0,0 +1,70 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ComponentsAPI from './components';
+import { ComponentListResponse, ComponentListResponsesPageCursorURL, Components } from './components';
+import * as SummaryAPI from './summary';
+import { Summary, SummaryListResponse, SummaryListResponsesPageCursorURL } from './summary';
+import * as TypesAPI from './types';
+import { TypeListResponse, TypeListResponsesPageCursorURL, Types } from './types';
+import { PageCursorURL, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Custom objects defined by the company
+ */
+export class Metadata extends APIResource {
+  components: ComponentsAPI.Components = new ComponentsAPI.Components(this._client);
+  summary: SummaryAPI.Summary = new SummaryAPI.Summary(this._client);
+  types: TypesAPI.Types = new TypesAPI.Types(this._client);
+
+  /**
+   * A List of metadata components
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(options?: RequestOptions): PagePromise<MetadataListResponsesPageCursorURL, MetadataListResponse> {
+    return this._client.getAPIList('/metadata/', PageCursorURL<MetadataListResponse>, options);
+  }
+}
+
+export type MetadataListResponsesPageCursorURL = PageCursorURL<MetadataListResponse>;
+
+/**
+ * Base DTO model shared across metadata endpoints.
+ */
+export interface MetadataListResponse {
+  /**
+   * Status of the operation
+   */
+  status?: string;
+}
+
+Metadata.Components = Components;
+Metadata.Summary = Summary;
+Metadata.Types = Types;
+
+export declare namespace Metadata {
+  export {
+    type MetadataListResponse as MetadataListResponse,
+    type MetadataListResponsesPageCursorURL as MetadataListResponsesPageCursorURL,
+  };
+
+  export {
+    Components as Components,
+    type ComponentListResponse as ComponentListResponse,
+    type ComponentListResponsesPageCursorURL as ComponentListResponsesPageCursorURL,
+  };
+
+  export {
+    Summary as Summary,
+    type SummaryListResponse as SummaryListResponse,
+    type SummaryListResponsesPageCursorURL as SummaryListResponsesPageCursorURL,
+  };
+
+  export {
+    Types as Types,
+    type TypeListResponse as TypeListResponse,
+    type TypeListResponsesPageCursorURL as TypeListResponsesPageCursorURL,
+  };
+}