@dugjason/front-node 0.1.0-alpha.2 → 0.1.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +110 -213
- package/dist/client.d.ts +8 -3
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +23 -11
- package/dist/client.js.map +1 -1
- package/dist/core/client.d.ts +36 -0
- package/dist/core/client.d.ts.map +1 -0
- package/dist/core/client.js +89 -0
- package/dist/core/client.js.map +1 -0
- package/dist/core/errors.d.ts +55 -0
- package/dist/core/errors.d.ts.map +1 -0
- package/dist/core/errors.js +124 -0
- package/dist/core/errors.js.map +1 -0
- package/dist/core/paginator.d.ts +88 -0
- package/dist/core/paginator.d.ts.map +1 -0
- package/dist/core/paginator.js +129 -0
- package/dist/core/paginator.js.map +1 -0
- package/dist/core/resource.d.ts +143 -0
- package/dist/core/resource.d.ts.map +1 -0
- package/dist/core/resource.js +132 -0
- package/dist/core/resource.js.map +1 -0
- package/dist/endpoints/accounts.d.ts +34 -0
- package/dist/endpoints/accounts.d.ts.map +1 -0
- package/dist/endpoints/accounts.js +85 -0
- package/dist/endpoints/accounts.js.map +1 -0
- package/dist/endpoints/analytics.d.ts +32 -0
- package/dist/endpoints/analytics.d.ts.map +1 -0
- package/dist/endpoints/analytics.js +48 -0
- package/dist/endpoints/analytics.js.map +1 -0
- package/dist/endpoints/applications.d.ts +15 -0
- package/dist/endpoints/applications.d.ts.map +1 -0
- package/dist/endpoints/applications.js +17 -0
- package/dist/endpoints/applications.js.map +1 -0
- package/dist/endpoints/attachments.d.ts +8 -0
- package/dist/endpoints/attachments.d.ts.map +1 -0
- package/dist/endpoints/attachments.js +10 -0
- package/dist/endpoints/attachments.js.map +1 -0
- package/dist/endpoints/channels.d.ts +41 -0
- package/dist/endpoints/channels.d.ts.map +1 -0
- package/dist/endpoints/channels.js +64 -0
- package/dist/endpoints/channels.js.map +1 -0
- package/dist/endpoints/comments.d.ts +30 -0
- package/dist/endpoints/comments.d.ts.map +1 -0
- package/dist/endpoints/comments.js +45 -0
- package/dist/endpoints/comments.js.map +1 -0
- package/dist/endpoints/contacts.d.ts +46 -0
- package/dist/endpoints/contacts.d.ts.map +1 -0
- package/dist/endpoints/contacts.js +99 -0
- package/dist/endpoints/contacts.js.map +1 -0
- package/dist/endpoints/conversations.d.ts +77 -0
- package/dist/endpoints/conversations.d.ts.map +1 -0
- package/dist/endpoints/conversations.js +221 -0
- package/dist/endpoints/conversations.js.map +1 -0
- package/dist/endpoints/drafts.d.ts +12 -0
- package/dist/endpoints/drafts.d.ts.map +1 -0
- package/dist/endpoints/drafts.js +26 -0
- package/dist/endpoints/drafts.js.map +1 -0
- package/dist/endpoints/events.d.ts +13 -0
- package/dist/endpoints/events.d.ts.map +1 -0
- package/dist/endpoints/events.js +21 -0
- package/dist/endpoints/events.js.map +1 -0
- package/dist/endpoints/inboxes.d.ts +42 -0
- package/dist/endpoints/inboxes.d.ts.map +1 -0
- package/dist/endpoints/inboxes.js +83 -0
- package/dist/endpoints/inboxes.js.map +1 -0
- package/dist/endpoints/knowledge-base-articles.d.ts +8 -0
- package/dist/endpoints/knowledge-base-articles.d.ts.map +1 -0
- package/dist/endpoints/knowledge-base-articles.js +10 -0
- package/dist/endpoints/knowledge-base-articles.js.map +1 -0
- package/dist/endpoints/knowledge-bases.d.ts +50 -0
- package/dist/endpoints/knowledge-bases.d.ts.map +1 -0
- package/dist/endpoints/knowledge-bases.js +131 -0
- package/dist/endpoints/knowledge-bases.js.map +1 -0
- package/dist/endpoints/links.d.ts +30 -0
- package/dist/endpoints/links.d.ts.map +1 -0
- package/dist/endpoints/links.js +67 -0
- package/dist/endpoints/links.js.map +1 -0
- package/dist/endpoints/message-template-folders.d.ts +38 -0
- package/dist/endpoints/message-template-folders.d.ts.map +1 -0
- package/dist/endpoints/message-template-folders.js +114 -0
- package/dist/endpoints/message-template-folders.js.map +1 -0
- package/dist/endpoints/message-templates.d.ts +30 -0
- package/dist/endpoints/message-templates.d.ts.map +1 -0
- package/dist/endpoints/message-templates.js +69 -0
- package/dist/endpoints/message-templates.js.map +1 -0
- package/dist/endpoints/messages.d.ts +21 -0
- package/dist/endpoints/messages.d.ts.map +1 -0
- package/dist/endpoints/messages.js +31 -0
- package/dist/endpoints/messages.js.map +1 -0
- package/dist/endpoints/rules.d.ts +16 -0
- package/dist/endpoints/rules.d.ts.map +1 -0
- package/dist/endpoints/rules.js +21 -0
- package/dist/endpoints/rules.js.map +1 -0
- package/dist/endpoints/shifts.d.ts +46 -0
- package/dist/endpoints/shifts.d.ts.map +1 -0
- package/dist/endpoints/shifts.js +70 -0
- package/dist/endpoints/shifts.js.map +1 -0
- package/dist/endpoints/signatures.d.ts +36 -0
- package/dist/endpoints/signatures.d.ts.map +1 -0
- package/dist/endpoints/signatures.js +52 -0
- package/dist/endpoints/signatures.js.map +1 -0
- package/dist/endpoints/statuses.d.ts +15 -0
- package/dist/endpoints/statuses.d.ts.map +1 -0
- package/dist/endpoints/statuses.js +22 -0
- package/dist/endpoints/statuses.js.map +1 -0
- package/dist/endpoints/tags.d.ts +30 -0
- package/dist/endpoints/tags.d.ts.map +1 -0
- package/dist/endpoints/tags.js +49 -0
- package/dist/endpoints/tags.js.map +1 -0
- package/dist/endpoints/teammate-groups.d.ts +47 -0
- package/dist/endpoints/teammate-groups.d.ts.map +1 -0
- package/dist/endpoints/teammate-groups.js +101 -0
- package/dist/endpoints/teammate-groups.js.map +1 -0
- package/dist/endpoints/teammates.d.ts +28 -0
- package/dist/endpoints/teammates.d.ts.map +1 -0
- package/dist/endpoints/teammates.js +59 -0
- package/dist/endpoints/teammates.js.map +1 -0
- package/dist/endpoints/teams.d.ts +37 -0
- package/dist/endpoints/teams.d.ts.map +1 -0
- package/dist/endpoints/teams.js +79 -0
- package/dist/endpoints/teams.js.map +1 -0
- package/dist/front.d.ts +85 -21
- package/dist/front.d.ts.map +1 -1
- package/dist/front.js +137 -33
- package/dist/front.js.map +1 -1
- package/dist/generated/client/client.gen.d.ts +3 -0
- package/dist/generated/client/client.gen.d.ts.map +1 -0
- package/dist/generated/client/client.gen.js +204 -0
- package/dist/generated/client/client.gen.js.map +1 -0
- package/dist/generated/client/index.d.ts +8 -0
- package/dist/generated/client/index.d.ts.map +1 -0
- package/dist/generated/client/index.js +6 -0
- package/dist/generated/client/index.js.map +1 -0
- package/dist/generated/client/types.gen.d.ts +125 -0
- package/dist/generated/client/types.gen.d.ts.map +1 -0
- package/dist/generated/client/types.gen.js +3 -0
- package/dist/generated/client/types.gen.js.map +1 -0
- package/dist/generated/client/utils.gen.d.ts +39 -0
- package/dist/generated/client/utils.gen.d.ts.map +1 -0
- package/dist/generated/client/utils.gen.js +230 -0
- package/dist/generated/client/utils.gen.js.map +1 -0
- package/dist/generated/client.gen.d.ts +13 -0
- package/dist/generated/client.gen.d.ts.map +1 -0
- package/dist/generated/client.gen.js +6 -0
- package/dist/generated/client.gen.js.map +1 -0
- package/dist/generated/core/auth.gen.d.ts +19 -0
- package/dist/generated/core/auth.gen.d.ts.map +1 -0
- package/dist/generated/core/auth.gen.js +15 -0
- package/dist/generated/core/auth.gen.js.map +1 -0
- package/dist/generated/core/bodySerializer.gen.d.ts +18 -0
- package/dist/generated/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/bodySerializer.gen.js +58 -0
- package/dist/generated/core/bodySerializer.gen.js.map +1 -0
- package/dist/generated/core/params.gen.d.ts +34 -0
- package/dist/generated/core/params.gen.d.ts.map +1 -0
- package/dist/generated/core/params.gen.js +89 -0
- package/dist/generated/core/params.gen.js.map +1 -0
- package/dist/generated/core/pathSerializer.gen.d.ts +34 -0
- package/dist/generated/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/pathSerializer.gen.js +115 -0
- package/dist/generated/core/pathSerializer.gen.js.map +1 -0
- package/dist/generated/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/generated/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/generated/core/serverSentEvents.gen.js +136 -0
- package/dist/generated/core/serverSentEvents.gen.js.map +1 -0
- package/dist/generated/core/types.gen.d.ts +79 -0
- package/dist/generated/core/types.gen.d.ts.map +1 -0
- package/dist/generated/core/types.gen.js +3 -0
- package/dist/generated/core/types.gen.js.map +1 -0
- package/dist/generated/core/utils.gen.d.ts +15 -0
- package/dist/generated/core/utils.gen.d.ts.map +1 -0
- package/dist/generated/core/utils.gen.js +70 -0
- package/dist/generated/core/utils.gen.js.map +1 -0
- package/dist/generated/sdk.gen.d.ts +1292 -0
- package/dist/generated/sdk.gen.d.ts.map +1 -0
- package/dist/generated/sdk.gen.js +4202 -0
- package/dist/generated/sdk.gen.js.map +1 -0
- package/dist/generated/types.gen.d.ts +8492 -0
- package/dist/generated/types.gen.d.ts.map +1 -0
- package/dist/generated/types.gen.js +149 -0
- package/dist/generated/types.gen.js.map +1 -0
- package/dist/index.d.ts +26 -8
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -8
- package/dist/index.js.map +1 -1
- package/dist/resources/accounts.d.ts +14 -37
- package/dist/resources/accounts.d.ts.map +1 -1
- package/dist/resources/accounts.js +34 -54
- package/dist/resources/accounts.js.map +1 -1
- package/dist/resources/analytics.d.ts +36 -0
- package/dist/resources/analytics.d.ts.map +1 -0
- package/dist/resources/analytics.js +82 -0
- package/dist/resources/analytics.js.map +1 -0
- package/dist/resources/applications.d.ts +9 -0
- package/dist/resources/applications.d.ts.map +1 -0
- package/dist/resources/applications.js +13 -0
- package/dist/resources/applications.js.map +1 -0
- package/dist/resources/channels.d.ts +18 -0
- package/dist/resources/channels.d.ts.map +1 -0
- package/dist/resources/channels.js +35 -0
- package/dist/resources/channels.js.map +1 -0
- package/dist/resources/comments.d.ts +18 -0
- package/dist/resources/comments.d.ts.map +1 -0
- package/dist/resources/comments.js +36 -0
- package/dist/resources/comments.js.map +1 -0
- package/dist/resources/contacts.d.ts +16 -0
- package/dist/resources/contacts.d.ts.map +1 -0
- package/dist/resources/contacts.js +37 -0
- package/dist/resources/contacts.js.map +1 -0
- package/dist/resources/conversations.d.ts +22 -39
- package/dist/resources/conversations.d.ts.map +1 -1
- package/dist/resources/conversations.js +52 -52
- package/dist/resources/conversations.js.map +1 -1
- package/dist/resources/drafts.d.ts +13 -25
- package/dist/resources/drafts.d.ts.map +1 -1
- package/dist/resources/drafts.js +31 -34
- package/dist/resources/drafts.js.map +1 -1
- package/dist/resources/events.d.ts +23 -0
- package/dist/resources/events.d.ts.map +1 -0
- package/dist/resources/events.js +28 -0
- package/dist/resources/events.js.map +1 -0
- package/dist/resources/inboxes.d.ts +12 -0
- package/dist/resources/inboxes.d.ts.map +1 -0
- package/dist/resources/inboxes.js +25 -0
- package/dist/resources/inboxes.js.map +1 -0
- package/dist/resources/knowledge-base-articles.d.ts +15 -0
- package/dist/resources/knowledge-base-articles.d.ts.map +1 -0
- package/dist/resources/knowledge-base-articles.js +34 -0
- package/dist/resources/knowledge-base-articles.js.map +1 -0
- package/dist/resources/knowledge-base-categories.d.ts +16 -0
- package/dist/resources/knowledge-base-categories.d.ts.map +1 -0
- package/dist/resources/knowledge-base-categories.js +37 -0
- package/dist/resources/knowledge-base-categories.js.map +1 -0
- package/dist/resources/knowledge-bases.d.ts +15 -0
- package/dist/resources/knowledge-bases.d.ts.map +1 -0
- package/dist/resources/knowledge-bases.js +35 -0
- package/dist/resources/knowledge-bases.js.map +1 -0
- package/dist/resources/links.d.ts +12 -0
- package/dist/resources/links.d.ts.map +1 -0
- package/dist/resources/links.js +25 -0
- package/dist/resources/links.js.map +1 -0
- package/dist/resources/message-template-folders.d.ts +13 -0
- package/dist/resources/message-template-folders.d.ts.map +1 -0
- package/dist/resources/message-template-folders.js +41 -0
- package/dist/resources/message-template-folders.js.map +1 -0
- package/dist/resources/message-templates.d.ts +16 -0
- package/dist/resources/message-templates.d.ts.map +1 -0
- package/dist/resources/message-templates.js +50 -0
- package/dist/resources/message-templates.js.map +1 -0
- package/dist/resources/messages.d.ts +36 -0
- package/dist/resources/messages.d.ts.map +1 -0
- package/dist/resources/messages.js +55 -0
- package/dist/resources/messages.js.map +1 -0
- package/dist/resources/rules.d.ts +11 -0
- package/dist/resources/rules.d.ts.map +1 -0
- package/dist/resources/rules.js +22 -0
- package/dist/resources/rules.js.map +1 -0
- package/dist/resources/shifts.d.ts +14 -0
- package/dist/resources/shifts.d.ts.map +1 -0
- package/dist/resources/shifts.js +31 -0
- package/dist/resources/shifts.js.map +1 -0
- package/dist/resources/signatures.d.ts +17 -0
- package/dist/resources/signatures.d.ts.map +1 -0
- package/dist/resources/signatures.js +51 -0
- package/dist/resources/signatures.js.map +1 -0
- package/dist/resources/statuses.d.ts +13 -0
- package/dist/resources/statuses.d.ts.map +1 -0
- package/dist/resources/statuses.js +28 -0
- package/dist/resources/statuses.js.map +1 -0
- package/dist/resources/tags.d.ts +15 -61
- package/dist/resources/tags.d.ts.map +1 -1
- package/dist/resources/tags.js +50 -88
- package/dist/resources/tags.js.map +1 -1
- package/dist/resources/teammate-groups.d.ts +17 -0
- package/dist/resources/teammate-groups.d.ts.map +1 -0
- package/dist/resources/teammate-groups.js +25 -0
- package/dist/resources/teammate-groups.js.map +1 -0
- package/dist/resources/teammates.d.ts +15 -27
- package/dist/resources/teammates.d.ts.map +1 -1
- package/dist/resources/teammates.js +37 -34
- package/dist/resources/teammates.js.map +1 -1
- package/dist/resources/teams.d.ts +11 -0
- package/dist/resources/teams.d.ts.map +1 -0
- package/dist/resources/teams.js +28 -0
- package/dist/resources/teams.js.map +1 -0
- package/dist/types.d.ts +13 -222
- package/dist/types.d.ts.map +1 -1
- package/package.json +9 -4
|
@@ -0,0 +1,4202 @@
|
|
|
1
|
+
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
+
import { client as _heyApiClient } from './client.gen';
|
|
3
|
+
/**
|
|
4
|
+
* List Accounts
|
|
5
|
+
* List the accounts of the company.
|
|
6
|
+
*/
|
|
7
|
+
export const listAccounts = (options) => {
|
|
8
|
+
return (options?.client ?? _heyApiClient).get({
|
|
9
|
+
security: [
|
|
10
|
+
{
|
|
11
|
+
scheme: 'bearer',
|
|
12
|
+
type: 'http'
|
|
13
|
+
}
|
|
14
|
+
],
|
|
15
|
+
url: '/accounts',
|
|
16
|
+
...options
|
|
17
|
+
});
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* Create account
|
|
21
|
+
* Create a new account.
|
|
22
|
+
*/
|
|
23
|
+
export const createAccount = (options) => {
|
|
24
|
+
return (options?.client ?? _heyApiClient).post({
|
|
25
|
+
security: [
|
|
26
|
+
{
|
|
27
|
+
scheme: 'bearer',
|
|
28
|
+
type: 'http'
|
|
29
|
+
}
|
|
30
|
+
],
|
|
31
|
+
url: '/accounts',
|
|
32
|
+
...options,
|
|
33
|
+
headers: {
|
|
34
|
+
'Content-Type': 'application/json',
|
|
35
|
+
...options?.headers
|
|
36
|
+
}
|
|
37
|
+
});
|
|
38
|
+
};
|
|
39
|
+
/**
|
|
40
|
+
* List Account's custom fields
|
|
41
|
+
* Lists the custom fields that can be attached to an Account.
|
|
42
|
+
*/
|
|
43
|
+
export const listAccountCustomFields = (options) => {
|
|
44
|
+
return (options?.client ?? _heyApiClient).get({
|
|
45
|
+
security: [
|
|
46
|
+
{
|
|
47
|
+
scheme: 'bearer',
|
|
48
|
+
type: 'http'
|
|
49
|
+
}
|
|
50
|
+
],
|
|
51
|
+
url: '/accounts/custom_fields',
|
|
52
|
+
...options
|
|
53
|
+
});
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* Delete an account
|
|
57
|
+
* Deletes an account
|
|
58
|
+
*/
|
|
59
|
+
export const deleteAnAccount = (options) => {
|
|
60
|
+
return (options.client ?? _heyApiClient).delete({
|
|
61
|
+
security: [
|
|
62
|
+
{
|
|
63
|
+
scheme: 'bearer',
|
|
64
|
+
type: 'http'
|
|
65
|
+
}
|
|
66
|
+
],
|
|
67
|
+
url: '/accounts/{account_id}',
|
|
68
|
+
...options
|
|
69
|
+
});
|
|
70
|
+
};
|
|
71
|
+
/**
|
|
72
|
+
* Fetch an account
|
|
73
|
+
* Fetches an account
|
|
74
|
+
*/
|
|
75
|
+
export const fetchAnAccount = (options) => {
|
|
76
|
+
return (options.client ?? _heyApiClient).get({
|
|
77
|
+
security: [
|
|
78
|
+
{
|
|
79
|
+
scheme: 'bearer',
|
|
80
|
+
type: 'http'
|
|
81
|
+
}
|
|
82
|
+
],
|
|
83
|
+
url: '/accounts/{account_id}',
|
|
84
|
+
...options
|
|
85
|
+
});
|
|
86
|
+
};
|
|
87
|
+
/**
|
|
88
|
+
* Update account
|
|
89
|
+
* Updates an account.
|
|
90
|
+
*/
|
|
91
|
+
export const updateAccount = (options) => {
|
|
92
|
+
return (options.client ?? _heyApiClient).patch({
|
|
93
|
+
security: [
|
|
94
|
+
{
|
|
95
|
+
scheme: 'bearer',
|
|
96
|
+
type: 'http'
|
|
97
|
+
}
|
|
98
|
+
],
|
|
99
|
+
url: '/accounts/{account_id}',
|
|
100
|
+
...options,
|
|
101
|
+
headers: {
|
|
102
|
+
'Content-Type': 'application/json',
|
|
103
|
+
...options.headers
|
|
104
|
+
}
|
|
105
|
+
});
|
|
106
|
+
};
|
|
107
|
+
/**
|
|
108
|
+
* Remove contact from Account
|
|
109
|
+
* Removes a list of contacts from an Account
|
|
110
|
+
*/
|
|
111
|
+
export const removeContactFromAccount = (options) => {
|
|
112
|
+
return (options.client ?? _heyApiClient).delete({
|
|
113
|
+
security: [
|
|
114
|
+
{
|
|
115
|
+
scheme: 'bearer',
|
|
116
|
+
type: 'http'
|
|
117
|
+
}
|
|
118
|
+
],
|
|
119
|
+
url: '/accounts/{account_id}/contacts',
|
|
120
|
+
...options,
|
|
121
|
+
headers: {
|
|
122
|
+
'Content-Type': 'application/json',
|
|
123
|
+
...options.headers
|
|
124
|
+
}
|
|
125
|
+
});
|
|
126
|
+
};
|
|
127
|
+
/**
|
|
128
|
+
* List account contacts
|
|
129
|
+
* Lists the contacts associated with an Account
|
|
130
|
+
*/
|
|
131
|
+
export const listAccountContacts = (options) => {
|
|
132
|
+
return (options.client ?? _heyApiClient).get({
|
|
133
|
+
security: [
|
|
134
|
+
{
|
|
135
|
+
scheme: 'bearer',
|
|
136
|
+
type: 'http'
|
|
137
|
+
}
|
|
138
|
+
],
|
|
139
|
+
url: '/accounts/{account_id}/contacts',
|
|
140
|
+
...options
|
|
141
|
+
});
|
|
142
|
+
};
|
|
143
|
+
/**
|
|
144
|
+
* Add contact to Account
|
|
145
|
+
* Adds a list of contacts to an Account
|
|
146
|
+
*/
|
|
147
|
+
export const addContactToAccount = (options) => {
|
|
148
|
+
return (options.client ?? _heyApiClient).post({
|
|
149
|
+
security: [
|
|
150
|
+
{
|
|
151
|
+
scheme: 'bearer',
|
|
152
|
+
type: 'http'
|
|
153
|
+
}
|
|
154
|
+
],
|
|
155
|
+
url: '/accounts/{account_id}/contacts',
|
|
156
|
+
...options,
|
|
157
|
+
headers: {
|
|
158
|
+
'Content-Type': 'application/json',
|
|
159
|
+
...options.headers
|
|
160
|
+
}
|
|
161
|
+
});
|
|
162
|
+
};
|
|
163
|
+
/**
|
|
164
|
+
* Create a new analytics export
|
|
165
|
+
* Create a new analytics export of messages or events (activities) over a specific time span.
|
|
166
|
+
* The export will be executed asynchronously. The response will include a link that can be used to retrieve the export status & result. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.
|
|
167
|
+
*
|
|
168
|
+
*/
|
|
169
|
+
export const createAnalyticsExport = (options) => {
|
|
170
|
+
return (options?.client ?? _heyApiClient).post({
|
|
171
|
+
security: [
|
|
172
|
+
{
|
|
173
|
+
scheme: 'bearer',
|
|
174
|
+
type: 'http'
|
|
175
|
+
}
|
|
176
|
+
],
|
|
177
|
+
url: '/analytics/exports',
|
|
178
|
+
...options,
|
|
179
|
+
headers: {
|
|
180
|
+
'Content-Type': 'application/json',
|
|
181
|
+
...options?.headers
|
|
182
|
+
}
|
|
183
|
+
});
|
|
184
|
+
};
|
|
185
|
+
/**
|
|
186
|
+
* Fetch an analytics export
|
|
187
|
+
* Fetch an analytics exports. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.
|
|
188
|
+
*/
|
|
189
|
+
export const getAnalyticsExport = (options) => {
|
|
190
|
+
return (options.client ?? _heyApiClient).get({
|
|
191
|
+
security: [
|
|
192
|
+
{
|
|
193
|
+
scheme: 'bearer',
|
|
194
|
+
type: 'http'
|
|
195
|
+
}
|
|
196
|
+
],
|
|
197
|
+
url: '/analytics/exports/{export_id}',
|
|
198
|
+
...options
|
|
199
|
+
});
|
|
200
|
+
};
|
|
201
|
+
/**
|
|
202
|
+
* Create a new analytics report
|
|
203
|
+
* Create a new analytics report for a set of metrics over a specific time span. Different filters (e.g. Inbox v Tag v Teammates) will be joined with AND logic, but the IDs within a filter will be joined with OR logic (e.g. Inbox A or Inbox B, Tag A or Tag B).
|
|
204
|
+
* The report will be executed asynchronously. The response will include a link that can be used to retrieve the
|
|
205
|
+
* report status & result. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.
|
|
206
|
+
*
|
|
207
|
+
*/
|
|
208
|
+
export const createAnalyticsReport = (options) => {
|
|
209
|
+
return (options?.client ?? _heyApiClient).post({
|
|
210
|
+
security: [
|
|
211
|
+
{
|
|
212
|
+
scheme: 'bearer',
|
|
213
|
+
type: 'http'
|
|
214
|
+
}
|
|
215
|
+
],
|
|
216
|
+
url: '/analytics/reports',
|
|
217
|
+
...options,
|
|
218
|
+
headers: {
|
|
219
|
+
'Content-Type': 'application/json',
|
|
220
|
+
...options?.headers
|
|
221
|
+
}
|
|
222
|
+
});
|
|
223
|
+
};
|
|
224
|
+
/**
|
|
225
|
+
* Fetch an analytics report
|
|
226
|
+
* Fetch an analytics report. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.
|
|
227
|
+
*/
|
|
228
|
+
export const getAnalyticsReport = (options) => {
|
|
229
|
+
return (options.client ?? _heyApiClient).get({
|
|
230
|
+
security: [
|
|
231
|
+
{
|
|
232
|
+
scheme: 'bearer',
|
|
233
|
+
type: 'http'
|
|
234
|
+
}
|
|
235
|
+
],
|
|
236
|
+
url: '/analytics/reports/{report_uid}',
|
|
237
|
+
...options
|
|
238
|
+
});
|
|
239
|
+
};
|
|
240
|
+
/**
|
|
241
|
+
* Trigger application event
|
|
242
|
+
* Triggers an event on behalf of an application. These events can trigger Front workflows, like rules.
|
|
243
|
+
* For more information, see the [developer docs](https://dev.frontapp.com/docs/application-triggers#/).
|
|
244
|
+
*
|
|
245
|
+
*/
|
|
246
|
+
export const triggerAppEvent = (options) => {
|
|
247
|
+
return (options.client ?? _heyApiClient).post({
|
|
248
|
+
security: [
|
|
249
|
+
{
|
|
250
|
+
scheme: 'bearer',
|
|
251
|
+
type: 'http'
|
|
252
|
+
}
|
|
253
|
+
],
|
|
254
|
+
url: '/applications/{application_uid}/events',
|
|
255
|
+
...options,
|
|
256
|
+
headers: {
|
|
257
|
+
'Content-Type': 'application/json',
|
|
258
|
+
...options.headers
|
|
259
|
+
}
|
|
260
|
+
});
|
|
261
|
+
};
|
|
262
|
+
/**
|
|
263
|
+
* List channels
|
|
264
|
+
* List the channels of the company.
|
|
265
|
+
*/
|
|
266
|
+
export const listChannels = (options) => {
|
|
267
|
+
return (options?.client ?? _heyApiClient).get({
|
|
268
|
+
security: [
|
|
269
|
+
{
|
|
270
|
+
scheme: 'bearer',
|
|
271
|
+
type: 'http'
|
|
272
|
+
}
|
|
273
|
+
],
|
|
274
|
+
url: '/channels',
|
|
275
|
+
...options
|
|
276
|
+
});
|
|
277
|
+
};
|
|
278
|
+
/**
|
|
279
|
+
* Get channel
|
|
280
|
+
* Fetch a channel.
|
|
281
|
+
*/
|
|
282
|
+
export const getChannel = (options) => {
|
|
283
|
+
return (options.client ?? _heyApiClient).get({
|
|
284
|
+
security: [
|
|
285
|
+
{
|
|
286
|
+
scheme: 'bearer',
|
|
287
|
+
type: 'http'
|
|
288
|
+
}
|
|
289
|
+
],
|
|
290
|
+
url: '/channels/{channel_id}',
|
|
291
|
+
...options
|
|
292
|
+
});
|
|
293
|
+
};
|
|
294
|
+
/**
|
|
295
|
+
* Update Channel
|
|
296
|
+
* Update a channel.
|
|
297
|
+
*/
|
|
298
|
+
export const updateChannel = (options) => {
|
|
299
|
+
return (options.client ?? _heyApiClient).patch({
|
|
300
|
+
security: [
|
|
301
|
+
{
|
|
302
|
+
scheme: 'bearer',
|
|
303
|
+
type: 'http'
|
|
304
|
+
}
|
|
305
|
+
],
|
|
306
|
+
url: '/channels/{channel_id}',
|
|
307
|
+
...options,
|
|
308
|
+
headers: {
|
|
309
|
+
'Content-Type': 'application/json',
|
|
310
|
+
...options.headers
|
|
311
|
+
}
|
|
312
|
+
});
|
|
313
|
+
};
|
|
314
|
+
/**
|
|
315
|
+
* Create draft
|
|
316
|
+
* Create a draft message which is the first message of a new [conversation](https://dev.frontapp.com/reference/conversations).
|
|
317
|
+
*/
|
|
318
|
+
export const createDraft = (options) => {
|
|
319
|
+
return (options.client ?? _heyApiClient).post({
|
|
320
|
+
security: [
|
|
321
|
+
{
|
|
322
|
+
scheme: 'bearer',
|
|
323
|
+
type: 'http'
|
|
324
|
+
}
|
|
325
|
+
],
|
|
326
|
+
url: '/channels/{channel_id}/drafts',
|
|
327
|
+
...options,
|
|
328
|
+
headers: {
|
|
329
|
+
'Content-Type': 'application/json',
|
|
330
|
+
...options.headers
|
|
331
|
+
}
|
|
332
|
+
});
|
|
333
|
+
};
|
|
334
|
+
/**
|
|
335
|
+
* Receive custom messages
|
|
336
|
+
* Receive a custom message in Front. This endpoint is available for custom channels **ONLY**.
|
|
337
|
+
*/
|
|
338
|
+
export const receiveCustomMessages = (options) => {
|
|
339
|
+
return (options.client ?? _heyApiClient).post({
|
|
340
|
+
security: [
|
|
341
|
+
{
|
|
342
|
+
scheme: 'bearer',
|
|
343
|
+
type: 'http'
|
|
344
|
+
}
|
|
345
|
+
],
|
|
346
|
+
url: '/channels/{channel_id}/incoming_messages',
|
|
347
|
+
...options,
|
|
348
|
+
headers: {
|
|
349
|
+
'Content-Type': 'application/json',
|
|
350
|
+
...options.headers
|
|
351
|
+
}
|
|
352
|
+
});
|
|
353
|
+
};
|
|
354
|
+
/**
|
|
355
|
+
* Create message
|
|
356
|
+
* Send a new message from a channel. This is one of the ways to create a new [conversation](https://dev.frontapp.com/reference/conversations#creating-a-new-conversation). The new conversation will support both messages and comments (discussions).
|
|
357
|
+
*/
|
|
358
|
+
export const createMessage = (options) => {
|
|
359
|
+
return (options.client ?? _heyApiClient).post({
|
|
360
|
+
security: [
|
|
361
|
+
{
|
|
362
|
+
scheme: 'bearer',
|
|
363
|
+
type: 'http'
|
|
364
|
+
}
|
|
365
|
+
],
|
|
366
|
+
url: '/channels/{channel_id}/messages',
|
|
367
|
+
...options,
|
|
368
|
+
headers: {
|
|
369
|
+
'Content-Type': 'application/json',
|
|
370
|
+
...options.headers
|
|
371
|
+
}
|
|
372
|
+
});
|
|
373
|
+
};
|
|
374
|
+
/**
|
|
375
|
+
* Validate channel
|
|
376
|
+
* Asynchronously validate an SMTP channel (this endpoint is irrelevant to other channel types). When you create an SMTP channel via the API, [create a channel](https://dev.frontapp.com/reference/post_inboxes-inbox-id-channels) with type smtp and the send_as set to the needed email address. You then [configure the email provider](https://help.front.com/en/articles/2081), after which you use this endpoint to asynchronously validate the SMTP settings.
|
|
377
|
+
*/
|
|
378
|
+
export const validateChannel = (options) => {
|
|
379
|
+
return (options.client ?? _heyApiClient).post({
|
|
380
|
+
security: [
|
|
381
|
+
{
|
|
382
|
+
scheme: 'bearer',
|
|
383
|
+
type: 'http'
|
|
384
|
+
}
|
|
385
|
+
],
|
|
386
|
+
url: '/channels/{channel_id}/validate',
|
|
387
|
+
...options
|
|
388
|
+
});
|
|
389
|
+
};
|
|
390
|
+
/**
|
|
391
|
+
* Get comment
|
|
392
|
+
* Fetches a comment.
|
|
393
|
+
*/
|
|
394
|
+
export const getComment = (options) => {
|
|
395
|
+
return (options.client ?? _heyApiClient).get({
|
|
396
|
+
security: [
|
|
397
|
+
{
|
|
398
|
+
scheme: 'bearer',
|
|
399
|
+
type: 'http'
|
|
400
|
+
}
|
|
401
|
+
],
|
|
402
|
+
url: '/comments/{comment_id}',
|
|
403
|
+
...options
|
|
404
|
+
});
|
|
405
|
+
};
|
|
406
|
+
/**
|
|
407
|
+
* Update comment
|
|
408
|
+
* Update a comment in a [conversation](https://dev.frontapp.com/reference/conversations).
|
|
409
|
+
*/
|
|
410
|
+
export const updateComment = (options) => {
|
|
411
|
+
return (options.client ?? _heyApiClient).patch({
|
|
412
|
+
security: [
|
|
413
|
+
{
|
|
414
|
+
scheme: 'bearer',
|
|
415
|
+
type: 'http'
|
|
416
|
+
}
|
|
417
|
+
],
|
|
418
|
+
url: '/comments/{comment_id}/',
|
|
419
|
+
...options,
|
|
420
|
+
headers: {
|
|
421
|
+
'Content-Type': 'application/json',
|
|
422
|
+
...options.headers
|
|
423
|
+
}
|
|
424
|
+
});
|
|
425
|
+
};
|
|
426
|
+
/**
|
|
427
|
+
* Download attachment for a comment
|
|
428
|
+
* Download an attachment file for a given comment ID
|
|
429
|
+
*/
|
|
430
|
+
export const downloadAttachmentForAComment = (options) => {
|
|
431
|
+
return (options.client ?? _heyApiClient).get({
|
|
432
|
+
security: [
|
|
433
|
+
{
|
|
434
|
+
scheme: 'bearer',
|
|
435
|
+
type: 'http'
|
|
436
|
+
}
|
|
437
|
+
],
|
|
438
|
+
url: '/comments/{comment_id}/download/{attachment_link_id}',
|
|
439
|
+
...options
|
|
440
|
+
});
|
|
441
|
+
};
|
|
442
|
+
/**
|
|
443
|
+
* List comment mentions
|
|
444
|
+
* List the teammates mentioned in a comment.
|
|
445
|
+
*/
|
|
446
|
+
export const listCommentMentions = (options) => {
|
|
447
|
+
return (options.client ?? _heyApiClient).get({
|
|
448
|
+
security: [
|
|
449
|
+
{
|
|
450
|
+
scheme: 'bearer',
|
|
451
|
+
type: 'http'
|
|
452
|
+
}
|
|
453
|
+
],
|
|
454
|
+
url: '/comments/{comment_id}/mentions',
|
|
455
|
+
...options
|
|
456
|
+
});
|
|
457
|
+
};
|
|
458
|
+
/**
|
|
459
|
+
* Add comment reply
|
|
460
|
+
* Add a reply to a comment on a [conversation](https://dev.frontapp.com/reference/conversations). Comment replies visually indicate which comment is being responded to, helping users follow the conversation.
|
|
461
|
+
*/
|
|
462
|
+
export const addCommentReply = (options) => {
|
|
463
|
+
return (options.client ?? _heyApiClient).post({
|
|
464
|
+
security: [
|
|
465
|
+
{
|
|
466
|
+
scheme: 'bearer',
|
|
467
|
+
type: 'http'
|
|
468
|
+
}
|
|
469
|
+
],
|
|
470
|
+
url: '/comments/{comment_id}/replies',
|
|
471
|
+
...options,
|
|
472
|
+
headers: {
|
|
473
|
+
'Content-Type': 'application/json',
|
|
474
|
+
...options.headers
|
|
475
|
+
}
|
|
476
|
+
});
|
|
477
|
+
};
|
|
478
|
+
/**
|
|
479
|
+
* List all company rules
|
|
480
|
+
* List the company rules.
|
|
481
|
+
*/
|
|
482
|
+
export const listAllCompanyRules = (options) => {
|
|
483
|
+
return (options?.client ?? _heyApiClient).get({
|
|
484
|
+
security: [
|
|
485
|
+
{
|
|
486
|
+
scheme: 'bearer',
|
|
487
|
+
type: 'http'
|
|
488
|
+
}
|
|
489
|
+
],
|
|
490
|
+
url: '/company/rules',
|
|
491
|
+
...options
|
|
492
|
+
});
|
|
493
|
+
};
|
|
494
|
+
/**
|
|
495
|
+
* List company ticket statuses
|
|
496
|
+
* List the ticket statuses available for your company.
|
|
497
|
+
*/
|
|
498
|
+
export const listCompanyTicketStatuses = (options) => {
|
|
499
|
+
return (options?.client ?? _heyApiClient).get({
|
|
500
|
+
security: [
|
|
501
|
+
{
|
|
502
|
+
scheme: 'bearer',
|
|
503
|
+
type: 'http'
|
|
504
|
+
}
|
|
505
|
+
],
|
|
506
|
+
url: '/company/statuses',
|
|
507
|
+
...options
|
|
508
|
+
});
|
|
509
|
+
};
|
|
510
|
+
/**
|
|
511
|
+
* Get ticket status
|
|
512
|
+
* Fetch a ticket status.
|
|
513
|
+
*/
|
|
514
|
+
export const getTicketStatusById = (options) => {
|
|
515
|
+
return (options.client ?? _heyApiClient).get({
|
|
516
|
+
security: [
|
|
517
|
+
{
|
|
518
|
+
scheme: 'bearer',
|
|
519
|
+
type: 'http'
|
|
520
|
+
}
|
|
521
|
+
],
|
|
522
|
+
url: '/company/statuses/{status_id}',
|
|
523
|
+
...options
|
|
524
|
+
});
|
|
525
|
+
};
|
|
526
|
+
/**
|
|
527
|
+
* List company tags
|
|
528
|
+
* List the company tags.
|
|
529
|
+
*/
|
|
530
|
+
export const listCompanyTags = (options) => {
|
|
531
|
+
return (options?.client ?? _heyApiClient).get({
|
|
532
|
+
security: [
|
|
533
|
+
{
|
|
534
|
+
scheme: 'bearer',
|
|
535
|
+
type: 'http'
|
|
536
|
+
}
|
|
537
|
+
],
|
|
538
|
+
url: '/company/tags',
|
|
539
|
+
...options
|
|
540
|
+
});
|
|
541
|
+
};
|
|
542
|
+
/**
|
|
543
|
+
* Create company tag
|
|
544
|
+
* Create a company tag.
|
|
545
|
+
*/
|
|
546
|
+
export const createCompanyTag = (options) => {
|
|
547
|
+
return (options?.client ?? _heyApiClient).post({
|
|
548
|
+
security: [
|
|
549
|
+
{
|
|
550
|
+
scheme: 'bearer',
|
|
551
|
+
type: 'http'
|
|
552
|
+
}
|
|
553
|
+
],
|
|
554
|
+
url: '/company/tags',
|
|
555
|
+
...options,
|
|
556
|
+
headers: {
|
|
557
|
+
'Content-Type': 'application/json',
|
|
558
|
+
...options?.headers
|
|
559
|
+
}
|
|
560
|
+
});
|
|
561
|
+
};
|
|
562
|
+
/**
|
|
563
|
+
* List groups
|
|
564
|
+
* List the contact groups.
|
|
565
|
+
*
|
|
566
|
+
* > ⚠️ Deprecated endpoint
|
|
567
|
+
* >
|
|
568
|
+
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
569
|
+
* > - `GET /contact_lists`.
|
|
570
|
+
*
|
|
571
|
+
* @deprecated
|
|
572
|
+
*/
|
|
573
|
+
export const listGroups = (options) => {
|
|
574
|
+
return (options?.client ?? _heyApiClient).get({
|
|
575
|
+
security: [
|
|
576
|
+
{
|
|
577
|
+
scheme: 'bearer',
|
|
578
|
+
type: 'http'
|
|
579
|
+
}
|
|
580
|
+
],
|
|
581
|
+
url: '/contact_groups',
|
|
582
|
+
...options
|
|
583
|
+
});
|
|
584
|
+
};
|
|
585
|
+
/**
|
|
586
|
+
* Create group
|
|
587
|
+
* Create a new contact group in the default team (workspace).
|
|
588
|
+
*
|
|
589
|
+
* > ⚠️ Deprecated endpoint
|
|
590
|
+
* >
|
|
591
|
+
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
592
|
+
* > - `POST /contact_lists`.
|
|
593
|
+
*
|
|
594
|
+
* @deprecated
|
|
595
|
+
*/
|
|
596
|
+
export const createGroup = (options) => {
|
|
597
|
+
return (options?.client ?? _heyApiClient).post({
|
|
598
|
+
security: [
|
|
599
|
+
{
|
|
600
|
+
scheme: 'bearer',
|
|
601
|
+
type: 'http'
|
|
602
|
+
}
|
|
603
|
+
],
|
|
604
|
+
url: '/contact_groups',
|
|
605
|
+
...options,
|
|
606
|
+
headers: {
|
|
607
|
+
'Content-Type': 'application/json',
|
|
608
|
+
...options?.headers
|
|
609
|
+
}
|
|
610
|
+
});
|
|
611
|
+
};
|
|
612
|
+
/**
|
|
613
|
+
* Delete group
|
|
614
|
+
* Delete a contact group.
|
|
615
|
+
*
|
|
616
|
+
* > ⚠️ Deprecated endpoint
|
|
617
|
+
* >
|
|
618
|
+
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
619
|
+
* > - `DELETE /contact_lists/{contact_list_id}`.
|
|
620
|
+
*
|
|
621
|
+
* @deprecated
|
|
622
|
+
*/
|
|
623
|
+
export const deleteGroup = (options) => {
|
|
624
|
+
return (options.client ?? _heyApiClient).delete({
|
|
625
|
+
security: [
|
|
626
|
+
{
|
|
627
|
+
scheme: 'bearer',
|
|
628
|
+
type: 'http'
|
|
629
|
+
}
|
|
630
|
+
],
|
|
631
|
+
url: '/contact_groups/{contact_group_id}',
|
|
632
|
+
...options
|
|
633
|
+
});
|
|
634
|
+
};
|
|
635
|
+
/**
|
|
636
|
+
* Remove contacts from group
|
|
637
|
+
* Remove contacts from the requested group.
|
|
638
|
+
*
|
|
639
|
+
* > ⚠️ Deprecated endpoint
|
|
640
|
+
* >
|
|
641
|
+
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
642
|
+
* > - `DELETE /contact_lists/{contact_list_id}/contacts`.
|
|
643
|
+
*
|
|
644
|
+
*/
|
|
645
|
+
export const removeContactsFromGroup = (options) => {
|
|
646
|
+
return (options.client ?? _heyApiClient).delete({
|
|
647
|
+
security: [
|
|
648
|
+
{
|
|
649
|
+
scheme: 'bearer',
|
|
650
|
+
type: 'http'
|
|
651
|
+
}
|
|
652
|
+
],
|
|
653
|
+
url: '/contact_groups/{contact_group_id}/contacts',
|
|
654
|
+
...options,
|
|
655
|
+
headers: {
|
|
656
|
+
'Content-Type': 'application/json',
|
|
657
|
+
...options.headers
|
|
658
|
+
}
|
|
659
|
+
});
|
|
660
|
+
};
|
|
661
|
+
/**
|
|
662
|
+
* List contacts in group
|
|
663
|
+
* List the contacts belonging to the requested group.
|
|
664
|
+
*
|
|
665
|
+
* > ⚠️ Deprecated endpoint
|
|
666
|
+
* >
|
|
667
|
+
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
668
|
+
* > - `GET /contact_lists/{contact_list_id}/contacts`.
|
|
669
|
+
*
|
|
670
|
+
* @deprecated
|
|
671
|
+
*/
|
|
672
|
+
export const listContactsInGroup = (options) => {
|
|
673
|
+
return (options.client ?? _heyApiClient).get({
|
|
674
|
+
security: [
|
|
675
|
+
{
|
|
676
|
+
scheme: 'bearer',
|
|
677
|
+
type: 'http'
|
|
678
|
+
}
|
|
679
|
+
],
|
|
680
|
+
url: '/contact_groups/{contact_group_id}/contacts',
|
|
681
|
+
...options
|
|
682
|
+
});
|
|
683
|
+
};
|
|
684
|
+
/**
|
|
685
|
+
* Add contacts to group
|
|
686
|
+
* Add contacts to the requested group.
|
|
687
|
+
*
|
|
688
|
+
* > ⚠️ Deprecated endpoint
|
|
689
|
+
* >
|
|
690
|
+
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
691
|
+
* > - `POST /contact_lists/{contact_list_id}/contacts`.
|
|
692
|
+
*
|
|
693
|
+
* @deprecated
|
|
694
|
+
*/
|
|
695
|
+
export const addContactsToGroup = (options) => {
|
|
696
|
+
return (options.client ?? _heyApiClient).post({
|
|
697
|
+
security: [
|
|
698
|
+
{
|
|
699
|
+
scheme: 'bearer',
|
|
700
|
+
type: 'http'
|
|
701
|
+
}
|
|
702
|
+
],
|
|
703
|
+
url: '/contact_groups/{contact_group_id}/contacts',
|
|
704
|
+
...options,
|
|
705
|
+
headers: {
|
|
706
|
+
'Content-Type': 'application/json',
|
|
707
|
+
...options.headers
|
|
708
|
+
}
|
|
709
|
+
});
|
|
710
|
+
};
|
|
711
|
+
/**
|
|
712
|
+
* List contact lists
|
|
713
|
+
* List contact lists.
|
|
714
|
+
*/
|
|
715
|
+
export const listContactLists = (options) => {
|
|
716
|
+
return (options?.client ?? _heyApiClient).get({
|
|
717
|
+
security: [
|
|
718
|
+
{
|
|
719
|
+
scheme: 'bearer',
|
|
720
|
+
type: 'http'
|
|
721
|
+
}
|
|
722
|
+
],
|
|
723
|
+
url: '/contact_lists',
|
|
724
|
+
...options
|
|
725
|
+
});
|
|
726
|
+
};
|
|
727
|
+
/**
|
|
728
|
+
* Create contact list
|
|
729
|
+
* Create a new contact list in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team contact list](https://dev.frontapp.com/reference/create-team-contact-list) endpoint instead.
|
|
730
|
+
*/
|
|
731
|
+
export const createContactList = (options) => {
|
|
732
|
+
return (options?.client ?? _heyApiClient).post({
|
|
733
|
+
security: [
|
|
734
|
+
{
|
|
735
|
+
scheme: 'bearer',
|
|
736
|
+
type: 'http'
|
|
737
|
+
}
|
|
738
|
+
],
|
|
739
|
+
url: '/contact_lists',
|
|
740
|
+
...options,
|
|
741
|
+
headers: {
|
|
742
|
+
'Content-Type': 'application/json',
|
|
743
|
+
...options?.headers
|
|
744
|
+
}
|
|
745
|
+
});
|
|
746
|
+
};
|
|
747
|
+
/**
|
|
748
|
+
* Delete contact list
|
|
749
|
+
* Delete a contact lists.
|
|
750
|
+
*/
|
|
751
|
+
export const deleteContactList = (options) => {
|
|
752
|
+
return (options.client ?? _heyApiClient).delete({
|
|
753
|
+
security: [
|
|
754
|
+
{
|
|
755
|
+
scheme: 'bearer',
|
|
756
|
+
type: 'http'
|
|
757
|
+
}
|
|
758
|
+
],
|
|
759
|
+
url: '/contact_lists/{contact_list_id}',
|
|
760
|
+
...options
|
|
761
|
+
});
|
|
762
|
+
};
|
|
763
|
+
/**
|
|
764
|
+
* Remove contacts from contact list
|
|
765
|
+
* Remove contacts from the requested contact list.
|
|
766
|
+
*/
|
|
767
|
+
export const removeContactsFromContactList = (options) => {
|
|
768
|
+
return (options.client ?? _heyApiClient).delete({
|
|
769
|
+
security: [
|
|
770
|
+
{
|
|
771
|
+
scheme: 'bearer',
|
|
772
|
+
type: 'http'
|
|
773
|
+
}
|
|
774
|
+
],
|
|
775
|
+
url: '/contact_lists/{contact_list_id}/contacts',
|
|
776
|
+
...options,
|
|
777
|
+
headers: {
|
|
778
|
+
'Content-Type': 'application/json',
|
|
779
|
+
...options.headers
|
|
780
|
+
}
|
|
781
|
+
});
|
|
782
|
+
};
|
|
783
|
+
/**
|
|
784
|
+
* List contacts in contact list
|
|
785
|
+
* List the contacts belonging to the requested contact list.
|
|
786
|
+
*/
|
|
787
|
+
export const listContactsInContactList = (options) => {
|
|
788
|
+
return (options.client ?? _heyApiClient).get({
|
|
789
|
+
security: [
|
|
790
|
+
{
|
|
791
|
+
scheme: 'bearer',
|
|
792
|
+
type: 'http'
|
|
793
|
+
}
|
|
794
|
+
],
|
|
795
|
+
url: '/contact_lists/{contact_list_id}/contacts',
|
|
796
|
+
...options
|
|
797
|
+
});
|
|
798
|
+
};
|
|
799
|
+
/**
|
|
800
|
+
* Add contacts to contact list
|
|
801
|
+
* Add contacts to the requested contact list.
|
|
802
|
+
*/
|
|
803
|
+
export const addContactsToContactList = (options) => {
|
|
804
|
+
return (options.client ?? _heyApiClient).post({
|
|
805
|
+
security: [
|
|
806
|
+
{
|
|
807
|
+
scheme: 'bearer',
|
|
808
|
+
type: 'http'
|
|
809
|
+
}
|
|
810
|
+
],
|
|
811
|
+
url: '/contact_lists/{contact_list_id}/contacts',
|
|
812
|
+
...options,
|
|
813
|
+
headers: {
|
|
814
|
+
'Content-Type': 'application/json',
|
|
815
|
+
...options.headers
|
|
816
|
+
}
|
|
817
|
+
});
|
|
818
|
+
};
|
|
819
|
+
/**
|
|
820
|
+
* List contacts
|
|
821
|
+
* List the contacts of the company.
|
|
822
|
+
*/
|
|
823
|
+
export const listContacts = (options) => {
|
|
824
|
+
return (options?.client ?? _heyApiClient).get({
|
|
825
|
+
security: [
|
|
826
|
+
{
|
|
827
|
+
scheme: 'bearer',
|
|
828
|
+
type: 'http'
|
|
829
|
+
}
|
|
830
|
+
],
|
|
831
|
+
url: '/contacts',
|
|
832
|
+
...options
|
|
833
|
+
});
|
|
834
|
+
};
|
|
835
|
+
/**
|
|
836
|
+
* Create contact
|
|
837
|
+
* Create a new contact at the company level.
|
|
838
|
+
*/
|
|
839
|
+
export const createContact = (options) => {
|
|
840
|
+
return (options?.client ?? _heyApiClient).post({
|
|
841
|
+
security: [
|
|
842
|
+
{
|
|
843
|
+
scheme: 'bearer',
|
|
844
|
+
type: 'http'
|
|
845
|
+
}
|
|
846
|
+
],
|
|
847
|
+
url: '/contacts',
|
|
848
|
+
...options,
|
|
849
|
+
headers: {
|
|
850
|
+
'Content-Type': 'application/json',
|
|
851
|
+
...options?.headers
|
|
852
|
+
}
|
|
853
|
+
});
|
|
854
|
+
};
|
|
855
|
+
/**
|
|
856
|
+
* List Contact's custom fields
|
|
857
|
+
* Lists the custom fields that can be attached to a Contact.
|
|
858
|
+
*/
|
|
859
|
+
export const listContactCustomFields = (options) => {
|
|
860
|
+
return (options?.client ?? _heyApiClient).get({
|
|
861
|
+
security: [
|
|
862
|
+
{
|
|
863
|
+
scheme: 'bearer',
|
|
864
|
+
type: 'http'
|
|
865
|
+
}
|
|
866
|
+
],
|
|
867
|
+
url: '/contacts/custom_fields',
|
|
868
|
+
...options
|
|
869
|
+
});
|
|
870
|
+
};
|
|
871
|
+
/**
|
|
872
|
+
* Merge contacts
|
|
873
|
+
* Merges the contacts specified into a single contact, deleting the merged-in contacts.
|
|
874
|
+
* If a target contact ID is supplied, the other contacts will be merged into that one.
|
|
875
|
+
* Otherwise, some contact in the contact ID list will be treated as the target contact.
|
|
876
|
+
* Merge conflicts will be resolved in the following ways:
|
|
877
|
+
* * name will prioritize manually-updated and non-private contact names
|
|
878
|
+
* * descriptions will be concatenated and separated by newlines in order from
|
|
879
|
+
* oldest to newest with the (optional) target contact's description first
|
|
880
|
+
* * all handles, groups, links, and notes will be preserved
|
|
881
|
+
* * other conflicts will use the most recently updated contact's value
|
|
882
|
+
*
|
|
883
|
+
*/
|
|
884
|
+
export const mergeContacts = (options) => {
|
|
885
|
+
return (options?.client ?? _heyApiClient).post({
|
|
886
|
+
security: [
|
|
887
|
+
{
|
|
888
|
+
scheme: 'bearer',
|
|
889
|
+
type: 'http'
|
|
890
|
+
}
|
|
891
|
+
],
|
|
892
|
+
url: '/contacts/merge',
|
|
893
|
+
...options,
|
|
894
|
+
headers: {
|
|
895
|
+
'Content-Type': 'application/json',
|
|
896
|
+
...options?.headers
|
|
897
|
+
}
|
|
898
|
+
});
|
|
899
|
+
};
|
|
900
|
+
/**
|
|
901
|
+
* Delete a contact
|
|
902
|
+
* Delete a contact.
|
|
903
|
+
*/
|
|
904
|
+
export const deleteAContact = (options) => {
|
|
905
|
+
return (options.client ?? _heyApiClient).delete({
|
|
906
|
+
security: [
|
|
907
|
+
{
|
|
908
|
+
scheme: 'bearer',
|
|
909
|
+
type: 'http'
|
|
910
|
+
}
|
|
911
|
+
],
|
|
912
|
+
url: '/contacts/{contact_id}',
|
|
913
|
+
...options
|
|
914
|
+
});
|
|
915
|
+
};
|
|
916
|
+
/**
|
|
917
|
+
* Get contact
|
|
918
|
+
* Fetch a contact.
|
|
919
|
+
*/
|
|
920
|
+
export const getContact = (options) => {
|
|
921
|
+
return (options.client ?? _heyApiClient).get({
|
|
922
|
+
security: [
|
|
923
|
+
{
|
|
924
|
+
scheme: 'bearer',
|
|
925
|
+
type: 'http'
|
|
926
|
+
}
|
|
927
|
+
],
|
|
928
|
+
url: '/contacts/{contact_id}',
|
|
929
|
+
...options
|
|
930
|
+
});
|
|
931
|
+
};
|
|
932
|
+
/**
|
|
933
|
+
* Update a contact
|
|
934
|
+
* Updates a contact.
|
|
935
|
+
*/
|
|
936
|
+
export const updateAContact = (options) => {
|
|
937
|
+
return (options.client ?? _heyApiClient).patch({
|
|
938
|
+
security: [
|
|
939
|
+
{
|
|
940
|
+
scheme: 'bearer',
|
|
941
|
+
type: 'http'
|
|
942
|
+
}
|
|
943
|
+
],
|
|
944
|
+
url: '/contacts/{contact_id}',
|
|
945
|
+
...options,
|
|
946
|
+
headers: {
|
|
947
|
+
'Content-Type': 'application/json',
|
|
948
|
+
...options.headers
|
|
949
|
+
}
|
|
950
|
+
});
|
|
951
|
+
};
|
|
952
|
+
/**
|
|
953
|
+
* List contact conversations
|
|
954
|
+
* List the conversations for a contact in reverse chronological order (newest first). For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
|
|
955
|
+
*
|
|
956
|
+
*/
|
|
957
|
+
export const listContactConversations = (options) => {
|
|
958
|
+
return (options.client ?? _heyApiClient).get({
|
|
959
|
+
security: [
|
|
960
|
+
{
|
|
961
|
+
scheme: 'bearer',
|
|
962
|
+
type: 'http'
|
|
963
|
+
}
|
|
964
|
+
],
|
|
965
|
+
url: '/contacts/{contact_id}/conversations',
|
|
966
|
+
...options
|
|
967
|
+
});
|
|
968
|
+
};
|
|
969
|
+
/**
|
|
970
|
+
* Delete contact handle
|
|
971
|
+
* Remove a handle from a contact.
|
|
972
|
+
*/
|
|
973
|
+
export const deleteContactHandle = (options) => {
|
|
974
|
+
return (options.client ?? _heyApiClient).delete({
|
|
975
|
+
security: [
|
|
976
|
+
{
|
|
977
|
+
scheme: 'bearer',
|
|
978
|
+
type: 'http'
|
|
979
|
+
}
|
|
980
|
+
],
|
|
981
|
+
url: '/contacts/{contact_id}/handles',
|
|
982
|
+
...options,
|
|
983
|
+
headers: {
|
|
984
|
+
'Content-Type': 'application/json',
|
|
985
|
+
...options.headers
|
|
986
|
+
}
|
|
987
|
+
});
|
|
988
|
+
};
|
|
989
|
+
/**
|
|
990
|
+
* Add contact handle
|
|
991
|
+
* Adds a new handle to a contact.
|
|
992
|
+
*/
|
|
993
|
+
export const addContactHandle = (options) => {
|
|
994
|
+
return (options.client ?? _heyApiClient).post({
|
|
995
|
+
security: [
|
|
996
|
+
{
|
|
997
|
+
scheme: 'bearer',
|
|
998
|
+
type: 'http'
|
|
999
|
+
}
|
|
1000
|
+
],
|
|
1001
|
+
url: '/contacts/{contact_id}/handles',
|
|
1002
|
+
...options,
|
|
1003
|
+
headers: {
|
|
1004
|
+
'Content-Type': 'application/json',
|
|
1005
|
+
...options.headers
|
|
1006
|
+
}
|
|
1007
|
+
});
|
|
1008
|
+
};
|
|
1009
|
+
/**
|
|
1010
|
+
* List notes
|
|
1011
|
+
* List the notes added to a contact.
|
|
1012
|
+
*/
|
|
1013
|
+
export const listNotes = (options) => {
|
|
1014
|
+
return (options.client ?? _heyApiClient).get({
|
|
1015
|
+
security: [
|
|
1016
|
+
{
|
|
1017
|
+
scheme: 'bearer',
|
|
1018
|
+
type: 'http'
|
|
1019
|
+
}
|
|
1020
|
+
],
|
|
1021
|
+
url: '/contacts/{contact_id}/notes',
|
|
1022
|
+
...options
|
|
1023
|
+
});
|
|
1024
|
+
};
|
|
1025
|
+
/**
|
|
1026
|
+
* Add note
|
|
1027
|
+
* Create a new note on a contact.
|
|
1028
|
+
*/
|
|
1029
|
+
export const addNote = (options) => {
|
|
1030
|
+
return (options.client ?? _heyApiClient).post({
|
|
1031
|
+
security: [
|
|
1032
|
+
{
|
|
1033
|
+
scheme: 'bearer',
|
|
1034
|
+
type: 'http'
|
|
1035
|
+
}
|
|
1036
|
+
],
|
|
1037
|
+
url: '/contacts/{contact_id}/notes',
|
|
1038
|
+
...options,
|
|
1039
|
+
headers: {
|
|
1040
|
+
'Content-Type': 'application/json',
|
|
1041
|
+
...options.headers
|
|
1042
|
+
}
|
|
1043
|
+
});
|
|
1044
|
+
};
|
|
1045
|
+
/**
|
|
1046
|
+
* List conversations
|
|
1047
|
+
* List the conversations in the company in reverse chronological order (most recently updated first). The order will respect your company's [bump settings](https://help.front.com/t/y729th/customize-when-conversations-bump-up), which determine when conversations bump to the top. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
|
|
1048
|
+
*
|
|
1049
|
+
*/
|
|
1050
|
+
export const listConversations = (options) => {
|
|
1051
|
+
return (options?.client ?? _heyApiClient).get({
|
|
1052
|
+
security: [
|
|
1053
|
+
{
|
|
1054
|
+
scheme: 'bearer',
|
|
1055
|
+
type: 'http'
|
|
1056
|
+
}
|
|
1057
|
+
],
|
|
1058
|
+
url: '/conversations',
|
|
1059
|
+
...options
|
|
1060
|
+
});
|
|
1061
|
+
};
|
|
1062
|
+
/**
|
|
1063
|
+
* Create discussion conversation
|
|
1064
|
+
* Create a new [conversation](https://dev.frontapp.com/reference/conversations#creating-a-new-conversation) that only supports comments (known as discussions in Front). If you want to create a conversation that supports messages, use the [Create message](https://dev.frontapp.com/reference/post_channels-channel-id-messages) endpoint. If you want to add a comment to an existing conversation, use the [Add comment](https://dev.frontapp.com/reference/post_conversations-conversation-id-comments) endpoint.
|
|
1065
|
+
*/
|
|
1066
|
+
export const createConversation = (options) => {
|
|
1067
|
+
return (options?.client ?? _heyApiClient).post({
|
|
1068
|
+
security: [
|
|
1069
|
+
{
|
|
1070
|
+
scheme: 'bearer',
|
|
1071
|
+
type: 'http'
|
|
1072
|
+
}
|
|
1073
|
+
],
|
|
1074
|
+
url: '/conversations',
|
|
1075
|
+
...options,
|
|
1076
|
+
headers: {
|
|
1077
|
+
'Content-Type': 'application/json',
|
|
1078
|
+
...options?.headers
|
|
1079
|
+
}
|
|
1080
|
+
});
|
|
1081
|
+
};
|
|
1082
|
+
/**
|
|
1083
|
+
* List Conversation's custom fields
|
|
1084
|
+
* Lists the custom fields that can be attached to a Conversation.
|
|
1085
|
+
*/
|
|
1086
|
+
export const listConversationCustomFields = (options) => {
|
|
1087
|
+
return (options?.client ?? _heyApiClient).get({
|
|
1088
|
+
security: [
|
|
1089
|
+
{
|
|
1090
|
+
scheme: 'bearer',
|
|
1091
|
+
type: 'http'
|
|
1092
|
+
}
|
|
1093
|
+
],
|
|
1094
|
+
url: '/conversations/custom_fields',
|
|
1095
|
+
...options
|
|
1096
|
+
});
|
|
1097
|
+
};
|
|
1098
|
+
/**
|
|
1099
|
+
* Search conversations
|
|
1100
|
+
* Search for conversations. Response will include a count of total matches and an array of conversations in descending order by last activity.
|
|
1101
|
+
* See the [search syntax documentation](https://dev.frontapp.com/docs/search-1) for usage examples.
|
|
1102
|
+
* **Note:** This endpoint is subject to [proportional rate limiting](https://dev.frontapp.com/docs/rate-limiting#additional-proportional-limiting) at 40% of your company's rate limit.
|
|
1103
|
+
*
|
|
1104
|
+
*/
|
|
1105
|
+
export const searchConversations = (options) => {
|
|
1106
|
+
return (options.client ?? _heyApiClient).get({
|
|
1107
|
+
security: [
|
|
1108
|
+
{
|
|
1109
|
+
scheme: 'bearer',
|
|
1110
|
+
type: 'http'
|
|
1111
|
+
}
|
|
1112
|
+
],
|
|
1113
|
+
url: '/conversations/search/{query}',
|
|
1114
|
+
...options
|
|
1115
|
+
});
|
|
1116
|
+
};
|
|
1117
|
+
/**
|
|
1118
|
+
* Get conversation
|
|
1119
|
+
* Fetch a conversation.
|
|
1120
|
+
*
|
|
1121
|
+
*/
|
|
1122
|
+
export const getConversationById = (options) => {
|
|
1123
|
+
return (options.client ?? _heyApiClient).get({
|
|
1124
|
+
security: [
|
|
1125
|
+
{
|
|
1126
|
+
scheme: 'bearer',
|
|
1127
|
+
type: 'http'
|
|
1128
|
+
}
|
|
1129
|
+
],
|
|
1130
|
+
url: '/conversations/{conversation_id}',
|
|
1131
|
+
...options
|
|
1132
|
+
});
|
|
1133
|
+
};
|
|
1134
|
+
/**
|
|
1135
|
+
* Update conversation
|
|
1136
|
+
* Update a conversation.
|
|
1137
|
+
*/
|
|
1138
|
+
export const updateConversation = (options) => {
|
|
1139
|
+
return (options.client ?? _heyApiClient).patch({
|
|
1140
|
+
security: [
|
|
1141
|
+
{
|
|
1142
|
+
scheme: 'bearer',
|
|
1143
|
+
type: 'http'
|
|
1144
|
+
}
|
|
1145
|
+
],
|
|
1146
|
+
url: '/conversations/{conversation_id}',
|
|
1147
|
+
...options,
|
|
1148
|
+
headers: {
|
|
1149
|
+
'Content-Type': 'application/json',
|
|
1150
|
+
...options.headers
|
|
1151
|
+
}
|
|
1152
|
+
});
|
|
1153
|
+
};
|
|
1154
|
+
/**
|
|
1155
|
+
* Update conversation assignee
|
|
1156
|
+
* Assign or unassign a conversation.
|
|
1157
|
+
*/
|
|
1158
|
+
export const updateConversationAssignee = (options) => {
|
|
1159
|
+
return (options.client ?? _heyApiClient).put({
|
|
1160
|
+
security: [
|
|
1161
|
+
{
|
|
1162
|
+
scheme: 'bearer',
|
|
1163
|
+
type: 'http'
|
|
1164
|
+
}
|
|
1165
|
+
],
|
|
1166
|
+
url: '/conversations/{conversation_id}/assignee',
|
|
1167
|
+
...options,
|
|
1168
|
+
headers: {
|
|
1169
|
+
'Content-Type': 'application/json',
|
|
1170
|
+
...options.headers
|
|
1171
|
+
}
|
|
1172
|
+
});
|
|
1173
|
+
};
|
|
1174
|
+
/**
|
|
1175
|
+
* List conversation comments
|
|
1176
|
+
* List the comments in a conversation in reverse chronological order (newest first).
|
|
1177
|
+
*/
|
|
1178
|
+
export const listConversationComments = (options) => {
|
|
1179
|
+
return (options.client ?? _heyApiClient).get({
|
|
1180
|
+
security: [
|
|
1181
|
+
{
|
|
1182
|
+
scheme: 'bearer',
|
|
1183
|
+
type: 'http'
|
|
1184
|
+
}
|
|
1185
|
+
],
|
|
1186
|
+
url: '/conversations/{conversation_id}/comments',
|
|
1187
|
+
...options
|
|
1188
|
+
});
|
|
1189
|
+
};
|
|
1190
|
+
/**
|
|
1191
|
+
* Add comment
|
|
1192
|
+
* Add a comment to a [conversation](https://dev.frontapp.com/reference/conversations). If you want to create a new comment-only conversation, use the [Create discussion conversation](https://dev.frontapp.com/reference/create-conversation) endpoint.
|
|
1193
|
+
*/
|
|
1194
|
+
export const addComment = (options) => {
|
|
1195
|
+
return (options.client ?? _heyApiClient).post({
|
|
1196
|
+
security: [
|
|
1197
|
+
{
|
|
1198
|
+
scheme: 'bearer',
|
|
1199
|
+
type: 'http'
|
|
1200
|
+
}
|
|
1201
|
+
],
|
|
1202
|
+
url: '/conversations/{conversation_id}/comments',
|
|
1203
|
+
...options,
|
|
1204
|
+
headers: {
|
|
1205
|
+
'Content-Type': 'application/json',
|
|
1206
|
+
...options.headers
|
|
1207
|
+
}
|
|
1208
|
+
});
|
|
1209
|
+
};
|
|
1210
|
+
/**
|
|
1211
|
+
* List conversation drafts
|
|
1212
|
+
* List the drafts in a conversation.
|
|
1213
|
+
*/
|
|
1214
|
+
export const listConversationDrafts = (options) => {
|
|
1215
|
+
return (options.client ?? _heyApiClient).get({
|
|
1216
|
+
security: [
|
|
1217
|
+
{
|
|
1218
|
+
scheme: 'bearer',
|
|
1219
|
+
type: 'http'
|
|
1220
|
+
}
|
|
1221
|
+
],
|
|
1222
|
+
url: '/conversations/{conversation_id}/drafts',
|
|
1223
|
+
...options
|
|
1224
|
+
});
|
|
1225
|
+
};
|
|
1226
|
+
/**
|
|
1227
|
+
* Create draft reply
|
|
1228
|
+
* Create a new draft as a reply to the last message in the conversation.
|
|
1229
|
+
*/
|
|
1230
|
+
export const createDraftReply = (options) => {
|
|
1231
|
+
return (options.client ?? _heyApiClient).post({
|
|
1232
|
+
security: [
|
|
1233
|
+
{
|
|
1234
|
+
scheme: 'bearer',
|
|
1235
|
+
type: 'http'
|
|
1236
|
+
}
|
|
1237
|
+
],
|
|
1238
|
+
url: '/conversations/{conversation_id}/drafts',
|
|
1239
|
+
...options,
|
|
1240
|
+
headers: {
|
|
1241
|
+
'Content-Type': 'application/json',
|
|
1242
|
+
...options.headers
|
|
1243
|
+
}
|
|
1244
|
+
});
|
|
1245
|
+
};
|
|
1246
|
+
/**
|
|
1247
|
+
* List conversation events
|
|
1248
|
+
* List the events that occured for a conversation in reverse chronological order (newest first). The order will respect your company's [bump settings](https://help.front.com/t/y729th/customize-when-conversations-bump-up), which determine when conversations bump to the top.
|
|
1249
|
+
*/
|
|
1250
|
+
export const listConversationEvents = (options) => {
|
|
1251
|
+
return (options.client ?? _heyApiClient).get({
|
|
1252
|
+
security: [
|
|
1253
|
+
{
|
|
1254
|
+
scheme: 'bearer',
|
|
1255
|
+
type: 'http'
|
|
1256
|
+
}
|
|
1257
|
+
],
|
|
1258
|
+
url: '/conversations/{conversation_id}/events',
|
|
1259
|
+
...options
|
|
1260
|
+
});
|
|
1261
|
+
};
|
|
1262
|
+
/**
|
|
1263
|
+
* Delete conversation followers
|
|
1264
|
+
* Removes teammates from the list of followers of a conversation.
|
|
1265
|
+
*/
|
|
1266
|
+
export const deleteConversationFollowers = (options) => {
|
|
1267
|
+
return (options.client ?? _heyApiClient).delete({
|
|
1268
|
+
security: [
|
|
1269
|
+
{
|
|
1270
|
+
scheme: 'bearer',
|
|
1271
|
+
type: 'http'
|
|
1272
|
+
}
|
|
1273
|
+
],
|
|
1274
|
+
url: '/conversations/{conversation_id}/followers',
|
|
1275
|
+
...options,
|
|
1276
|
+
headers: {
|
|
1277
|
+
'Content-Type': 'application/json',
|
|
1278
|
+
...options.headers
|
|
1279
|
+
}
|
|
1280
|
+
});
|
|
1281
|
+
};
|
|
1282
|
+
/**
|
|
1283
|
+
* List conversation followers
|
|
1284
|
+
* List the teammates following a conversation.
|
|
1285
|
+
*/
|
|
1286
|
+
export const listConversationFollowers = (options) => {
|
|
1287
|
+
return (options.client ?? _heyApiClient).get({
|
|
1288
|
+
security: [
|
|
1289
|
+
{
|
|
1290
|
+
scheme: 'bearer',
|
|
1291
|
+
type: 'http'
|
|
1292
|
+
}
|
|
1293
|
+
],
|
|
1294
|
+
url: '/conversations/{conversation_id}/followers',
|
|
1295
|
+
...options
|
|
1296
|
+
});
|
|
1297
|
+
};
|
|
1298
|
+
/**
|
|
1299
|
+
* Add conversation followers
|
|
1300
|
+
* Adds teammates to the list of followers of a conversation.
|
|
1301
|
+
*/
|
|
1302
|
+
export const addConversationFollowers = (options) => {
|
|
1303
|
+
return (options.client ?? _heyApiClient).post({
|
|
1304
|
+
security: [
|
|
1305
|
+
{
|
|
1306
|
+
scheme: 'bearer',
|
|
1307
|
+
type: 'http'
|
|
1308
|
+
}
|
|
1309
|
+
],
|
|
1310
|
+
url: '/conversations/{conversation_id}/followers',
|
|
1311
|
+
...options,
|
|
1312
|
+
headers: {
|
|
1313
|
+
'Content-Type': 'application/json',
|
|
1314
|
+
...options.headers
|
|
1315
|
+
}
|
|
1316
|
+
});
|
|
1317
|
+
};
|
|
1318
|
+
/**
|
|
1319
|
+
* List conversation inboxes
|
|
1320
|
+
* List the inboxes in which a conversation is listed.
|
|
1321
|
+
*/
|
|
1322
|
+
export const listConversationInboxes = (options) => {
|
|
1323
|
+
return (options.client ?? _heyApiClient).get({
|
|
1324
|
+
security: [
|
|
1325
|
+
{
|
|
1326
|
+
scheme: 'bearer',
|
|
1327
|
+
type: 'http'
|
|
1328
|
+
}
|
|
1329
|
+
],
|
|
1330
|
+
url: '/conversations/{conversation_id}/inboxes',
|
|
1331
|
+
...options
|
|
1332
|
+
});
|
|
1333
|
+
};
|
|
1334
|
+
/**
|
|
1335
|
+
* Remove conversation links
|
|
1336
|
+
* Removes one or more links to a conversation.
|
|
1337
|
+
* For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.
|
|
1338
|
+
*
|
|
1339
|
+
*/
|
|
1340
|
+
export const removeConversationLinks = (options) => {
|
|
1341
|
+
return (options.client ?? _heyApiClient).delete({
|
|
1342
|
+
security: [
|
|
1343
|
+
{
|
|
1344
|
+
scheme: 'bearer',
|
|
1345
|
+
type: 'http'
|
|
1346
|
+
}
|
|
1347
|
+
],
|
|
1348
|
+
url: '/conversations/{conversation_id}/links',
|
|
1349
|
+
...options,
|
|
1350
|
+
headers: {
|
|
1351
|
+
'Content-Type': 'application/json',
|
|
1352
|
+
...options.headers
|
|
1353
|
+
}
|
|
1354
|
+
});
|
|
1355
|
+
};
|
|
1356
|
+
/**
|
|
1357
|
+
* Add conversation link
|
|
1358
|
+
* Adds one or more links to a conversation
|
|
1359
|
+
* For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.
|
|
1360
|
+
*
|
|
1361
|
+
*/
|
|
1362
|
+
export const addConversationLink = (options) => {
|
|
1363
|
+
return (options.client ?? _heyApiClient).post({
|
|
1364
|
+
security: [
|
|
1365
|
+
{
|
|
1366
|
+
scheme: 'bearer',
|
|
1367
|
+
type: 'http'
|
|
1368
|
+
}
|
|
1369
|
+
],
|
|
1370
|
+
url: '/conversations/{conversation_id}/links',
|
|
1371
|
+
...options,
|
|
1372
|
+
headers: {
|
|
1373
|
+
'Content-Type': 'application/json',
|
|
1374
|
+
...options.headers
|
|
1375
|
+
}
|
|
1376
|
+
});
|
|
1377
|
+
};
|
|
1378
|
+
/**
|
|
1379
|
+
* List conversation messages
|
|
1380
|
+
* List the messages in a conversation in reverse chronological order (newest first).
|
|
1381
|
+
*/
|
|
1382
|
+
export const listConversationMessages = (options) => {
|
|
1383
|
+
return (options.client ?? _heyApiClient).get({
|
|
1384
|
+
security: [
|
|
1385
|
+
{
|
|
1386
|
+
scheme: 'bearer',
|
|
1387
|
+
type: 'http'
|
|
1388
|
+
}
|
|
1389
|
+
],
|
|
1390
|
+
url: '/conversations/{conversation_id}/messages',
|
|
1391
|
+
...options
|
|
1392
|
+
});
|
|
1393
|
+
};
|
|
1394
|
+
/**
|
|
1395
|
+
* Create message reply
|
|
1396
|
+
* Reply to a conversation by sending a message and appending it to the conversation.
|
|
1397
|
+
*/
|
|
1398
|
+
export const createMessageReply = (options) => {
|
|
1399
|
+
return (options.client ?? _heyApiClient).post({
|
|
1400
|
+
security: [
|
|
1401
|
+
{
|
|
1402
|
+
scheme: 'bearer',
|
|
1403
|
+
type: 'http'
|
|
1404
|
+
}
|
|
1405
|
+
],
|
|
1406
|
+
url: '/conversations/{conversation_id}/messages',
|
|
1407
|
+
...options,
|
|
1408
|
+
headers: {
|
|
1409
|
+
'Content-Type': 'application/json',
|
|
1410
|
+
...options.headers
|
|
1411
|
+
}
|
|
1412
|
+
});
|
|
1413
|
+
};
|
|
1414
|
+
/**
|
|
1415
|
+
* Update conversation reminders
|
|
1416
|
+
* Snooze or unsnooze a conversation for the provided user.
|
|
1417
|
+
* For private conversations, reminders can only be created and edited through the API for teammates that own the conversation.
|
|
1418
|
+
* For shared conversations, reminders created and edited through the API are shared for all teammates within the shared inbox(es) that the conversation belongs to.
|
|
1419
|
+
*
|
|
1420
|
+
*/
|
|
1421
|
+
export const updateConversationReminders = (options) => {
|
|
1422
|
+
return (options.client ?? _heyApiClient).patch({
|
|
1423
|
+
security: [
|
|
1424
|
+
{
|
|
1425
|
+
scheme: 'bearer',
|
|
1426
|
+
type: 'http'
|
|
1427
|
+
}
|
|
1428
|
+
],
|
|
1429
|
+
url: '/conversations/{conversation_id}/reminders',
|
|
1430
|
+
...options,
|
|
1431
|
+
headers: {
|
|
1432
|
+
'Content-Type': 'application/json',
|
|
1433
|
+
...options.headers
|
|
1434
|
+
}
|
|
1435
|
+
});
|
|
1436
|
+
};
|
|
1437
|
+
/**
|
|
1438
|
+
* Remove conversation tag
|
|
1439
|
+
* Removes one or more tags to a conversation
|
|
1440
|
+
*/
|
|
1441
|
+
export const removeConversationTag = (options) => {
|
|
1442
|
+
return (options.client ?? _heyApiClient).delete({
|
|
1443
|
+
security: [
|
|
1444
|
+
{
|
|
1445
|
+
scheme: 'bearer',
|
|
1446
|
+
type: 'http'
|
|
1447
|
+
}
|
|
1448
|
+
],
|
|
1449
|
+
url: '/conversations/{conversation_id}/tags',
|
|
1450
|
+
...options,
|
|
1451
|
+
headers: {
|
|
1452
|
+
'Content-Type': 'application/json',
|
|
1453
|
+
...options.headers
|
|
1454
|
+
}
|
|
1455
|
+
});
|
|
1456
|
+
};
|
|
1457
|
+
/**
|
|
1458
|
+
* Add conversation tag
|
|
1459
|
+
* Adds one or more tags to a conversation
|
|
1460
|
+
*/
|
|
1461
|
+
export const addConversationTag = (options) => {
|
|
1462
|
+
return (options.client ?? _heyApiClient).post({
|
|
1463
|
+
security: [
|
|
1464
|
+
{
|
|
1465
|
+
scheme: 'bearer',
|
|
1466
|
+
type: 'http'
|
|
1467
|
+
}
|
|
1468
|
+
],
|
|
1469
|
+
url: '/conversations/{conversation_id}/tags',
|
|
1470
|
+
...options,
|
|
1471
|
+
headers: {
|
|
1472
|
+
'Content-Type': 'application/json',
|
|
1473
|
+
...options.headers
|
|
1474
|
+
}
|
|
1475
|
+
});
|
|
1476
|
+
};
|
|
1477
|
+
/**
|
|
1478
|
+
* List Contact's custom fields
|
|
1479
|
+
* Lists the custom fields that can be attached to a Contact.
|
|
1480
|
+
*
|
|
1481
|
+
* > ⚠️ Deprecated endpoint
|
|
1482
|
+
* >
|
|
1483
|
+
* > This endpoint has been deprecated. Please use the fully compatible `GET /contacts/custom_fields` endpoint instead.
|
|
1484
|
+
*
|
|
1485
|
+
* @deprecated
|
|
1486
|
+
*/
|
|
1487
|
+
export const listCustomFields = (options) => {
|
|
1488
|
+
return (options?.client ?? _heyApiClient).get({
|
|
1489
|
+
security: [
|
|
1490
|
+
{
|
|
1491
|
+
scheme: 'bearer',
|
|
1492
|
+
type: 'http'
|
|
1493
|
+
}
|
|
1494
|
+
],
|
|
1495
|
+
url: '/custom_fields',
|
|
1496
|
+
...options
|
|
1497
|
+
});
|
|
1498
|
+
};
|
|
1499
|
+
/**
|
|
1500
|
+
* Download attachment
|
|
1501
|
+
* Download an attachment file.
|
|
1502
|
+
*/
|
|
1503
|
+
export const downloadAttachment = (options) => {
|
|
1504
|
+
return (options.client ?? _heyApiClient).get({
|
|
1505
|
+
security: [
|
|
1506
|
+
{
|
|
1507
|
+
scheme: 'bearer',
|
|
1508
|
+
type: 'http'
|
|
1509
|
+
}
|
|
1510
|
+
],
|
|
1511
|
+
url: '/download/{attachment_link_id}',
|
|
1512
|
+
...options
|
|
1513
|
+
});
|
|
1514
|
+
};
|
|
1515
|
+
/**
|
|
1516
|
+
* Delete draft
|
|
1517
|
+
* Delete a draft message.
|
|
1518
|
+
*/
|
|
1519
|
+
export const deleteDraft = (options) => {
|
|
1520
|
+
return (options.client ?? _heyApiClient).delete({
|
|
1521
|
+
security: [
|
|
1522
|
+
{
|
|
1523
|
+
scheme: 'bearer',
|
|
1524
|
+
type: 'http'
|
|
1525
|
+
}
|
|
1526
|
+
],
|
|
1527
|
+
url: '/drafts/{draft_id}',
|
|
1528
|
+
...options,
|
|
1529
|
+
headers: {
|
|
1530
|
+
'Content-Type': 'application/json',
|
|
1531
|
+
...options.headers
|
|
1532
|
+
}
|
|
1533
|
+
});
|
|
1534
|
+
};
|
|
1535
|
+
/**
|
|
1536
|
+
* Edit draft
|
|
1537
|
+
* Edit a draft message.
|
|
1538
|
+
*/
|
|
1539
|
+
export const editDraft = (options) => {
|
|
1540
|
+
return (options.client ?? _heyApiClient).patch({
|
|
1541
|
+
security: [
|
|
1542
|
+
{
|
|
1543
|
+
scheme: 'bearer',
|
|
1544
|
+
type: 'http'
|
|
1545
|
+
}
|
|
1546
|
+
],
|
|
1547
|
+
url: '/drafts/{message_id}/',
|
|
1548
|
+
...options,
|
|
1549
|
+
headers: {
|
|
1550
|
+
'Content-Type': 'application/json',
|
|
1551
|
+
...options.headers
|
|
1552
|
+
}
|
|
1553
|
+
});
|
|
1554
|
+
};
|
|
1555
|
+
/**
|
|
1556
|
+
* List events
|
|
1557
|
+
* Lists all the detailed events which occurred in the inboxes of the company ordered in reverse chronological order (newest first).
|
|
1558
|
+
* Refer to the [Events](https://dev.frontapp.com/reference/events) topic for more information, including sorting and filtering.
|
|
1559
|
+
*
|
|
1560
|
+
*/
|
|
1561
|
+
export const listEvents = (options) => {
|
|
1562
|
+
return (options?.client ?? _heyApiClient).get({
|
|
1563
|
+
security: [
|
|
1564
|
+
{
|
|
1565
|
+
scheme: 'bearer',
|
|
1566
|
+
type: 'http'
|
|
1567
|
+
}
|
|
1568
|
+
],
|
|
1569
|
+
url: '/events',
|
|
1570
|
+
...options
|
|
1571
|
+
});
|
|
1572
|
+
};
|
|
1573
|
+
/**
|
|
1574
|
+
* Get event
|
|
1575
|
+
* Fetch an event.
|
|
1576
|
+
* Refer to the [Events](https://dev.frontapp.com/reference/events) topic for more information, including sorting and filtering.
|
|
1577
|
+
*
|
|
1578
|
+
*/
|
|
1579
|
+
export const getEvent = (options) => {
|
|
1580
|
+
return (options.client ?? _heyApiClient).get({
|
|
1581
|
+
security: [
|
|
1582
|
+
{
|
|
1583
|
+
scheme: 'bearer',
|
|
1584
|
+
type: 'http'
|
|
1585
|
+
}
|
|
1586
|
+
],
|
|
1587
|
+
url: '/events/{event_id}',
|
|
1588
|
+
...options
|
|
1589
|
+
});
|
|
1590
|
+
};
|
|
1591
|
+
/**
|
|
1592
|
+
* List inboxes
|
|
1593
|
+
* List the inboxes of the company.
|
|
1594
|
+
*/
|
|
1595
|
+
export const listInboxes = (options) => {
|
|
1596
|
+
return (options?.client ?? _heyApiClient).get({
|
|
1597
|
+
security: [
|
|
1598
|
+
{
|
|
1599
|
+
scheme: 'bearer',
|
|
1600
|
+
type: 'http'
|
|
1601
|
+
}
|
|
1602
|
+
],
|
|
1603
|
+
url: '/inboxes',
|
|
1604
|
+
...options
|
|
1605
|
+
});
|
|
1606
|
+
};
|
|
1607
|
+
/**
|
|
1608
|
+
* Create inbox
|
|
1609
|
+
* Create an inbox in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team inbox](https://dev.frontapp.com/reference/create-team-inbox) endpoint instead.
|
|
1610
|
+
*/
|
|
1611
|
+
export const createInbox = (options) => {
|
|
1612
|
+
return (options?.client ?? _heyApiClient).post({
|
|
1613
|
+
security: [
|
|
1614
|
+
{
|
|
1615
|
+
scheme: 'bearer',
|
|
1616
|
+
type: 'http'
|
|
1617
|
+
}
|
|
1618
|
+
],
|
|
1619
|
+
url: '/inboxes',
|
|
1620
|
+
...options,
|
|
1621
|
+
headers: {
|
|
1622
|
+
'Content-Type': 'application/json',
|
|
1623
|
+
...options?.headers
|
|
1624
|
+
}
|
|
1625
|
+
});
|
|
1626
|
+
};
|
|
1627
|
+
/**
|
|
1628
|
+
* List Inbox's custom fields
|
|
1629
|
+
* Lists the custom fields that can be attached to an Inbox.
|
|
1630
|
+
*/
|
|
1631
|
+
export const listInboxCustomFields = (options) => {
|
|
1632
|
+
return (options?.client ?? _heyApiClient).get({
|
|
1633
|
+
security: [
|
|
1634
|
+
{
|
|
1635
|
+
scheme: 'bearer',
|
|
1636
|
+
type: 'http'
|
|
1637
|
+
}
|
|
1638
|
+
],
|
|
1639
|
+
url: '/inboxes/custom_fields',
|
|
1640
|
+
...options
|
|
1641
|
+
});
|
|
1642
|
+
};
|
|
1643
|
+
/**
|
|
1644
|
+
* Get inbox
|
|
1645
|
+
* Fetch an inbox.
|
|
1646
|
+
*/
|
|
1647
|
+
export const getInbox = (options) => {
|
|
1648
|
+
return (options.client ?? _heyApiClient).get({
|
|
1649
|
+
security: [
|
|
1650
|
+
{
|
|
1651
|
+
scheme: 'bearer',
|
|
1652
|
+
type: 'http'
|
|
1653
|
+
}
|
|
1654
|
+
],
|
|
1655
|
+
url: '/inboxes/{inbox_id}',
|
|
1656
|
+
...options
|
|
1657
|
+
});
|
|
1658
|
+
};
|
|
1659
|
+
/**
|
|
1660
|
+
* List inbox channels
|
|
1661
|
+
* List the channels in an inbox.
|
|
1662
|
+
*/
|
|
1663
|
+
export const listInboxChannels = (options) => {
|
|
1664
|
+
return (options.client ?? _heyApiClient).get({
|
|
1665
|
+
security: [
|
|
1666
|
+
{
|
|
1667
|
+
scheme: 'bearer',
|
|
1668
|
+
type: 'http'
|
|
1669
|
+
}
|
|
1670
|
+
],
|
|
1671
|
+
url: '/inboxes/{inbox_id}/channels',
|
|
1672
|
+
...options
|
|
1673
|
+
});
|
|
1674
|
+
};
|
|
1675
|
+
/**
|
|
1676
|
+
* Create a channel
|
|
1677
|
+
* Create a channel in an inbox.
|
|
1678
|
+
*/
|
|
1679
|
+
export const createAChannel = (options) => {
|
|
1680
|
+
return (options.client ?? _heyApiClient).post({
|
|
1681
|
+
security: [
|
|
1682
|
+
{
|
|
1683
|
+
scheme: 'bearer',
|
|
1684
|
+
type: 'http'
|
|
1685
|
+
}
|
|
1686
|
+
],
|
|
1687
|
+
url: '/inboxes/{inbox_id}/channels',
|
|
1688
|
+
...options,
|
|
1689
|
+
headers: {
|
|
1690
|
+
'Content-Type': 'application/json',
|
|
1691
|
+
...options.headers
|
|
1692
|
+
}
|
|
1693
|
+
});
|
|
1694
|
+
};
|
|
1695
|
+
/**
|
|
1696
|
+
* List inbox conversations
|
|
1697
|
+
* List the conversations in an inbox. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
|
|
1698
|
+
*
|
|
1699
|
+
*/
|
|
1700
|
+
export const listInboxConversations = (options) => {
|
|
1701
|
+
return (options.client ?? _heyApiClient).get({
|
|
1702
|
+
security: [
|
|
1703
|
+
{
|
|
1704
|
+
scheme: 'bearer',
|
|
1705
|
+
type: 'http'
|
|
1706
|
+
}
|
|
1707
|
+
],
|
|
1708
|
+
url: '/inboxes/{inbox_id}/conversations',
|
|
1709
|
+
...options
|
|
1710
|
+
});
|
|
1711
|
+
};
|
|
1712
|
+
/**
|
|
1713
|
+
* Import message
|
|
1714
|
+
* Import a new message in an inbox. **Only use this endpoint to import historical, non-active conversations**. Do not use it to create messages for new conversations.
|
|
1715
|
+
*/
|
|
1716
|
+
export const importInboxMessage = (options) => {
|
|
1717
|
+
return (options.client ?? _heyApiClient).post({
|
|
1718
|
+
security: [
|
|
1719
|
+
{
|
|
1720
|
+
scheme: 'bearer',
|
|
1721
|
+
type: 'http'
|
|
1722
|
+
}
|
|
1723
|
+
],
|
|
1724
|
+
url: '/inboxes/{inbox_id}/imported_messages',
|
|
1725
|
+
...options,
|
|
1726
|
+
headers: {
|
|
1727
|
+
'Content-Type': 'application/json',
|
|
1728
|
+
...options.headers
|
|
1729
|
+
}
|
|
1730
|
+
});
|
|
1731
|
+
};
|
|
1732
|
+
/**
|
|
1733
|
+
* Removes inbox access
|
|
1734
|
+
* Remove access of one or more teammates from an inbox.
|
|
1735
|
+
*/
|
|
1736
|
+
export const removesInboxAccess = (options) => {
|
|
1737
|
+
return (options.client ?? _heyApiClient).delete({
|
|
1738
|
+
security: [
|
|
1739
|
+
{
|
|
1740
|
+
scheme: 'bearer',
|
|
1741
|
+
type: 'http'
|
|
1742
|
+
}
|
|
1743
|
+
],
|
|
1744
|
+
url: '/inboxes/{inbox_id}/teammates',
|
|
1745
|
+
...options,
|
|
1746
|
+
headers: {
|
|
1747
|
+
'Content-Type': 'application/json',
|
|
1748
|
+
...options.headers
|
|
1749
|
+
}
|
|
1750
|
+
});
|
|
1751
|
+
};
|
|
1752
|
+
/**
|
|
1753
|
+
* List inbox access
|
|
1754
|
+
* List the teammates with access to an inbox.
|
|
1755
|
+
*/
|
|
1756
|
+
export const listInboxAccess = (options) => {
|
|
1757
|
+
return (options.client ?? _heyApiClient).get({
|
|
1758
|
+
security: [
|
|
1759
|
+
{
|
|
1760
|
+
scheme: 'bearer',
|
|
1761
|
+
type: 'http'
|
|
1762
|
+
}
|
|
1763
|
+
],
|
|
1764
|
+
url: '/inboxes/{inbox_id}/teammates',
|
|
1765
|
+
...options
|
|
1766
|
+
});
|
|
1767
|
+
};
|
|
1768
|
+
/**
|
|
1769
|
+
* Add inbox access
|
|
1770
|
+
* Give access to one or more teammates to an inbox.
|
|
1771
|
+
*/
|
|
1772
|
+
export const addInboxAccess = (options) => {
|
|
1773
|
+
return (options.client ?? _heyApiClient).post({
|
|
1774
|
+
security: [
|
|
1775
|
+
{
|
|
1776
|
+
scheme: 'bearer',
|
|
1777
|
+
type: 'http'
|
|
1778
|
+
}
|
|
1779
|
+
],
|
|
1780
|
+
url: '/inboxes/{inbox_id}/teammates',
|
|
1781
|
+
...options,
|
|
1782
|
+
headers: {
|
|
1783
|
+
'Content-Type': 'application/json',
|
|
1784
|
+
...options.headers
|
|
1785
|
+
}
|
|
1786
|
+
});
|
|
1787
|
+
};
|
|
1788
|
+
/**
|
|
1789
|
+
* Delete an article
|
|
1790
|
+
* Deletes an article and all its content and translations.
|
|
1791
|
+
*/
|
|
1792
|
+
export const deleteAnArticle = (options) => {
|
|
1793
|
+
return (options.client ?? _heyApiClient).delete({
|
|
1794
|
+
security: [
|
|
1795
|
+
{
|
|
1796
|
+
scheme: 'bearer',
|
|
1797
|
+
type: 'http'
|
|
1798
|
+
}
|
|
1799
|
+
],
|
|
1800
|
+
url: '/knowledge_base_articles/{article_id}',
|
|
1801
|
+
...options
|
|
1802
|
+
});
|
|
1803
|
+
};
|
|
1804
|
+
/**
|
|
1805
|
+
* Get a knowledge base article
|
|
1806
|
+
* Fetches a knowledge base article.
|
|
1807
|
+
*/
|
|
1808
|
+
export const getAKnowledgeBaseArticle = (options) => {
|
|
1809
|
+
return (options.client ?? _heyApiClient).get({
|
|
1810
|
+
security: [
|
|
1811
|
+
{
|
|
1812
|
+
scheme: 'bearer',
|
|
1813
|
+
type: 'http'
|
|
1814
|
+
}
|
|
1815
|
+
],
|
|
1816
|
+
url: '/knowledge_base_articles/{article_id}',
|
|
1817
|
+
...options
|
|
1818
|
+
});
|
|
1819
|
+
};
|
|
1820
|
+
/**
|
|
1821
|
+
* Get knowledge base article with content in default locale
|
|
1822
|
+
* Fetches a knowledge base article with content in the default locale.
|
|
1823
|
+
*/
|
|
1824
|
+
export const getKnowledgeBaseArticleWithContentInDefaultLocale = (options) => {
|
|
1825
|
+
return (options.client ?? _heyApiClient).get({
|
|
1826
|
+
security: [
|
|
1827
|
+
{
|
|
1828
|
+
scheme: 'bearer',
|
|
1829
|
+
type: 'http'
|
|
1830
|
+
}
|
|
1831
|
+
],
|
|
1832
|
+
url: '/knowledge_base_articles/{article_id}/content',
|
|
1833
|
+
...options
|
|
1834
|
+
});
|
|
1835
|
+
};
|
|
1836
|
+
/**
|
|
1837
|
+
* Update article content in default locale.
|
|
1838
|
+
* Updates an article's content in the default locale
|
|
1839
|
+
*/
|
|
1840
|
+
export const updateArticleContentInDefaultLocale = (options) => {
|
|
1841
|
+
return (options.client ?? _heyApiClient).patch({
|
|
1842
|
+
security: [
|
|
1843
|
+
{
|
|
1844
|
+
scheme: 'bearer',
|
|
1845
|
+
type: 'http'
|
|
1846
|
+
}
|
|
1847
|
+
],
|
|
1848
|
+
url: '/knowledge_base_articles/{article_id}/content',
|
|
1849
|
+
...options,
|
|
1850
|
+
headers: {
|
|
1851
|
+
'Content-Type': 'application/json',
|
|
1852
|
+
...options.headers
|
|
1853
|
+
}
|
|
1854
|
+
});
|
|
1855
|
+
};
|
|
1856
|
+
/**
|
|
1857
|
+
* Download attachment from an article
|
|
1858
|
+
* Downloads the attachment from an article.
|
|
1859
|
+
*/
|
|
1860
|
+
export const downloadAttachmentFromAnArticle = (options) => {
|
|
1861
|
+
return (options.client ?? _heyApiClient).get({
|
|
1862
|
+
security: [
|
|
1863
|
+
{
|
|
1864
|
+
scheme: 'bearer',
|
|
1865
|
+
type: 'http'
|
|
1866
|
+
}
|
|
1867
|
+
],
|
|
1868
|
+
url: '/knowledge_base_articles/{article_id}/download/{attachment_id}',
|
|
1869
|
+
...options
|
|
1870
|
+
});
|
|
1871
|
+
};
|
|
1872
|
+
/**
|
|
1873
|
+
* Get knowledge base article with content in specified locale
|
|
1874
|
+
* Fetches a knowledge base article with content for a given locale.
|
|
1875
|
+
*/
|
|
1876
|
+
export const getKnowledgeBaseArticleWithContentInSpecifiedLocale = (options) => {
|
|
1877
|
+
return (options.client ?? _heyApiClient).get({
|
|
1878
|
+
security: [
|
|
1879
|
+
{
|
|
1880
|
+
scheme: 'bearer',
|
|
1881
|
+
type: 'http'
|
|
1882
|
+
}
|
|
1883
|
+
],
|
|
1884
|
+
url: '/knowledge_base_articles/{article_id}/locales/{locale}/content',
|
|
1885
|
+
...options
|
|
1886
|
+
});
|
|
1887
|
+
};
|
|
1888
|
+
/**
|
|
1889
|
+
* Update article content in specified locale
|
|
1890
|
+
* Updates an article's content for a given locale.
|
|
1891
|
+
*/
|
|
1892
|
+
export const updateArticleContentInSpecifiedLocale = (options) => {
|
|
1893
|
+
return (options.client ?? _heyApiClient).patch({
|
|
1894
|
+
security: [
|
|
1895
|
+
{
|
|
1896
|
+
scheme: 'bearer',
|
|
1897
|
+
type: 'http'
|
|
1898
|
+
}
|
|
1899
|
+
],
|
|
1900
|
+
url: '/knowledge_base_articles/{article_id}/locales/{locale}/content',
|
|
1901
|
+
...options,
|
|
1902
|
+
headers: {
|
|
1903
|
+
'Content-Type': 'application/json',
|
|
1904
|
+
...options.headers
|
|
1905
|
+
}
|
|
1906
|
+
});
|
|
1907
|
+
};
|
|
1908
|
+
/**
|
|
1909
|
+
* Delete a knowledge base category
|
|
1910
|
+
* Deletes a knowledge base category.
|
|
1911
|
+
*
|
|
1912
|
+
* > ⚠️ Warning
|
|
1913
|
+
* >
|
|
1914
|
+
* > When a category is deleted, all articles in the category are also deleted.
|
|
1915
|
+
*
|
|
1916
|
+
*/
|
|
1917
|
+
export const deleteAKnowledgeBaseCategory = (options) => {
|
|
1918
|
+
return (options.client ?? _heyApiClient).delete({
|
|
1919
|
+
security: [
|
|
1920
|
+
{
|
|
1921
|
+
scheme: 'bearer',
|
|
1922
|
+
type: 'http'
|
|
1923
|
+
}
|
|
1924
|
+
],
|
|
1925
|
+
url: '/knowledge_base_categories/{category_id}',
|
|
1926
|
+
...options
|
|
1927
|
+
});
|
|
1928
|
+
};
|
|
1929
|
+
/**
|
|
1930
|
+
* Get a knowledge base category
|
|
1931
|
+
* Fetches a knowledge base category.
|
|
1932
|
+
*/
|
|
1933
|
+
export const getAKnowledgeBaseCategory = (options) => {
|
|
1934
|
+
return (options.client ?? _heyApiClient).get({
|
|
1935
|
+
security: [
|
|
1936
|
+
{
|
|
1937
|
+
scheme: 'bearer',
|
|
1938
|
+
type: 'http'
|
|
1939
|
+
}
|
|
1940
|
+
],
|
|
1941
|
+
url: '/knowledge_base_categories/{category_id}',
|
|
1942
|
+
...options
|
|
1943
|
+
});
|
|
1944
|
+
};
|
|
1945
|
+
/**
|
|
1946
|
+
* List articles in a category
|
|
1947
|
+
* List articles in a category.
|
|
1948
|
+
*/
|
|
1949
|
+
export const listArticlesInACategory = (options) => {
|
|
1950
|
+
return (options.client ?? _heyApiClient).get({
|
|
1951
|
+
security: [
|
|
1952
|
+
{
|
|
1953
|
+
scheme: 'bearer',
|
|
1954
|
+
type: 'http'
|
|
1955
|
+
}
|
|
1956
|
+
],
|
|
1957
|
+
url: '/knowledge_base_categories/{category_id}/articles',
|
|
1958
|
+
...options
|
|
1959
|
+
});
|
|
1960
|
+
};
|
|
1961
|
+
/**
|
|
1962
|
+
* Get knowledge base category content in default locale
|
|
1963
|
+
* Fetches a knowledge base category with content in the default locale.
|
|
1964
|
+
*/
|
|
1965
|
+
export const getKnowledgeBaseCategoryContentInDefaultLocale = (options) => {
|
|
1966
|
+
return (options.client ?? _heyApiClient).get({
|
|
1967
|
+
security: [
|
|
1968
|
+
{
|
|
1969
|
+
scheme: 'bearer',
|
|
1970
|
+
type: 'http'
|
|
1971
|
+
}
|
|
1972
|
+
],
|
|
1973
|
+
url: '/knowledge_base_categories/{category_id}/content',
|
|
1974
|
+
...options
|
|
1975
|
+
});
|
|
1976
|
+
};
|
|
1977
|
+
/**
|
|
1978
|
+
* Update knowledge base category in default locale
|
|
1979
|
+
* Updates a knowledge base category in the default locale. Will republish the knowledge base if the knowledge base is currently published.
|
|
1980
|
+
*/
|
|
1981
|
+
export const updateKnowledgeBaseCategoryInDefaultLocale = (options) => {
|
|
1982
|
+
return (options.client ?? _heyApiClient).patch({
|
|
1983
|
+
security: [
|
|
1984
|
+
{
|
|
1985
|
+
scheme: 'bearer',
|
|
1986
|
+
type: 'http'
|
|
1987
|
+
}
|
|
1988
|
+
],
|
|
1989
|
+
url: '/knowledge_base_categories/{category_id}/content',
|
|
1990
|
+
...options,
|
|
1991
|
+
headers: {
|
|
1992
|
+
'Content-Type': 'application/json',
|
|
1993
|
+
...options.headers
|
|
1994
|
+
}
|
|
1995
|
+
});
|
|
1996
|
+
};
|
|
1997
|
+
/**
|
|
1998
|
+
* Get knowledge base category with content in specified locale
|
|
1999
|
+
* Fetches a knowledge base category with content for a given locale.
|
|
2000
|
+
*/
|
|
2001
|
+
export const getKnowledgeBaseCategoryWithContentInSpecifiedLocale = (options) => {
|
|
2002
|
+
return (options.client ?? _heyApiClient).get({
|
|
2003
|
+
security: [
|
|
2004
|
+
{
|
|
2005
|
+
scheme: 'bearer',
|
|
2006
|
+
type: 'http'
|
|
2007
|
+
}
|
|
2008
|
+
],
|
|
2009
|
+
url: '/knowledge_base_categories/{category_id}/locales/{locale}/content',
|
|
2010
|
+
...options
|
|
2011
|
+
});
|
|
2012
|
+
};
|
|
2013
|
+
/**
|
|
2014
|
+
* Update knowledge base category in specified locale
|
|
2015
|
+
* Updates a knowledge base category for a given locale. Will republish the knowledge base if the knowledge base is currently published.
|
|
2016
|
+
*/
|
|
2017
|
+
export const updateKnowledgeBaseCategoryInSpecifiedLocale = (options) => {
|
|
2018
|
+
return (options.client ?? _heyApiClient).patch({
|
|
2019
|
+
security: [
|
|
2020
|
+
{
|
|
2021
|
+
scheme: 'bearer',
|
|
2022
|
+
type: 'http'
|
|
2023
|
+
}
|
|
2024
|
+
],
|
|
2025
|
+
url: '/knowledge_base_categories/{category_id}/locales/{locale}/content',
|
|
2026
|
+
...options,
|
|
2027
|
+
headers: {
|
|
2028
|
+
'Content-Type': 'application/json',
|
|
2029
|
+
...options.headers
|
|
2030
|
+
}
|
|
2031
|
+
});
|
|
2032
|
+
};
|
|
2033
|
+
/**
|
|
2034
|
+
* List knowledge bases
|
|
2035
|
+
* List the knowledge bases of the company.
|
|
2036
|
+
*/
|
|
2037
|
+
export const listKnowledgeBases = (options) => {
|
|
2038
|
+
return (options?.client ?? _heyApiClient).get({
|
|
2039
|
+
security: [
|
|
2040
|
+
{
|
|
2041
|
+
scheme: 'bearer',
|
|
2042
|
+
type: 'http'
|
|
2043
|
+
}
|
|
2044
|
+
],
|
|
2045
|
+
url: '/knowledge_bases',
|
|
2046
|
+
...options
|
|
2047
|
+
});
|
|
2048
|
+
};
|
|
2049
|
+
/**
|
|
2050
|
+
* Create a knowledge base
|
|
2051
|
+
* Creates a knowledge base.
|
|
2052
|
+
*/
|
|
2053
|
+
export const createAKnowledgeBase = (options) => {
|
|
2054
|
+
return (options?.client ?? _heyApiClient).post({
|
|
2055
|
+
security: [
|
|
2056
|
+
{
|
|
2057
|
+
scheme: 'bearer',
|
|
2058
|
+
type: 'http'
|
|
2059
|
+
}
|
|
2060
|
+
],
|
|
2061
|
+
url: '/knowledge_bases',
|
|
2062
|
+
...options,
|
|
2063
|
+
headers: {
|
|
2064
|
+
'Content-Type': 'application/json',
|
|
2065
|
+
...options?.headers
|
|
2066
|
+
}
|
|
2067
|
+
});
|
|
2068
|
+
};
|
|
2069
|
+
/**
|
|
2070
|
+
* Get a knowledge base
|
|
2071
|
+
* Fetches a knowledge base.
|
|
2072
|
+
*/
|
|
2073
|
+
export const getAKnowledgeBase = (options) => {
|
|
2074
|
+
return (options.client ?? _heyApiClient).get({
|
|
2075
|
+
security: [
|
|
2076
|
+
{
|
|
2077
|
+
scheme: 'bearer',
|
|
2078
|
+
type: 'http'
|
|
2079
|
+
}
|
|
2080
|
+
],
|
|
2081
|
+
url: '/knowledge_bases/{knowledge_base_id}',
|
|
2082
|
+
...options
|
|
2083
|
+
});
|
|
2084
|
+
};
|
|
2085
|
+
/**
|
|
2086
|
+
* List articles in a knowledge base
|
|
2087
|
+
* List articles in a knowledge base
|
|
2088
|
+
*/
|
|
2089
|
+
export const listArticlesInAKnowledgeBase = (options) => {
|
|
2090
|
+
return (options.client ?? _heyApiClient).get({
|
|
2091
|
+
security: [
|
|
2092
|
+
{
|
|
2093
|
+
scheme: 'bearer',
|
|
2094
|
+
type: 'http'
|
|
2095
|
+
}
|
|
2096
|
+
],
|
|
2097
|
+
url: '/knowledge_bases/{knowledge_base_id}/articles',
|
|
2098
|
+
...options
|
|
2099
|
+
});
|
|
2100
|
+
};
|
|
2101
|
+
/**
|
|
2102
|
+
* Create article in a knowledge base in default locale
|
|
2103
|
+
* Creates an article in a knowledge base in the default locale.
|
|
2104
|
+
*/
|
|
2105
|
+
export const createArticleInAKnowledgeBaseInDefaultLocale = (options) => {
|
|
2106
|
+
return (options.client ?? _heyApiClient).post({
|
|
2107
|
+
security: [
|
|
2108
|
+
{
|
|
2109
|
+
scheme: 'bearer',
|
|
2110
|
+
type: 'http'
|
|
2111
|
+
}
|
|
2112
|
+
],
|
|
2113
|
+
url: '/knowledge_bases/{knowledge_base_id}/articles',
|
|
2114
|
+
...options,
|
|
2115
|
+
headers: {
|
|
2116
|
+
'Content-Type': 'application/json',
|
|
2117
|
+
...options.headers
|
|
2118
|
+
}
|
|
2119
|
+
});
|
|
2120
|
+
};
|
|
2121
|
+
/**
|
|
2122
|
+
* List categories in a knowledge base
|
|
2123
|
+
* List categories in a knowledge base.
|
|
2124
|
+
*/
|
|
2125
|
+
export const listCategoriesInAKnowledgeBase = (options) => {
|
|
2126
|
+
return (options.client ?? _heyApiClient).get({
|
|
2127
|
+
security: [
|
|
2128
|
+
{
|
|
2129
|
+
scheme: 'bearer',
|
|
2130
|
+
type: 'http'
|
|
2131
|
+
}
|
|
2132
|
+
],
|
|
2133
|
+
url: '/knowledge_bases/{knowledge_base_id}/categories',
|
|
2134
|
+
...options
|
|
2135
|
+
});
|
|
2136
|
+
};
|
|
2137
|
+
/**
|
|
2138
|
+
* Create knowledge base category in default locale
|
|
2139
|
+
* Creates a knowledge base category in the default locale.
|
|
2140
|
+
*/
|
|
2141
|
+
export const createKnowledgeBaseCategoryInDefaultLocale = (options) => {
|
|
2142
|
+
return (options.client ?? _heyApiClient).post({
|
|
2143
|
+
security: [
|
|
2144
|
+
{
|
|
2145
|
+
scheme: 'bearer',
|
|
2146
|
+
type: 'http'
|
|
2147
|
+
}
|
|
2148
|
+
],
|
|
2149
|
+
url: '/knowledge_bases/{knowledge_base_id}/categories',
|
|
2150
|
+
...options,
|
|
2151
|
+
headers: {
|
|
2152
|
+
'Content-Type': 'application/json',
|
|
2153
|
+
...options.headers
|
|
2154
|
+
}
|
|
2155
|
+
});
|
|
2156
|
+
};
|
|
2157
|
+
/**
|
|
2158
|
+
* Get a knowledge base with content in default locale
|
|
2159
|
+
* Fetches a knowledge base with its content in the default locale.
|
|
2160
|
+
*/
|
|
2161
|
+
export const getAKnowledgeBaseWithContentInDefaultLocale = (options) => {
|
|
2162
|
+
return (options.client ?? _heyApiClient).get({
|
|
2163
|
+
security: [
|
|
2164
|
+
{
|
|
2165
|
+
scheme: 'bearer',
|
|
2166
|
+
type: 'http'
|
|
2167
|
+
}
|
|
2168
|
+
],
|
|
2169
|
+
url: '/knowledge_bases/{knowledge_base_id}/content',
|
|
2170
|
+
...options
|
|
2171
|
+
});
|
|
2172
|
+
};
|
|
2173
|
+
/**
|
|
2174
|
+
* Update knowledge base in default locale
|
|
2175
|
+
* Updates a knowledge base in the default locale. Will republish the knowledge base if the knowledge base is currently published.
|
|
2176
|
+
*/
|
|
2177
|
+
export const updateKnowledgeBaseInDefaultLocale = (options) => {
|
|
2178
|
+
return (options.client ?? _heyApiClient).patch({
|
|
2179
|
+
security: [
|
|
2180
|
+
{
|
|
2181
|
+
scheme: 'bearer',
|
|
2182
|
+
type: 'http'
|
|
2183
|
+
}
|
|
2184
|
+
],
|
|
2185
|
+
url: '/knowledge_bases/{knowledge_base_id}/content',
|
|
2186
|
+
...options,
|
|
2187
|
+
headers: {
|
|
2188
|
+
'Content-Type': 'application/json',
|
|
2189
|
+
...options.headers
|
|
2190
|
+
}
|
|
2191
|
+
});
|
|
2192
|
+
};
|
|
2193
|
+
/**
|
|
2194
|
+
* Create article in a knowledge base in specified locale
|
|
2195
|
+
* Create an article for a given locale in a knowledge base.
|
|
2196
|
+
*/
|
|
2197
|
+
export const createArticleInAKnowledgeBaseInSpecifiedLocale = (options) => {
|
|
2198
|
+
return (options.client ?? _heyApiClient).post({
|
|
2199
|
+
security: [
|
|
2200
|
+
{
|
|
2201
|
+
scheme: 'bearer',
|
|
2202
|
+
type: 'http'
|
|
2203
|
+
}
|
|
2204
|
+
],
|
|
2205
|
+
url: '/knowledge_bases/{knowledge_base_id}/locales/{locale}/articles',
|
|
2206
|
+
...options,
|
|
2207
|
+
headers: {
|
|
2208
|
+
'Content-Type': 'application/json',
|
|
2209
|
+
...options.headers
|
|
2210
|
+
}
|
|
2211
|
+
});
|
|
2212
|
+
};
|
|
2213
|
+
/**
|
|
2214
|
+
* Create knowledge base category in specified locale
|
|
2215
|
+
* Creates a knowledge base category for a given locale.
|
|
2216
|
+
*/
|
|
2217
|
+
export const createKnowledgeBaseCategoryInSpecifiedLocale = (options) => {
|
|
2218
|
+
return (options.client ?? _heyApiClient).post({
|
|
2219
|
+
security: [
|
|
2220
|
+
{
|
|
2221
|
+
scheme: 'bearer',
|
|
2222
|
+
type: 'http'
|
|
2223
|
+
}
|
|
2224
|
+
],
|
|
2225
|
+
url: '/knowledge_bases/{knowledge_base_id}/locales/{locale}/categories',
|
|
2226
|
+
...options,
|
|
2227
|
+
headers: {
|
|
2228
|
+
'Content-Type': 'application/json',
|
|
2229
|
+
...options.headers
|
|
2230
|
+
}
|
|
2231
|
+
});
|
|
2232
|
+
};
|
|
2233
|
+
/**
|
|
2234
|
+
* Get a knowledge base with content in specified locale
|
|
2235
|
+
* Fetches a knowledge base with its content for a given locale.
|
|
2236
|
+
*/
|
|
2237
|
+
export const getAKnowledgeBaseWithContentInSpecifiedLocale = (options) => {
|
|
2238
|
+
return (options.client ?? _heyApiClient).get({
|
|
2239
|
+
security: [
|
|
2240
|
+
{
|
|
2241
|
+
scheme: 'bearer',
|
|
2242
|
+
type: 'http'
|
|
2243
|
+
}
|
|
2244
|
+
],
|
|
2245
|
+
url: '/knowledge_bases/{knowledge_base_id}/locales/{locale}/content',
|
|
2246
|
+
...options
|
|
2247
|
+
});
|
|
2248
|
+
};
|
|
2249
|
+
/**
|
|
2250
|
+
* Update knowledge base in specified locale
|
|
2251
|
+
* Updates a knowledge base for a given locale. Will republish the knowledge base if the knowledge base is currently published.
|
|
2252
|
+
*/
|
|
2253
|
+
export const updateKnowledgeBaseInSpecifiedLocale = (options) => {
|
|
2254
|
+
return (options.client ?? _heyApiClient).patch({
|
|
2255
|
+
security: [
|
|
2256
|
+
{
|
|
2257
|
+
scheme: 'bearer',
|
|
2258
|
+
type: 'http'
|
|
2259
|
+
}
|
|
2260
|
+
],
|
|
2261
|
+
url: '/knowledge_bases/{knowledge_base_id}/locales/{locale}/content',
|
|
2262
|
+
...options,
|
|
2263
|
+
headers: {
|
|
2264
|
+
'Content-Type': 'application/json',
|
|
2265
|
+
...options.headers
|
|
2266
|
+
}
|
|
2267
|
+
});
|
|
2268
|
+
};
|
|
2269
|
+
/**
|
|
2270
|
+
* List links
|
|
2271
|
+
* List the links of the company paginated by id. Allows filtering by link type via the q.types param.
|
|
2272
|
+
* These links include application objects; for more details, see the [Links](https://dev.frontapp.com/reference/links) topic.
|
|
2273
|
+
*
|
|
2274
|
+
*/
|
|
2275
|
+
export const listLinks = (options) => {
|
|
2276
|
+
return (options?.client ?? _heyApiClient).get({
|
|
2277
|
+
security: [
|
|
2278
|
+
{
|
|
2279
|
+
scheme: 'bearer',
|
|
2280
|
+
type: 'http'
|
|
2281
|
+
}
|
|
2282
|
+
],
|
|
2283
|
+
url: '/links',
|
|
2284
|
+
...options
|
|
2285
|
+
});
|
|
2286
|
+
};
|
|
2287
|
+
/**
|
|
2288
|
+
* Create link
|
|
2289
|
+
* Create a link. You must supply either `pattern` or `external_url` in the request, but not both (`pattern` is for application objects while `external_url` is for standard links). If `pattern` is provided, the API call updates the application objects matching the exact pattern. Keep in mind this endpoint only creates or updates an existing link from an application object. It does not create new application objects. If the link is resolved to an installed links integration, any name retrieved from the integration will override the provided name in the request.
|
|
2290
|
+
*/
|
|
2291
|
+
export const createLink = (options) => {
|
|
2292
|
+
return (options?.client ?? _heyApiClient).post({
|
|
2293
|
+
security: [
|
|
2294
|
+
{
|
|
2295
|
+
scheme: 'bearer',
|
|
2296
|
+
type: 'http'
|
|
2297
|
+
}
|
|
2298
|
+
],
|
|
2299
|
+
url: '/links',
|
|
2300
|
+
...options,
|
|
2301
|
+
headers: {
|
|
2302
|
+
'Content-Type': 'application/json',
|
|
2303
|
+
...options?.headers
|
|
2304
|
+
}
|
|
2305
|
+
});
|
|
2306
|
+
};
|
|
2307
|
+
/**
|
|
2308
|
+
* List Link's custom fields
|
|
2309
|
+
* Lists the custom fields that can be attached to a Link.
|
|
2310
|
+
* For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.
|
|
2311
|
+
*
|
|
2312
|
+
*/
|
|
2313
|
+
export const listLinkCustomFields = (options) => {
|
|
2314
|
+
return (options?.client ?? _heyApiClient).get({
|
|
2315
|
+
security: [
|
|
2316
|
+
{
|
|
2317
|
+
scheme: 'bearer',
|
|
2318
|
+
type: 'http'
|
|
2319
|
+
}
|
|
2320
|
+
],
|
|
2321
|
+
url: '/links/custom_fields',
|
|
2322
|
+
...options
|
|
2323
|
+
});
|
|
2324
|
+
};
|
|
2325
|
+
/**
|
|
2326
|
+
* Get link
|
|
2327
|
+
* Fetch a link.
|
|
2328
|
+
* For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.
|
|
2329
|
+
*
|
|
2330
|
+
*/
|
|
2331
|
+
export const getLink = (options) => {
|
|
2332
|
+
return (options.client ?? _heyApiClient).get({
|
|
2333
|
+
security: [
|
|
2334
|
+
{
|
|
2335
|
+
scheme: 'bearer',
|
|
2336
|
+
type: 'http'
|
|
2337
|
+
}
|
|
2338
|
+
],
|
|
2339
|
+
url: '/links/{link_id}',
|
|
2340
|
+
...options
|
|
2341
|
+
});
|
|
2342
|
+
};
|
|
2343
|
+
/**
|
|
2344
|
+
* Update a link
|
|
2345
|
+
* Update a link.
|
|
2346
|
+
* For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.
|
|
2347
|
+
*
|
|
2348
|
+
*/
|
|
2349
|
+
export const updateALink = (options) => {
|
|
2350
|
+
return (options.client ?? _heyApiClient).patch({
|
|
2351
|
+
security: [
|
|
2352
|
+
{
|
|
2353
|
+
scheme: 'bearer',
|
|
2354
|
+
type: 'http'
|
|
2355
|
+
}
|
|
2356
|
+
],
|
|
2357
|
+
url: '/links/{link_id}',
|
|
2358
|
+
...options,
|
|
2359
|
+
headers: {
|
|
2360
|
+
'Content-Type': 'application/json',
|
|
2361
|
+
...options.headers
|
|
2362
|
+
}
|
|
2363
|
+
});
|
|
2364
|
+
};
|
|
2365
|
+
/**
|
|
2366
|
+
* List link conversations
|
|
2367
|
+
* List the conversations linked to a specific link. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
|
|
2368
|
+
* For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.
|
|
2369
|
+
*
|
|
2370
|
+
*/
|
|
2371
|
+
export const listLinkConversations = (options) => {
|
|
2372
|
+
return (options.client ?? _heyApiClient).get({
|
|
2373
|
+
security: [
|
|
2374
|
+
{
|
|
2375
|
+
scheme: 'bearer',
|
|
2376
|
+
type: 'http'
|
|
2377
|
+
}
|
|
2378
|
+
],
|
|
2379
|
+
url: '/links/{link_id}/conversations',
|
|
2380
|
+
...options
|
|
2381
|
+
});
|
|
2382
|
+
};
|
|
2383
|
+
/**
|
|
2384
|
+
* API Token details
|
|
2385
|
+
* Fetch the details of the API token.
|
|
2386
|
+
*/
|
|
2387
|
+
export const apiTokenDetails = (options) => {
|
|
2388
|
+
return (options?.client ?? _heyApiClient).get({
|
|
2389
|
+
security: [
|
|
2390
|
+
{
|
|
2391
|
+
scheme: 'bearer',
|
|
2392
|
+
type: 'http'
|
|
2393
|
+
}
|
|
2394
|
+
],
|
|
2395
|
+
url: '/me',
|
|
2396
|
+
...options
|
|
2397
|
+
});
|
|
2398
|
+
};
|
|
2399
|
+
/**
|
|
2400
|
+
* List folders
|
|
2401
|
+
* List the message template folders.
|
|
2402
|
+
*/
|
|
2403
|
+
export const listFolders = (options) => {
|
|
2404
|
+
return (options?.client ?? _heyApiClient).get({
|
|
2405
|
+
security: [
|
|
2406
|
+
{
|
|
2407
|
+
scheme: 'bearer',
|
|
2408
|
+
type: 'http'
|
|
2409
|
+
}
|
|
2410
|
+
],
|
|
2411
|
+
url: '/message_template_folders',
|
|
2412
|
+
...options
|
|
2413
|
+
});
|
|
2414
|
+
};
|
|
2415
|
+
/**
|
|
2416
|
+
* Create folder
|
|
2417
|
+
* Create a new message template folder in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team folder](https://dev.frontapp.com/reference/create-team-folder) endpoint instead.
|
|
2418
|
+
*/
|
|
2419
|
+
export const createFolder = (options) => {
|
|
2420
|
+
return (options?.client ?? _heyApiClient).post({
|
|
2421
|
+
security: [
|
|
2422
|
+
{
|
|
2423
|
+
scheme: 'bearer',
|
|
2424
|
+
type: 'http'
|
|
2425
|
+
}
|
|
2426
|
+
],
|
|
2427
|
+
url: '/message_template_folders',
|
|
2428
|
+
...options,
|
|
2429
|
+
headers: {
|
|
2430
|
+
'Content-Type': 'application/json',
|
|
2431
|
+
...options?.headers
|
|
2432
|
+
}
|
|
2433
|
+
});
|
|
2434
|
+
};
|
|
2435
|
+
/**
|
|
2436
|
+
* Delete folder
|
|
2437
|
+
* Delete a message template folder and child folders/templates
|
|
2438
|
+
*/
|
|
2439
|
+
export const deleteFolder = (options) => {
|
|
2440
|
+
return (options.client ?? _heyApiClient).delete({
|
|
2441
|
+
security: [
|
|
2442
|
+
{
|
|
2443
|
+
scheme: 'bearer',
|
|
2444
|
+
type: 'http'
|
|
2445
|
+
}
|
|
2446
|
+
],
|
|
2447
|
+
url: '/message_template_folders/{message_template_folder_id}',
|
|
2448
|
+
...options
|
|
2449
|
+
});
|
|
2450
|
+
};
|
|
2451
|
+
/**
|
|
2452
|
+
* Get folder
|
|
2453
|
+
* Fetch a message template folder.
|
|
2454
|
+
*/
|
|
2455
|
+
export const getFolder = (options) => {
|
|
2456
|
+
return (options.client ?? _heyApiClient).get({
|
|
2457
|
+
security: [
|
|
2458
|
+
{
|
|
2459
|
+
scheme: 'bearer',
|
|
2460
|
+
type: 'http'
|
|
2461
|
+
}
|
|
2462
|
+
],
|
|
2463
|
+
url: '/message_template_folders/{message_template_folder_id}',
|
|
2464
|
+
...options
|
|
2465
|
+
});
|
|
2466
|
+
};
|
|
2467
|
+
/**
|
|
2468
|
+
* Update folder
|
|
2469
|
+
* Update message template folder
|
|
2470
|
+
*/
|
|
2471
|
+
export const updateFolder = (options) => {
|
|
2472
|
+
return (options.client ?? _heyApiClient).patch({
|
|
2473
|
+
security: [
|
|
2474
|
+
{
|
|
2475
|
+
scheme: 'bearer',
|
|
2476
|
+
type: 'http'
|
|
2477
|
+
}
|
|
2478
|
+
],
|
|
2479
|
+
url: '/message_template_folders/{message_template_folder_id}',
|
|
2480
|
+
...options,
|
|
2481
|
+
headers: {
|
|
2482
|
+
'Content-Type': 'application/json',
|
|
2483
|
+
...options.headers
|
|
2484
|
+
}
|
|
2485
|
+
});
|
|
2486
|
+
};
|
|
2487
|
+
/**
|
|
2488
|
+
* Get child folders
|
|
2489
|
+
* Fetch the child message templates folders of a message template folder.
|
|
2490
|
+
*/
|
|
2491
|
+
export const getChildFolders = (options) => {
|
|
2492
|
+
return (options.client ?? _heyApiClient).get({
|
|
2493
|
+
security: [
|
|
2494
|
+
{
|
|
2495
|
+
scheme: 'bearer',
|
|
2496
|
+
type: 'http'
|
|
2497
|
+
}
|
|
2498
|
+
],
|
|
2499
|
+
url: '/message_template_folders/{message_template_folder_id}/message_template_folders',
|
|
2500
|
+
...options
|
|
2501
|
+
});
|
|
2502
|
+
};
|
|
2503
|
+
/**
|
|
2504
|
+
* Create child folder
|
|
2505
|
+
* Create a new message template folder as a child of the given folder
|
|
2506
|
+
*/
|
|
2507
|
+
export const createChildFolder = (options) => {
|
|
2508
|
+
return (options.client ?? _heyApiClient).post({
|
|
2509
|
+
security: [
|
|
2510
|
+
{
|
|
2511
|
+
scheme: 'bearer',
|
|
2512
|
+
type: 'http'
|
|
2513
|
+
}
|
|
2514
|
+
],
|
|
2515
|
+
url: '/message_template_folders/{message_template_folder_id}/message_template_folders',
|
|
2516
|
+
...options,
|
|
2517
|
+
headers: {
|
|
2518
|
+
'Content-Type': 'application/json',
|
|
2519
|
+
...options.headers
|
|
2520
|
+
}
|
|
2521
|
+
});
|
|
2522
|
+
};
|
|
2523
|
+
/**
|
|
2524
|
+
* Get child templates
|
|
2525
|
+
* Fetch the child message templates of a message template folder.
|
|
2526
|
+
*/
|
|
2527
|
+
export const getChildTemplates = (options) => {
|
|
2528
|
+
return (options.client ?? _heyApiClient).get({
|
|
2529
|
+
security: [
|
|
2530
|
+
{
|
|
2531
|
+
scheme: 'bearer',
|
|
2532
|
+
type: 'http'
|
|
2533
|
+
}
|
|
2534
|
+
],
|
|
2535
|
+
url: '/message_template_folders/{message_template_folder_id}/message_templates',
|
|
2536
|
+
...options
|
|
2537
|
+
});
|
|
2538
|
+
};
|
|
2539
|
+
/**
|
|
2540
|
+
* Create child template
|
|
2541
|
+
* Create a new message template as a child of the given folder
|
|
2542
|
+
*/
|
|
2543
|
+
export const createChildTemplate = (options) => {
|
|
2544
|
+
return (options.client ?? _heyApiClient).post({
|
|
2545
|
+
security: [
|
|
2546
|
+
{
|
|
2547
|
+
scheme: 'bearer',
|
|
2548
|
+
type: 'http'
|
|
2549
|
+
}
|
|
2550
|
+
],
|
|
2551
|
+
url: '/message_template_folders/{message_template_folder_id}/message_templates',
|
|
2552
|
+
...options,
|
|
2553
|
+
headers: {
|
|
2554
|
+
'Content-Type': 'application/json',
|
|
2555
|
+
...options.headers
|
|
2556
|
+
}
|
|
2557
|
+
});
|
|
2558
|
+
};
|
|
2559
|
+
/**
|
|
2560
|
+
* List message templates
|
|
2561
|
+
* List the message templates.
|
|
2562
|
+
*/
|
|
2563
|
+
export const listMessageTemplates = (options) => {
|
|
2564
|
+
return (options?.client ?? _heyApiClient).get({
|
|
2565
|
+
security: [
|
|
2566
|
+
{
|
|
2567
|
+
scheme: 'bearer',
|
|
2568
|
+
type: 'http'
|
|
2569
|
+
}
|
|
2570
|
+
],
|
|
2571
|
+
url: '/message_templates',
|
|
2572
|
+
...options
|
|
2573
|
+
});
|
|
2574
|
+
};
|
|
2575
|
+
/**
|
|
2576
|
+
* Create message template
|
|
2577
|
+
* Create a new message template in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team message template](https://dev.frontapp.com/reference/create-team-message-template) endpoint instead.
|
|
2578
|
+
*/
|
|
2579
|
+
export const createMessageTemplate = (options) => {
|
|
2580
|
+
return (options?.client ?? _heyApiClient).post({
|
|
2581
|
+
security: [
|
|
2582
|
+
{
|
|
2583
|
+
scheme: 'bearer',
|
|
2584
|
+
type: 'http'
|
|
2585
|
+
}
|
|
2586
|
+
],
|
|
2587
|
+
url: '/message_templates',
|
|
2588
|
+
...options,
|
|
2589
|
+
headers: {
|
|
2590
|
+
'Content-Type': 'application/json',
|
|
2591
|
+
...options?.headers
|
|
2592
|
+
}
|
|
2593
|
+
});
|
|
2594
|
+
};
|
|
2595
|
+
/**
|
|
2596
|
+
* Delete message template
|
|
2597
|
+
* Delete a message template
|
|
2598
|
+
*/
|
|
2599
|
+
export const deleteMessageTemplate = (options) => {
|
|
2600
|
+
return (options.client ?? _heyApiClient).delete({
|
|
2601
|
+
security: [
|
|
2602
|
+
{
|
|
2603
|
+
scheme: 'bearer',
|
|
2604
|
+
type: 'http'
|
|
2605
|
+
}
|
|
2606
|
+
],
|
|
2607
|
+
url: '/message_templates/{message_template_id}',
|
|
2608
|
+
...options
|
|
2609
|
+
});
|
|
2610
|
+
};
|
|
2611
|
+
/**
|
|
2612
|
+
* Get message template
|
|
2613
|
+
* Fetch a message template.
|
|
2614
|
+
*/
|
|
2615
|
+
export const getMessageTemplate = (options) => {
|
|
2616
|
+
return (options.client ?? _heyApiClient).get({
|
|
2617
|
+
security: [
|
|
2618
|
+
{
|
|
2619
|
+
scheme: 'bearer',
|
|
2620
|
+
type: 'http'
|
|
2621
|
+
}
|
|
2622
|
+
],
|
|
2623
|
+
url: '/message_templates/{message_template_id}',
|
|
2624
|
+
...options
|
|
2625
|
+
});
|
|
2626
|
+
};
|
|
2627
|
+
/**
|
|
2628
|
+
* Update message template
|
|
2629
|
+
* Update message template
|
|
2630
|
+
*/
|
|
2631
|
+
export const updateMessageTemplate = (options) => {
|
|
2632
|
+
return (options.client ?? _heyApiClient).patch({
|
|
2633
|
+
security: [
|
|
2634
|
+
{
|
|
2635
|
+
scheme: 'bearer',
|
|
2636
|
+
type: 'http'
|
|
2637
|
+
}
|
|
2638
|
+
],
|
|
2639
|
+
url: '/message_templates/{message_template_id}',
|
|
2640
|
+
...options,
|
|
2641
|
+
headers: {
|
|
2642
|
+
'Content-Type': 'application/json',
|
|
2643
|
+
...options.headers
|
|
2644
|
+
}
|
|
2645
|
+
});
|
|
2646
|
+
};
|
|
2647
|
+
/**
|
|
2648
|
+
* Download attachment for a message template
|
|
2649
|
+
* Download an attachment file for a given message template ID
|
|
2650
|
+
*/
|
|
2651
|
+
export const downloadAttachmentForAMessageTemplate = (options) => {
|
|
2652
|
+
return (options.client ?? _heyApiClient).get({
|
|
2653
|
+
security: [
|
|
2654
|
+
{
|
|
2655
|
+
scheme: 'bearer',
|
|
2656
|
+
type: 'http'
|
|
2657
|
+
}
|
|
2658
|
+
],
|
|
2659
|
+
url: '/message_templates/{message_template_id}/download/{attachment_link_id}',
|
|
2660
|
+
...options
|
|
2661
|
+
});
|
|
2662
|
+
};
|
|
2663
|
+
/**
|
|
2664
|
+
* Get message
|
|
2665
|
+
* Fetch a message.
|
|
2666
|
+
*
|
|
2667
|
+
* > ℹ️ The HTTP Header `Accept` can be used to request the message in a different format.
|
|
2668
|
+
* > By default, Front will return the documented JSON response. By requesting `message/rfc822`, the response will contain the message in the EML format (for email messages only).
|
|
2669
|
+
*
|
|
2670
|
+
*/
|
|
2671
|
+
export const getMessage = (options) => {
|
|
2672
|
+
return (options.client ?? _heyApiClient).get({
|
|
2673
|
+
security: [
|
|
2674
|
+
{
|
|
2675
|
+
scheme: 'bearer',
|
|
2676
|
+
type: 'http'
|
|
2677
|
+
}
|
|
2678
|
+
],
|
|
2679
|
+
url: '/messages/{message_id}',
|
|
2680
|
+
...options
|
|
2681
|
+
});
|
|
2682
|
+
};
|
|
2683
|
+
/**
|
|
2684
|
+
* Download attachment for a message
|
|
2685
|
+
* Download an attachment file for a given message id. Should be used by partner channels.
|
|
2686
|
+
*/
|
|
2687
|
+
export const downloadAttachmentForAMessage = (options) => {
|
|
2688
|
+
return (options.client ?? _heyApiClient).get({
|
|
2689
|
+
security: [
|
|
2690
|
+
{
|
|
2691
|
+
scheme: 'bearer',
|
|
2692
|
+
type: 'http'
|
|
2693
|
+
}
|
|
2694
|
+
],
|
|
2695
|
+
url: '/messages/{message_id}/download/{attachment_link_id}',
|
|
2696
|
+
...options
|
|
2697
|
+
});
|
|
2698
|
+
};
|
|
2699
|
+
/**
|
|
2700
|
+
* Get message seen status
|
|
2701
|
+
* Get the seen receipts for the given message. If no seen-by information is available, there will be a single entry for the first time the message was seen by any recipient. If seen-by information is available, there will be an entry for each recipient who has seen the message.
|
|
2702
|
+
*/
|
|
2703
|
+
export const getMessageSeenStatus = (options) => {
|
|
2704
|
+
return (options.client ?? _heyApiClient).get({
|
|
2705
|
+
security: [
|
|
2706
|
+
{
|
|
2707
|
+
scheme: 'bearer',
|
|
2708
|
+
type: 'http'
|
|
2709
|
+
}
|
|
2710
|
+
],
|
|
2711
|
+
url: '/messages/{message_id}/seen',
|
|
2712
|
+
...options
|
|
2713
|
+
});
|
|
2714
|
+
};
|
|
2715
|
+
/**
|
|
2716
|
+
* Mark message seen
|
|
2717
|
+
* Mark an outbound message from Front as seen. Note, the message seen route should only be called in response to an actual end-user's message-seen action. In accordance with this behavior, the route is rate limited to 10 requests per message per hour.
|
|
2718
|
+
*/
|
|
2719
|
+
export const markMessageSeen = (options) => {
|
|
2720
|
+
return (options.client ?? _heyApiClient).post({
|
|
2721
|
+
security: [
|
|
2722
|
+
{
|
|
2723
|
+
scheme: 'bearer',
|
|
2724
|
+
type: 'http'
|
|
2725
|
+
}
|
|
2726
|
+
],
|
|
2727
|
+
url: '/messages/{message_id}/seen',
|
|
2728
|
+
...options,
|
|
2729
|
+
headers: {
|
|
2730
|
+
'Content-Type': 'application/json',
|
|
2731
|
+
...options.headers
|
|
2732
|
+
}
|
|
2733
|
+
});
|
|
2734
|
+
};
|
|
2735
|
+
/**
|
|
2736
|
+
* List rules
|
|
2737
|
+
* List the rules of the company.
|
|
2738
|
+
*/
|
|
2739
|
+
export const listRules = (options) => {
|
|
2740
|
+
return (options?.client ?? _heyApiClient).get({
|
|
2741
|
+
security: [
|
|
2742
|
+
{
|
|
2743
|
+
scheme: 'bearer',
|
|
2744
|
+
type: 'http'
|
|
2745
|
+
}
|
|
2746
|
+
],
|
|
2747
|
+
url: '/rules',
|
|
2748
|
+
...options
|
|
2749
|
+
});
|
|
2750
|
+
};
|
|
2751
|
+
/**
|
|
2752
|
+
* Get rule
|
|
2753
|
+
* Fetch a rule.
|
|
2754
|
+
*/
|
|
2755
|
+
export const getRule = (options) => {
|
|
2756
|
+
return (options.client ?? _heyApiClient).get({
|
|
2757
|
+
security: [
|
|
2758
|
+
{
|
|
2759
|
+
scheme: 'bearer',
|
|
2760
|
+
type: 'http'
|
|
2761
|
+
}
|
|
2762
|
+
],
|
|
2763
|
+
url: '/rules/{rule_id}',
|
|
2764
|
+
...options
|
|
2765
|
+
});
|
|
2766
|
+
};
|
|
2767
|
+
/**
|
|
2768
|
+
* List Shifts
|
|
2769
|
+
* List the shifts.
|
|
2770
|
+
*/
|
|
2771
|
+
export const listShifts = (options) => {
|
|
2772
|
+
return (options?.client ?? _heyApiClient).get({
|
|
2773
|
+
security: [
|
|
2774
|
+
{
|
|
2775
|
+
scheme: 'bearer',
|
|
2776
|
+
type: 'http'
|
|
2777
|
+
}
|
|
2778
|
+
],
|
|
2779
|
+
url: '/shifts',
|
|
2780
|
+
...options
|
|
2781
|
+
});
|
|
2782
|
+
};
|
|
2783
|
+
/**
|
|
2784
|
+
* Create shift
|
|
2785
|
+
* Create a shift in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team shift](https://dev.frontapp.com/reference/create-team-shift) endpoint instead.
|
|
2786
|
+
*/
|
|
2787
|
+
export const createShift = (options) => {
|
|
2788
|
+
return (options?.client ?? _heyApiClient).post({
|
|
2789
|
+
security: [
|
|
2790
|
+
{
|
|
2791
|
+
scheme: 'bearer',
|
|
2792
|
+
type: 'http'
|
|
2793
|
+
}
|
|
2794
|
+
],
|
|
2795
|
+
url: '/shifts',
|
|
2796
|
+
...options,
|
|
2797
|
+
headers: {
|
|
2798
|
+
'Content-Type': 'application/json',
|
|
2799
|
+
...options?.headers
|
|
2800
|
+
}
|
|
2801
|
+
});
|
|
2802
|
+
};
|
|
2803
|
+
/**
|
|
2804
|
+
* Get shift
|
|
2805
|
+
* Fetch a shift.
|
|
2806
|
+
*/
|
|
2807
|
+
export const getShift = (options) => {
|
|
2808
|
+
return (options.client ?? _heyApiClient).get({
|
|
2809
|
+
security: [
|
|
2810
|
+
{
|
|
2811
|
+
scheme: 'bearer',
|
|
2812
|
+
type: 'http'
|
|
2813
|
+
}
|
|
2814
|
+
],
|
|
2815
|
+
url: '/shifts/{shift_id}',
|
|
2816
|
+
...options
|
|
2817
|
+
});
|
|
2818
|
+
};
|
|
2819
|
+
/**
|
|
2820
|
+
* Update shift
|
|
2821
|
+
* Update a shift.
|
|
2822
|
+
*/
|
|
2823
|
+
export const updateShift = (options) => {
|
|
2824
|
+
return (options.client ?? _heyApiClient).patch({
|
|
2825
|
+
security: [
|
|
2826
|
+
{
|
|
2827
|
+
scheme: 'bearer',
|
|
2828
|
+
type: 'http'
|
|
2829
|
+
}
|
|
2830
|
+
],
|
|
2831
|
+
url: '/shifts/{shift_id}',
|
|
2832
|
+
...options,
|
|
2833
|
+
headers: {
|
|
2834
|
+
'Content-Type': 'application/json',
|
|
2835
|
+
...options.headers
|
|
2836
|
+
}
|
|
2837
|
+
});
|
|
2838
|
+
};
|
|
2839
|
+
/**
|
|
2840
|
+
* Remove teammates from shift
|
|
2841
|
+
* Remove teammates from a shift.
|
|
2842
|
+
*/
|
|
2843
|
+
export const removeTeammatesFromShift = (options) => {
|
|
2844
|
+
return (options.client ?? _heyApiClient).delete({
|
|
2845
|
+
security: [
|
|
2846
|
+
{
|
|
2847
|
+
scheme: 'bearer',
|
|
2848
|
+
type: 'http'
|
|
2849
|
+
}
|
|
2850
|
+
],
|
|
2851
|
+
url: '/shifts/{shift_id}/teammates',
|
|
2852
|
+
...options,
|
|
2853
|
+
headers: {
|
|
2854
|
+
'Content-Type': 'application/json',
|
|
2855
|
+
...options.headers
|
|
2856
|
+
}
|
|
2857
|
+
});
|
|
2858
|
+
};
|
|
2859
|
+
/**
|
|
2860
|
+
* List shift's teammates
|
|
2861
|
+
* List the teammates assigned to a shift.
|
|
2862
|
+
*/
|
|
2863
|
+
export const listShiftsTeammates = (options) => {
|
|
2864
|
+
return (options.client ?? _heyApiClient).get({
|
|
2865
|
+
security: [
|
|
2866
|
+
{
|
|
2867
|
+
scheme: 'bearer',
|
|
2868
|
+
type: 'http'
|
|
2869
|
+
}
|
|
2870
|
+
],
|
|
2871
|
+
url: '/shifts/{shift_id}/teammates',
|
|
2872
|
+
...options
|
|
2873
|
+
});
|
|
2874
|
+
};
|
|
2875
|
+
/**
|
|
2876
|
+
* Add teammates to shift
|
|
2877
|
+
* Add teammates to a shift. The selected teammates must be in the team that owns the shift.
|
|
2878
|
+
*/
|
|
2879
|
+
export const addTeammatesToShift = (options) => {
|
|
2880
|
+
return (options.client ?? _heyApiClient).post({
|
|
2881
|
+
security: [
|
|
2882
|
+
{
|
|
2883
|
+
scheme: 'bearer',
|
|
2884
|
+
type: 'http'
|
|
2885
|
+
}
|
|
2886
|
+
],
|
|
2887
|
+
url: '/shifts/{shift_id}/teammates',
|
|
2888
|
+
...options,
|
|
2889
|
+
headers: {
|
|
2890
|
+
'Content-Type': 'application/json',
|
|
2891
|
+
...options.headers
|
|
2892
|
+
}
|
|
2893
|
+
});
|
|
2894
|
+
};
|
|
2895
|
+
/**
|
|
2896
|
+
* Delete signature
|
|
2897
|
+
* Delete signature
|
|
2898
|
+
*/
|
|
2899
|
+
export const deleteSignature = (options) => {
|
|
2900
|
+
return (options.client ?? _heyApiClient).delete({
|
|
2901
|
+
security: [
|
|
2902
|
+
{
|
|
2903
|
+
scheme: 'bearer',
|
|
2904
|
+
type: 'http'
|
|
2905
|
+
}
|
|
2906
|
+
],
|
|
2907
|
+
url: '/signatures/{signature_id}',
|
|
2908
|
+
...options
|
|
2909
|
+
});
|
|
2910
|
+
};
|
|
2911
|
+
/**
|
|
2912
|
+
* Get signatures
|
|
2913
|
+
* Get the given signature.
|
|
2914
|
+
*/
|
|
2915
|
+
export const getSignatures = (options) => {
|
|
2916
|
+
return (options.client ?? _heyApiClient).get({
|
|
2917
|
+
security: [
|
|
2918
|
+
{
|
|
2919
|
+
scheme: 'bearer',
|
|
2920
|
+
type: 'http'
|
|
2921
|
+
}
|
|
2922
|
+
],
|
|
2923
|
+
url: '/signatures/{signature_id}',
|
|
2924
|
+
...options
|
|
2925
|
+
});
|
|
2926
|
+
};
|
|
2927
|
+
/**
|
|
2928
|
+
* Update signature
|
|
2929
|
+
* Update signature
|
|
2930
|
+
*/
|
|
2931
|
+
export const updateSignature = (options) => {
|
|
2932
|
+
return (options.client ?? _heyApiClient).patch({
|
|
2933
|
+
security: [
|
|
2934
|
+
{
|
|
2935
|
+
scheme: 'bearer',
|
|
2936
|
+
type: 'http'
|
|
2937
|
+
}
|
|
2938
|
+
],
|
|
2939
|
+
url: '/signatures/{signature_id}',
|
|
2940
|
+
...options,
|
|
2941
|
+
headers: {
|
|
2942
|
+
'Content-Type': 'application/json',
|
|
2943
|
+
...options.headers
|
|
2944
|
+
}
|
|
2945
|
+
});
|
|
2946
|
+
};
|
|
2947
|
+
/**
|
|
2948
|
+
* List tags
|
|
2949
|
+
* List all the tags of the company that the API token has access to, whether they be company tags, team tags, or teammate tags.
|
|
2950
|
+
*/
|
|
2951
|
+
export const listTags = (options) => {
|
|
2952
|
+
return (options?.client ?? _heyApiClient).get({
|
|
2953
|
+
security: [
|
|
2954
|
+
{
|
|
2955
|
+
scheme: 'bearer',
|
|
2956
|
+
type: 'http'
|
|
2957
|
+
}
|
|
2958
|
+
],
|
|
2959
|
+
url: '/tags',
|
|
2960
|
+
...options
|
|
2961
|
+
});
|
|
2962
|
+
};
|
|
2963
|
+
/**
|
|
2964
|
+
* Create tag
|
|
2965
|
+
* Create a tag in the oldest team (workspace). This is a legacy endpoint. Use the Create company tag, Create team tag, or Create teammate tag endpoints instead.
|
|
2966
|
+
*/
|
|
2967
|
+
export const createTag = (options) => {
|
|
2968
|
+
return (options?.client ?? _heyApiClient).post({
|
|
2969
|
+
security: [
|
|
2970
|
+
{
|
|
2971
|
+
scheme: 'bearer',
|
|
2972
|
+
type: 'http'
|
|
2973
|
+
}
|
|
2974
|
+
],
|
|
2975
|
+
url: '/tags',
|
|
2976
|
+
...options,
|
|
2977
|
+
headers: {
|
|
2978
|
+
'Content-Type': 'application/json',
|
|
2979
|
+
...options?.headers
|
|
2980
|
+
}
|
|
2981
|
+
});
|
|
2982
|
+
};
|
|
2983
|
+
/**
|
|
2984
|
+
* Delete tag
|
|
2985
|
+
* Delete a tag.
|
|
2986
|
+
*/
|
|
2987
|
+
export const deleteTag = (options) => {
|
|
2988
|
+
return (options.client ?? _heyApiClient).delete({
|
|
2989
|
+
security: [
|
|
2990
|
+
{
|
|
2991
|
+
scheme: 'bearer',
|
|
2992
|
+
type: 'http'
|
|
2993
|
+
}
|
|
2994
|
+
],
|
|
2995
|
+
url: '/tags/{tag_id}',
|
|
2996
|
+
...options
|
|
2997
|
+
});
|
|
2998
|
+
};
|
|
2999
|
+
/**
|
|
3000
|
+
* Get tag
|
|
3001
|
+
* Fetch a tag.
|
|
3002
|
+
*/
|
|
3003
|
+
export const getTag = (options) => {
|
|
3004
|
+
return (options.client ?? _heyApiClient).get({
|
|
3005
|
+
security: [
|
|
3006
|
+
{
|
|
3007
|
+
scheme: 'bearer',
|
|
3008
|
+
type: 'http'
|
|
3009
|
+
}
|
|
3010
|
+
],
|
|
3011
|
+
url: '/tags/{tag_id}',
|
|
3012
|
+
...options
|
|
3013
|
+
});
|
|
3014
|
+
};
|
|
3015
|
+
/**
|
|
3016
|
+
* Update a tag
|
|
3017
|
+
* Update a tag.
|
|
3018
|
+
*/
|
|
3019
|
+
export const updateATag = (options) => {
|
|
3020
|
+
return (options.client ?? _heyApiClient).patch({
|
|
3021
|
+
security: [
|
|
3022
|
+
{
|
|
3023
|
+
scheme: 'bearer',
|
|
3024
|
+
type: 'http'
|
|
3025
|
+
}
|
|
3026
|
+
],
|
|
3027
|
+
url: '/tags/{tag_id}',
|
|
3028
|
+
...options,
|
|
3029
|
+
headers: {
|
|
3030
|
+
'Content-Type': 'application/json',
|
|
3031
|
+
...options.headers
|
|
3032
|
+
}
|
|
3033
|
+
});
|
|
3034
|
+
};
|
|
3035
|
+
/**
|
|
3036
|
+
* List tag children
|
|
3037
|
+
* List the children of a specific tag.
|
|
3038
|
+
*/
|
|
3039
|
+
export const listTagChildren = (options) => {
|
|
3040
|
+
return (options.client ?? _heyApiClient).get({
|
|
3041
|
+
security: [
|
|
3042
|
+
{
|
|
3043
|
+
scheme: 'bearer',
|
|
3044
|
+
type: 'http'
|
|
3045
|
+
}
|
|
3046
|
+
],
|
|
3047
|
+
url: '/tags/{tag_id}/children',
|
|
3048
|
+
...options
|
|
3049
|
+
});
|
|
3050
|
+
};
|
|
3051
|
+
/**
|
|
3052
|
+
* Create child tag
|
|
3053
|
+
* Creates a child tag.
|
|
3054
|
+
*/
|
|
3055
|
+
export const createChildTag = (options) => {
|
|
3056
|
+
return (options.client ?? _heyApiClient).post({
|
|
3057
|
+
security: [
|
|
3058
|
+
{
|
|
3059
|
+
scheme: 'bearer',
|
|
3060
|
+
type: 'http'
|
|
3061
|
+
}
|
|
3062
|
+
],
|
|
3063
|
+
url: '/tags/{tag_id}/children',
|
|
3064
|
+
...options,
|
|
3065
|
+
headers: {
|
|
3066
|
+
'Content-Type': 'application/json',
|
|
3067
|
+
...options.headers
|
|
3068
|
+
}
|
|
3069
|
+
});
|
|
3070
|
+
};
|
|
3071
|
+
/**
|
|
3072
|
+
* List tagged conversations
|
|
3073
|
+
* List the conversations tagged with a tag. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
|
|
3074
|
+
*
|
|
3075
|
+
*/
|
|
3076
|
+
export const listTaggedConversations = (options) => {
|
|
3077
|
+
return (options.client ?? _heyApiClient).get({
|
|
3078
|
+
security: [
|
|
3079
|
+
{
|
|
3080
|
+
scheme: 'bearer',
|
|
3081
|
+
type: 'http'
|
|
3082
|
+
}
|
|
3083
|
+
],
|
|
3084
|
+
url: '/tags/{tag_id}/conversations',
|
|
3085
|
+
...options
|
|
3086
|
+
});
|
|
3087
|
+
};
|
|
3088
|
+
/**
|
|
3089
|
+
* List teammate groups
|
|
3090
|
+
* List the teammate groups in the company.
|
|
3091
|
+
*/
|
|
3092
|
+
export const listCompanyTeammateGroups = (options) => {
|
|
3093
|
+
return (options?.client ?? _heyApiClient).get({
|
|
3094
|
+
security: [
|
|
3095
|
+
{
|
|
3096
|
+
scheme: 'bearer',
|
|
3097
|
+
type: 'http'
|
|
3098
|
+
}
|
|
3099
|
+
],
|
|
3100
|
+
url: '/teammate_groups',
|
|
3101
|
+
...options
|
|
3102
|
+
});
|
|
3103
|
+
};
|
|
3104
|
+
/**
|
|
3105
|
+
* Create teammate group
|
|
3106
|
+
* Create a new teammate group.
|
|
3107
|
+
*/
|
|
3108
|
+
export const createCompanyTeammateGroup = (options) => {
|
|
3109
|
+
return (options?.client ?? _heyApiClient).post({
|
|
3110
|
+
security: [
|
|
3111
|
+
{
|
|
3112
|
+
scheme: 'bearer',
|
|
3113
|
+
type: 'http'
|
|
3114
|
+
}
|
|
3115
|
+
],
|
|
3116
|
+
url: '/teammate_groups',
|
|
3117
|
+
...options,
|
|
3118
|
+
headers: {
|
|
3119
|
+
'Content-Type': 'application/json',
|
|
3120
|
+
...options?.headers
|
|
3121
|
+
}
|
|
3122
|
+
});
|
|
3123
|
+
};
|
|
3124
|
+
/**
|
|
3125
|
+
* Delete teammate group
|
|
3126
|
+
* Deletes a teammate group. Note - You cannot delete a teammate group that is managed by SCIM.
|
|
3127
|
+
*/
|
|
3128
|
+
export const deleteCompanyTeammateGroup = (options) => {
|
|
3129
|
+
return (options.client ?? _heyApiClient).delete({
|
|
3130
|
+
security: [
|
|
3131
|
+
{
|
|
3132
|
+
scheme: 'bearer',
|
|
3133
|
+
type: 'http'
|
|
3134
|
+
}
|
|
3135
|
+
],
|
|
3136
|
+
url: '/teammate_groups/{teammate_group_id}',
|
|
3137
|
+
...options
|
|
3138
|
+
});
|
|
3139
|
+
};
|
|
3140
|
+
/**
|
|
3141
|
+
* Get teammate group
|
|
3142
|
+
* Fetch a teammate group.
|
|
3143
|
+
*/
|
|
3144
|
+
export const getCompanyTeammateGroup = (options) => {
|
|
3145
|
+
return (options.client ?? _heyApiClient).get({
|
|
3146
|
+
security: [
|
|
3147
|
+
{
|
|
3148
|
+
scheme: 'bearer',
|
|
3149
|
+
type: 'http'
|
|
3150
|
+
}
|
|
3151
|
+
],
|
|
3152
|
+
url: '/teammate_groups/{teammate_group_id}',
|
|
3153
|
+
...options
|
|
3154
|
+
});
|
|
3155
|
+
};
|
|
3156
|
+
/**
|
|
3157
|
+
* Update a teammate group
|
|
3158
|
+
* Updates a teammate group. Note - You cannot modify a teammate group that is managed by SCIM.
|
|
3159
|
+
*/
|
|
3160
|
+
export const updateACompanyTeammateGroup = (options) => {
|
|
3161
|
+
return (options.client ?? _heyApiClient).patch({
|
|
3162
|
+
security: [
|
|
3163
|
+
{
|
|
3164
|
+
scheme: 'bearer',
|
|
3165
|
+
type: 'http'
|
|
3166
|
+
}
|
|
3167
|
+
],
|
|
3168
|
+
url: '/teammate_groups/{teammate_group_id}',
|
|
3169
|
+
...options,
|
|
3170
|
+
headers: {
|
|
3171
|
+
'Content-Type': 'application/json',
|
|
3172
|
+
...options.headers
|
|
3173
|
+
}
|
|
3174
|
+
});
|
|
3175
|
+
};
|
|
3176
|
+
/**
|
|
3177
|
+
* Remove teammate group team inboxes
|
|
3178
|
+
* Unlinks non-public inboxes from the teammate group.
|
|
3179
|
+
*/
|
|
3180
|
+
export const removeCompanyTeammateGroupTeamInboxes = (options) => {
|
|
3181
|
+
return (options.client ?? _heyApiClient).delete({
|
|
3182
|
+
security: [
|
|
3183
|
+
{
|
|
3184
|
+
scheme: 'bearer',
|
|
3185
|
+
type: 'http'
|
|
3186
|
+
}
|
|
3187
|
+
],
|
|
3188
|
+
url: '/teammate_groups/{teammate_group_id}/inboxes',
|
|
3189
|
+
...options,
|
|
3190
|
+
headers: {
|
|
3191
|
+
'Content-Type': 'application/json',
|
|
3192
|
+
...options.headers
|
|
3193
|
+
}
|
|
3194
|
+
});
|
|
3195
|
+
};
|
|
3196
|
+
/**
|
|
3197
|
+
* List teammate group team inboxes
|
|
3198
|
+
* List inboxes that the teammate group has access to via its associated teams.
|
|
3199
|
+
*/
|
|
3200
|
+
export const listCompanyTeammateGroupTeamInboxes = (options) => {
|
|
3201
|
+
return (options.client ?? _heyApiClient).get({
|
|
3202
|
+
security: [
|
|
3203
|
+
{
|
|
3204
|
+
scheme: 'bearer',
|
|
3205
|
+
type: 'http'
|
|
3206
|
+
}
|
|
3207
|
+
],
|
|
3208
|
+
url: '/teammate_groups/{teammate_group_id}/inboxes',
|
|
3209
|
+
...options
|
|
3210
|
+
});
|
|
3211
|
+
};
|
|
3212
|
+
/**
|
|
3213
|
+
* Add teammate group team inboxes
|
|
3214
|
+
* Links non-public inboxes to the teammate group. The inbox must be part of a team that has been added to the teammate group.
|
|
3215
|
+
*/
|
|
3216
|
+
export const addCompanyTeammateGroupTeamInboxes = (options) => {
|
|
3217
|
+
return (options.client ?? _heyApiClient).post({
|
|
3218
|
+
security: [
|
|
3219
|
+
{
|
|
3220
|
+
scheme: 'bearer',
|
|
3221
|
+
type: 'http'
|
|
3222
|
+
}
|
|
3223
|
+
],
|
|
3224
|
+
url: '/teammate_groups/{teammate_group_id}/inboxes',
|
|
3225
|
+
...options,
|
|
3226
|
+
headers: {
|
|
3227
|
+
'Content-Type': 'application/json',
|
|
3228
|
+
...options.headers
|
|
3229
|
+
}
|
|
3230
|
+
});
|
|
3231
|
+
};
|
|
3232
|
+
/**
|
|
3233
|
+
* Remove teammate group teammates
|
|
3234
|
+
* Remove teammate group teammates. Note - You cannot modify a teammate group that is managed by SCIM.
|
|
3235
|
+
*/
|
|
3236
|
+
export const removeCompanyTeammateGroupTeammates = (options) => {
|
|
3237
|
+
return (options.client ?? _heyApiClient).delete({
|
|
3238
|
+
security: [
|
|
3239
|
+
{
|
|
3240
|
+
scheme: 'bearer',
|
|
3241
|
+
type: 'http'
|
|
3242
|
+
}
|
|
3243
|
+
],
|
|
3244
|
+
url: '/teammate_groups/{teammate_group_id}/teammates',
|
|
3245
|
+
...options,
|
|
3246
|
+
headers: {
|
|
3247
|
+
'Content-Type': 'application/json',
|
|
3248
|
+
...options.headers
|
|
3249
|
+
}
|
|
3250
|
+
});
|
|
3251
|
+
};
|
|
3252
|
+
/**
|
|
3253
|
+
* List teammate group teammates
|
|
3254
|
+
* List teammate group teammates.
|
|
3255
|
+
*/
|
|
3256
|
+
export const listCompanyTeammateGroupTeammates = (options) => {
|
|
3257
|
+
return (options.client ?? _heyApiClient).get({
|
|
3258
|
+
security: [
|
|
3259
|
+
{
|
|
3260
|
+
scheme: 'bearer',
|
|
3261
|
+
type: 'http'
|
|
3262
|
+
}
|
|
3263
|
+
],
|
|
3264
|
+
url: '/teammate_groups/{teammate_group_id}/teammates',
|
|
3265
|
+
...options
|
|
3266
|
+
});
|
|
3267
|
+
};
|
|
3268
|
+
/**
|
|
3269
|
+
* Add teammate group teammates
|
|
3270
|
+
* Add teammate group teammates. Note - You cannot modify a teammate group that is managed by SCIM.
|
|
3271
|
+
*/
|
|
3272
|
+
export const addCompanyTeammateGroupTeammates = (options) => {
|
|
3273
|
+
return (options.client ?? _heyApiClient).post({
|
|
3274
|
+
security: [
|
|
3275
|
+
{
|
|
3276
|
+
scheme: 'bearer',
|
|
3277
|
+
type: 'http'
|
|
3278
|
+
}
|
|
3279
|
+
],
|
|
3280
|
+
url: '/teammate_groups/{teammate_group_id}/teammates',
|
|
3281
|
+
...options,
|
|
3282
|
+
headers: {
|
|
3283
|
+
'Content-Type': 'application/json',
|
|
3284
|
+
...options.headers
|
|
3285
|
+
}
|
|
3286
|
+
});
|
|
3287
|
+
};
|
|
3288
|
+
/**
|
|
3289
|
+
* Remove teammate group teams
|
|
3290
|
+
* Remove teams from the teammate group. Unlinks to any associated team inboxes.
|
|
3291
|
+
*/
|
|
3292
|
+
export const removeCompanyTeammateGroupTeams = (options) => {
|
|
3293
|
+
return (options.client ?? _heyApiClient).delete({
|
|
3294
|
+
security: [
|
|
3295
|
+
{
|
|
3296
|
+
scheme: 'bearer',
|
|
3297
|
+
type: 'http'
|
|
3298
|
+
}
|
|
3299
|
+
],
|
|
3300
|
+
url: '/teammate_groups/{teammate_group_id}/teams',
|
|
3301
|
+
...options,
|
|
3302
|
+
headers: {
|
|
3303
|
+
'Content-Type': 'application/json',
|
|
3304
|
+
...options.headers
|
|
3305
|
+
}
|
|
3306
|
+
});
|
|
3307
|
+
};
|
|
3308
|
+
/**
|
|
3309
|
+
* List teammate group teams
|
|
3310
|
+
* List teams added to the teammate group. Any teams added to the teammate group will automatically link public inboxes.
|
|
3311
|
+
*/
|
|
3312
|
+
export const listCompanyTeammateGroupTeams = (options) => {
|
|
3313
|
+
return (options.client ?? _heyApiClient).get({
|
|
3314
|
+
security: [
|
|
3315
|
+
{
|
|
3316
|
+
scheme: 'bearer',
|
|
3317
|
+
type: 'http'
|
|
3318
|
+
}
|
|
3319
|
+
],
|
|
3320
|
+
url: '/teammate_groups/{teammate_group_id}/teams',
|
|
3321
|
+
...options
|
|
3322
|
+
});
|
|
3323
|
+
};
|
|
3324
|
+
/**
|
|
3325
|
+
* Add teammate group teams
|
|
3326
|
+
* Adds teams to the teammate group. Any teams added to the teammate group will automatically link public inboxes. Non-public inboxes can be added to the teammate group separately.
|
|
3327
|
+
*/
|
|
3328
|
+
export const addCompanyTeammateGroupTeams = (options) => {
|
|
3329
|
+
return (options.client ?? _heyApiClient).post({
|
|
3330
|
+
security: [
|
|
3331
|
+
{
|
|
3332
|
+
scheme: 'bearer',
|
|
3333
|
+
type: 'http'
|
|
3334
|
+
}
|
|
3335
|
+
],
|
|
3336
|
+
url: '/teammate_groups/{teammate_group_id}/teams',
|
|
3337
|
+
...options,
|
|
3338
|
+
headers: {
|
|
3339
|
+
'Content-Type': 'application/json',
|
|
3340
|
+
...options.headers
|
|
3341
|
+
}
|
|
3342
|
+
});
|
|
3343
|
+
};
|
|
3344
|
+
/**
|
|
3345
|
+
* List teammates
|
|
3346
|
+
* List the teammates in the company.
|
|
3347
|
+
*/
|
|
3348
|
+
export const listTeammates = (options) => {
|
|
3349
|
+
return (options?.client ?? _heyApiClient).get({
|
|
3350
|
+
security: [
|
|
3351
|
+
{
|
|
3352
|
+
scheme: 'bearer',
|
|
3353
|
+
type: 'http'
|
|
3354
|
+
}
|
|
3355
|
+
],
|
|
3356
|
+
url: '/teammates',
|
|
3357
|
+
...options
|
|
3358
|
+
});
|
|
3359
|
+
};
|
|
3360
|
+
/**
|
|
3361
|
+
* List Teammate's custom fields
|
|
3362
|
+
* Lists the custom fields that can be attached to a Teammate.
|
|
3363
|
+
*/
|
|
3364
|
+
export const listTeammateCustomFields = (options) => {
|
|
3365
|
+
return (options?.client ?? _heyApiClient).get({
|
|
3366
|
+
security: [
|
|
3367
|
+
{
|
|
3368
|
+
scheme: 'bearer',
|
|
3369
|
+
type: 'http'
|
|
3370
|
+
}
|
|
3371
|
+
],
|
|
3372
|
+
url: '/teammates/custom_fields',
|
|
3373
|
+
...options
|
|
3374
|
+
});
|
|
3375
|
+
};
|
|
3376
|
+
/**
|
|
3377
|
+
* Get teammate
|
|
3378
|
+
* Fetch a teammate.
|
|
3379
|
+
*/
|
|
3380
|
+
export const getTeammate = (options) => {
|
|
3381
|
+
return (options.client ?? _heyApiClient).get({
|
|
3382
|
+
security: [
|
|
3383
|
+
{
|
|
3384
|
+
scheme: 'bearer',
|
|
3385
|
+
type: 'http'
|
|
3386
|
+
}
|
|
3387
|
+
],
|
|
3388
|
+
url: '/teammates/{teammate_id}',
|
|
3389
|
+
...options
|
|
3390
|
+
});
|
|
3391
|
+
};
|
|
3392
|
+
/**
|
|
3393
|
+
* Update teammate
|
|
3394
|
+
* Update a teammate.
|
|
3395
|
+
*/
|
|
3396
|
+
export const updateTeammate = (options) => {
|
|
3397
|
+
return (options.client ?? _heyApiClient).patch({
|
|
3398
|
+
security: [
|
|
3399
|
+
{
|
|
3400
|
+
scheme: 'bearer',
|
|
3401
|
+
type: 'http'
|
|
3402
|
+
}
|
|
3403
|
+
],
|
|
3404
|
+
url: '/teammates/{teammate_id}',
|
|
3405
|
+
...options,
|
|
3406
|
+
headers: {
|
|
3407
|
+
'Content-Type': 'application/json',
|
|
3408
|
+
...options.headers
|
|
3409
|
+
}
|
|
3410
|
+
});
|
|
3411
|
+
};
|
|
3412
|
+
/**
|
|
3413
|
+
* List teammate channels
|
|
3414
|
+
* List the channels of a teammate.
|
|
3415
|
+
*/
|
|
3416
|
+
export const listTeammateChannels = (options) => {
|
|
3417
|
+
return (options.client ?? _heyApiClient).get({
|
|
3418
|
+
security: [
|
|
3419
|
+
{
|
|
3420
|
+
scheme: 'bearer',
|
|
3421
|
+
type: 'http'
|
|
3422
|
+
}
|
|
3423
|
+
],
|
|
3424
|
+
url: '/teammates/{teammate_id}/channels',
|
|
3425
|
+
...options
|
|
3426
|
+
});
|
|
3427
|
+
};
|
|
3428
|
+
/**
|
|
3429
|
+
* List teammate groups
|
|
3430
|
+
* List the contact groups belonging to the requested teammate.
|
|
3431
|
+
*
|
|
3432
|
+
* > ⚠️ Deprecated endpoint
|
|
3433
|
+
* >
|
|
3434
|
+
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
3435
|
+
* > - `GET /teammates/{teammate_id}/contact_lists`.
|
|
3436
|
+
*
|
|
3437
|
+
* @deprecated
|
|
3438
|
+
*/
|
|
3439
|
+
export const listTeammateGroups = (options) => {
|
|
3440
|
+
return (options.client ?? _heyApiClient).get({
|
|
3441
|
+
security: [
|
|
3442
|
+
{
|
|
3443
|
+
scheme: 'bearer',
|
|
3444
|
+
type: 'http'
|
|
3445
|
+
}
|
|
3446
|
+
],
|
|
3447
|
+
url: '/teammates/{teammate_id}/contact_groups',
|
|
3448
|
+
...options
|
|
3449
|
+
});
|
|
3450
|
+
};
|
|
3451
|
+
/**
|
|
3452
|
+
* Create teammate group
|
|
3453
|
+
* Create a new contact group for the requested teammate.
|
|
3454
|
+
*
|
|
3455
|
+
* > ⚠️ Deprecated endpoint
|
|
3456
|
+
* >
|
|
3457
|
+
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
3458
|
+
* > - `POST /teammates/{teammate_id}/contact_lists`.
|
|
3459
|
+
*
|
|
3460
|
+
* @deprecated
|
|
3461
|
+
*/
|
|
3462
|
+
export const createTeammateGroup = (options) => {
|
|
3463
|
+
return (options.client ?? _heyApiClient).post({
|
|
3464
|
+
security: [
|
|
3465
|
+
{
|
|
3466
|
+
scheme: 'bearer',
|
|
3467
|
+
type: 'http'
|
|
3468
|
+
}
|
|
3469
|
+
],
|
|
3470
|
+
url: '/teammates/{teammate_id}/contact_groups',
|
|
3471
|
+
...options,
|
|
3472
|
+
headers: {
|
|
3473
|
+
'Content-Type': 'application/json',
|
|
3474
|
+
...options.headers
|
|
3475
|
+
}
|
|
3476
|
+
});
|
|
3477
|
+
};
|
|
3478
|
+
/**
|
|
3479
|
+
* List teammate contact lists
|
|
3480
|
+
* List the contact lists belonging to the requested teammate.
|
|
3481
|
+
*/
|
|
3482
|
+
export const listTeammateContactLists = (options) => {
|
|
3483
|
+
return (options.client ?? _heyApiClient).get({
|
|
3484
|
+
security: [
|
|
3485
|
+
{
|
|
3486
|
+
scheme: 'bearer',
|
|
3487
|
+
type: 'http'
|
|
3488
|
+
}
|
|
3489
|
+
],
|
|
3490
|
+
url: '/teammates/{teammate_id}/contact_lists',
|
|
3491
|
+
...options
|
|
3492
|
+
});
|
|
3493
|
+
};
|
|
3494
|
+
/**
|
|
3495
|
+
* Create teammate contact list
|
|
3496
|
+
* Create a new contact list for the requested teammate.
|
|
3497
|
+
*/
|
|
3498
|
+
export const createTeammateContactList = (options) => {
|
|
3499
|
+
return (options.client ?? _heyApiClient).post({
|
|
3500
|
+
security: [
|
|
3501
|
+
{
|
|
3502
|
+
scheme: 'bearer',
|
|
3503
|
+
type: 'http'
|
|
3504
|
+
}
|
|
3505
|
+
],
|
|
3506
|
+
url: '/teammates/{teammate_id}/contact_lists',
|
|
3507
|
+
...options,
|
|
3508
|
+
headers: {
|
|
3509
|
+
'Content-Type': 'application/json',
|
|
3510
|
+
...options.headers
|
|
3511
|
+
}
|
|
3512
|
+
});
|
|
3513
|
+
};
|
|
3514
|
+
/**
|
|
3515
|
+
* List teammate contacts
|
|
3516
|
+
* List the contacts of a teammate.
|
|
3517
|
+
*/
|
|
3518
|
+
export const listTeammateContacts = (options) => {
|
|
3519
|
+
return (options.client ?? _heyApiClient).get({
|
|
3520
|
+
security: [
|
|
3521
|
+
{
|
|
3522
|
+
scheme: 'bearer',
|
|
3523
|
+
type: 'http'
|
|
3524
|
+
}
|
|
3525
|
+
],
|
|
3526
|
+
url: '/teammates/{teammate_id}/contacts',
|
|
3527
|
+
...options
|
|
3528
|
+
});
|
|
3529
|
+
};
|
|
3530
|
+
/**
|
|
3531
|
+
* Create teammate contact
|
|
3532
|
+
* Create a contact for a teammate.
|
|
3533
|
+
*/
|
|
3534
|
+
export const createTeammateContact = (options) => {
|
|
3535
|
+
return (options.client ?? _heyApiClient).post({
|
|
3536
|
+
security: [
|
|
3537
|
+
{
|
|
3538
|
+
scheme: 'bearer',
|
|
3539
|
+
type: 'http'
|
|
3540
|
+
}
|
|
3541
|
+
],
|
|
3542
|
+
url: '/teammates/{teammate_id}/contacts',
|
|
3543
|
+
...options,
|
|
3544
|
+
headers: {
|
|
3545
|
+
'Content-Type': 'application/json',
|
|
3546
|
+
...options.headers
|
|
3547
|
+
}
|
|
3548
|
+
});
|
|
3549
|
+
};
|
|
3550
|
+
/**
|
|
3551
|
+
* List assigned conversations
|
|
3552
|
+
* List the conversations assigned to a teammate in reverse chronological order (most recently updated first). For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
|
|
3553
|
+
*
|
|
3554
|
+
*/
|
|
3555
|
+
export const listAssignedConversations = (options) => {
|
|
3556
|
+
return (options.client ?? _heyApiClient).get({
|
|
3557
|
+
security: [
|
|
3558
|
+
{
|
|
3559
|
+
scheme: 'bearer',
|
|
3560
|
+
type: 'http'
|
|
3561
|
+
}
|
|
3562
|
+
],
|
|
3563
|
+
url: '/teammates/{teammate_id}/conversations',
|
|
3564
|
+
...options
|
|
3565
|
+
});
|
|
3566
|
+
};
|
|
3567
|
+
/**
|
|
3568
|
+
* List teammate inboxes
|
|
3569
|
+
* Returns list of inboxes the teammate has access to.
|
|
3570
|
+
* @deprecated
|
|
3571
|
+
*/
|
|
3572
|
+
export const listTeammateInboxes = (options) => {
|
|
3573
|
+
return (options.client ?? _heyApiClient).get({
|
|
3574
|
+
security: [
|
|
3575
|
+
{
|
|
3576
|
+
scheme: 'bearer',
|
|
3577
|
+
type: 'http'
|
|
3578
|
+
}
|
|
3579
|
+
],
|
|
3580
|
+
url: '/teammates/{teammate_id}/inboxes',
|
|
3581
|
+
...options
|
|
3582
|
+
});
|
|
3583
|
+
};
|
|
3584
|
+
/**
|
|
3585
|
+
* List teammate folders
|
|
3586
|
+
* List the message template folders belonging to the requested teammate.
|
|
3587
|
+
*/
|
|
3588
|
+
export const listTeammateFolders = (options) => {
|
|
3589
|
+
return (options.client ?? _heyApiClient).get({
|
|
3590
|
+
security: [
|
|
3591
|
+
{
|
|
3592
|
+
scheme: 'bearer',
|
|
3593
|
+
type: 'http'
|
|
3594
|
+
}
|
|
3595
|
+
],
|
|
3596
|
+
url: '/teammates/{teammate_id}/message_template_folders',
|
|
3597
|
+
...options
|
|
3598
|
+
});
|
|
3599
|
+
};
|
|
3600
|
+
/**
|
|
3601
|
+
* Create teammate folder
|
|
3602
|
+
* Create a new message template folder belonging to the requested teammate.
|
|
3603
|
+
*/
|
|
3604
|
+
export const createTeammateFolder = (options) => {
|
|
3605
|
+
return (options.client ?? _heyApiClient).post({
|
|
3606
|
+
security: [
|
|
3607
|
+
{
|
|
3608
|
+
scheme: 'bearer',
|
|
3609
|
+
type: 'http'
|
|
3610
|
+
}
|
|
3611
|
+
],
|
|
3612
|
+
url: '/teammates/{teammate_id}/message_template_folders',
|
|
3613
|
+
...options,
|
|
3614
|
+
headers: {
|
|
3615
|
+
'Content-Type': 'application/json',
|
|
3616
|
+
...options.headers
|
|
3617
|
+
}
|
|
3618
|
+
});
|
|
3619
|
+
};
|
|
3620
|
+
/**
|
|
3621
|
+
* List teammate message templates
|
|
3622
|
+
* List the message templates belonging to the requested teammate.
|
|
3623
|
+
*/
|
|
3624
|
+
export const listTeammateMessageTemplates = (options) => {
|
|
3625
|
+
return (options.client ?? _heyApiClient).get({
|
|
3626
|
+
security: [
|
|
3627
|
+
{
|
|
3628
|
+
scheme: 'bearer',
|
|
3629
|
+
type: 'http'
|
|
3630
|
+
}
|
|
3631
|
+
],
|
|
3632
|
+
url: '/teammates/{teammate_id}/message_templates',
|
|
3633
|
+
...options
|
|
3634
|
+
});
|
|
3635
|
+
};
|
|
3636
|
+
/**
|
|
3637
|
+
* Create teammate message template
|
|
3638
|
+
* Create a new message template for the given teammate
|
|
3639
|
+
*/
|
|
3640
|
+
export const createTeammateMessageTemplate = (options) => {
|
|
3641
|
+
return (options.client ?? _heyApiClient).post({
|
|
3642
|
+
security: [
|
|
3643
|
+
{
|
|
3644
|
+
scheme: 'bearer',
|
|
3645
|
+
type: 'http'
|
|
3646
|
+
}
|
|
3647
|
+
],
|
|
3648
|
+
url: '/teammates/{teammate_id}/message_templates',
|
|
3649
|
+
...options,
|
|
3650
|
+
headers: {
|
|
3651
|
+
'Content-Type': 'application/json',
|
|
3652
|
+
...options.headers
|
|
3653
|
+
}
|
|
3654
|
+
});
|
|
3655
|
+
};
|
|
3656
|
+
/**
|
|
3657
|
+
* List teammate rules
|
|
3658
|
+
* List the rules of a teammate.
|
|
3659
|
+
*/
|
|
3660
|
+
export const listTeammateRules = (options) => {
|
|
3661
|
+
return (options.client ?? _heyApiClient).get({
|
|
3662
|
+
security: [
|
|
3663
|
+
{
|
|
3664
|
+
scheme: 'bearer',
|
|
3665
|
+
type: 'http'
|
|
3666
|
+
}
|
|
3667
|
+
],
|
|
3668
|
+
url: '/teammates/{teammate_id}/rules',
|
|
3669
|
+
...options
|
|
3670
|
+
});
|
|
3671
|
+
};
|
|
3672
|
+
/**
|
|
3673
|
+
* List Teammate Shifts
|
|
3674
|
+
* Lists all the shifts for the teammate.
|
|
3675
|
+
*/
|
|
3676
|
+
export const listTeammateShifts = (options) => {
|
|
3677
|
+
return (options.client ?? _heyApiClient).get({
|
|
3678
|
+
security: [
|
|
3679
|
+
{
|
|
3680
|
+
scheme: 'bearer',
|
|
3681
|
+
type: 'http'
|
|
3682
|
+
}
|
|
3683
|
+
],
|
|
3684
|
+
url: '/teammates/{teammate_id}/shifts',
|
|
3685
|
+
...options
|
|
3686
|
+
});
|
|
3687
|
+
};
|
|
3688
|
+
/**
|
|
3689
|
+
* List teammate signatures
|
|
3690
|
+
* List the signatures belonging to the given teammate.
|
|
3691
|
+
*/
|
|
3692
|
+
export const listTeammateSignatures = (options) => {
|
|
3693
|
+
return (options.client ?? _heyApiClient).get({
|
|
3694
|
+
security: [
|
|
3695
|
+
{
|
|
3696
|
+
scheme: 'bearer',
|
|
3697
|
+
type: 'http'
|
|
3698
|
+
}
|
|
3699
|
+
],
|
|
3700
|
+
url: '/teammates/{teammate_id}/signatures',
|
|
3701
|
+
...options
|
|
3702
|
+
});
|
|
3703
|
+
};
|
|
3704
|
+
/**
|
|
3705
|
+
* Create teammate signature
|
|
3706
|
+
* Create a new signature for the given teammate
|
|
3707
|
+
*/
|
|
3708
|
+
export const createTeammateSignature = (options) => {
|
|
3709
|
+
return (options.client ?? _heyApiClient).post({
|
|
3710
|
+
security: [
|
|
3711
|
+
{
|
|
3712
|
+
scheme: 'bearer',
|
|
3713
|
+
type: 'http'
|
|
3714
|
+
}
|
|
3715
|
+
],
|
|
3716
|
+
url: '/teammates/{teammate_id}/signatures',
|
|
3717
|
+
...options,
|
|
3718
|
+
headers: {
|
|
3719
|
+
'Content-Type': 'application/json',
|
|
3720
|
+
...options.headers
|
|
3721
|
+
}
|
|
3722
|
+
});
|
|
3723
|
+
};
|
|
3724
|
+
/**
|
|
3725
|
+
* List teammate tags
|
|
3726
|
+
* List the tags for a teammate.
|
|
3727
|
+
*/
|
|
3728
|
+
export const listTeammateTags = (options) => {
|
|
3729
|
+
return (options.client ?? _heyApiClient).get({
|
|
3730
|
+
security: [
|
|
3731
|
+
{
|
|
3732
|
+
scheme: 'bearer',
|
|
3733
|
+
type: 'http'
|
|
3734
|
+
}
|
|
3735
|
+
],
|
|
3736
|
+
url: '/teammates/{teammate_id}/tags',
|
|
3737
|
+
...options
|
|
3738
|
+
});
|
|
3739
|
+
};
|
|
3740
|
+
/**
|
|
3741
|
+
* Create teammate tag
|
|
3742
|
+
* Create a tag for a teammate.
|
|
3743
|
+
*/
|
|
3744
|
+
export const createTeammateTag = (options) => {
|
|
3745
|
+
return (options.client ?? _heyApiClient).post({
|
|
3746
|
+
security: [
|
|
3747
|
+
{
|
|
3748
|
+
scheme: 'bearer',
|
|
3749
|
+
type: 'http'
|
|
3750
|
+
}
|
|
3751
|
+
],
|
|
3752
|
+
url: '/teammates/{teammate_id}/tags',
|
|
3753
|
+
...options,
|
|
3754
|
+
headers: {
|
|
3755
|
+
'Content-Type': 'application/json',
|
|
3756
|
+
...options.headers
|
|
3757
|
+
}
|
|
3758
|
+
});
|
|
3759
|
+
};
|
|
3760
|
+
/**
|
|
3761
|
+
* List teams
|
|
3762
|
+
* List the teams (workspaces) in the company.
|
|
3763
|
+
*/
|
|
3764
|
+
export const listTeams = (options) => {
|
|
3765
|
+
return (options?.client ?? _heyApiClient).get({
|
|
3766
|
+
security: [
|
|
3767
|
+
{
|
|
3768
|
+
scheme: 'bearer',
|
|
3769
|
+
type: 'http'
|
|
3770
|
+
}
|
|
3771
|
+
],
|
|
3772
|
+
url: '/teams',
|
|
3773
|
+
...options
|
|
3774
|
+
});
|
|
3775
|
+
};
|
|
3776
|
+
/**
|
|
3777
|
+
* Get team
|
|
3778
|
+
* Fetch a team (workspace).
|
|
3779
|
+
*/
|
|
3780
|
+
export const getTeam = (options) => {
|
|
3781
|
+
return (options.client ?? _heyApiClient).get({
|
|
3782
|
+
security: [
|
|
3783
|
+
{
|
|
3784
|
+
scheme: 'bearer',
|
|
3785
|
+
type: 'http'
|
|
3786
|
+
}
|
|
3787
|
+
],
|
|
3788
|
+
url: '/teams/{team_id}',
|
|
3789
|
+
...options
|
|
3790
|
+
});
|
|
3791
|
+
};
|
|
3792
|
+
/**
|
|
3793
|
+
* List team channels
|
|
3794
|
+
* List the channels of a team (workspace).
|
|
3795
|
+
*/
|
|
3796
|
+
export const listTeamChannels = (options) => {
|
|
3797
|
+
return (options.client ?? _heyApiClient).get({
|
|
3798
|
+
security: [
|
|
3799
|
+
{
|
|
3800
|
+
scheme: 'bearer',
|
|
3801
|
+
type: 'http'
|
|
3802
|
+
}
|
|
3803
|
+
],
|
|
3804
|
+
url: '/teams/{team_id}/channels',
|
|
3805
|
+
...options
|
|
3806
|
+
});
|
|
3807
|
+
};
|
|
3808
|
+
/**
|
|
3809
|
+
* List team groups
|
|
3810
|
+
* List contact groups belonging to the requested team (workspace).
|
|
3811
|
+
*
|
|
3812
|
+
* > ⚠️ Deprecated endpoint
|
|
3813
|
+
* >
|
|
3814
|
+
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
3815
|
+
* > - `GET /teams/{team_id}/contact_lists`.
|
|
3816
|
+
*
|
|
3817
|
+
* @deprecated
|
|
3818
|
+
*/
|
|
3819
|
+
export const listTeamGroups = (options) => {
|
|
3820
|
+
return (options.client ?? _heyApiClient).get({
|
|
3821
|
+
security: [
|
|
3822
|
+
{
|
|
3823
|
+
scheme: 'bearer',
|
|
3824
|
+
type: 'http'
|
|
3825
|
+
}
|
|
3826
|
+
],
|
|
3827
|
+
url: '/teams/{team_id}/contact_groups',
|
|
3828
|
+
...options
|
|
3829
|
+
});
|
|
3830
|
+
};
|
|
3831
|
+
/**
|
|
3832
|
+
* Create team group
|
|
3833
|
+
* Create a new contact group for the requested team (workspace).
|
|
3834
|
+
*
|
|
3835
|
+
* > ⚠️ Deprecated endpoint
|
|
3836
|
+
* >
|
|
3837
|
+
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
3838
|
+
* > - `POST /teams/{team_id}/contact_lists`.
|
|
3839
|
+
*
|
|
3840
|
+
* @deprecated
|
|
3841
|
+
*/
|
|
3842
|
+
export const createTeamGroup = (options) => {
|
|
3843
|
+
return (options.client ?? _heyApiClient).post({
|
|
3844
|
+
security: [
|
|
3845
|
+
{
|
|
3846
|
+
scheme: 'bearer',
|
|
3847
|
+
type: 'http'
|
|
3848
|
+
}
|
|
3849
|
+
],
|
|
3850
|
+
url: '/teams/{team_id}/contact_groups',
|
|
3851
|
+
...options,
|
|
3852
|
+
headers: {
|
|
3853
|
+
'Content-Type': 'application/json',
|
|
3854
|
+
...options.headers
|
|
3855
|
+
}
|
|
3856
|
+
});
|
|
3857
|
+
};
|
|
3858
|
+
/**
|
|
3859
|
+
* List team contact lists
|
|
3860
|
+
* List contact lists belonging to the requested team (workspace).
|
|
3861
|
+
*/
|
|
3862
|
+
export const listTeamContactLists = (options) => {
|
|
3863
|
+
return (options.client ?? _heyApiClient).get({
|
|
3864
|
+
security: [
|
|
3865
|
+
{
|
|
3866
|
+
scheme: 'bearer',
|
|
3867
|
+
type: 'http'
|
|
3868
|
+
}
|
|
3869
|
+
],
|
|
3870
|
+
url: '/teams/{team_id}/contact_lists',
|
|
3871
|
+
...options
|
|
3872
|
+
});
|
|
3873
|
+
};
|
|
3874
|
+
/**
|
|
3875
|
+
* Create team contact list
|
|
3876
|
+
* Create a new contact list for the requested team (workspace).
|
|
3877
|
+
*/
|
|
3878
|
+
export const createTeamContactList = (options) => {
|
|
3879
|
+
return (options.client ?? _heyApiClient).post({
|
|
3880
|
+
security: [
|
|
3881
|
+
{
|
|
3882
|
+
scheme: 'bearer',
|
|
3883
|
+
type: 'http'
|
|
3884
|
+
}
|
|
3885
|
+
],
|
|
3886
|
+
url: '/teams/{team_id}/contact_lists',
|
|
3887
|
+
...options,
|
|
3888
|
+
headers: {
|
|
3889
|
+
'Content-Type': 'application/json',
|
|
3890
|
+
...options.headers
|
|
3891
|
+
}
|
|
3892
|
+
});
|
|
3893
|
+
};
|
|
3894
|
+
/**
|
|
3895
|
+
* List team contacts
|
|
3896
|
+
* List the contacts of a team (workspace).
|
|
3897
|
+
*/
|
|
3898
|
+
export const listTeamContacts = (options) => {
|
|
3899
|
+
return (options.client ?? _heyApiClient).get({
|
|
3900
|
+
security: [
|
|
3901
|
+
{
|
|
3902
|
+
scheme: 'bearer',
|
|
3903
|
+
type: 'http'
|
|
3904
|
+
}
|
|
3905
|
+
],
|
|
3906
|
+
url: '/teams/{team_id}/contacts',
|
|
3907
|
+
...options
|
|
3908
|
+
});
|
|
3909
|
+
};
|
|
3910
|
+
/**
|
|
3911
|
+
* Create team contact
|
|
3912
|
+
* Create a contact for a team (workspace).
|
|
3913
|
+
*/
|
|
3914
|
+
export const createTeamContact = (options) => {
|
|
3915
|
+
return (options.client ?? _heyApiClient).post({
|
|
3916
|
+
security: [
|
|
3917
|
+
{
|
|
3918
|
+
scheme: 'bearer',
|
|
3919
|
+
type: 'http'
|
|
3920
|
+
}
|
|
3921
|
+
],
|
|
3922
|
+
url: '/teams/{team_id}/contacts',
|
|
3923
|
+
...options,
|
|
3924
|
+
headers: {
|
|
3925
|
+
'Content-Type': 'application/json',
|
|
3926
|
+
...options.headers
|
|
3927
|
+
}
|
|
3928
|
+
});
|
|
3929
|
+
};
|
|
3930
|
+
/**
|
|
3931
|
+
* List team inboxes
|
|
3932
|
+
* List the inboxes belonging to a team (workspace).
|
|
3933
|
+
*/
|
|
3934
|
+
export const listTeamInboxes = (options) => {
|
|
3935
|
+
return (options.client ?? _heyApiClient).get({
|
|
3936
|
+
security: [
|
|
3937
|
+
{
|
|
3938
|
+
scheme: 'bearer',
|
|
3939
|
+
type: 'http'
|
|
3940
|
+
}
|
|
3941
|
+
],
|
|
3942
|
+
url: '/teams/{team_id}/inboxes',
|
|
3943
|
+
...options
|
|
3944
|
+
});
|
|
3945
|
+
};
|
|
3946
|
+
/**
|
|
3947
|
+
* Create team inbox
|
|
3948
|
+
* Create an inbox for a team (workspace).
|
|
3949
|
+
*/
|
|
3950
|
+
export const createTeamInbox = (options) => {
|
|
3951
|
+
return (options.client ?? _heyApiClient).post({
|
|
3952
|
+
security: [
|
|
3953
|
+
{
|
|
3954
|
+
scheme: 'bearer',
|
|
3955
|
+
type: 'http'
|
|
3956
|
+
}
|
|
3957
|
+
],
|
|
3958
|
+
url: '/teams/{team_id}/inboxes',
|
|
3959
|
+
...options,
|
|
3960
|
+
headers: {
|
|
3961
|
+
'Content-Type': 'application/json',
|
|
3962
|
+
...options.headers
|
|
3963
|
+
}
|
|
3964
|
+
});
|
|
3965
|
+
};
|
|
3966
|
+
/**
|
|
3967
|
+
* List team folders
|
|
3968
|
+
* List the message template folders belonging to the requested team (workspace).
|
|
3969
|
+
*/
|
|
3970
|
+
export const listTeamFolders = (options) => {
|
|
3971
|
+
return (options.client ?? _heyApiClient).get({
|
|
3972
|
+
security: [
|
|
3973
|
+
{
|
|
3974
|
+
scheme: 'bearer',
|
|
3975
|
+
type: 'http'
|
|
3976
|
+
}
|
|
3977
|
+
],
|
|
3978
|
+
url: '/teams/{team_id}/message_template_folders',
|
|
3979
|
+
...options
|
|
3980
|
+
});
|
|
3981
|
+
};
|
|
3982
|
+
/**
|
|
3983
|
+
* Create team folder
|
|
3984
|
+
* Create a new message template folder belonging to the requested team (workspace).
|
|
3985
|
+
*/
|
|
3986
|
+
export const createTeamFolder = (options) => {
|
|
3987
|
+
return (options.client ?? _heyApiClient).post({
|
|
3988
|
+
security: [
|
|
3989
|
+
{
|
|
3990
|
+
scheme: 'bearer',
|
|
3991
|
+
type: 'http'
|
|
3992
|
+
}
|
|
3993
|
+
],
|
|
3994
|
+
url: '/teams/{team_id}/message_template_folders',
|
|
3995
|
+
...options,
|
|
3996
|
+
headers: {
|
|
3997
|
+
'Content-Type': 'application/json',
|
|
3998
|
+
...options.headers
|
|
3999
|
+
}
|
|
4000
|
+
});
|
|
4001
|
+
};
|
|
4002
|
+
/**
|
|
4003
|
+
* List team message templates
|
|
4004
|
+
* List the message templates belonging to the requested team (workspace).
|
|
4005
|
+
*/
|
|
4006
|
+
export const listTeamMessageTemplates = (options) => {
|
|
4007
|
+
return (options.client ?? _heyApiClient).get({
|
|
4008
|
+
security: [
|
|
4009
|
+
{
|
|
4010
|
+
scheme: 'bearer',
|
|
4011
|
+
type: 'http'
|
|
4012
|
+
}
|
|
4013
|
+
],
|
|
4014
|
+
url: '/teams/{team_id}/message_templates',
|
|
4015
|
+
...options
|
|
4016
|
+
});
|
|
4017
|
+
};
|
|
4018
|
+
/**
|
|
4019
|
+
* Create team message template
|
|
4020
|
+
* Create a new message template for the given team (workspace).
|
|
4021
|
+
*/
|
|
4022
|
+
export const createTeamMessageTemplate = (options) => {
|
|
4023
|
+
return (options.client ?? _heyApiClient).post({
|
|
4024
|
+
security: [
|
|
4025
|
+
{
|
|
4026
|
+
scheme: 'bearer',
|
|
4027
|
+
type: 'http'
|
|
4028
|
+
}
|
|
4029
|
+
],
|
|
4030
|
+
url: '/teams/{team_id}/message_templates',
|
|
4031
|
+
...options,
|
|
4032
|
+
headers: {
|
|
4033
|
+
'Content-Type': 'application/json',
|
|
4034
|
+
...options.headers
|
|
4035
|
+
}
|
|
4036
|
+
});
|
|
4037
|
+
};
|
|
4038
|
+
/**
|
|
4039
|
+
* List team rules
|
|
4040
|
+
* List the rules of a team (workspace).
|
|
4041
|
+
*/
|
|
4042
|
+
export const listTeamRules = (options) => {
|
|
4043
|
+
return (options.client ?? _heyApiClient).get({
|
|
4044
|
+
security: [
|
|
4045
|
+
{
|
|
4046
|
+
scheme: 'bearer',
|
|
4047
|
+
type: 'http'
|
|
4048
|
+
}
|
|
4049
|
+
],
|
|
4050
|
+
url: '/teams/{team_id}/rules',
|
|
4051
|
+
...options
|
|
4052
|
+
});
|
|
4053
|
+
};
|
|
4054
|
+
/**
|
|
4055
|
+
* List team Shifts
|
|
4056
|
+
* List the shifts for a team (workspace).
|
|
4057
|
+
*/
|
|
4058
|
+
export const listTeamShifts = (options) => {
|
|
4059
|
+
return (options.client ?? _heyApiClient).get({
|
|
4060
|
+
security: [
|
|
4061
|
+
{
|
|
4062
|
+
scheme: 'bearer',
|
|
4063
|
+
type: 'http'
|
|
4064
|
+
}
|
|
4065
|
+
],
|
|
4066
|
+
url: '/teams/{team_id}/shifts',
|
|
4067
|
+
...options
|
|
4068
|
+
});
|
|
4069
|
+
};
|
|
4070
|
+
/**
|
|
4071
|
+
* Create team shift
|
|
4072
|
+
* Create a shift for a team (workspace).
|
|
4073
|
+
*/
|
|
4074
|
+
export const createTeamShift = (options) => {
|
|
4075
|
+
return (options.client ?? _heyApiClient).post({
|
|
4076
|
+
security: [
|
|
4077
|
+
{
|
|
4078
|
+
scheme: 'bearer',
|
|
4079
|
+
type: 'http'
|
|
4080
|
+
}
|
|
4081
|
+
],
|
|
4082
|
+
url: '/teams/{team_id}/shifts',
|
|
4083
|
+
...options,
|
|
4084
|
+
headers: {
|
|
4085
|
+
'Content-Type': 'application/json',
|
|
4086
|
+
...options.headers
|
|
4087
|
+
}
|
|
4088
|
+
});
|
|
4089
|
+
};
|
|
4090
|
+
/**
|
|
4091
|
+
* List team signatures
|
|
4092
|
+
* List the signatures belonging to the given team (workspace).
|
|
4093
|
+
*/
|
|
4094
|
+
export const listTeamSignatures = (options) => {
|
|
4095
|
+
return (options.client ?? _heyApiClient).get({
|
|
4096
|
+
security: [
|
|
4097
|
+
{
|
|
4098
|
+
scheme: 'bearer',
|
|
4099
|
+
type: 'http'
|
|
4100
|
+
}
|
|
4101
|
+
],
|
|
4102
|
+
url: '/teams/{team_id}/signatures',
|
|
4103
|
+
...options
|
|
4104
|
+
});
|
|
4105
|
+
};
|
|
4106
|
+
/**
|
|
4107
|
+
* Create team signature
|
|
4108
|
+
* Create a new signature for the given team (workspace).
|
|
4109
|
+
*/
|
|
4110
|
+
export const createTeamSignature = (options) => {
|
|
4111
|
+
return (options.client ?? _heyApiClient).post({
|
|
4112
|
+
security: [
|
|
4113
|
+
{
|
|
4114
|
+
scheme: 'bearer',
|
|
4115
|
+
type: 'http'
|
|
4116
|
+
}
|
|
4117
|
+
],
|
|
4118
|
+
url: '/teams/{team_id}/signatures',
|
|
4119
|
+
...options,
|
|
4120
|
+
headers: {
|
|
4121
|
+
'Content-Type': 'application/json',
|
|
4122
|
+
...options.headers
|
|
4123
|
+
}
|
|
4124
|
+
});
|
|
4125
|
+
};
|
|
4126
|
+
/**
|
|
4127
|
+
* List team tags
|
|
4128
|
+
* List the tags for a team (workspace).
|
|
4129
|
+
*/
|
|
4130
|
+
export const listTeamTags = (options) => {
|
|
4131
|
+
return (options.client ?? _heyApiClient).get({
|
|
4132
|
+
security: [
|
|
4133
|
+
{
|
|
4134
|
+
scheme: 'bearer',
|
|
4135
|
+
type: 'http'
|
|
4136
|
+
}
|
|
4137
|
+
],
|
|
4138
|
+
url: '/teams/{team_id}/tags',
|
|
4139
|
+
...options
|
|
4140
|
+
});
|
|
4141
|
+
};
|
|
4142
|
+
/**
|
|
4143
|
+
* Create team tag
|
|
4144
|
+
* Create a tag for a team (workspace).
|
|
4145
|
+
*/
|
|
4146
|
+
export const createTeamTag = (options) => {
|
|
4147
|
+
return (options.client ?? _heyApiClient).post({
|
|
4148
|
+
security: [
|
|
4149
|
+
{
|
|
4150
|
+
scheme: 'bearer',
|
|
4151
|
+
type: 'http'
|
|
4152
|
+
}
|
|
4153
|
+
],
|
|
4154
|
+
url: '/teams/{team_id}/tags',
|
|
4155
|
+
...options,
|
|
4156
|
+
headers: {
|
|
4157
|
+
'Content-Type': 'application/json',
|
|
4158
|
+
...options.headers
|
|
4159
|
+
}
|
|
4160
|
+
});
|
|
4161
|
+
};
|
|
4162
|
+
/**
|
|
4163
|
+
* Remove teammates from team
|
|
4164
|
+
* Remove one or more teammates from a team (workspace).
|
|
4165
|
+
*/
|
|
4166
|
+
export const removeTeammatesFromTeam = (options) => {
|
|
4167
|
+
return (options.client ?? _heyApiClient).delete({
|
|
4168
|
+
security: [
|
|
4169
|
+
{
|
|
4170
|
+
scheme: 'bearer',
|
|
4171
|
+
type: 'http'
|
|
4172
|
+
}
|
|
4173
|
+
],
|
|
4174
|
+
url: '/teams/{team_id}/teammates',
|
|
4175
|
+
...options,
|
|
4176
|
+
headers: {
|
|
4177
|
+
'Content-Type': 'application/json',
|
|
4178
|
+
...options.headers
|
|
4179
|
+
}
|
|
4180
|
+
});
|
|
4181
|
+
};
|
|
4182
|
+
/**
|
|
4183
|
+
* Add teammates to team
|
|
4184
|
+
* Add one or more teammates to a team (workspace).
|
|
4185
|
+
*/
|
|
4186
|
+
export const addTeammatesToTeam = (options) => {
|
|
4187
|
+
return (options.client ?? _heyApiClient).post({
|
|
4188
|
+
security: [
|
|
4189
|
+
{
|
|
4190
|
+
scheme: 'bearer',
|
|
4191
|
+
type: 'http'
|
|
4192
|
+
}
|
|
4193
|
+
],
|
|
4194
|
+
url: '/teams/{team_id}/teammates',
|
|
4195
|
+
...options,
|
|
4196
|
+
headers: {
|
|
4197
|
+
'Content-Type': 'application/json',
|
|
4198
|
+
...options.headers
|
|
4199
|
+
}
|
|
4200
|
+
});
|
|
4201
|
+
};
|
|
4202
|
+
//# sourceMappingURL=sdk.gen.js.map
|