constructor

• new BitbucketCloudClient(clientOptions?: ClientOptions): BitbucketCloudClient

  Parameters

  • OptionalclientOptions: ClientOptions

  Returns BitbucketCloudClient

Readonlyopenapi

bulkCreateOrUpdateAnnotations

• bulkCreateOrUpdateAnnotations(
      ...init: [
          {
              params: {
                  cookie?: undefined;
                  header?: undefined;
                  path: {
                      commit: string;
                      repo_slug: string;
                      reportId: string;
                      workspace: string;
                  };
                  query?: undefined;
              };
          } & {
              body: {
                  "[iterator]": {} & {};
                  "[unscopables]": {
                      "[iterator]"?: boolean;
                      "[unscopables]"?: boolean;
                      at?: boolean;
                      concat?: boolean;
                      entries?: boolean;
                      every?: boolean;
                      filter?: boolean;
                      find?: boolean;
                      findIndex?: boolean;
                      findLast?: boolean;
                      findLastIndex?: boolean;
                      flat?: boolean;
                      flatMap?: boolean;
                      forEach?: boolean;
                      includes?: boolean;
                      indexOf?: boolean;
                      join?: boolean;
                      keys?: boolean;
                      lastIndexOf?: boolean;
                      length?: boolean;
                      map?: boolean;
                      reduce?: boolean;
                      reduceRight?: boolean;
                      slice?: boolean;
                      some?: boolean;
                      toLocaleString?: boolean;
                      toReversed?: boolean;
                      toSorted?: boolean;
                      toSpliced?: boolean;
                      toString?: boolean;
                      values?: boolean;
                      with?: boolean;
                      readonly [key: number]: boolean
                      | undefined;
                  } & {};
                  at: {} & {};
                  concat: {} & {};
                  entries: {} & {};
                  every: {} & {};
                  filter: {} & {};
                  find: {} & {};
                  findIndex: {} & {};
                  findLast: {} & {};
                  findLastIndex: {} & {};
                  flat: {} & {};
                  flatMap: {} & {};
                  forEach: {} & {};
                  includes: {} & {};
                  indexOf: {} & {};
                  join: {} & {};
                  keys: {} & {};
                  lastIndexOf: {} & {};
                  length: number;
                  map: {} & {};
                  reduce: {} & {};
                  reduceRight: {} & {};
                  slice: {} & {};
                  some: {} & {};
                  toLocaleString: {} & {};
                  toReversed: {} & {};
                  toSorted: {} & {};
                  toSpliced: {} & {};
                  toString: {} & {};
                  values: {} & {};
                  with: {} & {};
                  readonly [key: number]: {
                      annotation_type?: "BUG"
                      | "CODE_SMELL"
                      | "VULNERABILITY";
                      created_on?: string;
                      details?: string;
                      external_id?: string;
                      line?: number;
                      link?: string;
                      path?: string;
                      result?: "FAILED" | "PASSED" | "IGNORED" | "SKIPPED";
                      severity?: "CRITICAL" | "HIGH" | "LOW" | "MEDIUM";
                      summary?: string;
                      type: "report_annotation";
                      updated_on?: string;
                      uuid?: string;
                      readonly [key: string]: unknown;
                  } & {};
              } & {};
          } & {
              baseUrl?: string;
              bodySerializer?: BodySerializer<
                  {
                      parameters: {
                          cookie?: undefined;
                          header?: undefined;
                          path: {
                              commit: string;
                              repo_slug: string;
                              reportId: string;
                              workspace: string;
                          };
                          query?: undefined;
                      };
                      requestBody: {
                          content: {
                              "application/json": readonly (
                                  { type: ... } & Omit<(...), (...)> & Readonly<(...)> & {
                                      annotation_type?: ...;
                                      created_on?: ...;
                                      details?: ...;
                                      external_id?: ...;
                                      line?: ...;
                                      link?: ...;
                                      path?: ...;
                                      result?: ...;
                                      severity?: ...;
                                      summary?: ...;
                                      updated_on?: ...;
                                      uuid?: ...;
                                  }
                              )[];
                          };
                      };
                      responses: {
                          "200": {
                              content: {
                                  "application/json": readonly ((...) & (...) & (...) & (...))[];
                              };
                              headers: Readonly<Record<string, unknown>>;
                          };
                      };
                  },
              >;
              fetch?: (input: Request) => Promise<Response>;
              headers?: HeadersOptions;
              middleware?: Middleware[];
              parseAs?: keyof BodyType<unknown>;
              pathSerializer?: PathSerializer;
              querySerializer?:
                  | QuerySerializerOptions
                  | QuerySerializer<
                      {
                          parameters: {
                              cookie?: undefined;
                              header?: undefined;
                              path: {
                                  commit: string;
                                  repo_slug: string;
                                  reportId: string;
                                  workspace: string;
                              };
                              query?: undefined;
                          };
                          requestBody: {
                              content: {
                                  "application/json": readonly (
                                      { type: ... } & Omit<(...), (...)> & Readonly<(...)> & {
                                          annotation_type?: ...;
                                          created_on?: ...;
                                          details?: ...;
                                          external_id?: ...;
                                          line?: ...;
                                          link?: ...;
                                          path?: ...;
                                          result?: ...;
                                          severity?: ...;
                                          summary?: ...;
                                          updated_on?: ...;
                                          uuid?: ...;
                                      }
                                  )[];
                              };
                          };
                          responses: {
                              "200": {
                                  content: {
                                      "application/json": readonly ((...) & (...) & (...) & (...))[];
                                  };
                                  headers: Readonly<Record<string, unknown>>;
                              };
                          };
                      },
                  >;
          } & Omit<RequestInit, "body" | "headers"> & { [key: string]: unknown },
      ],
  ): Promise<
      FetchResponse<
          {
              parameters: {
                  cookie?: undefined;
                  header?: undefined;
                  path: {
                      commit: string;
                      repo_slug: string;
                      reportId: string;
                      workspace: string;
                  };
                  query?: undefined;
              };
              requestBody: {
                  content: {
                      "application/json": readonly (
                          { type: "report_annotation" } & Omit<
                              Readonly<Record<(...), (...)>> & { type: string },
                              "type",
                          > & Readonly<Record<string, unknown>> & {
                              annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                              created_on?: string;
                              details?: string;
                              external_id?: string;
                              line?: number;
                              link?: string;
                              path?: string;
                              result?: "FAILED" | "PASSED" | "IGNORED" | "SKIPPED";
                              severity?: "CRITICAL" | "HIGH" | "LOW" | "MEDIUM";
                              summary?: string;
                              updated_on?: string;
                              uuid?: string;
                          }
                      )[];
                  };
              };
              responses: {
                  "200": {
                      content: {
                          "application/json": readonly (
                              { type: "report_annotation" } & Omit<
                                  Readonly<(...)> & { type: ... },
                                  "type",
                              > & Readonly<Record<string, unknown>> & {
                                  annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                                  created_on?: string;
                                  details?: string;
                                  external_id?: string;
                                  line?: number;
                                  link?: string;
                                  path?: string;
                                  result?: "FAILED" | "PASSED" | "IGNORED" | "SKIPPED";
                                  severity?: "CRITICAL" | "HIGH" | "LOW" | "MEDIUM";
                                  summary?: string;
                                  updated_on?: string;
                                  uuid?: string;
                              }
                          )[];
                      };
                      headers: Readonly<Record<string, unknown>>;
                  };
              };
          },
          FetchOptions<
              {
                  parameters: {
                      cookie?: undefined;
                      header?: undefined;
                      path: {
                          commit: string;
                          repo_slug: string;
                          reportId: string;
                          workspace: string;
                      };
                      query?: undefined;
                  };
                  requestBody: {
                      content: {
                          "application/json": readonly (
                              { type: "report_annotation" } & Omit<
                                  Readonly<(...)> & { type: ... },
                                  "type",
                              > & Readonly<Record<string, unknown>> & {
                                  annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                                  created_on?: string;
                                  details?: string;
                                  external_id?: string;
                                  line?: number;
                                  link?: string;
                                  path?: string;
                                  result?: "FAILED" | "PASSED" | "IGNORED" | "SKIPPED";
                                  severity?: "CRITICAL" | "HIGH" | "LOW" | "MEDIUM";
                                  summary?: string;
                                  updated_on?: string;
                                  uuid?: string;
                              }
                          )[];
                      };
                  };
                  responses: {
                      "200": {
                          content: {
                              "application/json": readonly (
                                  { type: "report_annotation" } & Omit<(...) & (...), "type"> & Readonly<
                                      Record<(...), (...)>,
                                  > & {
                                      annotation_type?: (...) | (...) | (...) | (...);
                                      created_on?: (...) | (...);
                                      details?: (...) | (...);
                                      external_id?: (...) | (...);
                                      line?: (...) | (...);
                                      link?: (...) | (...);
                                      path?: (...) | (...);
                                      result?: (...) | (...) | (...) | (...) | (...);
                                      severity?: (...) | (...) | (...) | (...) | (...);
                                      summary?: (...) | (...);
                                      updated_on?: (...) | (...);
                                      uuid?: (...) | (...);
                                  }
                              )[];
                          };
                          headers: Readonly<Record<string, unknown>>;
                      };
                  };
              },
          >,
          "application/json",
      >,
  >

  Bulk create or update annotations

  Bulk upload of annotations. Annotations are individual findings that have been identified as part of a report, for example, a line of code that represents a vulnerability. These annotations can be attached to a specific file and even a specific line in that file, however, that is optional. Annotations are not mandatory and a report can contain up to 1000 annotations.

  Add the annotations you want to upload as objects in a JSON array and make sure each annotation has the external_id field set to a unique value. If you want to use an existing id from your own system, we recommend prefixing it with your system's name to avoid collisions, for example, mySystem-annotation001. The external id can later be used to identify the report as an alternative to the generated UUID. You can upload up to 100 annotations per POST request.

  Sample cURL request:

  curl --location 'https://api.bitbucket.org/2.0/repositories/<username>/<reposity-name>/commit/<commit-hash>/reports/mysystem-001/annotations' \
  --header 'Content-Type: application/json' \
  --data-raw '[
    {
          "external_id": "mysystem-annotation001",
          "title": "Security scan report",
          "annotation_type": "VULNERABILITY",
          "summary": "This line represents a security threat.",
          "severity": "HIGH",
        "path": "my-service/src/main/java/com/myCompany/mysystem/logic/Main.java",
          "line": 42
    },
    {
          "external_id": "mySystem-annotation002",
          "title": "Bug report",
          "annotation_type": "BUG",
          "result": "FAILED",
          "summary": "This line might introduce a bug.",
          "severity": "MEDIUM",
        "path": "my-service/src/main/java/com/myCompany/mysystem/logic/Helper.java",
          "line": 13
    }
  ]'
  Copy

  Possible field values:

  annotation_type: VULNERABILITY, CODE_SMELL, BUG result: PASSED, FAILED, IGNORED, SKIPPED severity: HIGH, MEDIUM, LOW, CRITICAL

  Please refer to the Code Insights documentation for more information.

  Parameters

  • ...init: [
        {
            params: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    reportId: string;
                    workspace: string;
                };
                query?: undefined;
            };
        } & {
            body: {
                "[iterator]": {} & {};
                "[unscopables]": {
                    "[iterator]"?: boolean;
                    "[unscopables]"?: boolean;
                    at?: boolean;
                    concat?: boolean;
                    entries?: boolean;
                    every?: boolean;
                    filter?: boolean;
                    find?: boolean;
                    findIndex?: boolean;
                    findLast?: boolean;
                    findLastIndex?: boolean;
                    flat?: boolean;
                    flatMap?: boolean;
                    forEach?: boolean;
                    includes?: boolean;
                    indexOf?: boolean;
                    join?: boolean;
                    keys?: boolean;
                    lastIndexOf?: boolean;
                    length?: boolean;
                    map?: boolean;
                    reduce?: boolean;
                    reduceRight?: boolean;
                    slice?: boolean;
                    some?: boolean;
                    toLocaleString?: boolean;
                    toReversed?: boolean;
                    toSorted?: boolean;
                    toSpliced?: boolean;
                    toString?: boolean;
                    values?: boolean;
                    with?: boolean;
                    readonly [key: number]: boolean
                    | undefined;
                } & {};
                at: {} & {};
                concat: {} & {};
                entries: {} & {};
                every: {} & {};
                filter: {} & {};
                find: {} & {};
                findIndex: {} & {};
                findLast: {} & {};
                findLastIndex: {} & {};
                flat: {} & {};
                flatMap: {} & {};
                forEach: {} & {};
                includes: {} & {};
                indexOf: {} & {};
                join: {} & {};
                keys: {} & {};
                lastIndexOf: {} & {};
                length: number;
                map: {} & {};
                reduce: {} & {};
                reduceRight: {} & {};
                slice: {} & {};
                some: {} & {};
                toLocaleString: {} & {};
                toReversed: {} & {};
                toSorted: {} & {};
                toSpliced: {} & {};
                toString: {} & {};
                values: {} & {};
                with: {} & {};
                readonly [key: number]: {
                    annotation_type?: "BUG"
                    | "CODE_SMELL"
                    | "VULNERABILITY";
                    created_on?: string;
                    details?: string;
                    external_id?: string;
                    line?: number;
                    link?: string;
                    path?: string;
                    result?: "FAILED" | "PASSED" | "IGNORED" | "SKIPPED";
                    severity?: "CRITICAL" | "HIGH" | "LOW" | "MEDIUM";
                    summary?: string;
                    type: "report_annotation";
                    updated_on?: string;
                    uuid?: string;
                    readonly [key: string]: unknown;
                } & {};
            } & {};
        } & {
            baseUrl?: string;
            bodySerializer?: BodySerializer<
                {
                    parameters: {
                        cookie?: undefined;
                        header?: undefined;
                        path: {
                            commit: string;
                            repo_slug: string;
                            reportId: string;
                            workspace: string;
                        };
                        query?: undefined;
                    };
                    requestBody: {
                        content: {
                            "application/json": readonly (
                                { type: ... } & Omit<(...), (...)> & Readonly<(...)> & {
                                    annotation_type?: ...;
                                    created_on?: ...;
                                    details?: ...;
                                    external_id?: ...;
                                    line?: ...;
                                    link?: ...;
                                    path?: ...;
                                    result?: ...;
                                    severity?: ...;
                                    summary?: ...;
                                    updated_on?: ...;
                                    uuid?: ...;
                                }
                            )[];
                        };
                    };
                    responses: {
                        "200": {
                            content: {
                                "application/json": readonly ((...) & (...) & (...) & (...))[];
                            };
                            headers: Readonly<Record<string, unknown>>;
                        };
                    };
                },
            >;
            fetch?: (input: Request) => Promise<Response>;
            headers?: HeadersOptions;
            middleware?: Middleware[];
            parseAs?: keyof BodyType<unknown>;
            pathSerializer?: PathSerializer;
            querySerializer?:
                | QuerySerializerOptions
                | QuerySerializer<
                    {
                        parameters: {
                            cookie?: undefined;
                            header?: undefined;
                            path: {
                                commit: string;
                                repo_slug: string;
                                reportId: string;
                                workspace: string;
                            };
                            query?: undefined;
                        };
                        requestBody: {
                            content: {
                                "application/json": readonly (
                                    { type: ... } & Omit<(...), (...)> & Readonly<(...)> & {
                                        annotation_type?: ...;
                                        created_on?: ...;
                                        details?: ...;
                                        external_id?: ...;
                                        line?: ...;
                                        link?: ...;
                                        path?: ...;
                                        result?: ...;
                                        severity?: ...;
                                        summary?: ...;
                                        updated_on?: ...;
                                        uuid?: ...;
                                    }
                                )[];
                            };
                        };
                        responses: {
                            "200": {
                                content: {
                                    "application/json": readonly ((...) & (...) & (...) & (...))[];
                                };
                                headers: Readonly<Record<string, unknown>>;
                            };
                        };
                    },
                >;
        } & Omit<RequestInit, "body" | "headers"> & { [key: string]: unknown },
    ]

  Returns Promise<
      FetchResponse<
          {
              parameters: {
                  cookie?: undefined;
                  header?: undefined;
                  path: {
                      commit: string;
                      repo_slug: string;
                      reportId: string;
                      workspace: string;
                  };
                  query?: undefined;
              };
              requestBody: {
                  content: {
                      "application/json": readonly (
                          { type: "report_annotation" } & Omit<
                              Readonly<Record<(...), (...)>> & { type: string },
                              "type",
                          > & Readonly<Record<string, unknown>> & {
                              annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                              created_on?: string;
                              details?: string;
                              external_id?: string;
                              line?: number;
                              link?: string;
                              path?: string;
                              result?: "FAILED" | "PASSED" | "IGNORED" | "SKIPPED";
                              severity?: "CRITICAL" | "HIGH" | "LOW" | "MEDIUM";
                              summary?: string;
                              updated_on?: string;
                              uuid?: string;
                          }
                      )[];
                  };
              };
              responses: {
                  "200": {
                      content: {
                          "application/json": readonly (
                              { type: "report_annotation" } & Omit<
                                  Readonly<(...)> & { type: ... },
                                  "type",
                              > & Readonly<Record<string, unknown>> & {
                                  annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                                  created_on?: string;
                                  details?: string;
                                  external_id?: string;
                                  line?: number;
                                  link?: string;
                                  path?: string;
                                  result?: "FAILED" | "PASSED" | "IGNORED" | "SKIPPED";
                                  severity?: "CRITICAL" | "HIGH" | "LOW" | "MEDIUM";
                                  summary?: string;
                                  updated_on?: string;
                                  uuid?: string;
                              }
                          )[];
                      };
                      headers: Readonly<Record<string, unknown>>;
                  };
              };
          },
          FetchOptions<
              {
                  parameters: {
                      cookie?: undefined;
                      header?: undefined;
                      path: {
                          commit: string;
                          repo_slug: string;
                          reportId: string;
                          workspace: string;
                      };
                      query?: undefined;
                  };
                  requestBody: {
                      content: {
                          "application/json": readonly (
                              { type: "report_annotation" } & Omit<
                                  Readonly<(...)> & { type: ... },
                                  "type",
                              > & Readonly<Record<string, unknown>> & {
                                  annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                                  created_on?: string;
                                  details?: string;
                                  external_id?: string;
                                  line?: number;
                                  link?: string;
                                  path?: string;
                                  result?: "FAILED" | "PASSED" | "IGNORED" | "SKIPPED";
                                  severity?: "CRITICAL" | "HIGH" | "LOW" | "MEDIUM";
                                  summary?: string;
                                  updated_on?: string;
                                  uuid?: string;
                              }
                          )[];
                      };
                  };
                  responses: {
                      "200": {
                          content: {
                              "application/json": readonly (
                                  { type: "report_annotation" } & Omit<(...) & (...), "type"> & Readonly<
                                      Record<(...), (...)>,
                                  > & {
                                      annotation_type?: (...) | (...) | (...) | (...);
                                      created_on?: (...) | (...);
                                      details?: (...) | (...);
                                      external_id?: (...) | (...);
                                      line?: (...) | (...);
                                      link?: (...) | (...);
                                      path?: (...) | (...);
                                      result?: (...) | (...) | (...) | (...) | (...);
                                      severity?: (...) | (...) | (...) | (...) | (...);
                                      summary?: (...) | (...);
                                      updated_on?: (...) | (...);
                                      uuid?: (...) | (...);
                                  }
                              )[];
                          };
                          headers: Readonly<Record<string, unknown>>;
                      };
                  };
              },
          >,
          "application/json",
      >,
  >

