import { APIResource } from "../../core/resource.js"; import * as ExtractAPI from "./extract.js"; import { Extract, ExtractCreateParams, ExtractCreateResponse } from "./extract.js"; import * as TypesAPI from "./types.js"; import { TypeRetrieveResponse, Types } from "./types.js"; import { PageCursorURL, PagePromise } from "../../core/pagination.js"; import { RequestOptions } from "../../internal/request-options.js"; /** * Author, publish, and install Unity Packages V2 packages */ export declare class PackageComponents extends APIResource { types: TypesAPI.Types; extract: ExtractAPI.Extract; /** * Return lightweight summaries and complete picker identifiers for one component * type, without extracting configurations or source code. Search filters summaries * before pagination. Results are ordered by display name (case-insensitive), then * identifier. Follow next_link until null. Catalog edits between pages may affect * results; this is not a frozen snapshot. * * @example HTTP * Representative request and response shapes. * ``` * GET /package-components/?type=x&search=search&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": [ * { * "name": "string", * "description": "string", * "identifier": {}, * "selectable": false, * "unsupported_reason": "string" * } * ], * "next_link": "string" * } * ``` */ list(query: PackageComponentListParams, options?: RequestOptions): PagePromise; } export type PackageComponentListResponsesPageCursorURL = PageCursorURL; export interface PackageComponentListResponse { /** * Component description, when available. */ description: string | null; /** * Complete package picker identifier to pass unchanged to extraction; fields * depend on component type. */ identifier: unknown; /** * Component display name in the package builder. */ name: string; /** * Whether the package builder permits selecting this component. */ selectable: boolean; /** * Why selection is unavailable, when supplied by the package builder. */ unsupported_reason: string | null; } export interface PackageComponentListParams { /** * Component type returned by GET /package-components/types/. */ type: string; /** * Opaque continuation cursor from next_link for the same role, company, component * type, and normalized search. */ cursor?: string; /** * Maximum number of component summaries per page. */ limit?: number; /** * Case-insensitive substring match on display name and API-name fields in the * identifier. Surrounding whitespace is ignored; an omitted or blank search lists * the catalog. Descriptions, internal IDs, source code, and configurations are not * searched. */ search?: string; } export declare namespace PackageComponents { export { type PackageComponentListResponse as PackageComponentListResponse, type PackageComponentListResponsesPageCursorURL as PackageComponentListResponsesPageCursorURL, type PackageComponentListParams as PackageComponentListParams, }; export { Types as Types, type TypeRetrieveResponse as TypeRetrieveResponse }; export { Extract as Extract, type ExtractCreateResponse as ExtractCreateResponse, type ExtractCreateParams as ExtractCreateParams, }; } //# sourceMappingURL=package-components.d.ts.map