Welcome to the MagicbellProjectClient SDK documentation. This guide will help you get started with integrating and using the MagicbellProjectClient SDK in your project.
- API version:
2.0.0 - SDK version:
0.1.1
OpenAPI 3.1.0 Specification for MagicBell API.
This SDK is compatible with the following versions: Go >= 1.19.0
The magicbell-project-client API uses an Access Token for authentication.
This token must be provided to authenticate your requests to the API.
When you initialize the SDK, you can set the access token as follows:
import (
"github.com/magicbell/magicbell-go-project-client/pkg/magicbellprojectclient"
"github.com/magicbell/magicbell-go-project-client/pkg/magicbellprojectclientconfig"
)
config := magicbellprojectclientconfig.NewConfig()
config.SetAccessToken("YOUR-TOKEN")
sdk := magicbellprojectclient.NewMagicbellProjectClient(config)If you need to set or update the access token after initializing the SDK, you can use:
import (
"github.com/magicbell/magicbell-go-project-client/pkg/magicbellprojectclient"
"github.com/magicbell/magicbell-go-project-client/pkg/magicbellprojectclientconfig"
)
config := magicbellprojectclientconfig.NewConfig()
sdk := magicbellprojectclient.NewMagicbellProjectClient(config)
sdk.SetAccessToken("YOUR-TOKEN")The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
| Name |
|---|
| BroadcastsService |
| ChannelsService |
| EventsService |
| IntegrationsService |
| JwtService |
| NotificationsService |
| UsersService |
All services use response wrappers to provide a consistent interface to return the responses from the API.
The response wrapper itself is a generic struct that contains the response data and metadata.
Below are the response wrappers used in the SDK:
This response wrapper is used to return the response data from the API. It contains the following fields:
| Name | Type | Description |
|---|---|---|
| Data | T |
The body of the API response |
| Metadata | MagicbellProjectClientResponseMetadata |
Status code and headers returned by the API |
This response wrapper is used to return an error. It contains the following fields:
| Name | Type | Description |
|---|---|---|
| Err | error |
The error that occurred |
| Body | T |
The body of the API response |
| Metadata | MagicbellProjectClientResponseMetadata |
Status code and headers returned by the API |
This struct is shared by both response wrappers and contains the following fields:
| Name | Type | Description |
|---|---|---|
| Headers | map[string]string |
A map containing the headers returned by the API |
| StatusCode | int |
The status code returned by the API |
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
Below is a list of all available models with links to their detailed documentation:
This SDK is licensed under the MIT License.
See the LICENSE file for more details.