import { HttpResponse, RequestConfig } from '../../http/types.js'; import { BaseService } from '../base-service.js'; import { ApnsToken } from './models/apns-token.js'; import { ApnsTokenCollection } from './models/apns-token-collection.js'; import { CategoryDeliveryConfig } from './models/category-delivery-config.js'; import { DiscardResult } from './models/discard-result.js'; import { ExpoToken } from './models/expo-token.js'; import { ExpoTokenCollection } from './models/expo-token-collection.js'; import { FcmToken } from './models/fcm-token.js'; import { FcmTokenCollection } from './models/fcm-token-collection.js'; import { InboxTokenResponse } from './models/inbox-token-response.js'; import { InboxTokenResponseCollection } from './models/inbox-token-response-collection.js'; import { SlackToken } from './models/slack-token.js'; import { SlackTokenCollection } from './models/slack-token-collection.js'; import { TeamsToken } from './models/teams-token.js'; import { TeamsTokenCollection } from './models/teams-token-collection.js'; import { WebPushToken } from './models/web-push-token.js'; import { WebPushTokenCollection } from './models/web-push-token-collection.js'; import { ListUserApnsTokensParams, ListUserExpoTokensParams, ListUserFcmTokensParams, ListUserInboxTokensParams, ListUserMagicbellSlackbotTokensParams, ListUserSlackTokensParams, ListUserTeamsTokensParams, ListUserWebPushTokensParams } from './request-params.js'; /** * Service class for ChannelsService operations. * Provides methods to interact with ChannelsService-related API endpoints. * All methods return promises and handle request/response serialization automatically. */ export declare class ChannelsService extends BaseService { /** * Save the channels configuration for a given key. * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ saveChannelsConfig(body: CategoryDeliveryConfig, requestConfig?: RequestConfig): Promise>; /** * Fetches the channels config for a given key. * @param {string} key - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchChannelsConfig(key: string, requestConfig?: RequestConfig): Promise>; /** * 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] - defines the maximum number of items to return per page (default: 50) * @param {string} [params.startingAfter] - a cursor for use in pagination, points to the last ID in previous page * @param {string} [params.endingBefore] - a cursor for use in pagination, points to the first ID in next page * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ listUserInboxTokens(userId: string, params?: ListUserInboxTokensParams, requestConfig?: RequestConfig): Promise>; /** * 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchUserInboxToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteUserInboxToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * 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] - defines the maximum number of items to return per page (default: 50) * @param {string} [params.startingAfter] - a cursor for use in pagination, points to the last ID in previous page * @param {string} [params.endingBefore] - a cursor for use in pagination, points to the first ID in next page * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ listUserApnsTokens(userId: string, params?: ListUserApnsTokensParams, requestConfig?: RequestConfig): Promise>; /** * 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchUserApnsToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteUserApnsToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * 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] - defines the maximum number of items to return per page (default: 50) * @param {string} [params.startingAfter] - a cursor for use in pagination, points to the last ID in previous page * @param {string} [params.endingBefore] - a cursor for use in pagination, points to the first ID in next page * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ listUserExpoTokens(userId: string, params?: ListUserExpoTokensParams, requestConfig?: RequestConfig): Promise>; /** * 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchUserExpoToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteUserExpoToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * 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] - defines the maximum number of items to return per page (default: 50) * @param {string} [params.startingAfter] - a cursor for use in pagination, points to the last ID in previous page * @param {string} [params.endingBefore] - a cursor for use in pagination, points to the first ID in next page * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ listUserFcmTokens(userId: string, params?: ListUserFcmTokensParams, requestConfig?: RequestConfig): Promise>; /** * 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchUserFcmToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteUserFcmToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Lists all MagicBell SlackBot 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] - defines the maximum number of items to return per page (default: 50) * @param {string} [params.startingAfter] - a cursor for use in pagination, points to the last ID in previous page * @param {string} [params.endingBefore] - a cursor for use in pagination, points to the first ID in next page * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ listUserMagicbellSlackbotTokens(userId: string, params?: ListUserMagicbellSlackbotTokensParams, requestConfig?: RequestConfig): Promise>; /** * Fetches a specific MagicBell SlackBot 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchUserMagicbellSlackbotToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Deletes a specific user's MagicBell SlackBot 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteUserMagicbellSlackbotToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * 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] - defines the maximum number of items to return per page (default: 50) * @param {string} [params.startingAfter] - a cursor for use in pagination, points to the last ID in previous page * @param {string} [params.endingBefore] - a cursor for use in pagination, points to the first ID in next page * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ listUserSlackTokens(userId: string, params?: ListUserSlackTokensParams, requestConfig?: RequestConfig): Promise>; /** * 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchUserSlackToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteUserSlackToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * 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] - defines the maximum number of items to return per page (default: 50) * @param {string} [params.startingAfter] - a cursor for use in pagination, points to the last ID in previous page * @param {string} [params.endingBefore] - a cursor for use in pagination, points to the first ID in next page * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ listUserTeamsTokens(userId: string, params?: ListUserTeamsTokensParams, requestConfig?: RequestConfig): Promise>; /** * 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchUserTeamsToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteUserTeamsToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * 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] - defines the maximum number of items to return per page (default: 50) * @param {string} [params.startingAfter] - a cursor for use in pagination, points to the last ID in previous page * @param {string} [params.endingBefore] - a cursor for use in pagination, points to the first ID in next page * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ listUserWebPushTokens(userId: string, params?: ListUserWebPushTokensParams, requestConfig?: RequestConfig): Promise>; /** * 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchUserWebPushToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; /** * 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] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteUserWebPushToken(userId: string, tokenId: string, requestConfig?: RequestConfig): Promise>; } //# sourceMappingURL=channels-service.d.ts.map