Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ucook_api

enricowillemse20Unlicense1.0.9

ERROR_UNKNOWN

readme

ucook_api

UcookApi - JavaScript client for ucook_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: v1
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

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 ucook_api --save

git

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

    npm install YOUR_USERNAME/ucook_api --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.

Getting Started

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

var UcookApi = require('ucook_api');

var api = new UcookApi.DeliveryAreasApiApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiDeliveryAreasGet(callback);

Documentation for API Endpoints

All URIs are relative to http://ucookbackend.azurewebsites.net/

Class Method HTTP request Description
UcookApi.DeliveryAreasApiApi apiDeliveryAreasGet GET /api/DeliveryAreas
UcookApi.MenusApiApi apiMenusGet GET /api/Menus
UcookApi.MenusApiApi apiMenusGetCurrentMenuGet GET /api/Menus/GetCurrentMenu
UcookApi.MenusApiApi apiMenusGetDishByDishIdGet GET /api/Menus/GetDish/{dishId}
UcookApi.MenusApiApi apiMenusGetMenuByMenuIdGet GET /api/Menus/GetMenu/{menuId}
UcookApi.OrdersApiApi apiOrdersChangeOrderDishesByUsernameByMenuIdPost POST /api/Orders/ChangeOrderDishes/{username}/{menuId}
UcookApi.OrdersApiApi apiOrdersGetUserDishesByUsernameByMenuIdGet GET /api/Orders/GetUserDishes/{username}/{menuId}
UcookApi.SubscriptionsApiApi apiSubscriptionsApplyCouponPost POST /api/Subscriptions/ApplyCoupon
UcookApi.SubscriptionsApiApi apiSubscriptionsGetSubscriptionByUsernameGet GET /api/Subscriptions/GetSubscription/{username}
UcookApi.SubscriptionsApiApi apiSubscriptionsGetSubscriptionsTypesGet GET /api/Subscriptions/GetSubscriptionsTypes
UcookApi.SubscriptionsApiApi apiSubscriptionsNewSubscriptionPut PUT /api/Subscriptions/NewSubscription
UcookApi.SubscriptionsApiApi apiSubscriptionsPauseUnpauseSubscriptionByUsernameByPausePost POST /api/Subscriptions/PauseUnpauseSubscription/{username}/{pause}
UcookApi.SubscriptionsApiApi apiSubscriptionsRemoveCouponPost POST /api/Subscriptions/RemoveCoupon
UcookApi.SubscriptionsApiApi apiSubscriptionsUpdateCreditCardInfoByUsernamePost POST /api/Subscriptions/UpdateCreditCardInfo/{username}
UcookApi.SubscriptionsApiApi apiSubscriptionsUpdateShippingAddressByUsernamePost POST /api/Subscriptions/UpdateShippingAddress/{username}
UcookApi.SubscriptionsApiApi apiSubscriptionsUpdateSubscriptionTypeByUsernameBySubscriptionTypeIdPost POST /api/Subscriptions/UpdateSubscriptionType/{username}/{subscriptionTypeId}
UcookApi.SuppliersApiApi apiSuppliersGetSupplierBySupplierIdGet GET /api/Suppliers/GetSupplier/{supplierId}
UcookApi.SuppliersApiApi apiSuppliersGetSuppliersGet GET /api/Suppliers/GetSuppliers
UcookApi.WordpressUsersApiApi apiWordpressUsersAuthoriseUserFacebookPost POST /api/WordpressUsers/AuthoriseUserFacebook
UcookApi.WordpressUsersApiApi apiWordpressUsersAuthoriseUserPost POST /api/WordpressUsers/AuthoriseUser
UcookApi.WordpressUsersApiApi apiWordpressUsersCreateUserPut PUT /api/WordpressUsers/CreateUser
UcookApi.WordpressUsersApiApi apiWordpressUsersGetUserByUsernameGet GET /api/WordpressUsers/GetUser/{username}
UcookApi.WordpressUsersApiApi apiWordpressUsersGetUserReferralsByUsernameGet GET /api/WordpressUsers/GetUserReferrals/{username}
UcookApi.WordpressUsersApiApi apiWordpressUsersUpdatePasswordPost POST /api/WordpressUsers/UpdatePassword
UcookApi.WordpressUsersApiApi apiWordpressUsersUpdateUserByUsernamePost POST /api/WordpressUsers/UpdateUser/{username}

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.