@approvio/api 0.0.1

package/README.md

@@ -0,0 +1,80 @@
+# Approvio API
+
+This repository contains the OpenAPI specification for the Approvio backend and the tooling to generate the TypeScript API client.
+
+## Getting Started
+
+1.  **Install Dependencies:**
+
+    ```bash
+    yarn install
+    ```
+
+2.  **Generate API Client:**
+
+    This command will generate the TypeScript API client in the `generated/openapi` directory.
+
+    ```bash
+    yarn generate:api
+    ```
+
+## Usage
+
+The generated API client can be consumed by other TypeScript/JavaScript projects.
+
+### Linting the OpenAPI Specification
+
+To lint the `openapi.yaml` file and check for adherence to best practices and defined rules:
+
+```bash
+yarn lint:api
+```
+
+## Linking and Publishing
+
+### Linking for Local Development
+
+To link this package for local development in another project (e.g., `approvio-frontend`):
+
+1.  Navigate to the `approvio-api` directory:
+
+    ```bash
+    cd approvio-api
+    ```
+
+2.  Run `yarn link` to create a global symlink:
+
+    ```bash
+    yarn link
+    ```
+
+3.  Navigate to your consuming project (e.g., `approvio-frontend`):
+
+    ```bash
+    cd ../approvio-frontend
+    ```
+
+4.  Link the `approvio-api` package:
+
+    ```bash
+    yarn link @approvio/api
+    ```
+
+Now, your consuming project will use the locally linked version of `@approvio/api`.
+
+### Publishing to NPM
+
+To publish this package to an NPM registry:
+
+1.  Ensure you are logged in to the correct NPM registry:
+
+    ```bash
+    yarn login
+    ```
+
+
+1.  Run `yarn publish`:
+
+    ```bash
+    yarn publish
+    ```

package/generated/openapi/model/add-group-entities-request.ts

@@ -0,0 +1,24 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { EntityMembershipAdd } from './entity-membership-add';
+
+
+/**
+ * Defines operations to add entities within a group
+ */
+export interface AddGroupEntitiesRequest { 
+    /**
+     * List of entities to add to the group.
+     */
+    entities: Array<EntityMembershipAdd>;
+}
+

package/generated/openapi/model/and-rule.ts

@@ -0,0 +1,35 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ApprovalRule } from './approval-rule';
+
+
+/**
+ * An AND rule requiring all nested rules to be satisfied.
+ */
+export interface AndRule { 
+    /**
+     * Rule type (AND)
+     */
+    type: AndRule.TypeEnum;
+    /**
+     * List of rules that must all be satisfied. Cannot be empty.
+     */
+    rules: Array<ApprovalRule>;
+}
+export namespace AndRule {
+    export type TypeEnum = 'AND';
+    export const TypeEnum = {
+        And: 'AND' as TypeEnum
+    };
+}
+
+

package/generated/openapi/model/api-error-details-inner.ts

@@ -0,0 +1,18 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface APIErrorDetailsInner { 
+    field?: string;
+    message?: string;
+}
+

package/generated/openapi/model/api-error.ts

@@ -0,0 +1,26 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { APIErrorDetailsInner } from './api-error-details-inner';
+
+
+export interface APIError { 
+    /**
+     * Error code
+     */
+    code?: string;
+    /**
+     * Error message
+     */
+    message?: string;
+    details?: Array<APIErrorDetailsInner>;
+}
+

package/generated/openapi/model/approval-rule.ts

@@ -0,0 +1,26 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AndRule } from './and-rule';
+import { OrRule } from './or-rule';
+import { GroupRequirementRule } from './group-requirement-rule';
+
+
+/**
+ * Configuration of approval rules. Can be a boolean operator (AND/OR) combining nested rules, or a specific requirement (minimum count from a group). 
+ */
+/**
+ * @type ApprovalRule
+ * Configuration of approval rules. Can be a boolean operator (AND/OR) combining nested rules, or a specific requirement (minimum count from a group). 
+ * @export
+ */
+export type ApprovalRule = AndRule | GroupRequirementRule | OrRule;
+

