From 3a2f9457a61e0e230a7ec93b7cd999b74d485164 Mon Sep 17 00:00:00 2001 From: OneSignal Date: Thu, 9 Apr 2026 21:33:14 +0000 Subject: [PATCH] docs: update README and DefaultApi.md snippets --- README.md | 557 ++---------------- docs/Api/DefaultApi.md | 308 +++++----- docs/Model/ApiKeyToken.md | 2 +- docs/Model/ApiKeyTokensListResponse.md | 2 +- docs/Model/App.md | 2 +- docs/Model/BasicNotification.md | 2 +- docs/Model/BasicNotificationAllOf.md | 2 +- ...otificationAllOfAndroidBackgroundLayout.md | 2 +- docs/Model/Button.md | 2 +- docs/Model/CopyTemplateRequest.md | 2 +- docs/Model/CreateApiKeyRequest.md | 2 +- docs/Model/CreateApiKeyResponse.md | 2 +- .../CreateNotificationSuccessResponse.md | 2 +- docs/Model/CreateSegmentConflictResponse.md | 2 +- docs/Model/CreateSegmentSuccessResponse.md | 2 +- docs/Model/CreateTemplateRequest.md | 2 +- docs/Model/CreateUserConflictResponse.md | 2 +- .../CreateUserConflictResponseErrorsInner.md | 2 +- ...eateUserConflictResponseErrorsItemsMeta.md | 2 +- docs/Model/CustomEvent.md | 2 +- docs/Model/CustomEventsRequest.md | 2 +- docs/Model/DeliveryData.md | 2 +- docs/Model/ExportEventsSuccessResponse.md | 2 +- docs/Model/ExportSubscriptionsRequestBody.md | 2 +- .../ExportSubscriptionsSuccessResponse.md | 2 +- docs/Model/Filter.md | 2 +- docs/Model/FilterExpression.md | 2 +- docs/Model/GenericError.md | 2 +- docs/Model/GenericSuccessBoolResponse.md | 2 +- .../GetNotificationHistoryRequestBody.md | 2 +- docs/Model/GetSegmentsSuccessResponse.md | 2 +- docs/Model/LanguageStringMap.md | 2 +- docs/Model/Notification.md | 2 +- docs/Model/NotificationAllOf.md | 2 +- .../NotificationHistorySuccessResponse.md | 2 +- docs/Model/NotificationSlice.md | 2 +- docs/Model/NotificationTarget.md | 2 +- docs/Model/NotificationWithMeta.md | 2 +- docs/Model/NotificationWithMetaAllOf.md | 2 +- docs/Model/Operator.md | 2 +- docs/Model/OutcomeData.md | 2 +- docs/Model/OutcomesData.md | 2 +- docs/Model/PlatformDeliveryData.md | 2 +- docs/Model/PlatformDeliveryDataEmailAllOf.md | 2 +- docs/Model/PlatformDeliveryDataSmsAllOf.md | 2 +- docs/Model/PropertiesBody.md | 2 +- docs/Model/PropertiesDeltas.md | 2 +- docs/Model/PropertiesObject.md | 2 +- docs/Model/Purchase.md | 2 +- docs/Model/RateLimitError.md | 2 +- docs/Model/Segment.md | 2 +- docs/Model/SegmentData.md | 2 +- docs/Model/SegmentNotificationTarget.md | 2 +- docs/Model/StartLiveActivityRequest.md | 2 +- .../Model/StartLiveActivitySuccessResponse.md | 2 +- docs/Model/Subscription.md | 2 +- docs/Model/SubscriptionBody.md | 2 +- docs/Model/SubscriptionNotificationTarget.md | 2 +- docs/Model/TemplateResource.md | 2 +- docs/Model/TemplatesListResponse.md | 2 +- docs/Model/TransferSubscriptionRequestBody.md | 2 +- docs/Model/UpdateApiKeyRequest.md | 2 +- docs/Model/UpdateLiveActivityRequest.md | 2 +- .../UpdateLiveActivitySuccessResponse.md | 2 +- docs/Model/UpdateTemplateRequest.md | 2 +- docs/Model/UpdateUserRequest.md | 2 +- docs/Model/User.md | 2 +- docs/Model/UserIdentityBody.md | 2 +- docs/Model/WebButton.md | 2 +- 69 files changed, 252 insertions(+), 747 deletions(-) diff --git a/README.md b/README.md index e03f4cb..204bea0 100644 --- a/README.md +++ b/README.md @@ -4,555 +4,104 @@ A powerful way to send personalized messages at scale and build effective custom For more information, please visit [https://onesignal.com](https://onesignal.com). -## Installation & Usage +- API version: 5.3.0 +- Package version: 5.3.0 -### Requirements +## Requirements PHP 7.3 and later. -### Composer +## Installation -To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`: +Add the following to `composer.json`: ```json { - "repositories": [ - { - "type": "vcs", - "url": "https://github.com/OneSignal/onesignal-php-api.git" - } - ], "require": { - "onesignal/onesignal-php-api": "*@dev" + "onesignal/onesignal-php-api": "^5.3" } } ``` -Then run `composer update` +Then run `composer update`. +## Configuration + +Every SDK requires authentication via API keys. Two key types are available: + +- **REST API Key** — required for most endpoints (sending notifications, managing users, etc.). Found in your app's **Settings > Keys & IDs**. +- **Organization API Key** — only required for organization-level endpoints like creating or listing apps. Found in **Organization Settings**. + +> **Warning:** Store your API keys in environment variables or a secrets manager. Never commit them to source control. -## Usage examples -### Imports ```php -use DateTime; use onesignal\client\api\DefaultApi; use onesignal\client\Configuration; -use onesignal\client\model\GetNotificationRequestBody; -use onesignal\client\model\Notification; -use onesignal\client\model\StringMap; -use onesignal\client\model\Player; -use onesignal\client\model\UpdatePlayerTagsRequestBody; -use onesignal\client\model\ExportPlayersRequestBody; -use onesignal\client\model\Segment; -use onesignal\client\model\FilterExpressions; -use PHPUnit\Framework\TestCase; use GuzzleHttp; -``` - -### Constants -```php -const APP_ID = ''; -const REST_API_KEY_TOKEN = ''; // App REST API key required for most endpoints -const ORGANIZATION_API_KEY_TOKEN = ''; // Organization key is only required for creating new apps and other top-level endpoints -``` -### Configure authorization -```php $config = Configuration::getDefaultConfiguration() - ->setRestApiKeyToken(REST_API_KEY_TOKEN) - ->setOrganizationApiKeyToken(ORGANIZATION_API_KEY_TOKEN); + ->setRestApiKeyToken('YOUR_REST_API_KEY') + ->setOrganizationApiKeyToken('YOUR_ORGANIZATION_API_KEY'); -$apiInstance = new DefaultApi( +$client = new DefaultApi( new GuzzleHttp\Client(), $config ); ``` -## Notifications -### Creating a notification model -```php -function createNotification($enContent): Notification { - $content = new StringMap(); - $content->setEn($enContent); - - $notification = new Notification(); - $notification->setAppId(APP_ID); - $notification->setContents($content); - $notification->setIncludedSegments(['Subscribed Users']); - - return $notification; -} -``` - -### Sending a notification immediately -```php -$notification = createNotification('PHP Test notification'); - -$result = $apiInstance->createNotification($notification); -print_r($result); -``` - -### Scheduling a notification to be sent in 24 hours -```php -$notification = self::createNotification('PHP Test scheduled notification'); -$dt = new DateTime(); -$dt->modify('+1 day'); -$notification->setSendAfter($dt); - -$scheduledNotification = $apiInstance->createNotification($notification); -print_r($scheduledNotification); -``` - -### Sending a notification using Filters -Send this notification only to the users that have not spent any USD on IAP. -```php -$notification = createNotification('PHP Test filtered notification'); -$filter1 = new Filter(); -$filter1->setField('amount_spent'); -$filter1->setRelation('='); -$filter1->setValue('0'); -$notification->setFilters([$filter1]); -$result = $apiInstance->createNotification($notification); -print_r($result); -``` - -### Sending a notification immediately -```php -$notification = createNotification('PHP Test notification'); - -$result = $apiInstance->createNotification($notification); -print_r($result); -``` - -### Retrieving a notification -```php -$scheduledNotification = $apiInstance->getNotification(APP_ID, $scheduledNotification->getId()); -print_r($scheduledNotification); -``` - -### Listing notifications by application ID -```php -$getResult = $apiInstance->getNotifications(APP_ID); -print_r($getResult->getNotifications()); -``` - -### Getting notification history -```php -$requestBody = new GetNotificationRequestBody(); -$requestBody - ->setAppId(APP_ID) - ->setEvents('sent'); - -$getResult = $apiInstance->getNotificationHistory($scheduledNotification->getId(), $requestBody); -print_r($getResult->getSuccess()); -``` - -## Players -### Creating a new Player model -```php -function createPlayerModel($playerId): Player { - $player = new Player(); - - $player->setAppId(APP_ID); - $player->setIdentifier($playerId); - $player->setDeviceType(1); - - return $player; -} -``` - -### Creating a Player -```php -$player = createPlayerModel('php_test_player_id'); -$createPlayerResult = $apiInstance->createPlayer($player); -print_r($createPlayerResult); -``` - -### Getting a Player -```php -$getPlayerResult = $apiInstance->getPlayer(APP_ID, 'php_test_player_id'); -print_r($getPlayerResult); -``` - -### Getting a list of Players -```php -$limit = 10; -$getPlayersResult = $apiInstance->getPlayers(APP_ID, $limit); -print_r($getPlayersResult->getPlayers()); -``` - -### Deleting a player -```php -$deletePlayerResult = $apiInstance->deletePlayer(APP_ID, 'php_test_player_id'); -print_r($deletePlayerResult->getSuccess()); -``` - -### Exporting players into CSV-spreadsheet -```php -$exportPlayersRequestBody = new ExportPlayersRequestBody(); -$exportPlayersRequestBody->setExtraFields([]); -$exportPlayersRequestBody->setSegmentName(''); - -$exportPlayersResult = $apiInstance->exportPlayers(APP_ID, $exportPlayersRequestBody); -print_r($exportPlayersResult->getCsvFileUrl()); -``` - -## Segments -### Creating a segment -```php -// Settings up the filter. Filters determine a segment. -$filterExpressions = new FilterExpressions(); -$filterExpressions->setField('session_count'); -$filterExpressions->setRelation('>'); -$filterExpressions->setValue('1'); -``` +## Send a push notification -### Setting up the segment itself ```php -$segment = new Segment(); -$segment->setName('test_segment_name'); -$segment->setFilters([$filterExpressions]); - -$createSegmentResponse = $apiInstance->createSegments(APP_ID, $segment); -print_r($createSegmentResponse); -``` - -### Deleting a segment -```php -$deleteSegmentResponse = $apiInstance->deleteSegments(APP_ID, $createSegmentResponse->getId()); -print_r($deleteSegmentResponse->getSuccess()); -``` - -## Working with Apps -### Getting an app -```php -$getAppResponse = $apiInstance->getApp(APP_ID); -print_r($getAppResponse); -``` - -### Getting a list of apps -```php -$getAppsResponse = $apiInstance->getApps(); -print_r($getAppsResponse); -``` - -### Updating an app -```php -$getAppResponse = $apiInstance->getApp(APP_ID); -$getAppResponse->setName('php_test_app_name'); -$updateAppResponse = $apiInstance->updateApp(APP_ID, $getAppResponse); -print_r($updateAppResponse); -``` - -### Outcomes -```php -$outcomeNames = "os__session_duration.count,os__click.count"; -$outcomeTimeRange = "1d"; -$outcomePlatforms = "5"; -$outcomeAttribution = "direct"; -$outcomesResponse = $apiInstance->getOutcomes(APP_ID, $outcomeNames, null, $outcomeTimeRange, $outcomePlatforms, $outcomeAttribution); -print_r($outcomesResponse->getOutcomes()); -``` - -## Live Activities -### Begin Live Activity -```php -$activityId = "activity_id_example"; -$beginLiveActivityRequest = new BeginLiveActivityRequest(array( - 'push_token' => "push_token_example", - 'subscription_id' => "player_id_example" -)); - -self::$apiInstance->beginLiveActivity(APP_ID, $activityId, $beginLiveActivityRequest); -``` - -### Update Live Activity -```php -$activityId = "activity_id_example"; -$updateLiveActivityRequest = new UpdateLiveActivityRequest(array( - 'event' => 'update', - 'name' => 'contents', - 'event_updates' => array('data' => 'test') -)); - -self::$apiInstance->updateLiveActivity(APP_ID, $activityId, $updateLiveActivityRequest); -``` - -### End Live Activity -```php -$activityId = "activity_id_example"; -$subscriptionId = "player_id_example"; -self::$apiInstance->endLiveActivity(APP_ID, $activityId, $subscriptionId); -``` - -## Users -### Creating a user -```php -// Create user model -$user = new User(); -$aliasLabel = ''; -$aliasId = ''; -$pushToken = ''; - -$subscriptionObject = new SubscriptionObject(); -$subscriptionObject->setType('iOSPush'); -$subscriptionObject->setToken($pushToken); - -$user->setIdentity(array($aliasLabel => $aliasId)); -$user->setSubscriptions([$subscriptionObject]); - -// Send model to API -$createUserResponse = self::$apiInstance->createUser(APP_ID, $user); -``` - -### Fetch user by an alias -```php -$fetchUserResponse = self::$apiInstance->fetchUser(APP_ID, $aliasLabel, $aliasId); -``` - -### Update user -```php -$updateUserRequest = new UpdateUserRequest(array( - 'properties' => array( - 'language' => 'fr' - )) -); - -$updateUserResponse = self::$apiInstance->updateUser(APP_ID, $aliasLabel, $aliasId, $updateUserRequest); -``` +use onesignal\client\model\Notification; +use onesignal\client\model\StringMap; -### Delete user -```php -self::$apiInstance->deleteUser(APP_ID, $aliasLabel, $aliasId); -``` +$content = new StringMap(); +$content->setEn('Hello from OneSignal!'); -### Create subscription -```php -$createSubscriptionRequestBody = new CreateSubscriptionRequestBody(); -$subscriptionObject = new SubscriptionObject(); -$subscriptionObject->setType('AndroidPush'); -$subscriptionObject->setToken('DEVICE_PUSH_TOKEN'); -$createSubscriptionRequestBody->setSubscription($subscriptionObject); - -$createSubscriptionResponse = - self::$apiInstance->createSubscription(APP_ID, $aliasLabel, $aliasId, $createSubscriptionRequestBody); -``` +$headings = new StringMap(); +$headings->setEn('Push Notification'); -### Update subscription -```php -$updateSubscriptionRequestBody = new UpdateSubscriptionRequestBody(); -$subscriptionObject = new SubscriptionObject(); -$subscriptionObject->setType('AndroidPush'); -$subscriptionObject->setToken('DEVICE_PUSH_TOKEN' -$updateSubscriptionRequestBody->setSubscription($subscriptionObject); +$notification = new Notification(); +$notification->setAppId('YOUR_APP_ID'); +$notification->setContents($content); +$notification->setHeadings($headings); +$notification->setIncludedSegments(['Subscribed Users']); -self::$apiInstance->updateSubscription(APP_ID, $subscriptionId, $updateSubscriptionRequestBody); +$response = $client->createNotification($notification); +echo 'Notification ID: ' . $response->getId(); ``` -### Delete subscription -```php -self::$apiInstance->deleteSubscription(APP_ID, ''); -``` -### Delete Alias -```php -self::$apiInstance->deleteAlias(APP_ID, '', '', ''); -``` +## Send an email -### Fetch aliases by subscription id ```php -$fetchAliasesResponse = self::$apiInstance->fetchAliases(APP_ID, ''); -``` +$notification = new Notification(); +$notification->setAppId('YOUR_APP_ID'); +$notification->setEmailSubject('Important Update'); +$notification->setEmailBody('

Hello!

This is an HTML email.

'); +$notification->setIncludedSegments(['Subscribed Users']); +$notification->setChannelForExternalUserIds('email'); -### Fetch aliases by another alias -```php -$fetchAliasesResponse = self::$apiInstance->fetchUserIdentity(APP_ID, '', ''); +$response = $client->createNotification($notification); ``` -### Identify user by subscription id -```php -$userIdentityRequestBody = new UserIdentityRequestBody(); - -$userIdentityRequestBody->setIdentity(array( - '' => '' -)); +## Send an SMS -// Act -$fetchAliasesResponse = self::$apiInstance->identifyUserBySubscriptionId( - APP_ID, '', $userIdentityRequestBody); -``` - -### Identify user by another alias ```php -$userIdentityRequestBody = new UserIdentityRequestBody(); +$content = new StringMap(); +$content->setEn('Your SMS message content here'); -$userIdentityRequestBody->setIdentity(array( - '' => '' -)); +$notification = new Notification(); +$notification->setAppId('YOUR_APP_ID'); +$notification->setContents($content); +$notification->setIncludedSegments(['Subscribed Users']); +$notification->setChannelForExternalUserIds('sms'); +$notification->setSmsFrom('+15551234567'); -// Act -$fetchAliasesResponse = self::$apiInstance->identifyUserByAlias( - APP_ID, '', '', $userIdentityRequestBody); +$response = $client->createNotification($notification); ``` +## Full API reference -### Transfer subscription to another user -```php -$transferSubscriptionRequestBody = new TransferSubscriptionRequestBody(); -$transferSubscriptionRequestBody->setIdentity(array('' => '')); - -// Act -$transferSubscriptionResponse = self::$apiInstance->transferSubscription( - APP_ID, '', $transferSubscriptionRequestBody); -``` - -### Fetch in app messages -```php -$getEligibleIamsResponse = self::$apiInstance->getEligibleIams(APP_ID, ''); -``` +The complete list of API endpoints and their parameters is available in the [DefaultApi documentation](https://github.com/OneSignal/onesignal-php-api/blob/main/docs/Api/DefaultApi.md). -## API Endpoints - -All URIs are relative to *https://api.onesignal.com* - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*DefaultApi* | [**cancelNotification**](docs/Api/DefaultApi.md#cancelnotification) | **DELETE** /notifications/{notification_id} | Stop a scheduled or currently outgoing notification -*DefaultApi* | [**copyTemplateToApp**](docs/Api/DefaultApi.md#copytemplatetoapp) | **POST** /templates/{template_id}/copy_to_app | Copy template to another app -*DefaultApi* | [**createAlias**](docs/Api/DefaultApi.md#createalias) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity | -*DefaultApi* | [**createAliasBySubscription**](docs/Api/DefaultApi.md#createaliasbysubscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity | -*DefaultApi* | [**createApiKey**](docs/Api/DefaultApi.md#createapikey) | **POST** /apps/{app_id}/auth/tokens | Create API key -*DefaultApi* | [**createApp**](docs/Api/DefaultApi.md#createapp) | **POST** /apps | Create an app -*DefaultApi* | [**createCustomEvents**](docs/Api/DefaultApi.md#createcustomevents) | **POST** /apps/{app_id}/integrations/custom_events | Create custom events -*DefaultApi* | [**createNotification**](docs/Api/DefaultApi.md#createnotification) | **POST** /notifications | Create notification -*DefaultApi* | [**createSegment**](docs/Api/DefaultApi.md#createsegment) | **POST** /apps/{app_id}/segments | Create Segment -*DefaultApi* | [**createSubscription**](docs/Api/DefaultApi.md#createsubscription) | **POST** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions | -*DefaultApi* | [**createTemplate**](docs/Api/DefaultApi.md#createtemplate) | **POST** /templates | Create template -*DefaultApi* | [**createUser**](docs/Api/DefaultApi.md#createuser) | **POST** /apps/{app_id}/users | -*DefaultApi* | [**deleteAlias**](docs/Api/DefaultApi.md#deletealias) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} | -*DefaultApi* | [**deleteApiKey**](docs/Api/DefaultApi.md#deleteapikey) | **DELETE** /apps/{app_id}/auth/tokens/{token_id} | Delete API key -*DefaultApi* | [**deleteSegment**](docs/Api/DefaultApi.md#deletesegment) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segment -*DefaultApi* | [**deleteSubscription**](docs/Api/DefaultApi.md#deletesubscription) | **DELETE** /apps/{app_id}/subscriptions/{subscription_id} | -*DefaultApi* | [**deleteTemplate**](docs/Api/DefaultApi.md#deletetemplate) | **DELETE** /templates/{template_id} | Delete template -*DefaultApi* | [**deleteUser**](docs/Api/DefaultApi.md#deleteuser) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id} | -*DefaultApi* | [**exportEvents**](docs/Api/DefaultApi.md#exportevents) | **POST** /notifications/{notification_id}/export_events?app_id={app_id} | Export CSV of Events -*DefaultApi* | [**exportSubscriptions**](docs/Api/DefaultApi.md#exportsubscriptions) | **POST** /players/csv_export?app_id={app_id} | Export CSV of Subscriptions -*DefaultApi* | [**getAliases**](docs/Api/DefaultApi.md#getaliases) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity | -*DefaultApi* | [**getAliasesBySubscription**](docs/Api/DefaultApi.md#getaliasesbysubscription) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity | -*DefaultApi* | [**getApp**](docs/Api/DefaultApi.md#getapp) | **GET** /apps/{app_id} | View an app -*DefaultApi* | [**getApps**](docs/Api/DefaultApi.md#getapps) | **GET** /apps | View apps -*DefaultApi* | [**getNotification**](docs/Api/DefaultApi.md#getnotification) | **GET** /notifications/{notification_id} | View notification -*DefaultApi* | [**getNotificationHistory**](docs/Api/DefaultApi.md#getnotificationhistory) | **POST** /notifications/{notification_id}/history | Notification History -*DefaultApi* | [**getNotifications**](docs/Api/DefaultApi.md#getnotifications) | **GET** /notifications | View notifications -*DefaultApi* | [**getOutcomes**](docs/Api/DefaultApi.md#getoutcomes) | **GET** /apps/{app_id}/outcomes | View Outcomes -*DefaultApi* | [**getSegments**](docs/Api/DefaultApi.md#getsegments) | **GET** /apps/{app_id}/segments | Get Segments -*DefaultApi* | [**getUser**](docs/Api/DefaultApi.md#getuser) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} | -*DefaultApi* | [**rotateApiKey**](docs/Api/DefaultApi.md#rotateapikey) | **POST** /apps/{app_id}/auth/tokens/{token_id}/rotate | Rotate API key -*DefaultApi* | [**startLiveActivity**](docs/Api/DefaultApi.md#startliveactivity) | **POST** /apps/{app_id}/activities/activity/{activity_type} | Start Live Activity -*DefaultApi* | [**transferSubscription**](docs/Api/DefaultApi.md#transfersubscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/owner | -*DefaultApi* | [**unsubscribeEmailWithToken**](docs/Api/DefaultApi.md#unsubscribeemailwithtoken) | **POST** /apps/{app_id}/notifications/{notification_id}/unsubscribe | Unsubscribe with token -*DefaultApi* | [**updateApiKey**](docs/Api/DefaultApi.md#updateapikey) | **PATCH** /apps/{app_id}/auth/tokens/{token_id} | Update API key -*DefaultApi* | [**updateApp**](docs/Api/DefaultApi.md#updateapp) | **PUT** /apps/{app_id} | Update an app -*DefaultApi* | [**updateLiveActivity**](docs/Api/DefaultApi.md#updateliveactivity) | **POST** /apps/{app_id}/live_activities/{activity_id}/notifications | Update a Live Activity via Push -*DefaultApi* | [**updateSubscription**](docs/Api/DefaultApi.md#updatesubscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id} | -*DefaultApi* | [**updateSubscriptionByToken**](docs/Api/DefaultApi.md#updatesubscriptionbytoken) | **PATCH** /apps/{app_id}/subscriptions_by_token/{token_type}/{token} | Update subscription by token -*DefaultApi* | [**updateTemplate**](docs/Api/DefaultApi.md#updatetemplate) | **PATCH** /templates/{template_id} | Update template -*DefaultApi* | [**updateUser**](docs/Api/DefaultApi.md#updateuser) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id} | -*DefaultApi* | [**viewApiKeys**](docs/Api/DefaultApi.md#viewapikeys) | **GET** /apps/{app_id}/auth/tokens | View API keys -*DefaultApi* | [**viewTemplate**](docs/Api/DefaultApi.md#viewtemplate) | **GET** /templates/{template_id} | View template -*DefaultApi* | [**viewTemplates**](docs/Api/DefaultApi.md#viewtemplates) | **GET** /templates | View templates - -## Models - -- [ApiKeyToken](docs/Model/ApiKeyToken.md) -- [ApiKeyTokensListResponse](docs/Model/ApiKeyTokensListResponse.md) -- [App](docs/Model/App.md) -- [BasicNotification](docs/Model/BasicNotification.md) -- [BasicNotificationAllOf](docs/Model/BasicNotificationAllOf.md) -- [BasicNotificationAllOfAndroidBackgroundLayout](docs/Model/BasicNotificationAllOfAndroidBackgroundLayout.md) -- [Button](docs/Model/Button.md) -- [CopyTemplateRequest](docs/Model/CopyTemplateRequest.md) -- [CreateApiKeyRequest](docs/Model/CreateApiKeyRequest.md) -- [CreateApiKeyResponse](docs/Model/CreateApiKeyResponse.md) -- [CreateNotificationSuccessResponse](docs/Model/CreateNotificationSuccessResponse.md) -- [CreateSegmentConflictResponse](docs/Model/CreateSegmentConflictResponse.md) -- [CreateSegmentSuccessResponse](docs/Model/CreateSegmentSuccessResponse.md) -- [CreateTemplateRequest](docs/Model/CreateTemplateRequest.md) -- [CreateUserConflictResponse](docs/Model/CreateUserConflictResponse.md) -- [CreateUserConflictResponseErrorsInner](docs/Model/CreateUserConflictResponseErrorsInner.md) -- [CreateUserConflictResponseErrorsItemsMeta](docs/Model/CreateUserConflictResponseErrorsItemsMeta.md) -- [CustomEvent](docs/Model/CustomEvent.md) -- [CustomEventsRequest](docs/Model/CustomEventsRequest.md) -- [DeliveryData](docs/Model/DeliveryData.md) -- [ExportEventsSuccessResponse](docs/Model/ExportEventsSuccessResponse.md) -- [ExportSubscriptionsRequestBody](docs/Model/ExportSubscriptionsRequestBody.md) -- [ExportSubscriptionsSuccessResponse](docs/Model/ExportSubscriptionsSuccessResponse.md) -- [Filter](docs/Model/Filter.md) -- [FilterExpression](docs/Model/FilterExpression.md) -- [GenericError](docs/Model/GenericError.md) -- [GenericSuccessBoolResponse](docs/Model/GenericSuccessBoolResponse.md) -- [GetNotificationHistoryRequestBody](docs/Model/GetNotificationHistoryRequestBody.md) -- [GetSegmentsSuccessResponse](docs/Model/GetSegmentsSuccessResponse.md) -- [LanguageStringMap](docs/Model/LanguageStringMap.md) -- [Notification](docs/Model/Notification.md) -- [NotificationAllOf](docs/Model/NotificationAllOf.md) -- [NotificationHistorySuccessResponse](docs/Model/NotificationHistorySuccessResponse.md) -- [NotificationSlice](docs/Model/NotificationSlice.md) -- [NotificationTarget](docs/Model/NotificationTarget.md) -- [NotificationWithMeta](docs/Model/NotificationWithMeta.md) -- [NotificationWithMetaAllOf](docs/Model/NotificationWithMetaAllOf.md) -- [Operator](docs/Model/Operator.md) -- [OutcomeData](docs/Model/OutcomeData.md) -- [OutcomesData](docs/Model/OutcomesData.md) -- [PlatformDeliveryData](docs/Model/PlatformDeliveryData.md) -- [PlatformDeliveryDataEmailAllOf](docs/Model/PlatformDeliveryDataEmailAllOf.md) -- [PlatformDeliveryDataSmsAllOf](docs/Model/PlatformDeliveryDataSmsAllOf.md) -- [PropertiesBody](docs/Model/PropertiesBody.md) -- [PropertiesDeltas](docs/Model/PropertiesDeltas.md) -- [PropertiesObject](docs/Model/PropertiesObject.md) -- [Purchase](docs/Model/Purchase.md) -- [RateLimitError](docs/Model/RateLimitError.md) -- [Segment](docs/Model/Segment.md) -- [SegmentData](docs/Model/SegmentData.md) -- [SegmentNotificationTarget](docs/Model/SegmentNotificationTarget.md) -- [StartLiveActivityRequest](docs/Model/StartLiveActivityRequest.md) -- [StartLiveActivitySuccessResponse](docs/Model/StartLiveActivitySuccessResponse.md) -- [Subscription](docs/Model/Subscription.md) -- [SubscriptionBody](docs/Model/SubscriptionBody.md) -- [SubscriptionNotificationTarget](docs/Model/SubscriptionNotificationTarget.md) -- [TemplateResource](docs/Model/TemplateResource.md) -- [TemplatesListResponse](docs/Model/TemplatesListResponse.md) -- [TransferSubscriptionRequestBody](docs/Model/TransferSubscriptionRequestBody.md) -- [UpdateApiKeyRequest](docs/Model/UpdateApiKeyRequest.md) -- [UpdateLiveActivityRequest](docs/Model/UpdateLiveActivityRequest.md) -- [UpdateLiveActivitySuccessResponse](docs/Model/UpdateLiveActivitySuccessResponse.md) -- [UpdateTemplateRequest](docs/Model/UpdateTemplateRequest.md) -- [UpdateUserRequest](docs/Model/UpdateUserRequest.md) -- [User](docs/Model/User.md) -- [UserIdentityBody](docs/Model/UserIdentityBody.md) -- [WebButton](docs/Model/WebButton.md) - -## Authorization -All the OneSignal endpoints require either an *app_key* or *user_key* tokens for authorization. It is recommended to -set up both of those keys during the initial config initialization so that you don't need to worry about which endpoint -requires app_key and which user_key. You can get the value of these keys from your -[app dashboard]([https://app.onesignal.com/apps]) and [user settings](https://app.onesignal.com/profile) pages. - - - -### organization_api_key - -- **Type**: Bearer authentication - - -### rest_api_key - -- **Type**: Bearer authentication - - -## Author - -devrel@onesignal.com - - -- API version: `5.3.0` - - Package version: `5.3.0` +For the underlying REST API, see the [OneSignal API reference](https://documentation.onesignal.com/reference). diff --git a/docs/Api/DefaultApi.md b/docs/Api/DefaultApi.md index 9270414..e193ca1 100644 --- a/docs/Api/DefaultApi.md +++ b/docs/Api/DefaultApi.md @@ -104,16 +104,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `copyTemplateToApp()` @@ -171,16 +170,15 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `createAlias()` @@ -240,16 +238,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `createAliasBySubscription()` @@ -307,16 +304,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `createApiKey()` @@ -372,16 +368,15 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `createApp()` @@ -435,16 +430,15 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `createCustomEvents()` @@ -500,16 +494,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `createNotification()` @@ -563,16 +556,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `createSegment()` @@ -628,16 +620,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `createSubscription()` @@ -697,16 +688,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `createTemplate()` @@ -760,16 +750,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `createUser()` @@ -825,16 +814,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `deleteAlias()` @@ -894,16 +882,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `deleteApiKey()` @@ -959,16 +946,15 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `deleteSegment()` @@ -1024,16 +1010,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `deleteSubscription()` @@ -1088,16 +1073,15 @@ void (empty response body) ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `deleteTemplate()` @@ -1153,16 +1137,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `deleteUser()` @@ -1219,16 +1202,15 @@ void (empty response body) ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `exportEvents()` @@ -1284,16 +1266,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `exportSubscriptions()` @@ -1349,16 +1330,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `getAliases()` @@ -1416,16 +1396,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `getAliasesBySubscription()` @@ -1481,16 +1460,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `getApp()` @@ -1544,16 +1522,15 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `getApps()` @@ -1604,16 +1581,15 @@ This endpoint does not need any parameter. ### Authorization -[organization_api_key](../../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `getNotification()` @@ -1669,16 +1645,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `getNotificationHistory()` @@ -1734,16 +1709,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `getNotifications()` @@ -1803,16 +1777,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `getOutcomes()` @@ -1876,16 +1849,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `getSegments()` @@ -1943,16 +1915,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `getUser()` @@ -2010,16 +1981,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `rotateApiKey()` @@ -2075,16 +2045,15 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `startLiveActivity()` @@ -2142,16 +2111,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `transferSubscription()` @@ -2209,16 +2177,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `unsubscribeEmailWithToken()` @@ -2276,16 +2243,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `updateApiKey()` @@ -2343,16 +2309,15 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `updateApp()` @@ -2408,16 +2373,15 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `updateLiveActivity()` @@ -2475,16 +2439,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `updateSubscription()` @@ -2541,16 +2504,15 @@ void (empty response body) ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `updateSubscriptionByToken()` @@ -2610,16 +2572,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `updateTemplate()` @@ -2677,16 +2638,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `updateUser()` @@ -2746,16 +2706,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: `application/json` - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `viewApiKeys()` @@ -2809,16 +2768,15 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `viewTemplate()` @@ -2874,16 +2832,15 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) ## `viewTemplates()` @@ -2943,13 +2900,12 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-php-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) +[[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/ApiKeyToken.md b/docs/Model/ApiKeyToken.md index c90ab6b..8a316f9 100644 --- a/docs/Model/ApiKeyToken.md +++ b/docs/Model/ApiKeyToken.md @@ -11,4 +11,4 @@ Name | Type | Description | Notes **ip_allowlist_mode** | **string** | | [optional] **ip_allowlist** | **string[]** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/ApiKeyTokensListResponse.md b/docs/Model/ApiKeyTokensListResponse.md index 1112215..c1429c7 100644 --- a/docs/Model/ApiKeyTokensListResponse.md +++ b/docs/Model/ApiKeyTokensListResponse.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **tokens** | [**\onesignal\client\model\ApiKeyToken[]**](ApiKeyToken.md) | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/App.md b/docs/Model/App.md index 277e5ba..6733767 100644 --- a/docs/Model/App.md +++ b/docs/Model/App.md @@ -39,4 +39,4 @@ Name | Type | Description | Notes **organization_id** | **string** | The Id of the Organization you would like to add this app to. | [optional] **additional_data_is_root_payload** | **bool** | iOS: Notification data (additional data) values will be added to the root of the apns payload when sent to the device. Ignore if you're not using any other plugins, or not using OneSignal SDK methods to read the payload. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/BasicNotification.md b/docs/Model/BasicNotification.md index a2d26c3..c440904 100644 --- a/docs/Model/BasicNotification.md +++ b/docs/Model/BasicNotification.md @@ -119,4 +119,4 @@ Name | Type | Description | Notes **huawei_category** | **string** | Channel: Push Notifications Platform: Huawei Category of the push notification for HMS classification. | [optional] **huawei_bi_tag** | **string** | Channel: Push Notifications Platform: Huawei A tag used for Huawei business intelligence and analytics. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/BasicNotificationAllOf.md b/docs/Model/BasicNotificationAllOf.md index b8f59fb..b3f9037 100644 --- a/docs/Model/BasicNotificationAllOf.md +++ b/docs/Model/BasicNotificationAllOf.md @@ -106,4 +106,4 @@ Name | Type | Description | Notes **huawei_category** | **string** | Channel: Push Notifications Platform: Huawei Category of the push notification for HMS classification. | [optional] **huawei_bi_tag** | **string** | Channel: Push Notifications Platform: Huawei A tag used for Huawei business intelligence and analytics. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/BasicNotificationAllOfAndroidBackgroundLayout.md b/docs/Model/BasicNotificationAllOfAndroidBackgroundLayout.md index 067b964..7f7820f 100644 --- a/docs/Model/BasicNotificationAllOfAndroidBackgroundLayout.md +++ b/docs/Model/BasicNotificationAllOfAndroidBackgroundLayout.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **headings_color** | **string** | Title text color ARGB Hex format. Example(Blue) \"FF0000FF\". | [optional] **contents_color** | **string** | Body text color ARGB Hex format. Example(Red) \"FFFF0000\". | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/Button.md b/docs/Model/Button.md index 8bb37b8..40018e7 100644 --- a/docs/Model/Button.md +++ b/docs/Model/Button.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **text** | **string** | | [optional] **icon** | **string** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/CopyTemplateRequest.md b/docs/Model/CopyTemplateRequest.md index 87f1df5..113b021 100644 --- a/docs/Model/CopyTemplateRequest.md +++ b/docs/Model/CopyTemplateRequest.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **target_app_id** | **string** | Destination OneSignal App ID in UUID v4 format. | -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/CreateApiKeyRequest.md b/docs/Model/CreateApiKeyRequest.md index 74fdec7..6192907 100644 --- a/docs/Model/CreateApiKeyRequest.md +++ b/docs/Model/CreateApiKeyRequest.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **ip_allowlist_mode** | **string** | | [optional] **ip_allowlist** | **string[]** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/CreateApiKeyResponse.md b/docs/Model/CreateApiKeyResponse.md index d95f9db..aeb0935 100644 --- a/docs/Model/CreateApiKeyResponse.md +++ b/docs/Model/CreateApiKeyResponse.md @@ -7,4 +7,4 @@ Name | Type | Description | Notes **token_id** | **string** | | [optional] **formatted_token** | **string** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/CreateNotificationSuccessResponse.md b/docs/Model/CreateNotificationSuccessResponse.md index c089ecc..2cfcf76 100644 --- a/docs/Model/CreateNotificationSuccessResponse.md +++ b/docs/Model/CreateNotificationSuccessResponse.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **external_id** | **string** | | [optional] **errors** | **mixed** | Errors include the identifiers that are invalid, or that there are no subscribers. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/CreateSegmentConflictResponse.md b/docs/Model/CreateSegmentConflictResponse.md index 259323a..f66e900 100644 --- a/docs/Model/CreateSegmentConflictResponse.md +++ b/docs/Model/CreateSegmentConflictResponse.md @@ -7,4 +7,4 @@ Name | Type | Description | Notes **success** | **bool** | | [optional] **errors** | **string[]** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/CreateSegmentSuccessResponse.md b/docs/Model/CreateSegmentSuccessResponse.md index 497c2d9..475f65f 100644 --- a/docs/Model/CreateSegmentSuccessResponse.md +++ b/docs/Model/CreateSegmentSuccessResponse.md @@ -7,4 +7,4 @@ Name | Type | Description | Notes **success** | **bool** | | [optional] **id** | **string** | UUID of created segment | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/CreateTemplateRequest.md b/docs/Model/CreateTemplateRequest.md index 2939d7f..0d5207f 100644 --- a/docs/Model/CreateTemplateRequest.md +++ b/docs/Model/CreateTemplateRequest.md @@ -13,4 +13,4 @@ Name | Type | Description | Notes **is_sms** | **bool** | Set true for an SMS template. | [optional] **dynamic_content** | **string** | JSON string for dynamic content personalization. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/CreateUserConflictResponse.md b/docs/Model/CreateUserConflictResponse.md index 689d274..7a10f81 100644 --- a/docs/Model/CreateUserConflictResponse.md +++ b/docs/Model/CreateUserConflictResponse.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**\onesignal\client\model\CreateUserConflictResponseErrorsInner[]**](CreateUserConflictResponseErrorsInner.md) | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/CreateUserConflictResponseErrorsInner.md b/docs/Model/CreateUserConflictResponseErrorsInner.md index e5e3e00..bd796ae 100644 --- a/docs/Model/CreateUserConflictResponseErrorsInner.md +++ b/docs/Model/CreateUserConflictResponseErrorsInner.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **title** | **string** | | [optional] **meta** | [**\onesignal\client\model\CreateUserConflictResponseErrorsItemsMeta**](CreateUserConflictResponseErrorsItemsMeta.md) | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/CreateUserConflictResponseErrorsItemsMeta.md b/docs/Model/CreateUserConflictResponseErrorsItemsMeta.md index 2ce84a5..f3c9bec 100644 --- a/docs/Model/CreateUserConflictResponseErrorsItemsMeta.md +++ b/docs/Model/CreateUserConflictResponseErrorsItemsMeta.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **conflicting_aliases** | **object** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/CustomEvent.md b/docs/Model/CustomEvent.md index 1b0aeee..5b434f4 100644 --- a/docs/Model/CustomEvent.md +++ b/docs/Model/CustomEvent.md @@ -10,4 +10,4 @@ Name | Type | Description | Notes **timestamp** | **\DateTime** | Time the event occurred as an ISO8601 formatted string. Defaults to now if not included or past date provided. | [optional] **payload** | **array** | Properties or data related to the event, like {\"geography\": \"USA\"} | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/CustomEventsRequest.md b/docs/Model/CustomEventsRequest.md index 5161c04..7f2aaee 100644 --- a/docs/Model/CustomEventsRequest.md +++ b/docs/Model/CustomEventsRequest.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **events** | [**\onesignal\client\model\CustomEvent[]**](CustomEvent.md) | | -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/DeliveryData.md b/docs/Model/DeliveryData.md index 3df7a80..2233838 100644 --- a/docs/Model/DeliveryData.md +++ b/docs/Model/DeliveryData.md @@ -10,4 +10,4 @@ Name | Type | Description | Notes **converted** | **int** | Number of messages that were clicked. | [optional] **received** | **int** | Number of devices that received the message. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/ExportEventsSuccessResponse.md b/docs/Model/ExportEventsSuccessResponse.md index d8e0baf..65f9723 100644 --- a/docs/Model/ExportEventsSuccessResponse.md +++ b/docs/Model/ExportEventsSuccessResponse.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **csv_file_url** | **string** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/ExportSubscriptionsRequestBody.md b/docs/Model/ExportSubscriptionsRequestBody.md index b5b5c1b..ac314d6 100644 --- a/docs/Model/ExportSubscriptionsRequestBody.md +++ b/docs/Model/ExportSubscriptionsRequestBody.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **last_active_since** | **string** | Export all devices with a last_active timestamp greater than this time. Unixtime in seconds. | [optional] **segment_name** | **string** | Export all devices belonging to the segment. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/ExportSubscriptionsSuccessResponse.md b/docs/Model/ExportSubscriptionsSuccessResponse.md index 3d77ffc..7e36ce9 100644 --- a/docs/Model/ExportSubscriptionsSuccessResponse.md +++ b/docs/Model/ExportSubscriptionsSuccessResponse.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **csv_file_url** | **string** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/Filter.md b/docs/Model/Filter.md index 48b2bac..8b0764d 100644 --- a/docs/Model/Filter.md +++ b/docs/Model/Filter.md @@ -13,4 +13,4 @@ Name | Type | Description | Notes **long** | **float** | If `field` is `location`, this is *required* to specify the user's longitude. | [optional] **relation** | **string** | Required. Operator of a filter expression. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/FilterExpression.md b/docs/Model/FilterExpression.md index a8a7dd1..0284236 100644 --- a/docs/Model/FilterExpression.md +++ b/docs/Model/FilterExpression.md @@ -14,4 +14,4 @@ Name | Type | Description | Notes **relation** | **string** | Required. Operator of a filter expression. | [optional] **operator** | **string** | Strictly, this must be either `\"OR\"`, or `\"AND\"`. It can be used to compose Filters as part of a Filters object. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/GenericError.md b/docs/Model/GenericError.md index ec1d1c3..7167fdd 100644 --- a/docs/Model/GenericError.md +++ b/docs/Model/GenericError.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **success** | **bool** | | [optional] **reference** | **mixed** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/GenericSuccessBoolResponse.md b/docs/Model/GenericSuccessBoolResponse.md index 4ae2458..923d8d6 100644 --- a/docs/Model/GenericSuccessBoolResponse.md +++ b/docs/Model/GenericSuccessBoolResponse.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **bool** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/GetNotificationHistoryRequestBody.md b/docs/Model/GetNotificationHistoryRequestBody.md index 18455c1..c6fcd76 100644 --- a/docs/Model/GetNotificationHistoryRequestBody.md +++ b/docs/Model/GetNotificationHistoryRequestBody.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **email** | **string** | The email address you would like the report sent. | [optional] **app_id** | **string** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/GetSegmentsSuccessResponse.md b/docs/Model/GetSegmentsSuccessResponse.md index 7828a45..4fa53f0 100644 --- a/docs/Model/GetSegmentsSuccessResponse.md +++ b/docs/Model/GetSegmentsSuccessResponse.md @@ -9,4 +9,4 @@ Name | Type | Description | Notes **limit** | **int** | Maximum number of Segments returned. Default 300. | [optional] **segments** | [**\onesignal\client\model\SegmentData[]**](SegmentData.md) | An array containing the Segment information. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/LanguageStringMap.md b/docs/Model/LanguageStringMap.md index dfc9726..2fa1501 100644 --- a/docs/Model/LanguageStringMap.md +++ b/docs/Model/LanguageStringMap.md @@ -48,4 +48,4 @@ Name | Type | Description | Notes **uk** | **string** | Text in Ukrainian. | [optional] **vi** | **string** | Text in Vietnamese. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/Notification.md b/docs/Model/Notification.md index a52ec43..2cf639e 100644 --- a/docs/Model/Notification.md +++ b/docs/Model/Notification.md @@ -120,4 +120,4 @@ Name | Type | Description | Notes **huawei_bi_tag** | **string** | Channel: Push Notifications Platform: Huawei A tag used for Huawei business intelligence and analytics. | [optional] **send_after** | **\DateTime** | Channel: All Schedule notification for future delivery. API defaults to UTC -1100 Examples: All examples are the exact same date & time. \"Thu Sep 24 2015 14:00:00 GMT-0700 (PDT)\" \"September 24th 2015, 2:00:00 pm UTC-07:00\" \"2015-09-24 14:00:00 GMT-0700\" \"Sept 24 2015 14:00:00 GMT-0700\" \"Thu Sep 24 2015 14:00:00 GMT-0700 (Pacific Daylight Time)\" Note: SMS currently only supports send_after parameter. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/NotificationAllOf.md b/docs/Model/NotificationAllOf.md index b8e6cb2..7a8d5f0 100644 --- a/docs/Model/NotificationAllOf.md +++ b/docs/Model/NotificationAllOf.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **send_after** | **\DateTime** | Channel: All Schedule notification for future delivery. API defaults to UTC -1100 Examples: All examples are the exact same date & time. \"Thu Sep 24 2015 14:00:00 GMT-0700 (PDT)\" \"September 24th 2015, 2:00:00 pm UTC-07:00\" \"2015-09-24 14:00:00 GMT-0700\" \"Sept 24 2015 14:00:00 GMT-0700\" \"Thu Sep 24 2015 14:00:00 GMT-0700 (Pacific Daylight Time)\" Note: SMS currently only supports send_after parameter. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/NotificationHistorySuccessResponse.md b/docs/Model/NotificationHistorySuccessResponse.md index 4e48b2b..22d9a23 100644 --- a/docs/Model/NotificationHistorySuccessResponse.md +++ b/docs/Model/NotificationHistorySuccessResponse.md @@ -7,4 +7,4 @@ Name | Type | Description | Notes **success** | **bool** | | [optional] **destination_url** | **string** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/NotificationSlice.md b/docs/Model/NotificationSlice.md index 4a1e477..58410ed 100644 --- a/docs/Model/NotificationSlice.md +++ b/docs/Model/NotificationSlice.md @@ -9,4 +9,4 @@ Name | Type | Description | Notes **limit** | **int** | | [optional] **notifications** | [**\onesignal\client\model\NotificationWithMeta[]**](NotificationWithMeta.md) | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/NotificationTarget.md b/docs/Model/NotificationTarget.md index 4bffb27..8ce9fff 100644 --- a/docs/Model/NotificationTarget.md +++ b/docs/Model/NotificationTarget.md @@ -18,4 +18,4 @@ Name | Type | Description | Notes **include_aliases** | **array** | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] **target_channel** | **string** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/NotificationWithMeta.md b/docs/Model/NotificationWithMeta.md index 88e5df5..c9bc639 100644 --- a/docs/Model/NotificationWithMeta.md +++ b/docs/Model/NotificationWithMeta.md @@ -131,4 +131,4 @@ Name | Type | Description | Notes **platform_delivery_stats** | [**\onesignal\client\model\PlatformDeliveryData**](PlatformDeliveryData.md) | | [optional] **canceled** | **bool** | Indicates whether the notification was canceled before it could be sent. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/NotificationWithMetaAllOf.md b/docs/Model/NotificationWithMetaAllOf.md index e1a9712..bd38445 100644 --- a/docs/Model/NotificationWithMetaAllOf.md +++ b/docs/Model/NotificationWithMetaAllOf.md @@ -17,4 +17,4 @@ Name | Type | Description | Notes **throttle_rate_per_minute** | **int** | number of push notifications sent per minute. Paid Feature Only. If throttling is not enabled for the app or the notification, and for free accounts, null is returned. Refer to Throttling for more details. | [optional] **canceled** | **bool** | Indicates whether the notification was canceled before it could be sent. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/Operator.md b/docs/Model/Operator.md index cd7f211..039f6ba 100644 --- a/docs/Model/Operator.md +++ b/docs/Model/Operator.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operator** | **string** | Strictly, this must be either `\"OR\"`, or `\"AND\"`. It can be used to compose Filters as part of a Filters object. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/OutcomeData.md b/docs/Model/OutcomeData.md index aa127c6..1148037 100644 --- a/docs/Model/OutcomeData.md +++ b/docs/Model/OutcomeData.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **value** | **int** | | **aggregation** | **string** | | -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/OutcomesData.md b/docs/Model/OutcomesData.md index a46e4bc..97135d5 100644 --- a/docs/Model/OutcomesData.md +++ b/docs/Model/OutcomesData.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **outcomes** | [**\onesignal\client\model\OutcomeData[]**](OutcomeData.md) | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/PlatformDeliveryData.md b/docs/Model/PlatformDeliveryData.md index 1689697..dd15e7d 100644 --- a/docs/Model/PlatformDeliveryData.md +++ b/docs/Model/PlatformDeliveryData.md @@ -13,4 +13,4 @@ Name | Type | Description | Notes **sms** | [**DeliveryData**](DeliveryData.md) | | [optional] **email** | [**DeliveryData**](DeliveryData.md) | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/PlatformDeliveryDataEmailAllOf.md b/docs/Model/PlatformDeliveryDataEmailAllOf.md index 6630fbd..32a98a5 100644 --- a/docs/Model/PlatformDeliveryDataEmailAllOf.md +++ b/docs/Model/PlatformDeliveryDataEmailAllOf.md @@ -12,4 +12,4 @@ Name | Type | Description | Notes **reported_spam** | **int** | Number of recipients who reported this email as spam. | [optional] **unsubscribed** | **int** | Number of recipients who opted out of your emails using the unsubscribe link in this email. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/PlatformDeliveryDataSmsAllOf.md b/docs/Model/PlatformDeliveryDataSmsAllOf.md index dc693a4..7fa58dc 100644 --- a/docs/Model/PlatformDeliveryDataSmsAllOf.md +++ b/docs/Model/PlatformDeliveryDataSmsAllOf.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **provider_failed** | **int** | Number of recipients who didn't receive your message as reported by the SMS service provider. | [optional] **provider_errored** | **int** | Number of errors reported by the SMS service provider. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/PropertiesBody.md b/docs/Model/PropertiesBody.md index 039bd3a..4885b26 100644 --- a/docs/Model/PropertiesBody.md +++ b/docs/Model/PropertiesBody.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **properties** | [**\onesignal\client\model\PropertiesObject**](PropertiesObject.md) | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/PropertiesDeltas.md b/docs/Model/PropertiesDeltas.md index f985eae..cc39b75 100644 --- a/docs/Model/PropertiesDeltas.md +++ b/docs/Model/PropertiesDeltas.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **session_count** | **int** | | [optional] **purchases** | [**\onesignal\client\model\Purchase[]**](Purchase.md) | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/PropertiesObject.md b/docs/Model/PropertiesObject.md index ce659e6..f913e24 100644 --- a/docs/Model/PropertiesObject.md +++ b/docs/Model/PropertiesObject.md @@ -16,4 +16,4 @@ Name | Type | Description | Notes **purchases** | [**\onesignal\client\model\Purchase[]**](Purchase.md) | | [optional] **ip** | **string** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/Purchase.md b/docs/Model/Purchase.md index 351999c..ecb5f4c 100644 --- a/docs/Model/Purchase.md +++ b/docs/Model/Purchase.md @@ -9,4 +9,4 @@ Name | Type | Description | Notes **iso** | **string** | The 3-letter ISO 4217 currency code. Required for correct storage and conversion of amount. | **count** | **int** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/RateLimitError.md b/docs/Model/RateLimitError.md index 39d2963..9f3ddc6 100644 --- a/docs/Model/RateLimitError.md +++ b/docs/Model/RateLimitError.md @@ -7,4 +7,4 @@ Name | Type | Description | Notes **errors** | **string[]** | | [optional] **limit** | **string** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/Segment.md b/docs/Model/Segment.md index fd58519..0888bcc 100644 --- a/docs/Model/Segment.md +++ b/docs/Model/Segment.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **name** | **string** | Name of the segment. You'll see this name on the Web UI. | **filters** | [**\onesignal\client\model\FilterExpression[]**](FilterExpression.md) | Filter or operators the segment will have. For a list of available filters with details, please see Send to Users Based on Filters. | -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/SegmentData.md b/docs/Model/SegmentData.md index 1ef469d..2337f31 100644 --- a/docs/Model/SegmentData.md +++ b/docs/Model/SegmentData.md @@ -12,4 +12,4 @@ Name | Type | Description | Notes **read_only** | **bool** | Is the segment read only? | [optional] **is_active** | **bool** | Is the segment active? | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/SegmentNotificationTarget.md b/docs/Model/SegmentNotificationTarget.md index 46ded78..9048ad5 100644 --- a/docs/Model/SegmentNotificationTarget.md +++ b/docs/Model/SegmentNotificationTarget.md @@ -7,4 +7,4 @@ Name | Type | Description | Notes **included_segments** | **string[]** | The segment names you want to target. Users in these segments will receive a notification. This targeting parameter is only compatible with excluded_segments. Example: [\"Active Users\", \"Inactive Users\"] | [optional] **excluded_segments** | **string[]** | Segment that will be excluded when sending. Users in these segments will not receive a notification, even if they were included in included_segments. This targeting parameter is only compatible with included_segments. Example: [\"Active Users\", \"Inactive Users\"] | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/StartLiveActivityRequest.md b/docs/Model/StartLiveActivityRequest.md index 5f5e909..b72522b 100644 --- a/docs/Model/StartLiveActivityRequest.md +++ b/docs/Model/StartLiveActivityRequest.md @@ -21,4 +21,4 @@ Name | Type | Description | Notes **excluded_segments** | **string[]** | Segment names to exclude. Only compatible with included_segments. | [optional] **filters** | [**\onesignal\client\model\FilterExpression[]**](FilterExpression.md) | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/StartLiveActivitySuccessResponse.md b/docs/Model/StartLiveActivitySuccessResponse.md index cdaf0ba..d54bb8d 100644 --- a/docs/Model/StartLiveActivitySuccessResponse.md +++ b/docs/Model/StartLiveActivitySuccessResponse.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **notification_id** | **string** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/Subscription.md b/docs/Model/Subscription.md index 522bd7b..8e82aea 100644 --- a/docs/Model/Subscription.md +++ b/docs/Model/Subscription.md @@ -22,4 +22,4 @@ Name | Type | Description | Notes **web_auth** | **string** | | [optional] **web_p256** | **string** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/SubscriptionBody.md b/docs/Model/SubscriptionBody.md index 14b2efc..185fca4 100644 --- a/docs/Model/SubscriptionBody.md +++ b/docs/Model/SubscriptionBody.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **subscription** | [**\onesignal\client\model\Subscription**](Subscription.md) | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/SubscriptionNotificationTarget.md b/docs/Model/SubscriptionNotificationTarget.md index 05814cd..3d95a09 100644 --- a/docs/Model/SubscriptionNotificationTarget.md +++ b/docs/Model/SubscriptionNotificationTarget.md @@ -16,4 +16,4 @@ Name | Type | Description | Notes **include_aliases** | **array** | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] **target_channel** | **string** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/TemplateResource.md b/docs/Model/TemplateResource.md index bc719d9..e066a81 100644 --- a/docs/Model/TemplateResource.md +++ b/docs/Model/TemplateResource.md @@ -11,4 +11,4 @@ Name | Type | Description | Notes **channel** | **string** | | [optional] **content** | **array** | Rendered content and channel/platform flags for the template. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/TemplatesListResponse.md b/docs/Model/TemplatesListResponse.md index 507f963..c49e239 100644 --- a/docs/Model/TemplatesListResponse.md +++ b/docs/Model/TemplatesListResponse.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **templates** | [**\onesignal\client\model\TemplateResource[]**](TemplateResource.md) | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/TransferSubscriptionRequestBody.md b/docs/Model/TransferSubscriptionRequestBody.md index 3ac629e..0672ffa 100644 --- a/docs/Model/TransferSubscriptionRequestBody.md +++ b/docs/Model/TransferSubscriptionRequestBody.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **identity** | **array** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/UpdateApiKeyRequest.md b/docs/Model/UpdateApiKeyRequest.md index 914ba73..6179910 100644 --- a/docs/Model/UpdateApiKeyRequest.md +++ b/docs/Model/UpdateApiKeyRequest.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **ip_allowlist_mode** | **string** | | [optional] **ip_allowlist** | **string[]** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/UpdateLiveActivityRequest.md b/docs/Model/UpdateLiveActivityRequest.md index 3f9da91..90788ac 100644 --- a/docs/Model/UpdateLiveActivityRequest.md +++ b/docs/Model/UpdateLiveActivityRequest.md @@ -14,4 +14,4 @@ Name | Type | Description | Notes **dismissal_date** | **int** | Accepts Unix timestamp in seconds; only allowed if event is \"end\" | [optional] **priority** | **int** | Delivery priority through the the push provider (APNs). Pass 10 for higher priority notifications, or 5 for lower priority notifications. Lower priority notifications are sent based on the power considerations of the end user's device. If not set, defaults to 10. Some providers (APNs) allow for a limited budget of high priority notifications per hour, and if that budget is exceeded, the provider may throttle notification delivery. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/UpdateLiveActivitySuccessResponse.md b/docs/Model/UpdateLiveActivitySuccessResponse.md index c7a4f7a..04a541e 100644 --- a/docs/Model/UpdateLiveActivitySuccessResponse.md +++ b/docs/Model/UpdateLiveActivitySuccessResponse.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/UpdateTemplateRequest.md b/docs/Model/UpdateTemplateRequest.md index 00fc11c..e218e03 100644 --- a/docs/Model/UpdateTemplateRequest.md +++ b/docs/Model/UpdateTemplateRequest.md @@ -12,4 +12,4 @@ Name | Type | Description | Notes **is_sms** | **bool** | Set true for an SMS template. | [optional] **dynamic_content** | **string** | JSON string for dynamic content personalization. | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/UpdateUserRequest.md b/docs/Model/UpdateUserRequest.md index c691a6d..53529f3 100644 --- a/docs/Model/UpdateUserRequest.md +++ b/docs/Model/UpdateUserRequest.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **refresh_device_metadata** | **bool** | | [optional] [default to false] **deltas** | [**\onesignal\client\model\PropertiesDeltas**](PropertiesDeltas.md) | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/User.md b/docs/Model/User.md index b0d0e2b..995932d 100644 --- a/docs/Model/User.md +++ b/docs/Model/User.md @@ -8,4 +8,4 @@ Name | Type | Description | Notes **identity** | **array** | | [optional] **subscriptions** | [**\onesignal\client\model\Subscription[]**](Subscription.md) | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/UserIdentityBody.md b/docs/Model/UserIdentityBody.md index cf50311..fbf77c7 100644 --- a/docs/Model/UserIdentityBody.md +++ b/docs/Model/UserIdentityBody.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **identity** | **array** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api) diff --git a/docs/Model/WebButton.md b/docs/Model/WebButton.md index 6c5465d..2c54a50 100644 --- a/docs/Model/WebButton.md +++ b/docs/Model/WebButton.md @@ -9,4 +9,4 @@ Name | Type | Description | Notes **icon** | **string** | | [optional] **url** | **string** | | [optional] -[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)