@silkline/paramify 0.0.2

package/src/resources/issues/milestones.ts

@@ -0,0 +1,350 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Milestones extends APIResource {
+  /**
+   * Creates a new milestone associated with the issue specified by the `issueId`
+   * path parameter. The `id` value of the milestone returned can be used as the
+   * `milestoneId` parameter in other milestone routes.
+   *
+   * @example
+   * ```ts
+   * const milestone = await client.issues.milestones.create(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   *   {
+   *     description:
+   *       'This is a detailed description of the task.',
+   *     dueEnd: '2022-01-01T00:00:00.000Z',
+   *     title: 'Task Title Example',
+   *   },
+   * );
+   * ```
+   */
+  create(
+    issueID: string,
+    body: MilestoneCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<MilestoneCreateResponse> {
+    return this._client.post(path`/issues/${issueID}/milestones`, { body, ...options });
+  }
+
+  /**
+   * Returns the milestone specified by the `milestoneId` path parameter and
+   * associated with the given `issueId`. The `id` value of the milestone returned
+   * can be used as the `milestoneId` parameter in other milestone routes.
+   *
+   * @example
+   * ```ts
+   * const milestone = await client.issues.milestones.retrieve(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   *   { issueId: '123e4567-e89b-12d3-a456-426614174000' },
+   * );
+   * ```
+   */
+  retrieve(
+    milestoneID: string,
+    params: MilestoneRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<MilestoneRetrieveResponse> {
+    const { issueId } = params;
+    return this._client.get(path`/issues/${issueId}/milestones/${milestoneID}`, options);
+  }
+
+  /**
+   * Updates the milestone specified by the `milestoneId` path parameter. Only the
+   * fields provided in the request body will be modified; all other fields will
+   * remain unchanged.
+   *
+   * @example
+   * ```ts
+   * const milestone = await client.issues.milestones.update(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   *   { issueId: '123e4567-e89b-12d3-a456-426614174000' },
+   * );
+   * ```
+   */
+  update(
+    milestoneID: string,
+    params: MilestoneUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<MilestoneUpdateResponse> {
+    const { issueId, ...body } = params;
+    return this._client.patch(path`/issues/${issueId}/milestones/${milestoneID}`, { body, ...options });
+  }
+
+  /**
+   * Gets all milestones associated with the issue specified by the `issueId` path
+   * parameter, and optionally filters by one or more milestone IDs. The `id` value
+   * of the milestone(s) returned can be used as the `milestoneId` parameter in other
+   * milestone routes.
+   *
+   * @example
+   * ```ts
+   * const milestones = await client.issues.milestones.list(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   * );
+   * ```
+   */
+  list(
+    issueID: string,
+    query: MilestoneListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<MilestoneListResponse> {
+    return this._client.get(path`/issues/${issueID}/milestones`, { query, ...options });
+  }
+
+  /**
+   * Deletes the milestone specified by the `milestoneId` path parameter and
+   * associated with the given `issueId`. Warning: This action is irreversible.
+   *
+   * @example
+   * ```ts
+   * await client.issues.milestones.delete(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   *   { issueId: '123e4567-e89b-12d3-a456-426614174000' },
+   * );
+   * ```
+   */
+  delete(milestoneID: string, params: MilestoneDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { issueId } = params;
+    return this._client.delete(path`/issues/${issueId}/milestones/${milestoneID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface Milestone {
+  /**
+   * The description of the task
+   */
+  description: string;
+
+  /**
+   * The end date of the task
+   */
+  dueEnd: string;
+
+  /**
+   * The title of the task
+   */
+  title: string;
+
+  /**
+   * The start date of the task
+   */
+  dueStart?: string | null;
+}
+
+export interface MilestoneCreateResponse {
+  /**
+   * A uuid that uniquely identifies the milestone
+   */
+  id: string;
+
+  /**
+   * The description of the milestone
+   */
+  description: string;
+
+  /**
+   * The end date of the milestone
+   */
+  dueEnd: string | null;
+
+  /**
+   * The start date of the milestone
+   */
+  dueStart: string | null;
+
+  /**
+   * The title of the milestone
+   */
+  title: string;
+}
+
+export interface MilestoneRetrieveResponse {
+  /**
+   * A uuid that uniquely identifies the milestone
+   */
+  id: string;
+
+  /**
+   * The description of the milestone
+   */
+  description: string;
+
+  /**
+   * The end date of the milestone
+   */
+  dueEnd: string | null;
+
+  /**
+   * The start date of the milestone
+   */
+  dueStart: string | null;
+
+  /**
+   * The title of the milestone
+   */
+  title: string;
+}
+
+/**
+ * The milestone as it exists after the operation
+ */
+export interface MilestoneUpdateResponse {
+  /**
+   * A uuid that uniquely identifies the milestone
+   */
+  id: string;
+
+  /**
+   * The description of the milestone
+   */
+  description: string;
+
+  /**
+   * The end date of the milestone
+   */
+  dueEnd: string | null;
+
+  /**
+   * The start date of the milestone
+   */
+  dueStart: string | null;
+
+  /**
+   * The title of the milestone
+   */
+  title: string;
+}
+
+export interface MilestoneListResponse {
+  milestones: Array<MilestoneListResponse.Milestone>;
+}
+
+export namespace MilestoneListResponse {
+  export interface Milestone {
+    /**
+     * A uuid that uniquely identifies the milestone
+     */
+    id: string;
+
+    /**
+     * The description of the milestone
+     */
+    description: string;
+
+    /**
+     * The end date of the milestone
+     */
+    dueEnd: string | null;
+
+    /**
+     * The start date of the milestone
+     */
+    dueStart: string | null;
+
+    /**
+     * The title of the milestone
+     */
+    title: string;
+  }
+}
+
+export interface MilestoneCreateParams {
+  /**
+   * The description of the task
+   */
+  description: string;
+
+  /**
+   * The end date of the task
+   */
+  dueEnd: string;
+
+  /**
+   * The title of the task
+   */
+  title: string;
+
+  /**
+   * The start date of the task
+   */
+  dueStart?: string | null;
+}
+
+export interface MilestoneRetrieveParams {
+  /**
+   * An id that represents an issue within the Paramify application.
+   */
+  issueId: string;
+}
+
+export interface MilestoneUpdateParams {
+  /**
+   * Path param: An id that represents an issue within the Paramify application.
+   */
+  issueId: string;
+
+  /**
+   * Body param: A uuid that uniquely identifies the milestone
+   */
+  id?: string;
+
+  /**
+   * Body param: The description of the milestone
+   */
+  description?: string;
+
+  /**
+   * Body param: The date the milestone is due to be completed
+   */
+  dueEnd?: string;
+
+  /**
+   * Body param: The date progress on the milestone should start
+   */
+  dueStart?: string;
+
+  /**
+   * Body param: The title of the milestone
+   */
+  title?: string;
+}
+
+export interface MilestoneListParams {
+  /**
+   * Filter milestones by ID. Multiple IDs can be provided to retrieve multiple
+   * milestones at once.
+   */
+  id?: Array<string>;
+}
+
+export interface MilestoneDeleteParams {
+  /**
+   * An id that represents an issue within the Paramify application.
+   */
+  issueId: string;
+}
+
+export declare namespace Milestones {
+  export {
+    type Milestone as Milestone,
+    type MilestoneCreateResponse as MilestoneCreateResponse,
+    type MilestoneRetrieveResponse as MilestoneRetrieveResponse,
+    type MilestoneUpdateResponse as MilestoneUpdateResponse,
+    type MilestoneListResponse as MilestoneListResponse,
+    type MilestoneCreateParams as MilestoneCreateParams,
+    type MilestoneRetrieveParams as MilestoneRetrieveParams,
+    type MilestoneUpdateParams as MilestoneUpdateParams,
+    type MilestoneListParams as MilestoneListParams,
+    type MilestoneDeleteParams as MilestoneDeleteParams,
+  };
+}