@makeplane/plane-node-sdk 0.1.4 → 0.1.5

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.

package/src/models/Epic.ts

@@ -0,0 +1,302 @@
+/* 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 { mapValues } from '../runtime';
+import type { PriorityEnum } from './PriorityEnum';
+import {
+    PriorityEnumFromJSON,
+    PriorityEnumFromJSONTyped,
+    PriorityEnumToJSON,
+    PriorityEnumToJSONTyped,
+} from './PriorityEnum';
+
+/**
+ * 
+ * @export
+ * @interface Epic
+ */
+export interface Epic {
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Epic
+     */
+    readonly deletedAt?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Epic
+     */
+    readonly createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Epic
+     */
+    readonly updatedAt?: Date;
+    /**
+     * 
+     * @type {number}
+     * @memberof Epic
+     */
+    point?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    name: string;
+    /**
+     * 
+     * @type {any}
+     * @memberof Epic
+     */
+    description?: any | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    descriptionHtml?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    descriptionStripped?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    readonly descriptionBinary?: string | null;
+    /**
+     * 
+     * @type {PriorityEnum}
+     * @memberof Epic
+     */
+    priority?: PriorityEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Epic
+     */
+    startDate?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Epic
+     */
+    targetDate?: Date | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof Epic
+     */
+    sequenceId?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof Epic
+     */
+    sortOrder?: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Epic
+     */
+    completedAt?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Epic
+     */
+    archivedAt?: Date | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Epic
+     */
+    isDraft?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    externalId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    createdBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    updatedBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    project: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    workspace: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    parent?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    state?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    estimatePoint?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Epic
+     */
+    type?: string | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof Epic
+     */
+    readonly assignees?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof Epic
+     */
+    readonly labels?: Array<string>;
+}
+
+
+
+/**
+ * Check if a given object implements the Epic interface.
+ */
+export function instanceOfEpic(value: object): value is Epic {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('project' in value) || value['project'] === undefined) return false;
+    if (!('workspace' in value) || value['workspace'] === undefined) return false;
+    return true;
+}
+
+export function EpicFromJSON(json: any): Epic {
+    return EpicFromJSONTyped(json, false);
+}
+
+export function EpicFromJSONTyped(json: any, ignoreDiscriminator: boolean): Epic {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'deletedAt': json['deleted_at'] == null ? undefined : (new Date(json['deleted_at'])),
+        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
+        'updatedAt': json['updated_at'] == null ? undefined : (new Date(json['updated_at'])),
+        'point': json['point'] == null ? undefined : json['point'],
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'descriptionHtml': json['description_html'] == null ? undefined : json['description_html'],
+        'descriptionStripped': json['description_stripped'] == null ? undefined : json['description_stripped'],
+        'descriptionBinary': json['description_binary'] == null ? undefined : json['description_binary'],
+        'priority': json['priority'] == null ? undefined : PriorityEnumFromJSON(json['priority']),
+        'startDate': json['start_date'] == null ? undefined : (new Date(json['start_date'])),
+        'targetDate': json['target_date'] == null ? undefined : (new Date(json['target_date'])),
+        'sequenceId': json['sequence_id'] == null ? undefined : json['sequence_id'],
+        'sortOrder': json['sort_order'] == null ? undefined : json['sort_order'],
+        'completedAt': json['completed_at'] == null ? undefined : (new Date(json['completed_at'])),
+        'archivedAt': json['archived_at'] == null ? undefined : (new Date(json['archived_at'])),
+        'isDraft': json['is_draft'] == null ? undefined : json['is_draft'],
+        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+        'createdBy': json['created_by'] == null ? undefined : json['created_by'],
+        'updatedBy': json['updated_by'] == null ? undefined : json['updated_by'],
+        'project': json['project'],
+        'workspace': json['workspace'],
+        'parent': json['parent'] == null ? undefined : json['parent'],
+        'state': json['state'] == null ? undefined : json['state'],
+        'estimatePoint': json['estimate_point'] == null ? undefined : json['estimate_point'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'assignees': json['assignees'] == null ? undefined : json['assignees'],
+        'labels': json['labels'] == null ? undefined : json['labels'],
+    };
+}
+
+export function EpicToJSON(json: any): Epic {
+    return EpicToJSONTyped(json, false);
+}
+
+export function EpicToJSONTyped(value?: Omit<Epic, 'id'|'deleted_at'|'created_at'|'updated_at'|'description_binary'|'assignees'|'labels'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'point': value['point'],
+        'name': value['name'],
+        'description': value['description'],
+        'description_html': value['descriptionHtml'],
+        'description_stripped': value['descriptionStripped'],
+        'priority': PriorityEnumToJSON(value['priority']),
+        'start_date': value['startDate'] == null ? undefined : ((value['startDate'] as any).toISOString().substring(0,10)),
+        'target_date': value['targetDate'] == null ? undefined : ((value['targetDate'] as any).toISOString().substring(0,10)),
+        'sequence_id': value['sequenceId'],
+        'sort_order': value['sortOrder'],
+        'completed_at': value['completedAt'] == null ? undefined : ((value['completedAt'] as any).toISOString()),
+        'archived_at': value['archivedAt'] == null ? undefined : ((value['archivedAt'] as any).toISOString().substring(0,10)),
+        'is_draft': value['isDraft'],
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+        'created_by': value['createdBy'],
+        'updated_by': value['updatedBy'],
+        'project': value['project'],
+        'workspace': value['workspace'],
+        'parent': value['parent'],
+        'state': value['state'],
+        'estimate_point': value['estimatePoint'],
+        'type': value['type'],
+    };
+}
+

