monosolutions_api (EXPERIMENTAL)

The purpose of this Open API description, is to enable resellers / third parties to easily integrate with our detailed site API.

This site serves both as an interactive tour/demo and as API documentation for the site API.

Demo site: demoapi.v5demo01.monosolutions.com Username: apidemo Password: apidemo123

Use the login credential above in the api call /login to interact with calls that require login.

The API contains much more, how ever we have prioritized not publicly documenting all features, please contact us for additonal details.

Thanks The Mono API team

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

  • API version: 5.0.0
  • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  monosolutions_api: 1.0.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  monosolutions_api:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  monosolutions_api:
    path: /path/to/monosolutions_api

Getting Started

Please follow the installation procedure and then run the following:

import 'package:monosolutions_api/monosolutions_api.dart';


final api = MonosolutionsApi().getClass0Api();

try {
    api.docGet();
} catch on DioException (e) {
    print("Exception when calling Class0Api->docGet: $e\n");
}

Documentation for API Endpoints

All URIs are relative to http://localhost/api.php

Class Method HTTP request Description
Class0Api docGet GET /doc
Class0Api loginPost POST /login
Class1Api websiteDesignGet GET /website/design
Class1Api websiteDesignModulesGet GET /website/design/modules
Class1Api websiteDesignPatch PATCH /website/design
Class1Api websiteDesignPut PUT /website/design
Class1Api websiteLocalesDelete DELETE /website/locales
Class1Api websiteLocalesGet GET /website/locales
Class1Api websiteLocalesLocaleIdDelete DELETE /website/locales/{localeId}
Class1Api websiteLocalesLocaleIdGet GET /website/locales/{localeId}
Class1Api websiteLocalesLocaleIdPatch PATCH /website/locales/{localeId}
Class1Api websiteLocalesLocaleIdPut PUT /website/locales/{localeId}
Class1Api websiteLocalesPost POST /website/locales
Class1Api websitePagesGet GET /website/pages
Class1Api websitePagesPageIdColsColIdDelete DELETE /website/pages/{pageId}/cols/{colId}
Class1Api websitePagesPageIdColsColIdGet GET /website/pages/{pageId}/cols/{colId}
Class1Api websitePagesPageIdColsColIdPatch PATCH /website/pages/{pageId}/cols/{colId}
Class1Api websitePagesPageIdColsColIdPost POST /website/pages/{pageId}/cols/{colId}
Class1Api websitePagesPageIdColsColIdPut PUT /website/pages/{pageId}/cols/{colId}
Class1Api websitePagesPageIdColsGet GET /website/pages/{pageId}/cols
Class1Api websitePagesPageIdDelete DELETE /website/pages/{pageId}
Class1Api websitePagesPageIdGet GET /website/pages/{pageId}
Class1Api websitePagesPageIdModulesGet GET /website/pages/{pageId}/modules
Class1Api websitePagesPageIdModulesModuleIdDelete DELETE /website/pages/{pageId}/modules/{moduleId}
Class1Api websitePagesPageIdModulesModuleIdGet GET /website/pages/{pageId}/modules/{moduleId}
Class1Api websitePagesPageIdModulesModuleIdPatch PATCH /website/pages/{pageId}/modules/{moduleId}
Class1Api websitePagesPageIdModulesModuleIdPost POST /website/pages/{pageId}/modules/{moduleId}
Class1Api websitePagesPageIdModulesModuleIdPut PUT /website/pages/{pageId}/modules/{moduleId}
Class1Api websitePagesPageIdPatch PATCH /website/pages/{pageId}
Class1Api websitePagesPageIdPut PUT /website/pages/{pageId}
Class1Api websitePagesPageIdRowsGet GET /website/pages/{pageId}/rows
Class1Api websitePagesPageIdRowsRowIdDelete DELETE /website/pages/{pageId}/rows/{rowId}
Class1Api websitePagesPageIdRowsRowIdGet GET /website/pages/{pageId}/rows/{rowId}
Class1Api websitePagesPageIdRowsRowIdPatch PATCH /website/pages/{pageId}/rows/{rowId}
Class1Api websitePagesPageIdRowsRowIdPost POST /website/pages/{pageId}/rows/{rowId}
Class1Api websitePagesPageIdRowsRowIdPut PUT /website/pages/{pageId}/rows/{rowId}
Class1Api websitePagesPost POST /website/pages
Class10Api websiteStatsGet GET /website/stats
Class11Api customersActivitiesActivityIdDelete DELETE /customers/activities/{activityId}
Class11Api customersActivitiesActivityIdGet GET /customers/activities/{activityId}
Class11Api customersActivitiesGet GET /customers/activities
Class11Api customersCustomerGroupsCustomerGroupIdDelete DELETE /customers/customerGroups/{customerGroupId}
Class11Api customersCustomerGroupsCustomerGroupIdGet GET /customers/customerGroups/{customerGroupId}
Class11Api customersCustomerGroupsGet GET /customers/customerGroups
Class11Api customersCustomerGroupsPost POST /customers/customerGroups
Class11Api customersCustomersCustomerIdDelete DELETE /customers/customers/{customerId}
Class11Api customersCustomersCustomerIdGet GET /customers/customers/{customerId}
Class11Api customersCustomersEmailGet GET /customers/customers/email
Class11Api customersCustomersGet GET /customers/customers
Class11Api customersCustomersPost POST /customers/customers
Class11Api customersCustomersPut PUT /customers/customers
Class2Api filesDelete DELETE /files
Class2Api filesFileIdDelete DELETE /files/{fileId}
Class2Api filesFileIdGet GET /files/{fileId}
Class2Api filesFileIdPatch PATCH /files/{fileId}
Class2Api filesFileIdPut PUT /files/{fileId}
Class2Api filesGet GET /files
Class2Api globalsDelete DELETE /globals Deletes custom global data fields
Class2Api globalsDownloadsDelete DELETE /globals/downloads Delete all items
Class2Api globalsDownloadsDownloadIdDelete DELETE /globals/downloads/{downloadId}
Class2Api globalsDownloadsGet GET /globals/downloads Get globals
Class2Api globalsDownloadsIdPatch PATCH /globals/downloads/{id} Set new global data downloads, but only provided values
Class2Api globalsDownloadsPost POST /globals/downloads Set new global data downloads
Class2Api globalsFaqsDelete DELETE /globals/faqs Delete all items
Class2Api globalsFaqsFaqIdDelete DELETE /globals/faqs/{faqId}
Class2Api globalsFaqsGet GET /globals/faqs Get globals
Class2Api globalsFaqsIdPatch PATCH /globals/faqs/{id} Set new global data faqs, but only provided values
Class2Api globalsFaqsPost POST /globals/faqs Set new global data faqs
Class2Api globalsGet GET /globals Get globals
Class2Api globalsImagesDelete DELETE /globals/images Delete all items
Class2Api globalsImagesGet GET /globals/images Get globals
Class2Api globalsImagesIdPatch PATCH /globals/images/{id} Set new global data images, but only provided values
Class2Api globalsImagesImageIdDelete DELETE /globals/images/{imageId}
Class2Api globalsImagesPost POST /globals/images Set new global data images
Class2Api globalsListsDelete DELETE /globals/lists Delete all items
Class2Api globalsListsGet GET /globals/lists Get globals
Class2Api globalsListsIdPatch PATCH /globals/lists/{id} Set new global data lists, but only provided values
Class2Api globalsListsListIdDelete DELETE /globals/lists/{listId}
Class2Api globalsListsPost POST /globals/lists Set new global data lists
Class2Api globalsOffersDelete DELETE /globals/offers Delete all items
Class2Api globalsOffersGet GET /globals/offers Get globals
Class2Api globalsOffersIdPatch PATCH /globals/offers/{id} Set new global data offers, but only provided values
Class2Api globalsOffersOfferIdDelete DELETE /globals/offers/{offerId}
Class2Api globalsOffersPost POST /globals/offers Set new global data offers
Class2Api globalsOpeningHoursDelete DELETE /globals/openingHours Delete all items
Class2Api globalsOpeningHoursGet GET /globals/openingHours Get globals
Class2Api globalsOpeningHoursIdPatch PATCH /globals/openingHours/{id} Set new global data openingHours, but only provided values
Class2Api globalsOpeningHoursOpeningHourIdDelete DELETE /globals/openingHours/{openingHourId}
Class2Api globalsOpeningHoursPost POST /globals/openingHours Set new global data openingHours
Class2Api globalsPatch PATCH /globals Set new globals, but only provided values
Class2Api globalsPaymentMethodsDelete DELETE /globals/paymentMethods Delete all items
Class2Api globalsPaymentMethodsGet GET /globals/paymentMethods Get globals
Class2Api globalsPaymentMethodsIdPatch PATCH /globals/paymentMethods/{id} Set new global data paymentMethods, but only provided values
Class2Api globalsPaymentMethodsPaymentMethodIdDelete DELETE /globals/paymentMethods/{paymentMethodId}
Class2Api globalsPaymentMethodsPost POST /globals/paymentMethods Set new global data paymentMethods
Class2Api globalsPersonsDelete DELETE /globals/persons Delete all items
Class2Api globalsPersonsGet GET /globals/persons Get globals
Class2Api globalsPersonsIdPatch PATCH /globals/persons/{id} Set new global data persons, but only provided values
Class2Api globalsPersonsPersonIdDelete DELETE /globals/persons/{personId}
Class2Api globalsPersonsPost POST /globals/persons Set new global data persons
Class2Api globalsPriceListsDelete DELETE /globals/priceLists Delete all items
Class2Api globalsPriceListsGet GET /globals/priceLists Get globals
Class2Api globalsPriceListsPatch PATCH /globals/priceLists Set new global data priceLists, but only provided values
Class2Api globalsPriceListsPost POST /globals/priceLists Set new global data priceLists
Class2Api globalsPriceListsPriceListIdDelete DELETE /globals/priceLists/{priceListId}
Class2Api globalsPut PUT /globals Set new globals
Class2Api globalsReviewsDelete DELETE /globals/reviews Delete all items
Class2Api globalsReviewsGet GET /globals/reviews Get globals
Class2Api globalsReviewsIdPatch PATCH /globals/reviews/{id} Set new global data reviews, but only provided values
Class2Api globalsReviewsPost POST /globals/reviews Set new global data reviews
Class2Api globalsReviewsReviewIdDelete DELETE /globals/reviews/{reviewId}
Class2Api globalsSetsDelete DELETE /globals/sets Delete all items
Class2Api globalsSetsGet GET /globals/sets Get globals
Class2Api globalsSetsPost POST /globals/sets Set new global data sets
Class2Api globalsSetsSetIdDelete DELETE /globals/sets/{setId} Deletes one item
Class2Api globalsSetsSetIdPatch PATCH /globals/sets/{setId} Set new global data sets, but only provided values
Class2Api globalsSocialMediasDelete DELETE /globals/socialMedias Delete all items
Class2Api globalsSocialMediasGet GET /globals/socialMedias Get globals
Class2Api globalsSocialMediasIdPatch PATCH /globals/socialMedias/{id} Set new global data socialMedias, but only provided values
Class2Api globalsSocialMediasPost POST /globals/socialMedias Set new global data socialMedias
Class2Api globalsSocialMediasSocialMediaIdDelete DELETE /globals/socialMedias/{socialMediaId}
Class2Api globalsVideosDelete DELETE /globals/videos Delete all items
Class2Api globalsVideosGet GET /globals/videos Get globals
Class2Api globalsVideosIdPatch PATCH /globals/videos/{id} Set new global data videos, but only provided values
Class2Api globalsVideosPost POST /globals/videos Set new global data videos
Class2Api globalsVideosVideoIdDelete DELETE /globals/videos/{videoId}
Class2Api globalsWebsitesDelete DELETE /globals/websites Delete all items
Class2Api globalsWebsitesGet GET /globals/websites Get globals
Class2Api globalsWebsitesIdPatch PATCH /globals/websites/{id} Set new global data websites, but only provided values
Class2Api globalsWebsitesPost POST /globals/websites Set new global data websites
Class2Api globalsWebsitesWebsiteIdDelete DELETE /globals/websites/{websiteId}
Class2Api settingsTimezonesGet GET /settings/timezones Get Timezones
Class2Api uploadFile POST /files uploads a file
Class3Api shopFeedsDelete DELETE /shop/feeds
Class3Api shopFeedsFeedIdDelete DELETE /shop/feeds/{feedId}
Class3Api shopFeedsFeedIdGet GET /shop/feeds/{feedId}
Class3Api shopFeedsFeedIdPost POST /shop/feeds/{feedId}
Class3Api shopFeedsGet GET /shop/feeds
Class3Api shopFeedsPost POST /shop/feeds
Class3Api shopOrdersGet GET /shop/orders/
Class3Api shopOrdersOrderIdGet GET /shop/orders/{orderId}
Class3Api shopProductsGet GET /shop/products
Class3Api shopProductsPost POST /shop/products
Class3Api shopProductsProductIdGet GET /shop/products/{productId}
Class3Api shopSettingsGet GET /shop/settings
Class3Api shopSettingsPatch PATCH /shop/settings
Class3Api shopSettingsPost POST /shop/settings
Class3Api shopSettingsPut PUT /shop/settings
Class3Api shopSettingsShippingPost POST /shop/settings/shipping
Class3Api shopSettingsTermsPost POST /shop/settings/terms
Class3Api shopTagsGet GET /shop/tags
Class3Api shopTagsPost POST /shop/tags
Class3Api shopTagsTagGet GET /shop/tags/{tag}
Class3Api shopTagsTagPut PUT /shop/tags/{tag}
Class3Api shopTagscommandremoveDeletedProductsGet GET /shop/tags?command=removeDeletedProducts
Class5Api settingsGet GET /settings
Class5Api settingsPatch PATCH /settings
Class5Api settingsPut PUT /settings
Class6Api crmUserscommandcsvexampleGet GET /crm/users?command=csvexample
Class6Api crmUserscommandimportPost POST /crm/users?command=import
Class6Api crmUserscommandimportValidatePost POST /crm/users?command=importValidate
Class6Api globalscommandpublishPost POST /globals?command=publish
Class6Api shopProductscommandcsvexamplesimpletrueGet GET /shop/products?command=csvexample&simple=true
Class6Api shopProductscommandduplicatePost POST /shop/products?command=duplicate
Class6Api shopProductscommandexportGet GET /shop/products?command=export
Class6Api shopProductscommandimportPost POST /shop/products?command=import
Class6Api shopProductscommandimportValidatePost POST /shop/products?command=importValidate
Class6Api shopProductscommandrecalculatePost POST /shop/products?command=recalculate
Class6Api shopProductscommandrecalculatePricePost POST /shop/products?command=recalculatePrice
Class6Api shopSettingsTaxTypesGet GET /shop/settings/tax-types
Class6Api shopSettingsTaxTypesPost POST /shop/settings/tax-types
Class6Api shopSettingsTaxTypesTaxTypeIdGet GET /shop/settings/tax-types/{taxTypeId}
Class6Api shopSettingsTaxTypesTaxTypeIdPatch PATCH /shop/settings/tax-types/{taxTypeId}
Class6Api shopSettingsTaxTypesTaxTypeIdPost POST /shop/settings/tax-types/{taxTypeId}
Class6Api websiteSnapshotsSnapshotIdcommandrestorePost POST /website/snapshots/{snapshotId}?command=restore
Class6Api websitecommandflattenPost POST /website?command=flatten
Class6Api websitecommandgetVisiblePagesPost POST /website?command=getVisiblePages
Class6Api websitecommandpublishPost POST /website?command=publish
Class7Api backupsBackupIdDelete DELETE /backups/{backupId}
Class7Api backupsBackupIdGet GET /backups/{backupId}
Class7Api backupsDelete DELETE /backups
Class7Api backupsGet GET /backups
Class7Api backupsPost POST /backups
Class7Api websiteSnapshotsDelete DELETE /website/snapshots
Class7Api websiteSnapshotsGet GET /website/snapshots
Class7Api websiteSnapshotsPost POST /website/snapshots
Class7Api websiteSnapshotsSnapshotIdDelete DELETE /website/snapshots/{snapshotId}
Class7Api websiteSnapshotsSnapshotIdGet GET /website/snapshots/{snapshotId}
Class8Api blogCommentsCommentIdGet GET /blog/comments/{commentId}
Class8Api blogCommentsGet GET /blog/comments
Class8Api blogCommentsPost POST /blog/comments
Class8Api blogPostsGet GET /blog/posts
Class8Api blogPostsPost POST /blog/posts
Class8Api blogPostsPostIdGet GET /blog/posts/{postId}
Class8Api blogSettingsGet GET /blog/settings
Class8Api blogSettingsPatch PATCH /blog/settings
Class8Api blogSettingsPost POST /blog/settings
Class8Api blogTagsGet GET /blog/tags
Class8Api blogTagsPost POST /blog/tags
Class8Api blogTagsTagGet GET /blog/tags/{tag}
Class8Api blogTagsTagPut PUT /blog/tags/{tag}
Class8Api engagementsSettingsGet GET /engagements/settings
Class8Api engagementsSettingsPatch PATCH /engagements/settings
Class8Api engagementsSettingsPost POST /engagements/settings
Class9Api crmActivitiesIdDelete DELETE /crm/activities/{id}/
Class9Api crmActivitiesUserIdGet GET /crm/activities/{userId}
Class9Api crmActivitiesUserIdPost POST /crm/activities/{userId}
Class9Api crmActivitiesUserIdcommandexportPost POST /crm/activities/{userId}?command=export
Class9Api crmEmailcampaignsGet GET /crm/emailcampaigns
Class9Api crmEmailcampaignsIdDelete DELETE /crm/emailcampaigns/{id}
Class9Api crmEmailcampaignsIdGet GET /crm/emailcampaigns/{id}
Class9Api crmEmailcampaignsIdPatch PATCH /crm/emailcampaigns/{id}
Class9Api crmEmailcampaignsIdPost POST /crm/emailcampaigns/{id}
Class9Api crmEmailcampaignsIdPut PUT /crm/emailcampaigns/{id}
Class9Api crmEmailcampaignsIdcommandpreviewPost POST /crm/emailcampaigns/{id}?command=preview
Class9Api crmEmailcampaignsIdcommandsendPost POST /crm/emailcampaigns/{id}?command=send
Class9Api crmEmailcampaignsPost POST /crm/emailcampaigns
Class9Api crmEmailcampaignscommandduplicatePost POST /crm/emailcampaigns?command=duplicate
Class9Api crmFormsFormIdDataGet GET /crm/forms/{formId}/data
Class9Api crmFormsFormIdDataIdDelete DELETE /crm/forms/{formId}/data/{id}
Class9Api crmFormsFormIdDataIdGet GET /crm/forms/{formId}/data/{id}
Class9Api crmFormsFormIdDatacommandexportPost POST /crm/forms/{formId}/data?command=export
Class9Api crmFormsGet GET /crm/forms
Class9Api crmFormsIdDelete DELETE /crm/forms/{id}
Class9Api crmFormsIdGet GET /crm/forms/{id}
Class9Api crmGroupsGet GET /crm/groups
Class9Api crmGroupsIdDelete DELETE /crm/groups/{id}
Class9Api crmGroupsIdGet GET /crm/groups/{id}
Class9Api crmGroupsPost POST /crm/groups
Class9Api crmRemindersIdDelete DELETE /crm/reminders/{id}
Class9Api crmRemindersIdGet GET /crm/reminders/{id}
Class9Api crmRemindersPost POST /crm/reminders
Class9Api crmSettingsGet GET /crm/settings
Class9Api crmSettingsPatch PATCH /crm/settings
Class9Api crmSettingsPost POST /crm/settings
Class9Api crmUsersGet GET /crm/users
Class9Api crmUsersIdDelete DELETE /crm/users/{id}
Class9Api crmUsersIdGet GET /crm/users/{id}
Class9Api crmUsersIdPatch PATCH /crm/users/{id}
Class9Api crmUsersIdPost POST /crm/users/{id}
Class9Api crmUsersIdPut PUT /crm/users/{id}
Class9Api crmUsersPost POST /crm/users
DefaultApi engagementsDelete DELETE /engagements
DefaultApi engagementsEngagementIdDelete DELETE /engagements/{engagementId}
DefaultApi engagementsEngagementIdGet GET /engagements/{engagementId}
DefaultApi engagementsEngagementIdPost POST /engagements/{engagementId}
DefaultApi engagementsGet GET /engagements
DefaultApi engagementsPost POST /engagements
DefaultApi findPetById GET /shop/settings/shipping/{shippingMethodId}
DefaultApi gdprGet GET /gdpr
DefaultApi searchGet GET /search
DefaultApi shopSettingsShippingShippingMethodIdDelete DELETE /shop/settings/shipping/{shippingMethodId}
DefaultApi shopSettingsTermsGet GET /shop/settings/terms
DefaultApi utilsGet GET /utils

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Libraries

monosolutions_api