mezzanine_dart_client 1.0.2 mezzanine_dart_client: ^1.0.2 copied to clipboard
A Dart client for the REST Web API for Mezzanine with Cartridge
Mezzanine Dart Client #
A Dart client for the REST Web API for Mezzanine with Cartridge
This Dart package is automatically generated by the Swagger Codegen project (for the most part)
- API version: 1.5.16
- Build package: io.swagger.codegen.languages.DartClientCodegen
Requirements #
Dart 1.20.0 or later OR Flutter 0.0.20 or later
Installation & Usage #
Github #
If installing from Github, include the following in pubspec.yaml
name: mezzanine_dart_client
version: 1.0.0
description: A Dart client for the REST Web API for Mezzanine with Cartridge
dependencies:
mezzanine_dart_client:
git: https://github.com/jackvz/mezzanine-cartridge-api
version: 'any'
Local #
To use the package in your local drive, include the following in pubspec.yaml
dependencies:
mezzanine_dart_client:
path: /path/to/mezzanine_dart_client
Getting Started #
import 'package:mezzanine_dart_client/api.dart';
// TODO Configure API key authorization: API Secret Key
//mezzanine_dart_client.api.Configuration.apiKey{'Api-Secret-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//mezzanine_dart_client.api.Configuration.apiKeyPrefix{'Api-Secret-Key'} = "Bearer";
// TODO Configure API key authorization: API Token
//mezzanine_dart_client.api.Configuration.apiKey{'Api-Token'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//mezzanine_dart_client.api.Configuration.apiKeyPrefix{'Api-Token'} = "Bearer";
var api_instance = new AssignedkeywordsApi();
var data = new AssignedKeyword(); // AssignedKeyword |
try {
var result = api_instance.assignedkeywordsCreate(data);
print(result);
} catch (e) {
print("Exception when calling AssignedkeywordsApi->assignedkeywordsCreate: $e\n");
}
Documentation for API Endpoints #
All URIs are relative to https://localhost/api
Class | Method | HTTP request | Description |
---|---|---|---|
AssignedkeywordsApi | assignedkeywordsCreate | POST /assignedkeywords/ | |
AssignedkeywordsApi | assignedkeywordsDelete | DELETE /assignedkeywords/{id}/ | |
AssignedkeywordsApi | assignedkeywordsList | GET /assignedkeywords/ | |
AssignedkeywordsApi | assignedkeywordsPartialUpdate | PATCH /assignedkeywords/{id}/ | |
AssignedkeywordsApi | assignedkeywordsRead | GET /assignedkeywords/{id}/ | |
AssignedkeywordsApi | assignedkeywordsUpdate | PUT /assignedkeywords/{id}/ | |
BlogcategoriesApi | blogcategoriesCreate | POST /blogcategories/ | |
BlogcategoriesApi | blogcategoriesDelete | DELETE /blogcategories/{id}/ | |
BlogcategoriesApi | blogcategoriesList | GET /blogcategories/ | |
BlogcategoriesApi | blogcategoriesPartialUpdate | PATCH /blogcategories/{id}/ | |
BlogcategoriesApi | blogcategoriesRead | GET /blogcategories/{id}/ | |
BlogcategoriesApi | blogcategoriesUpdate | PUT /blogcategories/{id}/ | |
BlogpostsApi | blogpostsCreate | POST /blogposts/ | |
BlogpostsApi | blogpostsDelete | DELETE /blogposts/{id}/ | |
BlogpostsApi | blogpostsList | GET /blogposts/ | |
BlogpostsApi | blogpostsPartialUpdate | PATCH /blogposts/{id}/ | |
BlogpostsApi | blogpostsRead | GET /blogposts/{id}/ | |
BlogpostsApi | blogpostsUpdate | PUT /blogposts/{id}/ | |
CartitemsApi | cartitemsCreate | POST /cartitems/ | |
CartitemsApi | cartitemsDelete | DELETE /cartitems/{id}/ | |
CartitemsApi | cartitemsList | GET /cartitems/ | |
CartitemsApi | cartitemsPartialUpdate | PATCH /cartitems/{id}/ | |
CartitemsApi | cartitemsRead | GET /cartitems/{id}/ | |
CartitemsApi | cartitemsUpdate | PUT /cartitems/{id}/ | |
CartsApi | cartsBillingShipping | POST /carts/{id}/billing-shipping/ | |
CartsApi | cartsCreate | POST /carts/ | |
CartsApi | cartsDelete | DELETE /carts/{id}/ | |
CartsApi | cartsList | GET /carts/ | |
CartsApi | cartsOrderPlacement | POST /carts/{id}/order-placement/ | |
CartsApi | cartsPartialUpdate | PATCH /carts/{id}/ | |
CartsApi | cartsPayment | POST /carts/{id}/payment/ | |
CartsApi | cartsRead | GET /carts/{id}/ | |
CartsApi | cartsTax | POST /carts/{id}/tax/ | |
CartsApi | cartsUpdate | PUT /carts/{id}/ | |
CategoriesApi | categoriesCreate | POST /categories/ | |
CategoriesApi | categoriesDelete | DELETE /categories/{id}/ | |
CategoriesApi | categoriesList | GET /categories/ | |
CategoriesApi | categoriesPartialUpdate | PATCH /categories/{id}/ | |
CategoriesApi | categoriesRead | GET /categories/{id}/ | |
CategoriesApi | categoriesUpdate | PUT /categories/{id}/ | |
DiscountcodesApi | discountcodesCreate | POST /discountcodes/ | |
DiscountcodesApi | discountcodesDelete | DELETE /discountcodes/{id}/ | |
DiscountcodesApi | discountcodesList | GET /discountcodes/ | |
DiscountcodesApi | discountcodesPartialUpdate | PATCH /discountcodes/{id}/ | |
DiscountcodesApi | discountcodesRead | GET /discountcodes/{id}/ | |
DiscountcodesApi | discountcodesUpdate | PUT /discountcodes/{id}/ | |
GalleriesApi | galleriesCreate | POST /galleries/ | |
GalleriesApi | galleriesDelete | DELETE /galleries/{id}/ | |
GalleriesApi | galleriesList | GET /galleries/ | |
GalleriesApi | galleriesPartialUpdate | PATCH /galleries/{id}/ | |
GalleriesApi | galleriesRead | GET /galleries/{id}/ | |
GalleriesApi | galleriesUpdate | PUT /galleries/{id}/ | |
GalleryimagesApi | galleryimagesCreate | POST /galleryimages/ | |
GalleryimagesApi | galleryimagesDelete | DELETE /galleryimages/{id}/ | |
GalleryimagesApi | galleryimagesList | GET /galleryimages/ | |
GalleryimagesApi | galleryimagesPartialUpdate | PATCH /galleryimages/{id}/ | |
GalleryimagesApi | galleryimagesRead | GET /galleryimages/{id}/ | |
GalleryimagesApi | galleryimagesUpdate | PUT /galleryimages/{id}/ | |
GroupsApi | groupsCreate | POST /groups/ | |
GroupsApi | groupsDelete | DELETE /groups/{id}/ | |
GroupsApi | groupsList | GET /groups/ | |
GroupsApi | groupsPartialUpdate | PATCH /groups/{id}/ | |
GroupsApi | groupsRead | GET /groups/{id}/ | |
GroupsApi | groupsUpdate | PUT /groups/{id}/ | |
OrderitemsApi | orderitemsCreate | POST /orderitems/ | |
OrderitemsApi | orderitemsDelete | DELETE /orderitems/{id}/ | |
OrderitemsApi | orderitemsList | GET /orderitems/ | |
OrderitemsApi | orderitemsPartialUpdate | PATCH /orderitems/{id}/ | |
OrderitemsApi | orderitemsRead | GET /orderitems/{id}/ | |
OrderitemsApi | orderitemsUpdate | PUT /orderitems/{id}/ | |
OrdersApi | ordersCreate | POST /orders/ | |
OrdersApi | ordersDelete | DELETE /orders/{id}/ | |
OrdersApi | ordersList | GET /orders/ | |
OrdersApi | ordersPartialUpdate | PATCH /orders/{id}/ | |
OrdersApi | ordersRead | GET /orders/{id}/ | |
OrdersApi | ordersUpdate | PUT /orders/{id}/ | |
PagesApi | pagesCreate | POST /pages/ | |
PagesApi | pagesDelete | DELETE /pages/{id}/ | |
PagesApi | pagesList | GET /pages/ | |
PagesApi | pagesPartialUpdate | PATCH /pages/{id}/ | |
PagesApi | pagesRead | GET /pages/{id}/ | |
PagesApi | pagesUpdate | PUT /pages/{id}/ | |
ProductimagesApi | productimagesCreate | POST /productimages/ | |
ProductimagesApi | productimagesDelete | DELETE /productimages/{id}/ | |
ProductimagesApi | productimagesList | GET /productimages/ | |
ProductimagesApi | productimagesPartialUpdate | PATCH /productimages/{id}/ | |
ProductimagesApi | productimagesRead | GET /productimages/{id}/ | |
ProductimagesApi | productimagesUpdate | PUT /productimages/{id}/ | |
ProductoptionsApi | productoptionsCreate | POST /productoptions/ | |
ProductoptionsApi | productoptionsDelete | DELETE /productoptions/{id}/ | |
ProductoptionsApi | productoptionsList | GET /productoptions/ | |
ProductoptionsApi | productoptionsPartialUpdate | PATCH /productoptions/{id}/ | |
ProductoptionsApi | productoptionsRead | GET /productoptions/{id}/ | |
ProductoptionsApi | productoptionsUpdate | PUT /productoptions/{id}/ | |
ProductsApi | productsCreate | POST /products/ | |
ProductsApi | productsDelete | DELETE /products/{id}/ | |
ProductsApi | productsList | GET /products/ | |
ProductsApi | productsPartialUpdate | PATCH /products/{id}/ | |
ProductsApi | productsRead | GET /products/{id}/ | |
ProductsApi | productsUpdate | PUT /products/{id}/ | |
ProductvariationsApi | productvariationsCreate | POST /productvariations/ | |
ProductvariationsApi | productvariationsDelete | DELETE /productvariations/{id}/ | |
ProductvariationsApi | productvariationsList | GET /productvariations/ | |
ProductvariationsApi | productvariationsPartialUpdate | PATCH /productvariations/{id}/ | |
ProductvariationsApi | productvariationsRead | GET /productvariations/{id}/ | |
ProductvariationsApi | productvariationsUpdate | PUT /productvariations/{id}/ | |
RatingsApi | ratingsCreate | POST /ratings/ | |
RatingsApi | ratingsDelete | DELETE /ratings/{id}/ | |
RatingsApi | ratingsList | GET /ratings/ | |
RatingsApi | ratingsPartialUpdate | PATCH /ratings/{id}/ | |
RatingsApi | ratingsRead | GET /ratings/{id}/ | |
RatingsApi | ratingsUpdate | PUT /ratings/{id}/ | |
RedirectsApi | redirectsCreate | POST /redirects/ | |
RedirectsApi | redirectsDelete | DELETE /redirects/{id}/ | |
RedirectsApi | redirectsList | GET /redirects/ | |
RedirectsApi | redirectsPartialUpdate | PATCH /redirects/{id}/ | |
RedirectsApi | redirectsRead | GET /redirects/{id}/ | |
RedirectsApi | redirectsUpdate | PUT /redirects/{id}/ | |
SalesApi | salesCreate | POST /sales/ | |
SalesApi | salesDelete | DELETE /sales/{id}/ | |
SalesApi | salesList | GET /sales/ | |
SalesApi | salesPartialUpdate | PATCH /sales/{id}/ | |
SalesApi | salesRead | GET /sales/{id}/ | |
SalesApi | salesUpdate | PUT /sales/{id}/ | |
SettingsApi | settingsCreate | POST /settings/ | |
SettingsApi | settingsDelete | DELETE /settings/{id}/ | |
SettingsApi | settingsList | GET /settings/ | |
SettingsApi | settingsPartialUpdate | PATCH /settings/{id}/ | |
SettingsApi | settingsRead | GET /settings/{id}/ | |
SettingsApi | settingsUpdate | PUT /settings/{id}/ | |
SitesApi | sitesCreate | POST /sites/ | |
SitesApi | sitesDelete | DELETE /sites/{id}/ | |
SitesApi | sitesList | GET /sites/ | |
SitesApi | sitesPartialUpdate | PATCH /sites/{id}/ | |
SitesApi | sitesRead | GET /sites/{id}/ | |
SitesApi | sitesUpdate | PUT /sites/{id}/ | |
SystemsettingsApi | systemsettingsList | GET /systemsettings/ | |
ThreadedcommentsApi | threadedcommentsCreate | POST /threadedcomments/ | |
ThreadedcommentsApi | threadedcommentsDelete | DELETE /threadedcomments/{id}/ | |
ThreadedcommentsApi | threadedcommentsList | GET /threadedcomments/ | |
ThreadedcommentsApi | threadedcommentsPartialUpdate | PATCH /threadedcomments/{id}/ | |
ThreadedcommentsApi | threadedcommentsRead | GET /threadedcomments/{id}/ | |
ThreadedcommentsApi | threadedcommentsUpdate | PUT /threadedcomments/{id}/ | |
UsersApi | usersActivate | POST /users/{id}/activate/ | |
UsersApi | usersCheckPassword | POST /users/check-password/ | |
UsersApi | usersCheckToken | POST /users/{id}/check-token/ | |
UsersApi | usersCreate | POST /users/ | |
UsersApi | usersDelete | DELETE /users/{id}/ | |
UsersApi | usersList | GET /users/ | |
UsersApi | usersPartialUpdate | PATCH /users/{id}/ | |
UsersApi | usersRead | GET /users/{id}/ | |
UsersApi | usersResetPassword | POST /users/reset-password/ | |
UsersApi | usersSetPassword | POST /users/{id}/set-password/ | |
UsersApi | usersUpdate | PUT /users/{id}/ |
Documentation For Models #
- AssignedKeyword
- BlogCategory
- BlogPost
- Cart
- CartBillingShipping
- CartItem
- CartPayment
- CartTax
- Category
- CategoryProductManyToManyThrough
- DiscountCode
- Gallery
- GalleryImage
- Group
- Order
- OrderForm
- OrderItem
- OrderPlacement
- Page
- Product
- ProductImage
- ProductOption
- ProductProductManyToManyThrough
- ProductVariation
- Rating
- Redirect
- Sale
- Setting
- Site
- SystemSetting
- ThreadedComment
- User
- UserActivation
- UserPasswordCheck
- UserPasswordReset
- UserPasswordSet
- UserTokenCheck
Documentation For Authorization #
API Secret Key #
- Type: API key
- API key parameter name: Api-Secret-Key
- Location: HTTP header
API Token #
- Type: API key
- API key parameter name: Api-Token
- Location: HTTP header