createDeploymentVariable

• createDeploymentVariable(
      ...init: [
          {
              params: {
                  cookie?: undefined;
                  header?: undefined;
                  path: { environment_uuid: string; repo_slug: string; workspace: string };
                  query?: undefined;
              };
          } & {
              body: {
                  key?: string;
                  secured?: boolean;
                  type: "deployment_variable";
                  uuid?: string;
                  value?: string;
                  readonly [key: string]: unknown;
              } & {};
          } & {
              baseUrl?: string;
              bodySerializer?: BodySerializer<
                  {
                      parameters: {
                          cookie?: undefined;
                          header?: undefined;
                          path: {
                              environment_uuid: string;
                              repo_slug: string;
                              workspace: string;
                          };
                          query?: undefined;
                      };
                      requestBody: {
                          content: {
                              "application/json": { type: "deployment_variable" } & Omit<
                                  (...) & (...),
                                  "type",
                              > & Readonly<Record<(...), (...)>> & {
                                  key?: (...) | (...);
                                  secured?: (...) | (...) | (...);
                                  uuid?: (...) | (...);
                                  value?: (...) | (...);
                              };
                          };
                      };
                      responses: {
                          "201": {
                              content: {
                                  "application/json": { type: ... } & Omit<(...), (...)> & Readonly<
                                      (...),
                                  > & { key?: ...; secured?: ...; uuid?: ...; value?: ... };
                              };
                              headers: { Location?: string; readonly [name: string]: unknown };
                          };
                          "404": {
                              content: {
                                  "application/json": Readonly<(...)> & { error?: ...; type: ... };
                              };
                              headers: Readonly<Record<string, unknown>>;
                          };
                          "409": {
                              content: {
                                  "application/json": Readonly<(...)> & { error?: ...; type: ... };
                              };
                              headers: Readonly<Record<string, unknown>>;
                          };
                      };
                  },
              >;
              fetch?: (input: Request) => Promise<Response>;
              headers?: HeadersOptions;
              middleware?: Middleware[];
              parseAs?: keyof BodyType<unknown>;
              pathSerializer?: PathSerializer;
              querySerializer?:
                  | QuerySerializerOptions
                  | QuerySerializer<
                      {
                          parameters: {
                              cookie?: undefined;
                              header?: undefined;
                              path: {
                                  environment_uuid: string;
                                  repo_slug: string;
                                  workspace: string;
                              };
                              query?: undefined;
                          };
                          requestBody: {
                              content: {
                                  "application/json": { type: "deployment_variable" } & Omit<
                                      (...) & (...),
                                      "type",
                                  > & Readonly<Record<(...), (...)>> & {
                                      key?: (...) | (...);
                                      secured?: (...) | (...) | (...);
                                      uuid?: (...) | (...);
                                      value?: (...) | (...);
                                  };
                              };
                          };
                          responses: {
                              "201": {
                                  content: {
                                      "application/json": { type: ... } & Omit<(...), (...)> & Readonly<
                                          (...),
                                      > & { key?: ...; secured?: ...; uuid?: ...; value?: ... };
                                  };
                                  headers: { Location?: string; readonly [name: string]: unknown };
                              };
                              "404": {
                                  content: {
                                      "application/json": Readonly<(...)> & { error?: ...; type: ... };
                                  };
                                  headers: Readonly<Record<string, unknown>>;
                              };
                              "409": {
                                  content: {
                                      "application/json": Readonly<(...)> & { error?: ...; type: ... };
                                  };
                                  headers: Readonly<Record<string, unknown>>;
                              };
                          };
                      },
                  >;
          } & Omit<RequestInit, "body" | "headers"> & { [key: string]: unknown },
      ],
  ): Promise<
      FetchResponse<
          {
              parameters: {
                  cookie?: undefined;
                  header?: undefined;
                  path: { environment_uuid: string; repo_slug: string; workspace: string };
                  query?: undefined;
              };
              requestBody: {
                  content: {
                      "application/json": { type: "deployment_variable" } & Omit<
                          Readonly<Record<string, unknown>> & { type: string },
                          "type",
                      > & Readonly<Record<string, unknown>> & {
                          key?: string;
                          secured?: boolean;
                          uuid?: string;
                          value?: string;
                      };
                  };
              };
              responses: {
                  "201": {
                      content: {
                          "application/json": { type: "deployment_variable" } & Omit<
                              Readonly<Record<(...), (...)>> & { type: string },
                              "type",
                          > & Readonly<Record<string, unknown>> & {
                              key?: string;
                              secured?: boolean;
                              uuid?: string;
                              value?: string;
                          };
                      };
                      headers: { Location?: string; readonly [name: string]: unknown };
                  };
                  "404": {
                      content: {
                          "application/json": Readonly<Record<string, unknown>> & {
                              error?: {
                                  data?: (...) | (...);
                                  detail?: (...) | (...);
                                  message: string;
                              };
                              type: string;
                          };
                      };
                      headers: Readonly<Record<string, unknown>>;
                  };
                  "409": {
                      content: {
                          "application/json": Readonly<Record<string, unknown>> & {
                              error?: {
                                  data?: (...) | (...);
                                  detail?: (...) | (...);
                                  message: string;
                              };
                              type: string;
                          };
                      };
                      headers: Readonly<Record<string, unknown>>;
                  };
              };
          },
          FetchOptions<
              {
                  parameters: {
                      cookie?: undefined;
                      header?: undefined;
                      path: {
                          environment_uuid: string;
                          repo_slug: string;
                          workspace: string;
                      };
                      query?: undefined;
                  };
                  requestBody: {
                      content: {
                          "application/json": { type: "deployment_variable" } & Omit<
                              Readonly<Record<(...), (...)>> & { type: string },
                              "type",
                          > & Readonly<Record<string, unknown>> & {
                              key?: string;
                              secured?: boolean;
                              uuid?: string;
                              value?: string;
                          };
                      };
                  };
                  responses: {
                      "201": {
                          content: {
                              "application/json": { type: "deployment_variable" } & Omit<
                                  Readonly<(...)> & { type: ... },
                                  "type",
                              > & Readonly<Record<string, unknown>> & {
                                  key?: string;
                                  secured?: boolean;
                                  uuid?: string;
                                  value?: string;
                              };
                          };
                          headers: { Location?: string; readonly [name: string]: unknown };
                      };
                      "404": {
                          content: {
                              "application/json": Readonly<Record<string, unknown>> & {
                                  error?: { data?: ...; detail?: ...; message: ... };
                                  type: string;
                              };
                          };
                          headers: Readonly<Record<string, unknown>>;
                      };
                      "409": {
                          content: {
                              "application/json": Readonly<Record<string, unknown>> & {
                                  error?: { data?: ...; detail?: ...; message: ... };
                                  type: string;
                              };
                          };
                          headers: Readonly<Record<string, unknown>>;
                      };
                  };
              },
          >,
          "application/json",
      >,
  >

  Create a variable for an environment

  Create a deployment environment level variable.

  Parameters

  • ...init: [
        {
            params: {
                cookie?: undefined;
                header?: undefined;
                path: { environment_uuid: string; repo_slug: string; workspace: string };
                query?: undefined;
            };
        } & {
            body: {
                key?: string;
                secured?: boolean;
                type: "deployment_variable";
                uuid?: string;
                value?: string;
                readonly [key: string]: unknown;
            } & {};
        } & {
            baseUrl?: string;
            bodySerializer?: BodySerializer<
                {
                    parameters: {
                        cookie?: undefined;
                        header?: undefined;
                        path: {
                            environment_uuid: string;
                            repo_slug: string;
                            workspace: string;
                        };
                        query?: undefined;
                    };
                    requestBody: {
                        content: {
                            "application/json": { type: "deployment_variable" } & Omit<
                                (...) & (...),
                                "type",
                            > & Readonly<Record<(...), (...)>> & {
                                key?: (...) | (...);
                                secured?: (...) | (...) | (...);
                                uuid?: (...) | (...);
                                value?: (...) | (...);
                            };
                        };
                    };
                    responses: {
                        "201": {
                            content: {
                                "application/json": { type: ... } & Omit<(...), (...)> & Readonly<
                                    (...),
                                > & { key?: ...; secured?: ...; uuid?: ...; value?: ... };
                            };
                            headers: { Location?: string; readonly [name: string]: unknown };
                        };
                        "404": {
                            content: {
                                "application/json": Readonly<(...)> & { error?: ...; type: ... };
                            };
                            headers: Readonly<Record<string, unknown>>;
                        };
                        "409": {
                            content: {
                                "application/json": Readonly<(...)> & { error?: ...; type: ... };
                            };
                            headers: Readonly<Record<string, unknown>>;
                        };
                    };
                },
            >;
            fetch?: (input: Request) => Promise<Response>;
            headers?: HeadersOptions;
            middleware?: Middleware[];
            parseAs?: keyof BodyType<unknown>;
            pathSerializer?: PathSerializer;
            querySerializer?:
                | QuerySerializerOptions
                | QuerySerializer<
                    {
                        parameters: {
                            cookie?: undefined;
                            header?: undefined;
                            path: {
                                environment_uuid: string;
                                repo_slug: string;
                                workspace: string;
                            };
                            query?: undefined;
                        };
                        requestBody: {
                            content: {
                                "application/json": { type: "deployment_variable" } & Omit<
                                    (...) & (...),
                                    "type",
                                > & Readonly<Record<(...), (...)>> & {
                                    key?: (...) | (...);
                                    secured?: (...) | (...) | (...);
                                    uuid?: (...) | (...);
                                    value?: (...) | (...);
                                };
                            };
                        };
                        responses: {
                            "201": {
                                content: {
                                    "application/json": { type: ... } & Omit<(...), (...)> & Readonly<
                                        (...),
                                    > & { key?: ...; secured?: ...; uuid?: ...; value?: ... };
                                };
                                headers: { Location?: string; readonly [name: string]: unknown };
                            };
                            "404": {
                                content: {
                                    "application/json": Readonly<(...)> & { error?: ...; type: ... };
                                };
                                headers: Readonly<Record<string, unknown>>;
                            };
                            "409": {
                                content: {
                                    "application/json": Readonly<(...)> & { error?: ...; type: ... };
                                };
                                headers: Readonly<Record<string, unknown>>;
                            };
                        };
                    },
                >;
        } & Omit<RequestInit, "body" | "headers"> & { [key: string]: unknown },
    ]

  Returns Promise<
      FetchResponse<
          {
              parameters: {
                  cookie?: undefined;
                  header?: undefined;
                  path: { environment_uuid: string; repo_slug: string; workspace: string };
                  query?: undefined;
              };
              requestBody: {
                  content: {
                      "application/json": { type: "deployment_variable" } & Omit<
                          Readonly<Record<string, unknown>> & { type: string },
                          "type",
                      > & Readonly<Record<string, unknown>> & {
                          key?: string;
                          secured?: boolean;
                          uuid?: string;
                          value?: string;
                      };
                  };
              };
              responses: {
                  "201": {
                      content: {
                          "application/json": { type: "deployment_variable" } & Omit<
                              Readonly<Record<(...), (...)>> & { type: string },
                              "type",
                          > & Readonly<Record<string, unknown>> & {
                              key?: string;
                              secured?: boolean;
                              uuid?: string;
                              value?: string;
                          };
                      };
                      headers: { Location?: string; readonly [name: string]: unknown };
                  };
                  "404": {
                      content: {
                          "application/json": Readonly<Record<string, unknown>> & {
                              error?: {
                                  data?: (...) | (...);
                                  detail?: (...) | (...);
                                  message: string;
                              };
                              type: string;
                          };
                      };
                      headers: Readonly<Record<string, unknown>>;
                  };
                  "409": {
                      content: {
                          "application/json": Readonly<Record<string, unknown>> & {
                              error?: {
                                  data?: (...) | (...);
                                  detail?: (...) | (...);
                                  message: string;
                              };
                              type: string;
                          };
                      };
                      headers: Readonly<Record<string, unknown>>;
                  };
              };
          },
          FetchOptions<
              {
                  parameters: {
                      cookie?: undefined;
                      header?: undefined;
                      path: {
                          environment_uuid: string;
                          repo_slug: string;
                          workspace: string;
                      };
                      query?: undefined;
                  };
                  requestBody: {
                      content: {
                          "application/json": { type: "deployment_variable" } & Omit<
                              Readonly<Record<(...), (...)>> & { type: string },
                              "type",
                          > & Readonly<Record<string, unknown>> & {
                              key?: string;
                              secured?: boolean;
                              uuid?: string;
                              value?: string;
                          };
                      };
                  };
                  responses: {
                      "201": {
                          content: {
                              "application/json": { type: "deployment_variable" } & Omit<
                                  Readonly<(...)> & { type: ... },
                                  "type",
                              > & Readonly<Record<string, unknown>> & {
                                  key?: string;
                                  secured?: boolean;
                                  uuid?: string;
                                  value?: string;
                              };
                          };
                          headers: { Location?: string; readonly [name: string]: unknown };
                      };
                      "404": {
                          content: {
                              "application/json": Readonly<Record<string, unknown>> & {
                                  error?: { data?: ...; detail?: ...; message: ... };
                                  type: string;
                              };
                          };
                          headers: Readonly<Record<string, unknown>>;
                      };
                      "409": {
                          content: {
                              "application/json": Readonly<Record<string, unknown>> & {
                                  error?: { data?: ...; detail?: ...; message: ... };
                                  type: string;
                              };
                          };
                          headers: Readonly<Record<string, unknown>>;
                      };
                  };
              },
          >,
          "application/json",
      >,
  >

