@onesignal/node-onesignal/dist/apis/DefaultApi.d.ts

OpenAPI client for @onesignal/node-onesignal

import { BaseAPIRequestFactory } from './baseapi';
import { Configuration } from '../configuration';
import { RequestContext, ResponseContext } from '../http/http';
import { ApiKeyTokensListResponse } from '../models/ApiKeyTokensListResponse';
import { App } from '../models/App';
import { CopyTemplateRequest } from '../models/CopyTemplateRequest';
import { CreateApiKeyRequest } from '../models/CreateApiKeyRequest';
import { CreateApiKeyResponse } from '../models/CreateApiKeyResponse';
import { CreateNotificationSuccessResponse } from '../models/CreateNotificationSuccessResponse';
import { CreateSegmentSuccessResponse } from '../models/CreateSegmentSuccessResponse';
import { CreateTemplateRequest } from '../models/CreateTemplateRequest';
import { CustomEventsRequest } from '../models/CustomEventsRequest';
import { ExportEventsSuccessResponse } from '../models/ExportEventsSuccessResponse';
import { ExportSubscriptionsRequestBody } from '../models/ExportSubscriptionsRequestBody';
import { ExportSubscriptionsSuccessResponse } from '../models/ExportSubscriptionsSuccessResponse';
import { GenericSuccessBoolResponse } from '../models/GenericSuccessBoolResponse';
import { GetNotificationHistoryRequestBody } from '../models/GetNotificationHistoryRequestBody';
import { GetSegmentsSuccessResponse } from '../models/GetSegmentsSuccessResponse';
import { Notification } from '../models/Notification';
import { NotificationHistorySuccessResponse } from '../models/NotificationHistorySuccessResponse';
import { NotificationSlice } from '../models/NotificationSlice';
import { NotificationWithMeta } from '../models/NotificationWithMeta';
import { OutcomesData } from '../models/OutcomesData';
import { PropertiesBody } from '../models/PropertiesBody';
import { Segment } from '../models/Segment';
import { StartLiveActivityRequest } from '../models/StartLiveActivityRequest';
import { StartLiveActivitySuccessResponse } from '../models/StartLiveActivitySuccessResponse';
import { SubscriptionBody } from '../models/SubscriptionBody';
import { TemplateResource } from '../models/TemplateResource';
import { TemplatesListResponse } from '../models/TemplatesListResponse';
import { TransferSubscriptionRequestBody } from '../models/TransferSubscriptionRequestBody';
import { UpdateApiKeyRequest } from '../models/UpdateApiKeyRequest';
import { UpdateLiveActivityRequest } from '../models/UpdateLiveActivityRequest';
import { UpdateLiveActivitySuccessResponse } from '../models/UpdateLiveActivitySuccessResponse';
import { UpdateTemplateRequest } from '../models/UpdateTemplateRequest';
import { UpdateUserRequest } from '../models/UpdateUserRequest';
import { User } from '../models/User';
import { UserIdentityBody } from '../models/UserIdentityBody';
export declare class DefaultApiRequestFactory extends BaseAPIRequestFactory {
    cancelNotification(appId: string, notificationId: string, _options?: Configuration): Promise<RequestContext>;
    copyTemplateToApp(templateId: string, appId: string, copyTemplateRequest: CopyTemplateRequest, _options?: Configuration): Promise<RequestContext>;
    createAlias(appId: string, aliasLabel: string, aliasId: string, userIdentityBody: UserIdentityBody, _options?: Configuration): Promise<RequestContext>;
    createAliasBySubscription(appId: string, subscriptionId: string, userIdentityBody: UserIdentityBody, _options?: Configuration): Promise<RequestContext>;
    createApiKey(appId: string, createApiKeyRequest: CreateApiKeyRequest, _options?: Configuration): Promise<RequestContext>;
    createApp(app: App, _options?: Configuration): Promise<RequestContext>;
    createCustomEvents(appId: string, customEventsRequest: CustomEventsRequest, _options?: Configuration): Promise<RequestContext>;
    createNotification(notification: Notification, _options?: Configuration): Promise<RequestContext>;
    createSegment(appId: string, segment?: Segment, _options?: Configuration): Promise<RequestContext>;
    createSubscription(appId: string, aliasLabel: string, aliasId: string, subscriptionBody: SubscriptionBody, _options?: Configuration): Promise<RequestContext>;
    createTemplate(createTemplateRequest: CreateTemplateRequest, _options?: Configuration): Promise<RequestContext>;
    createUser(appId: string, user: User, _options?: Configuration): Promise<RequestContext>;
    deleteAlias(appId: string, aliasLabel: string, aliasId: string, aliasLabelToDelete: string, _options?: Configuration): Promise<RequestContext>;
    deleteApiKey(appId: string, tokenId: string, _options?: Configuration): Promise<RequestContext>;
    deleteSegment(appId: string, segmentId: string, _options?: Configuration): Promise<RequestContext>;
    deleteSubscription(appId: string, subscriptionId: string, _options?: Configuration): Promise<RequestContext>;
    deleteTemplate(templateId: string, appId: string, _options?: Configuration): Promise<RequestContext>;
    deleteUser(appId: string, aliasLabel: string, aliasId: string, _options?: Configuration): Promise<RequestContext>;
    exportEvents(notificationId: string, appId: string, _options?: Configuration): Promise<RequestContext>;
    exportSubscriptions(appId: string, exportSubscriptionsRequestBody?: ExportSubscriptionsRequestBody, _options?: Configuration): Promise<RequestContext>;
    getAliases(appId: string, aliasLabel: string, aliasId: string, _options?: Configuration): Promise<RequestContext>;
    getAliasesBySubscription(appId: string, subscriptionId: string, _options?: Configuration): Promise<RequestContext>;
    getApp(appId: string, _options?: Configuration): Promise<RequestContext>;
    getApps(_options?: Configuration): Promise<RequestContext>;
    getNotification(appId: string, notificationId: string, _options?: Configuration): Promise<RequestContext>;
    getNotificationHistory(notificationId: string, getNotificationHistoryRequestBody: GetNotificationHistoryRequestBody, _options?: Configuration): Promise<RequestContext>;
    getNotifications(appId: string, limit?: number, offset?: number, kind?: 0 | 1 | 3, _options?: Configuration): Promise<RequestContext>;
    getOutcomes(appId: string, outcomeNames: string, outcomeNames2?: string, outcomeTimeRange?: string, outcomePlatforms?: string, outcomeAttribution?: string, _options?: Configuration): Promise<RequestContext>;
    getSegments(appId: string, offset?: number, limit?: number, _options?: Configuration): Promise<RequestContext>;
    getUser(appId: string, aliasLabel: string, aliasId: string, _options?: Configuration): Promise<RequestContext>;
    rotateApiKey(appId: string, tokenId: string, _options?: Configuration): Promise<RequestContext>;
    startLiveActivity(appId: string, activityType: string, startLiveActivityRequest: StartLiveActivityRequest, _options?: Configuration): Promise<RequestContext>;
    transferSubscription(appId: string, subscriptionId: string, transferSubscriptionRequestBody: TransferSubscriptionRequestBody, _options?: Configuration): Promise<RequestContext>;
    unsubscribeEmailWithToken(appId: string, notificationId: string, token: string, _options?: Configuration): Promise<RequestContext>;
    updateApiKey(appId: string, tokenId: string, updateApiKeyRequest: UpdateApiKeyRequest, _options?: Configuration): Promise<RequestContext>;
    updateApp(appId: string, app: App, _options?: Configuration): Promise<RequestContext>;
    updateLiveActivity(appId: string, activityId: string, updateLiveActivityRequest: UpdateLiveActivityRequest, _options?: Configuration): Promise<RequestContext>;
    updateSubscription(appId: string, subscriptionId: string, subscriptionBody: SubscriptionBody, _options?: Configuration): Promise<RequestContext>;
    updateSubscriptionByToken(appId: string, tokenType: string, token: string, subscriptionBody: SubscriptionBody, _options?: Configuration): Promise<RequestContext>;
    updateTemplate(templateId: string, appId: string, updateTemplateRequest: UpdateTemplateRequest, _options?: Configuration): Promise<RequestContext>;
    updateUser(appId: string, aliasLabel: string, aliasId: string, updateUserRequest: UpdateUserRequest, _options?: Configuration): Promise<RequestContext>;
    viewApiKeys(appId: string, _options?: Configuration): Promise<RequestContext>;
    viewTemplate(templateId: string, appId: string, _options?: Configuration): Promise<RequestContext>;
    viewTemplates(appId: string, limit?: number, offset?: number, channel?: 'push' | 'email' | 'sms', _options?: Configuration): Promise<RequestContext>;
}
export declare class DefaultApiResponseProcessor {
    cancelNotification(response: ResponseContext): Promise<GenericSuccessBoolResponse>;
    copyTemplateToApp(response: ResponseContext): Promise<TemplateResource>;
    createAlias(response: ResponseContext): Promise<UserIdentityBody>;
    createAliasBySubscription(response: ResponseContext): Promise<UserIdentityBody>;
    createApiKey(response: ResponseContext): Promise<CreateApiKeyResponse>;
    createApp(response: ResponseContext): Promise<App>;
    createCustomEvents(response: ResponseContext): Promise<object>;
    createNotification(response: ResponseContext): Promise<CreateNotificationSuccessResponse>;
    createSegment(response: ResponseContext): Promise<CreateSegmentSuccessResponse>;
    createSubscription(response: ResponseContext): Promise<SubscriptionBody>;
    createTemplate(response: ResponseContext): Promise<TemplateResource>;
    createUser(response: ResponseContext): Promise<User>;
    deleteAlias(response: ResponseContext): Promise<UserIdentityBody>;
    deleteApiKey(response: ResponseContext): Promise<object>;
    deleteSegment(response: ResponseContext): Promise<GenericSuccessBoolResponse>;
    deleteSubscription(response: ResponseContext): Promise<void>;
    deleteTemplate(response: ResponseContext): Promise<GenericSuccessBoolResponse>;
    deleteUser(response: ResponseContext): Promise<void>;
    exportEvents(response: ResponseContext): Promise<ExportEventsSuccessResponse>;
    exportSubscriptions(response: ResponseContext): Promise<ExportSubscriptionsSuccessResponse>;
    getAliases(response: ResponseContext): Promise<UserIdentityBody>;
    getAliasesBySubscription(response: ResponseContext): Promise<UserIdentityBody>;
    getApp(response: ResponseContext): Promise<App>;
    getApps(response: ResponseContext): Promise<Array<App>>;
    getNotification(response: ResponseContext): Promise<NotificationWithMeta>;
    getNotificationHistory(response: ResponseContext): Promise<NotificationHistorySuccessResponse>;
    getNotifications(response: ResponseContext): Promise<NotificationSlice>;
    getOutcomes(response: ResponseContext): Promise<OutcomesData>;
    getSegments(response: ResponseContext): Promise<GetSegmentsSuccessResponse>;
    getUser(response: ResponseContext): Promise<User>;
    rotateApiKey(response: ResponseContext): Promise<CreateApiKeyResponse>;
    startLiveActivity(response: ResponseContext): Promise<StartLiveActivitySuccessResponse>;
    transferSubscription(response: ResponseContext): Promise<UserIdentityBody>;
    unsubscribeEmailWithToken(response: ResponseContext): Promise<GenericSuccessBoolResponse>;
    updateApiKey(response: ResponseContext): Promise<object>;
    updateApp(response: ResponseContext): Promise<App>;
    updateLiveActivity(response: ResponseContext): Promise<UpdateLiveActivitySuccessResponse>;
    updateSubscription(response: ResponseContext): Promise<void>;
    updateSubscriptionByToken(response: ResponseContext): Promise<object>;
    updateTemplate(response: ResponseContext): Promise<TemplateResource>;
    updateUser(response: ResponseContext): Promise<PropertiesBody>;
    viewApiKeys(response: ResponseContext): Promise<ApiKeyTokensListResponse>;
    viewTemplate(response: ResponseContext): Promise<TemplateResource>;
    viewTemplates(response: ResponseContext): Promise<TemplatesListResponse>;
}