package/generated/openapi/model/can-vote-response.ts

@@ -0,0 +1,24 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface CanVoteResponse { 
+    /**
+     * True if the authenticated entity can currently vote on the workflow, false otherwise.
+     */
+    canVote: boolean;
+    /**
+     * Indicates the voting status for the user on this workflow.  Relevant only if \'canVote\' is true or if the user had voting rights previously. 
+     */
+    voteStatus: string;
+}
+

package/generated/openapi/model/entity-membership-add.ts

@@ -0,0 +1,22 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { EntityReference } from './entity-reference';
+
+
+export interface EntityMembershipAdd { 
+    entity: EntityReference;
+    /**
+     * Role assigned to the entity within the group.
+     */
+    role: string;
+}
+

package/generated/openapi/model/entity-membership-remove.ts

@@ -0,0 +1,18 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { EntityReference } from './entity-reference';
+
+
+export interface EntityMembershipRemove { 
+    entity: EntityReference;
+}
+

package/generated/openapi/model/entity-reference.ts

@@ -0,0 +1,24 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface EntityReference { 
+    /**
+     * The type of the entity being referenced.
+     */
+    entityType: string;
+    /**
+     * The unique identifier (UUID) of the entity.
+     */
+    entityId: string;
+}
+

package/generated/openapi/model/group-create.ts

@@ -0,0 +1,24 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface GroupCreate { 
+    /**
+     * Name of the group
+     */
+    name: string;
+    /**
+     * Description of the group
+     */
+    description?: string;
+}
+

package/generated/openapi/model/group-membership.ts

@@ -0,0 +1,26 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { EntityReference } from './entity-reference';
+
+
+export interface GroupMembership { 
+    entity: EntityReference;
+    /**
+     * The role of the entity within the group.
+     */
+    role: string;
+    /**
+     * Timestamp when the entity was added to the group.
+     */
+    readonly addedAt: string;
+}
+

package/generated/openapi/model/group-requirement-rule.ts

@@ -0,0 +1,38 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Requires a minimum number of approvals from a specific group.
+ */
+export interface GroupRequirementRule { 
+    /**
+     * Rule type (GROUP_REQUIREMENT)
+     */
+    type: GroupRequirementRule.TypeEnum;
+    /**
+     * ID of the approver group.
+     */
+    groupId: string;
+    /**
+     * Minimum number of approvals required from the group. Must be at least 1.
+     */
+    minCount: number;
+}
+export namespace GroupRequirementRule {
+    export type TypeEnum = 'GROUP_REQUIREMENT';
+    export const TypeEnum = {
+        GroupRequirement: 'GROUP_REQUIREMENT' as TypeEnum
+    };
+}
+
+

package/generated/openapi/model/group.ts

@@ -0,0 +1,40 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface Group { 
+    /**
+     * Unique identifier for the group
+     */
+    id: string;
+    /**
+     * Name of the group
+     */
+    name: string;
+    /**
+     * Description of the group
+     */
+    description?: string;
+    /**
+     * Number of entities in the group
+     */
+    entitiesCount: number;
+    /**
+     * Creation timestamp
+     */
+    createdAt: string;
+    /**
+     * Last update timestamp
+     */
+    updatedAt: string;
+}
+

package/generated/openapi/model/index.ts

@@ -0,0 +1,30 @@
+// Auto-generated index file
+
+export * from './workflow-create';
+export * from './list-users-200-response';
+export * from './group-create';
+export * from './pagination';
+export * from './and-rule';
+export * from './entity-membership-add';
+export * from './can-vote-response';
+export * from './list-group-entities-200-response';
+export * from './api-error';
+export * from './approval-rule';
+export * from './user';
+export * from './user-create';
+export * from './workflow-vote-request';
+export * from './api-error-details-inner';
+export * from './remove-group-entities-request';
+export * from './add-group-entities-request';
+export * from './models';
+export * from './group';
+export * from './group-requirement-rule';
+export * from './list-workflows-200-response';
+export * from './group-membership';
+export * from './list-groups-200-response';
+export * from './vote-mode';
+export * from './entity-membership-remove';
+export * from './workflow';
+export * from './or-rule';
+export * from './user-summary';
+export * from './entity-reference';

