@resolution/jira-api-client 0.1.0

package/src/openapi/software/services/feature-flags-service.ts

@@ -0,0 +1,303 @@
+// 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 { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * Apis related to integrating Feature Flags with Jira Software. These apis are
+ * only available to Atlassian Connect apps. To use these apis you must have the
+ * Feature Flag module (see
+ * https://developer.atlassian.com/cloud/jira/software/modules/feature-flag/) in
+ * your app's descriptor
+ */
+export class FeatureFlagsService extends CommonHttpService {
+  /**
+   * Delete the Feature Flag data currently stored for the given ID.
+   *
+   * Deletion is performed asynchronously. The getFeatureFlagById operation can be
+   * used to confirm that data has been deleted successfully (if needed).
+   *
+   * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
+   * access this resource.
+   * This resource requires the 'DELETE' scope for Connect apps.
+   *
+   * @path {DELETE} /rest/featureflags/0.1/flag/{featureFlagId}
+   */
+  deleteFeatureFlagById({
+    featureFlagId,
+    updateSequenceId,
+    authorization,
+  }: {
+    /** The ID of the Feature Flag to delete. */
+    featureFlagId: string;
+    /**
+     * This parameter usage is no longer supported.
+     *
+     * An optional `_updateSequenceId` to use to control deletion.
+     *
+     * Only stored data with an `updateSequenceId` less than or equal to that provided
+     * will be deleted.
+     * This can be used help ensure submit/delete requests are applied correctly if
+     * issued close together.
+     *
+     * @deprecated
+     */
+    updateSequenceId?: number;
+    /**
+     * All requests must be signed with a Connect JWT token that corresponds to the
+     * Provider app installed in Jira.
+     *
+     * If the JWT token corresponds to an app that does not define Feature Flags
+     * module it will be rejected with a 403.
+     *
+     * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
+     * details.
+     */
+    authorization: string;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/featureflags/0.1/flag/{featureFlagId}",
+        method: "DELETE",
+        pathParams: {
+          featureFlagId,
+        },
+        query: {
+          _updateSequenceId: updateSequenceId,
+        },
+        headers: {
+          Authorization: authorization,
+        },
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * Bulk delete all Feature Flags that match the given request.
+   *
+   * One or more query params must be supplied to specify Properties to delete by.
+   * Optional param `_updateSequenceId` is no longer supported.
+   * If more than one Property is provided, data will be deleted that matches ALL of
+   * the Properties (e.g. treated as an AND).
+   * See the documentation for the submitFeatureFlags operation for more details.
+   *
+   * e.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
+   *
+   * Deletion is performed asynchronously. The getFeatureFlagById operation can be
+   * used to confirm that data has been deleted successfully (if needed).
+   *
+   * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
+   * access this resource.
+   * This resource requires the 'DELETE' scope for Connect apps.
+   *
+   * @path {DELETE} /rest/featureflags/0.1/bulkByProperties
+   */
+  deleteFeatureFlagsByProperty({
+    updateSequenceId,
+    authorization,
+  }: {
+    /**
+     * This parameter usage is no longer supported.
+     *
+     * An optional `_updateSequenceId` to use to control deletion.
+     *
+     * Only stored data with an `updateSequenceId` less than or equal to that provided
+     * will be deleted.
+     * This can be used help ensure submit/delete requests are applied correctly if
+     * issued close together.
+     *
+     * If not provided, all stored data that matches the request will be deleted.
+     *
+     * @deprecated
+     */
+    updateSequenceId?: number;
+    /**
+     * All requests must be signed with a Connect JWT token that corresponds to the
+     * Provider app installed in Jira.
+     *
+     * If the JWT token corresponds to an app that does not define Feature Flags
+     * module it will be rejected with a 403.
+     *
+     * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
+     * details.
+     */
+    authorization: string;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/featureflags/0.1/bulkByProperties",
+        method: "DELETE",
+        query: {
+          _updateSequenceId: updateSequenceId,
+        },
+        headers: {
+          Authorization: authorization,
+        },
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * Retrieve the currently stored Feature Flag data for the given ID.
+   *
+   * The result will be what is currently stored, ignoring any pending updates or
+   * deletes.
+   *
+   * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
+   * access this resource.
+   * This resource requires the 'READ' scope for Connect apps.
+   *
+   * @returns The Feature Flag data currently stored for the given ID.
+   * @path {GET} /rest/featureflags/0.1/flag/{featureFlagId}
+   */
+  getFeatureFlagById({
+    featureFlagId,
+    authorization,
+  }: {
+    /** The ID of the Feature Flag to fetch. */
+    featureFlagId: string;
+    /**
+     * All requests must be signed with a Connect JWT token that corresponds to the
+     * Provider app installed in Jira.
+     *
+     * If the JWT token corresponds to an app that does not define Feature Flags
+     * module it will be rejected with a 403.
+     *
+     * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
+     * details.
+     */
+    authorization: string;
+  }): Promise<unknown> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/featureflags/0.1/flag/{featureFlagId}",
+        method: "GET",
+        pathParams: {
+          featureFlagId,
+        },
+        headers: {
+          Authorization: authorization,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "FeatureFlagsService.getFeatureFlagById.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Update / insert Feature Flag data.
+   *
+   * Feature Flags are identified by their ID, and existing Feature Flag data for
+   * the same ID will be replaced if it exists and the updateSequenceId of existing
+   * data is less than the incoming data.
+   *
+   * Submissions are performed asynchronously. Submitted data will eventually be
+   * available in Jira; most updates are available within a short period of time,
+   * but may take some time during peak load and/or maintenance times. The
+   * getFeatureFlagById operation can be used to confirm that data has been stored
+   * successfully (if needed).
+   *
+   * In the case of multiple Feature Flags being submitted in one request, each is
+   * validated individually prior to submission. Details of which Feature Flags
+   * failed submission (if any) are available in the response object.
+   *
+   * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
+   * access this resource.
+   * This resource requires the 'WRITE' scope for Connect apps.
+   *
+   * @returns Submission accepted. Each submitted Feature Flag that is of a valid format will
+   * be eventually available in Jira.
+   *
+   * Details of which Feature Flags were submitted and which failed submission (due
+   * to data format problems etc.) are available in the response object.
+   * @path {POST} /rest/featureflags/0.1/bulk
+   */
+  submitFeatureFlags({
+    authorization,
+    requestBody,
+  }: {
+    /**
+     * All requests must be signed with a Connect JWT token that corresponds to the
+     * Provider app installed in Jira.
+     *
+     * If the JWT token corresponds to an app that does not define Feature Flags
+     * module it will be rejected with a 403.
+     *
+     * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
+     * details.
+     */
+    authorization: string;
+    /** Feature Flag data to submit. */
+    requestBody: unknown;
+  }): Promise<unknown> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/featureflags/0.1/bulk",
+        method: "POST",
+        headers: {
+          Authorization: authorization,
+          "Content-Type": "application/json",
+        },
+        body: requestBody,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          202: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 202;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "FeatureFlagsService.submitFeatureFlags.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "FeatureFlagsService.submitFeatureFlags.response",
+      z
+        .object({
+          status: z.literal(202),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("FeatureFlagsService.submitFeatureFlags.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "FeatureFlagsService.getFeatureFlagById.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("FeatureFlagsService.getFeatureFlagById.response"),
+    );
+  }
+}