@harnessio/react-rmg-service-client 0.56.0 → 0.57.0

package/dist/rmg-service/src/services/hooks/useDeleteReleaseMutation.d.ts

@@ -1,5 +1,4 @@
 import { UseMutationOptions } from '@tanstack/react-query';
-import type { DeleteReleaseResponseResponse } from '../responses/DeleteReleaseResponseResponse';
 import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
 import type { ResponseWithPagination } from '../helpers';
 import { FetcherOptions } from '../../../../fetcher/index.js';
@@ -13,13 +12,13 @@ export interface DeleteReleaseMutationQueryParams {
 export interface DeleteReleaseMutationHeaderParams {
     'Harness-Account': string;
 }
-export type DeleteReleaseOkResponse = ResponseWithPagination<DeleteReleaseResponseResponse>;
+export type DeleteReleaseOkResponse = ResponseWithPagination<unknown>;
 export type DeleteReleaseErrorResponse = ErrorResponseResponse;
 export interface DeleteReleaseProps extends DeleteReleaseMutationPathParams, Omit<FetcherOptions<DeleteReleaseMutationQueryParams, unknown, DeleteReleaseMutationHeaderParams>, 'url'> {
     queryParams: DeleteReleaseMutationQueryParams;
 }
 export declare function deleteRelease(props: DeleteReleaseProps): Promise<DeleteReleaseOkResponse>;
 /**
- * Delete a release. For ADHOC releases, deletes both the release and its stub release group. For RECURRING releases, deletes only the release. The identifier can be either the slug_id or UUID of the release. Cannot delete releases in Running, Paused, or InputWaiting states.
+ * Delete a release. For ADHOC releases, deletes both the release and its stub release group. For RECURRING releases, deletes only the release. The identifier can be either the slug_id or UUID of the release. Only releases in Scheduled or InputWaiting state can be deleted. Cannot delete releases in Running or Paused states.
  */
 export declare function useDeleteReleaseMutation(options?: Omit<UseMutationOptions<DeleteReleaseOkResponse, DeleteReleaseErrorResponse, DeleteReleaseProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<DeleteReleaseOkResponse, import("..").Error, DeleteReleaseProps, unknown>;

package/dist/rmg-service/src/services/hooks/useDeleteReleaseMutation.js

@@ -7,7 +7,7 @@ export function deleteRelease(props) {
     return fetcher(Object.assign({ url: `/release/${props.releaseId}`, method: 'DELETE' }, props));
 }
 /**
- * Delete a release. For ADHOC releases, deletes both the release and its stub release group. For RECURRING releases, deletes only the release. The identifier can be either the slug_id or UUID of the release. Cannot delete releases in Running, Paused, or InputWaiting states.
+ * Delete a release. For ADHOC releases, deletes both the release and its stub release group. For RECURRING releases, deletes only the release. The identifier can be either the slug_id or UUID of the release. Only releases in Scheduled or InputWaiting state can be deleted. Cannot delete releases in Running or Paused states.
  */
 export function useDeleteReleaseMutation(options) {
     return useMutation((mutateProps) => deleteRelease(mutateProps), options);

package/dist/rmg-service/src/services/hooks/useGetReportDownloadQuery.d.ts

@@ -19,6 +19,6 @@ export interface GetReportDownloadProps extends GetReportDownloadQueryPathParams
 }
 export declare function getReportDownload(props: GetReportDownloadProps): Promise<GetReportDownloadOkResponse>;
 /**
- * Download the generated CSV report. The report must be in COMPLETED status. Returns the CSV file as a binary download.
+ * Download the generated Excel report. The report must be in COMPLETED status. Returns the Excel file as a binary download.
  */
 export declare function useGetReportDownloadQuery(props: GetReportDownloadProps, options?: Omit<UseQueryOptions<GetReportDownloadOkResponse, GetReportDownloadErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<GetReportDownloadOkResponse, import("..").Error>;

package/dist/rmg-service/src/services/hooks/useGetReportDownloadQuery.js

@@ -7,7 +7,7 @@ export function getReportDownload(props) {
     return fetcher(Object.assign({ url: `/release/report/${props.reportId}/download`, method: 'GET' }, props));
 }
 /**
- * Download the generated CSV report. The report must be in COMPLETED status. Returns the CSV file as a binary download.
+ * Download the generated Excel report. The report must be in COMPLETED status. Returns the Excel file as a binary download.
  */
 export function useGetReportDownloadQuery(props, options) {
     return useQuery(['getReportDownload', props.reportId, props.queryParams], ({ signal }) => getReportDownload(Object.assign(Object.assign({}, props), { signal })), options);

package/dist/rmg-service/src/services/hooks/useGetYamlSchemaQuery.d.ts

@@ -0,0 +1,22 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface GetYamlSchemaQueryQueryParams {
+    accountIdentifier: string;
+    orgIdentifier?: string;
+    projectIdentifier?: string;
+    entityType: 'PROCESS';
+}
+export type GetYamlSchemaOkResponse = ResponseWithPagination<{
+    [key: string]: any;
+}>;
+export type GetYamlSchemaErrorResponse = ErrorResponseResponse;
+export interface GetYamlSchemaProps extends Omit<FetcherOptions<GetYamlSchemaQueryQueryParams, unknown>, 'url'> {
+    queryParams: GetYamlSchemaQueryQueryParams;
+}
+export declare function getYamlSchema(props: GetYamlSchemaProps): Promise<GetYamlSchemaOkResponse>;
+/**
+ * Returns the JSON Schema for the specified entity type. Currently supports entityType=PROCESS.
+ */
+export declare function useGetYamlSchemaQuery(props: GetYamlSchemaProps, options?: Omit<UseQueryOptions<GetYamlSchemaOkResponse, GetYamlSchemaErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<GetYamlSchemaOkResponse, import("..").Error>;

package/dist/rmg-service/src/services/hooks/useGetYamlSchemaQuery.js

@@ -0,0 +1,14 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+import { useQuery } from '@tanstack/react-query';
+import { fetcher } from '../../../../fetcher/index.js';
+export function getYamlSchema(props) {
+    return fetcher(Object.assign({ url: `/yamlSchema`, method: 'GET' }, props));
+}
+/**
+ * Returns the JSON Schema for the specified entity type. Currently supports entityType=PROCESS.
+ */
+export function useGetYamlSchemaQuery(props, options) {
+    return useQuery(['get-yamlSchema', props.queryParams], ({ signal }) => getYamlSchema(Object.assign(Object.assign({}, props), { signal })), options);
+}

package/dist/rmg-service/src/services/hooks/usePostReleaseGroupReportGenerateMutation.d.ts

@@ -23,6 +23,6 @@ export interface PostReleaseGroupReportGenerateProps extends PostReleaseGroupRep
 }
 export declare function postReleaseGroupReportGenerate(props: PostReleaseGroupReportGenerateProps): Promise<PostReleaseGroupReportGenerateOkResponse>;
 /**
- * Generate a CSV report for all releases in a release group within a time period. The report generation is asynchronous and returns a report job ID that can be used to track status and download the report.
+ * Generate an Excel report for all releases in a release group within a time period. The report generation is asynchronous and returns a report job ID that can be used to track status and download the report.
  */
 export declare function usePostReleaseGroupReportGenerateMutation(options?: Omit<UseMutationOptions<PostReleaseGroupReportGenerateOkResponse, PostReleaseGroupReportGenerateErrorResponse, PostReleaseGroupReportGenerateProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<PostReleaseGroupReportGenerateOkResponse, import("..").Error, PostReleaseGroupReportGenerateProps, unknown>;

package/dist/rmg-service/src/services/hooks/usePostReleaseGroupReportGenerateMutation.js

@@ -7,7 +7,7 @@ export function postReleaseGroupReportGenerate(props) {
     return fetcher(Object.assign({ url: `/releaseGroup/${props.releaseGroupId}/report/generate`, method: 'POST' }, props));
 }
 /**
- * Generate a CSV report for all releases in a release group within a time period. The report generation is asynchronous and returns a report job ID that can be used to track status and download the report.
+ * Generate an Excel report for all releases in a release group within a time period. The report generation is asynchronous and returns a report job ID that can be used to track status and download the report.
  */
 export function usePostReleaseGroupReportGenerateMutation(options) {
     return useMutation((mutateProps) => postReleaseGroupReportGenerate(mutateProps), options);

package/dist/rmg-service/src/services/hooks/usePostReleaseReportGenerateMutation.d.ts

@@ -23,6 +23,6 @@ export interface PostReleaseReportGenerateProps extends PostReleaseReportGenerat
 }
 export declare function postReleaseReportGenerate(props: PostReleaseReportGenerateProps): Promise<PostReleaseReportGenerateOkResponse>;
 /**
- * Generate a CSV report for a specific release within a time period. The report generation is asynchronous and returns a report job ID that can be used to track status and download the report.
+ * Generate an Excel report for a specific release within a time period. The report generation is asynchronous and returns a report job ID that can be used to track status and download the report.
  */
 export declare function usePostReleaseReportGenerateMutation(options?: Omit<UseMutationOptions<PostReleaseReportGenerateOkResponse, PostReleaseReportGenerateErrorResponse, PostReleaseReportGenerateProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<PostReleaseReportGenerateOkResponse, import("..").Error, PostReleaseReportGenerateProps, unknown>;

package/dist/rmg-service/src/services/hooks/usePostReleaseReportGenerateMutation.js

@@ -7,7 +7,7 @@ export function postReleaseReportGenerate(props) {
     return fetcher(Object.assign({ url: `/release/${props.releaseId}/report/generate`, method: 'POST' }, props));
 }
 /**
- * Generate a CSV report for a specific release within a time period. The report generation is asynchronous and returns a report job ID that can be used to track status and download the report.
+ * Generate an Excel report for a specific release within a time period. The report generation is asynchronous and returns a report job ID that can be used to track status and download the report.
  */
 export function usePostReleaseReportGenerateMutation(options) {
     return useMutation((mutateProps) => postReleaseReportGenerate(mutateProps), options);

package/dist/rmg-service/src/services/hooks/useReceiveWebhookSignalMutation.d.ts

@@ -0,0 +1,21 @@
+import { UseMutationOptions } from '@tanstack/react-query';
+import type { WebhookSignalResponse } from '../schemas/WebhookSignalResponse';
+import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
+import type { WebhookSignalRequest } from '../schemas/WebhookSignalRequest';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface ReceiveWebhookSignalMutationHeaderParams {
+    'Harness-Account': string;
+}
+export type ReceiveWebhookSignalRequestBody = WebhookSignalRequest;
+export type ReceiveWebhookSignalOkResponse = ResponseWithPagination<WebhookSignalResponse>;
+export type ReceiveWebhookSignalErrorResponse = ErrorResponseResponse;
+export interface ReceiveWebhookSignalProps extends Omit<FetcherOptions<unknown, ReceiveWebhookSignalRequestBody, ReceiveWebhookSignalMutationHeaderParams>, 'url'> {
+    body: ReceiveWebhookSignalRequestBody;
+}
+export declare function receiveWebhookSignal(props: ReceiveWebhookSignalProps): Promise<ReceiveWebhookSignalOkResponse>;
+/**
+ * Receive an inbound webhook signal from an external source (e.g. a pipeline execution completion event). Persists the signal as PENDING in the webhooks table and returns 200. Duplicate submissions with the same idempotencyKey are silently accepted (idempotent). Requires the RMG_ENABLE_WEBHOOK_QUEUE_SUPPORT feature flag to be enabled.
+ *
+ */
+export declare function useReceiveWebhookSignalMutation(options?: Omit<UseMutationOptions<ReceiveWebhookSignalOkResponse, ReceiveWebhookSignalErrorResponse, ReceiveWebhookSignalProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<ReceiveWebhookSignalOkResponse, import("..").Error, ReceiveWebhookSignalProps, unknown>;

package/dist/rmg-service/src/services/hooks/useReceiveWebhookSignalMutation.js

@@ -0,0 +1,15 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+import { useMutation } from '@tanstack/react-query';
+import { fetcher } from '../../../../fetcher/index.js';
+export function receiveWebhookSignal(props) {
+    return fetcher(Object.assign({ url: `/v1/webhook/signal`, method: 'POST' }, props));
+}
+/**
+ * Receive an inbound webhook signal from an external source (e.g. a pipeline execution completion event). Persists the signal as PENDING in the webhooks table and returns 200. Duplicate submissions with the same idempotencyKey are silently accepted (idempotent). Requires the RMG_ENABLE_WEBHOOK_QUEUE_SUPPORT feature flag to be enabled.
+ *
+ */
+export function useReceiveWebhookSignalMutation(options) {
+    return useMutation((mutateProps) => receiveWebhookSignal(mutateProps), options);
+}

package/dist/rmg-service/src/services/index.d.ts

@@ -85,6 +85,8 @@ export type { GetReportStatusErrorResponse, GetReportStatusOkResponse, GetReport
 export { getReportStatus, useGetReportStatusQuery } from './hooks/useGetReportStatusQuery';
 export type { GetTaskCommentsSummaryErrorResponse, GetTaskCommentsSummaryOkResponse, GetTaskCommentsSummaryProps, GetTaskCommentsSummaryQueryPathParams, GetTaskCommentsSummaryQueryQueryParams, } from './hooks/useGetTaskCommentsSummaryQuery';
 export { getTaskCommentsSummary, useGetTaskCommentsSummaryQuery, } from './hooks/useGetTaskCommentsSummaryQuery';
+export type { GetYamlSchemaErrorResponse, GetYamlSchemaOkResponse, GetYamlSchemaProps, GetYamlSchemaQueryQueryParams, } from './hooks/useGetYamlSchemaQuery';
+export { getYamlSchema, useGetYamlSchemaQuery } from './hooks/useGetYamlSchemaQuery';
 export type { PatchReleaseGroupErrorResponse, PatchReleaseGroupMutationPathParams, PatchReleaseGroupMutationQueryParams, PatchReleaseGroupOkResponse, PatchReleaseGroupProps, PatchReleaseGroupRequestBody, } from './hooks/usePatchReleaseGroupMutation';
 export { patchReleaseGroup, usePatchReleaseGroupMutation, } from './hooks/usePatchReleaseGroupMutation';
 export type { PostActivityExecutionOutputErrorResponse, PostActivityExecutionOutputMutationPathParams, PostActivityExecutionOutputMutationQueryParams, PostActivityExecutionOutputOkResponse, PostActivityExecutionOutputProps, PostActivityExecutionOutputRequestBody, } from './hooks/usePostActivityExecutionOutputMutation';
@@ -125,6 +127,8 @@ export type { PutReleaseGroupErrorResponse, PutReleaseGroupMutationPathParams, P
 export { putReleaseGroup, usePutReleaseGroupMutation } from './hooks/usePutReleaseGroupMutation';
 export type { PutReleaseReleaseIdErrorResponse, PutReleaseReleaseIdMutationPathParams, PutReleaseReleaseIdOkResponse, PutReleaseReleaseIdProps, PutReleaseReleaseIdRequestBody, } from './hooks/usePutReleaseReleaseIdMutation';
 export { putReleaseReleaseId, usePutReleaseReleaseIdMutation, } from './hooks/usePutReleaseReleaseIdMutation';
+export type { ReceiveWebhookSignalErrorResponse, ReceiveWebhookSignalOkResponse, ReceiveWebhookSignalProps, ReceiveWebhookSignalRequestBody, } from './hooks/useReceiveWebhookSignalMutation';
+export { receiveWebhookSignal, useReceiveWebhookSignalMutation, } from './hooks/useReceiveWebhookSignalMutation';
 export type { ServeUploadErrorResponse, ServeUploadOkResponse, ServeUploadProps, ServeUploadQueryPathParams, } from './hooks/useServeUploadQuery';
 export { serveUpload, useServeUploadQuery } from './hooks/useServeUploadQuery';
 export type { StartReleaseExecutionErrorResponse, StartReleaseExecutionMutationPathParams, StartReleaseExecutionMutationQueryParams, StartReleaseExecutionOkResponse, StartReleaseExecutionProps, StartReleaseExecutionRequestBody, } from './hooks/useStartReleaseExecutionMutation';
@@ -160,7 +164,6 @@ export type { CreateOrchestrationProcessResponseResponse } from './responses/Cre
 export type { CreateReleaseGroupResponseResponse } from './responses/CreateReleaseGroupResponseResponse';
 export type { CreateTaskCommentResponseResponse } from './responses/CreateTaskCommentResponseResponse';
 export type { DeleteReleaseGroupResponseResponse } from './responses/DeleteReleaseGroupResponseResponse';
-export type { DeleteReleaseResponseResponse } from './responses/DeleteReleaseResponseResponse';
 export type { EnvironmentDashboardResponseResponse } from './responses/EnvironmentDashboardResponseResponse';
 export type { EnvironmentListPerReleaseResponseResponse } from './responses/EnvironmentListPerReleaseResponseResponse';
 export type { ErrorResponseResponse } from './responses/ErrorResponseResponse';
@@ -331,4 +334,7 @@ export type { TimeRangeDto } from './schemas/TimeRangeDto';
 export type { TriggerType } from './schemas/TriggerType';
 export type { TriggeredByDto } from './schemas/TriggeredByDto';
 export type { User } from './schemas/User';
+export type { WebhookPipeline } from './schemas/WebhookPipeline';
+export type { WebhookSignalRequest } from './schemas/WebhookSignalRequest';
+export type { WebhookSignalResponse } from './schemas/WebhookSignalResponse';
 export type { Weekday } from './schemas/Weekday';

package/dist/rmg-service/src/services/index.js

@@ -41,6 +41,7 @@ export { getReleaseTasks, useGetReleaseTasksQuery } from './hooks/useGetReleaseT
 export { getReportDownload, useGetReportDownloadQuery } from './hooks/useGetReportDownloadQuery';
 export { getReportStatus, useGetReportStatusQuery } from './hooks/useGetReportStatusQuery';
 export { getTaskCommentsSummary, useGetTaskCommentsSummaryQuery, } from './hooks/useGetTaskCommentsSummaryQuery';
+export { getYamlSchema, useGetYamlSchemaQuery } from './hooks/useGetYamlSchemaQuery';
 export { patchReleaseGroup, usePatchReleaseGroupMutation, } from './hooks/usePatchReleaseGroupMutation';
 export { postActivityExecutionOutput, usePostActivityExecutionOutputMutation, } from './hooks/usePostActivityExecutionOutputMutation';
 export { postOnHoldActivityAction, usePostOnHoldActivityActionMutation, } from './hooks/usePostOnHoldActivityActionMutation';
@@ -61,6 +62,7 @@ export { putOrchestrationProcessInput, usePutOrchestrationProcessInputMutation,
 export { putOrchestrationProcess, usePutOrchestrationProcessMutation, } from './hooks/usePutOrchestrationProcessMutation';
 export { putReleaseGroup, usePutReleaseGroupMutation } from './hooks/usePutReleaseGroupMutation';
 export { putReleaseReleaseId, usePutReleaseReleaseIdMutation, } from './hooks/usePutReleaseReleaseIdMutation';
+export { receiveWebhookSignal, useReceiveWebhookSignalMutation, } from './hooks/useReceiveWebhookSignalMutation';
 export { serveUpload, useServeUploadQuery } from './hooks/useServeUploadQuery';
 export { startReleaseExecution, useStartReleaseExecutionMutation, } from './hooks/useStartReleaseExecutionMutation';
 export { updateExecutionTaskMetadata, useUpdateExecutionTaskMetadataMutation, } from './hooks/useUpdateExecutionTaskMetadataMutation';

package/dist/rmg-service/src/services/schemas/WebhookPipeline.d.ts

@@ -0,0 +1,6 @@
+export interface WebhookPipeline {
+    /**
+     * Pipeline identifier that acts as the webhook source.
+     */
+    identifier?: string;
+}

package/dist/rmg-service/src/services/schemas/WebhookSignalRequest.d.ts

@@ -0,0 +1,14 @@
+import type { WebhookPipeline } from '../schemas/WebhookPipeline';
+export interface WebhookSignalRequest {
+    /**
+     * Unique key to ensure idempotent signal delivery.
+     */
+    idempotencyKey: string;
+    /**
+     * Optional arbitrary metadata payload from the webhook source.
+     */
+    metadata?: {
+        [key: string]: any;
+    };
+    pipeline?: WebhookPipeline;
+}

package/dist/rmg-service/src/services/schemas/WebhookSignalRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/rmg-service/src/services/schemas/WebhookSignalResponse.d.ts

@@ -0,0 +1,7 @@
+export interface WebhookSignalResponse {
+    /**
+     * Acknowledgement status of the ingested signal.
+     * @example "accepted"
+     */
+    status: string;
+}

package/dist/rmg-service/src/services/schemas/WebhookSignalResponse.js

@@ -0,0 +1,4 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harnessio/react-rmg-service-client",
-  "version": "0.56.0",
+  "version": "0.57.0",
   "description": "Harness Release Management Service APIs integrated with react hooks",
   "author": "Harness Inc",
   "license": "MIT",

package/dist/rmg-service/src/services/responses/DeleteReleaseResponseResponse.d.ts

@@ -1,14 +0,0 @@
-export interface DeleteReleaseResponseResponse {
-    /**
-     * UUID of the deleted release
-     */
-    id: string;
-    /**
-     * Source of the deleted release (ADHOC or RECURRING)
-     */
-    source: string;
-    /**
-     * Indicates whether the deletion was successful
-     */
-    success: boolean;
-}