CustomersRelationsApi.md

Jalismrs\Stalactite\Client\Data\CustomersRelationsApi

All URIs are relative to https://stalactite.jalis.pro/data, except if the operation defines another base path.

Method	HTTP request	Description
getCustomerRelations()	GET /customers/{uid}/relations
getMyCustomerRelations()	GET /customers/me/relations

getCustomerRelations()

getCustomerRelations($uid): \Jalismrs\Stalactite\Client\Data\Model\DomainCustomerRelation[]

Get customer relations based on its uid

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: StalactiteToken
$config = Jalismrs\Stalactite\Client\Data\Configuration::getDefaultConfiguration()->setApiKey('X-API-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Jalismrs\Stalactite\Client\Data\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-TOKEN', 'Bearer');


$apiInstance = new Jalismrs\Stalactite\Client\Data\Api\CustomersRelationsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$uid = 'uid_example'; // string

try {
    $result = $apiInstance->getCustomerRelations($uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersRelationsApi->getCustomerRelations: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
uid	string

Return type

\Jalismrs\Stalactite\Client\Data\Model\DomainCustomerRelation[]

Authorization

StalactiteToken

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMyCustomerRelations()

getMyCustomerRelations(): \Jalismrs\Stalactite\Client\Data\Model\DomainCustomerRelation[]

Get my customer relations

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: StalactiteToken
$config = Jalismrs\Stalactite\Client\Data\Configuration::getDefaultConfiguration()->setApiKey('X-API-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Jalismrs\Stalactite\Client\Data\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-TOKEN', 'Bearer');


$apiInstance = new Jalismrs\Stalactite\Client\Data\Api\CustomersRelationsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getMyCustomerRelations();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersRelationsApi->getMyCustomerRelations: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\Jalismrs\Stalactite\Client\Data\Model\DomainCustomerRelation[]

Authorization

StalactiteToken

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]