#213 ServiceDesk experimental API fixed. 'X-ExperimentalApi': 'opt-in' header added (#214)

Author: MrRefactoring

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Jira.js changelog
 
+### 2.15.1
+
+- ServiceDesk for experimental API `'X-ExperimentalApi': 'opt-in'` header added.
+
 ### 2.15.0
 
 - Version 3: addWorklog and updateWorklog comment field type fixed. Thanks to [RealBuddy](https://github.com/RealBuddy) for reporting the issue.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "jira.js",
-  "version": "2.15.0",
+  "version": "2.15.1",
   "description": "jira.js is a powerful Node.JS/Browser module that allows you to interact with the Jira API very easily",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -53,7 +53,7 @@
   "devDependencies": {
     "@swc-node/register": "^1.5.1",
     "@types/express": "^4.17.13",
-    "@types/node": "^17.0.42",
+    "@types/node": "^18.0.0",
     "@types/oauth": "^0.9.1",
     "@types/sinon": "^10.0.11",
     "@typescript-eslint/eslint-plugin": "^5.28.0",
@@ -66,7 +66,7 @@
     "eslint-import-resolver-typescript": "^2.7.1",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-sort-exports": "^0.6.0",
-    "prettier": "^2.7.0",
+    "prettier": "^2.7.1",
     "prettier-plugin-jsdoc": "^0.3.38",
     "sinon": "^14.0.0",
     "typedoc": "^0.22.17",

package.json

@@ -30,6 +30,9 @@ export class KnowledgeBase {
     const config: RequestConfig = {
       url: '/rest/servicedeskapi/knowledgebase/article',
       method: 'GET',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
       params: {
         query: parameters.query,
         highlight: parameters.highlight,

src/serviceDesk/knowledgeBase.ts

@@ -605,6 +605,9 @@ export class Request {
     const config: RequestConfig = {
       url: `/rest/servicedeskapi/request/${parameters.issueIdOrKey}/comment/${parameters.commentId}/attachment`,
       method: 'GET',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
       params: {
         start: parameters.start,
         limit: parameters.limit,
@@ -1026,6 +1029,9 @@ export class Request {
     const config: RequestConfig = {
       url: `/rest/servicedeskapi/request/${parameters.requestIdOrKey}/feedback`,
       method: 'GET',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
     };
 
     return this.client.sendRequest(config, callback);
@@ -1055,6 +1061,9 @@ export class Request {
     const config: RequestConfig = {
       url: `/rest/servicedeskapi/request/${parameters.requestIdOrKey}/feedback`,
       method: 'POST',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
       data: {
         type: parameters.type,
         rating: parameters.rating,
@@ -1083,6 +1092,9 @@ export class Request {
     const config: RequestConfig = {
       url: `/rest/servicedeskapi/request/${parameters.requestIdOrKey}/feedback`,
       method: 'DELETE',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
     };
 
     return this.client.sendRequest(config, callback);

src/serviceDesk/request.ts

@@ -48,6 +48,9 @@ export class RequestType {
     const config: RequestConfig = {
       url: '/rest/servicedeskapi/requesttype',
       method: 'GET',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
       params: {
         searchQuery: parameters?.searchQuery,
         serviceDeskId: parameters?.serviceDeskId,

src/serviceDesk/requestType.ts

@@ -153,6 +153,9 @@ export class ServiceDesk {
     const config: RequestConfig = {
       url: `/rest/servicedeskapi/servicedesk/${parameters.serviceDeskId}/customer`,
       method: 'GET',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
       params: {
         query: parameters.query,
         start: parameters.start,
@@ -214,6 +217,9 @@ export class ServiceDesk {
     const config: RequestConfig = {
       url: `/rest/servicedeskapi/servicedesk/${parameters.serviceDeskId}/customer`,
       method: 'DELETE',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
       data: {
         usernames: parameters.usernames,
         accountIds: parameters.accountIds,
@@ -244,6 +250,9 @@ export class ServiceDesk {
     const config: RequestConfig = {
       url: `/rest/servicedeskapi/servicedesk/${parameters.serviceDeskId}/knowledgebase/article`,
       method: 'GET',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
       params: {
         query: parameters.query,
         highlight: parameters.highlight,
@@ -450,6 +459,9 @@ export class ServiceDesk {
     const config: RequestConfig = {
       url: `/rest/servicedeskapi/servicedesk/${parameters.serviceDeskId}/requesttype`,
       method: 'POST',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
       data: {
         issueTypeId: parameters.issueTypeId,
         name: parameters.name,
@@ -519,6 +531,9 @@ export class ServiceDesk {
     const config: RequestConfig = {
       url: `/rest/servicedeskapi/servicedesk/${parameters.serviceDeskId}/requesttype/${parameters.requestTypeId}`,
       method: 'DELETE',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
     };
 
     return this.client.sendRequest(config, callback);
@@ -608,6 +623,9 @@ export class ServiceDesk {
     const config: RequestConfig = {
       url: `/rest/servicedeskapi/servicedesk/${parameters.serviceDeskId}/requesttype/${parameters.requestTypeId}/property`,
       method: 'GET',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
     };
 
     return this.client.sendRequest(config, callback);
@@ -647,6 +665,9 @@ export class ServiceDesk {
     const config: RequestConfig = {
       url: `/rest/servicedeskapi/servicedesk/${parameters.serviceDeskId}/requesttype/${parameters.requestTypeId}/property/${parameters.propertyKey}`,
       method: 'GET',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
     };
 
     return this.client.sendRequest(config, callback);
@@ -680,6 +701,9 @@ export class ServiceDesk {
     const config: RequestConfig = {
       url: `/rest/servicedeskapi/servicedesk/${parameters.serviceDeskId}/requesttype/${parameters.requestTypeId}/property/${parameters.propertyKey}`,
       method: 'PUT',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
     };
 
     return this.client.sendRequest(config, callback);
@@ -713,6 +737,9 @@ export class ServiceDesk {
     const config: RequestConfig = {
       url: `/rest/servicedeskapi/servicedesk/${parameters.serviceDeskId}/requesttype/${parameters.requestTypeId}/property/${parameters.propertyKey}`,
       method: 'DELETE',
+      headers: {
+        'X-ExperimentalApi': 'opt-in',
+      },
     };
 
     return this.client.sendRequest(config, callback);