@fenixalliance/abs-api-client 1.0.8 → 1.0.9

package/clients/contentService/index.ts

@@ -93,11 +93,11 @@ export type { PaginationOptions } from './models/PaginationOptions';
 export type { PaymentMethod } from './models/PaymentMethod';
 export type { PaymentOptions } from './models/PaymentOptions';
 export type { PerformanceOptions } from './models/PerformanceOptions';
-export type { Portal } from './models/Portal';
-export type { PortalEnvelope } from './models/PortalEnvelope';
 export type { PortalId } from './models/PortalId';
 export { PortalOptions } from './models/PortalOptions';
 export type { PortalOptionsEnvelope } from './models/PortalOptionsEnvelope';
+export type { PortalSettings } from './models/PortalSettings';
+export type { PortalSettingsEnvelope } from './models/PortalSettingsEnvelope';
 export type { PortfolioOptions } from './models/PortfolioOptions';
 export type { PriceCalculationOptions } from './models/PriceCalculationOptions';
 export type { PrivacyOptions } from './models/PrivacyOptions';

package/clients/contentService/models/{Portal.ts → PortalSettings.ts}

@@ -3,7 +3,7 @@
 /* tslint:disable */
 /* eslint-disable */
 import type { PortalOptions } from './PortalOptions';
