# Functions
GetMode returns the mode of operation of the package.
NewBegetRequest creates a new [BegetRequest].
PrepareRequest is a function to prepare request to Beget.API system.
PrepareRequestWithClient is a function to prepare request to Beget.API system and specify http client.
SetMode sets the mode of operation of the package.
SetTestHost sets the Beget API host for testing.
# Constants
authorization error.
call is failed.
prefix of api endpoint.
an error indicating an incorrect API request.
validation error of the transmitted data.
JSON format (supports only a json format).
failure to complete due to reaching any limit (for example, the limit of sites or the limit of API requests is exceeded (no more than 60 requests per minute for the user)).
internal error when executing the method.
the specified method does not exist.
Prod mode.
call is successful.
Test mode.
name of user agent.
# Variables
"method was executed without a success result, it returns error".
"method was executed with a success result, it does not return error".
"general API was executed without a success result, it returns error".
"general API was executed with a success result, it does not return error".
"api method got some error".
"invalid beget hostname".
# Structs
Answer defines the response of the specific method part of the API.
BegetRequest is a prepared request to Beget,API.
BegetResponse defines the response of the general part of the API.
Client is a client of Beget.com to access by API.
Error is the type to represent an API method call general's errors.
# Interfaces
APIMethod is an interface that describes the methods for the library core to work with the methods of the Beget.Api.
# Type aliases
APIErrorCode represents the error code of the API request response.
Format represents the type of input and output formats for the API request and response, respectively.
MethodErrorCode represents the error code of the method call response.
MethodErrors is the type to represent an API method call method's errors.
MethodName is typed of name of Beget.Api method.
Mode is the mode of operation of the package.
Status represents the status of request to Beget.API.