@resolution/confluence-api-client 0.4.4 → 0.4.6

package/lib/openapi/v1/services/AnalyticsService.js

@@ -10,65 +10,68 @@ const CommonHttpService_1 = require("../core/CommonHttpService");
 const validationSchemaStorage_1 = require("../validationSchemaStorage");
 /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics */
 class AnalyticsService extends CommonHttpService_1.CommonHttpService {
-    /**
-     * Get the total number of distinct viewers a piece of content has.
-     *
-     * @returns Returns the total number of distinct viewers for the content.
-     * @path {GET} /wiki/rest/api/analytics/content/{contentId}/viewers
-     * @scopes-current read:confluence-content.summary
-     * @scopes-beta read:analytics.content:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics#api-wiki-rest-api-analytics-content-contentid-viewers-get
-     */
-    getViewers({ contentId, fromDate, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/analytics/content/{contentId}/viewers",
-            method: "GET",
-            pathParams: {
-                contentId,
-            },
-            query: {
-                fromDate,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AnalyticsService.getViewers.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Get the total number of views a piece of content has.
-     *
-     * @returns Returns the total number of views for the content.
-     * @path {GET} /wiki/rest/api/analytics/content/{contentId}/views
-     * @scopes-current read:confluence-content.summary
-     * @scopes-beta read:analytics.content:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics#api-wiki-rest-api-analytics-content-contentid-views-get
-     */
-    getViews({ contentId, fromDate, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/analytics/content/{contentId}/views",
-            method: "GET",
-            pathParams: {
-                contentId,
-            },
-            query: {
-                fromDate,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AnalyticsService.getViews.response"))
-            .then(commonHttpClient.getBody);
+    constructor() {
+        super(...arguments);
+        /**
+         * Get the total number of distinct viewers a piece of content has.
+         *
+         * @returns Returns the total number of distinct viewers for the content.
+         * @path {GET} /wiki/rest/api/analytics/content/{contentId}/viewers
+         * @scopes-current read:confluence-content.summary
+         * @scopes-beta read:analytics.content:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics#api-wiki-rest-api-analytics-content-contentid-viewers-get
+         */
+        this.getViewers = ({ contentId, fromDate, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/analytics/content/{contentId}/viewers",
+                method: "GET",
+                pathParams: {
+                    contentId,
+                },
+                query: {
+                    fromDate,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("AnalyticsService.getViewers.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Get the total number of views a piece of content has.
+         *
+         * @returns Returns the total number of views for the content.
+         * @path {GET} /wiki/rest/api/analytics/content/{contentId}/views
+         * @scopes-current read:confluence-content.summary
+         * @scopes-beta read:analytics.content:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics#api-wiki-rest-api-analytics-content-contentid-views-get
+         */
+        this.getViews = ({ contentId, fromDate, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/analytics/content/{contentId}/views",
+                method: "GET",
+                pathParams: {
+                    contentId,
+                },
+                query: {
+                    fromDate,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("AnalyticsService.getViews.response"))
+                .then(commonHttpClient.getBody);
+        };
     }
     static initialize() {
         validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AnalyticsService.getViewers.response", zod_1.z

package/lib/openapi/v1/services/AnalyticsService.js.map

@@ -1 +1 @@
-{"version":3,"file":"AnalyticsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/AnalyticsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,wEAAqE;AACrE,wFAAwF;AACxF,MAAa,gBAAiB,SAAQ,qCAAiB;IACrD;;;;;;;;OAQG;IACH,UAAU,CAAC,EACT,SAAS,EACT,QAAQ,GAUT;QAUC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sDAAsD;YAC5D,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,SAAS;aACV;YACD,KAAK,EAAE;gBACL,QAAQ;aACT;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,sCAAsC,CACvC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;OAQG;IACH,QAAQ,CAAC,EACP,SAAS,EACT,QAAQ,GAUT;QAUC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,oDAAoD;YAC1D,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,SAAS;aACV;YACD,KAAK,EAAE;gBACL,QAAQ;aACT;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAAC,oCAAoC,CAAC,CACxE;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,sCAAsC,EACtC,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,OAAC;iBACJ,MAAM,CAAC;gBACN,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;gBAC/B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;aACnC,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,sCAAsC,CAAC,CACpD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,oCAAoC,EACpC,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,OAAC;iBACJ,MAAM,CAAC;gBACN,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;gBAC/B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;aACnC,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,oCAAoC,CAAC,CAClD,CAAC;IACJ,CAAC;CACF;AAvKD,4CAuKC"}
+{"version":3,"file":"AnalyticsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/AnalyticsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,wEAAqE;AACrE,wFAAwF;AACxF,MAAa,gBAAiB,SAAQ,qCAAiB;IAAvD;;QACE;;;;;;;;WAQG;QACH,eAAU,GAAG,CAAC,EACZ,SAAS,EACT,QAAQ,GAUT,EASC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,sDAAsD;gBAC5D,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,SAAS;iBACV;gBACD,KAAK,EAAE;oBACL,QAAQ;iBACT;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,EASzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,sCAAsC,CACvC,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;WAQG;QACH,aAAQ,GAAG,CAAC,EACV,SAAS,EACT,QAAQ,GAUT,EASC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,oDAAoD;gBAC1D,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,SAAS;iBACV;gBACD,KAAK,EAAE;oBACL,QAAQ;iBACT;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,EASzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAAC,oCAAoC,CAAC,CACxE;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAiCJ,CAAC;IAhCC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,sCAAsC,EACtC,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,OAAC;iBACJ,MAAM,CAAC;gBACN,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;gBAC/B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;aACnC,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,sCAAsC,CAAC,CACpD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,oCAAoC,EACpC,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,OAAC;iBACJ,MAAM,CAAC;gBACN,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;gBAC/B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;aACnC,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,oCAAoC,CAAC,CAClD,CAAC;IACJ,CAAC;CACF;AAvKD,4CAuKC"}

package/lib/openapi/v1/services/AuditService.d.ts

@@ -14,10 +14,10 @@ export declare class AuditService extends CommonHttpService {
      * @scopes-current read:audit-log:confluence, write:audit-log:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-post
      */
-    createAuditRecord({ auditRecordCreate, }: {
+    createAuditRecord: ({ auditRecordCreate, }: {
         /** The record to be created in the audit log. */
         auditRecordCreate: AuditRecordCreate;
-    }): Promise<AuditRecord>;
+    }) => Promise<AuditRecord>;
     /**
      * Exports audit records as a CSV file or ZIP file.
      *
@@ -35,27 +35,27 @@ export declare class AuditService extends CommonHttpService {
      * @scopes-current read:audit-log:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-export-get
      */
-    exportAuditRecords({ startDate, endDate, searchString, format, }?: {
+    exportAuditRecords: ({ startDate, endDate, searchString, format, }?: {
         /**
          * Filters the exported results to the records on or after the `startDate`.
          * The `startDate` must be specified as [epoch
          * time](https://www.epochconverter.com/) in milliseconds.
          */
-        startDate?: string;
+        startDate?: string | undefined;
         /**
          * Filters the exported results to the records on or before the `endDate`.
          * The `endDate` must be specified as [epoch
          * time](https://www.epochconverter.com/) in milliseconds.
          */
-        endDate?: string;
+        endDate?: string | undefined;
         /**
          * Filters the exported results to records that have string property values
          * matching the `searchString`.
          */
-        searchString?: string;
+        searchString?: string | undefined;
         /** The format of the export file for the audit records. */
-        format?: "csv" | "zip";
-    }): Promise<commonHttpClient.WithResponse<{
+        format?: "csv" | "zip" | undefined;
+    }) => Promise<commonHttpClient.WithResponse<{
         status: 200;
         mediaType: "application/zip" | "text/csv";
         body: Blob;
@@ -75,32 +75,32 @@ export declare class AuditService extends CommonHttpService {
      * @scopes-current read:audit-log:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-get
      */
-    getAuditRecords({ startDate, endDate, searchString, start, limit, }?: {
+    getAuditRecords: ({ startDate, endDate, searchString, start, limit, }?: {
         /**
          * Filters the results to the records on or after the `startDate`.
          * The `startDate` must be specified as [epoch
          * time](https://www.epochconverter.com/) in milliseconds.
          */
-        startDate?: string;
+        startDate?: string | undefined;
         /**
          * Filters the results to the records on or before the `endDate`.
          * The `endDate` must be specified as [epoch
          * time](https://www.epochconverter.com/) in milliseconds.
          */
-        endDate?: string;
+        endDate?: string | undefined;
         /**
          * Filters the results to records that have string property values
          * matching the `searchString`.
          */
-        searchString?: string;
+        searchString?: string | undefined;
         /** The starting index of the returned records. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of records to return per page.
          * Note, this may be restricted by fixed system limits.
          */
-        limit?: number;
-    }): Promise<AuditRecordArray>;
+        limit?: number | undefined;
+    }) => Promise<AuditRecordArray>;
     /**
      * Returns records from the audit log, for a time period back from the current
      * date. For example, you can use this method to get the last 3 months of records.
@@ -118,24 +118,24 @@ export declare class AuditService extends CommonHttpService {
      * @scopes-current read:audit-log:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-since-get
      */
-    getAuditRecordsForTimePeriod({ number, units, searchString, start, limit, }?: {
+    getAuditRecordsForTimePeriod: ({ number, units, searchString, start, limit, }?: {
         /** The number of units for the time period. */
-        number?: number;
+        number?: number | undefined;
         /** The unit of time that the time period is measured in. */
-        units?: "NANOS" | "MICROS" | "MILLIS" | "SECONDS" | "MINUTES" | "HOURS" | "HALF_DAYS" | "DAYS" | "WEEKS" | "MONTHS" | "YEARS" | "DECADES" | "CENTURIES";
+        units?: "NANOS" | "MICROS" | "MILLIS" | "SECONDS" | "MINUTES" | "HOURS" | "HALF_DAYS" | "DAYS" | "WEEKS" | "MONTHS" | "YEARS" | "DECADES" | "CENTURIES" | undefined;
         /**
          * Filters the results to records that have string property values
          * matching the `searchString`.
          */
-        searchString?: string;
+        searchString?: string | undefined;
         /** The starting index of the returned records. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of records to return per page.
          * Note, this may be restricted by fixed system limits.
          */
-        limit?: number;
-    }): Promise<AuditRecordArray>;
+        limit?: number | undefined;
+    }) => Promise<AuditRecordArray>;
     /**
      * Returns the retention period for records in the audit log. The retention
      * period is how long an audit record is kept for, from creation date until
@@ -149,7 +149,7 @@ export declare class AuditService extends CommonHttpService {
      * @scopes-current read:audit-log:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-retention-get
      */
-    getRetentionPeriod(): Promise<RetentionPeriod>;
+    getRetentionPeriod: () => Promise<RetentionPeriod>;
     /**
      * Sets the retention period for records in the audit log. The retention period
      * can be set to a maximum of 1 year.
@@ -162,9 +162,9 @@ export declare class AuditService extends CommonHttpService {
      * @scopes-current write:audit-log:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-retention-put
      */
-    setRetentionPeriod({ retentionPeriod, }: {
+    setRetentionPeriod: ({ retentionPeriod, }: {
         /** The updated retention period. */
         retentionPeriod: RetentionPeriod;
-    }): Promise<RetentionPeriod>;
+    }) => Promise<RetentionPeriod>;
     static initialize(): void;
 }