@medrunner/api-client 0.6.3 → 0.7.0-beta.10

package/dist/index.d.ts

@@ -12,10 +12,13 @@ type Headers = {
 interface DbItem {
     id: string;
     created: string;
+}
+
+interface WritableDbItem extends DbItem {
     updated: string;
 }
 
-interface ApiToken extends DbItem {
+interface ApiToken extends WritableDbItem {
     /**
      * The user who created the token
      * */
@@ -25,13 +28,43 @@ interface ApiToken extends DbItem {
      * */
     name: string;
     /**
-     * The timestamp at which the token will expire in Unix seconds
+     * The date at which the token will expire
      * */
-    expirationDate?: number;
+    expirationDate?: string;
     /**
      *  When the token was last used to generate a new access token, iso-8601 timestamp
      * */
     lastUsed?: string;
+    /**
+     *  Whether the token has expired
+     * */
+    expired: boolean;
+    /**
+     *  The version of the token
+     * */
+    version: TokenVersion;
+    /**
+     *  The scopes granted to the token
+     * */
+    scopes: TokenScope[];
+}
+declare enum TokenVersion {
+    UNKNOWN = -1,
+    LEGACY = 0,
+    V3 = 3,
+    V4 = 4
+}
+declare enum TokenScope {
+    CLIENT_READ = "client:read",
+    CLIENT_WRITE = "client:write",
+    CLIENT_PROFILE_READ = "client:profile:read",
+    CLIENT_PROFILE_WRITE = "client:profile:write",
+    CLIENT_ORGSETTINGS_READ = "client:orgsettings:read",
+    STAFF_READ = "staff:read",
+    STAFF_WRITE = "staff:write",
+    STAFF_PROFILE_READ = "staff:profile:read",
+    STAFF_PROFILE_WRITE = "staff:profile:write",
+    STAFF_ORGSETTINGS_READ = "staff:orgsettings:read"
 }
 
 interface ApiResponse<T = unknown> {
@@ -130,6 +163,10 @@ interface CreateApiTokenRequest {
      * Optional expiration date for the token
      * */
     expirationDate?: Date;
+    /**
+     * List of scopes for the token
+     * */
+    scopes: TokenScope[];
 }
 
 /**
@@ -177,7 +214,7 @@ declare class AuthEndpoint extends ApiEndpoint {
     deleteApiToken(id: string): Promise<ApiResponse>;
 }
 
-interface ChatMessage extends DbItem {
+interface ChatMessage extends WritableDbItem {
     /**
      * The emergency associated with the chat message
      * */
@@ -186,10 +223,6 @@ interface ChatMessage extends DbItem {
      * The user id of the message sender
      * */
     senderId: string;
-    /**
-     * The timestamp at which the message was sent in Unix seconds
-     * */
-    messageSentTimestamp: number;
     /**
      * The contents of the message
      * */
@@ -250,8 +283,8 @@ declare class ChatMessageEndpoint extends ApiEndpoint {
      * Gets the specified amount of chat messages for a given emergency.
      *
      * @param emergencyId - The emergency for which to fetch the chat history
-     * @param limit - The number of emergencies to get
-     * @param paginationToken - The number to use for pagination
+     * @param limit - The number of emergencies to get, max 100
+     * @param paginationToken - The string to use for pagination
      * */
     getMessageHistory(emergencyId: string, limit: number, paginationToken?: string): Promise<ApiResponse<PaginatedResponse<ChatMessage>>>;
     /**
@@ -283,7 +316,6 @@ declare class ChatMessageEndpoint extends ApiEndpoint {
 interface ClientHistory extends DbItem {
     emergencyId: string;
     clientId: string;
-    emergencyCreationTimestamp: string;
 }
 
 interface EmergencyStats {
@@ -296,19 +328,6 @@ interface EmergencyStats {
     canceled: number;
 }
 
-interface WritableDbItem extends DbItem {
-    updated: string;
-}
-
-interface PromotionalCode extends WritableDbItem {
-    redeemerId: string;
-    type: CodeType;
-}
-declare enum CodeType {
-    Unknown = 0,
-    CitizenCon2954 = 1
-}
-
 interface Person extends WritableDbItem {
     discordId: string;
     rsiHandle?: string;
@@ -318,14 +337,6 @@ interface Person extends WritableDbItem {
     deactivationReason: AccountDeactivationReason;
     clientStats: ClientStats;
     activeEmergency?: string;
-    /**
-     * @deprecated Use {@link Person.clientPortalPreferencesBlob} instead.
-     */
-    clientPortalPreferences: Record<string, unknown>;
-    /**
-     * @deprecated Fetch this information via {@link client.getRedeemedCodes} instead.
-     */
-    redeemedCodes: RedeemedCode[];
     clientPortalPreferencesBlob?: string;
     allowAnonymousAlert: boolean;
     initialJoinDate?: string;
@@ -333,6 +344,7 @@ interface Person extends WritableDbItem {
 declare enum UserRoles {
     CLIENT = 1,
     STAFF = 2,
+    CEO = 262144,
     DEVELOPER = 524288,
     BOT = 1048576
 }
@@ -343,9 +355,7 @@ declare enum PersonType {
 }
 declare enum AccountDeactivationReason {
     NONE = 0,
-    CLIENT_DRIVEN_DELETION = 1,
-    TERMINATED = 2,
-    BLOCKED = 3
+    CLIENT_DRIVEN_DELETION = 1
 }
 interface ClientStats {
     missions: EmergencyStats;
@@ -353,10 +363,6 @@ interface ClientStats {
 interface BlockedStatus {
     blocked: boolean;
 }
-interface RedeemedCode {
-    code: string;
-    type: CodeType;
-}
 
 /**
  * Endpoints for interacting with clients.
@@ -370,10 +376,10 @@ declare class ClientEndpoint extends ApiEndpoint {
     get(): Promise<ApiResponse<Person>>;
     /**
      * Gets the specified amount of emergencies the client has created.
-     * @param limit - The number of emergencies to get
-     * @param paginationToken - The number to use for pagination
+     * @param limit - The number of emergencies to get, defaults to 10
+     * @param paginationToken - The string to use for pagination
      * */
-    getHistory(limit: number, paginationToken?: string): Promise<ApiResponse<PaginatedResponse<ClientHistory>>>;
+    getHistory(limit?: number, paginationToken?: string): Promise<ApiResponse<PaginatedResponse<ClientHistory>>>;
     /**
      * Gets the blocklist status of the current client.
      * */
@@ -389,7 +395,7 @@ declare class ClientEndpoint extends ApiEndpoint {
     /**
      * Updates the settings of the current user for the Client Portal.
      *
-     * @param settings - The object settings to add or update
+     * @param settings - The stringified object settings to add or update
      *
      * */
     setUserSettings(settings: string): Promise<ApiResponse>;
@@ -399,6 +405,14 @@ declare class ClientEndpoint extends ApiEndpoint {
     deactivate(): Promise<ApiResponse>;
 }
 
+interface PromotionalCode extends WritableDbItem {
+    type: CodeType;
+}
+declare enum CodeType {
+    UNKNOWN = 0,
+    CITIZEN_CON_2954 = 1
+}
+
 /**
  * Endpoints for interacting with promotional codes.
  * */
@@ -407,8 +421,11 @@ declare class CodeEndpoint extends ApiEndpoint {
     protected endpoint(): string;
     /**
      * Gets the redeemed codes for the current user.
+     *
+     * @param limit - The number of codes to get, max 100
+     * @param paginationToken - The string to use for pagination
      * */
-    getRedeemedCodes(): Promise<ApiResponse<PromotionalCode[]>>;
+    getRedeemedCodes(limit: number, paginationToken?: string): Promise<ApiResponse<PaginatedResponse<PromotionalCode>>>;
     /**
      * Redeems the specified promotional code for the current user
      *
@@ -462,16 +479,16 @@ declare enum Class {
 interface TeamMember {
     discordId: string;
     id: string;
-    rsiHandle?: string;
+    rsiHandle: string;
     class: Class;
-    teamId?: string;
+    updated: string;
 }
 
 interface Team {
+    maxMembers: number;
     staff: TeamMember[];
     dispatchers: TeamMember[];
     allMembers: TeamMember[];
-    maxMembers: number;
 }
 
 declare enum ThreatLevel {
@@ -491,28 +508,25 @@ interface Emergency extends WritableDbItem {
     clientId?: string;
     subscriptionTier: string;
     status: MissionStatus;
-    alertMessage?: MessageCache;
-    clientMessage?: MessageCache;
-    coordinationThread?: MessageCache;
-    afterActionReportMessage?: MessageCache;
+    cancellationReason: CancellationReason;
+    refusalReason?: string;
+    alertMessage?: DiscordMessage;
+    clientMessage?: DiscordMessage;
+    coordinationThread?: DiscordMessage;
+    afterActionReportMessage?: DiscordMessage;
     respondingTeam: Team;
     respondingTeams: RespondingTeam[];
-    creationTimestamp: number;
-    acceptedTimestamp?: number;
-    completionTimestamp?: number;
+    acceptedOn?: string;
+    completedOn?: string;
     rating: ResponseRating;
     ratingRemarks?: string;
-    test: boolean;
-    cancellationReason: CancellationReason;
-    refusalReason?: string;
     origin: Origin;
     clientData?: ClientData;
-    isComplete: boolean;
     missionName?: string;
+    isComplete: boolean;
     afterActionReport?: AfterActionReport;
-    submissionSource: SubmissionSource;
 }
-interface MessageCache {
+interface DiscordMessage {
     id: string;
     channelId: string;
 }
@@ -520,21 +534,21 @@ interface ClientData {
     rsiHandle: string;
     rsiProfileLink: string;
     gotClientData: boolean;
-    redactedOrgOnProfile: boolean;
     reported: boolean;
+    userSid?: string;
 }
 interface AfterActionReport {
-    remarks?: string;
-    submitterStaffId: string;
     servicesProvided: MissionServices;
     suspectedTrap: boolean;
-    hasBeenEdited: boolean;
-    submittedOn: number;
+    remarks?: string;
+    submitterStaffId: string;
+    submittedOn?: string;
     editHistory: AfterActionReportEdit[];
+    hasBeenEdited: boolean;
 }
 interface AfterActionReportEdit {
     editorStaffId: string;
-    editTime: number;
+    editTime: string;
 }
 declare enum MissionServices {
     NONE = 0,
@@ -729,9 +743,9 @@ interface PublicOrgSettings {
     status: ServiceStatus;
     emergenciesEnabled: boolean;
     anonymousAlertsEnabled: boolean;
-    registrationEnabled: boolean;
     messageOfTheDay?: MessageOfTheDay;
     locationSettings: LocationSettings;
+    registrationEnabled: boolean;
 }
 interface MessageOfTheDay {
     message: string;
@@ -747,9 +761,9 @@ interface LocationSettings {
 interface SpaceLocation {
     name: string;
     type: SpaceLocationType;
-    characteristics: LocationCharacteristic[];
     children: SpaceLocation[];
     enabled: boolean;
+    characteristics: LocationCharacteristic[];
 }
 declare enum SpaceLocationType {
     UNKNOWN = 0,
@@ -759,7 +773,7 @@ declare enum SpaceLocationType {
 }
 declare enum ServiceStatus {
     UNKNOWN = 0,
-    HEALTHY = 1,
+    OPERATIONAL = 1,
     SLIGHTLY_DEGRADED = 2,
     HEAVILY_DEGRADED = 3,
     OFFLINE = 4
@@ -906,4 +920,4 @@ declare enum ClientType {
     STAFF_PORTAL = 2
 }
 
-export { AccountDeactivationReason, type AfterActionReport, type AfterActionReportEdit, type ApiClient, type ApiConfig, ApiEndpoint, type ApiResponse, type ApiToken, type AsyncAction, type AsyncProvider, AuthEndpoint, type BlockedStatus, CancellationReason, type ChatMessage, ChatMessageEndpoint, type ChatMessageRequest, Class, type ClientData, ClientEndpoint, type ClientHistory, type ClientStats, ClientType, CodeEndpoint, CodeType, type CreateEmergencyRequest, type DateRange, type DbItem, DefaultApiConfig, type Deployment, type Emergency, EmergencyEndpoint, type EmergencyStats, type Func, type HeaderProvider, type Headers, Level, type Location, LocationCharacteristic, type LocationDetail, type LocationSettings, LocationType, type MedalInformation, MedrunnerApiClient, type MessageCache, type MessageOfTheDay, MissionServices, MissionStatus, type OrgSettings, OrgSettingsEndpoint, Origin, type PaginatedResponse, type Person, PersonType, type PromotionalCode, type PublicOrgSettings, type RedeemedCode, type ResponderDetails, type RespondingTeam, ResponseRating, ServiceStatus, type SpaceLocation, SpaceLocationType, StaffEndpoint, SubmissionSource, type Team, type TeamDetailsResponse, type TeamMember, ThreatLevel, type TokenGrant, TokenManager, UserRoles, WebsocketEndpoint, type WritableDbItem };
+export { AccountDeactivationReason, type AfterActionReport, type AfterActionReportEdit, type ApiClient, type ApiConfig, ApiEndpoint, type ApiResponse, type ApiToken, type AsyncAction, type AsyncProvider, AuthEndpoint, type BlockedStatus, CancellationReason, type ChatMessage, ChatMessageEndpoint, type ChatMessageRequest, Class, type ClientData, ClientEndpoint, type ClientHistory, type ClientStats, ClientType, CodeEndpoint, CodeType, type CreateEmergencyRequest, type DateRange, type DbItem, DefaultApiConfig, type Deployment, type DiscordMessage, type Emergency, EmergencyEndpoint, type EmergencyStats, type Func, type HeaderProvider, type Headers, Level, type Location, LocationCharacteristic, type LocationDetail, type LocationSettings, LocationType, type MedalInformation, MedrunnerApiClient, type MessageOfTheDay, MissionServices, MissionStatus, type OrgSettings, OrgSettingsEndpoint, Origin, type PaginatedResponse, type Person, PersonType, type PromotionalCode, type PublicOrgSettings, type ResponderDetails, type RespondingTeam, ResponseRating, ServiceStatus, type SpaceLocation, SpaceLocationType, StaffEndpoint, SubmissionSource, type Team, type TeamDetailsResponse, type TeamMember, ThreatLevel, type TokenGrant, TokenManager, TokenScope, TokenVersion, UserRoles, WebsocketEndpoint, type WritableDbItem };

package/dist/index.js

@@ -59,6 +59,8 @@ __export(index_exports, {
   SubmissionSource: () => SubmissionSource,
   ThreatLevel: () => ThreatLevel,
   TokenManager: () => TokenManager,
+  TokenScope: () => TokenScope,
+  TokenVersion: () => TokenVersion,
   UserRoles: () => UserRoles,
   WebsocketEndpoint: () => WebsocketEndpoint
 });
@@ -215,7 +217,8 @@ var AuthEndpoint = class extends ApiEndpoint {
   async createApiToken(newToken) {
     return await this.postRequest("/apiTokens", {
       name: newToken.name,
-      expirationDate: newToken.expirationDate?.toISOString()
+      expirationDate: newToken.expirationDate?.toISOString(),
+      scopes: newToken.scopes
     });
   }
   /**
@@ -340,8 +343,8 @@ var ChatMessageEndpoint = class extends ApiEndpoint {
    * Gets the specified amount of chat messages for a given emergency.
    *
    * @param emergencyId - The emergency for which to fetch the chat history
-   * @param limit - The number of emergencies to get
-   * @param paginationToken - The number to use for pagination
+   * @param limit - The number of emergencies to get, max 100
+   * @param paginationToken - The string to use for pagination
    * */
   async getMessageHistory(emergencyId, limit, paginationToken) {
     return await this.getRequest(`/conversation/${emergencyId}`, {
@@ -400,8 +403,8 @@ var ClientEndpoint = class extends ApiEndpoint {
   }
   /**
    * Gets the specified amount of emergencies the client has created.
-   * @param limit - The number of emergencies to get
-   * @param paginationToken - The number to use for pagination
+   * @param limit - The number of emergencies to get, defaults to 10
+   * @param paginationToken - The string to use for pagination
    * */
   async getHistory(limit, paginationToken) {
     return await this.getRequest("/history", { limit, paginationToken });
@@ -425,7 +428,7 @@ var ClientEndpoint = class extends ApiEndpoint {
   /**
    * Updates the settings of the current user for the Client Portal.
    *
-   * @param settings - The object settings to add or update
+   * @param settings - The stringified object settings to add or update
    *
    * */
   async setUserSettings(settings) {
@@ -452,9 +455,15 @@ var CodeEndpoint = class extends ApiEndpoint {
   }
   /**
    * Gets the redeemed codes for the current user.
+   *
+   * @param limit - The number of codes to get, max 100
+   * @param paginationToken - The string to use for pagination
    * */
-  async getRedeemedCodes() {
-    return await this.getRequest("/redeemed");
+  async getRedeemedCodes(limit, paginationToken) {
+    return await this.getRequest("/redeemed", {
+      limit,
+      paginationToken
+    });
   }
   /**
    * Redeems the specified promotional code for the current user
@@ -773,6 +782,7 @@ var MissionStatus = /* @__PURE__ */ ((MissionStatus2) => {
 var UserRoles = /* @__PURE__ */ ((UserRoles2) => {
   UserRoles2[UserRoles2["CLIENT"] = 1] = "CLIENT";
   UserRoles2[UserRoles2["STAFF"] = 2] = "STAFF";
+  UserRoles2[UserRoles2["CEO"] = 262144] = "CEO";
   UserRoles2[UserRoles2["DEVELOPER"] = 524288] = "DEVELOPER";
   UserRoles2[UserRoles2["BOT"] = 1048576] = "BOT";
   return UserRoles2;
@@ -786,8 +796,6 @@ var PersonType = /* @__PURE__ */ ((PersonType2) => {
 var AccountDeactivationReason = /* @__PURE__ */ ((AccountDeactivationReason2) => {
   AccountDeactivationReason2[AccountDeactivationReason2["NONE"] = 0] = "NONE";
   AccountDeactivationReason2[AccountDeactivationReason2["CLIENT_DRIVEN_DELETION"] = 1] = "CLIENT_DRIVEN_DELETION";
-  AccountDeactivationReason2[AccountDeactivationReason2["TERMINATED"] = 2] = "TERMINATED";
-  AccountDeactivationReason2[AccountDeactivationReason2["BLOCKED"] = 3] = "BLOCKED";
   return AccountDeactivationReason2;
 })(AccountDeactivationReason || {});
 
@@ -854,7 +862,7 @@ var SpaceLocationType = /* @__PURE__ */ ((SpaceLocationType2) => {
 })(SpaceLocationType || {});
 var ServiceStatus = /* @__PURE__ */ ((ServiceStatus2) => {
   ServiceStatus2[ServiceStatus2["UNKNOWN"] = 0] = "UNKNOWN";
-  ServiceStatus2[ServiceStatus2["HEALTHY"] = 1] = "HEALTHY";
+  ServiceStatus2[ServiceStatus2["OPERATIONAL"] = 1] = "OPERATIONAL";
   ServiceStatus2[ServiceStatus2["SLIGHTLY_DEGRADED"] = 2] = "SLIGHTLY_DEGRADED";
   ServiceStatus2[ServiceStatus2["HEAVILY_DEGRADED"] = 3] = "HEAVILY_DEGRADED";
   ServiceStatus2[ServiceStatus2["OFFLINE"] = 4] = "OFFLINE";
@@ -877,10 +885,32 @@ var ClientType = /* @__PURE__ */ ((ClientType2) => {
 
 // src/models/PromotionalCode.ts
 var CodeType = /* @__PURE__ */ ((CodeType2) => {
-  CodeType2[CodeType2["Unknown"] = 0] = "Unknown";
-  CodeType2[CodeType2["CitizenCon2954"] = 1] = "CitizenCon2954";
+  CodeType2[CodeType2["UNKNOWN"] = 0] = "UNKNOWN";
+  CodeType2[CodeType2["CITIZEN_CON_2954"] = 1] = "CITIZEN_CON_2954";
   return CodeType2;
 })(CodeType || {});
+
+// src/models/ApiToken.ts
+var TokenVersion = /* @__PURE__ */ ((TokenVersion2) => {
+  TokenVersion2[TokenVersion2["UNKNOWN"] = -1] = "UNKNOWN";
+  TokenVersion2[TokenVersion2["LEGACY"] = 0] = "LEGACY";
+  TokenVersion2[TokenVersion2["V3"] = 3] = "V3";
+  TokenVersion2[TokenVersion2["V4"] = 4] = "V4";
+  return TokenVersion2;
+})(TokenVersion || {});
+var TokenScope = /* @__PURE__ */ ((TokenScope2) => {
+  TokenScope2["CLIENT_READ"] = "client:read";
+  TokenScope2["CLIENT_WRITE"] = "client:write";
+  TokenScope2["CLIENT_PROFILE_READ"] = "client:profile:read";
+  TokenScope2["CLIENT_PROFILE_WRITE"] = "client:profile:write";
+  TokenScope2["CLIENT_ORGSETTINGS_READ"] = "client:orgsettings:read";
+  TokenScope2["STAFF_READ"] = "staff:read";
+  TokenScope2["STAFF_WRITE"] = "staff:write";
+  TokenScope2["STAFF_PROFILE_READ"] = "staff:profile:read";
+  TokenScope2["STAFF_PROFILE_WRITE"] = "staff:profile:write";
+  TokenScope2["STAFF_ORGSETTINGS_READ"] = "staff:orgsettings:read";
+  return TokenScope2;
+})(TokenScope || {});
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AccountDeactivationReason,
@@ -911,6 +941,8 @@ var CodeType = /* @__PURE__ */ ((CodeType2) => {
   SubmissionSource,
   ThreatLevel,
   TokenManager,
+  TokenScope,
+  TokenVersion,
   UserRoles,
   WebsocketEndpoint
 });