@makeplane/plane-node-sdk 0.1.0

package/src/apis/WorkItemActivityApi.ts

@@ -0,0 +1,228 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Plane REST API
+ * The Plane REST API  Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
+ *
+ * The version of the API Spec: 0.0.1
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  PaginatedIssueActivityDetailResponse,
+  PaginatedIssueActivityResponse,
+} from '../models/index';
+import {
+    PaginatedIssueActivityDetailResponseFromJSON,
+    PaginatedIssueActivityDetailResponseToJSON,
+    PaginatedIssueActivityResponseFromJSON,
+    PaginatedIssueActivityResponseToJSON,
+} from '../models/index';
+
+export interface ListWorkItemActivitiesRequest {
+    issueId: string;
+    projectId: string;
+    slug: string;
+    cursor?: string;
+    expand?: string;
+    fields?: string;
+    orderBy?: string;
+    perPage?: number;
+}
+
+export interface RetrieveWorkItemActivityRequest {
+    issueId: string;
+    pk: string;
+    projectId: string;
+    slug: string;
+    cursor?: string;
+    expand?: string;
+    fields?: string;
+    orderBy?: string;
+    perPage?: number;
+}
+
+/**
+ * 
+ */
+export class WorkItemActivityApi extends runtime.BaseAPI {
+
+    /**
+     * Retrieve all activities for a work item. Supports filtering by activity type and date range.
+     * Endpoints for issue activity/search and fetch issue activity details
+     */
+    async listWorkItemActivitiesRaw(requestParameters: ListWorkItemActivitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedIssueActivityResponse>> {
+        if (requestParameters['issueId'] == null) {
+            throw new runtime.RequiredError(
+                'issueId',
+                'Required parameter "issueId" was null or undefined when calling listWorkItemActivities().'
+            );
+        }
+
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling listWorkItemActivities().'
+            );
+        }
+
+        if (requestParameters['slug'] == null) {
+            throw new runtime.RequiredError(
+                'slug',
+                'Required parameter "slug" was null or undefined when calling listWorkItemActivities().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        if (requestParameters['expand'] != null) {
+            queryParameters['expand'] = requestParameters['expand'];
+        }
+
+        if (requestParameters['fields'] != null) {
+            queryParameters['fields'] = requestParameters['fields'];
+        }
+
+        if (requestParameters['orderBy'] != null) {
+            queryParameters['order_by'] = requestParameters['orderBy'];
+        }
+
+        if (requestParameters['perPage'] != null) {
+            queryParameters['per_page'] = requestParameters['perPage'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuthentication authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/activities/`.replace(`{${"issue_id"}}`, encodeURIComponent(String(requestParameters['issueId']))).replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters['projectId']))).replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedIssueActivityResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve all activities for a work item. Supports filtering by activity type and date range.
+     * Endpoints for issue activity/search and fetch issue activity details
+     */
+    async listWorkItemActivities(requestParameters: ListWorkItemActivitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedIssueActivityResponse> {
+        const response = await this.listWorkItemActivitiesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieve details of a specific activity.
+     * Endpoints for issue activity/search and fetch issue activity details
+     */
+    async retrieveWorkItemActivityRaw(requestParameters: RetrieveWorkItemActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedIssueActivityDetailResponse>> {
+        if (requestParameters['issueId'] == null) {
+            throw new runtime.RequiredError(
+                'issueId',
+                'Required parameter "issueId" was null or undefined when calling retrieveWorkItemActivity().'
+            );
+        }
+
+        if (requestParameters['pk'] == null) {
+            throw new runtime.RequiredError(
+                'pk',
+                'Required parameter "pk" was null or undefined when calling retrieveWorkItemActivity().'
+            );
+        }
+
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling retrieveWorkItemActivity().'
+            );
+        }
+
+        if (requestParameters['slug'] == null) {
+            throw new runtime.RequiredError(
+                'slug',
+                'Required parameter "slug" was null or undefined when calling retrieveWorkItemActivity().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        if (requestParameters['expand'] != null) {
+            queryParameters['expand'] = requestParameters['expand'];
+        }
+
+        if (requestParameters['fields'] != null) {
+            queryParameters['fields'] = requestParameters['fields'];
+        }
+
+        if (requestParameters['orderBy'] != null) {
+            queryParameters['order_by'] = requestParameters['orderBy'];
+        }
+
+        if (requestParameters['perPage'] != null) {
+            queryParameters['per_page'] = requestParameters['perPage'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuthentication authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/activities/{pk}/`.replace(`{${"issue_id"}}`, encodeURIComponent(String(requestParameters['issueId']))).replace(`{${"pk"}}`, encodeURIComponent(String(requestParameters['pk']))).replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters['projectId']))).replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedIssueActivityDetailResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve details of a specific activity.
+     * Endpoints for issue activity/search and fetch issue activity details
+     */
+    async retrieveWorkItemActivity(requestParameters: RetrieveWorkItemActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedIssueActivityDetailResponse> {
+        const response = await this.retrieveWorkItemActivityRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/WorkItemAttachmentsApi.ts

@@ -0,0 +1,335 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Plane REST API
+ * The Plane REST API  Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
+ *
+ * The version of the API Spec: 0.0.1
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  IssueAttachment,
+  IssueAttachmentUploadRequest,
+  RetrieveWorkItemAttachment400Response,
+} from '../models/index';
+import {
+    IssueAttachmentFromJSON,
+    IssueAttachmentToJSON,
+    IssueAttachmentUploadRequestFromJSON,
+    IssueAttachmentUploadRequestToJSON,
+    RetrieveWorkItemAttachment400ResponseFromJSON,
+    RetrieveWorkItemAttachment400ResponseToJSON,
+} from '../models/index';
+
+export interface CreateWorkItemAttachmentRequest {
+    issueId: string;
+    projectId: string;
+    slug: string;
+    issueAttachmentUploadRequest: IssueAttachmentUploadRequest;
+}
+
+export interface DeleteWorkItemAttachmentRequest {
+    issueId: string;
+    pk: string;
+    projectId: string;
+    slug: string;
+}
+
+export interface ListWorkItemAttachmentsRequest {
+    issueId: string;
+    projectId: string;
+    slug: string;
+}
+
+export interface RetrieveWorkItemAttachmentRequest {
+    issueId: string;
+    pk: string;
+    projectId: string;
+    slug: string;
+}
+
+/**
+ * 
+ */
+export class WorkItemAttachmentsApi extends runtime.BaseAPI {
+
+    /**
+     * Generate presigned URL for uploading file attachments to a work item.
+     * Endpoints for issue attachment create/update/delete and fetch issue attachment details
+     */
+    async createWorkItemAttachmentRaw(requestParameters: CreateWorkItemAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['issueId'] == null) {
+            throw new runtime.RequiredError(
+                'issueId',
+                'Required parameter "issueId" was null or undefined when calling createWorkItemAttachment().'
+            );
+        }
+
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling createWorkItemAttachment().'
+            );
+        }
+
+        if (requestParameters['slug'] == null) {
+            throw new runtime.RequiredError(
+                'slug',
+                'Required parameter "slug" was null or undefined when calling createWorkItemAttachment().'
+            );
+        }
+
+        if (requestParameters['issueAttachmentUploadRequest'] == null) {
+            throw new runtime.RequiredError(
+                'issueAttachmentUploadRequest',
+                'Required parameter "issueAttachmentUploadRequest" was null or undefined when calling createWorkItemAttachment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuthentication authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/`.replace(`{${"issue_id"}}`, encodeURIComponent(String(requestParameters['issueId']))).replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters['projectId']))).replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: IssueAttachmentUploadRequestToJSON(requestParameters['issueAttachmentUploadRequest']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Generate presigned URL for uploading file attachments to a work item.
+     * Endpoints for issue attachment create/update/delete and fetch issue attachment details
+     */
+    async createWorkItemAttachment(requestParameters: CreateWorkItemAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.createWorkItemAttachmentRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Permanently remove an attachment from a work item. Records deletion activity for audit purposes.
+     * Endpoints for issue attachment create/update/delete and fetch issue attachment details
+     */
+    async deleteWorkItemAttachmentRaw(requestParameters: DeleteWorkItemAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['issueId'] == null) {
+            throw new runtime.RequiredError(
+                'issueId',
+                'Required parameter "issueId" was null or undefined when calling deleteWorkItemAttachment().'
+            );
+        }
+
+        if (requestParameters['pk'] == null) {
+            throw new runtime.RequiredError(
+                'pk',
+                'Required parameter "pk" was null or undefined when calling deleteWorkItemAttachment().'
+            );
+        }
+
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling deleteWorkItemAttachment().'
+            );
+        }
+
+        if (requestParameters['slug'] == null) {
+            throw new runtime.RequiredError(
+                'slug',
+                'Required parameter "slug" was null or undefined when calling deleteWorkItemAttachment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuthentication authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{pk}/`.replace(`{${"issue_id"}}`, encodeURIComponent(String(requestParameters['issueId']))).replace(`{${"pk"}}`, encodeURIComponent(String(requestParameters['pk']))).replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters['projectId']))).replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug']))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Permanently remove an attachment from a work item. Records deletion activity for audit purposes.
+     * Endpoints for issue attachment create/update/delete and fetch issue attachment details
+     */
+    async deleteWorkItemAttachment(requestParameters: DeleteWorkItemAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteWorkItemAttachmentRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Retrieve all attachments for a work item.
+     * Endpoints for issue attachment create/update/delete and fetch issue attachment details
+     */
+    async listWorkItemAttachmentsRaw(requestParameters: ListWorkItemAttachmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IssueAttachment>> {
+        if (requestParameters['issueId'] == null) {
+            throw new runtime.RequiredError(
+                'issueId',
+                'Required parameter "issueId" was null or undefined when calling listWorkItemAttachments().'
+            );
+        }
+
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling listWorkItemAttachments().'
+            );
+        }
+
+        if (requestParameters['slug'] == null) {
+            throw new runtime.RequiredError(
+                'slug',
+                'Required parameter "slug" was null or undefined when calling listWorkItemAttachments().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuthentication authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/`.replace(`{${"issue_id"}}`, encodeURIComponent(String(requestParameters['issueId']))).replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters['projectId']))).replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => IssueAttachmentFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve all attachments for a work item.
+     * Endpoints for issue attachment create/update/delete and fetch issue attachment details
+     */
+    async listWorkItemAttachments(requestParameters: ListWorkItemAttachmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IssueAttachment> {
+        const response = await this.listWorkItemAttachmentsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Download attachment file. Returns a redirect to the presigned download URL.
+     * Endpoints for issue attachment create/update/delete and fetch issue attachment details
+     */
+    async retrieveWorkItemAttachmentRaw(requestParameters: RetrieveWorkItemAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['issueId'] == null) {
+            throw new runtime.RequiredError(
+                'issueId',
+                'Required parameter "issueId" was null or undefined when calling retrieveWorkItemAttachment().'
+            );
+        }
+
+        if (requestParameters['pk'] == null) {
+            throw new runtime.RequiredError(
+                'pk',
+                'Required parameter "pk" was null or undefined when calling retrieveWorkItemAttachment().'
+            );
+        }
+
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling retrieveWorkItemAttachment().'
+            );
+        }
+
+        if (requestParameters['slug'] == null) {
+            throw new runtime.RequiredError(
+                'slug',
+                'Required parameter "slug" was null or undefined when calling retrieveWorkItemAttachment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuthentication authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2Authentication", []);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{pk}/`.replace(`{${"issue_id"}}`, encodeURIComponent(String(requestParameters['issueId']))).replace(`{${"pk"}}`, encodeURIComponent(String(requestParameters['pk']))).replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters['projectId']))).replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Download attachment file. Returns a redirect to the presigned download URL.
+     * Endpoints for issue attachment create/update/delete and fetch issue attachment details
+     */
+    async retrieveWorkItemAttachment(requestParameters: RetrieveWorkItemAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.retrieveWorkItemAttachmentRaw(requestParameters, initOverrides);
+    }
+
+}