Skip to content

feat(workflow-definition-client): add categories #589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
blomqma wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(workflow-definition-client): add categories #589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/workflow-definition-closing-reason-categories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@epilot/workflow-definition-client": minor
"@epilot/sdk": minor
"@epilot/cli": patch
---

Add closing reason categories to the Workflow Definition API: `getAllClosingReasonCategories`, `createClosingReasonCategory`, `getClosingReasonCategory`, `updateClosingReasonCategory` and `deleteClosingReasonCategory` (`/v1/workflows/closing-reason-categories`), plus `categoryId` and the read-only resolved `category` on `ClosingReason`
44 changes: 44 additions & 0 deletions clients/workflow-definition-client/src/openapi-runtime.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,50 @@
"responses": {}
}
},
"/v1/workflows/closing-reason-categories": {
"get": {
"operationId": "getAllClosingReasonCategories",
"responses": {}
},
"post": {
"operationId": "createClosingReasonCategory",
"requestBody": {
"required": true,
"content": {
"application/json": {}
}
},
"responses": {}
}
},
"/v1/workflows/closing-reason-categories/{categoryId}": {
"parameters": [
{
"in": "path",
"name": "categoryId",
"required": true,
"description": "unique id to identify the closing reason category."
}
],
"get": {
"operationId": "getClosingReasonCategory",
"responses": {}
},
"patch": {
"operationId": "updateClosingReasonCategory",
"requestBody": {
"required": true,
"content": {
"application/json": {}
}
},
"responses": {}
},
"delete": {
"operationId": "deleteClosingReasonCategory",
"responses": {}
}
},
"/v1/workflows/definitions/{definitionId}/closing-reasons": {
"get": {
"operationId": "getWorkflowClosingReasons",
Expand Down
212 changes: 212 additions & 0 deletions clients/workflow-definition-client/src/openapi.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,9 +358,56 @@ declare namespace Components {
id?: string;
title?: string;
status?: ClosingReasonsStatus;
/**
* Id of the category the reason is grouped under. Omit or send null for a reason without a category.
* example:
* c9wq81x
*/
categoryId?: string | null;
category?: /* The reason's category, resolved when a flow template is read. Ignored on writes. */ ClosingReasonCategoryRef;
lastUpdateTime?: string;
creationTime?: string;
}
export interface ClosingReasonCategories {
categories: /* A category that groups closing reasons, e.g. "Wirtschaftlichkeit" for several economic reasons */ ClosingReasonCategory[];
}
/**
* A category that groups closing reasons, e.g. "Wirtschaftlichkeit" for several economic reasons
*/
export interface ClosingReasonCategory {
id?: string;
/**
* example:
* Wirtschaftlichkeit
*/
title?: string;
lastUpdateTime?: string;
creationTime?: string;
}
/**
* Error response returned when a closing reason category is not found.
*/
export interface ClosingReasonCategoryNotFoundResp {
/**
* example:
* Closing reason category not found
*/
message?: string;
}
export interface ClosingReasonCategoryPayload {
/**
* example:
* Wirtschaftlichkeit
*/
title: string;
}
/**
* The reason's category, resolved when a flow template is read. Ignored on writes.
*/
export interface ClosingReasonCategoryRef {
id: string;
title: string;
}
export interface ClosingReasonId {
/**
* example:
Expand Down Expand Up @@ -2091,6 +2138,15 @@ declare namespace Paths {
export type $201 = /* One Closing reason for a workflow */ Components.Schemas.ClosingReason;
}
}
namespace CreateClosingReasonCategory {
export type RequestBody = Components.Schemas.ClosingReasonCategoryPayload;
namespace Responses {
export type $201 = /* A category that groups closing reasons, e.g. "Wirtschaftlichkeit" for several economic reasons */ Components.Schemas.ClosingReasonCategory;
export type $400 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
export type $403 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
export type $409 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
}
}
namespace CreateDefinition {
export type RequestBody = /**
* V1 workflow definition schema. Defines a linear workflow structure with sections
Expand Down Expand Up @@ -2166,6 +2222,14 @@ declare namespace Paths {
export type $404 = /* Error response returned when a closing reason is not found. */ Components.Schemas.ClosingReasonNotFoundResp;
}
}
namespace DeleteClosingReasonCategory {
namespace Responses {
export interface $204 {
}
export type $403 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
export type $404 = /* Error response returned when a closing reason category is not found. */ Components.Schemas.ClosingReasonCategoryNotFoundResp;
}
}
namespace DeleteDefinition {
namespace Parameters {
export type DefinitionId = string;
Expand Down Expand Up @@ -2227,6 +2291,12 @@ declare namespace Paths {
export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
}
}
namespace GetAllClosingReasonCategories {
namespace Responses {
export type $200 = Components.Schemas.ClosingReasonCategories;
export type $403 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
}
}
namespace GetAllClosingReasons {
namespace Parameters {
export type IncludeInactive = boolean;
Expand Down Expand Up @@ -2260,6 +2330,13 @@ declare namespace Paths {
export type $404 = /* Error response returned when a closing reason is not found. */ Components.Schemas.ClosingReasonNotFoundResp;
}
}
namespace GetClosingReasonCategory {
namespace Responses {
export type $200 = /* A category that groups closing reasons, e.g. "Wirtschaftlichkeit" for several economic reasons */ Components.Schemas.ClosingReasonCategory;
export type $403 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
export type $404 = /* Error response returned when a closing reason category is not found. */ Components.Schemas.ClosingReasonCategoryNotFoundResp;
}
}
namespace GetClosingReasonV1 {
namespace Parameters {
export type ReasonId = string;
Expand Down Expand Up @@ -2425,6 +2502,16 @@ declare namespace Paths {
export type $404 = /* Error response returned when a closing reason is not found. */ Components.Schemas.ClosingReasonNotFoundResp;
}
}
namespace UpdateClosingReasonCategory {
export type RequestBody = Components.Schemas.ClosingReasonCategoryPayload;
namespace Responses {
export type $200 = /* A category that groups closing reasons, e.g. "Wirtschaftlichkeit" for several economic reasons */ Components.Schemas.ClosingReasonCategory;
export type $400 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
export type $403 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
export type $404 = /* Error response returned when a closing reason category is not found. */ Components.Schemas.ClosingReasonCategoryNotFoundResp;
export type $409 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
}
}
namespace UpdateDefinition {
namespace Parameters {
export type DefinitionId = string;
Expand Down Expand Up @@ -2494,6 +2581,22 @@ declare namespace Paths {
export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
}
}
namespace V1WorkflowsClosingReasonCategories$CategoryId {
namespace Parameters {
/**
* example:
* c9wq81x
*/
export type CategoryId = string;
}
export interface PathParameters {
categoryId: /**
* example:
* c9wq81x
*/
Parameters.CategoryId;
}
}
}


Expand Down Expand Up @@ -2712,6 +2815,56 @@ export interface OperationMethods {
data?: Paths.ChangeReasonStatus.RequestBody,
config?: AxiosRequestConfig
): OperationResponse<Paths.ChangeReasonStatus.Responses.$202>
/**
* getAllClosingReasonCategories - getAllClosingReasonCategories
*
* Get all closing reason categories defined in the organization.
*/
'getAllClosingReasonCategories'(
parameters?: Parameters<UnknownParamsObject> | null,
data?: any,
config?: AxiosRequestConfig
): OperationResponse<Paths.GetAllClosingReasonCategories.Responses.$200>
/**
* createClosingReasonCategory - createClosingReasonCategory
*
* Create a category that closing reasons can be grouped under. Titles are unique per organization, ignoring case and surrounding whitespace.
*/
'createClosingReasonCategory'(
parameters?: Parameters<UnknownParamsObject> | null,
data?: Paths.CreateClosingReasonCategory.RequestBody,
config?: AxiosRequestConfig
): OperationResponse<Paths.CreateClosingReasonCategory.Responses.$201>
/**
* getClosingReasonCategory - getClosingReasonCategory
*
* Get a closing reason category by id.
*/
'getClosingReasonCategory'(
parameters?: Parameters<Paths.V1WorkflowsClosingReasonCategories$CategoryId.PathParameters> | null,
data?: any,
config?: AxiosRequestConfig
): OperationResponse<Paths.GetClosingReasonCategory.Responses.$200>
/**
* updateClosingReasonCategory - updateClosingReasonCategory
*
* Rename a closing reason category. Running flows keep the title they started with.
*/
'updateClosingReasonCategory'(
parameters?: Parameters<Paths.V1WorkflowsClosingReasonCategories$CategoryId.PathParameters> | null,
data?: Paths.UpdateClosingReasonCategory.RequestBody,
config?: AxiosRequestConfig
): OperationResponse<Paths.UpdateClosingReasonCategory.Responses.$200>
/**
* deleteClosingReasonCategory - deleteClosingReasonCategory
*
* Delete a closing reason category. Its reasons are kept and lose their category.
*/
'deleteClosingReasonCategory'(
parameters?: Parameters<Paths.V1WorkflowsClosingReasonCategories$CategoryId.PathParameters> | null,
data?: any,
config?: AxiosRequestConfig
): OperationResponse<Paths.DeleteClosingReasonCategory.Responses.$204>
/**
* getWorkflowClosingReasons - getWorkflowClosingReasons
*
Expand Down Expand Up @@ -2969,6 +3122,60 @@ export interface PathsDictionary {
config?: AxiosRequestConfig
): OperationResponse<Paths.ChangeReasonStatus.Responses.$202>
}
['/v1/workflows/closing-reason-categories']: {
/**
* getAllClosingReasonCategories - getAllClosingReasonCategories
*
* Get all closing reason categories defined in the organization.
*/
'get'(
parameters?: Parameters<UnknownParamsObject> | null,
data?: any,
config?: AxiosRequestConfig
): OperationResponse<Paths.GetAllClosingReasonCategories.Responses.$200>
/**
* createClosingReasonCategory - createClosingReasonCategory
*
* Create a category that closing reasons can be grouped under. Titles are unique per organization, ignoring case and surrounding whitespace.
*/
'post'(
parameters?: Parameters<UnknownParamsObject> | null,
data?: Paths.CreateClosingReasonCategory.RequestBody,
config?: AxiosRequestConfig
): OperationResponse<Paths.CreateClosingReasonCategory.Responses.$201>
}
['/v1/workflows/closing-reason-categories/{categoryId}']: {
/**
* getClosingReasonCategory - getClosingReasonCategory
*
* Get a closing reason category by id.
*/
'get'(
parameters?: Parameters<Paths.V1WorkflowsClosingReasonCategories$CategoryId.PathParameters> | null,
data?: any,
config?: AxiosRequestConfig
): OperationResponse<Paths.GetClosingReasonCategory.Responses.$200>
/**
* updateClosingReasonCategory - updateClosingReasonCategory
*
* Rename a closing reason category. Running flows keep the title they started with.
*/
'patch'(
parameters?: Parameters<Paths.V1WorkflowsClosingReasonCategories$CategoryId.PathParameters> | null,
data?: Paths.UpdateClosingReasonCategory.RequestBody,
config?: AxiosRequestConfig
): OperationResponse<Paths.UpdateClosingReasonCategory.Responses.$200>
/**
* deleteClosingReasonCategory - deleteClosingReasonCategory
*
* Delete a closing reason category. Its reasons are kept and lose their category.
*/
'delete'(
parameters?: Parameters<Paths.V1WorkflowsClosingReasonCategories$CategoryId.PathParameters> | null,
data?: any,
config?: AxiosRequestConfig
): OperationResponse<Paths.DeleteClosingReasonCategory.Responses.$204>
}
['/v1/workflows/definitions/{definitionId}/closing-reasons']: {
/**
* getWorkflowClosingReasons - getWorkflowClosingReasons
Expand Down Expand Up @@ -3012,6 +3219,11 @@ export type AutomationTask = Components.Schemas.AutomationTask;
export type AutomationTrigger = Components.Schemas.AutomationTrigger;
export type ChangeReasonStatusReq = Components.Schemas.ChangeReasonStatusReq;
export type ClosingReason = Components.Schemas.ClosingReason;
export type ClosingReasonCategories = Components.Schemas.ClosingReasonCategories;
export type ClosingReasonCategory = Components.Schemas.ClosingReasonCategory;
export type ClosingReasonCategoryNotFoundResp = Components.Schemas.ClosingReasonCategoryNotFoundResp;
export type ClosingReasonCategoryPayload = Components.Schemas.ClosingReasonCategoryPayload;
export type ClosingReasonCategoryRef = Components.Schemas.ClosingReasonCategoryRef;
export type ClosingReasonId = Components.Schemas.ClosingReasonId;
export type ClosingReasonNotFoundResp = Components.Schemas.ClosingReasonNotFoundResp;
export type ClosingReasons = Components.Schemas.ClosingReasons;
Expand Down
Loading
Loading