monosolutions_hal_api 1.0.18

Published Aug 12, 2025
SDKdartflutter
Platformandroidioswindowslinuxmacosweb

OpenAPI API Dart client for Monosolutions HAL API (https://www.monosolutions.com/)

monosolutions_hal_api (EXPERIMENTAL)

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

The API is kept up to date. However, if you feel that documentation is missing, please feel free to contact us via Service Desk. Individual endpoints share common parameters and they are outlined under each endpoint. However, to access any endpoint, you must have a user or a reseller token. If you do not have a token or your token is not working, please contact your point of contact within Mono Solutions for assistance. IMPORTANT: Each command should have the parameter 'command' with the value of the command. For example, if you're calling addSubscription, then you should include {'command':'addSubscription'} in the JSON payload.

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_hal_api: 1.0.0

Github

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

dependencies:
  monosolutions_hal_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_hal_api:
    path: /path/to/monosolutions_hal_api

Getting Started

Please follow the installation procedure and then run the following:

import 'package:monosolutions_hal_api/monosolutions_hal_api.dart';


final api = MonosolutionsHalApi().getAccountApi();
final AccountAddSubscription body = ; // AccountAddSubscription | 

try {
    final response = await api.resellerAccountAddSubscriptionPost(body);
    print(response);
} catch on DioException (e) {
    print("Exception when calling AccountApi->resellerAccountAddSubscriptionPost: $e\n");
}

Documentation for API Endpoints

All URIs are relative to /api/v1

ClassMethodHTTP requestDescription
AccountApiresellerAccountAddSubscriptionPostPOST /reseller/account (addSubscription)
AccountApiresellerAccountChangeOnExpiryOnSubscriptionPostPOST /reseller/account (changeOnExpiryOnSubscription)
AccountApiresellerAccountChangeSubscriptionPostPOST /reseller/account (changeSubscription)
AccountApiresellerAccountCreateSitePostPOST /reseller/account (createSite)
AccountApiresellerAccountDeleteCustomDataPostPOST /reseller/account (deleteCustomData)
AccountApiresellerAccountGetAttachedDomainsPostPOST /reseller/account (GetAttachedDomains)
AccountApiresellerAccountGetCustomDataPostPOST /reseller/account (getCustomData)
AccountApiresellerAccountGetEmailsPostPOST /reseller/account (getEmails)
AccountApiresellerAccountGetInfoPostPOST /reseller/account (getInfo)
AccountApiresellerAccountGetSitesPostPOST /reseller/account (getSites)
AccountApiresellerAccountGetSubscriptionsPostPOST /reseller/account (getSubscriptions)
AccountApiresellerAccountMoveSubscriptionPostPOST /reseller/account (moveSubscription)
AccountApiresellerAccountMoveSubscriptionToV5PostPOST /reseller/account (moveSubscriptionToV5)
AccountApiresellerAccountRenewSubscriptionPostPOST /reseller/account (renewSubscription)
AccountApiresellerAccountSetCustomDataPostPOST /reseller/account (setCustomData)
AccountApiresellerAccountSuspendSubscriptionPostPOST /reseller/account (suspendSubscription)
AccountApiresellerAccountTerminatePostPOST /reseller/account (terminate)
AccountApiresellerAccountTerminateSubscriptionPostPOST /reseller/account (terminateSubscription)
AccountApiresellerAccountUnsuspendSubscriptionPostPOST /reseller/account (unsuspendSubscription)
AccountApiresellerAccountUpdateInfoPostPOST /reseller/account (updateInfo)
DomainApiresellerAccountDomainGetDNSPostPOST /reseller/account/domain (getDNS)
DomainApiresellerAccountDomainGetEPPCodePostPOST /reseller/account/domain (getEPPCode)
DomainApiresellerAccountDomainGetInfoPostPOST /reseller/account/domain (getInfo)
DomainApiresellerAccountDomainGetLockStatePostPOST /reseller/account/domain (getLockState)
DomainApiresellerAccountDomainGetRegisterDomainPeriodsPostPOST /reseller/account/domain (getRegisterDomainPeriods)
DomainApiresellerAccountDomainGetRegistrantVerificationStatusPostPOST /reseller/account/domain (getRegistrantVerificationStatus)
DomainApiresellerAccountDomainGetStatusPostPOST /reseller/account/domain (getStatus)
DomainApiresellerAccountDomainGetTransferStatusPostPOST /reseller/account/domain (getTransferStatus)
DomainApiresellerAccountDomainHostingPostPOST /reseller/account/domain (hosting)
DomainApiresellerAccountDomainRegisterPostPOST /reseller/account/domain (register)
DomainApiresellerAccountDomainRenewPostPOST /reseller/account/domain (renew)
DomainApiresellerAccountDomainResendVerificationEmailPostPOST /reseller/account/domain (resendVerificationEmail)
DomainApiresellerAccountDomainResetDNSPostPOST /reseller/account/domain (resetDNS)
DomainApiresellerAccountDomainSaveDNSPostPOST /reseller/account/domain (saveDNS)
DomainApiresellerAccountDomainSetEPPCodePostPOST /reseller/account/domain (setEPPCode)
DomainApiresellerAccountDomainSetLockStatePostPOST /reseller/account/domain (setLockState)
DomainApiresellerAccountDomainTransferPostPOST /reseller/account/domain (transfer)
DomainApiresellerAccountDomainUpdateContactSetPostPOST /reseller/account/domain (updateContactSet)
DomainApiresellerAccountDomainUpdateOwnerEmailPostPOST /reseller/account/domain (updateOwnerEmail)
EmailApiresellerAccountEmailAddAliasesPostPOST /reseller/account/email (addAliases)
EmailApiresellerAccountEmailCreateForwardPostPOST /reseller/account/email (createForward)
EmailApiresellerAccountEmailCreatePostPOST /reseller/account/email (create)
EmailApiresellerAccountEmailDeletePostPOST /reseller/account/email (delete)
EmailApiresellerAccountEmailGetInfoPostPOST /reseller/account/email (getInfo)
EmailApiresellerAccountEmailGetLoginPostPOST /reseller/account/email (getLogin)
EmailApiresellerAccountEmailGetPostPOST /reseller/account/email (get)
EmailApiresellerAccountEmailGetSuspendedStatusPostPOST /reseller/account/email (getSuspendedStatus)
EmailApiresellerAccountEmailRemoveAliasesPostPOST /reseller/account/email (removeAliases)
EmailApiresellerAccountEmailRenamePostPOST /reseller/account/email (rename)
EmailApiresellerAccountEmailSetAliasesPostPOST /reseller/account/email (setAliases)
EmailApiresellerAccountEmailSetPasswordPostPOST /reseller/account/email (setPassword)
LogsApiresellerLogGetInfoPostPOST /reseller/log (getInfo)
ResellerApiresellerCheckTransferPostPOST /reseller (checkTransfer)
ResellerApiresellerConnectUserToResellerPostPOST /reseller (connectUserToReseller)
ResellerApiresellerCreateAccountPostPOST /reseller (createAccount)
ResellerApiresellerCreateUserPostPOST /reseller (createUser)
ResellerApiresellerDeleteUserPostPOST /reseller (deleteUser)
ResellerApiresellerDomainCheckAvailabilityPostPOST /reseller (domainCheckAvailability)
ResellerApiresellerDomainSuggestionsPostPOST /reseller (domainSuggestions)
ResellerApiresellerGetAccountByEmailPostPOST /reseller (getAccountByEmail)
ResellerApiresellerGetAccountStatsDataPostPOST /reseller (getAccountStatsData)
ResellerApiresellerGetAccountsByEmailPostPOST /reseller (getAccountsByEmail)
ResellerApiresellerGetAvailableProductsPostPOST /reseller (getAvailableProducts)
ResellerApiresellerGetDomainsPostPOST /reseller (getDomains)
ResellerApiresellerGetExtraFieldsPostPOST /reseller (getExtraFields)
ResellerApiresellerGetHeadingsPostPOST /reseller (getHeadings)
ResellerApiresellerGetInfoPostPOST /reseller (getInfo)
ResellerApiresellerGetLatestSiteActivitiesPostPOST /reseller (getLatestSiteActivities)
ResellerApiresellerGetProductPricingPostPOST /reseller (getProductPricing)
ResellerApiresellerGetProductsByProductNamePostPOST /reseller (getProductsByProductName)
ResellerApiresellerGetResellerProductsPostPOST /reseller (getResellerProducts)
ResellerApiresellerGetResellerUserPostPOST /reseller (getResellerUser)
ResellerApiresellerGetResellerUsersPostPOST /reseller (getResellerUsers)
ResellerApiresellerGetSSLOverviewPostPOST /reseller (getSSLOverview)
ResellerApiresellerGetSitesPostPOST /reseller (getSites)
ResellerApiresellerGetSubscriptionsPostPOST /reseller (getSubscriptions)
ResellerApiresellerGetTemplatesPostPOST /reseller (getTemplates)
ResellerApiresellerGlobalSearchPostPOST /reseller (globalSearch)
ResellerApiresellerImageSearchPostPOST /reseller (ImageSearch)
ResellerApiresellerMapExternalDataPostPOST /reseller (mapExternalData)
ResellerApiresellerResellerSiteLoginUsernamePasswordPostPOST /reseller (resellerSiteLoginUsernamePassword)
ResellerApiresellerResellerUserLoginPostPOST /reseller (resellerUserLogin)
ResellerApiresellerSearchAccountBySiteIdPostPOST /reseller (searchAccountBySiteId)
ResellerApiresellerSearchAccountsPostPOST /reseller (searchAccounts)
ResellerApiresellerSearchSitesPostPOST /reseller (searchSites)
ResellerApiresellerSiteLoginPostPOST /reseller (siteLogin)
ResellerApiresellerUpdateUserPostPOST /reseller (updateUser)
ResellerApiresellerValidateUsernamePostPOST /reseller (validateUsername)
SchedulingApiresellerAccountSiteSchedulingCreateServicePostPOST /reseller/account/site/scheduling (createService)
SchedulingApiresellerAccountSiteSchedulingCreateStaffPostPOST /reseller/account/site/scheduling (createStaff)
SchedulingApiresellerAccountSiteSchedulingDeleteServicePostPOST /reseller/account/site/scheduling (deleteService)
SchedulingApiresellerAccountSiteSchedulingDeleteStaffPostPOST /reseller/account/site/scheduling (deleteStaff)
SchedulingApiresellerAccountSiteSchedulingGetAllSettingsPostPOST /reseller/account/site/scheduling (GetAllSettings)
SchedulingApiresellerAccountSiteSchedulingGetBookingRecordsPostPOST /reseller/account/site/scheduling (GetBookingRecords)
SchedulingApiresellerAccountSiteSchedulingGetLocationsPostPOST /reseller/account/site/scheduling (getLocations)
SchedulingApiresellerAccountSiteSchedulingGetOpenHoursPostPOST /reseller/account/site/scheduling (GetOpenHours)
SchedulingApiresellerAccountSiteSchedulingGetSettingPostPOST /reseller/account/site/scheduling (GetSetting)
SchedulingApiresellerAccountSiteSchedulingGetSpecialOpenHoursPostPOST /reseller/account/site/scheduling (GetSpecialOpenHours)
SchedulingApiresellerAccountSiteSchedulingGetTimeOffPostPOST /reseller/account/site/scheduling (GetTimeOff)
SchedulingApiresellerAccountSiteSchedulingUpdateAppointmentStatusPostPOST /reseller/account/site/scheduling (UpdateAppointmentStatus)
SchedulingApiresellerAccountSiteSchedulingUpdateServicePostPOST /reseller/account/site/scheduling (updateService)
SchedulingApiresellerAccountSiteSchedulingUpdateStaffPostPOST /reseller/account/site/scheduling (updateStaff)
SchedulingApiresellerAccountSiteSchedulingUpsertOpenHoursPostPOST /reseller/account/site/scheduling (UpsertOpenHours)
SchedulingApiresellerAccountSiteSchedulingUpsertSettingsPostPOST /reseller/account/site/scheduling (UpsertSettings)
SchedulingApiresellerAccountSiteSchedulingUpsertSpecialOpenHoursPostPOST /reseller/account/site/scheduling (UpsertSpecialOpenHours)
SchedulingApiresellerAccountSiteSchedulingUpsertTimeOffPostPOST /reseller/account/site/scheduling (UpsertTimeOff)
SiteApiresellerAccountSiteAddDomainPostPOST /reseller/account/site (addDomain)
SiteApiresellerAccountSiteAddStatServerPostPOST /reseller/account/site (addStatServer)
SiteApiresellerAccountSiteApiLoginPostPOST /reseller/account/site (apiLogin)
SiteApiresellerAccountSiteChangeTypePostPOST /reseller/account/site (changeType)
SiteApiresellerAccountSiteCheckDomainPostPOST /reseller/account/site (checkDomain)
SiteApiresellerAccountSiteClearCachePostPOST /reseller/account/site (clearCache)
SiteApiresellerAccountSiteContentSyncPostPOST /reseller/account/site (contentSync)
SiteApiresellerAccountSiteCopyContentPostPOST /reseller/account/site (copyContent)
SiteApiresellerAccountSiteCopyDesignPostPOST /reseller/account/site (copyDesign)
SiteApiresellerAccountSiteDeleteTemplatePostPOST /reseller/account/site (deleteTemplate)
SiteApiresellerAccountSiteGetContentPostPOST /reseller/account/site (getContent)
SiteApiresellerAccountSiteGetCustomFieldsPostPOST /reseller/account/site (getCustomFields)
SiteApiresellerAccountSiteGetDomainsPostPOST /reseller/account/site (getDomains)
SiteApiresellerAccountSiteGetGlobalDataPostPOST /reseller/account/site (getGlobalData)
SiteApiresellerAccountSiteGetInfoPostPOST /reseller/account/site (getInfo)
SiteApiresellerAccountSiteGetSMTPPostPOST /reseller/account/site (getSMTP)
SiteApiresellerAccountSiteGetSettingsPostPOST /reseller/account/site (getSettings)
SiteApiresellerAccountSiteGetSubscriptionsPostPOST /reseller/account/site (getSubscriptions)
SiteApiresellerAccountSiteLockSitePostPOST /reseller/account/site (lockSite)
SiteApiresellerAccountSiteMigrateContentFromPostPOST /reseller/account/site (migrateContentFrom)
SiteApiresellerAccountSiteMoveToAccountPostPOST /reseller/account/site (moveToAccount)
SiteApiresellerAccountSitePublishContentPostPOST /reseller/account/site (publishContent)
SiteApiresellerAccountSiteRefreshHtaccessPostPOST /reseller/account/site (refreshHtaccess)
SiteApiresellerAccountSiteRemoveDomainPostPOST /reseller/account/site (removeDomain)
SiteApiresellerAccountSiteRemoveStatServerPostPOST /reseller/account/site (removeStatServer)
SiteApiresellerAccountSiteSetAutoProvisionSslPostPOST /reseller/account/site (setAutoProvisionSsl)Set auto provision SSL
SiteApiresellerAccountSiteSetBrandingPostPOST /reseller/account/site (setBranding)
SiteApiresellerAccountSiteSetContentFromSourcePostPOST /reseller/account/site (setContentFromSource)
SiteApiresellerAccountSiteSetContentPostPOST /reseller/account/site (setContent)
SiteApiresellerAccountSiteSetCustomFieldsPostPOST /reseller/account/site (setCustomFields)
SiteApiresellerAccountSiteSetGlobalDataPostPOST /reseller/account/site (setGlobalData)
SiteApiresellerAccountSiteSetNoIndexPostPOST /reseller/account/site (setNoIndex)
SiteApiresellerAccountSiteSetPreviewPostPOST /reseller/account/site (setPreview)
SiteApiresellerAccountSiteSetSMTPPostPOST /reseller/account/site (setSMTP)
SiteApiresellerAccountSiteSuspendPostPOST /reseller/account/site (suspend)
SiteApiresellerAccountSiteTerminatePostPOST /reseller/account/site (terminate)
SiteApiresellerAccountSiteUnlockSitePostPOST /reseller/account/site (unlockSite)
SiteApiresellerAccountSiteUnpublishContentPostPOST /reseller/account/site (unpublishContent)
SiteApiresellerAccountSiteUnsuspendPostPOST /reseller/account/site (unsuspend)
SiteApiresellerAccountSiteUpdateInfoPostPOST /reseller/account/site (updateInfo)
SiteApiresellerAccountSiteUpdateSettingsPostPOST /reseller/account/site (updateSettings)
SslApiresellerAccountSslEnableLetsEncryptPostPOST /reseller/account/ssl (enableLetsEncrypt)
SslApiresellerAccountSslGetSSLListPostPOST /reseller/account/ssl (getSSLList)
StatApiresellerStatGetSiteStatPostPOST /reseller/stat (getSiteStat)
StatApiresellerStatGetStatBulkPostPOST /reseller/stat (getStatBulk)

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author