/** * Artifact Service v1 * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * OpenAPI spec version: 1.0.1 * * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * * Do not edit the class manually. */ import { RequestBuilder } from "./RequestBuilder"; export interface ArtifactObj { artifactId: string; created: string; groupId: string; hrn: string; updated: string; version: string; } export interface ArtifactFile { name?: string; } export interface DeleteArtifactResponseObj { artifact?: ArtifactObj; files?: string[]; } export interface DeleteFileResponseObj { artifact?: ArtifactObj; file?: string; } export interface DeleteSchemaResponseObj { artifacts?: ArtifactObj[]; schema?: SchemaObj; } export interface GetArtifactResponseObj { artifact?: ArtifactObj; files?: ArtifactFile[]; } export interface GetSchemaResponseObj { artifacts?: ArtifactObj[]; schema?: SchemaObj; schemaValidationResults?: SchemaValidationResults[]; variants?: Variant[]; } export interface ListSchemasResponseObj { items?: SchemaObj[]; next?: string; page?: PagedQuery; } export interface PagedQuery { from?: string; limit?: number; order: OrderEnum; sort: string; } export type OrderEnum = "ASC" | "DESC"; export interface Principal { type: TypeEnum; token: string; } export type TypeEnum = "User" | "App" | "Group"; export interface RegisterArtifactRequest { userId?: string; } export interface RegisterArtifactResponse { artifactId?: string; created?: boolean; groupId?: string; hrnPrefix?: string; } export interface SchemaObj { artifactId: string; created: string; groupId: string; hrn: string; name: string; summary?: string; updated: string; version: string; } export interface SchemaValidationResults { backwardsCompatibility?: boolean; fileExtension?: boolean; googleStyle?: boolean; majorVersionInPackage?: boolean; module: string; packageConsistency?: boolean; } export interface UpdatePermissionRequest { principal: Principal; permissions: PermissionsEnum[]; permitted?: boolean; } export type PermissionsEnum = "READ" | "MODIFY" | "SHARE"; export interface UpdatePermissionResponse { permissions?: PermissionsEnum[]; permitted?: boolean; principal?: Principal; } export interface Variant { id: string; url: string; } /** * Requires permission to 'modifyResource' for the given HRN * * @summary Delete a specific artifact * @param artifactHrn The HRN of the artifact */ export declare function deleteArtifactUsingDELETE(builder: RequestBuilder, params: { artifactHrn: string; }): Promise; /** * Requires permission to 'modifyResource' for the given HRN * * @summary Delete a specific artifact file * @param artifactHrn The HRN of the artifact * @param fileName The path to artifact file */ export declare function deleteFileUsingDELETE(builder: RequestBuilder, params: { artifactHrn: string; fileName: string; }): Promise; /** * Requires permission to 'readResource' for the given HRN * * @summary Retrieve a specific artifact file * @param artifactHrn The HRN of the artifact * @param fileName The path to artifact file */ export declare function getArtifactFileUsingGET(builder: RequestBuilder, params: { artifactHrn: string; fileName: string; }): Promise; /** * @summary getArtifact * @param artifactHrn The HRN of the artifact */ export declare function getArtifactUsingGET(builder: RequestBuilder, params: { artifactHrn: string; }): Promise; /** * Requires permission to 'modifyResource' for the given HRN * * @summary Create or update a specific artifact * @param artifactHrn The HRN of the artifact * @param fileName The path to artifact file * @param file */ export declare function putArtifactFileUsingPUT(builder: RequestBuilder, params: { artifactHrn: string; fileName: string; file: string; }): Promise; /** * Requires permission to 'apiAccess' * * @summary Register a new group and artifact * @param groupId The groupId of the artifact. Reversed internet domain name such as com.here.rib.schema * @param artifactId The ID of the artifact * @param registerRequest The register request */ export declare function registerArtifactUsingPUT(builder: RequestBuilder, params: { groupId: string; artifactId: string; registerRequest?: RegisterArtifactRequest; }): Promise; /** * Requires permission to 'modifyResource' for the given HRN * * @summary Delete schema * @param schemaHrn The HRN of the schema */ export declare function deleteSchemaUsingDELETE(builder: RequestBuilder, params: { schemaHrn: string; }): Promise; /** * Requires permission to 'readResource' for the given HRN * * @summary Resolve a schema doc variant URL * @param schemaHrn The HRN of the schema * @param file The path to schema file */ export declare function getDocumentUsingGET(builder: RequestBuilder, params: { schemaHrn: string; file: string; }): Promise; /** * Requires permission to 'readResource' for the given HRN * * @summary Retrieve schema details * @param schemaHrn The HRN of the schema */ export declare function getSchemaUsingGET(builder: RequestBuilder, params: { schemaHrn: string; }): Promise; /** * Requires permission to 'apiAccess' * * @summary List the available schemas * @param sort * @param order * @param from * @param limit */ export declare function listUsingGET(builder: RequestBuilder, params: { sort?: string; order?: "ASC" | "DESC"; from?: string; limit?: number; }): Promise; /** * READ grants 'readResource', MODIFY grants 'modifyResource', SHARE grants 'shareResource'. * Requires permission to 'shareResource' for the given HRN. * * @summary Update schema permissions for user on the specified schema and associated artifact. * @param schemaHrn The HRN of the schema * @param updatePermissionRequest The permission request */ export declare function updateSchemaPermissionUsingPOST(builder: RequestBuilder, params: { schemaHrn: string; updatePermissionRequest?: UpdatePermissionRequest; }): Promise;