magicbell-js 0.1.0 → 0.3.0

package/src/project-client/services/channels/channels-service.ts

@@ -30,33 +30,31 @@ import { TeamsTokenCollection, teamsTokenCollectionResponse } from './models/tea
 import { WebPushToken, webPushTokenResponse } from './models/web-push-token.js';
 import { WebPushTokenCollection, webPushTokenCollectionResponse } from './models/web-push-token-collection.js';
 import {
-  GetDeliveryconfigParams,
-  GetInAppInboxUserTokensParams,
-  GetMobilePushApnsUserTokensParams,
-  GetMobilePushExpoUserTokensParams,
-  GetMobilePushFcmUserTokensParams,
-  GetSlackUserTokensParams,
-  GetTeamsUserTokensParams,
-  GetWebPushUserTokensParams,
+  ListUserApnsTokensParams,
+  ListUserExpoTokensParams,
+  ListUserFcmTokensParams,
+  ListUserInboxTokensParams,
+  ListUserSlackTokensParams,
+  ListUserTeamsTokensParams,
+  ListUserWebPushTokensParams,
 } from './request-params.js';
 
 export class ChannelsService extends BaseService {
   /**
-   *
-   * @param {string} [params.key] -
+   * Save the channels configuration for a given key.
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<CategoryDeliveryConfig>>} OK
    */
-  async getDeliveryconfig(
-    params?: GetDeliveryconfigParams,
+  async saveChannelsConfig(
+    body: CategoryDeliveryConfig,
     requestConfig?: RequestConfig,
   ): Promise<HttpResponse<CategoryDeliveryConfig>> {
     const request = new RequestBuilder()
       .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
       .setConfig(this.config)
-      .setMethod('GET')
-      .setPath('/channels/deliveryconfig')
-      .setRequestSchema(z.any())
+      .setMethod('PUT')
+      .setPath('/channels')
+      .setRequestSchema(categoryDeliveryConfigRequest)
       .addAccessTokenAuth(this.config.token, 'Bearer')
       .setRequestContentType(ContentType.Json)
       .addResponse({
@@ -67,29 +65,25 @@ export class ChannelsService extends BaseService {
       .setRetryAttempts(this.config, requestConfig)
       .setRetryDelayMs(this.config, requestConfig)
       .setResponseValidation(this.config, requestConfig)
-      .addQueryParam({
-        key: 'key',
-        value: params?.key,
-      })
+      .addHeaderParam({ key: 'Content-Type', value: 'application/json' })
+      .addBody(body)
       .build();
     return this.client.call<CategoryDeliveryConfig>(request);
   }
 
   /**
-   *
+   * Fetches the channels config for a given key.
+   * @param {string} key -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<CategoryDeliveryConfig>>} OK
    */
-  async saveDeliveryconfig(
-    body: CategoryDeliveryConfig,
-    requestConfig?: RequestConfig,
-  ): Promise<HttpResponse<CategoryDeliveryConfig>> {
+  async fetchChannelsConfig(key: string, requestConfig?: RequestConfig): Promise<HttpResponse<CategoryDeliveryConfig>> {
     const request = new RequestBuilder()
       .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
       .setConfig(this.config)
-      .setMethod('PUT')
-      .setPath('/channels/deliveryconfig')
-      .setRequestSchema(categoryDeliveryConfigRequest)
+      .setMethod('GET')
+      .setPath('/channels/{key}')
+      .setRequestSchema(z.any())
       .addAccessTokenAuth(this.config.token, 'Bearer')
       .setRequestContentType(ContentType.Json)
       .addResponse({
@@ -100,14 +94,16 @@ export class ChannelsService extends BaseService {
       .setRetryAttempts(this.config, requestConfig)
       .setRetryDelayMs(this.config, requestConfig)
       .setResponseValidation(this.config, requestConfig)
-      .addHeaderParam({ key: 'Content-Type', value: 'application/json' })
-      .addBody(body)
+      .addPathParam({
+        key: 'key',
+        value: key,
+      })
       .build();
     return this.client.call<CategoryDeliveryConfig>(request);
   }
 
   /**
-   * Lists all in_app tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
+   * Lists all Inbox tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
    * @param {number} [params.limit] -
    * @param {string} [params.startingAfter] -
@@ -115,9 +111,9 @@ export class ChannelsService extends BaseService {
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<InboxTokenResponseCollection>>} OK
    */
-  async getInAppInboxUserTokens(
+  async listUserInboxTokens(
     userId: string,
-    params?: GetInAppInboxUserTokensParams,
+    params?: ListUserInboxTokensParams,
     requestConfig?: RequestConfig,
   ): Promise<HttpResponse<InboxTokenResponseCollection>> {
     const request = new RequestBuilder()
@@ -157,13 +153,13 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Retrieves a specific in_app token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
+   * Fetches a specific Inbox token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
    * @param {string} userId -
    * @param {string} tokenId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<InboxTokenResponse>>} OK
    */
-  async getInAppInboxUserToken(
+  async fetchUserInboxToken(
     userId: string,
     tokenId: string,
     requestConfig?: RequestConfig,
@@ -197,13 +193,13 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Revokes a specific user's in_app token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
+   * Deletes a specific user's Inbox token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
    * @param {string} userId -
    * @param {string} tokenId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<DiscardResult>>} OK
    */
-  async discardInAppInboxUserToken(
+  async deleteUserInboxToken(
     userId: string,
     tokenId: string,
     requestConfig?: RequestConfig,
@@ -237,7 +233,7 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Lists all mobile_push tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
+   * Lists all APNs tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
    * @param {number} [params.limit] -
    * @param {string} [params.startingAfter] -
@@ -245,9 +241,9 @@ export class ChannelsService extends BaseService {
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<ApnsTokenCollection>>} OK
    */
-  async getMobilePushApnsUserTokens(
+  async listUserApnsTokens(
     userId: string,
-    params?: GetMobilePushApnsUserTokensParams,
+    params?: ListUserApnsTokensParams,
     requestConfig?: RequestConfig,
   ): Promise<HttpResponse<ApnsTokenCollection>> {
     const request = new RequestBuilder()
@@ -287,13 +283,13 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Retrieves a specific mobile_push token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
+   * Fetches a specific APNs token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
    * @param {string} userId -
    * @param {string} tokenId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<ApnsToken>>} OK
    */
-  async getMobilePushApnsUserToken(
+  async fetchUserApnsToken(
     userId: string,
     tokenId: string,
     requestConfig?: RequestConfig,
@@ -327,13 +323,13 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Revokes a specific user's mobile_push token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
+   * Deletes a specific user's APNs token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
    * @param {string} userId -
    * @param {string} tokenId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<DiscardResult>>} OK
    */
-  async discardMobilePushApnsUserToken(
+  async deleteUserApnsToken(
     userId: string,
     tokenId: string,
     requestConfig?: RequestConfig,
@@ -367,7 +363,7 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Lists all mobile_push tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
+   * Lists all Expo tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
    * @param {number} [params.limit] -
    * @param {string} [params.startingAfter] -
@@ -375,9 +371,9 @@ export class ChannelsService extends BaseService {
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<ExpoTokenCollection>>} OK
    */
-  async getMobilePushExpoUserTokens(
+  async listUserExpoTokens(
     userId: string,
-    params?: GetMobilePushExpoUserTokensParams,
+    params?: ListUserExpoTokensParams,
     requestConfig?: RequestConfig,
   ): Promise<HttpResponse<ExpoTokenCollection>> {
     const request = new RequestBuilder()
@@ -417,13 +413,13 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Retrieves a specific mobile_push token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
+   * Fetches a specific Expo token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
    * @param {string} userId -
    * @param {string} tokenId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<ExpoToken>>} OK
    */
-  async getMobilePushExpoUserToken(
+  async fetchUserExpoToken(
     userId: string,
     tokenId: string,
     requestConfig?: RequestConfig,
@@ -457,13 +453,13 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Revokes a specific user's mobile_push token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
+   * Deletes a specific user's Expo token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
    * @param {string} userId -
    * @param {string} tokenId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<DiscardResult>>} OK
    */
-  async discardMobilePushExpoUserToken(
+  async deleteUserExpoToken(
     userId: string,
     tokenId: string,
     requestConfig?: RequestConfig,
@@ -497,7 +493,7 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Lists all mobile_push tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
+   * Lists all FCM tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
    * @param {number} [params.limit] -
    * @param {string} [params.startingAfter] -
@@ -505,9 +501,9 @@ export class ChannelsService extends BaseService {
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<FcmTokenCollection>>} OK
    */
-  async getMobilePushFcmUserTokens(
+  async listUserFcmTokens(
     userId: string,
-    params?: GetMobilePushFcmUserTokensParams,
+    params?: ListUserFcmTokensParams,
     requestConfig?: RequestConfig,
   ): Promise<HttpResponse<FcmTokenCollection>> {
     const request = new RequestBuilder()
@@ -547,13 +543,13 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Retrieves a specific mobile_push token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
+   * Fetches a specific FCM token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
    * @param {string} userId -
    * @param {string} tokenId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<FcmToken>>} OK
    */
-  async getMobilePushFcmUserToken(
+  async fetchUserFcmToken(
     userId: string,
     tokenId: string,
     requestConfig?: RequestConfig,
@@ -587,13 +583,13 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Revokes a specific user's mobile_push token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
+   * Deletes a specific user's FCM token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
    * @param {string} userId -
    * @param {string} tokenId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<DiscardResult>>} OK
    */
-  async discardMobilePushFcmUserToken(
+  async deleteUserFcmToken(
     userId: string,
     tokenId: string,
     requestConfig?: RequestConfig,
@@ -627,7 +623,7 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Lists all slack tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
+   * Lists all Slack tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
    * @param {number} [params.limit] -
    * @param {string} [params.startingAfter] -
@@ -635,9 +631,9 @@ export class ChannelsService extends BaseService {
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<SlackTokenCollection>>} OK
    */
-  async getSlackUserTokens(
+  async listUserSlackTokens(
     userId: string,
-    params?: GetSlackUserTokensParams,
+    params?: ListUserSlackTokensParams,
     requestConfig?: RequestConfig,
   ): Promise<HttpResponse<SlackTokenCollection>> {
     const request = new RequestBuilder()
@@ -677,13 +673,13 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Retrieves a specific slack token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
+   * Fetches a specific Slack token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
    * @param {string} userId -
    * @param {string} tokenId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<SlackToken>>} OK
    */
-  async getSlackUserToken(
+  async fetchUserSlackToken(
     userId: string,
     tokenId: string,
     requestConfig?: RequestConfig,
@@ -717,13 +713,13 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Revokes a specific user's slack token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
+   * Deletes a specific user's Slack token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
    * @param {string} userId -
    * @param {string} tokenId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<DiscardResult>>} OK
    */
-  async discardSlackUserToken(
+  async deleteUserSlackToken(
     userId: string,
     tokenId: string,
     requestConfig?: RequestConfig,
@@ -757,7 +753,7 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Lists all teams tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
+   * Lists all Teams tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
    * @param {number} [params.limit] -
    * @param {string} [params.startingAfter] -
@@ -765,9 +761,9 @@ export class ChannelsService extends BaseService {
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<TeamsTokenCollection>>} OK
    */
-  async getTeamsUserTokens(
+  async listUserTeamsTokens(
     userId: string,
-    params?: GetTeamsUserTokensParams,
+    params?: ListUserTeamsTokensParams,
     requestConfig?: RequestConfig,
   ): Promise<HttpResponse<TeamsTokenCollection>> {
     const request = new RequestBuilder()
@@ -807,13 +803,13 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Retrieves a specific teams token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
+   * Fetches a specific Teams token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
    * @param {string} userId -
    * @param {string} tokenId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<TeamsToken>>} OK
    */
-  async getTeamsUserToken(
+  async fetchUserTeamsToken(
     userId: string,
     tokenId: string,
     requestConfig?: RequestConfig,
@@ -847,13 +843,13 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Revokes a specific user's teams token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
+   * Deletes a specific user's Teams token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
    * @param {string} userId -
    * @param {string} tokenId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<DiscardResult>>} OK
    */
-  async discardTeamsUserToken(
+  async deleteUserTeamsToken(
     userId: string,
     tokenId: string,
     requestConfig?: RequestConfig,
@@ -887,7 +883,7 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Lists all web_push tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
+   * Lists all Web Push tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
    * @param {number} [params.limit] -
    * @param {string} [params.startingAfter] -
@@ -895,9 +891,9 @@ export class ChannelsService extends BaseService {
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<WebPushTokenCollection>>} OK
    */
-  async getWebPushUserTokens(
+  async listUserWebPushTokens(
     userId: string,
-    params?: GetWebPushUserTokensParams,
+    params?: ListUserWebPushTokensParams,
     requestConfig?: RequestConfig,
   ): Promise<HttpResponse<WebPushTokenCollection>> {
     const request = new RequestBuilder()
@@ -937,13 +933,13 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Retrieves a specific web_push token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
+   * Fetches a specific Web Push token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
    * @param {string} userId -
    * @param {string} tokenId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<WebPushToken>>} OK
    */
-  async getWebPushUserToken(
+  async fetchUserWebPushToken(
     userId: string,
     tokenId: string,
     requestConfig?: RequestConfig,
@@ -977,13 +973,13 @@ export class ChannelsService extends BaseService {
   }
 
   /**
-   * Revokes a specific user's web_push token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
+   * Deletes a specific user's Web Push token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
    * @param {string} userId -
    * @param {string} tokenId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<DiscardResult>>} OK
    */
-  async discardWebPushUserToken(
+  async deleteUserWebPushToken(
     userId: string,
     tokenId: string,
     requestConfig?: RequestConfig,

package/src/project-client/services/channels/request-params.ts

@@ -1,44 +1,40 @@
-export interface GetDeliveryconfigParams {
-  key?: string;
-}
-
-export interface GetInAppInboxUserTokensParams {
+export interface ListUserInboxTokensParams {
   limit?: number;
   startingAfter?: string;
   endingBefore?: string;
 }
 
-export interface GetMobilePushApnsUserTokensParams {
+export interface ListUserApnsTokensParams {
   limit?: number;
   startingAfter?: string;
   endingBefore?: string;
 }
 
-export interface GetMobilePushExpoUserTokensParams {
+export interface ListUserExpoTokensParams {
   limit?: number;
   startingAfter?: string;
   endingBefore?: string;
 }
 
-export interface GetMobilePushFcmUserTokensParams {
+export interface ListUserFcmTokensParams {
   limit?: number;
   startingAfter?: string;
   endingBefore?: string;
 }
 
-export interface GetSlackUserTokensParams {
+export interface ListUserSlackTokensParams {
   limit?: number;
   startingAfter?: string;
   endingBefore?: string;
 }
 
-export interface GetTeamsUserTokensParams {
+export interface ListUserTeamsTokensParams {
   limit?: number;
   startingAfter?: string;
   endingBefore?: string;
 }
 
-export interface GetWebPushUserTokensParams {
+export interface ListUserWebPushTokensParams {
   limit?: number;
   startingAfter?: string;
   endingBefore?: string;

package/src/project-client/services/common/index.ts

@@ -1 +1,2 @@
 export type { Links } from './links.js';
+export type { User } from './user.js';

package/src/project-client/services/events/events-service.ts

@@ -53,17 +53,17 @@ export class EventsService extends BaseService {
   }
 
   /**
-   * Retrieves a project event by its ID.
-   * @param {string} id -
+   * Fetches a project event by its ID.
+   * @param {string} eventId -
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<Event>>} OK
    */
-  async getEvent(id: string, requestConfig?: RequestConfig): Promise<HttpResponse<Event>> {
+  async fetchEvent(eventId: string, requestConfig?: RequestConfig): Promise<HttpResponse<Event>> {
     const request = new RequestBuilder()
       .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
       .setConfig(this.config)
       .setMethod('GET')
-      .setPath('/events/{id}')
+      .setPath('/events/{event_id}')
       .setRequestSchema(z.any())
       .addAccessTokenAuth(this.config.token, 'Bearer')
       .setRequestContentType(ContentType.Json)
@@ -76,8 +76,8 @@ export class EventsService extends BaseService {
       .setRetryDelayMs(this.config, requestConfig)
       .setResponseValidation(this.config, requestConfig)
       .addPathParam({
-        key: 'id',
-        value: id,
+        key: 'event_id',
+        value: eventId,
       })
       .build();
     return this.client.call<Event>(request);