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

ClassMethodHTTP requestDescription
AssignedkeywordsApiassignedkeywordsCreatePOST /assignedkeywords/
AssignedkeywordsApiassignedkeywordsDeleteDELETE /assignedkeywords/{id}/
AssignedkeywordsApiassignedkeywordsListGET /assignedkeywords/
AssignedkeywordsApiassignedkeywordsPartialUpdatePATCH /assignedkeywords/{id}/
AssignedkeywordsApiassignedkeywordsReadGET /assignedkeywords/{id}/
AssignedkeywordsApiassignedkeywordsUpdatePUT /assignedkeywords/{id}/
BlogcategoriesApiblogcategoriesCreatePOST /blogcategories/
BlogcategoriesApiblogcategoriesDeleteDELETE /blogcategories/{id}/
BlogcategoriesApiblogcategoriesListGET /blogcategories/
BlogcategoriesApiblogcategoriesPartialUpdatePATCH /blogcategories/{id}/
BlogcategoriesApiblogcategoriesReadGET /blogcategories/{id}/
BlogcategoriesApiblogcategoriesUpdatePUT /blogcategories/{id}/
BlogpostsApiblogpostsCreatePOST /blogposts/
BlogpostsApiblogpostsDeleteDELETE /blogposts/{id}/
BlogpostsApiblogpostsListGET /blogposts/
BlogpostsApiblogpostsPartialUpdatePATCH /blogposts/{id}/
BlogpostsApiblogpostsReadGET /blogposts/{id}/
BlogpostsApiblogpostsUpdatePUT /blogposts/{id}/
CartitemsApicartitemsCreatePOST /cartitems/
CartitemsApicartitemsDeleteDELETE /cartitems/{id}/
CartitemsApicartitemsListGET /cartitems/
CartitemsApicartitemsPartialUpdatePATCH /cartitems/{id}/
CartitemsApicartitemsReadGET /cartitems/{id}/
CartitemsApicartitemsUpdatePUT /cartitems/{id}/
CartsApicartsBillingShippingPOST /carts/{id}/billing-shipping/
CartsApicartsCreatePOST /carts/
CartsApicartsDeleteDELETE /carts/{id}/
CartsApicartsListGET /carts/
CartsApicartsOrderPlacementPOST /carts/{id}/order-placement/
CartsApicartsPartialUpdatePATCH /carts/{id}/
CartsApicartsPaymentPOST /carts/{id}/payment/
CartsApicartsReadGET /carts/{id}/
CartsApicartsTaxPOST /carts/{id}/tax/
CartsApicartsUpdatePUT /carts/{id}/
CategoriesApicategoriesCreatePOST /categories/
CategoriesApicategoriesDeleteDELETE /categories/{id}/
CategoriesApicategoriesListGET /categories/
CategoriesApicategoriesPartialUpdatePATCH /categories/{id}/
CategoriesApicategoriesReadGET /categories/{id}/
CategoriesApicategoriesUpdatePUT /categories/{id}/
DiscountcodesApidiscountcodesCreatePOST /discountcodes/
DiscountcodesApidiscountcodesDeleteDELETE /discountcodes/{id}/
DiscountcodesApidiscountcodesListGET /discountcodes/
DiscountcodesApidiscountcodesPartialUpdatePATCH /discountcodes/{id}/
DiscountcodesApidiscountcodesReadGET /discountcodes/{id}/
DiscountcodesApidiscountcodesUpdatePUT /discountcodes/{id}/
GalleriesApigalleriesCreatePOST /galleries/
GalleriesApigalleriesDeleteDELETE /galleries/{id}/
GalleriesApigalleriesListGET /galleries/
GalleriesApigalleriesPartialUpdatePATCH /galleries/{id}/
GalleriesApigalleriesReadGET /galleries/{id}/
GalleriesApigalleriesUpdatePUT /galleries/{id}/
GalleryimagesApigalleryimagesCreatePOST /galleryimages/
GalleryimagesApigalleryimagesDeleteDELETE /galleryimages/{id}/
GalleryimagesApigalleryimagesListGET /galleryimages/
GalleryimagesApigalleryimagesPartialUpdatePATCH /galleryimages/{id}/
GalleryimagesApigalleryimagesReadGET /galleryimages/{id}/
GalleryimagesApigalleryimagesUpdatePUT /galleryimages/{id}/
GroupsApigroupsCreatePOST /groups/
GroupsApigroupsDeleteDELETE /groups/{id}/
GroupsApigroupsListGET /groups/
GroupsApigroupsPartialUpdatePATCH /groups/{id}/
GroupsApigroupsReadGET /groups/{id}/
GroupsApigroupsUpdatePUT /groups/{id}/
OrderitemsApiorderitemsCreatePOST /orderitems/
OrderitemsApiorderitemsDeleteDELETE /orderitems/{id}/
OrderitemsApiorderitemsListGET /orderitems/
OrderitemsApiorderitemsPartialUpdatePATCH /orderitems/{id}/
OrderitemsApiorderitemsReadGET /orderitems/{id}/
OrderitemsApiorderitemsUpdatePUT /orderitems/{id}/
OrdersApiordersCreatePOST /orders/
OrdersApiordersDeleteDELETE /orders/{id}/
OrdersApiordersListGET /orders/
OrdersApiordersPartialUpdatePATCH /orders/{id}/
OrdersApiordersReadGET /orders/{id}/
OrdersApiordersUpdatePUT /orders/{id}/
PagesApipagesCreatePOST /pages/
PagesApipagesDeleteDELETE /pages/{id}/
PagesApipagesListGET /pages/
PagesApipagesPartialUpdatePATCH /pages/{id}/
PagesApipagesReadGET /pages/{id}/
PagesApipagesUpdatePUT /pages/{id}/
ProductimagesApiproductimagesCreatePOST /productimages/
ProductimagesApiproductimagesDeleteDELETE /productimages/{id}/
ProductimagesApiproductimagesListGET /productimages/
ProductimagesApiproductimagesPartialUpdatePATCH /productimages/{id}/
ProductimagesApiproductimagesReadGET /productimages/{id}/
ProductimagesApiproductimagesUpdatePUT /productimages/{id}/
ProductoptionsApiproductoptionsCreatePOST /productoptions/
ProductoptionsApiproductoptionsDeleteDELETE /productoptions/{id}/
ProductoptionsApiproductoptionsListGET /productoptions/
ProductoptionsApiproductoptionsPartialUpdatePATCH /productoptions/{id}/
ProductoptionsApiproductoptionsReadGET /productoptions/{id}/
ProductoptionsApiproductoptionsUpdatePUT /productoptions/{id}/
ProductsApiproductsCreatePOST /products/
ProductsApiproductsDeleteDELETE /products/{id}/
ProductsApiproductsListGET /products/
ProductsApiproductsPartialUpdatePATCH /products/{id}/
ProductsApiproductsReadGET /products/{id}/
ProductsApiproductsUpdatePUT /products/{id}/
ProductvariationsApiproductvariationsCreatePOST /productvariations/
ProductvariationsApiproductvariationsDeleteDELETE /productvariations/{id}/
ProductvariationsApiproductvariationsListGET /productvariations/
ProductvariationsApiproductvariationsPartialUpdatePATCH /productvariations/{id}/
ProductvariationsApiproductvariationsReadGET /productvariations/{id}/
ProductvariationsApiproductvariationsUpdatePUT /productvariations/{id}/
RatingsApiratingsCreatePOST /ratings/
RatingsApiratingsDeleteDELETE /ratings/{id}/
RatingsApiratingsListGET /ratings/
RatingsApiratingsPartialUpdatePATCH /ratings/{id}/
RatingsApiratingsReadGET /ratings/{id}/
RatingsApiratingsUpdatePUT /ratings/{id}/
RedirectsApiredirectsCreatePOST /redirects/
RedirectsApiredirectsDeleteDELETE /redirects/{id}/
RedirectsApiredirectsListGET /redirects/
RedirectsApiredirectsPartialUpdatePATCH /redirects/{id}/
RedirectsApiredirectsReadGET /redirects/{id}/
RedirectsApiredirectsUpdatePUT /redirects/{id}/
SalesApisalesCreatePOST /sales/
SalesApisalesDeleteDELETE /sales/{id}/
SalesApisalesListGET /sales/
SalesApisalesPartialUpdatePATCH /sales/{id}/
SalesApisalesReadGET /sales/{id}/
SalesApisalesUpdatePUT /sales/{id}/
SettingsApisettingsCreatePOST /settings/
SettingsApisettingsDeleteDELETE /settings/{id}/
SettingsApisettingsListGET /settings/
SettingsApisettingsPartialUpdatePATCH /settings/{id}/
SettingsApisettingsReadGET /settings/{id}/
SettingsApisettingsUpdatePUT /settings/{id}/
SitesApisitesCreatePOST /sites/
SitesApisitesDeleteDELETE /sites/{id}/
SitesApisitesListGET /sites/
SitesApisitesPartialUpdatePATCH /sites/{id}/
SitesApisitesReadGET /sites/{id}/
SitesApisitesUpdatePUT /sites/{id}/
SystemsettingsApisystemsettingsListGET /systemsettings/
ThreadedcommentsApithreadedcommentsCreatePOST /threadedcomments/
ThreadedcommentsApithreadedcommentsDeleteDELETE /threadedcomments/{id}/
ThreadedcommentsApithreadedcommentsListGET /threadedcomments/
ThreadedcommentsApithreadedcommentsPartialUpdatePATCH /threadedcomments/{id}/
ThreadedcommentsApithreadedcommentsReadGET /threadedcomments/{id}/
ThreadedcommentsApithreadedcommentsUpdatePUT /threadedcomments/{id}/
UsersApiusersActivatePOST /users/{id}/activate/
UsersApiusersCheckPasswordPOST /users/check-password/
UsersApiusersCheckTokenPOST /users/{id}/check-token/
UsersApiusersCreatePOST /users/
UsersApiusersDeleteDELETE /users/{id}/
UsersApiusersListGET /users/
UsersApiusersPartialUpdatePATCH /users/{id}/
UsersApiusersReadGET /users/{id}/
UsersApiusersResetPasswordPOST /users/reset-password/
UsersApiusersSetPasswordPOST /users/{id}/set-password/
UsersApiusersUpdatePUT /users/{id}/

Documentation For Models

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

Libraries

mezzanine_dart_client.api