package
1.3.4
Repository: https://github.com/10gen/realm-cli.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
Package mock_api is a generated GoMock package.

# Functions

NewAuthClient returns a new *AuthClient.
NewClient returns a new Client.
NewRealmClient returns a new RealmClient to be used for making calls to the Realm Admin API.
UnmarshalRealmError unmarshals an *http.Response into an ErrRealmResponse.

# Constants

DefaultAtlasBaseURL is the default atlas prod base url.
DefaultBaseURL is the default prod base url for Realm apps.
ExportStrategyNone will result in no extra configuration into the call to Export.
ExportStrategySourceControl will result in the `source_control` querystring parameter getting added to the call to Export.
ExportStrategyTemplate will result in the `template` querystring parameter getting added to the call to Export.
RealmCLIHeaderValue is the value of the RealmRequestOriginHeader if the request is from the CLI.
RealmRequestOriginHeader is the name of the header for where the api request is coming from (UI, CLI, ADMIN API).

# Structs

AuthClient is a Client that is aware of a User's auth credentials.
ErrAppNotFound is used when an app cannot be found by client app ID.
ErrRealmResponse represents a response from a Realm API call.
RequestOptions represents a simple set of options to use with HTTP requests.

# Interfaces

Client represents something that is capable of making HTTP requests.
RealmClient represents a Client that can be used to call the Realm Admin API.

# Type aliases

ExportStrategy is the enumeration of possible strategies which can be used when exporting a realm application.