OneSignal\Devices

Complexity

Total Complexity

14

Size/Duplication

Total Lines	199
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getOne()	0	6	1
A	getAll()	0	17	3
A	add()	0	10	1
A	update()	0	10	1
A	delete()	0	7	1
A	onSession()	0	10	1
A	onPurchase()	0	10	1
A	onFocus()	0	10	1
A	csvExport()	0	20	3

<?php

declare(strict_types=1);

namespace OneSignal;

use OneSignal\Resolver\ResolverFactory;

class Devices extends AbstractApi
{
    public const IOS = 0;
    public const ANDROID = 1;
    public const AMAZON = 2;
    public const WINDOWS_PHONE = 3;
    public const WINDOWS_PHONE_MPNS = 3;
    public const CHROME_APP = 4;
    public const CHROME_WEB = 5;
    public const WINDOWS_PHONE_WNS = 6;
    public const SAFARI = 7;
    public const FIREFOX = 8;
    public const MACOS = 9;
    public const ALEXA = 10;
    public const EMAIL = 11;
    public const HUAWEI = 13;
    public const SMS = 14;

    private $resolverFactory;

    public function __construct(OneSignal $client, ResolverFactory $resolverFactory)
    {
        parent::__construct($client);

        $this->resolverFactory = $resolverFactory;
    }

    /**
     * Get information about device with provided ID.
     *
     * @param string $id Device ID
     */
    public function getOne(string $id): array
    {
        $request = $this->createRequest('GET', "/players/$id?app_id={$this->client->getConfig()->getApplicationId()}");

        return $this->client->sendRequest($request);
    }

    /**
     * Get information about all registered devices for your application.
     *
     * Application auth key must be set.
     *
     * @param int $limit  How many devices to return. Max is 300. Default is 300
     * @param int $offset Result offset. Default is 0. Results are sorted by id
     */
    public function getAll(int $limit = null, int $offset = null): array
    {
        $query = ['app_id' => $this->client->getConfig()->getApplicationId()];

        if ($limit !== null) {
            $query['limit'] = $limit;
        }

        if ($offset !== null) {
            $query['offset'] = $offset;
        }

        $request = $this->createRequest('GET', '/players?'.http_build_query($query));
        $request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");

        return $this->client->sendRequest($request);
    }

    /**
     * Register a device for your application.
     *
     * @param array $data Device data
     */
    public function add(array $data): array
    {
        $resolvedData = $this->resolverFactory->createNewDeviceResolver()->resolve($data);

        $request = $this->createRequest('POST', '/players');
        $request = $request->withHeader('Content-Type', 'application/json');
        $request = $request->withBody($this->createStream($resolvedData));

        return $this->client->sendRequest($request);
    }

    /**
     * Update existing registered device for your application with provided data.
     *
     * @param string $id   Device ID
     * @param array  $data New device data
     */
    public function update(string $id, array $data): array
    {
        $resolvedData = $this->resolverFactory->createExistingDeviceResolver()->resolve($data);

        $request = $this->createRequest('PUT', "/players/$id");
        $request = $request->withHeader('Content-Type', 'application/json');
        $request = $request->withBody($this->createStream($resolvedData));

        return $this->client->sendRequest($request);
    }

    /**
     * Delete existing registered device from your application.
     *
     * OneSignal supports DELETE on the players API endpoint which is not documented in their official documentation
     * Reference: https://documentation.onesignal.com/docs/handling-personal-data#section-deleting-users-or-other-data-from-onesignal
     *
     * Application auth key must be set.
     *
     * @param string $id Device ID
     */
    public function delete(string $id): array
    {
        $request = $this->createRequest('DELETE', "/players/$id?app_id={$this->client->getConfig()->getApplicationId()}");
        $request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");

        return $this->client->sendRequest($request);
    }

    /**
     * Call on new device session in your app.
     *
     * @param string $id   Device ID
     * @param array  $data Device data
     */
    public function onSession(string $id, array $data): array
    {
        $resolvedData = $this->resolverFactory->createDeviceSessionResolver()->resolve($data);

        $request = $this->createRequest('POST', "/players/$id/on_session");
        $request = $request->withHeader('Content-Type', 'application/json');
        $request = $request->withBody($this->createStream($resolvedData));

        return $this->client->sendRequest($request);
    }

    /**
     * Track a new purchase.
     *
     * @param string $id   Device ID
     * @param array  $data Device data
     */
    public function onPurchase(string $id, array $data): array
    {
        $resolvedData = $this->resolverFactory->createDevicePurchaseResolver()->resolve($data);

        $request = $this->createRequest('POST', "/players/$id/on_purchase");
        $request = $request->withHeader('Content-Type', 'application/json');
        $request = $request->withBody($this->createStream($resolvedData));

        return $this->client->sendRequest($request);
    }

    /**
     * Increment the device's total session length.
     *
     * @param string $id   Device ID
     * @param array  $data Device data
     */
    public function onFocus(string $id, array $data): array
    {
        $resolvedData = $this->resolverFactory->createDeviceFocusResolver()->resolve($data);

        $request = $this->createRequest('POST', "/players/$id/on_focus");
        $request = $request->withHeader('Content-Type', 'application/json');
        $request = $request->withBody($this->createStream($resolvedData));

        return $this->client->sendRequest($request);
    }

    /**
     * Export all information about devices in a CSV format for your application.
     *
     * Application auth key must be set.
     *
     * @param array  $extraFields     Additional fields that you wish to include.
     *                                Currently supports: "location", "country", "rooted"
     * @param string $segmentName     A segment name to filter the scv export by.
     *                                Only devices from that segment will make it into the export
     * @param int    $lastActiveSince An epoch to filter results to users active after this time
     */
    public function csvExport(array $extraFields = [], string $segmentName = null, int $lastActiveSince = null): array
    {
        $request = $this->createRequest('POST', "/players/csv_export?app_id={$this->client->getConfig()->getApplicationId()}");
        $request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");
        $request = $request->withHeader('Content-Type', 'application/json');

        $body = ['extra_fields' => $extraFields];

        if ($segmentName !== null) {
            $body['segment_name'] = $segmentName;
        }

        if ($lastActiveSince !== null) {
            $body['last_active_since'] = (string) $lastActiveSince;
        }

        $request = $request->withBody($this->createStream($body));

        return $this->client->sendRequest($request);
    }
}