@rbaileysr/zephyr-managed-api 1.0.0

package/dist/groups/Priority.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Priority API group
+ * Handles priority-related operations
+ */
+import type { Priority, PriorityList, ListPrioritiesOptions, GetPriorityOptions, CreatePriorityRequest, UpdatePriorityRequest } from '../types';
+import type { ZephyrApiConnection } from '../index';
+export declare class PriorityGroup {
+    private api;
+    constructor(api: ZephyrApiConnection);
+    /**
+     * List all priorities
+     *
+     * Retrieves a paginated list of all priorities. Query parameters can be used to filter by project.
+     *
+     * @param options - Query parameters for filtering and pagination
+     * @param options.projectKey - Filter priorities by Jira project key
+     * @param options.maxResults - Maximum number of results to return (default: 10, max: 1000)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of priorities with metadata (total, isLast, etc.)
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listPriorities Official API Documentation}
+     */
+    listPriorities(options: ListPrioritiesOptions): Promise<PriorityList>;
+    /**
+     * Get a specific priority
+     *
+     * Retrieves detailed information about a specific priority by its ID.
+     *
+     * @param options - Get priority options
+     * @param options.priorityId - The priority ID
+     * @returns Priority object with all fields
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getPriority Official API Documentation}
+     */
+    getPriority(options: GetPriorityOptions): Promise<Priority>;
+    /**
+     * Create a new priority
+     *
+     * Creates a new priority in the specified project. Required fields include projectKey, name, index, and default.
+     * Optional fields include description and color.
+     *
+     * @param request - Create priority request
+     * @param request.body - Priority data
+     * @param request.body.projectKey - Jira project key (required)
+     * @param request.body.name - Priority name (required)
+     * @param request.body.index - Display order index (required)
+     * @param request.body.default - Whether this is the default priority (required)
+     * @param request.body.description - Priority description (optional)
+     * @param request.body.color - Priority color (optional)
+     * @returns Created priority object
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createPriority Official API Documentation}
+     */
+    createPriority(request: CreatePriorityRequest): Promise<Priority>;
+    /**
+     * Update a priority
+     *
+     * Updates an existing priority. For each non-specified field the value will be cleared.
+     * All fields from the existing priority must be included in the request.
+     *
+     * @param request - Update priority request
+     * @param request.priorityId - The priority ID to update
+     * @param request.body - Priority data to update (must include all existing fields)
+     * @param request.body.id - Priority ID (required)
+     * @param request.body.project - Project link (required)
+     * @param request.body.name - Priority name (required)
+     * @param request.body.index - Display order index (required)
+     * @param request.body.default - Whether this is the default priority (required)
+     * @param request.body.description - Priority description (optional)
+     * @param request.body.color - Priority color (optional)
+     * @returns Updated priority object
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/updatePriority Official API Documentation}
+     */
+    updatePriority(request: UpdatePriorityRequest): Promise<Priority>;
+}
+//# sourceMappingURL=Priority.d.ts.map

package/dist/groups/Priority.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Priority.d.ts","sourceRoot":"","sources":["../../groups/Priority.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,QAAQ,EACR,YAAY,EACZ,qBAAqB,EACrB,kBAAkB,EAClB,qBAAqB,EACrB,qBAAqB,EACrB,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEpD,qBAAa,aAAa;IACb,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,mBAAmB;IAE5C;;;;;;;;;;;;OAYG;IACG,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,YAAY,CAAC;IAM3E;;;;;;;;;;OAUG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAKjE;;;;;;;;;;;;;;;;;OAiBG;IACG,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;IASvE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;CAQvE"}

package/dist/groups/Priority.js

