@fenixalliance/abs-api-client 1.0.9 → 1.0.11

package/schemas/holderService/schema.s.ts

@@ -6,96 +6,171 @@
 
 export interface paths {
   "/api/v2/Me": {
-    /** Gets the current user */
-    get: operations["GetCurrentUser"];
-    /** Updates the current user */
-    put: operations["UpdateCurrentUser"];
-    /** Patches the current user */
-    patch: operations["PatchCurrentUser"];
+    /**
+     * Gets the current user
+     * @description Get the currently acting user.
+     */
+    get: operations["GetCurrentUserAsync"];
+    /**
+     * Update the current user's profile
+     * @description Update the current user's profile
+     */
+    put: operations["UpdateCurrentUserAsync"];
+    /**
+     * Partially update the current user's profile
+     * @description Partially update the current user's profile
+     */
+    patch: operations["PatchCurrentUserAsync"];
   };
   "/api/v2/Me/Extended": {
-    /** Gets the current user with extended information */
-    get: operations["GetExtendedCurrentUser"];
+    /**
+     * Get the current user's extended profile
+     * @description Get the current user's extended profile
+     */
+    get: operations["GetExtendedCurrentUserAsync"];
   };
   "/api/v2/Me/Avatar": {
-    /** Gets the current user's avatar */
-    get: operations["GetMyAvatar"];
-    /** Updates the current user's avatar */
-    post: operations["UpdateMyAvatar"];
+    /**
+     * Get the current user's avatar
+     * @description Get the current user's avatar
+     */
+    get: operations["GetCurrentUserAvatarAsync"];
+    /**
+     * Update the current user's avatar
+     * @description Update the current user's avatar
+     */
+    post: operations["UpdateAvatarAsync"];
   };
   "/api/v2/Me/Follows": {
-    /** Gets the social profiles that the current user follows */
-    get: operations["GetMyFollows"];
+    /**
+     * Get the social profiles that the current user follows
+     * @description Get the social profiles that the current user follows
+     */
+    get: operations["GetCurrentUserFollowsAsync"];
   };
   "/api/v2/Me/Follows/Count": {
-    /** Counts the social profiles that the current user follows */
-    get: operations["CountMyFollows"];
+    /**
+     * Count the social profiles that the current user follows
+     * @description Count the social profiles that the current user follows
+     */
+    get: operations["CountCurrentUserFollowsAsync"];
   };
   "/api/v2/Me/Followers": {
-    /** Gets the social profiles that follow the current user */
-    get: operations["GetMyFollowers"];
+    /**
+     * Get the social profiles that follow the current user
+     * @description Get the social profiles that follow the current user
+     */
+    get: operations["GetCurrentUserFollowersAsync"];
   };
   "/api/v2/Me/Followers/Count": {
-    /** Counts the social profiles that follow the current user */
-    get: operations["CountMyFollowers"];
+    /**
+     * Count the social profiles that follow the current user
+     * @description Count the social profiles that follow the current user
+     */
+    get: operations["CountCurrentUserFollowersAsync"];
   };
   "/api/v2/Me/Businesses": {
-    /** Gets the tenants that the current user is enrolled in */
-    get: operations["GetMyTenants"];
+    /**
+     * Get the tenants that the current user is enrolled in
+     * @description Get the tenants that the current user is enrolled in
+     */
+    get: operations["GetCurrentUserTenantsAsync"];
   };
   "/api/v2/Me/Businesses/Count": {
-    /** Counts the tenants that the current user is enrolled in */
-    get: operations["CountMyTenants"];
+    /**
+     * Count the tenants that the current user is enrolled in
+     * @description Count the tenants that the current user is enrolled in
+     */
+    get: operations["CountCurrentUserTenantsAsync"];
   };
   "/api/v2/Me/Businesses/Extended": {
-    /** Gets the tenants that the current user is enrolled in with extended information */
-    get: operations["GetMyTenantsExtended"];
+    /**
+     * Get the tenants that the current user is enrolled in
+     * @description Get the tenants that the current user is enrolled in
+     */
+    get: operations["GetCurrentUserTenantsExtendedAsync"];
   };
   "/api/v2/Me/Enrollments": {
-    /** Gets the list of enrollments for the current user */
-    get: operations["GetMyEnrollments"];
+    /**
+     * Get the list of enrollments for the current user
+     * @description Get the list of enrollments for the current user
+     */
+    get: operations["GetCurrentUserEnrollmentsAsync"];
   };
   "/api/v2/Me/Enrollments/Extended": {
-    /** Gets the list of enrollments for the current user with extended information */
-    get: operations["GetMyEnrollmentsExtended"];
+    /**
+     * Get the list of enrollments for the current user
+     * @description Get the list of enrollments for the current user
+     */
+    get: operations["GetCurrentUserEnrollmentsExtendedAsync"];
   };
   "/api/v2/Me/Enrollments/{enrollmentId}": {
-    /** Gets a single TenantEnrollment by its ID */
-    get: operations["GetMyEnrollment"];
+    /**
+     * Get a single TenantEnrollment by its ID
+     * @description Get a single TenantEnrollment by its ID
+     */
+    get: operations["GetTenantEnrollmentAsync"];
   };
   "/api/v2/Me/SocialProfile": {
-    /** Gets the current user's social profile */
-    get: operations["GetMySocialProfile"];
+    /**
+     * Get the current user's social profile
+     * @description Get the current user's social profile
+     */
+    get: operations["GetCurrentUserSocialProfileAsync"];
   };
   "/api/v2/Me/Cart": {
-    /** Gets the current user's cart */
-    get: operations["GetMyCart"];
+    /**
+     * Get the current user's cart
+     * @description Get the current user's cart
+     */
+    get: operations["GetCurrentUserCartAsync"];
   };
   "/api/v2/Me/Wallet": {
-    /** Gets the current user's billing profile */
-    get: operations["GetMyWallet"];
+    /**
+     * Get the current user's billing profile
+     * @description Get the current user's billing profile
+     */
+    get: operations["GetCurrentUserWalletAsync"];
   };
   "/api/v2/Me/Notifications": {
-    /** Gets the list of notifications for the current user */
-    get: operations["GetMyNotifications"];
+    /**
+     * Get the list of notifications for the current user
+     * @description Get the list of notifications for the current user
+     */
+    get: operations["GetCurrentUserNotificationsAsync"];
   };
   "/api/v2/Me/Notifications/Count": {
-    /** Counts the list of notifications for the current user */
-    get: operations["CountMyNotifications"];
+    /**
+     * Count the notifications for the current user
+     * @description Count the notifications for the current user
+     */
+    get: operations["CountCurrentUserNotificationsAsync"];
   };
   "/api/v2/Me/Settings": {
-    /** Gets the settings for the current user */
-    get: operations["GetMySettings"];
-    /** Updates the settings for the current user */
-    put: operations["UpdateMySettings"];
+    /**
+     * Get the settings for the current user
+     * @description Get the settings for the current user
+     */
+    get: operations["GetCurrentUserSettingsAsync"];
+    /**
+     * Update the settings for the current user
+     * @description Update the settings for the current user
+     */
+    put: operations["UpdateCurrentUserSettingsAsync"];
   };
   "/api/v2/Me/Addresses": {
-    /** Gets the list of addresses for the current user */
-    get: operations["GetMyAddresses"];
+    /**
+     * Get the list of addresses for the current user
+     * @description Get the list of addresses for the current user
+     */
+    get: operations["GetCurrentUserAddressesAsync"];
   };
   "/api/v2/Me/Invitations": {
-    /** Gets the list of tenant enrollment invitations for the current user */
-    get: operations["GetMyInvitations"];
+    /**
+     * Get the list of tenant enrollment invitations for the current user
+     * @description Get the list of tenant enrollment invitations for the current user
+     */
+    get: operations["GetCurrentUserInvitationAsync"];
   };
 }
 
