@resolution/jira-api-client 0.5.2 → 0.5.3

package/lib/openapi/platform/services/WebhooksService.js

@@ -30,10 +30,11 @@ class WebhooksService extends CommonHttpService_1.CommonHttpService {
          * 2.0](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps) apps
          * can use this operation.
          *
-         * @path {DELETE} /rest/api/3/webhook
+         * @path DELETE `/rest/api/3/webhook`
          * @scopes-current read:jira-work, manage:jira-webhook
          * @scopes-beta delete:webhook:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks#api-rest-api-3-webhook-delete
+         * @param params
          */
         this.deleteWebhookById = ({ containerForWebhookIds, }) => {
             return this.getClientInstance()
@@ -59,7 +60,9 @@ class WebhooksService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": true,
          *   "maxResults": 3,
          *   "startAt": 0,
@@ -99,10 +102,12 @@ class WebhooksService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/webhook
+         * ```
+         * @path GET `/rest/api/3/webhook`
          * @scopes-current read:jira-work, manage:jira-webhook
          * @scopes-beta read:webhook:jira, read:jql:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks#api-rest-api-3-webhook-get
+         * @param params
          */
         this.getDynamicWebhooksForApp = ({ startAt, maxResults, } = {}) => {
             return this.getClientInstance()
@@ -141,7 +146,9 @@ class WebhooksService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "values": [
          *     {
          *       "id": "1",
@@ -156,15 +163,14 @@ class WebhooksService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ],
          *   "maxResults": 100,
-         *   "next":
-         * "https://your-domain.atlassian.net/rest/api/3/webhook/failed?failedAfter=1573540473480&maxResults=100"
+         *   "next": "https://your-domain.atlassian.net/rest/api/3/webhook/failed?failedAfter=1573540473480&maxResults=100"
          * }
-         * @path {GET} /rest/api/3/webhook/failed
+         * ```
+         * @path GET `/rest/api/3/webhook/failed`
          * @scopes-current read:jira-work, manage:jira-webhook
-         * @scopes-beta read:issue-details:jira, read:webhook:jira, read:comment.property:jira,
-         * read:group:jira, read:issue-type:jira, read:project-role:jira,
-         * read:epic:jira-software
+         * @scopes-beta read:issue-details:jira, read:webhook:jira, read:comment.property:jira, read:group:jira, read:issue-type:jira, read:project-role:jira, read:epic:jira-software
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks#api-rest-api-3-webhook-failed-get
+         * @param params
          */
         this.getFailedWebhooks = ({ maxResults, after, } = {}) => {
             return this.getClientInstance()
@@ -200,13 +206,17 @@ class WebhooksService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "expirationDate": "2019-06-01T12:42:30.000+0000"
          * }
-         * @path {PUT} /rest/api/3/webhook/refresh
+         * ```
+         * @path PUT `/rest/api/3/webhook/refresh`
          * @scopes-current read:jira-work, manage:jira-webhook
          * @scopes-beta write:webhook:jira, read:webhook:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks#api-rest-api-3-webhook-refresh-put
+         * @param params
          */
         this.refreshWebhooks = ({ containerForWebhookIds, }) => {
             return this.getClientInstance()
@@ -241,7 +251,9 @@ class WebhooksService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "webhookRegistrationResult": [
          *     {
          *       "createdWebhookId": 1000
@@ -256,10 +268,12 @@ class WebhooksService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {POST} /rest/api/3/webhook
+         * ```
+         * @path POST `/rest/api/3/webhook`
          * @scopes-current read:jira-work, manage:jira-webhook
          * @scopes-beta read:field:jira, read:project:jira, write:webhook:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks#api-rest-api-3-webhook-post
+         * @param params
          */
         this.registerDynamicWebhooks = ({ webhookRegistrationDetails, }) => {
             return this.getClientInstance()

package/lib/openapi/platform/services/WebhooksService.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebhooksService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/WebhooksService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,iDAQ4B;AAC5B,wEAAqE;AACrE;;;;;;;GAOG;AACH,MAAa,eAAgB,SAAQ,qCAAiB;IAAtD;;QACE;;;;;;;;;;;;;;WAcG;QACH,sBAAiB,GAAG,CAAC,EACnB,sBAAsB,GAYvB,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,qBAAqB;gBAC3B,MAAM,EAAE,QAAQ;gBAChB,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,sBAAsB;aAC7B,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAwDG;QACH,6BAAwB,GAAG,CAAC,EAC1B,OAAO,EACP,UAAU,MAMR,EAAE,EAA4B,EAAE;YAClC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,qBAAqB;gBAC3B,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,OAAO;oBACP,UAAU;iBACX;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,mDAAmD,CACpD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA0CG;QACH,sBAAiB,GAAG,CAAC,EACnB,UAAU,EACV,KAAK,MAcH,EAAE,EAA2B,EAAE;YACjC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,4BAA4B;gBAClC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,UAAU;oBACV,KAAK;iBACN;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,4CAA4C,CAC7C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;WAsBG;QACH,oBAAe,GAAG,CAAC,EACjB,sBAAsB,GAYvB,EAAmC,EAAE;YACpC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6BAA6B;gBACnC,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,sBAAsB;aAC7B,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,0CAA0C,CAC3C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAiCG;QACH,4BAAuB,GAAG,CAAC,EACzB,0BAA0B,GAoC3B,EAA2C,EAAE;YAC5C,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,qBAAqB;gBAC3B,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,0BAA0B;aACjC,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,kDAAkD,CACnD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IA4CJ,CAAC;IA3CW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,mDAAmD,EACnD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,mDAAmD,CAAC,CACjE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,kDAAkD,EAClD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,gCAAgC,CAAC;SACrE,CAAC;aACD,QAAQ,CAAC,kDAAkD,CAAC,CAChE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,4CAA4C,EAC5C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC;SACrD,CAAC;aACD,QAAQ,CAAC,4CAA4C,CAAC,CAC1D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,wBAAwB,CAAC;SAC7D,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,4CAAiC,CAAC,CAAC,CAAC;IAC5E,CAAC;CACF;AAvbD,0CAubC"}
+{"version":3,"file":"WebhooksService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/WebhooksService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,iDAQ4B;AAC5B,wEAAqE;AACrE;;;;;;;GAOG;AACH,MAAa,eAAgB,SAAQ,qCAAiB;IAAtD;;QACE;;;;;;;;;;;;;;;WAeG;QACH,sBAAiB,GAAG,CAAC,EACnB,sBAAsB,GAavB,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,qBAAqB;gBAC3B,MAAM,EAAE,QAAQ;gBAChB,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,sBAAsB;aAC7B,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA4DG;QACH,6BAAwB,GAAG,CAAC,EAC1B,OAAO,EACP,UAAU,MAMR,EAAE,EAA4B,EAAE;YAClC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,qBAAqB;gBAC3B,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,OAAO;oBACP,UAAU;iBACX;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,mDAAmD,CACpD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2CG;QACH,sBAAiB,GAAG,CAAC,EACnB,UAAU,EACV,KAAK,MAcH,EAAE,EAA2B,EAAE;YACjC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,4BAA4B;gBAClC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,UAAU;oBACV,KAAK;iBACN;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,4CAA4C,CAC7C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;QACH,oBAAe,GAAG,CAAC,EACjB,sBAAsB,GAavB,EAAmC,EAAE;YACpC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6BAA6B;gBACnC,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,sBAAsB;aAC7B,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,0CAA0C,CAC3C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAqCG;QACH,4BAAuB,GAAG,CAAC,EACzB,0BAA0B,GAqC3B,EAA2C,EAAE;YAC5C,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,qBAAqB;gBAC3B,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,0BAA0B;aACjC,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,kDAAkD,CACnD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IA4CJ,CAAC;IA3CW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,mDAAmD,EACnD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,mDAAmD,CAAC,CACjE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,kDAAkD,EAClD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,gCAAgC,CAAC;SACrE,CAAC;aACD,QAAQ,CAAC,kDAAkD,CAAC,CAChE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,4CAA4C,EAC5C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC;SACrD,CAAC;aACD,QAAQ,CAAC,4CAA4C,CAAC,CAC1D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,wBAAwB,CAAC;SAC7D,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,4CAAiC,CAAC,CAAC,CAAC;IAC5E,CAAC;CACF;AAxcD,0CAwcC"}