@resolution/jira-api-client 0.1.0

package/lib/openapi/platform/services/issue-custom-field-contexts-service.d.ts

@@ -0,0 +1,659 @@
+import { CommonHttpService } from "../core/common-http-service";
+import type { IssueTypeIds } from "../models/common";
+import { type CreateCustomFieldContext, type CustomFieldContextDefaultValueUpdate, type CustomFieldContextUpdateDetails, type PageBeanContextForProjectAndIssueType, type PageBeanCustomFieldContext, type PageBeanCustomFieldContextDefaultValue, type PageBeanCustomFieldContextProjectMapping, type PageBeanIssueTypeToContextMapping, type ProjectIds, type ProjectIssueTypeMappings } from "../models/issue-custom-field-contexts";
+/**
+ * This resource represents issue custom field contexts. Use it to:
+ *
+ *  *  get, create, update, and delete custom field contexts.
+ *  *  get context to issue types and projects mappings.
+ *  *  get custom field contexts for projects and issue types.
+ *  *  assign custom field contexts to projects.
+ *  *  remove custom field contexts from projects.
+ *  *  add issue types to custom field contexts.
+ */
+export declare class IssueCustomFieldContextsService extends CommonHttpService {
+    /**
+     * Adds issue types to a custom field context, appending the issue types to the
+     * issue types list.
+     *
+     * A custom field context without any issue types applies to all issue types.
+     * Adding issue types to such a custom field context would result in it applying
+     * to only the listed issue types.
+     *
+     * If any of the issue types exists in the custom field context, the operation
+     * fails and no issue types are added.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if operation is successful.
+     * @path {PUT} /rest/api/3/field/{fieldId}/context/{contextId}/issuetype
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:field:jira
+     */
+    addIssueTypesToContext({ fieldId, contextId, issueTypeIds, }: {
+        /** The ID of the custom field. */
+        fieldId: string;
+        /** The ID of the context. */
+        contextId: number;
+        /**
+         * @example {
+         *     "issueTypeIds": [
+         *         "10001",
+         *         "10005",
+         *         "10006"
+         *     ]
+         * }
+         */
+        issueTypeIds: IssueTypeIds;
+    }): Promise<void>;
+    /**
+     * Assigns a custom field context to projects.
+     *
+     * If any project in the request is assigned to any context of the custom field,
+     * the operation fails.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if operation is successful.
+     * @path {PUT} /rest/api/3/field/{fieldId}/context/{contextId}/project
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:field:jira
+     */
+    assignProjectsToCustomFieldContext({ fieldId, contextId, projectIds, }: {
+        /** The ID of the custom field. */
+        fieldId: string;
+        /** The ID of the context. */
+        contextId: number;
+        /**
+         * @example {
+         *     "projectIds": [
+         *         "10001",
+         *         "10005",
+         *         "10006"
+         *     ]
+         * }
+         */
+        projectIds: ProjectIds;
+    }): Promise<void>;
+    /**
+     * Creates a custom field context.
+     *
+     * If `projectIds` is empty, a global context is created. A global context is one
+     * that applies to all project. If `issueTypeIds` is empty, the context applies to
+     * all issue types.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the custom field context is created.
+     *
+     * example: {
+     *   "id": "10025",
+     *   "name": "Bug fields context",
+     *   "description": "A context used to define the custom field options for bugs.",
+     *   "projectIds": [],
+     *   "issueTypeIds": [
+     *     "10010"
+     *   ]
+     * }
+     * @path {POST} /rest/api/3/field/{fieldId}/context
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:field:jira, write:field:jira,
+     * read:custom-field-contextual-configuration:jira
+     */
+    createCustomFieldContext({ fieldId, createCustomFieldContext, }: {
+        /** The ID of the custom field. */
+        fieldId: string;
+        /**
+         * @example {
+         *     "description": "A context used to define the custom field options for
+         * bugs.",
+         *     "issueTypeIds": [
+         *         "10010"
+         *     ],
+         *     "name": "Bug fields context",
+         *     "projectIds": []
+         * }
+         */
+        createCustomFieldContext: CreateCustomFieldContext;
+    }): Promise<CreateCustomFieldContext>;
+    /**
+     * Deletes a [ custom field
+     * context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the context is deleted.
+     * @path {DELETE} /rest/api/3/field/{fieldId}/context/{contextId}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta delete:field:jira
+     */
+    deleteCustomFieldContext({ fieldId, contextId, }: {
+        /** The ID of the custom field. */
+        fieldId: string;
+        /** The ID of the context. */
+        contextId: number;
+    }): Promise<void>;
+    /**
+     * Returns a [paginated](#pagination) list of [
+     * contexts](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html)
+     * for a custom field. Contexts can be returned as follows:
+     *
+     *  *  With no other parameters set, all contexts.
+     *  *  By defining `id` only, all contexts from the list of IDs.
+     *  *  By defining `isAnyIssueType`, limit the list of contexts returned to either
+     * those that apply to all issue types (true) or those that apply to only a subset
+     * of issue types (false)
+     *  *  By defining `isGlobalContext`, limit the list of contexts return to either
+     * those that apply to all projects (global contexts) (true) or those that apply
+     * to only a subset of projects (false).
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "isLast": true,
+     *   "maxResults": 100,
+     *   "startAt": 0,
+     *   "total": 2,
+     *   "values": [
+     *     {
+     *       "id": "10025",
+     *       "name": "Bug fields context",
+     *       "description": "A context used to define the custom field options for
+     * bugs.",
+     *       "isGlobalContext": true,
+     *       "isAnyIssueType": false
+     *     },
+     *     {
+     *       "id": "10026",
+     *       "name": "Task fields context",
+     *       "description": "A context used to define the custom field options for
+     * tasks.",
+     *       "isGlobalContext": false,
+     *       "isAnyIssueType": false
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/field/{fieldId}/context
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:field:jira, read:custom-field-contextual-configuration:jira
+     */
+    getContextsForField({ fieldId, isAnyIssueType, isGlobalContext, contextId, startAt, maxResults, }: {
+        /** The ID of the custom field. */
+        fieldId: string;
+        /** Whether to return contexts that apply to all issue types. */
+        isAnyIssueType?: boolean;
+        /** Whether to return contexts that apply to all projects. */
+        isGlobalContext?: boolean;
+        /**
+         * The list of context IDs. To include multiple contexts, separate IDs with
+         * ampersand: `contextId=10000&contextId=10001`.
+         */
+        contextId?: number[];
+        /** 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<PageBeanCustomFieldContext>;
+    /**
+     * Returns a [paginated](#pagination) list of project and issue type mappings and,
+     * for each mapping, the ID of a [custom field
+     * context](https://confluence.atlassian.com/x/k44fOw) that applies to the project
+     * and issue type.
+     *
+     * If there is no custom field context assigned to the project then, if present,
+     * the custom field context that applies to all projects is returned if it also
+     * applies to the issue type or all issue types. If a custom field context is not
+     * found, the returned custom field context ID is `null`.
+     *
+     * Duplicate project and issue type mappings cannot be provided in the request.
+     *
+     * The order of the returned values is the same as provided in the request.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "isLast": true,
+     *   "maxResults": 50,
+     *   "startAt": 0,
+     *   "total": 3,
+     *   "values": [
+     *     {
+     *       "projectId": "10000",
+     *       "issueTypeId": "10000",
+     *       "contextId": "10000"
+     *     },
+     *     {
+     *       "projectId": "10000",
+     *       "issueTypeId": "10001",
+     *       "contextId": null
+     *     },
+     *     {
+     *       "projectId": "10001",
+     *       "issueTypeId": "10002",
+     *       "contextId": "10003"
+     *     }
+     *   ]
+     * }
+     * @path {POST} /rest/api/3/field/{fieldId}/context/mapping
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:field:jira
+     */
+    getCustomFieldContextsForProjectsAndIssueTypes({ fieldId, startAt, maxResults, projectIssueTypeMappings, }: {
+        /** The ID of the custom field. */
+        fieldId: string;
+        /** 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;
+        /**
+         * The list of project and issue type mappings.
+         *
+         * @example {
+         *     "mappings": [
+         *         {
+         *             "issueTypeId": "10000",
+         *             "projectId": "10000"
+         *         },
+         *         {
+         *             "issueTypeId": "10001",
+         *             "projectId": "10000"
+         *         },
+         *         {
+         *             "issueTypeId": "10002",
+         *             "projectId": "10001"
+         *         }
+         *     ]
+         * }
+         */
+        projectIssueTypeMappings: ProjectIssueTypeMappings;
+    }): Promise<PageBeanContextForProjectAndIssueType>;
+    /**
+     * Returns a [paginated](#pagination) list of defaults for a custom field. The
+     * results can be filtered by `contextId`, otherwise all values are returned. If
+     * no defaults are set for a context, nothing is returned.
+     * The returned object depends on type of the custom field:
+     *
+     *  *  `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields.
+     *  *  `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for
+     * date-time fields.
+     *  *  `CustomFieldContextDefaultValueSingleOption` (type `option.single`) for
+     * single choice select lists and radio buttons.
+     *  *  `CustomFieldContextDefaultValueMultipleOption` (type `option.multiple`) for
+     * multiple choice select lists and checkboxes.
+     *  *  `CustomFieldContextDefaultValueCascadingOption` (type `option.cascading`)
+     * for cascading select lists.
+     *  *  `CustomFieldContextSingleUserPickerDefaults` (type `single.user.select`)
+     * for single users.
+     *  *  `CustomFieldContextDefaultValueMultiUserPicker` (type `multi.user.select`)
+     * for user lists.
+     *  *  `CustomFieldContextDefaultValueSingleGroupPicker` (type
+     * `grouppicker.single`) for single choice group pickers.
+     *  *  `CustomFieldContextDefaultValueMultipleGroupPicker` (type
+     * `grouppicker.multiple`) for multiple choice group pickers.
+     *  *  `CustomFieldContextDefaultValueURL` (type `url`) for URLs.
+     *  *  `CustomFieldContextDefaultValueProject` (type `project`) for project
+     * pickers.
+     *  *  `CustomFieldContextDefaultValueFloat` (type `float`) for floats
+     * (floating-point numbers).
+     *  *  `CustomFieldContextDefaultValueLabels` (type `labels`) for labels.
+     *  *  `CustomFieldContextDefaultValueTextField` (type `textfield`) for text
+     * fields.
+     *  *  `CustomFieldContextDefaultValueTextArea` (type `textarea`) for text area
+     * fields.
+     *  *  `CustomFieldContextDefaultValueReadOnly` (type `readonly`) for read only
+     * (text) fields.
+     *  *  `CustomFieldContextDefaultValueMultipleVersion` (type `version.multiple`)
+     * for single choice version pickers.
+     *  *  `CustomFieldContextDefaultValueSingleVersion` (type `version.single`) for
+     * multiple choice version pickers.
+     *
+     * Forge custom fields
+     * [types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/#data-types)
+     * are also supported, returning:
+     *
+     *  *  `CustomFieldContextDefaultValueForgeStringFieldBean` (type `forge.string`)
+     * for Forge string fields.
+     *  *  `CustomFieldContextDefaultValueForgeMultiStringFieldBean` (type
+     * `forge.string.list`) for Forge string collection fields.
+     *  *  `CustomFieldContextDefaultValueForgeObjectFieldBean` (type `forge.object`)
+     * for Forge object fields.
+     *  *  `CustomFieldContextDefaultValueForgeDateTimeFieldBean` (type
+     * `forge.datetime`) for Forge date-time fields.
+     *  *  `CustomFieldContextDefaultValueForgeGroupFieldBean` (type `forge.group`)
+     * for Forge group fields.
+     *  *  `CustomFieldContextDefaultValueForgeMultiGroupFieldBean` (type
+     * `forge.group.list`) for Forge group collection fields.
+     *  *  `CustomFieldContextDefaultValueForgeNumberFieldBean` (type `forge.number`)
+     * for Forge number fields.
+     *  *  `CustomFieldContextDefaultValueForgeUserFieldBean` (type `forge.user`) for
+     * Forge user fields.
+     *  *  `CustomFieldContextDefaultValueForgeMultiUserFieldBean` (type
+     * `forge.user.list`) for Forge user collection fields.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "isLast": true,
+     *   "maxResults": 50,
+     *   "startAt": 0,
+     *   "total": 3,
+     *   "values": [
+     *     {
+     *       "contextId": "10100",
+     *       "optionId": "10001"
+     *     },
+     *     {
+     *       "contextId": "10101",
+     *       "optionId": "10003"
+     *     },
+     *     {
+     *       "contextId": "10103"
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/field/{fieldId}/context/defaultValue
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:field.default-value:jira
+     */
+    getDefaultValues({ fieldId, contextId, startAt, maxResults, }: {
+        /** The ID of the custom field, for example `customfield\_10000`. */
+        fieldId: string;
+        /** The IDs of the contexts. */
+        contextId?: number[];
+        /** 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<PageBeanCustomFieldContextDefaultValue>;
+    /**
+     * Returns a [paginated](#pagination) list of context to issue type mappings for a
+     * custom field. Mappings are returned for all contexts or a list of contexts.
+     * Mappings are ordered first by context ID and then by issue type ID.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if operation is successful.
+     *
+     * example: {
+     *   "isLast": true,
+     *   "maxResults": 100,
+     *   "startAt": 0,
+     *   "total": 3,
+     *   "values": [
+     *     {
+     *       "contextId": "10001",
+     *       "issueTypeId": "10010"
+     *     },
+     *     {
+     *       "contextId": "10001",
+     *       "issueTypeId": "10011"
+     *     },
+     *     {
+     *       "contextId": "10002",
+     *       "isAnyIssueType": true
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/field/{fieldId}/context/issuetypemapping
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:field:jira
+     */
+    getIssueTypeMappingsForContexts({ fieldId, contextId, startAt, maxResults, }: {
+        /** The ID of the custom field. */
+        fieldId: string;
+        /**
+         * The ID of the context. To include multiple contexts, provide an
+         * ampersand-separated list. For example, `contextId=10001&contextId=10002`.
+         */
+        contextId?: number[];
+        /** 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<PageBeanIssueTypeToContextMapping>;
+    /**
+     * Returns a [paginated](#pagination) list of context to project mappings for a
+     * custom field. The result can be filtered by `contextId`. Otherwise, all
+     * mappings are returned. Invalid IDs are ignored.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "isLast": true,
+     *   "maxResults": 100,
+     *   "startAt": 0,
+     *   "total": 2,
+     *   "values": [
+     *     {
+     *       "contextId": "10025",
+     *       "projectId": "10001"
+     *     },
+     *     {
+     *       "contextId": "10026",
+     *       "isGlobalContext": true
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/field/{fieldId}/context/projectmapping
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:field:jira
+     */
+    getProjectContextMapping({ fieldId, contextId, startAt, maxResults, }: {
+        /** The ID of the custom field, for example `customfield\_10000`. */
+        fieldId: string;
+        /**
+         * The list of context IDs. To include multiple context, separate IDs with
+         * ampersand: `contextId=10000&contextId=10001`.
+         */
+        contextId?: number[];
+        /** 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<PageBeanCustomFieldContextProjectMapping>;
+    /**
+     * Removes a custom field context from projects.
+     *
+     * A custom field context without any projects applies to all projects. Removing
+     * all projects from a custom field context would result in it applying to all
+     * projects.
+     *
+     * If any project in the request is not assigned to the context, or the operation
+     * would result in two global contexts for the field, the operation fails.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the custom field context is removed from the projects.
+     * @path {POST} /rest/api/3/field/{fieldId}/context/{contextId}/project/remove
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:field:jira
+     */
+    removeCustomFieldContextFromProjects({ fieldId, contextId, projectIds, }: {
+        /** The ID of the custom field. */
+        fieldId: string;
+        /** The ID of the context. */
+        contextId: number;
+        /**
+         * @example {
+         *     "projectIds": [
+         *         "10001",
+         *         "10005",
+         *         "10006"
+         *     ]
+         * }
+         */
+        projectIds: ProjectIds;
+    }): Promise<void>;
+    /**
+     * Removes issue types from a custom field context.
+     *
+     * A custom field context without any issue types applies to all issue types.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if operation is successful.
+     * @path {POST} /rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:field:jira
+     */
+    removeIssueTypesFromContext({ fieldId, contextId, issueTypeIds, }: {
+        /** The ID of the custom field. */
+        fieldId: string;
+        /** The ID of the context. */
+        contextId: number;
+        /**
+         * @example {
+         *     "issueTypeIds": [
+         *         "10001",
+         *         "10005",
+         *         "10006"
+         *     ]
+         * }
+         */
+        issueTypeIds: IssueTypeIds;
+    }): Promise<void>;
+    /**
+     * Sets default for contexts of a custom field. Default are defined using these
+     * objects:
+     *
+     *  *  `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields.
+     *  *  `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for
+     * date-time fields.
+     *  *  `CustomFieldContextDefaultValueSingleOption` (type `option.single`) for
+     * single choice select lists and radio buttons.
+     *  *  `CustomFieldContextDefaultValueMultipleOption` (type `option.multiple`) for
+     * multiple choice select lists and checkboxes.
+     *  *  `CustomFieldContextDefaultValueCascadingOption` (type `option.cascading`)
+     * for cascading select lists.
+     *  *  `CustomFieldContextSingleUserPickerDefaults` (type `single.user.select`)
+     * for single users.
+     *  *  `CustomFieldContextDefaultValueMultiUserPicker` (type `multi.user.select`)
+     * for user lists.
+     *  *  `CustomFieldContextDefaultValueSingleGroupPicker` (type
+     * `grouppicker.single`) for single choice group pickers.
+     *  *  `CustomFieldContextDefaultValueMultipleGroupPicker` (type
+     * `grouppicker.multiple`) for multiple choice group pickers.
+     *  *  `CustomFieldContextDefaultValueURL` (type `url`) for URLs.
+     *  *  `CustomFieldContextDefaultValueProject` (type `project`) for project
+     * pickers.
+     *  *  `CustomFieldContextDefaultValueFloat` (type `float`) for floats
+     * (floating-point numbers).
+     *  *  `CustomFieldContextDefaultValueLabels` (type `labels`) for labels.
+     *  *  `CustomFieldContextDefaultValueTextField` (type `textfield`) for text
+     * fields.
+     *  *  `CustomFieldContextDefaultValueTextArea` (type `textarea`) for text area
+     * fields.
+     *  *  `CustomFieldContextDefaultValueReadOnly` (type `readonly`) for read only
+     * (text) fields.
+     *  *  `CustomFieldContextDefaultValueMultipleVersion` (type `version.multiple`)
+     * for single choice version pickers.
+     *  *  `CustomFieldContextDefaultValueSingleVersion` (type `version.single`) for
+     * multiple choice version pickers.
+     *
+     * Forge custom fields
+     * [types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/#data-types)
+     * are also supported, returning:
+     *
+     *  *  `CustomFieldContextDefaultValueForgeStringFieldBean` (type `forge.string`)
+     * for Forge string fields.
+     *  *  `CustomFieldContextDefaultValueForgeMultiStringFieldBean` (type
+     * `forge.string.list`) for Forge string collection fields.
+     *  *  `CustomFieldContextDefaultValueForgeObjectFieldBean` (type `forge.object`)
+     * for Forge object fields.
+     *  *  `CustomFieldContextDefaultValueForgeDateTimeFieldBean` (type
+     * `forge.datetime`) for Forge date-time fields.
+     *  *  `CustomFieldContextDefaultValueForgeGroupFieldBean` (type `forge.group`)
+     * for Forge group fields.
+     *  *  `CustomFieldContextDefaultValueForgeMultiGroupFieldBean` (type
+     * `forge.group.list`) for Forge group collection fields.
+     *  *  `CustomFieldContextDefaultValueForgeNumberFieldBean` (type `forge.number`)
+     * for Forge number fields.
+     *  *  `CustomFieldContextDefaultValueForgeUserFieldBean` (type `forge.user`) for
+     * Forge user fields.
+     *  *  `CustomFieldContextDefaultValueForgeMultiUserFieldBean` (type
+     * `forge.user.list`) for Forge user collection fields.
+     *
+     * Only one type of default object can be included in a request. To remove a
+     * default for a context, set the default parameter to `null`.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if operation is successful.
+     * @path {PUT} /rest/api/3/field/{fieldId}/context/defaultValue
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:field.default-value:jira
+     */
+    setDefaultValues({ fieldId, customFieldContextDefaultValueUpdate, }: {
+        /** The ID of the custom field. */
+        fieldId: string;
+        /**
+         * @example {
+         *     "defaultValues": [
+         *         {
+         *             "contextId": "10100",
+         *             "optionId": "10001",
+         *             "type": "option.single"
+         *         },
+         *         {
+         *             "contextId": "10101",
+         *             "optionId": "10003",
+         *             "type": "option.single"
+         *         },
+         *         {
+         *             "contextId": "10103",
+         *             "optionId": "10005",
+         *             "type": "option.single"
+         *         }
+         *     ]
+         * }
+         */
+        customFieldContextDefaultValueUpdate: CustomFieldContextDefaultValueUpdate;
+    }): Promise<void>;
+    /**
+     * Updates a [ custom field
+     * context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the context is updated.
+     * @path {PUT} /rest/api/3/field/{fieldId}/context/{contextId}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:field:jira
+     */
+    updateCustomFieldContext({ fieldId, contextId, customFieldContextUpdateDetails, }: {
+        /** The ID of the custom field. */
+        fieldId: string;
+        /** The ID of the context. */
+        contextId: number;
+        /**
+         * @example {
+         *     "description": "A context used to define the custom field options for
+         * bugs.",
+         *     "name": "Bug fields context"
+         * }
+         */
+        customFieldContextUpdateDetails: CustomFieldContextUpdateDetails;
+    }): Promise<void>;
+    static initialize(): void;
+}