@fenixalliance/abs-api-client 1.0.9 → 1.0.11

package/clients/contentService/services/PortalsService.js

@@ -5,11 +5,12 @@ const OpenAPI_1 = require("../core/OpenAPI");
 const request_1 = require("../core/request");
 class PortalsService {
     /**
+     * Get the root portal
      * @param xApiVersion
      * @returns WebPortalDtoEnvelope OK
      * @throws ApiError
      */
-    static getApiV2ContentServicePortalsRoot(xApiVersion) {
+    static getRootPortal(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/ContentService/Portals/Root',
@@ -23,11 +24,12 @@ class PortalsService {
         });
     }
     /**
+     * Get the current portal
      * @param xApiVersion
      * @returns WebPortalDtoEnvelope OK
      * @throws ApiError
      */
-    static getApiV2ContentServicePortalsCurrent(xApiVersion) {
+    static getCurrentWebPortal(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/ContentService/Portals/Current',
@@ -41,11 +43,12 @@ class PortalsService {
         });
     }
     /**
+     * Initialize the current portal
      * @param xApiVersion
      * @returns WebPortalDtoEnvelope OK
      * @throws ApiError
      */
-    static getApiV2ContentServicePortalsInitialize(xApiVersion) {
+    static initializeCurrentWebPortal(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/ContentService/Portals/Initialize',
@@ -59,11 +62,12 @@ class PortalsService {
         });
     }
     /**
+     * Get the current portal settings
      * @param xApiVersion
      * @returns PortalOptionsEnvelope OK
      * @throws ApiError
      */
-    static getApiV2ContentServicePortalsCurrentOptions(xApiVersion) {
+    static getCurrentWebPortalOptions(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/ContentService/Portals/Current/Options',
@@ -77,12 +81,13 @@ class PortalsService {
         });
     }
     /**
+     * Search for a portal by its domain
      * @param domain
      * @param xApiVersion
      * @returns WebPortalDtoEnvelope OK
      * @throws ApiError
      */
-    static getApiV2ContentServicePortalsSearch(domain, xApiVersion) {
+    static searchWebPortal(domain, xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/ContentService/Portals/Search',
@@ -99,12 +104,13 @@ class PortalsService {
         });
     }
     /**
+     * Get a web portal by its ID
      * @param portalId
      * @param xApiVersion
      * @returns WebPortalDtoEnvelope OK
      * @throws ApiError
      */
-    static getApiV2ContentServicePortals(portalId, xApiVersion) {
+    static getWebPortalById(portalId, xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/ContentService/Portals/{portalId}',
@@ -121,6 +127,7 @@ class PortalsService {
         });
     }
     /**
+     * Update an existing web portal
      * @param tenantId
      * @param portalId
      * @param xApiVersion
@@ -128,7 +135,7 @@ class PortalsService {
      * @returns EmptyEnvelope OK
      * @throws ApiError
      */
-    static putApiV2ContentServicePortals(tenantId, portalId, xApiVersion, requestBody) {
+    static updateWebPortal(tenantId, portalId, xApiVersion, requestBody) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'PUT',
             url: '/api/v2/ContentService/Portals/{portalId}',
@@ -150,6 +157,7 @@ class PortalsService {
         });
     }
     /**
+     * Delete a web portal by its ID
      * @param tenantId
      * @param portalId
      * @param requestBody
@@ -157,7 +165,7 @@ class PortalsService {
      * @returns EmptyEnvelope OK
      * @throws ApiError
      */
-    static deleteApiV2ContentServicePortals(tenantId, portalId, requestBody, xApiVersion) {
+    static deleteWebPortal(tenantId, portalId, requestBody, xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'DELETE',
             url: '/api/v2/ContentService/Portals/{portalId}',
@@ -179,6 +187,7 @@ class PortalsService {
         });
     }
     /**
+     * Partially update a web portal
      * @param tenantId
      * @param portalId
      * @param xApiVersion
@@ -186,7 +195,7 @@ class PortalsService {
      * @returns EmptyEnvelope OK
      * @throws ApiError
      */
-    static patchApiV2ContentServicePortals(tenantId, portalId, xApiVersion, requestBody) {
+    static patchWebPortal(tenantId, portalId, xApiVersion, requestBody) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'PATCH',
             url: '/api/v2/ContentService/Portals/{portalId}',
@@ -208,12 +217,13 @@ class PortalsService {
         });
     }
     /**
+     * Get a web portal's settings by its ID
      * @param portalId
      * @param xApiVersion
      * @returns PortalSettingsEnvelope OK
      * @throws ApiError
      */
-    static getApiV2ContentServicePortalsSettings(portalId, xApiVersion) {
+    static getWebPortalSettingsById(portalId, xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/ContentService/Portals/{portalId}/Settings',
@@ -230,12 +240,13 @@ class PortalsService {
         });
     }
     /**
+     * Get a web portal's options by its ID
      * @param portalId
      * @param xApiVersion
      * @returns PortalOptionsEnvelope OK
      * @throws ApiError
      */
