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

package/types/PromiseAPI.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';
@@ -80,6 +94,18 @@ export class PromiseDefaultApi {
         return result.toPromise();
     }
 
+    /**
+     * Copy a template to a destination app.
+     * Copy template to another app
+     * @param templateId 
+     * @param appId 
+     * @param copyTemplateRequest 
+     */
+    public copyTemplateToApp(templateId: string, appId: string, copyTemplateRequest: CopyTemplateRequest, _options?: Configuration): Promise<TemplateResource> {
+        const result = this.api.copyTemplateToApp(templateId, appId, copyTemplateRequest, _options);
+        return result.toPromise();
+    }
+
     /**
      * Upserts one or more Aliases to an existing User identified by (:alias_label, :alias_id).
      * @param appId 
@@ -103,6 +129,17 @@ export class PromiseDefaultApi {
         return result.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 appId 
+     * @param createApiKeyRequest 
+     */
+    public createApiKey(appId: string, createApiKeyRequest: CreateApiKeyRequest, _options?: Configuration): Promise<CreateApiKeyResponse> {
+        const result = this.api.createApiKey(appId, createApiKeyRequest, _options);
+        return result.toPromise();
+    }
+
     /**
      * Creates a new OneSignal app
      * Create an app
@@ -113,6 +150,17 @@ export class PromiseDefaultApi {
         return result.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 appId Your OneSignal App ID in UUID v4 format.
+     * @param customEventsRequest 
+     */
+    public createCustomEvents(appId: string, customEventsRequest: CustomEventsRequest, _options?: Configuration): Promise<object> {
+        const result = this.api.createCustomEvents(appId, customEventsRequest, _options);
+        return result.toPromise();
+    }
+
     /**
      * Sends notifications to your users 
      * Create notification
@@ -146,6 +194,16 @@ export class PromiseDefaultApi {
         return result.toPromise();
     }
 
+    /**
+     * Create reusable message templates for push, email, and SMS channels.
+     * Create template
+     * @param createTemplateRequest 
+     */
+    public createTemplate(createTemplateRequest: CreateTemplateRequest, _options?: Configuration): Promise<TemplateResource> {
+        const result = this.api.createTemplate(createTemplateRequest, _options);
+        return result.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 appId 
@@ -168,6 +226,17 @@ export class PromiseDefaultApi {
         return result.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 appId 
+     * @param tokenId 
+     */
+    public deleteApiKey(appId: string, tokenId: string, _options?: Configuration): Promise<object> {
+        const result = this.api.deleteApiKey(appId, tokenId, _options);
+        return result.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
@@ -189,6 +258,17 @@ export class PromiseDefaultApi {
         return result.toPromise();
     }
 
+    /**
+     * Delete a template by id.
+     * Delete template
+     * @param templateId 
+     * @param appId 
+     */
+    public deleteTemplate(templateId: string, appId: string, _options?: Configuration): Promise<GenericSuccessBoolResponse> {
+        const result = this.api.deleteTemplate(templateId, appId, _options);
+        return result.toPromise();
+    }
+
     /**
      * Removes the User identified by (:alias_label, :alias_id), and all Subscriptions and Aliases
      * @param appId 
@@ -335,6 +415,29 @@ export class PromiseDefaultApi {
         return result.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 appId 
+     * @param tokenId 
+     */
+    public rotateApiKey(appId: string, tokenId: string, _options?: Configuration): Promise<CreateApiKeyResponse> {
+        const result = this.api.rotateApiKey(appId, tokenId, _options);
+        return result.toPromise();
+    }
+
+    /**
+     * Remotely start a Live Activity on iOS devices via OneSignal’s REST API.
+     * Start Live Activity
+     * @param appId Your OneSignal App ID in UUID v4 format.
+     * @param activityType The name of the Live Activity defined in your app. This should match the attributes struct used in your app\&#39;s Live Activity implementation.
+     * @param startLiveActivityRequest 
+     */
+    public startLiveActivity(appId: string, activityType: string, startLiveActivityRequest: StartLiveActivityRequest, _options?: Configuration): Promise<StartLiveActivitySuccessResponse> {
+        const result = this.api.startLiveActivity(appId, activityType, startLiveActivityRequest, _options);
+        return result.toPromise();
+    }
+
     /**
      * Transfers this Subscription to the User identified by the identity in the payload.
      * @param appId 
@@ -358,6 +461,18 @@ export class PromiseDefaultApi {
         return result.toPromise();
     }
 
+    /**
+     * Update a Rich Authentication Token (App API Key) for a OneSignal app.
+     * Update API key
+     * @param appId 
+     * @param tokenId 
+     * @param updateApiKeyRequest 
+     */
+    public updateApiKey(appId: string, tokenId: string, updateApiKeyRequest: UpdateApiKeyRequest, _options?: Configuration): Promise<object> {
+        const result = this.api.updateApiKey(appId, tokenId, updateApiKeyRequest, _options);
+        return result.toPromise();
+    }
+
     /**
      * Updates the name or configuration settings of an existing OneSignal app
      * Update an app
@@ -392,6 +507,31 @@ export class PromiseDefaultApi {
         return result.toPromise();
     }
 
+    /**
+     * Update properties on an existing OneSignal subscription using its token.
+     * Update subscription by token
+     * @param appId Your OneSignal App ID in UUID v4 format.
+     * @param tokenType The type of token to use when looking up the subscription. See Subscription Types.
+     * @param token The value of the token to lookup by (e.g., email address, phone number).
+     * @param subscriptionBody 
+     */
+    public updateSubscriptionByToken(appId: string, tokenType: string, token: string, subscriptionBody: SubscriptionBody, _options?: Configuration): Promise<object> {
+        const result = this.api.updateSubscriptionByToken(appId, tokenType, token, subscriptionBody, _options);
+        return result.toPromise();
+    }
+
+    /**
+     * Update an existing template.
+     * Update template
+     * @param templateId 
+     * @param appId 
+     * @param updateTemplateRequest 
+     */
+    public updateTemplate(templateId: string, appId: string, updateTemplateRequest: UpdateTemplateRequest, _options?: Configuration): Promise<TemplateResource> {
+        const result = this.api.updateTemplate(templateId, appId, updateTemplateRequest, _options);
+        return result.toPromise();
+    }
+
     /**
      * Updates an existing User’s properties.
      * @param appId 
@@ -404,6 +544,40 @@ export class PromiseDefaultApi {
         return result.toPromise();
     }
 
+    /**
+     * View the details of all of your current app API keys (Rich Authentication Token) for a single OneSignal app.
+     * View API keys
+     * @param appId 
+     */
+    public viewApiKeys(appId: string, _options?: Configuration): Promise<ApiKeyTokensListResponse> {
+        const result = this.api.viewApiKeys(appId, _options);
+        return result.toPromise();
+    }
+
+    /**
+     * Fetch a single template by id.
+     * View template
+     * @param templateId 
+     * @param appId 
+     */
+    public viewTemplate(templateId: string, appId: string, _options?: Configuration): Promise<TemplateResource> {
+        const result = this.api.viewTemplate(templateId, appId, _options);
+        return result.toPromise();
+    }
+
+    /**
+     * List templates for an app.
+     * View templates
+     * @param appId Your OneSignal App ID in UUID v4 format.
+     * @param limit Maximum number of templates. Default and max is 50.
+     * @param offset Pagination offset.
+     * @param channel Filter by delivery channel.
+     */
+    public viewTemplates(appId: string, limit?: number, offset?: number, channel?: 'push' | 'email' | 'sms', _options?: Configuration): Promise<TemplatesListResponse> {
+        const result = this.api.viewTemplates(appId, limit, offset, channel, _options);
+        return result.toPromise();
+    }
+
 
 }