import { APIResource } from "../core/resource.mjs"; import { APIPromise } from "../core/api-promise.mjs"; import { PageCursorURL, PagePromise } from "../core/pagination.mjs"; import { RequestOptions } from "../internal/request-options.mjs"; /** * Object Categories defined by the company */ export declare class ObjectCategories extends APIResource { /** * A list of object categories. * * - Requires: `API Tier 1` * * @example HTTP * Representative request and response shapes. * ``` * GET /object-categories/?limit=50&cursor=cursor HTTP/1.1 * Host: rest.ripplingapis.com * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "results": [ * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "description": "string" * } * ], * "next_link": "string" * } * ``` */ list(query?: ObjectCategoryListParams | null | undefined, options?: RequestOptions): PagePromise; /** * Create a new object category. * * @example HTTP * Representative request and response shapes. * ``` * POST /object-categories/ HTTP/1.1 * Host: rest.ripplingapis.com * Content-Type: application/json * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * {} * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "description": "string" * } * ``` */ create(body?: ObjectCategoryCreateParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieve a specific object category. * * @example HTTP * Representative request and response shapes. * ``` * GET /object-categories/{id}/ HTTP/1.1 * Host: rest.ripplingapis.com * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "description": "string" * } * ``` */ retrieve(id: string, options?: RequestOptions): APIPromise; /** * Update a specific object category. A successful write returns the full record * when permitted by read access, or an ID-only receipt otherwise. * * @example HTTP * Representative request and response shapes. * ``` * PATCH /object-categories/{id}/ HTTP/1.1 * Host: rest.ripplingapis.com * Content-Type: application/json * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * {} * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "description": "string" * } * ``` */ update(id: string, body?: ObjectCategoryUpdateParams | null | undefined, options?: RequestOptions): APIPromise; /** * Delete an object category. * * @example HTTP * Representative request and response shapes. * ``` * DELETE /object-categories/{id}/ HTTP/1.1 * Host: rest.ripplingapis.com * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 204 No Content * ``` */ delete(id: string, options?: RequestOptions): APIPromise; } export type ObjectCategoriesPageCursorURL = PageCursorURL; export interface ObjectCategory { /** * Identifier field */ id: string; /** * Record creation date */ created_at: string; /** * The name of the Custom Category */ name: string; /** * Record update date */ updated_at: string; /** * The description of the Custom Category */ description?: string; } export interface ObjectCategoryListParams { cursor?: string; /** * The maximum number of results to return. Defaults to 50. Maximum is 100. */ limit?: number; } export interface ObjectCategoryCreateParams { /** * A description of the category. */ description?: string; /** * The name of the category. */ name?: string; } export interface ObjectCategoryUpdateParams { /** * A description of the category. */ description?: string; /** * The name of the category. */ name?: string; } export declare namespace ObjectCategories { export { type ObjectCategory as ObjectCategory, type ObjectCategoriesPageCursorURL as ObjectCategoriesPageCursorURL, type ObjectCategoryListParams as ObjectCategoryListParams, type ObjectCategoryCreateParams as ObjectCategoryCreateParams, type ObjectCategoryUpdateParams as ObjectCategoryUpdateParams, }; } //# sourceMappingURL=object-categories.d.mts.map