createEnvironment

• createEnvironment(
      ...init: [
          {
              params: {
                  cookie?: undefined;
                  header?: undefined;
                  path: { repo_slug: string; workspace: string };
                  query?: undefined;
              };
          } & {
              body: {
                  name?: string;
                  type: "deployment_environment";
                  uuid?: string;
                  readonly [key: string]: unknown;
              } & {};
          } & {
              baseUrl?: string;
              bodySerializer?: BodySerializer<
                  {
                      parameters: {
                          cookie?: undefined;
                          header?: undefined;
                          path: { repo_slug: string; workspace: string };
                          query?: undefined;
                      };
                      requestBody: {
                          content: {
                              "application/json": { type: "deployment_environment" } & Omit<
                                  (...) & (...),
                                  "type",
                              > & Readonly<Record<(...), (...)>> & {
                                  name?: (...) | (...);
                                  uuid?: (...) | (...);
                              };
                          };
                      };
                      responses: {
                          "201": {
                              content: {
                                  "application/json": { type: ... } & Omit<(...), (...)> & Readonly<
                                      (...),
                                  > & { name?: ...; uuid?: ... };
                              };
                              headers: { Location?: string; readonly [name: string]: unknown };
                          };
                          "404": {
                              content: {
                                  "application/json": Readonly<(...)> & { error?: ...; type: ... };
                              };
                              headers: Readonly<Record<string, unknown>>;
                          };
                          "409": {
                              content: {
                                  "application/json": Readonly<(...)> & { error?: ...; type: ... };
                              };
                              headers: Readonly<Record<string, unknown>>;
                          };
                      };
                  },
              >;
              fetch?: (input: Request) => Promise<Response>;
              headers?: HeadersOptions;
              middleware?: Middleware[];
              parseAs?: keyof BodyType<unknown>;
              pathSerializer?: PathSerializer;
              querySerializer?:
                  | QuerySerializerOptions
                  | QuerySerializer<
                      {
                          parameters: {
                              cookie?: undefined;
                              header?: undefined;
                              path: { repo_slug: string; workspace: string };
                              query?: undefined;
                          };
                          requestBody: {
                              content: {
                                  "application/json": { type: "deployment_environment" } & Omit<
                                      (...) & (...),
                                      "type",
                                  > & Readonly<Record<(...), (...)>> & {
                                      name?: (...) | (...);
                                      uuid?: (...) | (...);
                                  };
                              };
                          };
                          responses: {
                              "201": {
                                  content: {
                                      "application/json": { type: ... } & Omit<(...), (...)> & Readonly<
                                          (...),
                                      > & { name?: ...; uuid?: ... };
                                  };
                                  headers: { Location?: string; readonly [name: string]: unknown };
                              };
                              "404": {
                                  content: {
                                      "application/json": Readonly<(...)> & { error?: ...; type: ... };
                                  };
                                  headers: Readonly<Record<string, unknown>>;
                              };
                              "409": {
                                  content: {
                                      "application/json": Readonly<(...)> & { error?: ...; type: ... };
                                  };
                                  headers: Readonly<Record<string, unknown>>;
                              };
                          };
                      },
                  >;
          } & Omit<RequestInit, "body" | "headers"> & { [key: string]: unknown },
      ],
  ): Promise<
      FetchResponse<
          {
              parameters: {
                  cookie?: undefined;
                  header?: undefined;
                  path: { repo_slug: string; workspace: string };
                  query?: undefined;
              };
              requestBody: {
                  content: {
                      "application/json": { type: "deployment_environment" } & Omit<
                          Readonly<Record<string, unknown>> & { type: string },
                          "type",
                      > & Readonly<Record<string, unknown>> & {
                          name?: string;
                          uuid?: string;
                      };
                  };
              };
              responses: {
                  "201": {
                      content: {
                          "application/json": { type: "deployment_environment" } & Omit<
                              Readonly<Record<(...), (...)>> & { type: string },
                              "type",
                          > & Readonly<Record<string, unknown>> & {
                              name?: string;
                              uuid?: string;
                          };
                      };
                      headers: { Location?: string; readonly [name: string]: unknown };
                  };
                  "404": {
                      content: {
                          "application/json": Readonly<Record<string, unknown>> & {
                              error?: {
                                  data?: (...) | (...);
                                  detail?: (...) | (...);
                                  message: string;
                              };
                              type: string;
                          };
                      };
                      headers: Readonly<Record<string, unknown>>;
                  };
                  "409": {
                      content: {
                          "application/json": Readonly<Record<string, unknown>> & {
                              error?: {
                                  data?: (...) | (...);
                                  detail?: (...) | (...);
                                  message: string;
                              };
                              type: string;
                          };
                      };
                      headers: Readonly<Record<string, unknown>>;
                  };
              };
          },
          FetchOptions<
              {
                  parameters: {
                      cookie?: undefined;
                      header?: undefined;
                      path: { repo_slug: string; workspace: string };
                      query?: undefined;
                  };
                  requestBody: {
                      content: {
                          "application/json": { type: "deployment_environment" } & Omit<
                              Readonly<Record<(...), (...)>> & { type: string },
                              "type",
                          > & Readonly<Record<string, unknown>> & {
                              name?: string;
                              uuid?: string;
                          };
                      };
                  };
                  responses: {
                      "201": {
                          content: {
                              "application/json": { type: "deployment_environment" } & Omit<
                                  Readonly<(...)> & { type: ... },
                                  "type",
                              > & Readonly<Record<string, unknown>> & {
                                  name?: string;
                                  uuid?: string;
                              };
                          };
                          headers: { Location?: string; readonly [name: string]: unknown };
                      };
                      "404": {
                          content: {
                              "application/json": Readonly<Record<string, unknown>> & {
                                  error?: { data?: ...; detail?: ...; message: ... };
                                  type: string;
                              };
                          };
                          headers: Readonly<Record<string, unknown>>;
                      };
                      "409": {
                          content: {
                              "application/json": Readonly<Record<string, unknown>> & {
                                  error?: { data?: ...; detail?: ...; message: ... };
                                  type: string;
                              };
                          };
                          headers: Readonly<Record<string, unknown>>;
                      };
                  };
              },
          >,
          "application/json",
      >,
  >

  Create an environment

  Create an environment.

  Parameters

  • ...init: [
        {
            params: {
                cookie?: undefined;
                header?: undefined;
                path: { repo_slug: string; workspace: string };
                query?: undefined;
            };
        } & {
            body: {
                name?: string;
                type: "deployment_environment";
                uuid?: string;
                readonly [key: string]: unknown;
            } & {};
        } & {
            baseUrl?: string;
            bodySerializer?: BodySerializer<
                {
                    parameters: {
                        cookie?: undefined;
                        header?: undefined;
                        path: { repo_slug: string; workspace: string };
                        query?: undefined;
                    };
                    requestBody: {
                        content: {
                            "application/json": { type: "deployment_environment" } & Omit<
                                (...) & (...),
                                "type",
                            > & Readonly<Record<(...), (...)>> & {
                                name?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    responses: {
                        "201": {
                            content: {
                                "application/json": { type: ... } & Omit<(...), (...)> & Readonly<
                                    (...),
                                > & { name?: ...; uuid?: ... };
                            };
                            headers: { Location?: string; readonly [name: string]: unknown };
                        };
                        "404": {
                            content: {
                                "application/json": Readonly<(...)> & { error?: ...; type: ... };
                            };
                            headers: Readonly<Record<string, unknown>>;
                        };
                        "409": {
                            content: {
                                "application/json": Readonly<(...)> & { error?: ...; type: ... };
                            };
                            headers: Readonly<Record<string, unknown>>;
                        };
                    };
                },
            >;
            fetch?: (input: Request) => Promise<Response>;
            headers?: HeadersOptions;
            middleware?: Middleware[];
            parseAs?: keyof BodyType<unknown>;
            pathSerializer?: PathSerializer;
            querySerializer?:
                | QuerySerializerOptions
                | QuerySerializer<
                    {
                        parameters: {
                            cookie?: undefined;
                            header?: undefined;
                            path: { repo_slug: string; workspace: string };
                            query?: undefined;
                        };
                        requestBody: {
                            content: {
                                "application/json": { type: "deployment_environment" } & Omit<
                                    (...) & (...),
                                    "type",
                                > & Readonly<Record<(...), (...)>> & {
                                    name?: (...) | (...);
                                    uuid?: (...) | (...);
                                };
                            };
                        };
                        responses: {
                            "201": {
                                content: {
                                    "application/json": { type: ... } & Omit<(...), (...)> & Readonly<
                                        (...),
                                    > & { name?: ...; uuid?: ... };
                                };
                                headers: { Location?: string; readonly [name: string]: unknown };
                            };
                            "404": {
                                content: {
                                    "application/json": Readonly<(...)> & { error?: ...; type: ... };
                                };
                                headers: Readonly<Record<string, unknown>>;
                            };
                            "409": {
                                content: {
                                    "application/json": Readonly<(...)> & { error?: ...; type: ... };
                                };
                                headers: Readonly<Record<string, unknown>>;
                            };
                        };
                    },
                >;
        } & Omit<RequestInit, "body" | "headers"> & { [key: string]: unknown },
    ]

  Returns Promise<
      FetchResponse<
          {
              parameters: {
                  cookie?: undefined;
                  header?: undefined;
                  path: { repo_slug: string; workspace: string };
                  query?: undefined;
              };
              requestBody: {
                  content: {
                      "application/json": { type: "deployment_environment" } & Omit<
                          Readonly<Record<string, unknown>> & { type: string },
                          "type",
                      > & Readonly<Record<string, unknown>> & {
                          name?: string;
                          uuid?: string;
                      };
                  };
              };
              responses: {
                  "201": {
                      content: {
                          "application/json": { type: "deployment_environment" } & Omit<
                              Readonly<Record<(...), (...)>> & { type: string },
                              "type",
                          > & Readonly<Record<string, unknown>> & {
                              name?: string;
                              uuid?: string;
                          };
                      };
                      headers: { Location?: string; readonly [name: string]: unknown };
                  };
                  "404": {
                      content: {
                          "application/json": Readonly<Record<string, unknown>> & {
                              error?: {
                                  data?: (...) | (...);
                                  detail?: (...) | (...);
                                  message: string;
                              };
                              type: string;
                          };
                      };
                      headers: Readonly<Record<string, unknown>>;
                  };
                  "409": {
                      content: {
                          "application/json": Readonly<Record<string, unknown>> & {
                              error?: {
                                  data?: (...) | (...);
                                  detail?: (...) | (...);
                                  message: string;
                              };
                              type: string;
                          };
                      };
                      headers: Readonly<Record<string, unknown>>;
                  };
              };
          },
          FetchOptions<
              {
                  parameters: {
                      cookie?: undefined;
                      header?: undefined;
                      path: { repo_slug: string; workspace: string };
                      query?: undefined;
                  };
                  requestBody: {
                      content: {
                          "application/json": { type: "deployment_environment" } & Omit<
                              Readonly<Record<(...), (...)>> & { type: string },
                              "type",
                          > & Readonly<Record<string, unknown>> & {
                              name?: string;
                              uuid?: string;
                          };
                      };
                  };
                  responses: {
                      "201": {
                          content: {
                              "application/json": { type: "deployment_environment" } & Omit<
                                  Readonly<(...)> & { type: ... },
                                  "type",
                              > & Readonly<Record<string, unknown>> & {
                                  name?: string;
                                  uuid?: string;
                              };
                          };
                          headers: { Location?: string; readonly [name: string]: unknown };
                      };
                      "404": {
                          content: {
                              "application/json": Readonly<Record<string, unknown>> & {
                                  error?: { data?: ...; detail?: ...; message: ... };
                                  type: string;
                              };
                          };
                          headers: Readonly<Record<string, unknown>>;
                      };
                      "409": {
                          content: {
                              "application/json": Readonly<Record<string, unknown>> & {
                                  error?: { data?: ...; detail?: ...; message: ... };
                                  type: string;
                              };
                          };
                          headers: Readonly<Record<string, unknown>>;
                      };
                  };
              },
          >,
          "application/json",
      >,
  >