@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/services/webhooks-service.ts

@@ -1,458 +0,0 @@
-// DO NOT EDIT!
-// This file is generated by "api-typescript-generator".
-// To update this file run "yarn build:openapi".
-import { z } from "zod";
-
-import * as commonHttpClient from "../core/common-http-client";
-import { CommonHttpService } from "../core/common-http-service";
-import {
-  type ContainerForRegisteredWebhooks,
-  type ContainerForWebhookIds,
-  type FailedWebhooks,
-  type PageBeanWebhook,
-  registerWebhooksValidationSchemas,
-  type WebhookRegistrationDetails,
-  type WebhooksExpirationDate,
-} from "../models/webhooks";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents webhooks. Webhooks are calls sent to a URL when an
- * event occurs in Jira for issues specified by a JQL query. Only Connect and
- * OAuth 2.0 apps can register and manage webhooks. For more information, see
- * [Webhooks](https://developer.atlassian.com/cloud/jira/platform/webhooks/#registering-a-webhook-via-the-jira-rest-api-for-connect-apps).
- */
-export class WebhooksService extends CommonHttpService {
-  /**
-   * Removes webhooks by ID. Only webhooks registered by the calling app are
-   * removed. If webhooks created by other apps are specified, they are ignored.
-   *
-   * **[Permissions](#permissions) required:** Only
-   * [Connect](https://developer.atlassian.com/cloud/jira/platform/#connect-apps)
-   * and [OAuth
-   * 2.0](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps) apps
-   * can use this operation.
-   *
-   * @path {DELETE} /rest/api/3/webhook
-   * @scopes-current read:jira-work, manage:jira-webhook
-   * @scopes-beta delete:webhook:jira
-   */
-  deleteWebhookById({
-    containerForWebhookIds,
-  }: {
-    /**
-     * @example {
-     *     "webhookIds": [
-     *         10000,
-     *         10001,
-     *         10042
-     *     ]
-     * }
-     */
-    containerForWebhookIds: ContainerForWebhookIds;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/webhook",
-        method: "DELETE",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: containerForWebhookIds,
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Returns a [paginated](#pagination) list of the webhooks registered by the
-   * calling app.
-   *
-   * **[Permissions](#permissions) required:** Only
-   * [Connect](https://developer.atlassian.com/cloud/jira/platform/#connect-apps)
-   * and [OAuth
-   * 2.0](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps) apps
-   * can use this operation.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "isLast": true,
-   *   "maxResults": 3,
-   *   "startAt": 0,
-   *   "total": 3,
-   *   "values": [
-   *     {
-   *       "events": [
-   *         "jira:issue_updated",
-   *         "jira:issue_created"
-   *       ],
-   *       "expirationDate": "2019-06-01T12:42:30.000+0000",
-   *       "fieldIdsFilter": [
-   *         "summary",
-   *         "customfield_10029"
-   *       ],
-   *       "id": 10000,
-   *       "jqlFilter": "project = PRJ"
-   *     },
-   *     {
-   *       "events": [
-   *         "jira:issue_created"
-   *       ],
-   *       "expirationDate": "2019-06-01T12:42:30.000+0000",
-   *       "id": 10001,
-   *       "jqlFilter": "issuetype = Bug"
-   *     },
-   *     {
-   *       "events": [
-   *         "issue_property_set"
-   *       ],
-   *       "expirationDate": "2019-06-01T12:42:30.000+0000",
-   *       "id": 10002,
-   *       "issuePropertyKeysFilter": [
-   *         "my-issue-property-key"
-   *       ],
-   *       "jqlFilter": "project = PRJ"
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/webhook
-   * @scopes-current read:jira-work, manage:jira-webhook
-   * @scopes-beta read:webhook:jira, read:jql:jira
-   */
-  getDynamicWebhooksForApp({
-    startAt,
-    maxResults,
-  }: {
-    /** The index of the first item to return in a page of results (page offset). */
-    startAt?: number;
-    /** The maximum number of items to return per page. */
-    maxResults?: number;
-  }): Promise<PageBeanWebhook> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/webhook",
-        method: "GET",
-        query: {
-          startAt,
-          maxResults,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PageBeanWebhook;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "WebhooksService.getDynamicWebhooksForApp.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns webhooks that have recently failed to be delivered to the requesting
-   * app after the maximum number of retries.
-   *
-   * After 72 hours the failure may no longer be returned by this operation.
-   *
-   * The oldest failure is returned first.
-   *
-   * This method uses a cursor-based pagination. To request the next page use the
-   * failure time of the last webhook on the list as the `failedAfter` value or use
-   * the URL provided in `next`.
-   *
-   * **[Permissions](#permissions) required:** Only [Connect
-   * apps](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps)
-   * can use this operation.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "values": [
-   *     {
-   *       "id": "1",
-   *       "body": "{\"data\":\"webhook data\"}",
-   *       "url": "https://example.com",
-   *       "failureTime": 1573118132000
-   *     },
-   *     {
-   *       "id": "2",
-   *       "url": "https://example.com",
-   *       "failureTime": 1573540473480
-   *     }
-   *   ],
-   *   "maxResults": 100,
-   *   "next":
-   * "https://your-domain.atlassian.net/rest/api/3/webhook/failed?failedAfter=1573540473480&maxResults=100"
-   * }
-   * @path {GET} /rest/api/3/webhook/failed
-   * @scopes-current read:jira-work, manage:jira-webhook
-   * @scopes-beta read:issue-details:jira, read:webhook:jira, read:comment.property:jira,
-   * read:group:jira, read:issue-type:jira, read:project-role:jira,
-   * read:epic:jira-software
-   */
-  getFailedWebhooks({
-    maxResults,
-    after,
-  }: {
-    /**
-     * The maximum number of webhooks to return per page. If obeying the maxResults
-     * directive would result in records with the same failure time being split across
-     * pages, the directive is ignored and all records with the same failure time
-     * included on the page.
-     */
-    maxResults?: number;
-    /**
-     * The time after which any webhook failure must have occurred for the record to
-     * be returned, expressed as milliseconds since the UNIX epoch.
-     */
-    after?: number;
-  }): Promise<FailedWebhooks> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/webhook/failed",
-        method: "GET",
-        query: {
-          maxResults,
-          after,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: FailedWebhooks;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "WebhooksService.getFailedWebhooks.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Extends the life of webhook. Webhooks registered through the REST API expire
-   * after 30 days. Call this operation to keep them alive.
-   *
-   * Unrecognized webhook IDs (those that are not found or belong to other apps) are
-   * ignored.
-   *
-   * **[Permissions](#permissions) required:** Only
-   * [Connect](https://developer.atlassian.com/cloud/jira/platform/#connect-apps)
-   * and [OAuth
-   * 2.0](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps) apps
-   * can use this operation.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "expirationDate": "2019-06-01T12:42:30.000+0000"
-   * }
-   * @path {PUT} /rest/api/3/webhook/refresh
-   * @scopes-current read:jira-work, manage:jira-webhook
-   * @scopes-beta write:webhook:jira, read:webhook:jira
-   */
-  refreshWebhooks({
-    containerForWebhookIds,
-  }: {
-    /**
-     * @example {
-     *     "webhookIds": [
-     *         10000,
-     *         10001,
-     *         10042
-     *     ]
-     * }
-     */
-    containerForWebhookIds: ContainerForWebhookIds;
-  }): Promise<WebhooksExpirationDate> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/webhook/refresh",
-        method: "PUT",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: containerForWebhookIds,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: WebhooksExpirationDate;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "WebhooksService.refreshWebhooks.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Registers webhooks.
-   *
-   * **NOTE:** for non-public OAuth apps, webhooks are delivered only if there is a
-   * match between the app owner and the user who registered a dynamic webhook.
-   *
-   * **[Permissions](#permissions) required:** Only
-   * [Connect](https://developer.atlassian.com/cloud/jira/platform/#connect-apps)
-   * and [OAuth
-   * 2.0](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps) apps
-   * can use this operation.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "webhookRegistrationResult": [
-   *     {
-   *       "createdWebhookId": 1000
-   *     },
-   *     {
-   *       "errors": [
-   *         "The clause watchCount is unsupported"
-   *       ]
-   *     },
-   *     {
-   *       "createdWebhookId": 1001
-   *     }
-   *   ]
-   * }
-   * @path {POST} /rest/api/3/webhook
-   * @scopes-current read:jira-work, manage:jira-webhook
-   * @scopes-beta read:field:jira, read:project:jira, write:webhook:jira
-   */
-  registerDynamicWebhooks({
-    webhookRegistrationDetails,
-  }: {
-    /**
-     * @example {
-     *     "url": "https://your-app.example.com/webhook-received",
-     *     "webhooks": [
-     *         {
-     *             "events": [
-     *                 "jira:issue_created",
-     *                 "jira:issue_updated"
-     *             ],
-     *             "fieldIdsFilter": [
-     *                 "summary",
-     *                 "customfield_10029"
-     *             ],
-     *             "jqlFilter": "project = PROJ"
-     *         },
-     *         {
-     *             "events": [
-     *                 "jira:issue_deleted"
-     *             ],
-     *             "jqlFilter": "project IN (PROJ, EXP) AND status = done"
-     *         },
-     *         {
-     *             "events": [
-     *                 "issue_property_set"
-     *             ],
-     *             "issuePropertyKeysFilter": [
-     *                 "my-issue-property-key"
-     *             ],
-     *             "jqlFilter": "project = PROJ"
-     *         }
-     *     ]
-     * }
-     */
-    webhookRegistrationDetails: WebhookRegistrationDetails;
-  }): Promise<ContainerForRegisteredWebhooks> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/webhook",
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: webhookRegistrationDetails,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ContainerForRegisteredWebhooks;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "WebhooksService.registerDynamicWebhooks.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "WebhooksService.getDynamicWebhooksForApp.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("PageBeanWebhook"),
-        })
-        .describe("WebhooksService.getDynamicWebhooksForApp.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "WebhooksService.registerDynamicWebhooks.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("ContainerForRegisteredWebhooks"),
-        })
-        .describe("WebhooksService.registerDynamicWebhooks.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "WebhooksService.getFailedWebhooks.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("FailedWebhooks"),
-        })
-        .describe("WebhooksService.getFailedWebhooks.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "WebhooksService.refreshWebhooks.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("WebhooksExpirationDate"),
-        })
-        .describe("WebhooksService.refreshWebhooks.response"),
-    );
-    validationSchemaStorage.registerOnce([registerWebhooksValidationSchemas]);
-  }
-}