@approvio/api 0.0.29 → 0.0.31

package/dist/workflow-create-DVgNnx0X.d.mts

@@ -0,0 +1,506 @@
+//#region generated/openapi/model/or-rule.d.ts
+/**
+ * An OR rule requiring at least one of the nested rules to be satisfied.
+ */
+interface OrRule {
+  /**
+   * Rule type (OR)
+   */
+  type: OrRule.TypeEnum;
+  /**
+   * List of rules where at least one must be satisfied. Cannot be empty.
+   */
+  rules: Array<ApprovalRule>;
+}
+declare namespace OrRule {
+  type TypeEnum = 'OR';
+  const TypeEnum: {
+    Or: TypeEnum;
+  };
+}
+//#endregion
+//#region generated/openapi/model/group-requirement-rule.d.ts
+/**
+ * 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: 0.0.29
+ *
+ *
+ * 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.
+ */
+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;
+  /**
+   * Indicates whether a high-privilege token is required for votes fulfilling this rule.
+   */
+  requireHighPrivilege?: boolean;
+}
+declare namespace GroupRequirementRule {
+  type TypeEnum = 'GROUP_REQUIREMENT';
+  const TypeEnum: {
+    GroupRequirement: TypeEnum;
+  };
+}
+//#endregion
+//#region generated/openapi/model/approval-rule.d.ts
+/**
+ * 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
+ */
+type ApprovalRule = AndRule | GroupRequirementRule | OrRule;
+//#endregion
+//#region generated/openapi/model/and-rule.d.ts
+/**
+ * An AND rule requiring all nested rules to be satisfied.
+ */
+interface AndRule {
+  /**
+   * Rule type (AND)
+   */
+  type: AndRule.TypeEnum;
+  /**
+   * List of rules that must all be satisfied. Cannot be empty.
+   */
+  rules: Array<ApprovalRule>;
+}
+declare namespace AndRule {
+  type TypeEnum = 'AND';
+  const TypeEnum: {
+    And: TypeEnum;
+  };
+}
+//#endregion
+//#region generated/openapi/model/email-action.d.ts
+/**
+ * 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: 0.0.29
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Sends an email when workflow is approved
+ */
+interface EmailAction {
+  /**
+   * Action type (EMAIL)
+   */
+  type: EmailAction.TypeEnum;
+  /**
+   * List of email addresses to send the notification to
+   */
+  recipients: Array<string>;
+}
+declare namespace EmailAction {
+  type TypeEnum = 'EMAIL';
+  const TypeEnum: {
+    Email: TypeEnum;
+  };
+}
+//#endregion
+//#region generated/openapi/model/group-info.d.ts
+/**
+ * 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: 0.0.29
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface GroupInfo {
+  groupId: string;
+  groupName: string;
+}
+//#endregion
+//#region generated/openapi/model/group.d.ts
+/**
+ * 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: 0.0.29
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+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;
+}
+//#endregion
+//#region generated/openapi/model/pagination.d.ts
+/**
+ * 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: 0.0.29
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface Pagination {
+  /**
+   * Total number of items
+   */
+  total: number;
+  /**
+   * Current page number
+   */
+  page: number;
+  /**
+   * Items per page
+   */
+  limit: number;
+}
+//#endregion
+//#region generated/openapi/model/list-groups-200-response.d.ts
+interface ListGroups200Response {
+  groups: Array<Group>;
+  pagination: Pagination;
+}
+//#endregion
+//#region generated/openapi/model/user-summary.d.ts
+/**
+ * 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: 0.0.29
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface UserSummary {
+  /**
+   * Internal unique identifier for the user.
+   */
+  readonly id: string;
+  /**
+   * User\'s display name.
+   */
+  displayName: string;
+  /**
+   * User\'s email address.
+   */
+  email: string;
+}
+//#endregion
+//#region generated/openapi/model/webhook-action.d.ts
+/**
+ * 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: 0.0.29
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Calls a webhook when workflow is approved
+ */
+interface WebhookAction {
+  /**
+   * Action type (WEBHOOK)
+   */
+  type: WebhookAction.TypeEnum;
+  /**
+   * The URL to call
+   */
+  url: string;
+  /**
+   * HTTP method to use
+   */
+  method?: WebhookAction.MethodEnum;
+  /**
+   * Optional headers to send with the request
+   */
+  headers?: {
+    [key: string]: string;
+  };
+}
+declare namespace WebhookAction {
+  type TypeEnum = 'WEBHOOK';
+  const TypeEnum: {
+    Webhook: TypeEnum;
+  };
+  type MethodEnum = 'POST' | 'PUT' | 'GET';
+  const MethodEnum: {
+    Post: MethodEnum;
+    Put: MethodEnum;
+    Get: MethodEnum;
+  };
+}
+//#endregion
+//#region generated/openapi/model/workflow-action.d.ts
+/**
+ * Configuration for actions to be executed when workflow is approved. Currently supports email actions.
+ */
+/**
+ * @type WorkflowAction
+ * Configuration for actions to be executed when workflow is approved. Currently supports email actions.
+ * @export
+ */
+type WorkflowAction = EmailAction | WebhookAction;
+//#endregion
+//#region generated/openapi/model/workflow-template.d.ts
+interface WorkflowTemplate {
+  /**
+   * Unique identifier for the workflow template
+   */
+  id: string;
+  /**
+   * User-friendly name for the workflow template
+   */
+  name: string;
+  /**
+   * Version of the workflow template. \"latest\" for active templates, numeric for versioned templates
+   */
+  version: string;
+  /**
+   * Detailed description of the workflow template
+   */
+  description?: string;
+  /**
+   * Lifecycle status of the template: * ACTIVE - Template can be referenced to create new workflows * PENDING_DEPRECATION - Template has been deprecated but there are still active workflows (intermediate status for async deprecation) * DEPRECATED - Template cannot be referenced for new workflows, voting may still be allowed based on settings
+   */
+  status: WorkflowTemplate.StatusEnum;
+  /**
+   * Whether voting is allowed on workflows using this template when it\'s deprecated
+   */
+  allowVotingOnDeprecatedTemplate: boolean;
+  approvalRule: ApprovalRule;
+  /**
+   * Additional custom metadata for the workflow template
+   */
+  metadata?: object;
+  /**
+   * Actions to be executed when workflow is approved
+   */
+  actions?: Array<WorkflowAction>;
+  /**
+   * Default expiry time for workflows created from this template (in hours, max 1 year)
+   */
+  defaultExpiresInHours?: number;
+  /**
+   * ID of the space to which this workflow template belongs
+   */
+  spaceId: string;
+  /**
+   * Creation timestamp
+   */
+  createdAt: string;
+  /**
+   * Last update timestamp
+   */
+  updatedAt: string;
+}
+declare namespace WorkflowTemplate {
+  type StatusEnum = 'ACTIVE' | 'PENDING_DEPRECATION' | 'DEPRECATED';
+  const StatusEnum: {
+    Active: StatusEnum;
+    PendingDeprecation: StatusEnum;
+    Deprecated: StatusEnum;
+  };
+}
+//#endregion
+//#region generated/openapi/model/workflow-ref.d.ts
+/**
+ * Referenced objects (optional, controlled by include query parameters)
+ */
+interface WorkflowRef {
+  workflowTemplate?: WorkflowTemplate;
+}
+//#endregion
+//#region generated/openapi/model/workflow.d.ts
+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;
+  /**
+   * The unique identifier of the workflow template used as parent
+   */
+  workflowTemplateId: string;
+  /**
+   * Additional custom metadata for the workflow
+   */
+  metadata: object;
+  ref?: WorkflowRef;
+  /**
+   * Creation timestamp
+   */
+  createdAt: string;
+  /**
+   * Last update timestamp
+   */
+  updatedAt: string;
+  /**
+   * Expiry timestamp
+   */
+  readonly expiresAt?: string;
+}
+//#endregion
+//#region generated/openapi/model/list-workflows-200-response.d.ts
+interface ListWorkflows200Response {
+  data: Array<Workflow>;
+  pagination: Pagination;
+}
+//#endregion
+//#region generated/openapi/model/token-response.d.ts
+/**
+ * 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: 0.0.29
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface TokenResponse {
+  /**
+   * Access token for the authenticated user
+   */
+  accessToken: string;
+  /**
+   * Refresh token used to obtain a new access token
+   */
+  refreshToken: string;
+}
+//#endregion
+//#region generated/openapi/model/user.d.ts
+/**
+ * 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: 0.0.29
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface User {
+  /**
+   * Internal unique identifier for the user.
+   */
+  readonly id: string;
+  /**
+   * User\'s display name.
+   */
+  displayName: string;
+  /**
+   * User\'s email address.
+   */
+  email: string;
+  /**
+   * Role assigned to the user within the organization.
+   */
+  orgRole: string;
+  /**
+   * Timestamp when the user was created.
+   */
+  readonly createdAt: string;
+}
+//#endregion
+//#region generated/openapi/model/workflow-create.d.ts
+/**
+ * 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: 0.0.29
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+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;
+  /**
+   * The unique identifier of the workflow template to use as parent
+   */
+  workflowTemplateId: string;
+}
+//#endregion
+export { ApprovalRule as _, Workflow as a, WorkflowAction as c, ListGroups200Response as d, Pagination as f, AndRule as g, EmailAction as h, ListWorkflows200Response as i, WebhookAction as l, GroupInfo as m, User as n, WorkflowRef as o, Group as p, TokenResponse as r, WorkflowTemplate as s, WorkflowCreate as t, UserSummary as u, GroupRequirementRule as v, OrRule as y };