-
Notifications
You must be signed in to change notification settings - Fork 82
/
Copy pathcustom_object.go
215 lines (190 loc) · 7.17 KB
/
custom_object.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
package zendesk
import (
"context"
"encoding/json"
"fmt"
"time"
)
type CustomObjectRecord struct {
Url string `json:"url,omitempty"`
Name string `json:"name,omitempty"`
ID string `json:"id,omitempty"`
CustomObjectKey string `json:"custom_object_key"`
CustomObjectFields map[string]interface{} `json:"custom_object_fields" binding:"required"`
CreatedByUserID string `json:"created_by_user_id,omitempty"`
UpdatedByUserID string `json:"updated_by_user_id,omitempty"`
CreatedAt time.Time `json:"created_at,omitempty"`
UpdatedAt time.Time `json:"updated_at,omitempty"`
ExternalID string `json:"external_id,omitempty"`
}
// CustomObjectAPI an interface containing all custom object related methods
type CustomObjectAPI interface {
CreateCustomObjectRecord(
ctx context.Context, record CustomObjectRecord, customObjectKey string) (CustomObjectRecord, error)
AutocompleteSearchCustomObjectRecords(
ctx context.Context,
customObjectKey string,
opts *CustomObjectAutocompleteOptions,
) ([]CustomObjectRecord, Page, error)
SearchCustomObjectRecords(
ctx context.Context, customObjectKey string, opts *SearchCustomObjectRecordsOptions,
) ([]CustomObjectRecord, Page, error)
ListCustomObjectRecords(
ctx context.Context, customObjectKey string, opts *CustomObjectListOptions) ([]CustomObjectRecord, Page, error)
ShowCustomObjectRecord(
ctx context.Context, customObjectKey string, customObjectRecordID string,
) (*CustomObjectRecord, error)
UpdateCustomObjectRecord(
ctx context.Context, customObjectKey string, customObjectRecordID string, record CustomObjectRecord,
) (*CustomObjectRecord, error)
}
// CustomObjectAutocompleteOptions custom object search options
type CustomObjectAutocompleteOptions struct {
PageOptions
Name string `url:"name"`
}
// CreateCustomObjectRecord CreateCustomObject create a custom object record
func (z *Client) CreateCustomObjectRecord(
ctx context.Context, record CustomObjectRecord, customObjectKey string,
) (CustomObjectRecord, error) {
var data, result struct {
CustomObjectRecord CustomObjectRecord `json:"custom_object_record"`
}
data.CustomObjectRecord = record
body, err := z.post(ctx, fmt.Sprintf("/custom_objects/%s/records.json", customObjectKey), data)
if err != nil {
return CustomObjectRecord{}, err
}
err = json.Unmarshal(body, &result)
if err != nil {
return CustomObjectRecord{}, err
}
return result.CustomObjectRecord, nil
}
// CustomObjectListOptions custom object list options
type CustomObjectListOptions struct {
PageOptions
Ids string `url:"filter[ids],omitempty"`
ExternalIds string `url:"filter[external_ids],omitempty"`
}
// ListCustomObjectRecords list objects
// https://developer.zendesk.com/api-reference/custom-objects/custom_object_records/#list-custom-object-records
func (z *Client) ListCustomObjectRecords(
ctx context.Context, customObjectKey string, opts *CustomObjectListOptions) ([]CustomObjectRecord, Page, error) {
var result struct {
CustomObjectRecords []CustomObjectRecord `json:"custom_object_records"`
Page
}
tmp := opts
if tmp == nil {
tmp = &CustomObjectListOptions{}
}
url := fmt.Sprintf("/custom_objects/%s/records", customObjectKey)
urlWithOptions, err := addOptions(url, tmp)
body, err := z.get(ctx, urlWithOptions)
if err != nil {
return nil, Page{}, err
}
err = json.Unmarshal(body, &result)
if err != nil {
return nil, Page{}, err
}
return result.CustomObjectRecords, result.Page, nil
}
// AutocompleteSearchCustomObjectRecords search for a custom object record by the name field
// https://developer.zendesk.com/api-reference/custom-objects/custom_object_records/#autocomplete-custom-object-record-search
func (z *Client) AutocompleteSearchCustomObjectRecords(
ctx context.Context, customObjectKey string, opts *CustomObjectAutocompleteOptions,
) ([]CustomObjectRecord, Page, error) {
var result struct {
CustomObjectRecords []CustomObjectRecord `json:"custom_object_records"`
Page
}
tmp := opts
if tmp == nil {
tmp = &CustomObjectAutocompleteOptions{}
}
url := fmt.Sprintf("/custom_objects/%s/records/autocomplete", customObjectKey)
urlWithOptions, err := addOptions(url, tmp)
body, err := z.get(ctx, urlWithOptions)
if err != nil {
return nil, Page{}, err
}
err = json.Unmarshal(body, &result)
if err != nil {
return nil, Page{}, err
}
return result.CustomObjectRecords, result.Page, nil
}
type SearchCustomObjectRecordsOptions struct {
PageOptions
// One of name, created_at, updated_at, -name, -created_at, or -updated_at.
// The - denotes the sort will be descending. Defaults to sorting by relevance.
Sort string `url:"sort,omitempty"`
// Query string
Query string `url:"query,omitempty"`
}
// SearchCustomObjectRecords search for a custom object record by the name field
// https://developer.zendesk.com/api-reference/custom-objects/custom_object_records/#search-custom-object-records
func (z *Client) SearchCustomObjectRecords(
ctx context.Context, customObjectKey string, opts *SearchCustomObjectRecordsOptions,
) ([]CustomObjectRecord, Page, error) {
var result struct {
CustomObjectRecords []CustomObjectRecord `json:"custom_object_records"`
Page
}
tmp := opts
if tmp == nil {
tmp = &SearchCustomObjectRecordsOptions{}
}
url := fmt.Sprintf("/custom_objects/%s/records/search", customObjectKey)
urlWithOptions, err := addOptions(url, tmp)
body, err := z.get(ctx, urlWithOptions)
if err != nil {
return nil, Page{}, err
}
err = json.Unmarshal(body, &result)
if err != nil {
return nil, Page{}, err
}
return result.CustomObjectRecords, result.Page, nil
}
// ShowCustomObjectRecord returns a custom record for a specific object using a provided id.
// https://developer.zendesk.com/api-reference/custom-objects/custom_object_records/#show-custom-object-record
func (z *Client) ShowCustomObjectRecord(
ctx context.Context, customObjectKey string, customObjectRecordID string,
) (*CustomObjectRecord, error) {
var result struct {
CustomObjectRecord CustomObjectRecord `json:"custom_object_record"`
}
url := fmt.Sprintf("/custom_objects/%s/records/%s", customObjectKey, customObjectRecordID)
body, err := z.get(ctx, url)
if err != nil {
return nil, err
}
err = json.Unmarshal(body, &result)
if err != nil {
return nil, err
}
return &result.CustomObjectRecord, nil
}
// UpdateCustomObjectRecord Updates an individual custom object record
// https://developer.zendesk.com/api-reference/custom-objects/custom_object_records/#update-custom-object-record
func (z *Client) UpdateCustomObjectRecord(
ctx context.Context, customObjectKey string, customObjectRecordID string, record CustomObjectRecord,
) (*CustomObjectRecord, error) {
var data, result struct {
CustomObjectRecord CustomObjectRecord `json:"custom_object_record"`
}
data.CustomObjectRecord = record
url := fmt.Sprintf("/custom_objects/%s/records/%s", customObjectKey, customObjectRecordID)
body, err := z.patch(ctx, url, data)
if err != nil {
return nil, err
}
err = json.Unmarshal(body, &result)
if err != nil {
return nil, err
}
return &result.CustomObjectRecord, nil
}