@rippling/rippling-sdk 0.2.0-alpha.88 → 0.2.0-alpha.89

package/src/resources/job-codes.ts

@@ -318,6 +318,11 @@ export interface JobCodeListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 
@@ -532,6 +537,11 @@ export interface JobCodeListChangeLogParams {
 
   expand?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/job-dimensions.ts

@@ -152,6 +152,11 @@ export interface JobDimensionListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/job-functions.ts

@@ -87,6 +87,11 @@ export interface JobFunctionRetrieveResponse extends BusinessPartnersAPI.Meta {
 export interface JobFunctionListParams {
   cursor?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

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

@@ -122,6 +122,11 @@ export interface JobPayRateExceptionListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 
@@ -134,6 +139,11 @@ export interface JobPayRateExceptionListChangeLogParams {
 
   expand?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/job-requisitions.ts

@@ -57,6 +57,11 @@ export interface JobRequisition {
 export interface JobRequisitionListParams {
   cursor?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/kiosk-badges.ts

@@ -281,6 +281,11 @@ export interface KioskBadgeListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/leave-accruals.ts

@@ -389,6 +389,11 @@ export interface LeaveAccrualListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/leave-balances.ts

@@ -124,6 +124,11 @@ export interface LeaveBalanceListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/leave-requests.ts

@@ -742,6 +742,11 @@ export interface LeaveRequestListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/leave-types.ts

@@ -87,6 +87,11 @@ export interface LeaveTypeListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/legal-entities.ts

@@ -395,6 +395,11 @@ export interface LegalEntityListParams {
 
   expand?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/levels.ts

@@ -155,6 +155,11 @@ export interface LevelListParams {
 
   expand?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/location-factors.ts

@@ -639,6 +639,11 @@ export namespace LocationFactorRetrieveResponse {
 export interface LocationFactorListParams {
   cursor?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/metadata/component-schemas.ts

@@ -0,0 +1,109 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Custom objects defined by the company
+ */
+export class ComponentSchemas extends APIResource {
+  /**
+   * Return the JSON schema for one supported metadata component type.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const componentSchema =
+   *   await client.metadata.componentSchemas.get({
+   *     type: 'type',
+   *   });
+   * ```
+   */
+  get(query: ComponentSchemaGetParams, options?: RequestOptions): APIPromise<ComponentSchemaGetResponse> {
+    return this._client.get('/metadata/v2/schema/', { query, ...options });
+  }
+}
+
+export interface ComponentSchemaGetResponse {
+  /**
+   * JSON Schema for a full deployable component config.
+   */
+  config_schema: { [key: string]: unknown };
+
+  /**
+   * JSON Schema for identifying an existing component.
+   */
+  identifier_schema: { [key: string]: unknown };
+
+  /**
+   * Metadata component type.
+   */
+  type: string;
+
+  /**
+   * Type-specific implementation guidance.
+   */
+  best_practices?: string;
+
+  /**
+   * Common invalid inputs and their corrections.
+   */
+  common_mistakes?: Array<ComponentSchemaGetResponse.CommonMistake>;
+
+  /**
+   * Short description of the component type.
+   */
+  description?: string;
+
+  /**
+   * Human-readable component type name.
+   */
+  display_name?: string;
+
+  /**
+   * Valid example configs for this component type.
+   */
+  examples?: Array<{ [key: string]: unknown }>;
+
+  /**
+   * Type-specific authoring guidance.
+   */
+  usage_guide?: string;
+
+  [k: string]: unknown;
+}
+
+export namespace ComponentSchemaGetResponse {
+  export interface CommonMistake {
+    /**
+     * Explanation of the correction.
+     */
+    message: string;
+
+    /**
+     * Corrected example.
+     */
+    right: string;
+
+    /**
+     * Invalid or discouraged example.
+     */
+    wrong: string;
+  }
+}
+
+export interface ComponentSchemaGetParams {
+  /**
+   * Component type returned by list-metadata-component-types.
+   */
+  type: string;
+}
+
+export declare namespace ComponentSchemas {
+  export {
+    type ComponentSchemaGetResponse as ComponentSchemaGetResponse,
+    type ComponentSchemaGetParams as ComponentSchemaGetParams,
+  };
+}

package/src/resources/metadata/component-types.ts

@@ -0,0 +1,56 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Custom objects defined by the company
+ */
+export class ComponentTypes extends APIResource {
+  /**
+   * List component types that can be described, validated, and deployed by metadata
+   * composer.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const componentTypes =
+   *   await client.metadata.componentTypes.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<ComponentTypeListResponse> {
+    return this._client.get('/metadata/v2/types/', options);
+  }
+}
+
+export interface ComponentTypeListResponse {
+  /**
+   * Composer-enabled metadata component types.
+   */
+  types: Array<ComponentTypeListResponse.Type>;
+}
+
+export namespace ComponentTypeListResponse {
+  export interface Type {
+    /**
+     * Short description of the component type.
+     */
+    description: string;
+
+    /**
+     * Human-readable component type name.
+     */
+    display_name: string;
+
+    /**
+     * Metadata component type.
+     */
+    type: string;
+  }
+}
+
+export declare namespace ComponentTypes {
+  export { type ComponentTypeListResponse as ComponentTypeListResponse };
+}