motion-php/client

API client written in PHP for Motion

1.0.0 2023-05-06 11:27 UTC

Requires

• php: ^8.1.0
• php-http/discovery: 1.x-dev
• psr/http-client: 1.0.x-dev
• psr/http-client-implementation: *
• psr/http-factory-implementation: *
• psr/http-message: 2.0.x-dev

Requires (Dev)

• guzzlehttp/guzzle: dev-master
• guzzlehttp/psr7: 2.6.x-dev
• laravel/pint: dev-main
• pestphp/pest: 2.x-dev
• pestphp/pest-plugin-mock: 2.x-dev
• phpstan/phpstan: 1.11.x-dev
• rector/rector: 0.15.x-dev
• symfony/var-dumper: 6.3.x-dev

MIT

• Adam Paterson

README

Motion PHP is a community maintained PHP API Client for interacting with Motion API. Motion is an excellent calendar and project management application which uses AI to reschedule your time effectively. If you haven't heard of it yet, check it out at usemotion.com.

Table of Contents

• Getting Started
• Usage
  • Tasks Resource
  • Recurring Tasks Resource
  • Workspaces Resource
  • Users Resource
  • Projects Resource
  • Schedules Resource
• Testing

Getting Started

Requires PHP 8.1+

Requires PSR-18 HTTP Client

Install the Motion PHP client using the Composer package manager:

composer require motion-php/client

Make sure the php-http/discovery composer plugin is allowed to run or install a PSR-18 HTTP Client implementation manually if your project does not already have one.

composer require guzzlehttp/guzzle

Then you are ready to interact with the Motion API. To get started quickly, you can use the Motion::client factory method to create a client instance.

$apiKey = getenv('YOUR_API_KEY');

$client = Motion::client($apiKey);

$result = $client->task()->create([
    'name' => 'My Task',
    'description' => 'My Task Description',
    'status' => 'Completed',
]);

echo $result['task']['name']; // My Task
echo $result['task']['description']; // My Task Description
echo $result['task']['status']; // Completed

It is possible if you require to configure and provide a separate HTTP client using the Motion::factory method.

$apiKey = getenv('YOUR_API_KEY');

// PSR-18 HTTP Client
$httpClient = new GuzzleHttp\Client([]);

$client = Motion::factory()
    ->withApiKey($apiKey)
    ->withBaseUri('api.usemotion.com')
    ->withHttpClient($httpClient)
    ->withHttpHeader('X-My-Header', 'foo')
    ->withQueryParam('foo', 'bar')
    ->withStreamHandler(fn (RequestInterface $request): ResponseInterface => $client->send($request, [
        'stream' => true
    ]))
    ->make();

Usage

Tasks resource

update a task

Updates a task with the given id and properties. Returns a Task object.

PATCH /tasks/{id}: 📖 Documentation

$response = $client->tasks()->update('IF0lK9JcsdaxeLkDZ0nMG', [
    'name' => 'My Task',
    'description' => 'My Task Description',
    'status' => 'Completed',
]);

$task = $response->task; // Task object

$task->id; // IF0lK9JcsdaxeLkDZ0nMG
$task->name; // My Task
$task->description; // My Task Description
$task->project; // Project object

$task->toArray(); // ['id' => 'IF0lK9JcsdaxeLkDZ0nMG', ...]

create a task

Creates a task with the given properties. Returns a Task object.

POST /tasks: 📖 Documentation

$response = $client->tasks()->create([
    'name' => 'My Task',
    'description' => 'My Task Description',
    'status' => 'Completed',
]);

$task = $response->task; // Task object

$task->id; // IF0lK9JcsdaxeLkDZ0nMG
$task->name; // My Task
$task->description; // My Task Description
$task->project; // Project object

$task->toArray(); // ['id' => 'IF0lK9JcsdaxeLkDZ0nMG', ...]

delete a task

Deletes a task with the given id. Returns a Task object.

DELETE /tasks/{id}: 📖 Documentation

$response = $client->tasks()->delete('IF0lK9JcsdaxeLkDZ0nMG');

retrieve a task

Retrieves a task with the given id. Returns a Task object.

GET /tasks/{id}: 📖 Documentation

