@onesignal/node-onesignal 2.0.1-beta2 → 5.0.0-alpha-01

package/auth/auth.ts

@@ -27,7 +27,7 @@ export interface TokenProvider {
 /**
  * Applies http authentication to the request context.
  */
-export class AppKeyAuthentication implements SecurityAuthentication {
+export class RestApiKeyAuthentication implements SecurityAuthentication {
     /**
      * Configures the http authentication with the required details.
      *
@@ -36,7 +36,7 @@ export class AppKeyAuthentication implements SecurityAuthentication {
     public constructor(private tokenProvider: TokenProvider) {}
 
     public getName(): string {
-        return "app_key";
+        return "rest_api_key";
     }
 
     public async applySecurityAuthentication(context: RequestContext) {
@@ -47,7 +47,7 @@ export class AppKeyAuthentication implements SecurityAuthentication {
 /**
  * Applies http authentication to the request context.
  */
-export class UserKeyAuthentication implements SecurityAuthentication {
+export class UserAuthKeyAuthentication implements SecurityAuthentication {
     /**
      * Configures the http authentication with the required details.
      *
@@ -56,7 +56,7 @@ export class UserKeyAuthentication implements SecurityAuthentication {
     public constructor(private tokenProvider: TokenProvider) {}
 
     public getName(): string {
-        return "user_key";
+        return "user_auth_key";
     }
 
     public async applySecurityAuthentication(context: RequestContext) {
@@ -67,8 +67,8 @@ export class UserKeyAuthentication implements SecurityAuthentication {
 
 export type AuthMethods = {
     "default"?: SecurityAuthentication,
-    "app_key"?: SecurityAuthentication,
-    "user_key"?: SecurityAuthentication
+    "rest_api_key"?: SecurityAuthentication,
+    "user_auth_key"?: SecurityAuthentication
 }
 
 export type ApiKeyConfiguration = string;
@@ -78,8 +78,8 @@ export type OAuth2Configuration = { accessToken: string };
 
 export type AuthMethodsConfiguration = {
     "default"?: SecurityAuthentication,
-    "app_key"?: HttpBearerConfiguration,
-    "user_key"?: HttpBearerConfiguration
+    "rest_api_key"?: HttpBearerConfiguration,
+    "user_auth_key"?: HttpBearerConfiguration
 }
 
 /**
@@ -94,15 +94,15 @@ export function configureAuthMethods(config: AuthMethodsConfiguration | undefine
     }
     authMethods["default"] = config["default"]
 
-    if (config["app_key"]) {
-        authMethods["app_key"] = new AppKeyAuthentication(
-            config["app_key"]["tokenProvider"]
+    if (config["rest_api_key"]) {
+        authMethods["rest_api_key"] = new RestApiKeyAuthentication(
+            config["rest_api_key"]["tokenProvider"]
         );
     }
 
-    if (config["user_key"]) {
-        authMethods["user_key"] = new UserKeyAuthentication(
-            config["user_key"]["tokenProvider"]
+    if (config["user_auth_key"]) {
+        authMethods["user_auth_key"] = new UserAuthKeyAuthentication(
+            config["user_auth_key"]["tokenProvider"]
         );
     }
 

package/configuration.ts

@@ -39,8 +39,8 @@ export interface ConfigurationParameters {
     /**
      * Faster way to configure authentication methods
      */
-    appKey?: string;
-    userKey?: string;
+    restApiKey?: string;
+    userAuthKey?: string;
 }
 
 /**
@@ -58,14 +58,14 @@ export interface ConfigurationParameters {
 export function createConfiguration(conf: ConfigurationParameters): Configuration {
 
     const authMethods: AuthMethodsConfiguration = {
-        'app_key': {
+        'rest_api_key': {
             tokenProvider: {
-                getToken: () => conf.appKey || ''
+                getToken: () => conf.restApiKey || ''
             }
         },
-        'user_key': {
+        'user_auth_key': {
             tokenProvider: {
-                getToken: () => conf.userKey || ''
+                getToken: () => conf.userAuthKey || ''
             }
         },
     }

package/dist/apis/DefaultApi.d.ts

@@ -2,116 +2,89 @@ import { BaseAPIRequestFactory } from './baseapi';
 import { Configuration } from '../configuration';
 import { RequestContext, ResponseContext } from '../http/http';
 import { App } from '../models/App';
-import { BeginLiveActivityRequest } from '../models/BeginLiveActivityRequest';
-import { CancelNotificationSuccessResponse } from '../models/CancelNotificationSuccessResponse';
 import { CreateNotificationSuccessResponse } from '../models/CreateNotificationSuccessResponse';
-import { CreatePlayerSuccessResponse } from '../models/CreatePlayerSuccessResponse';
 import { CreateSegmentSuccessResponse } from '../models/CreateSegmentSuccessResponse';
-import { CreateSubscriptionRequestBody } from '../models/CreateSubscriptionRequestBody';
-import { DeletePlayerSuccessResponse } from '../models/DeletePlayerSuccessResponse';
-import { DeleteSegmentSuccessResponse } from '../models/DeleteSegmentSuccessResponse';
 import { ExportEventsSuccessResponse } from '../models/ExportEventsSuccessResponse';
-import { ExportPlayersRequestBody } from '../models/ExportPlayersRequestBody';
-import { ExportPlayersSuccessResponse } from '../models/ExportPlayersSuccessResponse';
-import { GetNotificationRequestBody } from '../models/GetNotificationRequestBody';
-import { InlineResponse200 } from '../models/InlineResponse200';
-import { InlineResponse2003 } from '../models/InlineResponse2003';
-import { InlineResponse201 } from '../models/InlineResponse201';
-import { InlineResponse202 } from '../models/InlineResponse202';
+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 { Player } from '../models/Player';
-import { PlayerSlice } from '../models/PlayerSlice';
+import { PropertiesBody } from '../models/PropertiesBody';
 import { Segment } from '../models/Segment';
+import { SubscriptionBody } from '../models/SubscriptionBody';
 import { TransferSubscriptionRequestBody } from '../models/TransferSubscriptionRequestBody';
 import { UpdateLiveActivityRequest } from '../models/UpdateLiveActivityRequest';
 import { UpdateLiveActivitySuccessResponse } from '../models/UpdateLiveActivitySuccessResponse';
-import { UpdatePlayerSuccessResponse } from '../models/UpdatePlayerSuccessResponse';
-import { UpdatePlayerTagsRequestBody } from '../models/UpdatePlayerTagsRequestBody';
-import { UpdatePlayerTagsSuccessResponse } from '../models/UpdatePlayerTagsSuccessResponse';
-import { UpdateSubscriptionRequestBody } from '../models/UpdateSubscriptionRequestBody';
 import { UpdateUserRequest } from '../models/UpdateUserRequest';
 import { User } from '../models/User';
-import { UserIdentityRequestBody } from '../models/UserIdentityRequestBody';
-import { UserIdentityResponse } from '../models/UserIdentityResponse';
+import { UserIdentityBody } from '../models/UserIdentityBody';
 export declare class DefaultApiRequestFactory extends BaseAPIRequestFactory {
-    beginLiveActivity(appId: string, activityId: string, beginLiveActivityRequest: BeginLiveActivityRequest, _options?: Configuration): Promise<RequestContext>;
     cancelNotification(appId: string, notificationId: string, _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>;
     createApp(app: App, _options?: Configuration): Promise<RequestContext>;
     createNotification(notification: Notification, _options?: Configuration): Promise<RequestContext>;
-    createPlayer(player: Player, _options?: Configuration): Promise<RequestContext>;
-    createSegments(appId: string, segment?: Segment, _options?: Configuration): Promise<RequestContext>;
-    createSubscription(appId: string, aliasLabel: string, aliasId: string, createSubscriptionRequestBody: CreateSubscriptionRequestBody, _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>;
     createUser(appId: string, user: User, _options?: Configuration): Promise<RequestContext>;
     deleteAlias(appId: string, aliasLabel: string, aliasId: string, aliasLabelToDelete: string, _options?: Configuration): Promise<RequestContext>;
-    deletePlayer(appId: string, playerId: string, _options?: Configuration): Promise<RequestContext>;
-    deleteSegments(appId: string, segmentId: string, _options?: Configuration): Promise<RequestContext>;
+    deleteSegment(appId: string, segmentId: string, _options?: Configuration): Promise<RequestContext>;
     deleteSubscription(appId: string, subscriptionId: string, _options?: Configuration): Promise<RequestContext>;
     deleteUser(appId: string, aliasLabel: string, aliasId: string, _options?: Configuration): Promise<RequestContext>;
-    endLiveActivity(appId: string, activityId: string, subscriptionId: string, _options?: Configuration): Promise<RequestContext>;
     exportEvents(notificationId: string, appId: string, _options?: Configuration): Promise<RequestContext>;
-    exportPlayers(appId: string, exportPlayersRequestBody?: ExportPlayersRequestBody, _options?: Configuration): Promise<RequestContext>;
-    fetchAliases(appId: string, subscriptionId: string, _options?: Configuration): Promise<RequestContext>;
-    fetchUser(appId: string, aliasLabel: string, aliasId: string, _options?: Configuration): Promise<RequestContext>;
-    fetchUserIdentity(appId: string, aliasLabel: string, aliasId: 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>;
-    getEligibleIams(appId: string, subscriptionId: string, _options?: Configuration): Promise<RequestContext>;
     getNotification(appId: string, notificationId: string, _options?: Configuration): Promise<RequestContext>;
-    getNotificationHistory(notificationId: string, getNotificationRequestBody: GetNotificationRequestBody, _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>;
-    getPlayer(appId: string, playerId: string, emailAuthHash?: string, _options?: Configuration): Promise<RequestContext>;
-    getPlayers(appId: string, limit?: number, offset?: number, _options?: Configuration): Promise<RequestContext>;
-    identifyUserByAlias(appId: string, aliasLabel: string, aliasId: string, userIdentityRequestBody: UserIdentityRequestBody, _options?: Configuration): Promise<RequestContext>;
-    identifyUserBySubscriptionId(appId: string, subscriptionId: string, userIdentityRequestBody: UserIdentityRequestBody, _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>;
     transferSubscription(appId: string, subscriptionId: string, transferSubscriptionRequestBody: TransferSubscriptionRequestBody, _options?: Configuration): Promise<RequestContext>;
+    unsubscribeEmailWithToken(appId: string, notificationId: string, token: string, _options?: Configuration): Promise<RequestContext>;
     updateApp(appId: string, app: App, _options?: Configuration): Promise<RequestContext>;
     updateLiveActivity(appId: string, activityId: string, updateLiveActivityRequest: UpdateLiveActivityRequest, _options?: Configuration): Promise<RequestContext>;
-    updatePlayer(playerId: string, player: Player, _options?: Configuration): Promise<RequestContext>;
-    updatePlayerTags(appId: string, externalUserId: string, updatePlayerTagsRequestBody?: UpdatePlayerTagsRequestBody, _options?: Configuration): Promise<RequestContext>;
-    updateSubscription(appId: string, subscriptionId: string, updateSubscriptionRequestBody: UpdateSubscriptionRequestBody, _options?: Configuration): Promise<RequestContext>;
+    updateSubscription(appId: string, subscriptionId: string, subscriptionBody: SubscriptionBody, _options?: Configuration): Promise<RequestContext>;
     updateUser(appId: string, aliasLabel: string, aliasId: string, updateUserRequest: UpdateUserRequest, _options?: Configuration): Promise<RequestContext>;
 }
 export declare class DefaultApiResponseProcessor {
-    beginLiveActivity(response: ResponseContext): Promise<void>;
-    cancelNotification(response: ResponseContext): Promise<CancelNotificationSuccessResponse>;
+    cancelNotification(response: ResponseContext): Promise<GenericSuccessBoolResponse>;
+    createAlias(response: ResponseContext): Promise<UserIdentityBody>;
+    createAliasBySubscription(response: ResponseContext): Promise<UserIdentityBody>;
     createApp(response: ResponseContext): Promise<App>;
     createNotification(response: ResponseContext): Promise<CreateNotificationSuccessResponse>;
-    createPlayer(response: ResponseContext): Promise<CreatePlayerSuccessResponse>;
-    createSegments(response: ResponseContext): Promise<CreateSegmentSuccessResponse>;
-    createSubscription(response: ResponseContext): Promise<InlineResponse201>;
+    createSegment(response: ResponseContext): Promise<CreateSegmentSuccessResponse>;
+    createSubscription(response: ResponseContext): Promise<SubscriptionBody>;
     createUser(response: ResponseContext): Promise<User>;
-    deleteAlias(response: ResponseContext): Promise<InlineResponse200>;
-    deletePlayer(response: ResponseContext): Promise<DeletePlayerSuccessResponse>;
-    deleteSegments(response: ResponseContext): Promise<DeleteSegmentSuccessResponse>;
+    deleteAlias(response: ResponseContext): Promise<UserIdentityBody>;
+    deleteSegment(response: ResponseContext): Promise<GenericSuccessBoolResponse>;
     deleteSubscription(response: ResponseContext): Promise<void>;
     deleteUser(response: ResponseContext): Promise<void>;
-    endLiveActivity(response: ResponseContext): Promise<void>;
     exportEvents(response: ResponseContext): Promise<ExportEventsSuccessResponse>;
-    exportPlayers(response: ResponseContext): Promise<ExportPlayersSuccessResponse>;
-    fetchAliases(response: ResponseContext): Promise<UserIdentityResponse>;
-    fetchUser(response: ResponseContext): Promise<User>;
-    fetchUserIdentity(response: ResponseContext): Promise<InlineResponse200>;
+    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>>;
-    getEligibleIams(response: ResponseContext): Promise<InlineResponse2003>;
     getNotification(response: ResponseContext): Promise<NotificationWithMeta>;
     getNotificationHistory(response: ResponseContext): Promise<NotificationHistorySuccessResponse>;
     getNotifications(response: ResponseContext): Promise<NotificationSlice>;
     getOutcomes(response: ResponseContext): Promise<OutcomesData>;
-    getPlayer(response: ResponseContext): Promise<Player>;
-    getPlayers(response: ResponseContext): Promise<PlayerSlice>;
-    identifyUserByAlias(response: ResponseContext): Promise<InlineResponse200>;
-    identifyUserBySubscriptionId(response: ResponseContext): Promise<UserIdentityResponse>;
-    transferSubscription(response: ResponseContext): Promise<UserIdentityResponse>;
+    getSegments(response: ResponseContext): Promise<GetSegmentsSuccessResponse>;
+    getUser(response: ResponseContext): Promise<User>;
+    transferSubscription(response: ResponseContext): Promise<UserIdentityBody>;
+    unsubscribeEmailWithToken(response: ResponseContext): Promise<GenericSuccessBoolResponse>;
     updateApp(response: ResponseContext): Promise<App>;
     updateLiveActivity(response: ResponseContext): Promise<UpdateLiveActivitySuccessResponse>;
-    updatePlayer(response: ResponseContext): Promise<UpdatePlayerSuccessResponse>;
-    updatePlayerTags(response: ResponseContext): Promise<UpdatePlayerTagsSuccessResponse>;
     updateSubscription(response: ResponseContext): Promise<void>;
-    updateUser(response: ResponseContext): Promise<InlineResponse202>;
+    updateUser(response: ResponseContext): Promise<PropertiesBody>;
 }