groomer_service

GroomerService - JavaScript client for groomer_service API для будущей GroomCRM или назовите ее уже как-нибудь. На этой странице расписаны основные эндпоинты, по которым можно получить данные из базы данных (или положить их туда, если будет такая возможность). Также здесь можно будет протестировать эти самые эндпоинты, посмотреть ответы и всякое такое.

TODO:

1. Обновить структуру описания в соответствии со структурой БД
2. Подготовить возможность тестирования
3. Добавить тест-кейсы для всего API

Changelog

v1.2.1: Добавил эндпоинт для получения информации об авторизованном Клиенте/Мастере

v1.2.0: Обновлены пути, респонсы, эндпоинты для приложений вынесены в отдельный стек

v1.1.4: Обновил структуру WorkingDiapason

v1.1.3: Добавил описания возвращаемых кодов.

v1.1.2: Удалил упоминания Питомцев и Пушей из АПИ

v1.1.1: Добавил параметр "платформа" для заказа, заменил OneSignal на FCM + APNs

v1.1.0: Убрал пуши из API

v1.0.4: добавлены фильтры по датам, добавлено поле телефона для мастеров (для смс-оповещений), добавлено поле push_device_id для отправки пушей на телефон.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.2.1
• Package version: 1.2.1
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit http://kosolapus.ddns.net/

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install groomer_service --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your groomer_service from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var GroomerService = require('groomer_service');


var api = new GroomerService.ApplicationApi()
var clientID = 1; // {Number} ID салона
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.clientClientGet(clientID, callback);

Documentation for API Endpoints

All URIs are relative to http://192.168.0.17/api/v1

