README

yclients-openapi-php package for YCLIENTS generated based on the openapi schema

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/vgrish/yclients-openapi-php/"
    }
  ],
  "require": {
    "vgrish/yclients-openapi-php": "main"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/yclients-openapi-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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




$apiInstance = new Vgrish\YclientsOpenApi\Api\DefaultApi(
    // 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()
);
$accept = application/vnd.yclients.v2+json; // string | e.g. application/vnd.yclients.v2+json
$content_type = 'content_type_example'; // string | application/json
$authorization = Bearer {{partner_token}}; // string | Bearer partner_token
$auth_user_request = {"login":"{{login}}","password":"{{password}}"}; // \Vgrish\YclientsOpenApi\Model\AuthUserRequest

try {
    $result = $apiInstance->authUser($accept, $content_type, $authorization, $auth_user_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->authUser: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.yclients.com/api/v1

Class	Method	HTTP request	Description
DefaultApi	authUser	POST /auth	Авторизовать пользователя
DefaultApi	clientCreate	POST /clients/{company_id}	Добавить клиента
DefaultApi	clientGet	GET /client/{company_id}/{id}	Получить клиента
DefaultApi	clientGetList	POST /company/{company_id}/clients/search	Получить список клиентов
DefaultApi	clientRemove	DELETE /client/{company_id}/{id}	Удалить клиента
DefaultApi	clientUpdate	PUT /client/{company_id}/{id}	Редактировать клиента
DefaultApi	companyCreate	POST /companies	Создать компанию
DefaultApi	companyGet	GET /company/{id}/	Получить компанию
DefaultApi	companyGetList	GET /companies	Получить список компаний
DefaultApi	companyRemove	DELETE /company/{id}/	Удалить компанию
DefaultApi	companyUpdate	PUT /company/{id}/	Изменить компанию
DefaultApi	loyaltyCardByClientIdGetList	GET /loyalty/client_cards/{client_id}	Получить список карт клиента по ID
DefaultApi	loyaltyCardByClientPhoneGetList	GET /loyalty/cards/{phone}/{chain_id}/{company_id}	Получить список карт клиента по номеру телефона
DefaultApi	loyaltyCardCreate	POST /loyalty/cards/{company_id}	Выдать карту лояльности
DefaultApi	loyaltyCardRemove	DELETE /loyalty/cards/{company_id}/{card_id}	Удалить карту лояльности
DefaultApi	loyaltyCardTransactionCreate	POST /company/{company_id}/loyalty/cards/{card_id}/manual_transaction	Ручное списание/пополнение карты лояльности в компании
DefaultApi	loyaltyCardTypeByChainIdGetList	GET /chain/{chain_id}/loyalty/card_types	Получить список типов карт, доступных в сети
DefaultApi	loyaltyCardTypeByClientPhoneGetList	GET /loyalty/card_types/client/{company_id}/{phone}	Получить список типов карт доступных для выдачи клиенту
DefaultApi	loyaltyCardTypeByCompanyIdGetList	GET /loyalty/card_types/salon/{company_id}	Получить список типов карт доступных в филиале
DefaultApi	loyaltyTransactionGetList	GET /chain/{chain_id}/loyalty/transactions	Получить список транзакций лояльности в сети
AuthApi	authUser	POST /auth	Авторизовать пользователя
ClientApi	clientCreate	POST /clients/{company_id}	Добавить клиента
ClientApi	clientGet	GET /client/{company_id}/{id}	Получить клиента
ClientApi	clientGetList	POST /company/{company_id}/clients/search	Получить список клиентов
ClientApi	clientRemove	DELETE /client/{company_id}/{id}	Удалить клиента
ClientApi	clientUpdate	PUT /client/{company_id}/{id}	Редактировать клиента
CompanyApi	companyCreate	POST /companies	Создать компанию
CompanyApi	companyGet	GET /company/{id}/	Получить компанию
CompanyApi	companyGetList	GET /companies	Получить список компаний
CompanyApi	companyRemove	DELETE /company/{id}/	Удалить компанию
CompanyApi	companyUpdate	PUT /company/{id}/	Изменить компанию
LoyaltyCardApi	loyaltyCardByClientIdGetList	GET /loyalty/client_cards/{client_id}	Получить список карт клиента по ID
LoyaltyCardApi	loyaltyCardByClientPhoneGetList	GET /loyalty/cards/{phone}/{chain_id}/{company_id}	Получить список карт клиента по номеру телефона
LoyaltyCardApi	loyaltyCardCreate	POST /loyalty/cards/{company_id}	Выдать карту лояльности
LoyaltyCardApi	loyaltyCardRemove	DELETE /loyalty/cards/{company_id}/{card_id}	Удалить карту лояльности
LoyaltyCardApi	loyaltyCardTransactionCreate	POST /company/{company_id}/loyalty/cards/{card_id}/manual_transaction	Ручное списание/пополнение карты лояльности в компании
LoyaltyCardApi	loyaltyCardTypeByChainIdGetList	GET /chain/{chain_id}/loyalty/card_types	Получить список типов карт, доступных в сети
LoyaltyCardApi	loyaltyCardTypeByClientPhoneGetList	GET /loyalty/card_types/client/{company_id}/{phone}	Получить список типов карт доступных для выдачи клиенту
LoyaltyCardApi	loyaltyCardTypeByCompanyIdGetList	GET /loyalty/card_types/salon/{company_id}	Получить список типов карт доступных в филиале
LoyaltyTransactionApi	loyaltyTransactionGetList	GET /chain/{chain_id}/loyalty/transactions	Получить список транзакций лояльности в сети

Models

Authorization

Endpoints do not require authorization.

Author

Vgrish@gmail.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
- Package version: 1.0.0
- Generator version: 4.3.1
Build package: org.openapitools.codegen.languages.PhpClientCodegen

vgrish / yclients-openapi-php

Maintainers

Details