@globalscoutme/api-client 1.1.29 → 1.2.1

package/sdk.gen.ts

@@ -73,6 +73,12 @@ import type {
   GetApiDocumentsMeData,
   GetApiDocumentsMeErrors,
   GetApiDocumentsMeResponses,
+  GetApiGlobalChatMessagesData,
+  GetApiGlobalChatMessagesResponses,
+  GetApiGlobalChatStatusData,
+  GetApiGlobalChatStatusResponses,
+  GetApiGlobalChatTimelineData,
+  GetApiGlobalChatTimelineResponses,
   GetApiIndexByTableNameData,
   GetApiIndexByTableNameErrors,
   GetApiIndexByTableNameResponses,
@@ -81,6 +87,8 @@ import type {
   GetApiIndexCountriesResponses,
   GetApiInvitationsData,
   GetApiInvitationsResponses,
+  GetApiKycMobileReturnData,
+  GetApiKycMobileReturnResponses,
   GetApiKycStatusByUserIdData,
   GetApiKycStatusByUserIdErrors,
   GetApiKycStatusByUserIdResponses,
@@ -159,6 +167,10 @@ import type {
   PatchApiClubsMeByIdData,
   PatchApiClubsMeByIdErrors,
   PatchApiClubsMeByIdResponses,
+  PatchApiGlobalChatNotificationsData,
+  PatchApiGlobalChatNotificationsResponses,
+  PatchApiGlobalChatReadData,
+  PatchApiGlobalChatReadResponses,
   PatchApiNotificationsPreferencesData,
   PatchApiNotificationsPreferencesResponses,
   PatchApiOffersConversationsByIdReadData,
@@ -196,6 +208,14 @@ import type {
   PostApiDocumentsData,
   PostApiDocumentsErrors,
   PostApiDocumentsResponses,
+  PostApiGlobalChatJoinData,
+  PostApiGlobalChatJoinResponses,
+  PostApiGlobalChatLeaveData,
+  PostApiGlobalChatLeaveResponses,
+  PostApiGlobalChatMessagesByMessageIdReportData,
+  PostApiGlobalChatMessagesByMessageIdReportResponses,
+  PostApiGlobalChatMessagesData,
+  PostApiGlobalChatMessagesResponses,
   PostApiInvitationsAcceptData,
   PostApiInvitationsAcceptResponses,
   PostApiInvitationsByIdResendData,
@@ -1216,6 +1236,19 @@ export class Invitations extends HeyApiClient {
 }
 
 export class Kyc extends HeyApiClient {
+  /**
+   * Return a Smile Link browser session to the mobile app
+   */
+  public returnToMobileKyc<ThrowOnError extends boolean = false>(
+    options: Options<GetApiKycMobileReturnData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).get<
+      GetApiKycMobileReturnResponses,
+      unknown,
+      ThrowOnError
+    >({ url: '/api/kyc/mobile-return', ...options });
+  }
+
   /**
    * Start or resume a KYC verification job
    */
@@ -1685,6 +1718,126 @@ export class Subscriptions extends HeyApiClient {
   }
 }
 
+export class GlobalChat extends HeyApiClient {
+  public getGlobalChatStatus<ThrowOnError extends boolean = false>(
+    options?: Options<GetApiGlobalChatStatusData, ThrowOnError>
+  ) {
+    return (options?.client ?? this.client).get<
+      GetApiGlobalChatStatusResponses,
+      unknown,
+      ThrowOnError
+    >({ url: '/api/global-chat/status', ...options });
+  }
+
+  public joinGlobalChat<ThrowOnError extends boolean = false>(
+    options: Options<PostApiGlobalChatJoinData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiGlobalChatJoinResponses,
+      unknown,
+      ThrowOnError
+    >({
+      url: '/api/global-chat/join',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  public leaveGlobalChat<ThrowOnError extends boolean = false>(
+    options?: Options<PostApiGlobalChatLeaveData, ThrowOnError>
+  ) {
+    return (options?.client ?? this.client).post<
+      PostApiGlobalChatLeaveResponses,
+      unknown,
+      ThrowOnError
+    >({ url: '/api/global-chat/leave', ...options });
+  }
+
+  public listGlobalChatMessages<ThrowOnError extends boolean = false>(
+    options?: Options<GetApiGlobalChatMessagesData, ThrowOnError>
+  ) {
+    return (options?.client ?? this.client).get<
+      GetApiGlobalChatMessagesResponses,
+      unknown,
+      ThrowOnError
+    >({ url: '/api/global-chat/messages', ...options });
+  }
+
+  public sendGlobalChatMessage<ThrowOnError extends boolean = false>(
+    options: Options<PostApiGlobalChatMessagesData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiGlobalChatMessagesResponses,
+      unknown,
+      ThrowOnError
+    >({
+      url: '/api/global-chat/messages',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  public listGlobalChatTimeline<ThrowOnError extends boolean = false>(
+    options?: Options<GetApiGlobalChatTimelineData, ThrowOnError>
+  ) {
+    return (options?.client ?? this.client).get<
+      GetApiGlobalChatTimelineResponses,
+      unknown,
+      ThrowOnError
+    >({ url: '/api/global-chat/timeline', ...options });
+  }
+
+  public markGlobalChatRead<ThrowOnError extends boolean = false>(
+    options: Options<PatchApiGlobalChatReadData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).patch<
+      PatchApiGlobalChatReadResponses,
+      unknown,
+      ThrowOnError
+    >({
+      url: '/api/global-chat/read',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  public reportGlobalChatMessage<ThrowOnError extends boolean = false>(
+    options: Options<PostApiGlobalChatMessagesByMessageIdReportData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiGlobalChatMessagesByMessageIdReportResponses,
+      unknown,
+      ThrowOnError
+    >({ url: '/api/global-chat/messages/{messageId}/report', ...options });
+  }
+
+  public updateGlobalChatNotifications<ThrowOnError extends boolean = false>(
+    options: Options<PatchApiGlobalChatNotificationsData, ThrowOnError>
+  ) {
+    return (options.client ?? this.client).patch<
+      PatchApiGlobalChatNotificationsResponses,
+      unknown,
+      ThrowOnError
+    >({
+      url: '/api/global-chat/notifications',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+}
+
 export class GlobalScoutMeClient extends HeyApiClient {
   public static readonly __registry = new HeyApiRegistry<GlobalScoutMeClient>();
 
@@ -1817,4 +1970,9 @@ export class GlobalScoutMeClient extends HeyApiClient {
   get subscriptions(): Subscriptions {
     return (this._subscriptions ??= new Subscriptions({ client: this.client }));
   }
+
+  private _globalChat?: GlobalChat;
+  get globalChat(): GlobalChat {
+    return (this._globalChat ??= new GlobalChat({ client: this.client }));
+  }
 }

package/tsconfig.json

@@ -8,7 +8,8 @@
     "strict": false,
     "skipLibCheck": true,
     "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true
+    "allowSyntheticDefaultImports": true,
+    "noEmitOnError": true
   },
   "include": ["./**/*.ts"],
   "exclude": ["dist", "node_modules"]

package/types.gen.ts

@@ -2684,6 +2684,113 @@ export type PortalResultDto = {
   url: string;
 };
 
+export type GlobalChatTimelineMessageDto = {
+  id: string;
+  senderId: string;
+  senderDisplayName: string;
+  senderAvatarUrl: string | null;
+  body: string;
+  createdAt: string;
+  isOwnMessage: boolean;
+  clientMessageId: string;
+  kind: 'message';
+  sortCreatedAt: string;
+};
+
+export type GlobalChatTimelineSystemDto = {
+  kind: 'system';
+  id: string;
+  eventType: 'member_joined' | 'member_removed_after_reports';
+  subjectDisplayName: string | null;
+  createdAt: string;
+  sortCreatedAt: string;
+};
+
+export type GlobalChatMessageDto = {
+  id: string;
+  senderId: string;
+  senderDisplayName: string;
+  senderAvatarUrl: string | null;
+  body: string;
+  createdAt: string;
+  isOwnMessage: boolean;
+  clientMessageId: string;
+};
+
+export type GlobalChatStatusDto = {
+  available: boolean;
+  eligibility: 'eligible' | 'underage' | 'incomplete' | 'wrong_role' | 'inactive';
+  membership: 'not_joined' | 'active' | 'left' | 'excluded' | 'rules_required';
+  rulesVersion: number;
+  notificationsEnabled: boolean;
+  masterPushEnabled: boolean;
+  unreadCount: number;
+  latestMessage: GlobalChatMessageDto | null;
+};
+
+export type JoinGlobalChatDto = {
+  acceptedRulesVersion?: number;
+  rulesLocale?: string;
+  notificationsEnabled: boolean;
+};
+
+export type JoinGlobalChatResultDto = {
+  available: boolean;
+  eligibility: 'eligible' | 'underage' | 'incomplete' | 'wrong_role' | 'inactive';
+  membership: 'not_joined' | 'active' | 'left' | 'excluded' | 'rules_required';
+  rulesVersion: number;
+  notificationsEnabled: boolean;
+  masterPushEnabled: boolean;
+  unreadCount: number;
+  latestMessage: GlobalChatMessageDto | null;
+  becameActive: boolean;
+};
+
+export type GlobalChatActionDto = {
+  ok: boolean;
+};
+
+export type GlobalChatMessageCursorDto = {
+  createdAt: string;
+  id: string;
+};
+
+export type GlobalChatMessagePageDto = {
+  messages: Array<GlobalChatMessageDto>;
+  nextCursor: GlobalChatMessageCursorDto | null;
+};
+
+export type GlobalChatTimelineCursorDto = {
+  createdAt: string;
+  id: string;
+  kind: 'message' | 'system';
+};
+
+export type GlobalChatTimelinePageDto = {
+  items: Array<
+    | ({
+        kind: 'message';
+      } & GlobalChatTimelineMessageDto)
+    | ({
+        kind: 'system';
+      } & GlobalChatTimelineSystemDto)
+  >;
+  nextCursor: GlobalChatTimelineCursorDto | null;
+};
+
+export type SendGlobalChatMessageDto = {
+  body: string;
+  clientMessageId: string;
+};
+
+export type MarkGlobalChatReadDto = {
+  messageId: string;
+};
+
+export type UpdateGlobalChatNotificationsDto = {
+  notificationsEnabled: boolean;
+};
+
 export type GetApiAuthMeData = {
   body?: never;
   path?: never;
@@ -4206,6 +4313,19 @@ export type PostApiInvitationsAcceptResponses = {
 export type PostApiInvitationsAcceptResponse =
   PostApiInvitationsAcceptResponses[keyof PostApiInvitationsAcceptResponses];
 
+export type GetApiKycMobileReturnData = {
+  body?: never;
+  path?: never;
+  query: {
+    status: string;
+  };
+  url: '/api/kyc/mobile-return';
+};
+
+export type GetApiKycMobileReturnResponses = {
+  200: unknown;
+};
+
 export type PostApiKycStartData = {
   body: StartKycRequestDto;
   path?: never;
@@ -4992,3 +5112,140 @@ export type PostApiSubscriptionsWebhookResponses = {
    */
   200: unknown;
 };
+
+export type GetApiGlobalChatStatusData = {
+  body?: never;
+  path?: never;
+  query?: never;
+  url: '/api/global-chat/status';
+};
+
+export type GetApiGlobalChatStatusResponses = {
+  200: GlobalChatStatusDto;
+};
+
+export type GetApiGlobalChatStatusResponse =
+  GetApiGlobalChatStatusResponses[keyof GetApiGlobalChatStatusResponses];
+
+export type PostApiGlobalChatJoinData = {
+  body: JoinGlobalChatDto;
+  path?: never;
+  query?: never;
+  url: '/api/global-chat/join';
+};
+
+export type PostApiGlobalChatJoinResponses = {
+  201: JoinGlobalChatResultDto;
+};
+
+export type PostApiGlobalChatJoinResponse =
+  PostApiGlobalChatJoinResponses[keyof PostApiGlobalChatJoinResponses];
+
+export type PostApiGlobalChatLeaveData = {
+  body?: never;
+  path?: never;
+  query?: never;
+  url: '/api/global-chat/leave';
+};
+
+export type PostApiGlobalChatLeaveResponses = {
+  201: GlobalChatActionDto;
+};
+
+export type PostApiGlobalChatLeaveResponse =
+  PostApiGlobalChatLeaveResponses[keyof PostApiGlobalChatLeaveResponses];
+
+export type GetApiGlobalChatMessagesData = {
+  body?: never;
+  path?: never;
+  query?: {
+    limit?: number;
+    cursorId?: string;
+    cursorCreatedAt?: string;
+  };
+  url: '/api/global-chat/messages';
+};
+
+export type GetApiGlobalChatMessagesResponses = {
+  200: GlobalChatMessagePageDto;
+};
+
+export type GetApiGlobalChatMessagesResponse =
+  GetApiGlobalChatMessagesResponses[keyof GetApiGlobalChatMessagesResponses];
+
+export type PostApiGlobalChatMessagesData = {
+  body: SendGlobalChatMessageDto;
+  path?: never;
+  query?: never;
+  url: '/api/global-chat/messages';
+};
+
+export type PostApiGlobalChatMessagesResponses = {
+  201: GlobalChatMessageDto;
+};
+
+export type PostApiGlobalChatMessagesResponse =
+  PostApiGlobalChatMessagesResponses[keyof PostApiGlobalChatMessagesResponses];
+
+export type GetApiGlobalChatTimelineData = {
+  body?: never;
+  path?: never;
+  query?: {
+    limit?: number;
+    cursorKind?: 'message' | 'system';
+    cursorId?: string;
+    cursorCreatedAt?: string;
+  };
+  url: '/api/global-chat/timeline';
+};
+
+export type GetApiGlobalChatTimelineResponses = {
+  200: GlobalChatTimelinePageDto;
+};
+
+export type GetApiGlobalChatTimelineResponse =
+  GetApiGlobalChatTimelineResponses[keyof GetApiGlobalChatTimelineResponses];
+
+export type PatchApiGlobalChatReadData = {
+  body: MarkGlobalChatReadDto;
+  path?: never;
+  query?: never;
+  url: '/api/global-chat/read';
+};
+
+export type PatchApiGlobalChatReadResponses = {
+  200: GlobalChatActionDto;
+};
+
+export type PatchApiGlobalChatReadResponse =
+  PatchApiGlobalChatReadResponses[keyof PatchApiGlobalChatReadResponses];
+
+export type PostApiGlobalChatMessagesByMessageIdReportData = {
+  body?: never;
+  path: {
+    messageId: string;
+  };
+  query?: never;
+  url: '/api/global-chat/messages/{messageId}/report';
+};
+
+export type PostApiGlobalChatMessagesByMessageIdReportResponses = {
+  201: GlobalChatActionDto;
+};
+
+export type PostApiGlobalChatMessagesByMessageIdReportResponse =
+  PostApiGlobalChatMessagesByMessageIdReportResponses[keyof PostApiGlobalChatMessagesByMessageIdReportResponses];
+
+export type PatchApiGlobalChatNotificationsData = {
+  body: UpdateGlobalChatNotificationsDto;
+  path?: never;
+  query?: never;
+  url: '/api/global-chat/notifications';
+};
+
+export type PatchApiGlobalChatNotificationsResponses = {
+  200: GlobalChatStatusDto;
+};
+
+export type PatchApiGlobalChatNotificationsResponse =
+  PatchApiGlobalChatNotificationsResponses[keyof PatchApiGlobalChatNotificationsResponses];