@arrowsphere/api-client 3.24.0-rc.1 → 3.24.0-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,6 @@
1
- export declare type CreateAttachmentPayload = {
2
- fileName: string;
3
- mimeType: string;
4
- content: string;
1
+ import { IssueAttachmentFields } from '../entities/issue/attachment';
2
+ export declare type AddIssueAttachmentPayload = {
3
+ [IssueAttachmentFields.COLUMN_FILE_NAME]: string;
4
+ [IssueAttachmentFields.COLUMN_MIME_TYPE]: string;
5
+ [IssueAttachmentFields.COLUMN_CONTENT]: string;
5
6
  };
@@ -1,3 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ const attachment_1 = require("../entities/issue/attachment");
3
4
  //# sourceMappingURL=attachment.js.map
@@ -1,5 +1,6 @@
1
1
  import { IssueCreatedByType } from '../entities/issue/issue';
2
- export declare type CreateCommentPayload = {
3
- body: string;
4
- createdBy?: IssueCreatedByType;
2
+ import { IssueCommentFields } from '../entities/issue/comment';
3
+ export declare type AddIssueCommentPayload = {
4
+ [IssueCommentFields.COLUMN_BODY]: string;
5
+ [IssueCommentFields.COLUMN_CREATED_BY]?: IssueCreatedByType;
5
6
  };
@@ -1,3 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ const comment_1 = require("../entities/issue/comment");
3
4
  //# sourceMappingURL=comment.js.map
@@ -1,18 +1,18 @@
1
- import { IssueAdditionalDataType, IssueCreatedByType, IssueOfferType, IssueStatusesType } from '../entities/issue/issue';
1
+ import { IssueAdditionalDataType, IssueCreatedByType, IssueFields, IssueOfferType, IssueStatusesType } from '../entities/issue/issue';
2
2
  import { Payload } from '../../abstractClient';
3
3
  export declare enum IssueProgramsType {
4
4
  MSCSP = "MSCSP",
5
5
  ARWS_AMS = "ARWS-AMS"
6
6
  }
7
7
  export declare type CreateIssuePayload = {
8
- title: string;
9
- description: string;
10
- topicId: string;
11
- program: IssueProgramsType;
12
- offer?: IssueOfferType;
13
- createdBy?: IssueCreatedByType;
14
- endCustomerRef?: string;
15
- additionalData?: Array<IssueAdditionalDataType>;
8
+ [IssueFields.COLUMN_TITLE]: string;
9
+ [IssueFields.COLUMN_DESCRIPTION]: string;
10
+ [IssueFields.COLUMN_TOPIC_ID]: string;
11
+ [IssueFields.COLUMN_PROGRAM]: IssueProgramsType;
12
+ [IssueFields.COLUMN_OFFER]?: IssueOfferType;
13
+ [IssueFields.COLUMN_CREATED_BY]?: IssueCreatedByType;
14
+ [IssueFields.COLUMN_END_CUSTOMER_REF]?: string;
15
+ [IssueFields.COLUMN_ADDITIONAL_DATA]?: Array<IssueAdditionalDataType>;
16
16
  };
17
17
  export declare type UpdateIssueStatusOperation = {
18
18
  op: 'replace';
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.StatusDetailsValueEnum = exports.IssueProgramsType = void 0;
4
+ const issue_1 = require("../entities/issue/issue");
4
5
  var IssueProgramsType;
5
6
  (function (IssueProgramsType) {
6
7
  IssueProgramsType["MSCSP"] = "MSCSP";
@@ -4,8 +4,8 @@ import { GetResult } from '../getResult';
4
4
  import { IssueAttachment, IssueAttachments } from './entities/issue/attachment';
5
5
  import { CreateIssuePayload, UpdateIssuePayload } from './payloads/issue';
6
6
  import { IssueComment, IssueComments } from './entities/issue/comment';
7
- import { CreateCommentPayload } from './payloads/comment';
8
- import { CreateAttachmentPayload } from './payloads/attachment';
7
+ import { AddIssueCommentPayload } from './payloads/comment';
8
+ import { AddIssueAttachmentPayload } from './payloads/attachment';
9
9
  import { Topics } from './entities/topic';
10
10
  export declare enum ListIssueParametersFields {
11
11
  DIR = "dir",
@@ -34,9 +34,9 @@ export declare class SupportCenterClient extends AbstractClient {
34
34
  createIssue(issuePayload: CreateIssuePayload, parameters?: Parameters): Promise<GetResult<Issue>>;
35
35
  getIssue(issueId: string, parameters?: Parameters): Promise<GetResult<Issue>>;
36
36
  updateIssue(issueId: string, payload: UpdateIssuePayload, parameters?: Parameters): Promise<GetResult<Issue>>;
37
- listComments(issueId: string, parameters?: Parameters): Promise<GetResult<IssueComments>>;
38
- addComment(issueId: string, payload: CreateCommentPayload, parameters?: Parameters): Promise<GetResult<IssueComment>>;
39
- listAttachments(issueId: string, parameters?: Parameters): Promise<GetResult<IssueAttachments>>;
40
- addAttachment(issueId: string, payload: CreateAttachmentPayload, parameters?: Parameters): Promise<GetResult<IssueAttachment>>;
41
- downloadAttachment(issueId: string, attachmentId: string, parameters?: Parameters): Promise<GetResult<IssueAttachment>>;
37
+ listIssueComments(issueId: string, parameters?: Parameters): Promise<GetResult<IssueComments>>;
38
+ addIssueComment(issueId: string, payload: AddIssueCommentPayload, parameters?: Parameters): Promise<GetResult<IssueComment>>;
39
+ listIssueAttachments(issueId: string, parameters?: Parameters): Promise<GetResult<IssueAttachments>>;
40
+ addIssueAttachment(issueId: string, payload: AddIssueAttachmentPayload, parameters?: Parameters): Promise<GetResult<IssueAttachment>>;
41
+ downloadIssueAttachment(issueId: string, attachmentId: string, parameters?: Parameters): Promise<GetResult<IssueAttachment>>;
42
42
  }
@@ -40,27 +40,27 @@ class SupportCenterClient extends abstractClient_1.AbstractClient {
40
40
  return new getResult_1.GetResult(issue_1.Issue, await this.get(parameters));
41
41
  }
42
42
  async updateIssue(issueId, payload, parameters = {}) {
43
- this.path = `/${issueId}`;
43
+ this.path = `/issues/${issueId}`;
44
44
  return new getResult_1.GetResult(issue_1.Issue, await this.patch(payload, parameters));
45
45
  }
46
- async listComments(issueId, parameters = {}) {
47
- this.path = `/${issueId}/comments`;
46
+ async listIssueComments(issueId, parameters = {}) {
47
+ this.path = `/issues/${issueId}/comments`;
48
48
  return new getResult_1.GetResult(comment_1.IssueComments, await this.get(parameters));
49
49
  }
50
- async addComment(issueId, payload, parameters = {}) {
51
- this.path = `/${issueId}/comments`;
50
+ async addIssueComment(issueId, payload, parameters = {}) {
51
+ this.path = `/issues/${issueId}/comments`;
52
52
  return new getResult_1.GetResult(comment_1.IssueComment, await this.post(payload, parameters));
53
53
  }
54
- async listAttachments(issueId, parameters = {}) {
55
- this.path = `/${issueId}/attachments`;
54
+ async listIssueAttachments(issueId, parameters = {}) {
55
+ this.path = `/issues/${issueId}/attachments`;
56
56
  return new getResult_1.GetResult(attachment_1.IssueAttachments, await this.get(parameters));
57
57
  }
58
- async addAttachment(issueId, payload, parameters = {}) {
59
- this.path = `/${issueId}/attachments`;
58
+ async addIssueAttachment(issueId, payload, parameters = {}) {
59
+ this.path = `/issues/${issueId}/attachments`;
60
60
  return new getResult_1.GetResult(attachment_1.IssueAttachment, await this.post(payload, parameters));
61
61
  }
62
- async downloadAttachment(issueId, attachmentId, parameters = {}) {
63
- this.path = `/${issueId}/attachments/${attachmentId}`;
62
+ async downloadIssueAttachment(issueId, attachmentId, parameters = {}) {
63
+ this.path = `/issues/${issueId}/attachments/${attachmentId}`;
64
64
  return new getResult_1.GetResult(attachment_1.IssueAttachment, await this.get(parameters));
65
65
  }
66
66
  }
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "type": "git",
5
5
  "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
6
6
  },
7
- "version": "3.24.0-rc.1",
7
+ "version": "3.24.0-rc.2",
8
8
  "description": "Node.js client for ArrowSphere's public API",
9
9
  "main": "build/index.js",
10
10
  "types": "build/index.d.ts",