q-delivery/lf-api

2.6.2 2021-10-19 07:37 UTC

README

使用说明

设置

use Gansel\LF\Api\FallApi;
use Symfony\Component\HttpClient\HttpClient;

$baseUri = 'https://....';
$username = '...';
$password = '...';

$client = HttpClient::create([
    'auth_basic' => [$username, $password],
    'max_duration' => 0,
]);

$fallApi = new FallApi($baseUri, $client);

创建Fall

use Gansel\LF\Api\FallApi;

$fallApi = new FallApi(/* ... */);
$fallApi->create($payload);

获取Fall

use Gansel\LF\Api\Domain\Value\Fall\FallUuid;
use Gansel\LF\Api\FallApi;

$fallApi = new FallApi(/* ... */);

$fallApi->get(
    FallUuid::fromString('123-456-789'), // the Fall UUID
);

更新Fall

仅在调用转换之前有效!

use Gansel\LF\Api\Domain\Value\Fall\FallUuid;
use Gansel\LF\Api\FallApi;

$fallApi = new FallApi(/* ... */);

$fallApi->update(
    FallUuid::fromString('123-456-789'), // the Fall UUID
    [
        'field' => 'value',
        // ...
    ]
);

设置Leadsale值

use Gansel\LF\Api\Domain\Value\Fall\FallUuid;
use Gansel\LF\Api\FallApi;

$fallApi = new FallApi(/* ... */);

$now = new DateTime();

$fallApi->updateLeadsaleValues(
    FallUuid::fromString('123-456-789'), // the Fall UUID
    true, // or false, the decision by the User
    $now, // a \DateTimeInterface, when the decision was made by the user
    'Please contact him on monday 6pm', // a string, when is the best time to contact the user, or null
    '030 / 123456789', // a string, with a local phone number, or null
    '0175 / 123456789', // a string, with a mobile phone number, or null
);

上传文件到Fall

use Gansel\LF\Api\Domain\Value\Fall\FallUuid;
use Gansel\LF\Api\FallApi;

$fallApi = new FallApi(/* ... */);

$fallApi->uploadFile(
    FallUuid::fromString('123-456-789'), // the Fall UUID
    '/var/test/testfile.txt',            // use the absolute filepath
    'Fahrzeugschein',                    // a prefix which can be added to the filename
    false                                // wether this file should be marked as new in LF or not
);

应用转换

use Gansel\LF\Api\Domain\Value\Fall\FallUuid;
use Gansel\LF\Api\FallApi;

$fallApi = new FallApi(/* ... */);

$fallApi->applyTransition(
    FallUuid::fromString('123-456-789'), // the Fall UUID
    'einreichen'                         // the transition which should be applied
);

注意

create()get() 已经返回一个 FallUuid,可用于上传文件或应用转换!