@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/models/webhooks.ts

@@ -1,307 +0,0 @@
-// DO NOT EDIT!
-// This file is generated by "api-typescript-generator".
-// To update this file run "yarn build:openapi".
-import { z, type ZodTypeAny } from "zod";
-
-import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
-/**
- * Container for a list of registered webhooks. Webhook details are returned in
- * the same order as the request.
- */
-export interface ContainerForRegisteredWebhooks {
-  /** A list of registered webhooks. */
-  webhookRegistrationResult?: RegisteredWebhook[];
-}
-/** Container for a list of webhook IDs. */
-export interface ContainerForWebhookIds {
-  /** A list of webhook IDs. */
-  webhookIds: number[];
-}
-/** Details about a failed webhook. */
-export interface FailedWebhook {
-  /** The webhook body. */
-  body?: string;
-  /**
-   * The time the webhook was added to the list of failed webhooks (that is, the
-   * time of the last failed retry).
-   */
-  failureTime: number;
-  /**
-   * The webhook ID, as sent in the `X-Atlassian-Webhook-Identifier` header with the
-   * webhook.
-   */
-  id: string;
-  /** The original webhook destination. */
-  url: string;
-}
-/** A page of failed webhooks. */
-export interface FailedWebhooks {
-  /**
-   * The maximum number of items on the page. If the list of values is shorter than
-   * this number, then there are no more pages.
-   */
-  maxResults: number;
-  /**
-   * The URL to the next page of results. Present only if the request returned at
-   * least one result.The next page may be empty at the time of receiving the
-   * response, but new failed webhooks may appear in time. You can save the URL to
-   * the next page and query for new results periodically (for example, every hour).
-   */
-  next?: string;
-  /** The list of webhooks. */
-  values: FailedWebhook[];
-}
-/** A page of items. */
-export interface PageBeanWebhook {
-  /** Whether this is the last page. */
-  isLast?: boolean;
-  /** The maximum number of items that could be returned. */
-  maxResults?: number;
-  /** If there is another page of results, the URL of the next page. */
-  nextPage?: string;
-  /** The URL of the page. */
-  self?: string;
-  /** The index of the first item returned. */
-  startAt?: number;
-  /** The number of items returned. */
-  total?: number;
-  /** The list of items. */
-  values?: Webhook[];
-}
-/**
- * ID of a registered webhook or error messages explaining why a webhook wasn't
- * registered.
- */
-export interface RegisteredWebhook {
-  /** The ID of the webhook. Returned if the webhook is created. */
-  createdWebhookId?: number;
-  /** Error messages specifying why the webhook creation failed. */
-  errors?: string[];
-}
-/** A webhook. */
-export interface Webhook {
-  /** The Jira events that trigger the webhook. */
-  events: (
-    | "jira:issue_created"
-    | "jira:issue_updated"
-    | "jira:issue_deleted"
-    | "comment_created"
-    | "comment_updated"
-    | "comment_deleted"
-    | "issue_property_set"
-    | "issue_property_deleted"
-  )[];
-  /**
-   * The date after which the webhook is no longer sent. Use [Extend webhook
-   * life](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/#api-rest-api-3-webhook-refresh-put)
-   * to extend the date.
-   */
-  expirationDate?: number;
-  /**
-   * A list of field IDs. When the issue changelog contains any of the fields, the
-   * webhook `jira:issue_updated` is sent. If this parameter is not present, the app
-   * is notified about all field updates.
-   */
-  fieldIdsFilter?: string[];
-  /** The ID of the webhook. */
-  id: number;
-  /**
-   * A list of issue property keys. A change of those issue properties triggers the
-   * `issue_property_set` or `issue_property_deleted` webhooks. If this parameter is
-   * not present, the app is notified about all issue property updates.
-   */
-  issuePropertyKeysFilter?: string[];
-  /** The JQL filter that specifies which issues the webhook is sent for. */
-  jqlFilter: string;
-}
-/** A list of webhooks. */
-export interface WebhookDetails {
-  /** The Jira events that trigger the webhook. */
-  events: (
-    | "jira:issue_created"
-    | "jira:issue_updated"
-    | "jira:issue_deleted"
-    | "comment_created"
-    | "comment_updated"
-    | "comment_deleted"
-    | "issue_property_set"
-    | "issue_property_deleted"
-  )[];
-  /**
-   * A list of field IDs. When the issue changelog contains any of the fields, the
-   * webhook `jira:issue_updated` is sent. If this parameter is not present, the app
-   * is notified about all field updates.
-   */
-  fieldIdsFilter?: string[];
-  /**
-   * A list of issue property keys. A change of those issue properties triggers the
-   * `issue_property_set` or `issue_property_deleted` webhooks. If this parameter is
-   * not present, the app is notified about all issue property updates.
-   */
-  issuePropertyKeysFilter?: string[];
-  /**
-   * The JQL filter that specifies which issues the webhook is sent for. Only a
-   * subset of JQL can be used. The supported elements are:
-   *
-   *  *  Fields: `issueKey`, `project`, `issuetype`, `status`, `assignee`,
-   * `reporter`, `issue.property`, and `cf[id]`. For custom fields (`cf[id]`), only
-   * the epic label custom field is supported.".
-   *  *  Operators: `=`, `!=`, `IN`, and `NOT IN`.
-   */
-  jqlFilter: string;
-}
-/** Details of webhooks to register. */
-export interface WebhookRegistrationDetails {
-  /**
-   * The URL that specifies where to send the webhooks. This URL must use the same
-   * base URL as the Connect app. Only a single URL per app is allowed to be
-   * registered.
-   */
-  url: string;
-  /** A list of webhooks. */
-  webhooks: WebhookDetails[];
-}
-/** The date the refreshed webhooks expire. */
-export interface WebhooksExpirationDate {
-  /** The expiration date of all the refreshed webhooks. */
-  expirationDate: number;
-}
-export function registerWebhooksValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "ContainerForRegisteredWebhooks",
-    z
-      .object({
-        webhookRegistrationResult: z
-          .array(validationSchemaStorage.lazy("RegisteredWebhook"))
-          .optional(),
-      })
-      .strict()
-      .describe("ContainerForRegisteredWebhooks"),
-  );
-  validationSchemaStorage.register(
-    "ContainerForWebhookIds",
-    z
-      .object({
-        webhookIds: z.array(z.number().int()),
-      })
-      .strict()
-      .describe("ContainerForWebhookIds"),
-  );
-  validationSchemaStorage.register(
-    "FailedWebhook",
-    z
-      .object({
-        body: z.string().optional(),
-        failureTime: z.number().int(),
-        id: z.string(),
-        url: z.string(),
-      })
-      .strict()
-      .describe("FailedWebhook"),
-  );
-  validationSchemaStorage.register(
-    "FailedWebhooks",
-    z
-      .object({
-        maxResults: z.number().int(),
-        next: z.string().optional(),
-        values: z.array(validationSchemaStorage.lazy("FailedWebhook")),
-      })
-      .strict()
-      .describe("FailedWebhooks"),
-  );
-  validationSchemaStorage.register(
-    "PageBeanWebhook",
-    z
-      .object({
-        isLast: z.boolean().optional(),
-        maxResults: z.number().int().optional(),
-        nextPage: z.string().optional(),
-        self: z.string().optional(),
-        startAt: z.number().int().optional(),
-        total: z.number().int().optional(),
-        values: z.array(validationSchemaStorage.lazy("Webhook")).optional(),
-      })
-      .strict()
-      .describe("PageBeanWebhook"),
-  );
-  validationSchemaStorage.register(
-    "RegisteredWebhook",
-    z
-      .object({
-        createdWebhookId: z.number().int().optional(),
-        errors: z.array(z.string()).optional(),
-      })
-      .strict()
-      .describe("RegisteredWebhook"),
-  );
-  validationSchemaStorage.register(
-    "Webhook",
-    z
-      .object({
-        events: z.array(
-          z.enum([
-            "jira:issue_created",
-            "jira:issue_updated",
-            "jira:issue_deleted",
-            "comment_created",
-            "comment_updated",
-            "comment_deleted",
-            "issue_property_set",
-            "issue_property_deleted",
-          ]),
-        ),
-        expirationDate: z.number().int().optional(),
-        fieldIdsFilter: z.array(z.string()).optional(),
-        id: z.number().int(),
-        issuePropertyKeysFilter: z.array(z.string()).optional(),
-        jqlFilter: z.string(),
-      })
-      .strict()
-      .describe("Webhook"),
-  );
-  validationSchemaStorage.register(
-    "WebhookDetails",
-    z
-      .object({
-        events: z.array(
-          z.enum([
-            "jira:issue_created",
-            "jira:issue_updated",
-            "jira:issue_deleted",
-            "comment_created",
-            "comment_updated",
-            "comment_deleted",
-            "issue_property_set",
-            "issue_property_deleted",
-          ]),
-        ),
-        fieldIdsFilter: z.array(z.string()).optional(),
-        issuePropertyKeysFilter: z.array(z.string()).optional(),
-        jqlFilter: z.string(),
-      })
-      .strict()
-      .describe("WebhookDetails"),
-  );
-  validationSchemaStorage.register(
-    "WebhookRegistrationDetails",
-    z
-      .object({
-        url: z.string(),
-        webhooks: z.array(validationSchemaStorage.lazy("WebhookDetails")),
-      })
-      .strict()
-      .describe("WebhookRegistrationDetails"),
-  );
-  validationSchemaStorage.register(
-    "WebhooksExpirationDate",
-    z
-      .object({
-        expirationDate: z.number().int(),
-      })
-      .strict()
-      .describe("WebhooksExpirationDate"),
-  );
-}

