rename ClientInterface -> MessageBirdClient

Author: vallerion

client.go

@@ -51,7 +51,7 @@ const (
 	FeatureConversationsAPIWhatsAppSandbox Feature = iota
 )
 
-type ClientInterface interface {
+type MessageBirdClient interface {
 	EnableFeatures(feature Feature)
 	DisableFeatures(feature Feature)
 	IsFeatureEnabled(feature Feature) bool

conversation/api.go

@@ -59,7 +59,7 @@ func (lro *PaginationRequest) QueryParams() string {
 // request does the exact same thing as Client.Request. It does, however,
 // prefix the path with the Conversation API's root. This ensures the client
 // doesn't "handle" this for us: by default, it uses the REST API.
-func request(c messagebird.ClientInterface, v interface{}, method, path string, data interface{}) error {
+func request(c messagebird.MessageBirdClient, v interface{}, method, path string, data interface{}) error {
 	var root string
 	if c.IsFeatureEnabled(messagebird.FeatureConversationsAPIWhatsAppSandbox) {
 		root = whatsappSandboxAPIRoot

conversation/conversation.go

@@ -159,7 +159,7 @@ func (lr *ListByContactRequest) QueryParams() string {
 }
 
 // List gets a collection of Conversations. Pagination can be set in options.
-func List(c messagebird.ClientInterface, options *ListRequest) (*ConversationList, error) {
+func List(c messagebird.MessageBirdClient, options *ListRequest) (*ConversationList, error) {
 	convList := &ConversationList{}
 	if err := request(c, convList, http.MethodGet, fmt.Sprintf("%s?%s", path, options.QueryParams()), nil); err != nil {
 		return nil, err
@@ -169,7 +169,7 @@ func List(c messagebird.ClientInterface, options *ListRequest) (*ConversationLis
 }
 
 // ListByContact fetches a collection of Conversations of a specific MessageBird contact ID.
-func ListByContact(c messagebird.ClientInterface, contactId string, options *PaginationRequest) (*ConversationByContactList, error) {
+func ListByContact(c messagebird.MessageBirdClient, contactId string, options *PaginationRequest) (*ConversationByContactList, error) {
 	reqPath := fmt.Sprintf("%s/%s/%s?%s", path, contactPath, contactId, options.QueryParams())
 
 	conv := &ConversationByContactList{}
@@ -181,7 +181,7 @@ func ListByContact(c messagebird.ClientInterface, contactId string, options *Pag
 }
 
 // Read fetches a single Conversation based on its ID.
-func Read(c messagebird.ClientInterface, id string) (*Conversation, error) {
+func Read(c messagebird.MessageBirdClient, id string) (*Conversation, error) {
 	conv := &Conversation{}
 	if err := request(c, conv, http.MethodGet, path+"/"+id, nil); err != nil {
 		return nil, err
@@ -192,7 +192,7 @@ func Read(c messagebird.ClientInterface, id string) (*Conversation, error) {
 
 // Start creates a conversation by sending an initial message. If an active
 // conversation exists for the recipient, it is resumed.
-func Start(c messagebird.ClientInterface, req *StartRequest) (*Conversation, error) {
+func Start(c messagebird.MessageBirdClient, req *StartRequest) (*Conversation, error) {
 	conv := &Conversation{}
 	if err := request(c, conv, http.MethodPost, path+"/"+startConversationPath, req); err != nil {
 		return nil, err
@@ -202,7 +202,7 @@ func Start(c messagebird.ClientInterface, req *StartRequest) (*Conversation, err
 }
 
 // Reply Send a new message to an existing conversation. In case the conversation is archived, a new conversation is created.
-func Reply(c messagebird.ClientInterface, conversationID string, req *ReplyRequest) (*Message, error) {
+func Reply(c messagebird.MessageBirdClient, conversationID string, req *ReplyRequest) (*Message, error) {
 	uri := fmt.Sprintf("%s/%s/%s", path, conversationID, messagesPath)
 
 	message := &Message{}
@@ -215,7 +215,7 @@ func Reply(c messagebird.ClientInterface, conversationID string, req *ReplyReque
 
 // Update changes the conversation's status, so this can be used to (un)archive
 // conversations.
-func Update(c messagebird.ClientInterface, id string, req *UpdateRequest) (*Conversation, error) {
+func Update(c messagebird.MessageBirdClient, id string, req *UpdateRequest) (*Conversation, error) {
 	conv := &Conversation{}
 	if err := request(c, conv, http.MethodPatch, path+"/"+id, req); err != nil {
 		return nil, err

conversation/message.go

@@ -212,7 +212,7 @@ func (lr *ListMessagesRequest) QueryParams() string {
 // SendMessage send a message to a specific recipient in a specific platform.
 // If an active conversation already exists for the recipient, the conversation will be resumed.
 // In case there's no active conversation a new one is created.
-func SendMessage(c messagebird.ClientInterface, options *SendMessageRequest) (*Message, error) {
+func SendMessage(c messagebird.MessageBirdClient, options *SendMessageRequest) (*Message, error) {
 	message := &Message{}
 	if err := request(c, message, http.MethodPost, sendMessagePath, options); err != nil {
 		return nil, err
@@ -223,7 +223,7 @@ func SendMessage(c messagebird.ClientInterface, options *SendMessageRequest) (*M
 
 // ListConversationMessages gets a collection of messages from a conversation.
 // Pagination can be set in the options.
-func ListConversationMessages(c messagebird.ClientInterface, conversationID string, options *ListConversationMessagesRequest) (*MessageList, error) {
+func ListConversationMessages(c messagebird.MessageBirdClient, conversationID string, options *ListConversationMessagesRequest) (*MessageList, error) {
 	uri := fmt.Sprintf("%s/%s/%s?%s", path, conversationID, messagesPath, options.QueryParams())
 
 	messageList := &MessageList{}
@@ -236,7 +236,7 @@ func ListConversationMessages(c messagebird.ClientInterface, conversationID stri
 
 // ListMessages gets a collection of messages from a conversation.
 // Pagination can be set in the options.
-func ListMessages(c messagebird.ClientInterface, options *ListMessagesRequest) (*MessageList, error) {
+func ListMessages(c messagebird.MessageBirdClient, options *ListMessagesRequest) (*MessageList, error) {
 	uri := fmt.Sprintf("%s?%s", messagesPath, options.QueryParams())
 
 	messageList := &MessageList{}
@@ -248,7 +248,7 @@ func ListMessages(c messagebird.ClientInterface, options *ListMessagesRequest) (
 }
 
 // ReadMessage gets a single message based on its ID.
-func ReadMessage(c messagebird.ClientInterface, messageID string) (*Message, error) {
+func ReadMessage(c messagebird.MessageBirdClient, messageID string) (*Message, error) {
 	message := &Message{}
 	if err := request(c, message, http.MethodGet, messagesPath+"/"+messageID, nil); err != nil {
 		return nil, err

conversation/webhook.go

@@ -69,7 +69,7 @@ const (
 
 // CreateWebhook registers a webhook that is invoked when something interesting
 // happens.
-func CreateWebhook(c messagebird.ClientInterface, req *WebhookCreateRequest) (*Webhook, error) {
+func CreateWebhook(c messagebird.MessageBirdClient, req *WebhookCreateRequest) (*Webhook, error) {
 	webhook := &Webhook{}
 	if err := request(c, webhook, http.MethodPost, webhooksPath, req); err != nil {
 		return nil, err
@@ -80,12 +80,12 @@ func CreateWebhook(c messagebird.ClientInterface, req *WebhookCreateRequest) (*W
 
 // DeleteWebhook ensures an existing webhook is deleted and no longer
 // triggered. If the error is nil, the deletion was successful.
-func DeleteWebhook(c messagebird.ClientInterface, id string) error {
+func DeleteWebhook(c messagebird.MessageBirdClient, id string) error {
 	return request(c, nil, http.MethodDelete, webhooksPath+"/"+id, nil)
 }
 
 // ListWebhooks gets a collection of webhooks. Pagination can be set in options.
-func ListWebhooks(c messagebird.ClientInterface, options *PaginationRequest) (*WebhookList, error) {
+func ListWebhooks(c messagebird.MessageBirdClient, options *PaginationRequest) (*WebhookList, error) {
 	webhookList := &WebhookList{}
 	if err := request(c, webhookList, http.MethodGet, webhooksPath+"?"+options.QueryParams(), nil); err != nil {
 		return nil, err
@@ -95,7 +95,7 @@ func ListWebhooks(c messagebird.ClientInterface, options *PaginationRequest) (*W
 }
 
 // ReadWebhook gets a single webhook based on its ID.
-func ReadWebhook(c messagebird.ClientInterface, id string) (*Webhook, error) {
+func ReadWebhook(c messagebird.MessageBirdClient, id string) (*Webhook, error) {
 	webhook := &Webhook{}
 	if err := request(c, webhook, http.MethodGet, webhooksPath+"/"+id, nil); err != nil {
 		return nil, err
@@ -106,7 +106,7 @@ func ReadWebhook(c messagebird.ClientInterface, id string) (*Webhook, error) {
 
 // UpdateWebhook updates a single webhook based on its ID with any values set in WebhookUpdateRequest.
 // Do not set any values that should not be updated.
-func UpdateWebhook(c messagebird.ClientInterface, id string, req *WebhookUpdateRequest) (*Webhook, error) {
+func UpdateWebhook(c messagebird.MessageBirdClient, id string, req *WebhookUpdateRequest) (*Webhook, error) {
 	webhook := &Webhook{}
 	if err := request(c, webhook, http.MethodPatch, webhooksPath+"/"+id, req); err != nil {
 		return nil, err

internal/mbtest/test_client.go

@@ -27,7 +27,7 @@ func (c *ClientMock) Request(v interface{}, method, path string, data interface{
 }
 
 // MockClient initializes a new mock of MessageBird client
-func MockClient() messagebird.ClientInterface {
+func MockClient() messagebird.MessageBirdClient {
 	return &ClientMock{}
 }