{"id":19251033,"url":"https://github.com/onesignal/onesignal-php-api","last_synced_at":"2025-04-06T11:07:34.326Z","repository":{"id":63683922,"uuid":"523894109","full_name":"OneSignal/onesignal-php-api","owner":"OneSignal","description":"The official OneSignal API client for PHP","archived":false,"fork":false,"pushed_at":"2025-03-26T17:16:28.000Z","size":277,"stargazers_count":25,"open_issues_count":5,"forks_count":11,"subscribers_count":31,"default_branch":"main","last_synced_at":"2025-04-05T18:51:41.590Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OneSignal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-11T23:14:04.000Z","updated_at":"2025-03-18T15:07:07.000Z","dependencies_parsed_at":"2025-03-02T08:10:36.670Z","dependency_job_id":"d229ea35-d483-4414-bfed-b0d6c1bd7dbe","html_url":"https://github.com/OneSignal/onesignal-php-api","commit_stats":{"total_commits":11,"total_committers":3,"mean_commits":"3.6666666666666665","dds":"0.18181818181818177","last_synced_commit":"b059f11f58990a6b204b207f79ae9955e57aaaab"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OneSignal%2Fonesignal-php-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OneSignal%2Fonesignal-php-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OneSignal%2Fonesignal-php-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OneSignal%2Fonesignal-php-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OneSignal","download_url":"https://codeload.github.com/OneSignal/onesignal-php-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247471517,"owners_count":20944158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T18:19:41.873Z","updated_at":"2025-04-06T11:07:34.310Z","avatar_url":"https://github.com/OneSignal.png","language":"PHP","readme":"# OneSignal\n\nA powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com\n\nFor more information, please visit [https://onesignal.com](https://onesignal.com).\n\n## Installation \u0026 Usage\n\n### Requirements\n\nPHP 7.3 and later.\n\n### Composer\n\nTo install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:\n\n```json\n{\n  \"repositories\": [\n    {\n      \"type\": \"vcs\",\n      \"url\": \"https://github.com/OneSignal/onesignal-php-api.git\"\n    }\n  ],\n  \"require\": {\n    \"OneSignal/onesignal-php-api\": \"*@dev\"\n  }\n}\n```\n\nThen run `composer install`\n\n\n## Usage examples\n### Imports\n```php\nuse DateTime;\nuse onesignal\\client\\api\\DefaultApi;\nuse onesignal\\client\\Configuration;\nuse onesignal\\client\\model\\GetNotificationRequestBody;\nuse onesignal\\client\\model\\Notification;\nuse onesignal\\client\\model\\StringMap;\nuse onesignal\\client\\model\\Player;\nuse onesignal\\client\\model\\UpdatePlayerTagsRequestBody;\nuse onesignal\\client\\model\\ExportPlayersRequestBody;\nuse onesignal\\client\\model\\Segment;\nuse onesignal\\client\\model\\FilterExpressions;\nuse PHPUnit\\Framework\\TestCase;\nuse GuzzleHttp;\n```\n\n### Constants\n```php\nconst APP_ID = '\u003cYOUR_APP_ID\u003e';\nconst APP_KEY_TOKEN = '\u003cYOUR_APP_KEY_TOKEN\u003e';\nconst USER_KEY_TOKEN = '\u003cYOUR_USER_KEY_TOKEN\u003e';\n```\n\n### Configure authorization\n```php\n$config = Configuration::getDefaultConfiguration()\n    -\u003esetAppKeyToken(APP_KEY_TOKEN)\n    -\u003esetUserKeyToken(USER_KEY_TOKEN);\n\n$apiInstance = new DefaultApi(\n    new GuzzleHttp\\Client(),\n    $config\n);\n```\n\n## Notifications\n### Creating a notification model\n```php\nfunction createNotification($enContent): Notification {\n    $content = new StringMap();\n    $content-\u003esetEn($enContent);\n\n    $notification = new Notification();\n    $notification-\u003esetAppId(APP_ID);\n    $notification-\u003esetContents($content);\n    $notification-\u003esetIncludedSegments(['Subscribed Users']);\n\n    return $notification;\n}\n```\n\n### Sending a notification immediately\n```php\n$notification = createNotification('PHP Test notification');\n\n$result = $apiInstance-\u003ecreateNotification($notification);\nprint_r($result);\n```\n\n### Scheduling a notification to be sent in 24 hours\n```php\n$notification = self::createNotification('PHP Test scheduled notification');\n$dt = new DateTime();\n$dt-\u003emodify('+1 day');\n$notification-\u003esetSendAfter($dt);\n\n$scheduledNotification = $apiInstance-\u003ecreateNotification($notification);\nprint_r($scheduledNotification);\n```\n\n### Sending a notification using Filters\nSend this notification only to the users that have not spent any USD on IAP.\n```php\n$notification = createNotification('PHP Test filtered notification');\n$filter1 = new Filter();\n$filter1-\u003esetField('amount_spent');\n$filter1-\u003esetRelation('=');\n$filter1-\u003esetValue('0');\n$notification-\u003esetFilters([$filter1]);\n$result = $apiInstance-\u003ecreateNotification($notification);\nprint_r($result);\n```\n\n### Sending a notification immediately\n```php\n$notification = createNotification('PHP Test notification');\n\n$result = $apiInstance-\u003ecreateNotification($notification);\nprint_r($result);\n```\n\n### Retrieving a notification\n```php\n$scheduledNotification = $apiInstance-\u003egetNotification(APP_ID, $scheduledNotification-\u003egetId());\nprint_r($scheduledNotification);\n```\n\n### Listing notifications by application ID\n```php\n$getResult = $apiInstance-\u003egetNotifications(APP_ID);\nprint_r($getResult-\u003egetNotifications());\n```\n\n### Getting notification history\n```php\n$requestBody = new GetNotificationRequestBody();\n$requestBody\n    -\u003esetAppId(APP_ID)\n    -\u003esetEvents('sent');\n\n$getResult = $apiInstance-\u003egetNotificationHistory($scheduledNotification-\u003egetId(), $requestBody);\nprint_r($getResult-\u003egetSuccess());\n```\n\n## Players\n### Creating a new Player model\n```php\nfunction createPlayerModel($playerId): Player {\n    $player = new Player();\n\n    $player-\u003esetAppId(APP_ID);\n    $player-\u003esetIdentifier($playerId);\n    $player-\u003esetDeviceType(1);\n\n    return $player;\n}\n```\n\n### Creating a Player\n```php\n$player = createPlayerModel('php_test_player_id');\n$createPlayerResult = $apiInstance-\u003ecreatePlayer($player);\nprint_r($createPlayerResult);\n```\n\n### Getting a Player\n```php\n$getPlayerResult = $apiInstance-\u003egetPlayer(APP_ID, 'php_test_player_id');\nprint_r($getPlayerResult);\n```\n\n### Getting a list of Players\n```php\n$limit = 10;\n$getPlayersResult = $apiInstance-\u003egetPlayers(APP_ID, $limit);\nprint_r($getPlayersResult-\u003egetPlayers());\n```\n\n### Deleting a player\n```php\n$deletePlayerResult = $apiInstance-\u003edeletePlayer(APP_ID, 'php_test_player_id');\nprint_r($deletePlayerResult-\u003egetSuccess());\n```\n\n### Exporting players into CSV-spreadsheet\n```php\n$exportPlayersRequestBody = new ExportPlayersRequestBody();\n$exportPlayersRequestBody-\u003esetExtraFields([]);\n$exportPlayersRequestBody-\u003esetSegmentName('');\n\n$exportPlayersResult =  $apiInstance-\u003eexportPlayers(APP_ID, $exportPlayersRequestBody);\nprint_r($exportPlayersResult-\u003egetCsvFileUrl());\n```\n\n## Segments\n### Creating a segment\n```php\n// Settings up the filter. Filters determine a segment.\n$filterExpressions = new FilterExpressions();\n$filterExpressions-\u003esetField('session_count');\n$filterExpressions-\u003esetRelation('\u003e');\n$filterExpressions-\u003esetValue('1');\n```\n\n### Setting up the segment itself\n```php\n$segment = new Segment();\n$segment-\u003esetName('test_segment_name');\n$segment-\u003esetFilters([$filterExpressions]);\n\n$createSegmentResponse = $apiInstance-\u003ecreateSegments(APP_ID, $segment);\nprint_r($createSegmentResponse);\n```\n\n### Deleting a segment\n```php\n$deleteSegmentResponse = $apiInstance-\u003edeleteSegments(APP_ID, $createSegmentResponse-\u003egetId());\nprint_r($deleteSegmentResponse-\u003egetSuccess());\n```\n\n## Working with Apps\n### Getting an app\n```php\n$getAppResponse = $apiInstance-\u003egetApp(APP_ID);\nprint_r($getAppResponse);\n```\n\n### Getting a list of apps\n```php\n$getAppsResponse = $apiInstance-\u003egetApps();\nprint_r($getAppsResponse);\n```\n\n### Updating an app\n```php\n$getAppResponse = $apiInstance-\u003egetApp(APP_ID);\n$getAppResponse-\u003esetName('php_test_app_name');\n$updateAppResponse = $apiInstance-\u003eupdateApp(APP_ID, $getAppResponse);\nprint_r($updateAppResponse);\n```\n\n### Outcomes\n```php\n$outcomeNames = \"os__session_duration.count,os__click.count\";\n$outcomeTimeRange = \"1d\";\n$outcomePlatforms = \"5\";\n$outcomeAttribution = \"direct\";\n$outcomesResponse = $apiInstance-\u003egetOutcomes(APP_ID, $outcomeNames, null, $outcomeTimeRange, $outcomePlatforms, $outcomeAttribution);\nprint_r($outcomesResponse-\u003egetOutcomes());\n```\n\n## Live Activities\n### Begin Live Activity\n```php\n$activityId = \"activity_id_example\";\n$beginLiveActivityRequest = new BeginLiveActivityRequest(array(\n    'push_token' =\u003e \"push_token_example\",\n    'subscription_id' =\u003e \"player_id_example\"\n));\n\nself::$apiInstance-\u003ebeginLiveActivity(APP_ID, $activityId, $beginLiveActivityRequest);\n```\n\n### Update Live Activity\n```php\n$activityId = \"activity_id_example\";\n$updateLiveActivityRequest = new UpdateLiveActivityRequest(array(\n    'event' =\u003e 'update',\n    'name' =\u003e 'contents',\n    'event_updates' =\u003e array('data' =\u003e 'test')\n));\n\nself::$apiInstance-\u003eupdateLiveActivity(APP_ID, $activityId, $updateLiveActivityRequest);\n```\n\n### End Live Activity\n```php\n$activityId = \"activity_id_example\";\n$subscriptionId = \"player_id_example\";\nself::$apiInstance-\u003eendLiveActivity(APP_ID, $activityId, $subscriptionId);\n```\n\n## Users\n### Creating a user\n```php\n// Create user model\n$user = new User();\n$aliasLabel = '\u003cALIAS_LABEL\u003e';\n$aliasId = '\u003cALIAS_ID\u003e';\n$pushToken = '\u003cDEVICE_PUSH_TOKEN\u003e';\n\n$subscriptionObject = new SubscriptionObject();\n$subscriptionObject-\u003esetType('iOSPush');\n$subscriptionObject-\u003esetToken($pushToken);\n\n$user-\u003esetIdentity(array($aliasLabel =\u003e $aliasId));\n$user-\u003esetSubscriptions([$subscriptionObject]);\n\n// Send model to API\n$createUserResponse = self::$apiInstance-\u003ecreateUser(APP_ID, $user);\n```\n\n### Fetch user by an alias\n```php\n$fetchUserResponse = self::$apiInstance-\u003efetchUser(APP_ID, $aliasLabel, $aliasId);\n```\n\n### Update user\n```php\n$updateUserRequest = new UpdateUserRequest(array(\n    'properties' =\u003e array(\n        'language' =\u003e 'fr'\n    ))\n);\n\n$updateUserResponse = self::$apiInstance-\u003eupdateUser(APP_ID, $aliasLabel, $aliasId, $updateUserRequest);\n```\n\n### Delete user\n```php\nself::$apiInstance-\u003edeleteUser(APP_ID, $aliasLabel, $aliasId);\n```\n\n### Create subscription\n```php\n$createSubscriptionRequestBody = new CreateSubscriptionRequestBody();\n$subscriptionObject = new SubscriptionObject();\n$subscriptionObject-\u003esetType('AndroidPush');\n$subscriptionObject-\u003esetToken('DEVICE_PUSH_TOKEN');\n$createSubscriptionRequestBody-\u003esetSubscription($subscriptionObject);\n\n$createSubscriptionResponse =\n    self::$apiInstance-\u003ecreateSubscription(APP_ID, $aliasLabel, $aliasId, $createSubscriptionRequestBody);\n```\n\n### Update subscription\n```php\n$updateSubscriptionRequestBody = new UpdateSubscriptionRequestBody();\n$subscriptionObject = new SubscriptionObject();\n$subscriptionObject-\u003esetType('AndroidPush');\n$subscriptionObject-\u003esetToken('DEVICE_PUSH_TOKEN'\n$updateSubscriptionRequestBody-\u003esetSubscription($subscriptionObject);\n\nself::$apiInstance-\u003eupdateSubscription(APP_ID, $subscriptionId, $updateSubscriptionRequestBody);\n```\n\n### Delete subscription\n```php\nself::$apiInstance-\u003edeleteSubscription(APP_ID, '\u003cSUBSCRIPTION_ID\u003e');\n```\n### Delete Alias\n```php\nself::$apiInstance-\u003edeleteAlias(APP_ID, '\u003cALIAS_LABEL\u003e', '\u003cALIAS_ID\u003e', '\u003cALIAS_LABEL_TO_DELETE\u003e');\n```\n\n### Fetch aliases by subscription id\n```php\n$fetchAliasesResponse = self::$apiInstance-\u003efetchAliases(APP_ID, '\u003cSUBSCRIPTION_ID\u003e');\n```\n\n### Fetch aliases by another alias\n```php\n$fetchAliasesResponse = self::$apiInstance-\u003efetchUserIdentity(APP_ID, '\u003cALIAS_LABEL\u003e', '\u003cALIAS_ID\u003e');\n```\n\n### Identify user by subscription id\n```php\n$userIdentityRequestBody = new UserIdentityRequestBody();\n\n$userIdentityRequestBody-\u003esetIdentity(array(\n    '\u003cNEW_ALIAS_LABEL\u003e' =\u003e '\u003cNEW_ALIAS_ID\u003e'\n));\n\n// Act\n$fetchAliasesResponse = self::$apiInstance-\u003eidentifyUserBySubscriptionId(\n    APP_ID, '\u003cSUBSCRIPTION_ID\u003e', $userIdentityRequestBody);\n```\n\n### Identify user by another alias\n```php\n$userIdentityRequestBody = new UserIdentityRequestBody();\n\n$userIdentityRequestBody-\u003esetIdentity(array(\n    '\u003cNEW_ALIAS_LABEL\u003e' =\u003e '\u003cNEW_ALIAS_ID\u003e'\n));\n\n// Act\n$fetchAliasesResponse = self::$apiInstance-\u003eidentifyUserByAlias(\n    APP_ID, '\u003cALIAS_LABEL\u003e', '\u003cALIAS_ID\u003e', $userIdentityRequestBody);\n```\n\n\n### Transfer subscription to another user\n```php\n$transferSubscriptionRequestBody = new TransferSubscriptionRequestBody();\n$transferSubscriptionRequestBody-\u003esetIdentity(array('\u003cUSER_FROM_ALIAS_LABEL\u003e' =\u003e '\u003cUSER_FROM_ALIAS_ID\u003e'));\n\n// Act\n$transferSubscriptionResponse = self::$apiInstance-\u003etransferSubscription(\n    APP_ID, '\u003cUSER_TO_SUBSCRIPTION_ID\u003e', $transferSubscriptionRequestBody);\n```\n\n### Fetch in app messages\n```php\n$getEligibleIamsResponse = self::$apiInstance-\u003egetEligibleIams(APP_ID, '\u003cSUBSCRIPTION_ID\u003e');\n```\n\n## API Endpoints\n\nAll URIs are relative to *https://api.onesignal.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**beginLiveActivity**](docs/Api/DefaultApi.md#beginliveactivity) | **POST** /apps/{app_id}/live_activities/{activity_id}/token | Start Live Activity\n*DefaultApi* | [**cancelNotification**](docs/Api/DefaultApi.md#cancelnotification) | **DELETE** /notifications/{notification_id} | Stop a scheduled or currently outgoing notification\n*DefaultApi* | [**createApp**](docs/Api/DefaultApi.md#createapp) | **POST** /apps | Create an app\n*DefaultApi* | [**createNotification**](docs/Api/DefaultApi.md#createnotification) | **POST** /notifications | Create notification\n*DefaultApi* | [**createPlayer**](docs/Api/DefaultApi.md#createplayer) | **POST** /players | Add a device\n*DefaultApi* | [**createSegments**](docs/Api/DefaultApi.md#createsegments) | **POST** /apps/{app_id}/segments | Create Segments\n*DefaultApi* | [**createSubscription**](docs/Api/DefaultApi.md#createsubscription) | **POST** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions | \n*DefaultApi* | [**createUser**](docs/Api/DefaultApi.md#createuser) | **POST** /apps/{app_id}/users | \n*DefaultApi* | [**deleteAlias**](docs/Api/DefaultApi.md#deletealias) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} | \n*DefaultApi* | [**deletePlayer**](docs/Api/DefaultApi.md#deleteplayer) | **DELETE** /players/{player_id} | Delete a user record\n*DefaultApi* | [**deleteSegments**](docs/Api/DefaultApi.md#deletesegments) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segments\n*DefaultApi* | [**deleteSubscription**](docs/Api/DefaultApi.md#deletesubscription) | **DELETE** /apps/{app_id}/subscriptions/{subscription_id} | \n*DefaultApi* | [**deleteUser**](docs/Api/DefaultApi.md#deleteuser) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id} | \n*DefaultApi* | [**endLiveActivity**](docs/Api/DefaultApi.md#endliveactivity) | **DELETE** /apps/{app_id}/live_activities/{activity_id}/token/{subscription_id} | Stop Live Activity\n*DefaultApi* | [**exportEvents**](docs/Api/DefaultApi.md#exportevents) | **POST** /notifications/{notification_id}/export_events?app_id\u0026#x3D;{app_id} | Export CSV of Events\n*DefaultApi* | [**exportPlayers**](docs/Api/DefaultApi.md#exportplayers) | **POST** /players/csv_export?app_id\u0026#x3D;{app_id} | Export CSV of Players\n*DefaultApi* | [**fetchAliases**](docs/Api/DefaultApi.md#fetchaliases) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity | \n*DefaultApi* | [**fetchUser**](docs/Api/DefaultApi.md#fetchuser) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} | \n*DefaultApi* | [**fetchUserIdentity**](docs/Api/DefaultApi.md#fetchuseridentity) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity | \n*DefaultApi* | [**getApp**](docs/Api/DefaultApi.md#getapp) | **GET** /apps/{app_id} | View an app\n*DefaultApi* | [**getApps**](docs/Api/DefaultApi.md#getapps) | **GET** /apps | View apps\n*DefaultApi* | [**getEligibleIams**](docs/Api/DefaultApi.md#geteligibleiams) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/iams | \n*DefaultApi* | [**getNotification**](docs/Api/DefaultApi.md#getnotification) | **GET** /notifications/{notification_id} | View notification\n*DefaultApi* | [**getNotificationHistory**](docs/Api/DefaultApi.md#getnotificationhistory) | **POST** /notifications/{notification_id}/history | Notification History\n*DefaultApi* | [**getNotifications**](docs/Api/DefaultApi.md#getnotifications) | **GET** /notifications | View notifications\n*DefaultApi* | [**getOutcomes**](docs/Api/DefaultApi.md#getoutcomes) | **GET** /apps/{app_id}/outcomes | View Outcomes\n*DefaultApi* | [**getPlayer**](docs/Api/DefaultApi.md#getplayer) | **GET** /players/{player_id} | View device\n*DefaultApi* | [**getPlayers**](docs/Api/DefaultApi.md#getplayers) | **GET** /players | View devices\n*DefaultApi* | [**identifyUserByAlias**](docs/Api/DefaultApi.md#identifyuserbyalias) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity | \n*DefaultApi* | [**identifyUserBySubscriptionId**](docs/Api/DefaultApi.md#identifyuserbysubscriptionid) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity | \n*DefaultApi* | [**transferSubscription**](docs/Api/DefaultApi.md#transfersubscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/owner | \n*DefaultApi* | [**updateApp**](docs/Api/DefaultApi.md#updateapp) | **PUT** /apps/{app_id} | Update an app\n*DefaultApi* | [**updateLiveActivity**](docs/Api/DefaultApi.md#updateliveactivity) | **POST** /apps/{app_id}/live_activities/{activity_id}/notifications | Update a Live Activity via Push\n*DefaultApi* | [**updatePlayer**](docs/Api/DefaultApi.md#updateplayer) | **PUT** /players/{player_id} | Edit device\n*DefaultApi* | [**updatePlayerTags**](docs/Api/DefaultApi.md#updateplayertags) | **PUT** /apps/{app_id}/users/{external_user_id} | Edit tags with external user id\n*DefaultApi* | [**updateSubscription**](docs/Api/DefaultApi.md#updatesubscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id} | \n*DefaultApi* | [**updateUser**](docs/Api/DefaultApi.md#updateuser) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id} | \n\n## Models\n\n- [App](docs/Model/App.md)\n- [BasicNotification](docs/Model/BasicNotification.md)\n- [BasicNotificationAllOf](docs/Model/BasicNotificationAllOf.md)\n- [BasicNotificationAllOfAndroidBackgroundLayout](docs/Model/BasicNotificationAllOfAndroidBackgroundLayout.md)\n- [BeginLiveActivityRequest](docs/Model/BeginLiveActivityRequest.md)\n- [Button](docs/Model/Button.md)\n- [CancelNotificationSuccessResponse](docs/Model/CancelNotificationSuccessResponse.md)\n- [CreateNotificationSuccessResponse](docs/Model/CreateNotificationSuccessResponse.md)\n- [CreatePlayerSuccessResponse](docs/Model/CreatePlayerSuccessResponse.md)\n- [CreateSegmentConflictResponse](docs/Model/CreateSegmentConflictResponse.md)\n- [CreateSegmentSuccessResponse](docs/Model/CreateSegmentSuccessResponse.md)\n- [CreateSubscriptionRequestBody](docs/Model/CreateSubscriptionRequestBody.md)\n- [CreateUserConflictResponse](docs/Model/CreateUserConflictResponse.md)\n- [CreateUserConflictResponseErrorsInner](docs/Model/CreateUserConflictResponseErrorsInner.md)\n- [CreateUserConflictResponseErrorsItemsMeta](docs/Model/CreateUserConflictResponseErrorsItemsMeta.md)\n- [DeletePlayerNotFoundResponse](docs/Model/DeletePlayerNotFoundResponse.md)\n- [DeletePlayerSuccessResponse](docs/Model/DeletePlayerSuccessResponse.md)\n- [DeleteSegmentNotFoundResponse](docs/Model/DeleteSegmentNotFoundResponse.md)\n- [DeleteSegmentSuccessResponse](docs/Model/DeleteSegmentSuccessResponse.md)\n- [DeliveryData](docs/Model/DeliveryData.md)\n- [ExportEventsSuccessResponse](docs/Model/ExportEventsSuccessResponse.md)\n- [ExportPlayersRequestBody](docs/Model/ExportPlayersRequestBody.md)\n- [ExportPlayersSuccessResponse](docs/Model/ExportPlayersSuccessResponse.md)\n- [Filter](docs/Model/Filter.md)\n- [FilterExpressions](docs/Model/FilterExpressions.md)\n- [GenericError](docs/Model/GenericError.md)\n- [GenericErrorErrorsInner](docs/Model/GenericErrorErrorsInner.md)\n- [GetNotificationRequestBody](docs/Model/GetNotificationRequestBody.md)\n- [InlineResponse200](docs/Model/InlineResponse200.md)\n- [InlineResponse2003](docs/Model/InlineResponse2003.md)\n- [InlineResponse201](docs/Model/InlineResponse201.md)\n- [InlineResponse202](docs/Model/InlineResponse202.md)\n- [InvalidIdentifierError](docs/Model/InvalidIdentifierError.md)\n- [Notification](docs/Model/Notification.md)\n- [Notification200Errors](docs/Model/Notification200Errors.md)\n- [NotificationAllOf](docs/Model/NotificationAllOf.md)\n- [NotificationHistorySuccessResponse](docs/Model/NotificationHistorySuccessResponse.md)\n- [NotificationSlice](docs/Model/NotificationSlice.md)\n- [NotificationTarget](docs/Model/NotificationTarget.md)\n- [NotificationWithMeta](docs/Model/NotificationWithMeta.md)\n- [NotificationWithMetaAllOf](docs/Model/NotificationWithMetaAllOf.md)\n- [Operator](docs/Model/Operator.md)\n- [OutcomeData](docs/Model/OutcomeData.md)\n- [OutcomesData](docs/Model/OutcomesData.md)\n- [PlatformDeliveryData](docs/Model/PlatformDeliveryData.md)\n- [PlatformDeliveryDataEmailAllOf](docs/Model/PlatformDeliveryDataEmailAllOf.md)\n- [PlatformDeliveryDataSmsAllOf](docs/Model/PlatformDeliveryDataSmsAllOf.md)\n- [Player](docs/Model/Player.md)\n- [PlayerNotificationTarget](docs/Model/PlayerNotificationTarget.md)\n- [PlayerNotificationTargetIncludeAliases](docs/Model/PlayerNotificationTargetIncludeAliases.md)\n- [PlayerSlice](docs/Model/PlayerSlice.md)\n- [PropertiesDeltas](docs/Model/PropertiesDeltas.md)\n- [PropertiesObject](docs/Model/PropertiesObject.md)\n- [Purchase](docs/Model/Purchase.md)\n- [RateLimiterError](docs/Model/RateLimiterError.md)\n- [Segment](docs/Model/Segment.md)\n- [SegmentNotificationTarget](docs/Model/SegmentNotificationTarget.md)\n- [StringMap](docs/Model/StringMap.md)\n- [SubscriptionObject](docs/Model/SubscriptionObject.md)\n- [TransferSubscriptionRequestBody](docs/Model/TransferSubscriptionRequestBody.md)\n- [UpdateLiveActivityRequest](docs/Model/UpdateLiveActivityRequest.md)\n- [UpdateLiveActivitySuccessResponse](docs/Model/UpdateLiveActivitySuccessResponse.md)\n- [UpdatePlayerSuccessResponse](docs/Model/UpdatePlayerSuccessResponse.md)\n- [UpdatePlayerTagsRequestBody](docs/Model/UpdatePlayerTagsRequestBody.md)\n- [UpdatePlayerTagsSuccessResponse](docs/Model/UpdatePlayerTagsSuccessResponse.md)\n- [UpdateSubscriptionRequestBody](docs/Model/UpdateSubscriptionRequestBody.md)\n- [UpdateUserRequest](docs/Model/UpdateUserRequest.md)\n- [User](docs/Model/User.md)\n- [UserIdentityRequestBody](docs/Model/UserIdentityRequestBody.md)\n- [UserIdentityResponse](docs/Model/UserIdentityResponse.md)\n- [UserSubscriptionOptions](docs/Model/UserSubscriptionOptions.md)\n\n## Authorization\nAll the OneSignal endpoints require either an *app_key* or *user_key* tokens for authorization. It is recommended to\nset up both of those keys during the initial config initialization so that you don't need to worry about which endpoint\nrequires app_key and which user_key. You can get the value of these keys from your\n[app dashboard]([https://app.onesignal.com/apps]) and [user settings](https://app.onesignal.com/profile) pages.\n\n\n\n### app_key\n\n- **Type**: Bearer authentication\n\n\n### user_key\n\n- **Type**: Bearer authentication\n\n\n## Author\n\ndevrel@onesignal.com\n\n\n- API version: `1.4.0`\n    - Package version: `2.2.0`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonesignal%2Fonesignal-php-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonesignal%2Fonesignal-php-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonesignal%2Fonesignal-php-api/lists"}