package/generated/openapi/model/list-group-entities-200-response.ts

@@ -0,0 +1,20 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Pagination } from './pagination';
+import { GroupMembership } from './group-membership';
+
+
+export interface ListGroupEntities200Response { 
+    entities: Array<GroupMembership>;
+    pagination: Pagination;
+}
+

package/generated/openapi/model/list-groups-200-response.ts

@@ -0,0 +1,20 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Group } from './group';
+import { Pagination } from './pagination';
+
+
+export interface ListGroups200Response { 
+    groups: Array<Group>;
+    pagination: Pagination;
+}
+

package/generated/openapi/model/list-users-200-response.ts

@@ -0,0 +1,20 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Pagination } from './pagination';
+import { UserSummary } from './user-summary';
+
+
+export interface ListUsers200Response { 
+    users: Array<UserSummary>;
+    pagination: Pagination;
+}
+

package/generated/openapi/model/list-workflows-200-response.ts

@@ -0,0 +1,20 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Pagination } from './pagination';
+import { Workflow } from './workflow';
+
+
+export interface ListWorkflows200Response { 
+    data: Array<Workflow>;
+    pagination: Pagination;
+}
+

package/generated/openapi/model/models.ts

@@ -0,0 +1,27 @@
+export * from './api-error';
+export * from './api-error-details-inner';
+export * from './add-group-entities-request';
+export * from './and-rule';
+export * from './approval-rule';
+export * from './can-vote-response';
+export * from './entity-membership-add';
+export * from './entity-membership-remove';
+export * from './entity-reference';
+export * from './group';
+export * from './group-create';
+export * from './group-membership';
+export * from './group-requirement-rule';
+export * from './list-group-entities-200-response';
+export * from './list-groups-200-response';
+export * from './list-users-200-response';
+export * from './list-workflows-200-response';
+export * from './or-rule';
+export * from './pagination';
+export * from './remove-group-entities-request';
+export * from './user';
+export * from './user-create';
+export * from './user-summary';
+export * from './vote-mode';
+export * from './workflow';
+export * from './workflow-create';
+export * from './workflow-vote-request';

package/generated/openapi/model/or-rule.ts

@@ -0,0 +1,35 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ApprovalRule } from './approval-rule';
+
+
+/**
+ * An OR rule requiring at least one of the nested rules to be satisfied.
+ */
+export interface OrRule { 
+    /**
+     * Rule type (OR)
+     */
+    type: OrRule.TypeEnum;
+    /**
+     * List of rules where at least one must be satisfied. Cannot be empty.
+     */
+    rules: Array<ApprovalRule>;
+}
+export namespace OrRule {
+    export type TypeEnum = 'OR';
+    export const TypeEnum = {
+        Or: 'OR' as TypeEnum
+    };
+}
+
+

package/generated/openapi/model/pagination.ts

@@ -0,0 +1,28 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface Pagination { 
+    /**
+     * Total number of items
+     */
+    total: number;
+    /**
+     * Current page number
+     */
+    page: number;
+    /**
+     * Items per page
+     */
+    limit: number;
+}
+

package/generated/openapi/model/remove-group-entities-request.ts

@@ -0,0 +1,24 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { EntityMembershipRemove } from './entity-membership-remove';
+
+
+/**
+ * Defines operations to remove entities within a group
+ */
+export interface RemoveGroupEntitiesRequest { 
+    /**
+     * List of entities to remove from the group.
+     */
+    entities: Array<EntityMembershipRemove>;
+}
+

