vitorbritto / gympass-sdk-php

轻松集成 Gympass 预订 API。

dev-master 2020-04-14 16:31 UTC

This package is auto-updated.

Last update: 2024-09-15 02:19:33 UTC


README

轻松集成 Gympass 预订 API。

安装

Gympass PHP SDK 可以通过 Composer 安装。运行以下命令:

composer require vitorbritto/gympass-sdk-php

用法

身份验证

为了设置身份验证和 API 客户端的初始化,您需要以下信息。

API 客户端可以按以下方式初始化。

$oAuthAccessToken = 'oAuthAccessToken'; // OAuth 2.0 Access Token

$client = new GympassAPILib\GympassAPIClient($oAuthAccessToken);

类参考

控制器列表

Class: ClassesController

获取单例实例

可以从 API 客户端访问 ClassesController 类的单例实例。

$classes = $client->getClasses();

Method: create

在给定的健身房创建一系列课程。

function create(
        $gymId,
        $payload)

参数

示例用法

$gymId = '1';
$payload = new Classes();

$result = $classes->create($gymId, $payload);

Method: mlist

获取给定健身房的课程列表。

function mlist($gymId)

参数

示例用法

$gymId = '1';

$result = $classes->mlist($gymId);

Method: getView

待办:添加方法描述

function getView(
        $gymId,
        $classId)

参数

示例用法

$gymId = '1';
$classId = '1';

$result = $classes->getView($gymId, $classId);

Method: update

待办:添加方法描述

function update(
        $gymId,
        $classId,
        $payload)

参数

示例用法

$gymId = '1';
$classId = '1';
$payload = new MClass();

$result = $classes->update($gymId, $classId, $payload);

返回控制器列表

Class: SlotsController

获取单例实例

可以从 API 客户端访问 SlotsController 类的单例实例。

$slots = $client->getSlots();

Method: create

待办:添加方法描述

function create(
        $gymId,
        $classId,
        $payload)

参数

示例用法

$gymId = '1';
$classId = '1';
$payload = new Slot();

$result = $slots->create($gymId, $classId, $payload);

方法: getView

待办:添加方法描述

function getView(
        $gymId,
        $classId,
        $slotId)

参数

示例用法

$gymId = '1';
$classId = '1';
$slotId = '1';

$result = $slots->getView($gymId, $classId, $slotId);

方法: mlist

待办:添加方法描述

function mlist(
        $gymId,
        $classId,
        $from,
        $to)

参数

示例用法

$gymId = '1';
$classId = '1';
$from = 'From';
$to = 'To';

$result = $slots->mlist($gymId, $classId, $from, $to);

方法: delete

待办:添加方法描述

function delete(
        $gymId,
        $classId,
        $slotId)

参数

示例用法

$gymId = '1';
$classId = '1';
$slotId = '1';

$slots->delete($gymId, $classId, $slotId);

方法: createPatch

待办:添加方法描述

function createPatch(
        $gymId,
        $classId,
        $slotId,
        $payload)

参数

示例用法

$gymId = '1';
$classId = '1';
$slotId = '1';
$payload = new SlotLimits();

$result = $slots->createPatch($gymId, $classId, $slotId, $payload);

方法: update

待办:添加方法描述

function update($payload)

参数

示例用法

$payload = new Slot();

$result = $slots->update($payload);

返回控制器列表

类: BookingsController

获取单例实例

可以通过API客户端访问BookingsController类的单例实例。

$bookings = $client->getBookings();

方法: update

待办:添加方法描述

function update(
        $gymId,
        $bookingNumber,
        $payload)

参数

示例用法

$gymId = '1';
$bookingNumber = '1';
$payload = new Booking();

$result = $bookings->update($gymId, $bookingNumber, $payload);

返回摘要