@@ -177,15 +252,6 @@ export interface components {
       timestamp?: string;
       activityId?: string | null;
     };
-    EmptyEnvelopeEnvelope: {
-      isSuccess?: boolean;
-      errorMessage?: string | null;
-      correlationId?: string | null;
-      /** Format: date-time */
-      timestamp?: string;
-      activityId?: string | null;
-      result?: components["schemas"]["EmptyEnvelope"];
-    };
     EnrollmentId: Record<string, never>;
     ErrorEnvelope: {
       isSuccess?: boolean;
@@ -746,8 +812,11 @@ export type external = Record<string, never>;
 
 export interface operations {
 
-  /** Gets the current user */
-  GetCurrentUser: {
+  /**
+   * Gets the current user
+   * @description Get the currently acting user.
+   */
+  GetCurrentUserAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -775,8 +844,11 @@ export interface operations {
       };
     };
   };
-  /** Updates the current user */
-  UpdateCurrentUser: {
+  /**
+   * Update the current user's profile
+   * @description Update the current user's profile
+   */
+  UpdateCurrentUserAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -796,9 +868,9 @@ export interface operations {
       /** @description OK */
       200: {
         content: {
-          "application/json": components["schemas"]["EmptyEnvelopeEnvelope"];
-          "application/xml": components["schemas"]["EmptyEnvelopeEnvelope"];
-          "multipart/form-data": components["schemas"]["EmptyEnvelopeEnvelope"];
+          "application/json": components["schemas"]["EmptyEnvelope"];
+          "application/xml": components["schemas"]["EmptyEnvelope"];
+          "multipart/form-data": components["schemas"]["EmptyEnvelope"];
         };
       };
       /** @description Unauthorized */
@@ -811,8 +883,11 @@ export interface operations {
       };
     };
   };
-  /** Patches the current user */
-  PatchCurrentUser: {
+  /**
+   * Partially update the current user's profile
+   * @description Partially update the current user's profile
+   */
+  PatchCurrentUserAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -832,9 +907,9 @@ export interface operations {
       /** @description OK */
       200: {
         content: {
-          "application/json": components["schemas"]["EmptyEnvelopeEnvelope"];
-          "application/xml": components["schemas"]["EmptyEnvelopeEnvelope"];
-          "multipart/form-data": components["schemas"]["EmptyEnvelopeEnvelope"];
+          "application/json": components["schemas"]["EmptyEnvelope"];
+          "application/xml": components["schemas"]["EmptyEnvelope"];
+          "multipart/form-data": components["schemas"]["EmptyEnvelope"];
         };
       };
       /** @description Unauthorized */
@@ -847,8 +922,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the current user with extended information */
-  GetExtendedCurrentUser: {
+  /**
+   * Get the current user's extended profile
+   * @description Get the current user's extended profile
+   */
+  GetExtendedCurrentUserAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -876,8 +954,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the current user's avatar */
-  GetMyAvatar: {
+  /**
+   * Get the current user's avatar
+   * @description Get the current user's avatar
+   */
+  GetCurrentUserAvatarAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -913,8 +994,11 @@ export interface operations {
       };
     };
   };
-  /** Updates the current user's avatar */
-  UpdateMyAvatar: {
+  /**
+   * Update the current user's avatar
+   * @description Update the current user's avatar
+   */
+  UpdateAvatarAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -966,8 +1050,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the social profiles that the current user follows */
-  GetMyFollows: {
+  /**
+   * Get the social profiles that the current user follows
+   * @description Get the social profiles that the current user follows
+   */
+  GetCurrentUserFollowsAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -995,8 +1082,11 @@ export interface operations {
       };
     };
   };
-  /** Counts the social profiles that the current user follows */
-  CountMyFollows: {
+  /**
+   * Count the social profiles that the current user follows
+   * @description Count the social profiles that the current user follows
+   */
+  CountCurrentUserFollowsAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1024,8 +1114,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the social profiles that follow the current user */
-  GetMyFollowers: {
+  /**
+   * Get the social profiles that follow the current user
+   * @description Get the social profiles that follow the current user
+   */
+  GetCurrentUserFollowersAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1053,8 +1146,11 @@ export interface operations {
       };
     };
   };
-  /** Counts the social profiles that follow the current user */
-  CountMyFollowers: {
+  /**
+   * Count the social profiles that follow the current user
+   * @description Count the social profiles that follow the current user
+   */
+  CountCurrentUserFollowersAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1082,8 +1178,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the tenants that the current user is enrolled in */
-  GetMyTenants: {
+  /**
+   * Get the tenants that the current user is enrolled in
+   * @description Get the tenants that the current user is enrolled in
+   */
+  GetCurrentUserTenantsAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1119,8 +1218,11 @@ export interface operations {
       };
     };
   };
-  /** Counts the tenants that the current user is enrolled in */
-  CountMyTenants: {
+  /**
+   * Count the tenants that the current user is enrolled in
+   * @description Count the tenants that the current user is enrolled in
+   */
+  CountCurrentUserTenantsAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1156,8 +1258,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the tenants that the current user is enrolled in with extended information */
-  GetMyTenantsExtended: {
+  /**
+   * Get the tenants that the current user is enrolled in
+   * @description Get the tenants that the current user is enrolled in
+   */
+  GetCurrentUserTenantsExtendedAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1193,8 +1298,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the list of enrollments for the current user */
-  GetMyEnrollments: {
+  /**
+   * Get the list of enrollments for the current user
+   * @description Get the list of enrollments for the current user
+   */
+  GetCurrentUserEnrollmentsAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1222,8 +1330,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the list of enrollments for the current user with extended information */
-  GetMyEnrollmentsExtended: {
+  /**
+   * Get the list of enrollments for the current user
+   * @description Get the list of enrollments for the current user
+   */
+  GetCurrentUserEnrollmentsExtendedAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1251,8 +1362,11 @@ export interface operations {
       };
     };
   };
-  /** Gets a single TenantEnrollment by its ID */
-  GetMyEnrollment: {
+  /**
+   * Get a single TenantEnrollment by its ID
+   * @description Get a single TenantEnrollment by its ID
+   */
+  GetTenantEnrollmentAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1290,8 +1404,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the current user's social profile */
-  GetMySocialProfile: {
+  /**
+   * Get the current user's social profile
+   * @description Get the current user's social profile
+   */
+  GetCurrentUserSocialProfileAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1319,8 +1436,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the current user's cart */
-  GetMyCart: {
+  /**
+   * Get the current user's cart
+   * @description Get the current user's cart
+   */
+  GetCurrentUserCartAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1348,8 +1468,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the current user's billing profile */
-  GetMyWallet: {
+  /**
+   * Get the current user's billing profile
+   * @description Get the current user's billing profile
+   */
+  GetCurrentUserWalletAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1377,8 +1500,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the list of notifications for the current user */
-  GetMyNotifications: {
+  /**
+   * Get the list of notifications for the current user
+   * @description Get the list of notifications for the current user
+   */
+  GetCurrentUserNotificationsAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1406,8 +1532,11 @@ export interface operations {
       };
     };
   };
-  /** Counts the list of notifications for the current user */
-  CountMyNotifications: {
+  /**
+   * Count the notifications for the current user
+   * @description Count the notifications for the current user
+   */
+  CountCurrentUserNotificationsAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1435,8 +1564,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the settings for the current user */
-  GetMySettings: {
+  /**
+   * Get the settings for the current user
+   * @description Get the settings for the current user
+   */
+  GetCurrentUserSettingsAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1464,8 +1596,11 @@ export interface operations {
       };
     };
   };
-  /** Updates the settings for the current user */
-  UpdateMySettings: {
+  /**
+   * Update the settings for the current user
+   * @description Update the settings for the current user
+   */
+  UpdateCurrentUserSettingsAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1500,8 +1635,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the list of addresses for the current user */
-  GetMyAddresses: {
+  /**
+   * Get the list of addresses for the current user
+   * @description Get the list of addresses for the current user
+   */
+  GetCurrentUserAddressesAsync: {
     parameters: {
       query?: {
         "api-version"?: string;
@@ -1529,8 +1667,11 @@ export interface operations {
       };
     };
   };
-  /** Gets the list of tenant enrollment invitations for the current user */
-  GetMyInvitations: {
+  /**
+   * Get the list of tenant enrollment invitations for the current user
+   * @description Get the list of tenant enrollment invitations for the current user
+   */
+  GetCurrentUserInvitationAsync: {
     parameters: {
       query?: {
         "api-version"?: string;