qqzii/map-client

PHP client for MAP API

Maintainers

Details

github.com/qqzii/map-client

Source

Issues

Installs: 3

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

pkg:composer/qqzii/map-client

1.1.0 2025-04-29 11:56 UTC

Requires

MIT e1bef5a38220cedc8de8661abc05f9d4211e8d14

  • Marozau Artsemi <a.morozov.woop@naveksoft.com>

This package is not auto-updated.

Last update: 2025-12-24 17:59:57 UTC

README

Installation

Install the latest version with

composer require qqzii/map-client

Basic Usage

Init config file map.php with simple structure

[
    'url' => 'your.map.url',
    'api_version' => 'v1',
    'auth' => [
        'login' => 'your_login',
        'secret' => 'your_secret_key',
    ],
    'logger' => [
        'name' => 'name_of_your_logger',
        'filepath' => 'path/to/your/logger/file.log',
    ],
];

Basic way of interaction

$mapService = new MapService(config('map'));

$indexQueryParamsExample = [
    'per_page' => 10,
    'page' => 1,
    'with' => ['topics'],
    'filters' => ['first_name' => 'Olivia']
];

$mapService->getCustomers($indexQueryParamsExample)

Available methods for interactions with MAP

  • Actions with customers

public function getCustomers(array $queryParams = []): array
public function getCustomer(string $customerId, array $queryParams = []): array
public function createCustomer(array $bodyArgs = []): array
public function updateCustomer(string $customerId, array $bodyArgs = []): array
public function deleteCustomer(string $customerId): array
public function initCustomerEvent(string $customerId, string $eventSlug, array $bodyArgs = []): array
public function attachCustomerToSegment(string $customerId, string $segmentId): array
public function detachCustomerFromSegment(string $customerId, string $segmentId): array

  • Actions with segments

public function getSegments(array $queryParams = []): array
public function getSegment(string $segmentId, array $queryParams = []): array
public function createSegment(array $bodyArgs = []): array
public function updateSegment(string $segmentId, array $bodyArgs = []): array
public function deleteSegment(string $segmentId): array

  • Actions with topics

public function getTopics(array $queryParams = []): array
public function getTopic(string $topicId, array $queryParams = []): array

  • Actions with messages

public function getMessages(array $queryParams = []): array
public function getMessage(string $messageId, array $queryParams = []): array
public function initMessageEvent(array $bodyArgs = []): array

  • Actions with devices

public function createDevice(array $bodyArgs = []): array
public function updateDevice(string $deviceId, array $bodyArgs = []): array