package/src/openapi/platform/models/workflow-scheme-drafts.ts

@@ -1,58 +0,0 @@
-// DO NOT EDIT!
-// This file is generated by "api-typescript-generator".
-// To update this file run "yarn build:openapi".
-import { z, type ZodTypeAny } from "zod";
-
-import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
-/** Details about the status mappings for publishing a draft workflow scheme. */
-export interface PublishDraftWorkflowScheme {
-  /** Mappings of statuses to new statuses for issue types. */
-  statusMappings?: StatusMapping[];
-}
-/** Details about the mapping from a status to a new status for an issue type. */
-export interface StatusMapping {
-  /** The ID of the issue type. */
-  issueTypeId: string;
-  /** The ID of the new status. */
-  newStatusId: string;
-  /** The ID of the status. */
-  statusId: string;
-}
-export function registerWorkflowSchemeDraftsValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "PublishDraftWorkflowScheme",
-    z
-      .object({
-        statusMappings: z
-          .array(validationSchemaStorage.lazy("StatusMapping"))
-          .superRefine((items, ctx) => {
-            if (
-              new Set(items.map((item) => JSON.stringify(item))).size !==
-              items.length
-            ) {
-              ctx.addIssue({
-                code: z.ZodIssueCode.custom,
-                path: [],
-                message: "Array items must be unique",
-              });
-            }
-          })
-          .optional(),
-      })
-      .strict()
-      .describe("PublishDraftWorkflowScheme"),
-  );
-  validationSchemaStorage.register(
-    "StatusMapping",
-    z
-      .object({
-        issueTypeId: z.string(),
-        newStatusId: z.string(),
-        statusId: z.string(),
-      })
-      .strict()
-      .describe("StatusMapping"),
-  );
-}