@@ -0,0 +1,97 @@
+/**
+ * Priority API group
+ * Handles priority-related operations
+ */
+import { buildQueryString, parseResponse, buildRequestBody } from '../utils';
+export class PriorityGroup {
+    constructor(api) {
+        this.api = api;
+    }
+    /**
+     * List all priorities
+     *
+     * Retrieves a paginated list of all priorities. Query parameters can be used to filter by project.
+     *
+     * @param options - Query parameters for filtering and pagination
+     * @param options.projectKey - Filter priorities by Jira project key
+     * @param options.maxResults - Maximum number of results to return (default: 10, max: 1000)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of priorities with metadata (total, isLast, etc.)
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listPriorities Official API Documentation}
+     */
+    async listPriorities(options) {
+        const queryString = buildQueryString(options);
+        const response = await this.api.fetch(`/priorities${queryString}`);
+        return parseResponse(response);
+    }
+    /**
+     * Get a specific priority
+     *
+     * Retrieves detailed information about a specific priority by its ID.
+     *
+     * @param options - Get priority options
+     * @param options.priorityId - The priority ID
+     * @returns Priority object with all fields
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getPriority Official API Documentation}
+     */
+    async getPriority(options) {
+        const response = await this.api.fetch(`/priorities/${options.priorityId}`);
+        return parseResponse(response);
+    }
+    /**
+     * Create a new priority
+     *
+     * Creates a new priority in the specified project. Required fields include projectKey, name, index, and default.
+     * Optional fields include description and color.
+     *
+     * @param request - Create priority request
+     * @param request.body - Priority data
+     * @param request.body.projectKey - Jira project key (required)
+     * @param request.body.name - Priority name (required)
+     * @param request.body.index - Display order index (required)
+     * @param request.body.default - Whether this is the default priority (required)
+     * @param request.body.description - Priority description (optional)
+     * @param request.body.color - Priority color (optional)
+     * @returns Created priority object
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createPriority Official API Documentation}
+     */
+    async createPriority(request) {
+        const response = await this.api.fetch('/priorities', {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        return parseResponse(response);
+    }
+    /**
+     * Update a priority
+     *
+     * Updates an existing priority. For each non-specified field the value will be cleared.
+     * All fields from the existing priority must be included in the request.
+     *
+     * @param request - Update priority request
+     * @param request.priorityId - The priority ID to update
+     * @param request.body - Priority data to update (must include all existing fields)
+     * @param request.body.id - Priority ID (required)
+     * @param request.body.project - Project link (required)
+     * @param request.body.name - Priority name (required)
+     * @param request.body.index - Display order index (required)
+     * @param request.body.default - Whether this is the default priority (required)
+     * @param request.body.description - Priority description (optional)
+     * @param request.body.color - Priority color (optional)
+     * @returns Updated priority object
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/updatePriority Official API Documentation}
+     */
+    async updatePriority(request) {
+        const response = await this.api.fetch(`/priorities/${request.priorityId}`, {
+            method: 'PUT',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        return parseResponse(response);
+    }
+}

package/dist/groups/Project.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Project API group
+ * Handles project-related operations (read-only)
+ */
+import type { Project, ProjectList, ListProjectsOptions, GetProjectOptions } from '../types';
+import type { ZephyrApiConnection } from '../index';
+export declare class ProjectGroup {
+    private api;
+    constructor(api: ZephyrApiConnection);
+    /**
+     * List all projects
+     *
+     * Retrieves a paginated list of all projects accessible to the authenticated user.
+     *
+     * @param options - Optional query parameters for pagination
+     * @param options.maxResults - Maximum number of results to return (default: 10, max: 1000)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of projects with metadata (total, isLast, etc.)
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listProjects Official API Documentation}
+     */
+    listProjects(options?: ListProjectsOptions): Promise<ProjectList>;
+    /**
+     * Get a specific project
+     *
+     * Retrieves detailed information about a specific project by its ID or key.
+     *
+     * @param options - Get project options
+     * @param options.projectIdOrKey - The project ID or key
+     * @returns Project object with all fields
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getProject Official API Documentation}
+     */
+    getProject(options: GetProjectOptions): Promise<Project>;
+}
+//# sourceMappingURL=Project.d.ts.map

package/dist/groups/Project.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Project.d.ts","sourceRoot":"","sources":["../../groups/Project.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEpD,qBAAa,YAAY;IACZ,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,mBAAmB;IAE5C;;;;;;;;;;;OAWG;IACG,YAAY,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC;IAMvE;;;;;;;;;;OAUG;IACG,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;CAI9D"}

package/dist/groups/Project.js

@@ -0,0 +1,42 @@
+/**
+ * Project API group
+ * Handles project-related operations (read-only)
+ */
+import { buildQueryString, parseResponse } from '../utils';
+export class ProjectGroup {
+    constructor(api) {
+        this.api = api;
+    }
+    /**
+     * List all projects
+     *
+     * Retrieves a paginated list of all projects accessible to the authenticated user.
+     *
+     * @param options - Optional query parameters for pagination
+     * @param options.maxResults - Maximum number of results to return (default: 10, max: 1000)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of projects with metadata (total, isLast, etc.)
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listProjects Official API Documentation}
+     */
+    async listProjects(options) {
+        const queryString = buildQueryString(options);
+        const response = await this.api.fetch(`/projects${queryString}`);
+        return parseResponse(response);
+    }
+    /**
+     * Get a specific project
+     *
+     * Retrieves detailed information about a specific project by its ID or key.
+     *
+     * @param options - Get project options
+     * @param options.projectIdOrKey - The project ID or key
+     * @returns Project object with all fields
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getProject Official API Documentation}
+     */
+    async getProject(options) {
+        const response = await this.api.fetch(`/projects/${options.projectIdOrKey}`);
+        return parseResponse(response);
+    }
+}

package/dist/groups/Status.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Status API group
+ * Handles status-related operations
+ */
+import type { Status, StatusList, ListStatusesOptions, GetStatusOptions, CreateStatusRequest, UpdateStatusRequest } from '../types';
+import type { ZephyrApiConnection } from '../index';
+export declare class StatusGroup {
+    private api;
+    constructor(api: ZephyrApiConnection);
+    /**
+     * List all statuses
+     *
+     * Retrieves a paginated list of all statuses. Query parameters can be used to filter by project and status type.
+     *
+     * @param options - Query parameters for filtering and pagination
+     * @param options.projectKey - Filter statuses by Jira project key
+     * @param options.statusType - Filter by status type: 'TEST_CASE', 'TEST_PLAN', 'TEST_CYCLE', or 'TEST_EXECUTION'
+     * @param options.maxResults - Maximum number of results to return (default: 10, max: 1000)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of statuses with metadata (total, isLast, etc.)
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listStatuses Official API Documentation}
+     */
+    listStatuses(options: ListStatusesOptions): Promise<StatusList>;
+    /**
+     * Get a specific status
+     *
+     * Retrieves detailed information about a specific status by its ID.
+     *
+     * @param options - Get status options
+     * @param options.statusId - The status ID
+     * @returns Status object with all fields
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getStatus Official API Documentation}
+     */
+    getStatus(options: GetStatusOptions): Promise<Status>;
+    /**
+     * Create a new status
+     *
+     * Creates a new status in the specified project. Required fields include projectKey, name, statusType, index, default, and archived.
+     * Optional fields include description and color.
+     *
+     * @param request - Create status request
+     * @param request.body - Status data
+     * @param request.body.projectKey - Jira project key (required)
+     * @param request.body.name - Status name (required)
+     * @param request.body.statusType - Status type: 'TEST_CASE', 'TEST_PLAN', 'TEST_CYCLE', or 'TEST_EXECUTION' (required)
+     * @param request.body.index - Display order index (required)
+     * @param request.body.default - Whether this is the default status (required)
+     * @param request.body.archived - Whether this status is archived (required)
+     * @param request.body.description - Status description (optional)
+     * @param request.body.color - Status color (optional)
+     * @returns Created status object
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createStatus Official API Documentation}
+     */
+    createStatus(request: CreateStatusRequest): Promise<Status>;
+    /**
+     * Update a status
+     *
+     * Updates an existing status. For each non-specified field the value will be cleared.
+     * All fields from the existing status must be included in the request.
+     *
+     * @param request - Update status request
+     * @param request.statusId - The status ID to update
+     * @param request.body - Status data to update (must include all existing fields)
+     * @param request.body.id - Status ID (required)
+     * @param request.body.project - Project link (required)
+     * @param request.body.name - Status name (required)
+     * @param request.body.statusType - Status type (required)
+     * @param request.body.index - Display order index (required)
+     * @param request.body.default - Whether this is the default status (required)
+     * @param request.body.archived - Whether this status is archived (required)
+     * @param request.body.description - Status description (optional)
+     * @param request.body.color - Status color (optional)
+     * @returns Updated status object
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/updateStatus Official API Documentation}
+     */
+    updateStatus(request: UpdateStatusRequest): Promise<Status>;
+}
+//# sourceMappingURL=Status.d.ts.map

package/dist/groups/Status.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Status.d.ts","sourceRoot":"","sources":["../../groups/Status.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,MAAM,EACN,UAAU,EACV,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EACnB,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEpD,qBAAa,WAAW;IACX,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,mBAAmB;IAE5C;;;;;;;;;;;;;OAaG;IACG,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAMrE;;;;;;;;;;OAUG;IACG,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAK3D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;IASjE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;CAQjE"}

package/dist/groups/Status.js

@@ -0,0 +1,102 @@
+/**
+ * Status API group
+ * Handles status-related operations
+ */
+import { buildQueryString, parseResponse, buildRequestBody } from '../utils';
+export class StatusGroup {
+    constructor(api) {
+        this.api = api;
+    }
+    /**
+     * List all statuses
+     *
+     * Retrieves a paginated list of all statuses. Query parameters can be used to filter by project and status type.
+     *
+     * @param options - Query parameters for filtering and pagination
+     * @param options.projectKey - Filter statuses by Jira project key
+     * @param options.statusType - Filter by status type: 'TEST_CASE', 'TEST_PLAN', 'TEST_CYCLE', or 'TEST_EXECUTION'
+     * @param options.maxResults - Maximum number of results to return (default: 10, max: 1000)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of statuses with metadata (total, isLast, etc.)
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listStatuses Official API Documentation}
+     */
+    async listStatuses(options) {
+        const queryString = buildQueryString(options);
+        const response = await this.api.fetch(`/statuses${queryString}`);
+        return parseResponse(response);
+    }
+    /**
+     * Get a specific status
+     *
+     * Retrieves detailed information about a specific status by its ID.
+     *
+     * @param options - Get status options
+     * @param options.statusId - The status ID
+     * @returns Status object with all fields
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getStatus Official API Documentation}
+     */
+    async getStatus(options) {
+        const response = await this.api.fetch(`/statuses/${options.statusId}`);
+        return parseResponse(response);
+    }
+    /**
+     * Create a new status
+     *
+     * Creates a new status in the specified project. Required fields include projectKey, name, statusType, index, default, and archived.
+     * Optional fields include description and color.
+     *
+     * @param request - Create status request
+     * @param request.body - Status data
+     * @param request.body.projectKey - Jira project key (required)
+     * @param request.body.name - Status name (required)
+     * @param request.body.statusType - Status type: 'TEST_CASE', 'TEST_PLAN', 'TEST_CYCLE', or 'TEST_EXECUTION' (required)
+     * @param request.body.index - Display order index (required)
+     * @param request.body.default - Whether this is the default status (required)
+     * @param request.body.archived - Whether this status is archived (required)
+     * @param request.body.description - Status description (optional)
+     * @param request.body.color - Status color (optional)
+     * @returns Created status object
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createStatus Official API Documentation}
+     */
+    async createStatus(request) {
+        const response = await this.api.fetch('/statuses', {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        return parseResponse(response);
+    }
+    /**
+     * Update a status
+     *
+     * Updates an existing status. For each non-specified field the value will be cleared.
+     * All fields from the existing status must be included in the request.
+     *
+     * @param request - Update status request
+     * @param request.statusId - The status ID to update
+     * @param request.body - Status data to update (must include all existing fields)
+     * @param request.body.id - Status ID (required)
+     * @param request.body.project - Project link (required)
+     * @param request.body.name - Status name (required)
+     * @param request.body.statusType - Status type (required)
+     * @param request.body.index - Display order index (required)
+     * @param request.body.default - Whether this is the default status (required)
+     * @param request.body.archived - Whether this status is archived (required)
+     * @param request.body.description - Status description (optional)
+     * @param request.body.color - Status color (optional)
+     * @returns Updated status object
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/updateStatus Official API Documentation}
+     */
+    async updateStatus(request) {
+        const response = await this.api.fetch(`/statuses/${request.statusId}`, {
+            method: 'PUT',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        return parseResponse(response);
+    }
+}