Class	Method	HTTP request	Description
GroomerService.ApplicationApi	clientClientGet	GET /client/{client}	Получение данных салона - адреса, телефоны, социалки и т.п.
GroomerService.ApplicationApi	clientClientMasterGet	GET /client/{client}/master	Получение списка мастеров конкретного салона
GroomerService.ApplicationApi	clientClientMasterMasterGet	GET /client/{client}/master/{master}	Получение информации по конкретному мастеру
GroomerService.ApplicationApi	clientClientMasterMasterWorkingDiapasonGet	GET /client/{client}/master/{master}/working-diapason	Получение расписания мастера
GroomerService.ApplicationApi	clientClientMasterMasterWorkingDiapasonWorkingDiapasonGet	GET /client/{client}/master/{master}/working-diapason/{working-diapason}	Получение деталей временного отрезка
GroomerService.ApplicationApi	clientClientOrderPost	POST /client/{client}/order	Создание заявки на оказание услуг
GroomerService.ApplicationApi	clientClientPromotionGet	GET /client/{client}/promotion	Получение списка акций для салона
GroomerService.ApplicationApi	clientClientPromotionPromotionGet	GET /client/{client}/promotion/{promotion}	Получение детальной информации по акции
GroomerService.ApplicationApi	clientClientServiceGet	GET /client/{client}/service	Получение списка Услуг, которые оказывает салон
GroomerService.ApplicationApi	clientClientServiceServiceGet	GET /client/{client}/service/{service}	Получение детальной информации услуги
GroomerService.ClientApi	clientClientDelete	DELETE /client/{client}
GroomerService.ClientApi	clientClientGet	GET /client/{client}	Получение данных салона - адреса, телефоны, социалки и т.п.
GroomerService.ClientApi	clientClientPatch	PATCH /client/{client}
GroomerService.ClientApi	clientGet	GET /client	Возвращает список клиентов массивом
GroomerService.ClientApi	clientPost	POST /client	Создает нового клиента
GroomerService.MasterApi	clientClientMasterGet	GET /client/{client}/master	Получение списка мастеров конкретного салона
GroomerService.MasterApi	clientClientMasterMasterDelete	DELETE /client/{client}/master/{master}
GroomerService.MasterApi	clientClientMasterMasterGet	GET /client/{client}/master/{master}	Получение информации по конкретному мастеру
GroomerService.MasterApi	clientClientMasterMasterPatch	PATCH /client/{client}/master/{master}
GroomerService.MasterApi	clientClientMasterPost	POST /client/{client}/master
GroomerService.OAuthApi	oauthClientLoginPost	POST /oauth/client/login	Аутентифицирует клиента - салон или частного грумера
GroomerService.OAuthApi	oauthMasterLoginPost	POST /oauth/master/login	Аутентифицирует клиента - салон или частного грумера
GroomerService.OAuthApi	oauthMeGet	GET /oauth/me
GroomerService.OrderApi	clientClientOrderGet	GET /client/{client}/order
GroomerService.OrderApi	clientClientOrderOrderDelete	DELETE /client/{client}/order/{order}
GroomerService.OrderApi	clientClientOrderOrderGet	GET /client/{client}/order/{order}
GroomerService.OrderApi	clientClientOrderOrderPatch	PATCH /client/{client}/order/{order}
GroomerService.OrderApi	clientClientOrderPost	POST /client/{client}/order	Создание заявки на оказание услуг
GroomerService.PromotionApi	clientClientPromotionGet	GET /client/{client}/promotion	Получение списка акций для салона
GroomerService.PromotionApi	clientClientPromotionPost	POST /client/{client}/promotion
GroomerService.PromotionApi	clientClientPromotionPromotionDelete	DELETE /client/{client}/promotion/{promotion}
GroomerService.PromotionApi	clientClientPromotionPromotionGet	GET /client/{client}/promotion/{promotion}	Получение детальной информации по акции
GroomerService.PromotionApi	clientClientPromotionPromotionPatch	PATCH /client/{client}/promotion/{promotion}
GroomerService.ServiceApi	clientClientServiceGet	GET /client/{client}/service	Получение списка Услуг, которые оказывает салон
GroomerService.ServiceApi	clientClientServicePost	POST /client/{client}/service
GroomerService.ServiceApi	clientClientServiceServiceDelete	DELETE /client/{client}/service/{service}
GroomerService.ServiceApi	clientClientServiceServiceGet	GET /client/{client}/service/{service}	Получение детальной информации услуги
GroomerService.ServiceApi	clientClientServiceServicePatch	PATCH /client/{client}/service/{service}
GroomerService.WorkingDiapasonApi	clientClientMasterMasterWorkingDiapasonGet	GET /client/{client}/master/{master}/working-diapason	Получение расписания мастера
GroomerService.WorkingDiapasonApi	clientClientMasterMasterWorkingDiapasonPost	POST /client/{client}/master/{master}/working-diapason
GroomerService.WorkingDiapasonApi	clientClientMasterMasterWorkingDiapasonWorkingDiapasonDelete	DELETE /client/{client}/master/{master}/working-diapason/{working-diapason}
GroomerService.WorkingDiapasonApi	clientClientMasterMasterWorkingDiapasonWorkingDiapasonGet	GET /client/{client}/master/{master}/working-diapason/{working-diapason}	Получение деталей временного отрезка
GroomerService.WorkingDiapasonApi	clientClientMasterMasterWorkingDiapasonWorkingDiapasonPatch	PATCH /client/{client}/master/{master}/working-diapason/{working-diapason}

Documentation for Models

• GroomerService.Bearer
• GroomerService.Client
• GroomerService.InlineObject
• GroomerService.InlineResponse200
• GroomerService.InlineResponse2001
• GroomerService.InlineResponse2002
• GroomerService.InlineResponse2003
• GroomerService.Master
• GroomerService.Order
• GroomerService.Promotion
• GroomerService.Service
• GroomerService.WorkingDiapason

Documentation for Authorization

bearerAuth

• Type: Bearer authentication (JWT)

bearerAuthAdmin

• Type: Bearer authentication (JWT)

bearerAuthMaster

• Type: Bearer authentication (JWT)