package/src/models/GenericAssetUploadRequest.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/GetWorkspaceMembers200ResponseInner.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/GroupEnum.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/IntakeIssue.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/IntakeIssueCreateRequest.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/IntakeWorkItemStatusEnum.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/Issue.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/IssueActivity.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/IssueAttachment.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/IssueAttachmentUploadRequest.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/IssueComment.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.
@@ -12,13 +12,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { AccessEnum } from './AccessEnum';
+import type { AccessBd4Enum } from './AccessBd4Enum';
 import {
-    AccessEnumFromJSON,
-    AccessEnumFromJSONTyped,
-    AccessEnumToJSON,
-    AccessEnumToJSONTyped,
-} from './AccessEnum';
+    AccessBd4EnumFromJSON,
+    AccessBd4EnumFromJSONTyped,
+    AccessBd4EnumToJSON,
+    AccessBd4EnumToJSONTyped,
+} from './AccessBd4Enum';
 
 /**
  * Full serializer for work item comments with membership context.
@@ -79,10 +79,10 @@ export interface IssueComment {
     attachments?: Array<string>;
     /**
      * 
-     * @type {AccessEnum}
+     * @type {AccessBd4Enum}
      * @memberof IssueComment
      */
-    access?: AccessEnum;
+    access?: AccessBd4Enum;
     /**
      * 
      * @type {string}
@@ -166,7 +166,7 @@ export function IssueCommentFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'commentStripped': json['comment_stripped'] == null ? undefined : json['comment_stripped'],
         'commentHtml': json['comment_html'] == null ? undefined : json['comment_html'],
         'attachments': json['attachments'] == null ? undefined : json['attachments'],
-        'access': json['access'] == null ? undefined : AccessEnumFromJSON(json['access']),
+        'access': json['access'] == null ? undefined : AccessBd4EnumFromJSON(json['access']),
         'externalSource': json['external_source'] == null ? undefined : json['external_source'],
         'externalId': json['external_id'] == null ? undefined : json['external_id'],
         'editedAt': json['edited_at'] == null ? undefined : (new Date(json['edited_at'])),
@@ -194,7 +194,7 @@ export function IssueCommentToJSONTyped(value?: Omit<IssueComment, 'id'|'is_memb
         'comment_stripped': value['commentStripped'],
         'comment_html': value['commentHtml'],
         'attachments': value['attachments'],
-        'access': AccessEnumToJSON(value['access']),
+        'access': AccessBd4EnumToJSON(value['access']),
         'external_source': value['externalSource'],
         'external_id': value['externalId'],
         'edited_at': value['editedAt'] == null ? undefined : ((value['editedAt'] as any).toISOString()),