import { HttpResponse, RequestConfig } from '../../http/types.js'; import { BaseService } from '../base-service.js'; import { WebPushTokenPayload } from '../common/web-push-token-payload.js'; import { ApnsToken } from './models/apns-token.js'; import { ApnsTokenCollection } from './models/apns-token-collection.js'; import { ApnsTokenPayload } from './models/apns-token-payload.js'; import { DiscardResult } from './models/discard-result.js'; import { ExpoToken } from './models/expo-token.js'; import { ExpoTokenCollection } from './models/expo-token-collection.js'; import { ExpoTokenPayload } from './models/expo-token-payload.js'; import { FcmToken } from './models/fcm-token.js'; import { FcmTokenCollection } from './models/fcm-token-collection.js'; import { FcmTokenPayload } from './models/fcm-token-payload.js'; import { InboxToken } from './models/inbox-token.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 { SlackTokenPayload } from './models/slack-token-payload.js'; import { TeamsToken } from './models/teams-token.js'; import { TeamsTokenCollection } from './models/teams-token-collection.js'; import { TeamsTokenPayload } from './models/teams-token-payload.js'; import { UserPreferences } from './models/user-preferences.js'; import { WebPushToken } from './models/web-push-token.js'; import { WebPushTokenCollection } from './models/web-push-token-collection.js'; import { ListApnsTokensParams, ListExpoTokensParams, ListFcmTokensParams, ListInboxTokensParams, ListMagicbellSlackbotTokensParams, ListSlackTokensParams, ListTeamsTokensParams, ListWebPushTokensParams } 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 { /** * Lists all Inbox tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata. * @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 */ listInboxTokens(params?: ListInboxTokensParams, requestConfig?: RequestConfig): Promise>; /** * Saves the Inbox token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel. * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ saveInboxToken(body: InboxToken, requestConfig?: RequestConfig): Promise>; /** * Fetches details of a specific Inbox token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchInboxToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Deletes one of the authenticated user's Inbox tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteInboxToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Lists all APNs tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata. * @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 */ listApnsTokens(params?: ListApnsTokensParams, requestConfig?: RequestConfig): Promise>; /** * Saves the APNs token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel. * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ saveApnsToken(body: ApnsTokenPayload, requestConfig?: RequestConfig): Promise>; /** * Fetches details of a specific APNs token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchApnsToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Deletes one of the authenticated user's APNs tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteApnsToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Lists all Expo tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata. * @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 */ listExpoTokens(params?: ListExpoTokensParams, requestConfig?: RequestConfig): Promise>; /** * Saves the Expo token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel. * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ saveExpoToken(body: ExpoTokenPayload, requestConfig?: RequestConfig): Promise>; /** * Fetches details of a specific Expo token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchExpoToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Deletes one of the authenticated user's Expo tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteExpoToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Lists all FCM tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata. * @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 */ listFcmTokens(params?: ListFcmTokensParams, requestConfig?: RequestConfig): Promise>; /** * Saves the FCM token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel. * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ saveFcmToken(body: FcmTokenPayload, requestConfig?: RequestConfig): Promise>; /** * Fetches details of a specific FCM token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchFcmToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Deletes one of the authenticated user's FCM tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteFcmToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Lists all MagicBell SlackBot tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata. * @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 */ listMagicbellSlackbotTokens(params?: ListMagicbellSlackbotTokensParams, requestConfig?: RequestConfig): Promise>; /** * Saves the MagicBell SlackBot token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel. * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ saveMagicbellSlackbotToken(body: SlackTokenPayload, requestConfig?: RequestConfig): Promise>; /** * Fetches details of a specific MagicBell SlackBot token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchMagicbellSlackbotToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Deletes one of the authenticated user's MagicBell SlackBot tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteMagicbellSlackbotToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Lists all Slack tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata. * @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 */ listSlackTokens(params?: ListSlackTokensParams, requestConfig?: RequestConfig): Promise>; /** * Saves the Slack token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel. * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ saveSlackToken(body: SlackTokenPayload, requestConfig?: RequestConfig): Promise>; /** * Fetches details of a specific Slack token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchSlackToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Deletes one of the authenticated user's Slack tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteSlackToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Lists all Teams tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata. * @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 */ listTeamsTokens(params?: ListTeamsTokensParams, requestConfig?: RequestConfig): Promise>; /** * Saves the Teams token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel. * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ saveTeamsToken(body: TeamsTokenPayload, requestConfig?: RequestConfig): Promise>; /** * Fetches details of a specific Teams token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchTeamsToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Deletes one of the authenticated user's Teams tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteTeamsToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Fetch a user's channel delivery preferences. * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchUserPreferences(requestConfig?: RequestConfig): Promise>; /** * Save a user's channel preferences. * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - No Content */ saveUserPreferences(body: UserPreferences, requestConfig?: RequestConfig): Promise>; /** * Lists all Web Push tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata. * @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 */ listWebPushTokens(params?: ListWebPushTokensParams, requestConfig?: RequestConfig): Promise>; /** * Saves the Web Push token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel. * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ saveWebPushToken(body: WebPushTokenPayload, requestConfig?: RequestConfig): Promise>; /** * Fetches details of a specific Web Push token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchWebPushToken(tokenId: string, requestConfig?: RequestConfig): Promise>; /** * Deletes one of the authenticated user's Web Push tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens. * @param {string} tokenId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ deleteWebPushToken(tokenId: string, requestConfig?: RequestConfig): Promise>; } //# sourceMappingURL=channels-service.d.ts.map