@onesignal/node-onesignal 5.2.1-beta1 → 5.3.0-beta1

package/types/ObjectParamAPI.ts

@@ -2,17 +2,25 @@ import { ResponseContext, RequestContext, HttpFile } from '../http/http';
 import * as models from '../models/all';
 import { Configuration} from '../configuration'
 
+import { ApiKeyToken } from '../models/ApiKeyToken';
+import { ApiKeyTokensListResponse } from '../models/ApiKeyTokensListResponse';
 import { App } from '../models/App';
 import { BasicNotification } from '../models/BasicNotification';
 import { BasicNotificationAllOf } from '../models/BasicNotificationAllOf';
 import { BasicNotificationAllOfAndroidBackgroundLayout } from '../models/BasicNotificationAllOfAndroidBackgroundLayout';
 import { Button } from '../models/Button';
+import { CopyTemplateRequest } from '../models/CopyTemplateRequest';
+import { CreateApiKeyRequest } from '../models/CreateApiKeyRequest';
+import { CreateApiKeyResponse } from '../models/CreateApiKeyResponse';
 import { CreateNotificationSuccessResponse } from '../models/CreateNotificationSuccessResponse';
 import { CreateSegmentConflictResponse } from '../models/CreateSegmentConflictResponse';
 import { CreateSegmentSuccessResponse } from '../models/CreateSegmentSuccessResponse';
+import { CreateTemplateRequest } from '../models/CreateTemplateRequest';
 import { CreateUserConflictResponse } from '../models/CreateUserConflictResponse';
 import { CreateUserConflictResponseErrorsInner } from '../models/CreateUserConflictResponseErrorsInner';
 import { CreateUserConflictResponseErrorsItemsMeta } from '../models/CreateUserConflictResponseErrorsItemsMeta';
+import { CustomEvent } from '../models/CustomEvent';
+import { CustomEventsRequest } from '../models/CustomEventsRequest';
 import { DeliveryData } from '../models/DeliveryData';
 import { ExportEventsSuccessResponse } from '../models/ExportEventsSuccessResponse';
 import { ExportSubscriptionsRequestBody } from '../models/ExportSubscriptionsRequestBody';
@@ -45,12 +53,18 @@ import { RateLimitError } from '../models/RateLimitError';
 import { Segment } from '../models/Segment';
 import { SegmentData } from '../models/SegmentData';
 import { SegmentNotificationTarget } from '../models/SegmentNotificationTarget';
+import { StartLiveActivityRequest } from '../models/StartLiveActivityRequest';
+import { StartLiveActivitySuccessResponse } from '../models/StartLiveActivitySuccessResponse';
 import { Subscription } from '../models/Subscription';
 import { SubscriptionBody } from '../models/SubscriptionBody';
 import { SubscriptionNotificationTarget } from '../models/SubscriptionNotificationTarget';
+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';
@@ -74,6 +88,27 @@ export interface DefaultApiCancelNotificationRequest {
     notificationId: string
 }
 