-export type Portal = {
+export type PortalSettings = {
     enable?: boolean;
     portalID?: string | null;
     scopes?: string | null;

package/clients/contentService/models/PortalSettingsEnvelope.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { PortalSettings } from './PortalSettings';
+export type PortalSettingsEnvelope = {
+    readonly isSuccess?: boolean;
+    errorMessage?: string | null;
+    correlationId?: string | null;
+    readonly timestamp?: string;
+    readonly activityId?: string | null;
+    result?: PortalSettings;
+};
+

package/clients/contentService/services/PortalsService.js

@@ -210,7 +210,7 @@ class PortalsService {
     /**
      * @param portalId
      * @param xApiVersion
-     * @returns PortalEnvelope OK
+     * @returns PortalSettingsEnvelope OK
      * @throws ApiError
      */
     static getApiV2ContentServicePortalsSettings(portalId, xApiVersion) {

package/clients/contentService/services/PortalsService.ts

@@ -4,9 +4,9 @@
 /* eslint-disable */
 import type { EmptyEnvelope } from '../models/EmptyEnvelope';
 import type { Operation } from '../models/Operation';
-import type { PortalEnvelope } from '../models/PortalEnvelope';
 import type { PortalId } from '../models/PortalId';
 import type { PortalOptionsEnvelope } from '../models/PortalOptionsEnvelope';
+import type { PortalSettingsEnvelope } from '../models/PortalSettingsEnvelope';
 import type { WebPortalCreateDto } from '../models/WebPortalCreateDto';
 import type { WebPortalDtoEnvelope } from '../models/WebPortalDtoEnvelope';
 import type { WebPortalUpdateDto } from '../models/WebPortalUpdateDto';
@@ -249,13 +249,13 @@ export class PortalsService {
     /**
      * @param portalId
      * @param xApiVersion
-     * @returns PortalEnvelope OK
+     * @returns PortalSettingsEnvelope OK
      * @throws ApiError
      */
     public static getApiV2ContentServicePortalsSettings(
         portalId: string,
         xApiVersion?: string,
-    ): CancelablePromise<PortalEnvelope> {
+    ): CancelablePromise<PortalSettingsEnvelope> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/v2/ContentService/Portals/{portalId}/Settings',

package/clients/holderService/index.ts

@@ -22,6 +22,7 @@ export type { ExtendedTenantEnrolmentDtoListEnvelope } from './models/ExtendedTe
 export { ExtendedUserDto } from './models/ExtendedUserDto';
 export type { ExtendedUserDtoEnvelope } from './models/ExtendedUserDtoEnvelope';
 export type { FollowRecordDto } from './models/FollowRecordDto';
+export type { FollowRecordDtoListEnvelope } from './models/FollowRecordDtoListEnvelope';
 export type { Int32Envelope } from './models/Int32Envelope';
 export type { NotificationDto } from './models/NotificationDto';
 export type { NotificationDtoListEnvelope } from './models/NotificationDtoListEnvelope';

package/clients/holderService/models/FollowRecordDtoListEnvelope.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/clients/holderService/models/FollowRecordDtoListEnvelope.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { FollowRecordDto } from './FollowRecordDto';
+export type FollowRecordDtoListEnvelope = {
+    readonly isSuccess?: boolean;
+    errorMessage?: string | null;
+    correlationId?: string | null;
+    readonly timestamp?: string;
+    readonly activityId?: string | null;
+    result?: Array<FollowRecordDto> | null;
+};
+

package/clients/holderService/services/HolderService.js

@@ -5,11 +5,12 @@ const OpenAPI_1 = require("../core/OpenAPI");
 const request_1 = require("../core/request");
 class HolderService {
     /**
+     * Gets the current user
      * @param xApiVersion
      * @returns UserDtoEnvelope OK
      * @throws ApiError
      */
-    static getApiV2Me(xApiVersion) {
+    static getCurrentUser(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me',
@@ -22,12 +23,13 @@ class HolderService {
         });
     }
     /**
+     * Updates the current user
      * @param xApiVersion
      * @param requestBody
      * @returns EmptyEnvelopeEnvelope OK
      * @throws ApiError
      */
-    static putApiV2Me(xApiVersion, requestBody) {
+    static updateCurrentUser(xApiVersion, requestBody) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'PUT',
             url: '/api/v2/Me',
@@ -42,12 +44,13 @@ class HolderService {
         });
     }
     /**
+     * Patches the current user
      * @param xApiVersion
      * @param requestBody
      * @returns EmptyEnvelopeEnvelope OK
      * @throws ApiError
      */
-    static patchApiV2Me(xApiVersion, requestBody) {
+    static patchCurrentUser(xApiVersion, requestBody) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'PATCH',
             url: '/api/v2/Me',
@@ -62,11 +65,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the current user with extended information
      * @param xApiVersion
      * @returns ExtendedUserDtoEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeExtended(xApiVersion) {
+    static getExtendedCurrentUser(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Extended',
@@ -79,11 +83,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the current user's avatar
      * @param xApiVersion
-     * @returns FollowRecordDto OK
+     * @returns binary OK
      * @throws ApiError
      */
-    static getApiV2MeAvatar(xApiVersion) {
+    static getMyAvatar(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Avatar',
@@ -92,16 +97,18 @@ class HolderService {
             },
             errors: {
                 401: `Unauthorized`,
+                403: `Forbidden`,
             },
         });
     }
     /**
+     * Updates the current user's avatar
      * @param xApiVersion
      * @param formData
      * @returns EmptyEnvelope OK
      * @throws ApiError
      */
-    static postApiV2MeAvatar(xApiVersion, formData) {
+    static updateMyAvatar(xApiVersion, formData) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'POST',
             url: '/api/v2/Me/Avatar',
@@ -117,11 +124,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the social profiles that the current user follows
      * @param xApiVersion
-     * @returns FollowRecordDto OK
+     * @returns FollowRecordDtoListEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeFollows(xApiVersion) {
+    static getMyFollows(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Follows',
@@ -134,11 +142,12 @@ class HolderService {
         });
     }
     /**
+     * Counts the social profiles that the current user follows
      * @param xApiVersion
-     * @returns FollowRecordDto OK
+     * @returns Int32Envelope OK
      * @throws ApiError
      */
-    static getApiV2MeFollowsCount(xApiVersion) {
+    static countMyFollows(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Follows/Count',
@@ -151,11 +160,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the social profiles that follow the current user
      * @param xApiVersion
-     * @returns FollowRecordDto OK
+     * @returns FollowRecordDtoListEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeFollowers(xApiVersion) {
+    static getMyFollowers(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Followers',
@@ -168,11 +178,12 @@ class HolderService {
         });
     }
     /**
+     * Counts the social profiles that follow the current user
      * @param xApiVersion
-     * @returns FollowRecordDto OK
+     * @returns Int32Envelope OK
      * @throws ApiError
      */
-    static getApiV2MeFollowersCount(xApiVersion) {
+    static countMyFollowers(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Followers/Count',
@@ -185,11 +196,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the tenants that the current user is enrolled in
      * @param xApiVersion
      * @returns TenantDtoListEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeBusinesses(xApiVersion) {
+    static getMyTenants(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Businesses',
@@ -203,11 +215,12 @@ class HolderService {
         });
     }
     /**
+     * Counts the tenants that the current user is enrolled in
      * @param xApiVersion
      * @returns Int32Envelope OK
      * @throws ApiError
      */
-    static getApiV2MeBusinessesCount(xApiVersion) {
+    static countMyTenants(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Businesses/Count',
@@ -221,11 +234,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the tenants that the current user is enrolled in with extended information
      * @param xApiVersion
      * @returns ExtendedTenantDtoListEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeBusinessesExtended(xApiVersion) {
+    static getMyTenantsExtended(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Businesses/Extended',
@@ -239,11 +253,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the list of enrollments for the current user
      * @param xApiVersion
      * @returns TenantEnrolmentDtoListEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeEnrollments(xApiVersion) {
+    static getMyEnrollments(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Enrollments',
@@ -256,11 +271,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the list of enrollments for the current user with extended information
      * @param xApiVersion
      * @returns ExtendedTenantEnrolmentDtoListEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeEnrollmentsExtended(xApiVersion) {
+    static getMyEnrollmentsExtended(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Enrollments/Extended',
@@ -273,13 +289,14 @@ class HolderService {
         });
     }
     /**
+     * Gets a single TenantEnrollment by its ID
      * @param enrollmentId
      * @param xApiVersion
      * @param requestBody
      * @returns TenantEnrolmentDtoEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeEnrollments1(enrollmentId, xApiVersion, requestBody) {
+    static getMyEnrollment(enrollmentId, xApiVersion, requestBody) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Enrollments/{enrollmentId}',
@@ -297,11 +314,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the current user's social profile
      * @param xApiVersion
      * @returns SocialProfileDtoEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeSocialProfile(xApiVersion) {
+    static getMySocialProfile(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/SocialProfile',
@@ -314,11 +332,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the current user's cart
      * @param xApiVersion
      * @returns CartDtoEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeCart(xApiVersion) {
+    static getMyCart(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Cart',
@@ -331,11 +350,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the current user's billing profile
      * @param xApiVersion
      * @returns WalletDtoEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeWallet(xApiVersion) {
+    static getMyWallet(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Wallet',
@@ -348,11 +368,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the list of notifications for the current user
      * @param xApiVersion
      * @returns NotificationDtoListEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeNotifications(xApiVersion) {
+    static getMyNotifications(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Notifications',
@@ -365,11 +386,12 @@ class HolderService {
         });
     }
     /**
+     * Counts the list of notifications for the current user
      * @param xApiVersion
      * @returns Int32Envelope OK
      * @throws ApiError
      */
-    static getApiV2MeNotificationsCount(xApiVersion) {
+    static countMyNotifications(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Notifications/Count',
@@ -382,11 +404,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the settings for the current user
      * @param xApiVersion
      * @returns UserSettingsDtoEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeSettings(xApiVersion) {
+    static getMySettings(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Settings',
@@ -399,12 +422,13 @@ class HolderService {
         });
     }
     /**
+     * Updates the settings for the current user
      * @param xApiVersion
      * @param requestBody
      * @returns UserSettingsDtoEnvelope OK
      * @throws ApiError
      */
-    static putApiV2MeSettings(xApiVersion, requestBody) {
+    static updateMySettings(xApiVersion, requestBody) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'PUT',
             url: '/api/v2/Me/Settings',
@@ -419,11 +443,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the list of addresses for the current user
      * @param xApiVersion
      * @returns AddressDtoListEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeAddresses(xApiVersion) {
+    static getMyAddresses(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Addresses',
@@ -436,11 +461,12 @@ class HolderService {
         });
     }
     /**
+     * Gets the list of tenant enrollment invitations for the current user
      * @param xApiVersion
      * @returns TenantInvitationDtoListEnvelope OK
      * @throws ApiError
      */
-    static getApiV2MeInvitations(xApiVersion) {
+    static getMyInvitations(xApiVersion) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/api/v2/Me/Invitations',