🚀 Installation
|
📚 Documentation
|
🧪 Examples & Tests
|
🤖 AI Usage
|
🛠️ Code Standards
|
🤝 Contributing
|
go-drift requires a supported release of Go.
go get -u github.com/mrz1836/go-drift/driftView the generated documentation
Heads up!
go-driftis intentionally light on dependencies. The only external package it uses is the excellenttestifysuite—and that's just for our tests. You can drop this library into your projects without dragging along extra baggage.
- Current coverage for the Drift API
- Contacts API
- Creating a Contact
- Updating a Contact
- Retrieving Contacts
- Deleting a Contact
- Unsubscribe Contacts from Emails
- Posting Timeline Events
- Listing Custom Attributes
- Users API
- Retrieving User
- Listing Users
- Updating a User
- Get Booked Meetings
- Conversations & Messages API
- Creating a Message
- Listing Conversations
- Retrieving a Conversation
- Retrieving a Conversation's Messages
- Retrieving a Conversation's Transcript
- Retrieving a Conversation's Attachments
- Creating a new Conversation
- Bulk Conversation Statuses
- Accounts API
- Creating an Account
- Retrieving an account
- Listing Accounts
- Updating Accounts
- Deleting Accounts
- Teams API
- Listing Teams (Org)
- Listing Teams by User
- Playbooks API
- Retrieving Bot Playbooks
- Retrieving Conversational Landing Pages
- Admin API
- Trigger App Uninstall
- Get Token Information
- GDPR API
- GDPR Retrieval
- GDPR Deletion
- Contacts API
Development Setup (Getting Started)
Install MAGE-X build tool for development:
# Install MAGE-X for development and building
go install github.com/mrz1836/mage-x/cmd/magex@latest
magex update:installLibrary Deployment
This project uses goreleaser for streamlined binary and library deployment to GitHub. To get started, install it via:
brew install goreleaserThe release process is defined in the .goreleaser.yml configuration file.
Then create and push a new Git tag using:
magex version:bump bump=patch push=true branch=masterThis process ensures consistent, repeatable releases with properly versioned artifacts and citation metadata.
Build Commands
View all build commands
magex helpGitHub Workflows
All workflows are driven by modular configuration in .github/env/ — no YAML editing required.
Updating Dependencies
To update all dependencies (Go modules, linters, and related tools), run:
magex deps:updateThis command ensures all dependencies are brought up to date in a single step, including Go modules and any managed tools. It is the recommended way to keep your development environment and CI in sync with the latest versions.
All unit tests and fuzz tests run via GitHub Actions and use Go version 1.18.x. View the configuration file.
Run all tests (fast):
magex testRun all tests with race detector (slower):
magex test:raceRun the Go benchmarks:
magex benchRead more about this Go project's code standards.
Read the AI Usage & Assistant Guidelines for details on how AI is used in this project and how to interact with the AI assistants.
 |
|---|
| MrZ |
View the contributing guidelines and please follow the code of conduct.
All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬. You can also support this project by becoming a sponsor on GitHub 👏 or by making a bitcoin donation to ensure this journey continues indefinitely! 🚀
Drift for their hard work on the API