+export interface DefaultApiCopyTemplateToAppRequest {
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApicopyTemplateToApp
+     */
+    templateId: string
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApicopyTemplateToApp
+     */
+    appId: string
+    /**
+     * 
+     * @type CopyTemplateRequest
+     * @memberof DefaultApicopyTemplateToApp
+     */
+    copyTemplateRequest: CopyTemplateRequest
+}
+
 export interface DefaultApiCreateAliasRequest {
     /**
      * 
@@ -122,6 +157,21 @@ export interface DefaultApiCreateAliasBySubscriptionRequest {
     userIdentityBody: UserIdentityBody
 }
 
+export interface DefaultApiCreateApiKeyRequest {
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApicreateApiKey
+     */
+    appId: string
+    /**
+     * 
+     * @type CreateApiKeyRequest
+     * @memberof DefaultApicreateApiKey
+     */
+    createApiKeyRequest: CreateApiKeyRequest
+}
+
 export interface DefaultApiCreateAppRequest {
     /**
      * 
@@ -131,6 +181,21 @@ export interface DefaultApiCreateAppRequest {
     app: App
 }
 
+export interface DefaultApiCreateCustomEventsRequest {
+    /**
+     * Your OneSignal App ID in UUID v4 format.
+     * @type string
+     * @memberof DefaultApicreateCustomEvents
+     */
+    appId: string
+    /**
+     * 
+     * @type CustomEventsRequest
+     * @memberof DefaultApicreateCustomEvents
+     */
+    customEventsRequest: CustomEventsRequest
+}
+
 export interface DefaultApiCreateNotificationRequest {
     /**
      * 
@@ -182,6 +247,15 @@ export interface DefaultApiCreateSubscriptionRequest {
     subscriptionBody: SubscriptionBody
 }
 
+export interface DefaultApiCreateTemplateRequest {
+    /**
+     * 
+     * @type CreateTemplateRequest
+     * @memberof DefaultApicreateTemplate
+     */
+    createTemplateRequest: CreateTemplateRequest
+}
+
 export interface DefaultApiCreateUserRequest {
     /**
      * 
@@ -224,6 +298,21 @@ export interface DefaultApiDeleteAliasRequest {
     aliasLabelToDelete: string
 }
 
+export interface DefaultApiDeleteApiKeyRequest {
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApideleteApiKey
+     */
+    appId: string
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApideleteApiKey
+     */
+    tokenId: string
+}
+
 export interface DefaultApiDeleteSegmentRequest {
     /**
      * The OneSignal App ID for your app.  Available in Keys & IDs.
@@ -254,6 +343,21 @@ export interface DefaultApiDeleteSubscriptionRequest {
     subscriptionId: string
 }
 
+export interface DefaultApiDeleteTemplateRequest {
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApideleteTemplate
+     */
+    templateId: string
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApideleteTemplate
+     */
+    appId: string
+}
+
 export interface DefaultApiDeleteUserRequest {
     /**
      * 
@@ -491,6 +595,42 @@ export interface DefaultApiGetUserRequest {
     aliasId: string
 }
 
+export interface DefaultApiRotateApiKeyRequest {
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApirotateApiKey
+     */
+    appId: string
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApirotateApiKey
+     */
+    tokenId: string
+}
+
+export interface DefaultApiStartLiveActivityRequest {
+    /**
+     * Your OneSignal App ID in UUID v4 format.
+     * @type string
+     * @memberof DefaultApistartLiveActivity
+     */
+    appId: string
+    /**
+     * The name of the Live Activity defined in your app. This should match the attributes struct used in your app\'s Live Activity implementation.
+     * @type string
+     * @memberof DefaultApistartLiveActivity
+     */
+    activityType: string
+    /**
+     * 
+     * @type StartLiveActivityRequest
+     * @memberof DefaultApistartLiveActivity
+     */
+    startLiveActivityRequest: StartLiveActivityRequest
+}
+
 export interface DefaultApiTransferSubscriptionRequest {
     /**
      * 
@@ -533,6 +673,27 @@ export interface DefaultApiUnsubscribeEmailWithTokenRequest {
     token: string
 }
 
+export interface DefaultApiUpdateApiKeyRequest {
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApiupdateApiKey
+     */
+    appId: string
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApiupdateApiKey
+     */
+    tokenId: string
+    /**
+     * 
+     * @type UpdateApiKeyRequest
+     * @memberof DefaultApiupdateApiKey
+     */
+    updateApiKeyRequest: UpdateApiKeyRequest
+}
+
 export interface DefaultApiUpdateAppRequest {
     /**
      * An app id
@@ -590,6 +751,54 @@ export interface DefaultApiUpdateSubscriptionRequest {
     subscriptionBody: SubscriptionBody
 }
 
+export interface DefaultApiUpdateSubscriptionByTokenRequest {
+    /**
+     * Your OneSignal App ID in UUID v4 format.
+     * @type string
+     * @memberof DefaultApiupdateSubscriptionByToken
+     */
+    appId: string
+    /**
+     * The type of token to use when looking up the subscription. See Subscription Types.
+     * @type string
+     * @memberof DefaultApiupdateSubscriptionByToken
+     */
+    tokenType: string
+    /**
+     * The value of the token to lookup by (e.g., email address, phone number).
+     * @type string
+     * @memberof DefaultApiupdateSubscriptionByToken
+     */
+    token: string
+    /**
+     * 
+     * @type SubscriptionBody
+     * @memberof DefaultApiupdateSubscriptionByToken
+     */
+    subscriptionBody: SubscriptionBody
+}
+
+export interface DefaultApiUpdateTemplateRequest {
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApiupdateTemplate
+     */
+    templateId: string
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApiupdateTemplate
+     */
+    appId: string
+    /**
+     * 
+     * @type UpdateTemplateRequest
+     * @memberof DefaultApiupdateTemplate
+     */
+    updateTemplateRequest: UpdateTemplateRequest
+}
+
 export interface DefaultApiUpdateUserRequest {
     /**
      * 
@@ -617,6 +826,57 @@ export interface DefaultApiUpdateUserRequest {
     updateUserRequest: UpdateUserRequest
 }
 
+export interface DefaultApiViewApiKeysRequest {
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApiviewApiKeys
+     */
+    appId: string
+}
+
+export interface DefaultApiViewTemplateRequest {
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApiviewTemplate
+     */
+    templateId: string
+    /**
+     * 
+     * @type string
+     * @memberof DefaultApiviewTemplate
+     */
+    appId: string
+}
+
+export interface DefaultApiViewTemplatesRequest {
+    /**
+     * Your OneSignal App ID in UUID v4 format.
+     * @type string
+     * @memberof DefaultApiviewTemplates
+     */
+    appId: string
+    /**
+     * Maximum number of templates. Default and max is 50.
+     * @type number
+     * @memberof DefaultApiviewTemplates
+     */
+    limit?: number
+    /**
+     * Pagination offset.
+     * @type number
+     * @memberof DefaultApiviewTemplates
+     */
+    offset?: number
+    /**
+     * Filter by delivery channel.
+     * @type 'push' | 'email' | 'sms'
+     * @memberof DefaultApiviewTemplates
+     */
+    channel?: 'push' | 'email' | 'sms'
+}
+
 export class ObjectDefaultApi {
     private api: ObservableDefaultApi
 
@@ -633,6 +893,15 @@ export class ObjectDefaultApi {
         return this.api.cancelNotification(param.appId, param.notificationId,  options).toPromise();
     }
 
+    /**
+     * Copy a template to a destination app.
+     * Copy template to another app
+     * @param param the request object
+     */
+    public copyTemplateToApp(param: DefaultApiCopyTemplateToAppRequest, options?: Configuration): Promise<TemplateResource> {
+        return this.api.copyTemplateToApp(param.templateId, param.appId, param.copyTemplateRequest,  options).toPromise();
+    }
+
     /**
      * Upserts one or more Aliases to an existing User identified by (:alias_label, :alias_id).
      * @param param the request object
@@ -649,6 +918,15 @@ export class ObjectDefaultApi {
         return this.api.createAliasBySubscription(param.appId, param.subscriptionId, param.userIdentityBody,  options).toPromise();
     }
 
+    /**
+     * Use this API to create a new App API Key (also called a Rich Authentication Token) for a specific OneSignal app. These keys are used to authenticate API requests at the app level and offer enhanced security features, including optional IP allowlisting.
+     * Create API key
+     * @param param the request object
+     */
+    public createApiKey(param: DefaultApiCreateApiKeyRequest, options?: Configuration): Promise<CreateApiKeyResponse> {
+        return this.api.createApiKey(param.appId, param.createApiKeyRequest,  options).toPromise();
+    }
+
     /**
      * Creates a new OneSignal app
      * Create an app
@@ -658,6 +936,15 @@ export class ObjectDefaultApi {
         return this.api.createApp(param.app,  options).toPromise();
     }
 
+    /**
+     * The Custom Events API allows you to record user events. Custom events can represent any action users take in your application, such as completing a purchase, viewing content, or achieving milestones.
+     * Create custom events
+     * @param param the request object
+     */
+    public createCustomEvents(param: DefaultApiCreateCustomEventsRequest, options?: Configuration): Promise<object> {
+        return this.api.createCustomEvents(param.appId, param.customEventsRequest,  options).toPromise();
+    }
+
     /**
      * Sends notifications to your users 
      * Create notification
@@ -684,6 +971,15 @@ export class ObjectDefaultApi {
         return this.api.createSubscription(param.appId, param.aliasLabel, param.aliasId, param.subscriptionBody,  options).toPromise();
     }
 
+    /**
+     * Create reusable message templates for push, email, and SMS channels.
+     * Create template
+     * @param param the request object
+     */
+    public createTemplate(param: DefaultApiCreateTemplateRequest, options?: Configuration): Promise<TemplateResource> {
+        return this.api.createTemplate(param.createTemplateRequest,  options).toPromise();
+    }
+
     /**
      * Creates a User, optionally Subscriptions owned by the User as well as Aliases. Aliases provided in the payload will be used to look up an existing User.
      * @param param the request object
@@ -700,6 +996,15 @@ export class ObjectDefaultApi {
         return this.api.deleteAlias(param.appId, param.aliasLabel, param.aliasId, param.aliasLabelToDelete,  options).toPromise();
     }
 
+    /**
+     * Delete a specific Rich Authentication Token (App API Key) for a OneSignal app. Requires your Organization API Key and the token’s unique ID, not the token value itself.
+     * Delete API key
+     * @param param the request object
+     */
+    public deleteApiKey(param: DefaultApiDeleteApiKeyRequest, options?: Configuration): Promise<object> {
+        return this.api.deleteApiKey(param.appId, param.tokenId,  options).toPromise();
+    }
+
     /**
      * Delete a segment (not user devices) - Required: OneSignal Paid Plan You can delete a segment under your app by calling this API. You must provide an API key in the Authorization header that has admin access on the app. The segment_id can be found in the URL of the segment when viewing it in the dashboard. 
      * Delete Segment
@@ -717,6 +1022,15 @@ export class ObjectDefaultApi {
         return this.api.deleteSubscription(param.appId, param.subscriptionId,  options).toPromise();
     }
 
+    /**
+     * Delete a template by id.
+     * Delete template
+     * @param param the request object
+     */
+    public deleteTemplate(param: DefaultApiDeleteTemplateRequest, options?: Configuration): Promise<GenericSuccessBoolResponse> {
+        return this.api.deleteTemplate(param.templateId, param.appId,  options).toPromise();
+    }
+
     /**
      * Removes the User identified by (:alias_label, :alias_id), and all Subscriptions and Aliases
      * @param param the request object
@@ -830,6 +1144,24 @@ export class ObjectDefaultApi {
         return this.api.getUser(param.appId, param.aliasLabel, param.aliasId,  options).toPromise();
     }
 
+    /**
+     * Rotate a Rich Authentication Token (App API Key) for a OneSignal app. Rotating a key revokes the current token and generates a new one under the same configuration—ideal when a token is lost or compromised but you don’t want to recreate and reconfigure it from scratch.
+     * Rotate API key
+     * @param param the request object
+     */
+    public rotateApiKey(param: DefaultApiRotateApiKeyRequest, options?: Configuration): Promise<CreateApiKeyResponse> {
+        return this.api.rotateApiKey(param.appId, param.tokenId,  options).toPromise();
+    }
+
+    /**
+     * Remotely start a Live Activity on iOS devices via OneSignal’s REST API.
+     * Start Live Activity
+     * @param param the request object
+     */
+    public startLiveActivity(param: DefaultApiStartLiveActivityRequest, options?: Configuration): Promise<StartLiveActivitySuccessResponse> {
+        return this.api.startLiveActivity(param.appId, param.activityType, param.startLiveActivityRequest,  options).toPromise();
+    }
+
     /**
      * Transfers this Subscription to the User identified by the identity in the payload.
      * @param param the request object
@@ -847,6 +1179,15 @@ export class ObjectDefaultApi {
         return this.api.unsubscribeEmailWithToken(param.appId, param.notificationId, param.token,  options).toPromise();
     }
 
+    /**
+     * Update a Rich Authentication Token (App API Key) for a OneSignal app.
+     * Update API key
+     * @param param the request object
+     */
+    public updateApiKey(param: DefaultApiUpdateApiKeyRequest, options?: Configuration): Promise<object> {
+        return this.api.updateApiKey(param.appId, param.tokenId, param.updateApiKeyRequest,  options).toPromise();
+    }
+
     /**
      * Updates the name or configuration settings of an existing OneSignal app
      * Update an app
@@ -873,6 +1214,24 @@ export class ObjectDefaultApi {
         return this.api.updateSubscription(param.appId, param.subscriptionId, param.subscriptionBody,  options).toPromise();
     }
 
+    /**
+     * Update properties on an existing OneSignal subscription using its token.
+     * Update subscription by token
+     * @param param the request object
+     */
+    public updateSubscriptionByToken(param: DefaultApiUpdateSubscriptionByTokenRequest, options?: Configuration): Promise<object> {
+        return this.api.updateSubscriptionByToken(param.appId, param.tokenType, param.token, param.subscriptionBody,  options).toPromise();
+    }
+
+    /**
+     * Update an existing template.
+     * Update template
+     * @param param the request object
+     */
+    public updateTemplate(param: DefaultApiUpdateTemplateRequest, options?: Configuration): Promise<TemplateResource> {
+        return this.api.updateTemplate(param.templateId, param.appId, param.updateTemplateRequest,  options).toPromise();
+    }
+
     /**
      * Updates an existing User’s properties.
      * @param param the request object
@@ -881,4 +1240,31 @@ export class ObjectDefaultApi {
         return this.api.updateUser(param.appId, param.aliasLabel, param.aliasId, param.updateUserRequest,  options).toPromise();
     }
 
+    /**
+     * View the details of all of your current app API keys (Rich Authentication Token) for a single OneSignal app.
+     * View API keys
+     * @param param the request object
+     */
+    public viewApiKeys(param: DefaultApiViewApiKeysRequest, options?: Configuration): Promise<ApiKeyTokensListResponse> {
+        return this.api.viewApiKeys(param.appId,  options).toPromise();
+    }
+
+    /**
+     * Fetch a single template by id.
+     * View template
+     * @param param the request object
+     */
+    public viewTemplate(param: DefaultApiViewTemplateRequest, options?: Configuration): Promise<TemplateResource> {
+        return this.api.viewTemplate(param.templateId, param.appId,  options).toPromise();
+    }
+
+    /**
+     * List templates for an app.
+     * View templates
+     * @param param the request object
+     */
+    public viewTemplates(param: DefaultApiViewTemplatesRequest, options?: Configuration): Promise<TemplatesListResponse> {
+        return this.api.viewTemplates(param.appId, param.limit, param.offset, param.channel,  options).toPromise();
+    }
+
 }