-    static getApiV2ContentServicePortalsOptions(portalId, xApiVersion) {
+    static getWebPortalOptionsById(portalId, xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/ContentService/Portals/{portalId}/Options',

package/clients/contentService/services/PortalsService.ts

@@ -15,11 +15,12 @@ import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
 export class PortalsService {
     /**
+     * Get the root portal
      * @param xApiVersion
      * @returns WebPortalDtoEnvelope OK
      * @throws ApiError
      */
-    public static getApiV2ContentServicePortalsRoot(
+    public static getRootPortal(
         xApiVersion?: string,
     ): CancelablePromise<WebPortalDtoEnvelope> {
         return __request(OpenAPI, {
@@ -35,11 +36,12 @@ export class PortalsService {
         });
     }
     /**
+     * Get the current portal
      * @param xApiVersion
      * @returns WebPortalDtoEnvelope OK
      * @throws ApiError
      */
-    public static getApiV2ContentServicePortalsCurrent(
+    public static getCurrentWebPortal(
         xApiVersion?: string,
     ): CancelablePromise<WebPortalDtoEnvelope> {
         return __request(OpenAPI, {
@@ -55,11 +57,12 @@ export class PortalsService {
         });
     }
     /**
+     * Initialize the current portal
      * @param xApiVersion
      * @returns WebPortalDtoEnvelope OK
      * @throws ApiError
      */
-    public static getApiV2ContentServicePortalsInitialize(
+    public static initializeCurrentWebPortal(
         xApiVersion?: string,
     ): CancelablePromise<WebPortalDtoEnvelope> {
         return __request(OpenAPI, {
@@ -75,11 +78,12 @@ export class PortalsService {
         });
     }
     /**
+     * Get the current portal settings
      * @param xApiVersion
      * @returns PortalOptionsEnvelope OK
      * @throws ApiError
      */
-    public static getApiV2ContentServicePortalsCurrentOptions(
+    public static getCurrentWebPortalOptions(
         xApiVersion?: string,
     ): CancelablePromise<PortalOptionsEnvelope> {
         return __request(OpenAPI, {
@@ -95,12 +99,13 @@ export class PortalsService {
         });
     }
     /**
+     * Search for a portal by its domain
      * @param domain
      * @param xApiVersion
      * @returns WebPortalDtoEnvelope OK
      * @throws ApiError
      */
-    public static getApiV2ContentServicePortalsSearch(
+    public static searchWebPortal(
         domain: string,
         xApiVersion?: string,
     ): CancelablePromise<WebPortalDtoEnvelope> {
@@ -120,12 +125,13 @@ export class PortalsService {
         });
     }
     /**
+     * Get a web portal by its ID
      * @param portalId
      * @param xApiVersion
      * @returns WebPortalDtoEnvelope OK
      * @throws ApiError
      */
-    public static getApiV2ContentServicePortals(
+    public static getWebPortalById(
         portalId: string,
         xApiVersion?: string,
     ): CancelablePromise<WebPortalDtoEnvelope> {
@@ -145,6 +151,7 @@ export class PortalsService {
         });
     }
     /**
+     * Update an existing web portal
      * @param tenantId
      * @param portalId
      * @param xApiVersion
@@ -152,7 +159,7 @@ export class PortalsService {
      * @returns EmptyEnvelope OK
      * @throws ApiError
      */
-    public static putApiV2ContentServicePortals(
+    public static updateWebPortal(
         tenantId: string,
         portalId: string,
         xApiVersion?: string,
@@ -179,6 +186,7 @@ export class PortalsService {
         });
     }
     /**
+     * Delete a web portal by its ID
      * @param tenantId
      * @param portalId
      * @param requestBody
@@ -186,7 +194,7 @@ export class PortalsService {
      * @returns EmptyEnvelope OK
      * @throws ApiError
      */
-    public static deleteApiV2ContentServicePortals(
+    public static deleteWebPortal(
         tenantId: string,
         portalId: string,
         requestBody: PortalId,
@@ -213,6 +221,7 @@ export class PortalsService {
         });
     }
     /**
+     * Partially update a web portal
      * @param tenantId
      * @param portalId
      * @param xApiVersion
@@ -220,7 +229,7 @@ export class PortalsService {
      * @returns EmptyEnvelope OK
      * @throws ApiError
      */
-    public static patchApiV2ContentServicePortals(
+    public static patchWebPortal(
         tenantId: string,
         portalId: PortalId,
         xApiVersion?: string,
@@ -247,12 +256,13 @@ export class PortalsService {
         });
     }
     /**
+     * Get a web portal's settings by its ID
      * @param portalId
      * @param xApiVersion
      * @returns PortalSettingsEnvelope OK
      * @throws ApiError
      */
-    public static getApiV2ContentServicePortalsSettings(
+    public static getWebPortalSettingsById(
         portalId: string,
         xApiVersion?: string,
     ): CancelablePromise<PortalSettingsEnvelope> {
@@ -272,12 +282,13 @@ export class PortalsService {
         });
     }
     /**
+     * Get a web portal's options by its ID
      * @param portalId
      * @param xApiVersion
      * @returns PortalOptionsEnvelope OK
      * @throws ApiError
      */
-    public static getApiV2ContentServicePortalsOptions(
+    public static getWebPortalOptionsById(
         portalId: string,
         xApiVersion?: string,
     ): CancelablePromise<PortalOptionsEnvelope> {