@globalscoutme/api-client 1.2.7 → 1.4.0

package/index.ts

@@ -2,6 +2,7 @@
 
 export {
   Achievements,
+  Admin,
   Auth,
   Billing,
   Body,
@@ -31,7 +32,36 @@ export {
   Videos,
 } from './sdk.gen.js';
 export type {
+  AccessCodeBadRequestResponseDto,
+  AccessCodeConflictResponseDto,
   AchievementCatalogDto,
+  AdminAccessCodeDto,
+  AdminAccessCodeListResultDto,
+  AdminAccessCodePlanDto,
+  AdminAccessCodeRedemptionDto,
+  AdminAccessCodeRedemptionListResultDto,
+  AdminAccessGrantDto,
+  AdminAccountActionResponseDto,
+  AdminActivityBucketDto,
+  AdminCreateAccessCodeDto,
+  AdminCreateAccessCodeResponseDto,
+  AdminDashboardMetricsDto,
+  AdminDashboardResponseDto,
+  AdminGrantAccessDto,
+  AdminKycListItemDto,
+  AdminKycListResultDto,
+  AdminMetricDto,
+  AdminPasswordResetResponseDto,
+  AdminRevokeAccessGrantDto,
+  AdminSetAccessCodeStateDto,
+  AdminSubscriptionHealthDto,
+  AdminSubscriptionListItemDto,
+  AdminSubscriptionListResultDto,
+  AdminUserAccessDto,
+  AdminUserActionRequestDto,
+  AdminUserDetailDto,
+  AdminUserListItemDto,
+  AdminUserListResultDto,
   AiReportClipDto,
   AiReportClipTargetDto,
   AiReportGsiBodySourceInputDto,
@@ -141,6 +171,35 @@ export type {
   GetApiAchievementsMeResponses,
   GetApiAchievementsResponse,
   GetApiAchievementsResponses,
+  GetApiAdminAccessCodesByIdRedemptionsData,
+  GetApiAdminAccessCodesByIdRedemptionsResponse,
+  GetApiAdminAccessCodesByIdRedemptionsResponses,
+  GetApiAdminAccessCodesData,
+  GetApiAdminAccessCodesPlansData,
+  GetApiAdminAccessCodesPlansResponse,
+  GetApiAdminAccessCodesPlansResponses,
+  GetApiAdminAccessCodesResponse,
+  GetApiAdminAccessCodesResponses,
+  GetApiAdminDashboardData,
+  GetApiAdminDashboardErrors,
+  GetApiAdminDashboardResponse,
+  GetApiAdminDashboardResponses,
+  GetApiAdminKycData,
+  GetApiAdminKycResponse,
+  GetApiAdminKycResponses,
+  GetApiAdminSubscriptionsData,
+  GetApiAdminSubscriptionsResponse,
+  GetApiAdminSubscriptionsResponses,
+  GetApiAdminUsersByIdAccessData,
+  GetApiAdminUsersByIdAccessResponse,
+  GetApiAdminUsersByIdAccessResponses,
+  GetApiAdminUsersByIdData,
+  GetApiAdminUsersByIdErrors,
+  GetApiAdminUsersByIdResponse,
+  GetApiAdminUsersByIdResponses,
+  GetApiAdminUsersData,
+  GetApiAdminUsersResponse,
+  GetApiAdminUsersResponses,
   GetApiAuthMeData,
   GetApiAuthMeErrors,
   GetApiAuthMeResponse,
@@ -213,6 +272,7 @@ export type {
   GetApiIndexCountriesResponse,
   GetApiIndexCountriesResponses,
   GetApiInvitationsData,
+  GetApiInvitationsErrors,
   GetApiInvitationsResponse,
   GetApiInvitationsResponses,
   GetApiKycMobileReturnData,
@@ -352,6 +412,9 @@ export type {
   OkDto,
   OrganizationResponseDto,
   PaginatedTrainingContentDto,
+  PatchApiAdminAccessCodesByIdData,
+  PatchApiAdminAccessCodesByIdResponse,
+  PatchApiAdminAccessCodesByIdResponses,
   PatchApiClubsMeByIdData,
   PatchApiClubsMeByIdErrors,
   PatchApiClubsMeByIdResponse,
@@ -393,7 +456,29 @@ export type {
   PlayerVideoDto,
   PlayUrlResponseDto,
   PortalResultDto,
+  PostApiAdminAccessCodesData,
+  PostApiAdminAccessCodesResponse,
+  PostApiAdminAccessCodesResponses,
+  PostApiAdminUsersByIdAccessGrantsByGrantIdRevokeData,
+  PostApiAdminUsersByIdAccessGrantsByGrantIdRevokeResponses,
+  PostApiAdminUsersByIdAccessGrantsData,
+  PostApiAdminUsersByIdAccessGrantsResponse,
+  PostApiAdminUsersByIdAccessGrantsResponses,
+  PostApiAdminUsersByIdDeactivateData,
+  PostApiAdminUsersByIdDeactivateResponse,
+  PostApiAdminUsersByIdDeactivateResponses,
+  PostApiAdminUsersByIdReactivateData,
+  PostApiAdminUsersByIdReactivateResponse,
+  PostApiAdminUsersByIdReactivateResponses,
+  PostApiAdminUsersByIdResetPasswordData,
+  PostApiAdminUsersByIdResetPasswordResponse,
+  PostApiAdminUsersByIdResetPasswordResponses,
+  PostApiAdminUsersByIdSuspendData,
+  PostApiAdminUsersByIdSuspendResponse,
+  PostApiAdminUsersByIdSuspendResponses,
   PostApiBillingAccessCodesRedeemData,
+  PostApiBillingAccessCodesRedeemError,
+  PostApiBillingAccessCodesRedeemErrors,
   PostApiBillingAccessCodesRedeemResponse,
   PostApiBillingAccessCodesRedeemResponses,
   PostApiBillingAppleSyncPurchaseData,
@@ -442,6 +527,7 @@ export type {
   PostApiGlobalChatMessagesResponse,
   PostApiGlobalChatMessagesResponses,
   PostApiInvitationsAcceptData,
+  PostApiInvitationsAcceptErrors,
   PostApiInvitationsAcceptResponse,
   PostApiInvitationsAcceptResponses,
   PostApiInvitationsByIdResendData,
@@ -555,6 +641,7 @@ export type {
   PutApiProfileMeResponses,
   QualitySummaryDto,
   RedeemAccessCodeDto,
+  RedeemAccessCodeResponseDto,
   RegisterAgentDto,
   RegisterAgentResponseDto,
   RegisterClubDto,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@globalscoutme/api-client",
-  "version": "1.2.7",
+  "version": "1.4.0",
   "description": "GlobalScoutMe API client (generated)",
   "author": "GlobalScoutMe",
   "license": "UNLICENSED",

package/sdk.gen.ts

@@ -36,6 +36,26 @@ import type {
   GetApiAchievementsMeErrors,
   GetApiAchievementsMeResponses,
   GetApiAchievementsResponses,
+  GetApiAdminAccessCodesByIdRedemptionsData,
+  GetApiAdminAccessCodesByIdRedemptionsResponses,
+  GetApiAdminAccessCodesData,
+  GetApiAdminAccessCodesPlansData,
+  GetApiAdminAccessCodesPlansResponses,
+  GetApiAdminAccessCodesResponses,
+  GetApiAdminDashboardData,
+  GetApiAdminDashboardErrors,
+  GetApiAdminDashboardResponses,
+  GetApiAdminKycData,
+  GetApiAdminKycResponses,
+  GetApiAdminSubscriptionsData,
+  GetApiAdminSubscriptionsResponses,
+  GetApiAdminUsersByIdAccessData,
+  GetApiAdminUsersByIdAccessResponses,
+  GetApiAdminUsersByIdData,
+  GetApiAdminUsersByIdErrors,
+  GetApiAdminUsersByIdResponses,
+  GetApiAdminUsersData,
+  GetApiAdminUsersResponses,
   GetApiAuthMeData,
   GetApiAuthMeErrors,
   GetApiAuthMeResponses,
@@ -88,6 +108,7 @@ import type {
   GetApiIndexCountriesErrors,
   GetApiIndexCountriesResponses,
   GetApiInvitationsData,
+  GetApiInvitationsErrors,
   GetApiInvitationsResponses,
   GetApiKycMobileReturnData,
   GetApiKycMobileReturnResponses,
@@ -166,6 +187,8 @@ import type {
   GetApiVideosMeData,
   GetApiVideosMeErrors,
   GetApiVideosMeResponses,
+  PatchApiAdminAccessCodesByIdData,
+  PatchApiAdminAccessCodesByIdResponses,
   PatchApiClubsMeByIdData,
   PatchApiClubsMeByIdErrors,
   PatchApiClubsMeByIdResponses,
@@ -184,7 +207,22 @@ import type {
   PatchApiTrainingAdminContentByIdData,
   PatchApiTrainingAdminContentByIdErrors,
   PatchApiTrainingAdminContentByIdResponses,
+  PostApiAdminAccessCodesData,
+  PostApiAdminAccessCodesResponses,
+  PostApiAdminUsersByIdAccessGrantsByGrantIdRevokeData,
+  PostApiAdminUsersByIdAccessGrantsByGrantIdRevokeResponses,
+  PostApiAdminUsersByIdAccessGrantsData,
+  PostApiAdminUsersByIdAccessGrantsResponses,
+  PostApiAdminUsersByIdDeactivateData,
+  PostApiAdminUsersByIdDeactivateResponses,
+  PostApiAdminUsersByIdReactivateData,
+  PostApiAdminUsersByIdReactivateResponses,
+  PostApiAdminUsersByIdResetPasswordData,
+  PostApiAdminUsersByIdResetPasswordResponses,
+  PostApiAdminUsersByIdSuspendData,
+  PostApiAdminUsersByIdSuspendResponses,
   PostApiBillingAccessCodesRedeemData,
+  PostApiBillingAccessCodesRedeemErrors,
   PostApiBillingAccessCodesRedeemResponses,
   PostApiBillingAppleSyncPurchaseData,
   PostApiBillingAppleSyncPurchaseResponses,
@@ -221,6 +259,7 @@ import type {
   PostApiGlobalChatMessagesData,
   PostApiGlobalChatMessagesResponses,
   PostApiInvitationsAcceptData,
+  PostApiInvitationsAcceptErrors,
   PostApiInvitationsAcceptResponses,
   PostApiInvitationsByIdResendData,
   PostApiInvitationsByIdResendErrors,
@@ -573,7 +612,7 @@ export class Billing extends HeyApiClient {
   ) {
     return (options.client ?? this.client).post<
       PostApiBillingAccessCodesRedeemResponses,
-      unknown,
+      PostApiBillingAccessCodesRedeemErrors,
       ThrowOnError
     >({
       url: '/api/billing/access-codes/redeem',
@@ -1202,10 +1241,11 @@ export class Invitations extends HeyApiClient {
   public listInvitations<ThrowOnError extends boolean = false>(
     options?: Options<GetApiInvitationsData, ThrowOnError>
   ) {
-    return (options?.client ?? this.client).get<GetApiInvitationsResponses, unknown, ThrowOnError>({
-      url: '/api/invitations',
-      ...options,
-    });
+    return (options?.client ?? this.client).get<
+      GetApiInvitationsResponses,
+      GetApiInvitationsErrors,
+      ThrowOnError
+    >({ url: '/api/invitations', ...options });
   }
 
   public sendInvitation<ThrowOnError extends boolean = false>(
@@ -1253,7 +1293,7 @@ export class Invitations extends HeyApiClient {
   ) {
     return (options?.client ?? this.client).post<
       PostApiInvitationsAcceptResponses,
-      unknown,
+      PostApiInvitationsAcceptErrors,
       ThrowOnError
     >({ url: '/api/invitations/accept', ...options });
   }
@@ -1882,6 +1922,283 @@ export class GlobalChat extends HeyApiClient {
   }
 }
 
+export class Admin extends HeyApiClient {
+  /**
+   * Get Super Admin platform metrics
+   */
+  public getAdminDashboard<ThrowOnError extends boolean = false>(
+    options?: Options<GetApiAdminDashboardData, ThrowOnError>
+  ) {
+    return (options?.client ?? this.client).get<
+      GetApiAdminDashboardResponses,
+      GetApiAdminDashboardErrors,
+      ThrowOnError
+    >({ url: '/api/admin/dashboard', ...options });
+  }
+
+  /**
+   * List registered users for Super Admin
+   */
+  public getAdminUsers<ThrowOnError extends boolean = false>(
+    options?: Options<GetApiAdminUsersData, ThrowOnError>
+  ) {
+    return (options?.client ?? this.client).get<GetApiAdminUsersResponses, unknown, ThrowOnError>({
+      url: '/api/admin/users',
+      ...options,
+    });
+  }
+
+  /**
+   * Get registered user detail
+   */
+  public getAdminUserById<ThrowOnError extends boolean = false>(
+    options: Options<GetApiAdminUsersByIdData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).get<
+      GetApiAdminUsersByIdResponses,
+      GetApiAdminUsersByIdErrors,
+      ThrowOnError
+    >({ url: '/api/admin/users/{id}', ...options });
+  }
+
+  /**
+   * List platform subscriptions
+   */
+  public getAdminSubscriptions<ThrowOnError extends boolean = false>(
+    options?: Options<GetApiAdminSubscriptionsData, ThrowOnError>
+  ) {
+    return (options?.client ?? this.client).get<
+      GetApiAdminSubscriptionsResponses,
+      unknown,
+      ThrowOnError
+    >({ url: '/api/admin/subscriptions', ...options });
+  }
+
+  /**
+   * List latest KYC verifications
+   */
+  public getAdminKycQueue<ThrowOnError extends boolean = false>(
+    options?: Options<GetApiAdminKycData, ThrowOnError>
+  ) {
+    return (options?.client ?? this.client).get<GetApiAdminKycResponses, unknown, ThrowOnError>({
+      url: '/api/admin/kyc',
+      ...options,
+    });
+  }
+
+  /**
+   * List plans available to access codes
+   */
+  public getAdminAccessCodePlans<ThrowOnError extends boolean = false>(
+    options?: Options<GetApiAdminAccessCodesPlansData, ThrowOnError>
+  ) {
+    return (options?.client ?? this.client).get<
+      GetApiAdminAccessCodesPlansResponses,
+      unknown,
+      ThrowOnError
+    >({ url: '/api/admin/access-codes/plans', ...options });
+  }
+
+  /**
+   * List access-code campaigns
+   */
+  public getAdminAccessCodes<ThrowOnError extends boolean = false>(
+    options?: Options<GetApiAdminAccessCodesData, ThrowOnError>
+  ) {
+    return (options?.client ?? this.client).get<
+      GetApiAdminAccessCodesResponses,
+      unknown,
+      ThrowOnError
+    >({ url: '/api/admin/access-codes', ...options });
+  }
+
+  /**
+   * Create an access-code campaign
+   */
+  public createAdminAccessCode<ThrowOnError extends boolean = false>(
+    options: Options<PostApiAdminAccessCodesData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiAdminAccessCodesResponses,
+      unknown,
+      ThrowOnError
+    >({
+      url: '/api/admin/access-codes',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  /**
+   * Activate or deactivate an access code
+   */
+  public setAdminAccessCodeState<ThrowOnError extends boolean = false>(
+    options: Options<PatchApiAdminAccessCodesByIdData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).patch<
+      PatchApiAdminAccessCodesByIdResponses,
+      unknown,
+      ThrowOnError
+    >({
+      url: '/api/admin/access-codes/{id}',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  /**
+   * List access-code redemptions
+   */
+  public getAdminAccessCodeRedemptions<ThrowOnError extends boolean = false>(
+    options: Options<GetApiAdminAccessCodesByIdRedemptionsData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).get<
+      GetApiAdminAccessCodesByIdRedemptionsResponses,
+      unknown,
+      ThrowOnError
+    >({ url: '/api/admin/access-codes/{id}/redemptions', ...options });
+  }
+
+  /**
+   * Get effective billing access for a user
+   */
+  public getAdminUserAccess<ThrowOnError extends boolean = false>(
+    options: Options<GetApiAdminUsersByIdAccessData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).get<
+      GetApiAdminUsersByIdAccessResponses,
+      unknown,
+      ThrowOnError
+    >({ url: '/api/admin/users/{id}/access', ...options });
+  }
+
+  /**
+   * Grant temporary manual access to a user
+   */
+  public grantAdminUserAccess<ThrowOnError extends boolean = false>(
+    options: Options<PostApiAdminUsersByIdAccessGrantsData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiAdminUsersByIdAccessGrantsResponses,
+      unknown,
+      ThrowOnError
+    >({
+      url: '/api/admin/users/{id}/access-grants',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  /**
+   * Revoke an Admin-managed access grant
+   */
+  public revokeAdminUserAccess<ThrowOnError extends boolean = false>(
+    options: Options<PostApiAdminUsersByIdAccessGrantsByGrantIdRevokeData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiAdminUsersByIdAccessGrantsByGrantIdRevokeResponses,
+      unknown,
+      ThrowOnError
+    >({
+      url: '/api/admin/users/{id}/access-grants/{grantId}/revoke',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  /**
+   * Suspend a user account
+   */
+  public suspendAdminUser<ThrowOnError extends boolean = false>(
+    options: Options<PostApiAdminUsersByIdSuspendData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiAdminUsersByIdSuspendResponses,
+      unknown,
+      ThrowOnError
+    >({
+      url: '/api/admin/users/{id}/suspend',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  /**
+   * Reactivate a suspended account
+   */
+  public reactivateAdminUser<ThrowOnError extends boolean = false>(
+    options: Options<PostApiAdminUsersByIdReactivateData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiAdminUsersByIdReactivateResponses,
+      unknown,
+      ThrowOnError
+    >({
+      url: '/api/admin/users/{id}/reactivate',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  /**
+   * Send a password recovery email
+   */
+  public resetAdminUserPassword<ThrowOnError extends boolean = false>(
+    options: Options<PostApiAdminUsersByIdResetPasswordData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiAdminUsersByIdResetPasswordResponses,
+      unknown,
+      ThrowOnError
+    >({
+      url: '/api/admin/users/{id}/reset-password',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  /**
+   * Soft-deactivate a user account
+   */
+  public deactivateAdminUser<ThrowOnError extends boolean = false>(
+    options: Options<PostApiAdminUsersByIdDeactivateData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiAdminUsersByIdDeactivateResponses,
+      unknown,
+      ThrowOnError
+    >({
+      url: '/api/admin/users/{id}/deactivate',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+}
+
 export class GlobalScoutMeClient extends HeyApiClient {
   public static readonly __registry = new HeyApiRegistry<GlobalScoutMeClient>();
 
@@ -2019,4 +2336,9 @@ export class GlobalScoutMeClient extends HeyApiClient {
   get globalChat(): GlobalChat {
     return (this._globalChat ??= new GlobalChat({ client: this.client }));
   }
+
+  private _admin?: Admin;
+  get admin(): Admin {
+    return (this._admin ??= new Admin({ client: this.client }));
+  }
 }