RetailCRM-Mirror/mg-transport-api-client-go
1
0
Fork 0
mirror of synced 2024-11-25 06:26:03 +03:00
Code Issues Projects Releases Wiki Activity

POST /api/transport/v1/messages/read_until support

Browse Source
This commit is contained in:
Pavel 2022-11-02 17:22:11 +03:00 committed by GitHub
commit 04ec837f3a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 193 additions and 121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

280
v1/client.go
View File

@ -49,13 +49,13 @@ func (c *MgClient) writeLog(format string, v ...interface{}) {
// //
// Example: // Example:
// //
// var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6") // var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
// //
// data, status, err := client.TransportTemplates() // data, status, err := client.TransportTemplates()
// //
// if err != nil { // if err != nil {
// fmt.Printf("%v", err) // fmt.Printf("%v", err)
// } // }
// //
// fmt.Printf("Status: %v, Templates found: %v", status, len(data)) // fmt.Printf("Status: %v, Templates found: %v", status, len(data))
func (c *MgClient) TransportTemplates() ([]Template, int, error) { func (c *MgClient) TransportTemplates() ([]Template, int, error) {
@ -80,33 +80,34 @@ func (c *MgClient) TransportTemplates() ([]Template, int, error) {
// ActivateTemplate implements template activation // ActivateTemplate implements template activation
// //
// Example: // Example:
// var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
// //
// request := v1.ActivateTemplateRequest{ // var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
// Code: "code",
// Name: "name",
// Type: v1.TemplateTypeText,
// Template: []v1.TemplateItem{
// {
// Type: v1.TemplateItemTypeText,
// Text: "Hello, ",
// },
// {
// Type: v1.TemplateItemTypeVar,
// VarType: v1.TemplateVarName,
// },
// {
// Type: v1.TemplateItemTypeText,
// Text: "!",
// },
// },
// }
// //
// _, err := client.ActivateTemplate(uint64(1), request) // request := v1.ActivateTemplateRequest{
// Code: "code",
// Name: "name",
// Type: v1.TemplateTypeText,
// Template: []v1.TemplateItem{
// {
// Type: v1.TemplateItemTypeText,
// Text: "Hello, ",
// },
// {
// Type: v1.TemplateItemTypeVar,
// VarType: v1.TemplateVarName,
// },
// {
// Type: v1.TemplateItemTypeText,
// Text: "!",
// },
// },
// }
// //
// if err != nil { // _, err := client.ActivateTemplate(uint64(1), request)
// fmt.Printf("%v", err) //
// } // if err != nil {
// fmt.Printf("%v", err)
// }
func (c *MgClient) ActivateTemplate(channelID uint64, request ActivateTemplateRequest) (int, error) { func (c *MgClient) ActivateTemplate(channelID uint64, request ActivateTemplateRequest) (int, error) {
outgoing, _ := json.Marshal(&request) outgoing, _ := json.Marshal(&request)
@ -124,33 +125,34 @@ func (c *MgClient) ActivateTemplate(channelID uint64, request ActivateTemplateRe
// UpdateTemplate implements template updating // UpdateTemplate implements template updating
// Example: // Example:
// var client = New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
// //
// request := v1.Template{ // var client = New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
// Code: "templateCode",
// ChannelID: 1,
// Name: "templateName",
// Template: []v1.TemplateItem{
// {
// Type: v1.TemplateItemTypeText,
// Text: "Welcome, ",
// },
// {
// Type: v1.TemplateItemTypeVar,
// VarType: v1.TemplateVarName,
// },
// {
// Type: v1.TemplateItemTypeText,
// Text: "!",
// },
// },
// }
// //
// _, err := client.UpdateTemplate(request) // request := v1.Template{
// Code: "templateCode",
// ChannelID: 1,
// Name: "templateName",
// Template: []v1.TemplateItem{
// {
// Type: v1.TemplateItemTypeText,
// Text: "Welcome, ",
// },
// {
// Type: v1.TemplateItemTypeVar,
// VarType: v1.TemplateVarName,
// },
// {
// Type: v1.TemplateItemTypeText,
// Text: "!",
// },
// },
// }
// //
// if err != nil { // _, err := client.UpdateTemplate(request)
// fmt.Printf("%#v", err) //
// } // if err != nil {
// fmt.Printf("%#v", err)
// }
func (c *MgClient) UpdateTemplate(request Template) (int, error) { func (c *MgClient) UpdateTemplate(request Template) (int, error) {
outgoing, _ := json.Marshal(&request) outgoing, _ := json.Marshal(&request)
@ -175,13 +177,13 @@ func (c *MgClient) UpdateTemplate(request Template) (int, error) {
// //
// Example: // Example:
// //
// var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6") // var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
// //
// _, err := client.DeactivateTemplate(3053450384, "templateCode") // _, err := client.DeactivateTemplate(3053450384, "templateCode")
// //
// if err != nil { // if err != nil {
// fmt.Printf("%v", err) // fmt.Printf("%v", err)
// } // }
func (c *MgClient) DeactivateTemplate(channelID uint64, templateCode string) (int, error) { func (c *MgClient) DeactivateTemplate(channelID uint64, templateCode string) (int, error) {
data, status, err := c.DeleteRequest( data, status, err := c.DeleteRequest(
fmt.Sprintf("/channels/%d/templates/%s", channelID, url.PathEscape(templateCode)), []byte{}) fmt.Sprintf("/channels/%d/templates/%s", channelID, url.PathEscape(templateCode)), []byte{})
@ -200,13 +202,13 @@ func (c *MgClient) DeactivateTemplate(channelID uint64, templateCode string) (in
// //
// Example: // Example:
// //
// var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6") // var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
// //
// data, status, err := client.TransportChannels(Channels{Active: true}) // data, status, err := client.TransportChannels(Channels{Active: true})
// //
// if err != nil { // if err != nil {
// fmt.Printf("%v", err) // fmt.Printf("%v", err)
// } // }
// //
// fmt.Printf("Status: %v, Channels found: %v", status, len(data)) // fmt.Printf("Status: %v, Channels found: %v", status, len(data))
func (c *MgClient) TransportChannels(request Channels) ([]ChannelListItem, int, error) { func (c *MgClient) TransportChannels(request Channels) ([]ChannelListItem, int, error) {
@ -234,7 +236,7 @@ func (c *MgClient) TransportChannels(request Channels) ([]ChannelListItem, int,
// //
// Example: // Example:
// //
// var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6") // var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
// //
// request := ActivateRequest{ // request := ActivateRequest{
// Type: "telegram", // Type: "telegram",
@ -243,30 +245,30 @@ func (c *MgClient) TransportChannels(request Channels) ([]ChannelListItem, int,
// Status: Status{ // Status: Status{
// Delivered: ChannelFeatureNone, // Delivered: ChannelFeatureNone,
// Read: ChannelFeatureReceive, // Read: ChannelFeatureReceive,
// }, // },
// Text: ChannelSettingsText{ // Text: ChannelSettingsText{
// Creating: ChannelFeatureBoth, // Creating: ChannelFeatureBoth,
// Editing: ChannelFeatureBoth, // Editing: ChannelFeatureBoth,
// Quoting: ChannelFeatureReceive, // Quoting: ChannelFeatureReceive,
// Deleting: ChannelFeatureSend, // Deleting: ChannelFeatureSend,
// MaxCharsCount: 2000, // MaxCharsCount: 2000,
// }, // },
// Product: Product{ // Product: Product{
// Creating: ChannelFeatureSend, // Creating: ChannelFeatureSend,
// Deleting: ChannelFeatureSend, // Deleting: ChannelFeatureSend,
// }, // },
// Order: Order{ // Order: Order{
// Creating: ChannelFeatureBoth, // Creating: ChannelFeatureBoth,
// Deleting: ChannelFeatureSend, // Deleting: ChannelFeatureSend,
// }, // },
// }, // },
// } // }
// //
// data, status, err := client.ActivateTransportChannel(request) // data, status, err := client.ActivateTransportChannel(request)
// //
// if err != nil { // if err != nil {
// fmt.Printf("%v", err) // fmt.Printf("%v", err)
// } // }
// //
// fmt.Printf("%s\n", data.CreatedAt) // fmt.Printf("%s\n", data.CreatedAt)
func (c *MgClient) ActivateTransportChannel(request Channel) (ActivateResponse, int, error) { func (c *MgClient) ActivateTransportChannel(request Channel) (ActivateResponse, int, error) {
@ -303,29 +305,29 @@ func (c *MgClient) ActivateTransportChannel(request Channel) (ActivateResponse,
// Status: Status{ // Status: Status{
// Delivered: ChannelFeatureNone, // Delivered: ChannelFeatureNone,
// Read: ChannelFeatureReceive, // Read: ChannelFeatureReceive,
// }, // },
// Text: ChannelSettingsText{ // Text: ChannelSettingsText{
// Creating: ChannelFeatureBoth, // Creating: ChannelFeatureBoth,
// Editing: ChannelFeatureSend, // Editing: ChannelFeatureSend,
// Quoting: ChannelFeatureReceive, // Quoting: ChannelFeatureReceive,
// Deleting: ChannelFeatureBoth, // Deleting: ChannelFeatureBoth,
// }, // },
// Product: Product{ // Product: Product{
// Creating: ChannelFeatureSend, // Creating: ChannelFeatureSend,
// Deleting: ChannelFeatureSend, // Deleting: ChannelFeatureSend,
// }, // },
// Order: Order{ // Order: Order{
// Creating: ChannelFeatureBoth, // Creating: ChannelFeatureBoth,
// Deleting: ChannelFeatureSend, // Deleting: ChannelFeatureSend,
// }, // },
// }, // },
// } // }
// //
// data, status, err := client.UpdateTransportChannel(request) // data, status, err := client.UpdateTransportChannel(request)
// //
// if err != nil { // if err != nil {
// fmt.Printf("%v", err) // fmt.Printf("%v", err)
// } // }
// //
// fmt.Printf("%s\n", data.UpdatedAt) // fmt.Printf("%s\n", data.UpdatedAt)
func (c *MgClient) UpdateTransportChannel(request Channel) (UpdateResponse, int, error) { func (c *MgClient) UpdateTransportChannel(request Channel) (UpdateResponse, int, error) {
@ -352,13 +354,13 @@ func (c *MgClient) UpdateTransportChannel(request Channel) (UpdateResponse, int,
// //
// Example: // Example:
// //
// var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6") // var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
// //
// data, status, err := client.DeactivateTransportChannel(3053450384) // data, status, err := client.DeactivateTransportChannel(3053450384)
// //
// if err != nil { // if err != nil {
// fmt.Printf("%v", err) // fmt.Printf("%v", err)
// } // }
// //
// fmt.Printf("%s\n", data.DeactivatedAt) // fmt.Printf("%s\n", data.DeactivatedAt)
func (c *MgClient) DeactivateTransportChannel(id uint64) (DeleteResponse, int, error) { func (c *MgClient) DeactivateTransportChannel(id uint64) (DeleteResponse, int, error) {
@ -388,7 +390,7 @@ func (c *MgClient) DeactivateTransportChannel(id uint64) (DeleteResponse, int, e
// //
// Example: // Example:
// //
// var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6") // var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
// msg := SendData{ // msg := SendData{
// SendMessage{ // SendMessage{
// Message{ // Message{
@ -406,11 +408,11 @@ func (c *MgClient) DeactivateTransportChannel(id uint64) (DeleteResponse, int, e
// 10, // 10,
// } // }
// //
// data, status, err := client.Messages(msg) // data, status, err := client.Messages(msg)
// //
// if err != nil { // if err != nil {
// fmt.Printf("%v", err) // fmt.Printf("%v", err)
// } // }
// //
// fmt.Printf("%s\n", data.MessageID) // fmt.Printf("%s\n", data.MessageID)
func (c *MgClient) Messages(request SendData) (MessagesResponse, int, error) { func (c *MgClient) Messages(request SendData) (MessagesResponse, int, error) {
@ -437,7 +439,7 @@ func (c *MgClient) Messages(request SendData) (MessagesResponse, int, error) {
// //
// Example: // Example:
// //
// var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6") // var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
// msg := UpdateData{ // msg := UpdateData{
// UpdateMessage{ // UpdateMessage{
// Message{ // Message{
@ -450,11 +452,11 @@ func (c *MgClient) Messages(request SendData) (MessagesResponse, int, error) {
// 10, // 10,
// } // }
// //
// data, status, err := client.UpdateMessages(msg) // data, status, err := client.UpdateMessages(msg)
// //
// if err != nil { // if err != nil {
// fmt.Printf("%v", err) // fmt.Printf("%v", err)
// } // }
// //
// fmt.Printf("%s\n", data.MessageID) // fmt.Printf("%s\n", data.MessageID)
func (c *MgClient) UpdateMessages(request EditMessageRequest) (MessagesResponse, int, error) { func (c *MgClient) UpdateMessages(request EditMessageRequest) (MessagesResponse, int, error) {
@ -481,7 +483,7 @@ func (c *MgClient) UpdateMessages(request EditMessageRequest) (MessagesResponse,
// //
// Example: // Example:
// //
// var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6") // var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
// msg := MarkMessageReadRequest{ // msg := MarkMessageReadRequest{
// Message{ // Message{
// ExternalID: "274628", // ExternalID: "274628",
@ -489,11 +491,11 @@ func (c *MgClient) UpdateMessages(request EditMessageRequest) (MessagesResponse,
// 10, // 10,
// } // }
// //
// data, status, err := client.MarkMessageRead(msg) // data, status, err := client.MarkMessageRead(msg)
// //
// if err != nil { // if err != nil {
// fmt.Printf("%v", err) // fmt.Printf("%v", err)
// } // }
// //
// fmt.Printf("%v %v\n", status, data) // fmt.Printf("%v %v\n", status, data)
func (c *MgClient) MarkMessageRead(request MarkMessageReadRequest) (MarkMessageReadResponse, int, error) { func (c *MgClient) MarkMessageRead(request MarkMessageReadRequest) (MarkMessageReadResponse, int, error) {
@ -547,27 +549,63 @@ func (c *MgClient) AckMessage(request AckMessageRequest) (int, error) {
return status, err return status, err
} }
// ReadUntil will mark all messages from specified timestamp as read.
//
// Example:
//
// var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
//
// request := ReadUntilRequest{
// ExternalMessageID: "274628",
// Channel: 10,
// }
//
// resp, status, err := client.ReadUntil(request)
// if err != nil {
// fmt.Printf("%v", err)
// }
// if resp != nil {
// fmt.Printf("Marked these as read: %s", resp.IDs)
// }
func (c *MgClient) ReadUntil(request MarkMessagesReadUntilRequest) (*MarkMessagesReadUntilResponse, int, error) {
outgoing, _ := json.Marshal(&request)
data, status, err := c.PostRequest("/messages/read_until", bytes.NewBuffer(outgoing))
if err != nil {
return nil, status, err
}
if status != http.StatusOK {
return nil, status, NewAPIClientError(data)
}
var resp *MarkMessagesReadUntilResponse
if e := json.Unmarshal(data, &resp); e != nil {
return nil, status, e
}
return resp, status, nil
}
// DeleteMessage implement delete message // DeleteMessage implement delete message
// //
// Example: // Example:
// //
// var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6") // var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
// //
// msg := DeleteData{ // msg := DeleteData{
// Message{ // Message{
// ExternalID: "274628", // ExternalID: "274628",
// }, // },
// 10, // 10,
// } // }
// //
// previousChatMessage, status, err := client.DeleteMessage(msg) // previousChatMessage, status, err := client.DeleteMessage(msg)
// if err != nil { // if err != nil {
// fmt.Printf("%v", err) // fmt.Printf("%v", err)
// } // }
// //
// if previousChatMessage != nil { // if previousChatMessage != nil {
// fmt.Printf("Previous chat message id = %d", previousChatMessage.MessageID) // fmt.Printf("Previous chat message id = %d", previousChatMessage.MessageID)
// } // }
func (c *MgClient) DeleteMessage(request DeleteData) (*MessagesResponse, int, error) { func (c *MgClient) DeleteMessage(request DeleteData) (*MessagesResponse, int, error) {
outgoing, _ := json.Marshal(&request) outgoing, _ := json.Marshal(&request)
@ -594,13 +632,13 @@ func (c *MgClient) DeleteMessage(request DeleteData) (*MessagesResponse, int, er
// //
// Example: // Example:
// //
// var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6") // var client = v1.New("https://token.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
// //
// data, status, err := client.GetFile("file_ID") // data, status, err := client.GetFile("file_ID")
// //
// if err != nil { // if err != nil {
// fmt.Printf("%v", err) // fmt.Printf("%v", err)
// } // }
// //
// fmt.Printf("%s\n", data.MessageID) // fmt.Printf("%s\n", data.MessageID)
func (c *MgClient) GetFile(request string) (FullFileResponse, int, error) { func (c *MgClient) GetFile(request string) (FullFileResponse, int, error) {

22
v1/client_test.go
View File

@ -614,6 +614,28 @@ func (t *MGClientTest) Test_UpdateMessages() {
t.Assert().Equal(1, dataU.MessageID) t.Assert().Equal(1, dataU.MessageID)
} }
func (t *MGClientTest) Test_ReadUntil() {
c := t.client()
req := MarkMessagesReadUntilRequest{
CustomerExternalID: "customer",
ChannelID: 1,
Until: time.Unix(0, 0),
}
defer gock.Off()
t.gock().
Post("messages/read_until").
Reply(http.StatusOK).
JSON(MarkMessagesReadUntilResponse{
IDs: []int64{1},
})
resp, st, err := c.ReadUntil(req)
t.Require().NoError(err)
t.Assert().Equal(http.StatusOK, st)
t.Assert().Equal([]int64{1}, resp.IDs)
}
func (t *MGClientTest) Test_MarkMessageReadAndDelete() { func (t *MGClientTest) Test_MarkMessageReadAndDelete() {
c := t.client() c := t.client()

12
v1/types.go
View File

@ -330,6 +330,18 @@ type AckMessageRequest struct {
Error *MessageSentError `json:"error,omitempty"` Error *MessageSentError `json:"error,omitempty"`
} }
// MarkMessagesReadUntilRequest type.
type MarkMessagesReadUntilRequest struct {
CustomerExternalID string `json:"customer_external_id"`
ChannelID uint64 `json:"channel_id"`
Until time.Time `json:"until"`
}
// MarkMessagesReadUntilResponse type.
type MarkMessagesReadUntilResponse struct {
IDs []int64 `json:"ids"`
}
// DeleteData struct. // DeleteData struct.
type DeleteData struct { type DeleteData struct {
Message Message `json:"message"` Message Message `json:"message"`