package/src/openapi/platform/models/workflow-scheme-project-associations.ts

@@ -1,68 +0,0 @@
-// DO NOT EDIT!
-// This file is generated by "api-typescript-generator".
-// To update this file run "yarn build:openapi".
-import { z, type ZodTypeAny } from "zod";
-
-import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
-import { registerCommonValidationSchemas, type WorkflowScheme } from "./common";
-/**
- * A container for a list of workflow schemes together with the projects they are
- * associated with.
- */
-export interface ContainerOfWorkflowSchemeAssociations {
-  /** A list of workflow schemes together with projects they are associated with. */
-  values: WorkflowSchemeAssociations[];
-}
-/** A workflow scheme along with a list of projects that use it. */
-export interface WorkflowSchemeAssociations {
-  /** The list of projects that use the workflow scheme. */
-  projectIds: string[];
-  /** The workflow scheme. */
-  workflowScheme: WorkflowScheme;
-}
-/** An associated workflow scheme and project. */
-export interface WorkflowSchemeProjectAssociation {
-  /** The ID of the project. */
-  projectId: string;
-  /**
-   * The ID of the workflow scheme. If the workflow scheme ID is `null`, the
-   * operation assigns the default workflow scheme.
-   */
-  workflowSchemeId?: string;
-}
-export function registerWorkflowSchemeProjectAssociationsValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "ContainerOfWorkflowSchemeAssociations",
-    z
-      .object({
-        values: z.array(
-          validationSchemaStorage.lazy("WorkflowSchemeAssociations"),
-        ),
-      })
-      .strict()
-      .describe("ContainerOfWorkflowSchemeAssociations"),
-  );
-  validationSchemaStorage.register(
-    "WorkflowSchemeAssociations",
-    z
-      .object({
-        projectIds: z.array(z.string()),
-        workflowScheme: validationSchemaStorage.lazy("WorkflowScheme"),
-      })
-      .strict()
-      .describe("WorkflowSchemeAssociations"),
-  );
-  validationSchemaStorage.register(
-    "WorkflowSchemeProjectAssociation",
-    z
-      .object({
-        projectId: z.string(),
-        workflowSchemeId: z.string().optional(),
-      })
-      .strict()
-      .describe("WorkflowSchemeProjectAssociation"),
-  );
-  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-}