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

Class Method HTTP request Description
AccountApi resellerAccountAddSubscriptionPost POST /reseller/account (addSubscription)
AccountApi resellerAccountChangeOnExpiryOnSubscriptionPost POST /reseller/account (changeOnExpiryOnSubscription)
AccountApi resellerAccountChangeSubscriptionPost POST /reseller/account (changeSubscription)
AccountApi resellerAccountCreateSitePost POST /reseller/account (createSite)
AccountApi resellerAccountDeleteCustomDataPost POST /reseller/account (deleteCustomData)
AccountApi resellerAccountGetAttachedDomainsPost POST /reseller/account (GetAttachedDomains)
AccountApi resellerAccountGetCustomDataPost POST /reseller/account (getCustomData)
AccountApi resellerAccountGetEmailsPost POST /reseller/account (getEmails)
AccountApi resellerAccountGetInfoPost POST /reseller/account (getInfo)
AccountApi resellerAccountGetSitesPost POST /reseller/account (getSites)
AccountApi resellerAccountGetSubscriptionsPost POST /reseller/account (getSubscriptions)
AccountApi resellerAccountMoveSubscriptionPost POST /reseller/account (moveSubscription)
AccountApi resellerAccountMoveSubscriptionToV5Post POST /reseller/account (moveSubscriptionToV5)
AccountApi resellerAccountRenewSubscriptionPost POST /reseller/account (renewSubscription)
AccountApi resellerAccountSetCustomDataPost POST /reseller/account (setCustomData)
AccountApi resellerAccountSuspendSubscriptionPost POST /reseller/account (suspendSubscription)
AccountApi resellerAccountTerminatePost POST /reseller/account (terminate)
AccountApi resellerAccountTerminateSubscriptionPost POST /reseller/account (terminateSubscription)
AccountApi resellerAccountUnsuspendSubscriptionPost POST /reseller/account (unsuspendSubscription)
AccountApi resellerAccountUpdateInfoPost POST /reseller/account (updateInfo)
DomainApi resellerAccountDomainGetDNSPost POST /reseller/account/domain (getDNS)
DomainApi resellerAccountDomainGetEPPCodePost POST /reseller/account/domain (getEPPCode)
DomainApi resellerAccountDomainGetInfoPost POST /reseller/account/domain (getInfo)
DomainApi resellerAccountDomainGetLockStatePost POST /reseller/account/domain (getLockState)
DomainApi resellerAccountDomainGetRegisterDomainPeriodsPost POST /reseller/account/domain (getRegisterDomainPeriods)
DomainApi resellerAccountDomainGetRegistrantVerificationStatusPost POST /reseller/account/domain (getRegistrantVerificationStatus)
DomainApi resellerAccountDomainGetStatusPost POST /reseller/account/domain (getStatus)
DomainApi resellerAccountDomainGetTransferStatusPost POST /reseller/account/domain (getTransferStatus)
DomainApi resellerAccountDomainHostingPost POST /reseller/account/domain (hosting)
DomainApi resellerAccountDomainRegisterPost POST /reseller/account/domain (register)
DomainApi resellerAccountDomainRenewPost POST /reseller/account/domain (renew)
DomainApi resellerAccountDomainResendVerificationEmailPost POST /reseller/account/domain (resendVerificationEmail)
DomainApi resellerAccountDomainResetDNSPost POST /reseller/account/domain (resetDNS)
DomainApi resellerAccountDomainSaveDNSPost POST /reseller/account/domain (saveDNS)
DomainApi resellerAccountDomainSetEPPCodePost POST /reseller/account/domain (setEPPCode)
DomainApi resellerAccountDomainSetLockStatePost POST /reseller/account/domain (setLockState)
DomainApi resellerAccountDomainTransferPost POST /reseller/account/domain (transfer)
DomainApi resellerAccountDomainUpdateContactSetPost POST /reseller/account/domain (updateContactSet)
DomainApi resellerAccountDomainUpdateOwnerEmailPost POST /reseller/account/domain (updateOwnerEmail)
EmailApi resellerAccountEmailAddAliasesPost POST /reseller/account/email (addAliases)
EmailApi resellerAccountEmailCreateForwardPost POST /reseller/account/email (createForward)
EmailApi resellerAccountEmailCreatePost POST /reseller/account/email (create)
EmailApi resellerAccountEmailDeletePost POST /reseller/account/email (delete)
EmailApi resellerAccountEmailGetInfoPost POST /reseller/account/email (getInfo)
EmailApi resellerAccountEmailGetLoginPost POST /reseller/account/email (getLogin)
EmailApi resellerAccountEmailGetPost POST /reseller/account/email (get)
EmailApi resellerAccountEmailGetSuspendedStatusPost POST /reseller/account/email (getSuspendedStatus)
EmailApi resellerAccountEmailRemoveAliasesPost POST /reseller/account/email (removeAliases)
EmailApi resellerAccountEmailRenamePost POST /reseller/account/email (rename)
EmailApi resellerAccountEmailSetAliasesPost POST /reseller/account/email (setAliases)
EmailApi resellerAccountEmailSetPasswordPost POST /reseller/account/email (setPassword)
LogsApi resellerLogGetInfoPost POST /reseller/log (getInfo)
ResellerApi resellerCheckTransferPost POST /reseller (checkTransfer)
ResellerApi resellerConnectUserToResellerPost POST /reseller (connectUserToReseller)
ResellerApi resellerCreateAccountPost POST /reseller (createAccount)
ResellerApi resellerCreateUserPost POST /reseller (createUser)
ResellerApi resellerDeleteUserPost POST /reseller (deleteUser)
ResellerApi resellerDomainCheckAvailabilityPost POST /reseller (domainCheckAvailability)
ResellerApi resellerDomainSuggestionsPost POST /reseller (domainSuggestions)
ResellerApi resellerGetAccountByEmailPost POST /reseller (getAccountByEmail)
ResellerApi resellerGetAccountStatsDataPost POST /reseller (getAccountStatsData)
ResellerApi resellerGetAccountsByEmailPost POST /reseller (getAccountsByEmail)
ResellerApi resellerGetAvailableProductsPost POST /reseller (getAvailableProducts)
ResellerApi resellerGetDomainsPost POST /reseller (getDomains)
ResellerApi resellerGetExtraFieldsPost POST /reseller (getExtraFields)
ResellerApi resellerGetHeadingsPost POST /reseller (getHeadings)
ResellerApi resellerGetInfoPost POST /reseller (getInfo)
ResellerApi resellerGetLatestSiteActivitiesPost POST /reseller (getLatestSiteActivities)
ResellerApi resellerGetProductPricingPost POST /reseller (getProductPricing)
ResellerApi resellerGetProductsByProductNamePost POST /reseller (getProductsByProductName)
ResellerApi resellerGetResellerProductsPost POST /reseller (getResellerProducts)
ResellerApi resellerGetResellerUserPost POST /reseller (getResellerUser)
ResellerApi resellerGetResellerUsersPost POST /reseller (getResellerUsers)
ResellerApi resellerGetSSLOverviewPost POST /reseller (getSSLOverview)
ResellerApi resellerGetSitesPost POST /reseller (getSites)
ResellerApi resellerGetSubscriptionsPost POST /reseller (getSubscriptions)
ResellerApi resellerGetTemplatesPost POST /reseller (getTemplates)
ResellerApi resellerGlobalSearchPost POST /reseller (globalSearch)
ResellerApi resellerImageSearchPost POST /reseller (ImageSearch)
ResellerApi resellerMapExternalDataPost POST /reseller (mapExternalData)
ResellerApi resellerResellerSiteLoginUsernamePasswordPost POST /reseller (resellerSiteLoginUsernamePassword)
ResellerApi resellerResellerUserLoginPost POST /reseller (resellerUserLogin)
ResellerApi resellerSearchAccountBySiteIdPost POST /reseller (searchAccountBySiteId)
ResellerApi resellerSearchAccountsPost POST /reseller (searchAccounts)
ResellerApi resellerSearchSitesPost POST /reseller (searchSites)
ResellerApi resellerSiteLoginPost POST /reseller (siteLogin)
ResellerApi resellerUpdateUserPost POST /reseller (updateUser)
ResellerApi resellerValidateUsernamePost POST /reseller (validateUsername)
SchedulingApi resellerAccountSiteSchedulingCreateServicePost POST /reseller/account/site/scheduling (createService)
SchedulingApi resellerAccountSiteSchedulingCreateStaffPost POST /reseller/account/site/scheduling (createStaff)
SchedulingApi resellerAccountSiteSchedulingDeleteServicePost POST /reseller/account/site/scheduling (deleteService)
SchedulingApi resellerAccountSiteSchedulingDeleteStaffPost POST /reseller/account/site/scheduling (deleteStaff)
SchedulingApi resellerAccountSiteSchedulingGetAllSettingsPost POST /reseller/account/site/scheduling (GetAllSettings)
SchedulingApi resellerAccountSiteSchedulingGetBookingRecordsPost POST /reseller/account/site/scheduling (GetBookingRecords)
SchedulingApi resellerAccountSiteSchedulingGetLocationsPost POST /reseller/account/site/scheduling (getLocations)
SchedulingApi resellerAccountSiteSchedulingGetOpenHoursPost POST /reseller/account/site/scheduling (GetOpenHours)
SchedulingApi resellerAccountSiteSchedulingGetSettingPost POST /reseller/account/site/scheduling (GetSetting)
SchedulingApi resellerAccountSiteSchedulingGetSpecialOpenHoursPost POST /reseller/account/site/scheduling (GetSpecialOpenHours)
SchedulingApi resellerAccountSiteSchedulingGetTimeOffPost POST /reseller/account/site/scheduling (GetTimeOff)
SchedulingApi resellerAccountSiteSchedulingUpdateAppointmentStatusPost POST /reseller/account/site/scheduling (UpdateAppointmentStatus)
SchedulingApi resellerAccountSiteSchedulingUpdateServicePost POST /reseller/account/site/scheduling (updateService)
SchedulingApi resellerAccountSiteSchedulingUpdateStaffPost POST /reseller/account/site/scheduling (updateStaff)
SchedulingApi resellerAccountSiteSchedulingUpsertOpenHoursPost POST /reseller/account/site/scheduling (UpsertOpenHours)
SchedulingApi resellerAccountSiteSchedulingUpsertSettingsPost POST /reseller/account/site/scheduling (UpsertSettings)
SchedulingApi resellerAccountSiteSchedulingUpsertSpecialOpenHoursPost POST /reseller/account/site/scheduling (UpsertSpecialOpenHours)
SchedulingApi resellerAccountSiteSchedulingUpsertTimeOffPost POST /reseller/account/site/scheduling (UpsertTimeOff)
SiteApi resellerAccountSiteAddDomainPost POST /reseller/account/site (addDomain)
SiteApi resellerAccountSiteAddStatServerPost POST /reseller/account/site (addStatServer)
SiteApi resellerAccountSiteApiLoginPost POST /reseller/account/site (apiLogin)
SiteApi resellerAccountSiteChangeTypePost POST /reseller/account/site (changeType)
SiteApi resellerAccountSiteCheckDomainPost POST /reseller/account/site (checkDomain)
SiteApi resellerAccountSiteClearCachePost POST /reseller/account/site (clearCache)
SiteApi resellerAccountSiteContentSyncPost POST /reseller/account/site (contentSync)
SiteApi resellerAccountSiteCopyContentPost POST /reseller/account/site (copyContent)
SiteApi resellerAccountSiteCopyDesignPost POST /reseller/account/site (copyDesign)
SiteApi resellerAccountSiteDeleteTemplatePost POST /reseller/account/site (deleteTemplate)
SiteApi resellerAccountSiteGetContentPost POST /reseller/account/site (getContent)
SiteApi resellerAccountSiteGetCustomFieldsPost POST /reseller/account/site (getCustomFields)
SiteApi resellerAccountSiteGetDomainsPost POST /reseller/account/site (getDomains)
SiteApi resellerAccountSiteGetGlobalDataPost POST /reseller/account/site (getGlobalData)
SiteApi resellerAccountSiteGetInfoPost POST /reseller/account/site (getInfo)
SiteApi resellerAccountSiteGetSMTPPost POST /reseller/account/site (getSMTP)
SiteApi resellerAccountSiteGetSettingsPost POST /reseller/account/site (getSettings)
SiteApi resellerAccountSiteGetSubscriptionsPost POST /reseller/account/site (getSubscriptions)
SiteApi resellerAccountSiteLockSitePost POST /reseller/account/site (lockSite)
SiteApi resellerAccountSiteMigrateContentFromPost POST /reseller/account/site (migrateContentFrom)
SiteApi resellerAccountSiteMoveToAccountPost POST /reseller/account/site (moveToAccount)
SiteApi resellerAccountSitePublishContentPost POST /reseller/account/site (publishContent)
SiteApi resellerAccountSiteRefreshHtaccessPost POST /reseller/account/site (refreshHtaccess)
SiteApi resellerAccountSiteRemoveDomainPost POST /reseller/account/site (removeDomain)
SiteApi resellerAccountSiteRemoveStatServerPost POST /reseller/account/site (removeStatServer)
SiteApi resellerAccountSiteSetAutoProvisionSslPost POST /reseller/account/site (setAutoProvisionSsl) Set auto provision SSL
SiteApi resellerAccountSiteSetBrandingPost POST /reseller/account/site (setBranding)
SiteApi resellerAccountSiteSetContentFromSourcePost POST /reseller/account/site (setContentFromSource)
SiteApi resellerAccountSiteSetContentPost POST /reseller/account/site (setContent)
SiteApi resellerAccountSiteSetCustomFieldsPost POST /reseller/account/site (setCustomFields)
SiteApi resellerAccountSiteSetGlobalDataPost POST /reseller/account/site (setGlobalData)
SiteApi resellerAccountSiteSetNoIndexPost POST /reseller/account/site (setNoIndex)
SiteApi resellerAccountSiteSetPreviewPost POST /reseller/account/site (setPreview)
SiteApi resellerAccountSiteSetSMTPPost POST /reseller/account/site (setSMTP)
SiteApi resellerAccountSiteSuspendPost POST /reseller/account/site (suspend)
SiteApi resellerAccountSiteTerminatePost POST /reseller/account/site (terminate)
SiteApi resellerAccountSiteUnlockSitePost POST /reseller/account/site (unlockSite)
SiteApi resellerAccountSiteUnpublishContentPost POST /reseller/account/site (unpublishContent)
SiteApi resellerAccountSiteUnsuspendPost POST /reseller/account/site (unsuspend)
SiteApi resellerAccountSiteUpdateInfoPost POST /reseller/account/site (updateInfo)
SiteApi resellerAccountSiteUpdateSettingsPost POST /reseller/account/site (updateSettings)
SslApi resellerAccountSslEnableLetsEncryptPost POST /reseller/account/ssl (enableLetsEncrypt)
SslApi resellerAccountSslGetSSLListPost POST /reseller/account/ssl (getSSLList)
StatApi resellerStatGetSiteStatPost POST /reseller/stat (getSiteStat)
StatApi resellerStatGetStatBulkPost POST /reseller/stat (getStatBulk)

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Libraries

monosolutions_hal_api