package/generated/openapi/model/user-create.ts

@@ -0,0 +1,28 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface UserCreate { 
+    /**
+     * User\'s display name.
+     */
+    displayName: string;
+    /**
+     * User\'s email address (must be unique).
+     */
+    email: string;
+    /**
+     * Role assigned to the user within the group.
+     */
+    orgRole: string;
+}
+

package/generated/openapi/model/user-summary.ts

@@ -0,0 +1,28 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface UserSummary { 
+    /**
+     * Internal unique identifier for the user.
+     */
+    readonly id: string;
+    /**
+     * User\'s display name.
+     */
+    displayName: string;
+    /**
+     * User\'s email address.
+     */
+    email: string;
+}
+

package/generated/openapi/model/user.ts

@@ -0,0 +1,32 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface User { 
+    /**
+     * Internal unique identifier for the user.
+     */
+    readonly id: string;
+    /**
+     * User\'s display name.
+     */
+    displayName: string;
+    /**
+     * User\'s email address.
+     */
+    email: string;
+    /**
+     * Timestamp when the user was created.
+     */
+    readonly createdAt: string;
+}
+

package/generated/openapi/model/vote-mode.ts

@@ -0,0 +1,20 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface VoteMode { 
+    /**
+     * Specifies the mode of voting.  VOTE_FOR_ALL means the vote applies based on the user\'s direct eligibility.  VOTE_FOR_GROUPS (future) would imply voting on behalf of specific groups. 
+     */
+    type: string;
+}
+

package/generated/openapi/model/workflow-create.ts

@@ -0,0 +1,30 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ApprovalRule } from './approval-rule';
+
+
+export interface WorkflowCreate { 
+    /**
+     * User-friendly name for the workflow
+     */
+    name: string;
+    /**
+     * Detailed description of the workflow
+     */
+    description?: string;
+    /**
+     * Additional custom metadata for the workflow
+     */
+    metadata?: object;
+    approvalRule: ApprovalRule;
+}
+

package/generated/openapi/model/workflow-vote-request.ts

@@ -0,0 +1,26 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { VoteMode } from './vote-mode';
+
+
+export interface WorkflowVoteRequest { 
+    /**
+     * The type of vote to cast.
+     */
+    voteType: string;
+    voteMode: VoteMode;
+    /**
+     * Optional reason for the vote. Can be used for approval comments or decline reasons.
+     */
+    reason?: string;
+}
+

package/generated/openapi/model/workflow.ts

@@ -0,0 +1,46 @@
+/**
+ * Workflow Approval System API
+ * API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ApprovalRule } from './approval-rule';
+
+
+export interface Workflow { 
+    /**
+     * Unique identifier for the workflow
+     */
+    id: string;
+    /**
+     * User-friendly name for the workflow
+     */
+    name: string;
+    /**
+     * Detailed description of the workflow
+     */
+    description?: string;
+    /**
+     * Current status of the workflow
+     */
+    status: string;
+    approvalRule: ApprovalRule;
+    /**
+     * Additional custom metadata for the workflow
+     */
+    metadata: object;
+    /**
+     * Creation timestamp
+     */
+    createdAt: string;
+    /**
+     * Last update timestamp
+     */
+    updatedAt: string;
+}
+

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@approvio/api",
+  "author": "Giovanni Baratta",
+  "license": "MIT",
+  "version": "0.0.1",
+  "private": false,
+  "files": [
+    "generated/openapi/model"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/giovannibaratta/approvio-api"
+  },
+  "scripts": {
+    "generate:api": "openapi-generator-cli generate --openapitools openapitools.json && yarn generate:index",
+    "generate:index": "./scripts/generate-index.sh",
+    "lint:api": "spectral lint openapi.yaml --ruleset .spectral.yaml"
+  },
+  "devDependencies": {
+    "@openapitools/openapi-generator-cli": "2.20.2",
+    "@stoplight/spectral-cli": "6.15.0"
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+}