@makeplane/plane-node-sdk 0.1.3 → 0.1.5

package/src/apis/WorkItemsApi.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.
@@ -15,6 +15,11 @@
 import * as runtime from '../runtime';
 import type {
   Issue,
+  IssueDetail,
+  IssueRelation,
+  IssueRelationCreateRequest,
+  IssueRelationRemoveRequest,
+  IssueRelationResponse,
   IssueRequest,
   IssueSearch,
   PaginatedWorkItemResponse,
@@ -23,6 +28,16 @@ import type {
 import {
     IssueFromJSON,
     IssueToJSON,
+    IssueDetailFromJSON,
+    IssueDetailToJSON,
+    IssueRelationFromJSON,
+    IssueRelationToJSON,
+    IssueRelationCreateRequestFromJSON,
+    IssueRelationCreateRequestToJSON,
+    IssueRelationRemoveRequestFromJSON,
+    IssueRelationRemoveRequestToJSON,
+    IssueRelationResponseFromJSON,
+    IssueRelationResponseToJSON,
     IssueRequestFromJSON,
     IssueRequestToJSON,
     IssueSearchFromJSON,
@@ -39,6 +54,13 @@ export interface CreateWorkItemRequest {
     issueRequest: IssueRequest;
 }
 
+export interface CreateWorkItemRelationRequest {
+    issueId: string;
+    projectId: string;
+    slug: string;
+    issueRelationCreateRequest: IssueRelationCreateRequest;
+}
+
 export interface DeleteWorkItemRequest {
     pk: string;
     projectId: string;
@@ -51,6 +73,17 @@ export interface GetWorkspaceWorkItemRequest {
     slug: string;
 }
 
+export interface ListWorkItemRelationsRequest {
+    issueId: string;
+    projectId: string;
+    slug: string;
+    cursor?: string;
+    expand?: string;
+    fields?: string;
+    orderBy?: string;
+    perPage?: number;
+}
+
 export interface ListWorkItemsRequest {
     projectId: string;
     slug: string;
@@ -63,6 +96,13 @@ export interface ListWorkItemsRequest {
     perPage?: number;
 }
 
+export interface RemoveWorkItemRelationRequest {
+    issueId: string;
+    projectId: string;
+    slug: string;
+    issueRelationRemoveRequest: IssueRelationRemoveRequest;
+}
+
 export interface RetrieveWorkItemRequest {
     pk: string;
     projectId: string;
@@ -160,6 +200,79 @@ export class WorkItemsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Create relationships between work items. Supports various relation types including blocking, blocked_by, duplicate, relates_to, start_before, start_after, finish_before, and finish_after.
+     * Create work item relation
+     */
+    async createWorkItemRelationRaw(requestParameters: CreateWorkItemRelationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IssueRelation>>> {
+        if (requestParameters['issueId'] == null) {
+            throw new runtime.RequiredError(
+                'issueId',
+                'Required parameter "issueId" was null or undefined when calling createWorkItemRelation().'
+            );
+        }
+
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling createWorkItemRelation().'
+            );
+        }
+
+        if (requestParameters['slug'] == null) {
+            throw new runtime.RequiredError(
+                'slug',
+                'Required parameter "slug" was null or undefined when calling createWorkItemRelation().'
+            );
+        }
+
+        if (requestParameters['issueRelationCreateRequest'] == null) {
+            throw new runtime.RequiredError(
+                'issueRelationCreateRequest',
+                'Required parameter "issueRelationCreateRequest" was null or undefined when calling createWorkItemRelation().'
+            );
+        }
+
+        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}/relations/`.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: IssueRelationCreateRequestToJSON(requestParameters['issueRelationCreateRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(IssueRelationFromJSON));
+    }
+
+    /**
+     * Create relationships between work items. Supports various relation types including blocking, blocked_by, duplicate, relates_to, start_before, start_after, finish_before, and finish_after.
+     * Create work item relation
+     */
+    async createWorkItemRelation(requestParameters: CreateWorkItemRelationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IssueRelation>> {
+        const response = await this.createWorkItemRelationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Permanently delete an existing work item from the project. Only admins or the item creator can perform this action.
      * Delete work item
@@ -285,6 +398,89 @@ export class WorkItemsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Retrieve all relationships for a work item including blocking, blocked_by, duplicate, relates_to, start_before, start_after, finish_before, and finish_after relations.
+     * List work item relations
+     */
+    async listWorkItemRelationsRaw(requestParameters: ListWorkItemRelationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IssueRelationResponse>> {
+        if (requestParameters['issueId'] == null) {
+            throw new runtime.RequiredError(
+                'issueId',
+                'Required parameter "issueId" was null or undefined when calling listWorkItemRelations().'
+            );
+        }
+
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling listWorkItemRelations().'
+            );
+        }
+
+        if (requestParameters['slug'] == null) {
+            throw new runtime.RequiredError(
+                'slug',
+                'Required parameter "slug" was null or undefined when calling listWorkItemRelations().'
+            );
+        }
+
+        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}/relations/`.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) => IssueRelationResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve all relationships for a work item including blocking, blocked_by, duplicate, relates_to, start_before, start_after, finish_before, and finish_after relations.
+     * List work item relations
+     */
+    async listWorkItemRelations(requestParameters: ListWorkItemRelationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IssueRelationResponse> {
+        const response = await this.listWorkItemRelationsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieve a paginated list of all work items in a project. Supports filtering, ordering, and field selection through query parameters.
      * List work items
@@ -369,11 +565,83 @@ export class WorkItemsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Remove a relationship between work items by specifying the related work item ID.
+     * Remove work item relation
+     */
+    async removeWorkItemRelationRaw(requestParameters: RemoveWorkItemRelationRequest, 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 removeWorkItemRelation().'
+            );
+        }
+
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling removeWorkItemRelation().'
+            );
+        }
+
+        if (requestParameters['slug'] == null) {
+            throw new runtime.RequiredError(
+                'slug',
+                'Required parameter "slug" was null or undefined when calling removeWorkItemRelation().'
+            );
+        }
+
+        if (requestParameters['issueRelationRemoveRequest'] == null) {
+            throw new runtime.RequiredError(
+                'issueRelationRemoveRequest',
+                'Required parameter "issueRelationRemoveRequest" was null or undefined when calling removeWorkItemRelation().'
+            );
+        }
+
+        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}/relations/remove/`.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: IssueRelationRemoveRequestToJSON(requestParameters['issueRelationRemoveRequest']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Remove a relationship between work items by specifying the related work item ID.
+     * Remove work item relation
+     */
+    async removeWorkItemRelation(requestParameters: RemoveWorkItemRelationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.removeWorkItemRelationRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Retrieve details of a specific work item.
      * Retrieve work item
      */
-    async retrieveWorkItemRaw(requestParameters: RetrieveWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Issue>> {
+    async retrieveWorkItemRaw(requestParameters: RetrieveWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IssueDetail>> {
         if (requestParameters['pk'] == null) {
             throw new runtime.RequiredError(
                 'pk',
@@ -440,14 +708,14 @@ export class WorkItemsApi extends runtime.BaseAPI {
             query: queryParameters,
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => IssueFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => IssueDetailFromJSON(jsonValue));
     }
 
     /**
      * Retrieve details of a specific work item.
      * Retrieve work item
      */
-    async retrieveWorkItem(requestParameters: RetrieveWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Issue> {
+    async retrieveWorkItem(requestParameters: RetrieveWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IssueDetail> {
         const response = await this.retrieveWorkItemRaw(requestParameters, initOverrides);
         return await response.value();
     }

package/src/apis/WorkspacesApi.ts

@@ -0,0 +1,80 @@
+/* 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.2
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+
+export interface WorkspacesProjectsMembersCreateRequest {
+    projectId: string;
+    slug: string;
+}
+
+/**
+ * 
+ */
+export class WorkspacesApi extends runtime.BaseAPI {
+
+    /**
+     * This enables timezone conversion according to the user set timezone
+     */
+    async workspacesProjectsMembersCreateRaw(requestParameters: WorkspacesProjectsMembersCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling workspacesProjectsMembersCreate().'
+            );
+        }
+
+        if (requestParameters['slug'] == null) {
+            throw new runtime.RequiredError(
+                'slug',
+                'Required parameter "slug" was null or undefined when calling workspacesProjectsMembersCreate().'
+            );
+        }
+
+        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}/members/`.replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters['projectId']))).replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * This enables timezone conversion according to the user set timezone
+     */
+    async workspacesProjectsMembersCreate(requestParameters: WorkspacesProjectsMembersCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.workspacesProjectsMembersCreateRaw(requestParameters, initOverrides);
+    }
+
+}