$response = $client->tasks()->retrieve('IF0lK9JcsdaxeLkDZ0nMG');

$task = $response->task; // Task object

$task->id; // IF0lK9JcsdaxeLkDZ0nMG
$task->name; // My Task
$task->description; // My Task Description
$task->project; // Project object

$task->toArray(); // ['id' => 'IF0lK9JcsdaxeLkDZ0nMG', ...]

move task between workspaces

Moves a task with the given id to a new workspace with the given id. Returns a Task object.

POST /tasks/{id}/move: 📖 Documentation

$response = $client->tasks()->move('IF0lK9JcsdaxeLkDZ0nMG', 'IF0lK9JcsdaxeLkDZ0nMG');

$task = $response->task; // Task object

$task->id; // IF0lK9JcsdaxeLkDZ0nMG
$task->name; // My Task
$task->description; // My Task Description
$task->project; // Project object

$task->toArray(); // ['id' => 'IF0lK9JcsdaxeLkDZ0nMG', ...]

Recurring Tasks resource

create a recurring task

Creates a recurring task with the given properties. Returns a RecurringTask object.

POST /recurring-tasks: 📖 Documentation

$response = $client->recurringTasks()->create([
    'name' => 'My Task',
    'description' => 'My Task Description',
    'status' => 'Completed',
]);

$task = $response->task; // Task object

$task->id; // IF0lK9JcsdaxeLkDZ0nMG
$task->name; // My Task

list recurring tasks

Lists recurring tasks in a workspace. Returns an array of RecurringTask objects.

GET /recurring-tasks: 📖 Documentation

$response = $client->recurringTasks()->list('workspaceId');

$tasks = $response->tasks; // array of Task objects
$meta = $response->meta; // Meta object

foreach ($tasks as $task) {
    $task->id; // IF0lK9JcsdaxeLkDZ0nMG
    $task->name; // My Task
    $task->project; // Project object
}

$meta->pageSize; // 20
$meta->nextCursor; // IF0lK9JcsdaxeLkDZ0nMG

delete a recurring task

Deletes a recurring task with the given id. Returns an id string.

DELETE /recurring-tasks/{id}: 📖 Documentation

$response = $client->recurringTasks()->delete('IF0lK9JcsdaxeLkDZ0nMG');

Workspaces resource

list

Lists workspaces for an organization.

GET /workspaces: 📖 Documentation

$response = $client->workspaces()->list();

$response->workspaces; // array of Workspace objects

foreach ($response->workspaces as $workspace) {
    $workspace->id; // IF0lK9JcsdaxeLkDZ0nMG
    $workspace->name; // My Workspace
    $workspace->teamId; // 2f0lK9JcsdaxeLkDZ0nMG
    $workspace->statuses; // array of Status objects
    $workspace->labels; // array of Label objects
    $workspace->type; // INDIVIDUAL
}

$response->toArray(); // ['workspaces' => [...]]

statuses

List statuses for a workspace

$response = $client->workspaces()->statuses('IF0lK9JcsdaxeLkDZ0nMG');

$response->statuses; // array of Status objects

foreach ($response->statuses as $status) {
    $status->name; // In Progress
    $status->isDefaultStatus // true
    $status->isResolvedStatus // false
}

$response->toArray(); // ['statuses' => [...]]

Users Resource

list

Lists the currently available users. Can be limited by teamId or workspaceId.

$response = $client->users()->list([
    'workspaceId' => 'IF0lK9JcsdaxeLkDZ0nMG'
]);

$response->users; // array of User objects

foreach ($response->users as $user) {
    $user->id; // LPSIBmTN2eai9uYoKtMkzWVFTUo2
    $user->name; // Adam Paterson
    $user->email; // [e-mail]
}

$response->toArray(); // ['users' => [...]]

Testing

$ composer test

Mock mode

The client can be configured to run in mock mode. This will return mock responses for all requests. This is useful for testing. This can help with implementation without hitting the API and hitting rate limits.

$client = Motion::factory()
    ->withApiKey($apiKey)
    ->useMockMode(true)
    ->make();

$response = $client->tasks()->list();

$response->tasks; // array of Task objects