package/src/apis/index.ts

@@ -2,10 +2,12 @@
  
 export * from './AssetsApi';
 export * from './CyclesApi';
+export * from './EpicsApi';
 export * from './IntakeApi';
 export * from './LabelsApi';
 export * from './MembersApi';
 export * from './ModulesApi';
+export * from './PagesApi';
 export * from './ProjectsApi';
 export * from './StatesApi';
 export * from './UsersApi';
@@ -17,3 +19,4 @@ export * from './WorkItemPropertiesApi';
 export * from './WorkItemTypesApi';
 export * from './WorkItemWorklogsApi';
 export * from './WorkItemsApi';
+export * from './WorkspacesApi';

package/src/models/AccessBd4Enum.ts

@@ -0,0 +1,53 @@
+/* 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.2
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * * `INTERNAL` - INTERNAL
+ * * `EXTERNAL` - EXTERNAL
+ * @export
+ */
+export const AccessBd4Enum = {
+    Internal: 'INTERNAL',
+    External: 'EXTERNAL'
+} as const;
+export type AccessBd4Enum = typeof AccessBd4Enum[keyof typeof AccessBd4Enum];
+
+
+export function instanceOfAccessBd4Enum(value: any): boolean {
+    for (const key in AccessBd4Enum) {
+        if (Object.prototype.hasOwnProperty.call(AccessBd4Enum, key)) {
+            if (AccessBd4Enum[key as keyof typeof AccessBd4Enum] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function AccessBd4EnumFromJSON(json: any): AccessBd4Enum {
+    return AccessBd4EnumFromJSONTyped(json, false);
+}
+
+export function AccessBd4EnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccessBd4Enum {
+    return json as AccessBd4Enum;
+}
+
+export function AccessBd4EnumToJSON(value?: AccessBd4Enum | null): any {
+    return value as any;
+}
+
+export function AccessBd4EnumToJSONTyped(value: any, ignoreDiscriminator: boolean): AccessBd4Enum {
+    return value as AccessBd4Enum;
+}
+

package/src/models/Cycle.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/CycleCreateRequest.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/CycleIssue.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/CycleIssueRequestRequest.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/CycleLite.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/EntityTypeEnum.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.