@outseta/api-client 0.3.39 → 0.3.41
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/dist/index.js +173 -1
- package/package.json +1 -1
- package/src/generated/attribute/attribute.ts +17 -8
- package/src/generated/crm/crm.ts +241 -1
- package/src/generated/email/email.ts +240 -0
- package/src/generated/models/accountAllOf.ts +3 -0
- package/src/generated/models/accountWebhookEntity.ts +3 -0
- package/src/generated/models/accountWebhookEntityCurrentStripeProductInstancesItem.ts +85 -0
- package/src/generated/models/accountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode.ts +13 -0
- package/src/generated/models/articleAddTagToEntityBody.ts +7 -0
- package/src/generated/models/articleAllOf.ts +3 -0
- package/src/generated/models/articleGetAllArticlesParams.ts +8 -0
- package/src/generated/models/articleGetTagsForEntity200.ts +8 -0
- package/src/generated/models/articleGetTagsForEntityParams.ts +14 -0
- package/src/generated/models/articleSetTagsForEntityBody.ts +7 -0
- package/src/generated/models/campaignAddTagToEntityBody.ts +7 -0
- package/src/generated/models/campaignGetAllBroadcastEmailsParams.ts +8 -0
- package/src/generated/models/campaignGetTagsForEntity200.ts +8 -0
- package/src/generated/models/campaignGetTagsForEntityParams.ts +14 -0
- package/src/generated/models/campaignSetTagsForEntityBody.ts +7 -0
- package/src/generated/models/crmSettingsAllOf.ts +0 -1
- package/src/generated/models/entityType.ts +2 -1
- package/src/generated/models/index.ts +14 -0
- package/src/generated/models/segmentAddTagToEntityBody.ts +7 -0
- package/src/generated/models/segmentGetTagsForEntity200.ts +8 -0
- package/src/generated/models/segmentGetTagsForEntityParams.ts +14 -0
- package/src/generated/models/segmentSetTagsForEntityBody.ts +7 -0
- package/src/generated/models/stripeProductAllOf.ts +2 -0
- package/src/generated/models/supportSettingsAllOf.ts +2 -0
- package/src/generated/support/support.ts +240 -0
|
@@ -2,9 +2,13 @@
|
|
|
2
2
|
import type {
|
|
3
3
|
BroadcastCampaign,
|
|
4
4
|
CampaignAddBroadcastEmailBody,
|
|
5
|
+
CampaignAddTagToEntityBody,
|
|
5
6
|
CampaignGetAllBroadcastEmails200,
|
|
6
7
|
CampaignGetAllBroadcastEmailsParams,
|
|
8
|
+
CampaignGetTagsForEntity200,
|
|
9
|
+
CampaignGetTagsForEntityParams,
|
|
7
10
|
CampaignSendTestCampaignEmailBody,
|
|
11
|
+
CampaignSetTagsForEntityBody,
|
|
8
12
|
CampaignUpdateBroadcastEmailBody,
|
|
9
13
|
DripCampaign,
|
|
10
14
|
DripCampaignAddDripCampaignBody,
|
|
@@ -1047,6 +1051,242 @@ export const campaignSendTestCampaignEmail = async (campaignSendTestCampaignEmai
|
|
|
1047
1051
|
);}
|
|
1048
1052
|
|
|
1049
1053
|
|
|
1054
|
+
/**
|
|
1055
|
+
* Send the uids of the tags to add. Tags that the record already carries stay on it, and
|
|
1056
|
+
naming one of them again changes nothing, so the same request is safe to repeat. To
|
|
1057
|
+
replace the whole set instead, use PUT on this same path.
|
|
1058
|
+
|
|
1059
|
+
A tag belongs to one entity type, so use tags whose EntityType matches this record.
|
|
1060
|
+
List them with GET /attribute/tags. A uid in the list that names no tag is skipped.
|
|
1061
|
+
* @summary Add tags to a record.
|
|
1062
|
+
*/
|
|
1063
|
+
export type campaignAddTagToEntityResponse200 = {
|
|
1064
|
+
data: Blob
|
|
1065
|
+
status: 200
|
|
1066
|
+
}
|
|
1067
|
+
|
|
1068
|
+
export type campaignAddTagToEntityResponse400 = {
|
|
1069
|
+
data: void
|
|
1070
|
+
status: 400
|
|
1071
|
+
}
|
|
1072
|
+
|
|
1073
|
+
export type campaignAddTagToEntityResponse401 = {
|
|
1074
|
+
data: void
|
|
1075
|
+
status: 401
|
|
1076
|
+
}
|
|
1077
|
+
|
|
1078
|
+
export type campaignAddTagToEntityResponse404 = {
|
|
1079
|
+
data: void
|
|
1080
|
+
status: 404
|
|
1081
|
+
}
|
|
1082
|
+
|
|
1083
|
+
export type campaignAddTagToEntityResponseSuccess = (campaignAddTagToEntityResponse200) & {
|
|
1084
|
+
headers: Headers;
|
|
1085
|
+
};
|
|
1086
|
+
export type campaignAddTagToEntityResponseError = (campaignAddTagToEntityResponse400 | campaignAddTagToEntityResponse401 | campaignAddTagToEntityResponse404) & {
|
|
1087
|
+
headers: Headers;
|
|
1088
|
+
};
|
|
1089
|
+
|
|
1090
|
+
export type campaignAddTagToEntityResponse = (campaignAddTagToEntityResponseSuccess | campaignAddTagToEntityResponseError)
|
|
1091
|
+
|
|
1092
|
+
export const getCampaignAddTagToEntityUrl = (entityUid: string | null,) => {
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
return `/api/v1/email/campaigns/broadcasts/${entityUid}/tags`
|
|
1098
|
+
}
|
|
1099
|
+
|
|
1100
|
+
export const campaignAddTagToEntity = async (entityUid: string | null,
|
|
1101
|
+
campaignAddTagToEntityBody: CampaignAddTagToEntityBody, options?: RequestInit): Promise<campaignAddTagToEntityResponse> => {
|
|
1102
|
+
|
|
1103
|
+
return customFetch<campaignAddTagToEntityResponse>(getCampaignAddTagToEntityUrl(entityUid),
|
|
1104
|
+
{
|
|
1105
|
+
...options,
|
|
1106
|
+
method: 'POST',
|
|
1107
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
1108
|
+
body: JSON.stringify(
|
|
1109
|
+
campaignAddTagToEntityBody,)
|
|
1110
|
+
}
|
|
1111
|
+
);}
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
/**
|
|
1115
|
+
* Returns the tags themselves, not the links that hold them. The same tags are also
|
|
1116
|
+
available on the record: ask for them with the fields parameter, for example
|
|
1117
|
+
fields=Uid,Tags.Uid,Tags.Name,Tags.TagColor. Tags cost an extra query, so the record
|
|
1118
|
+
leaves them out unless fields names Tags or is a plain wildcard.
|
|
1119
|
+
* @summary Retrieve the tags on a record.
|
|
1120
|
+
*/
|
|
1121
|
+
export type campaignGetTagsForEntityResponse200 = {
|
|
1122
|
+
data: CampaignGetTagsForEntity200
|
|
1123
|
+
status: 200
|
|
1124
|
+
}
|
|
1125
|
+
|
|
1126
|
+
export type campaignGetTagsForEntityResponse400 = {
|
|
1127
|
+
data: void
|
|
1128
|
+
status: 400
|
|
1129
|
+
}
|
|
1130
|
+
|
|
1131
|
+
export type campaignGetTagsForEntityResponse401 = {
|
|
1132
|
+
data: void
|
|
1133
|
+
status: 401
|
|
1134
|
+
}
|
|
1135
|
+
|
|
1136
|
+
export type campaignGetTagsForEntityResponseSuccess = (campaignGetTagsForEntityResponse200) & {
|
|
1137
|
+
headers: Headers;
|
|
1138
|
+
};
|
|
1139
|
+
export type campaignGetTagsForEntityResponseError = (campaignGetTagsForEntityResponse400 | campaignGetTagsForEntityResponse401) & {
|
|
1140
|
+
headers: Headers;
|
|
1141
|
+
};
|
|
1142
|
+
|
|
1143
|
+
export type campaignGetTagsForEntityResponse = (campaignGetTagsForEntityResponseSuccess | campaignGetTagsForEntityResponseError)
|
|
1144
|
+
|
|
1145
|
+
export const getCampaignGetTagsForEntityUrl = (entityUid: string | null,
|
|
1146
|
+
params?: CampaignGetTagsForEntityParams,) => {
|
|
1147
|
+
const normalizedParams = new URLSearchParams();
|
|
1148
|
+
|
|
1149
|
+
Object.entries(params || {}).forEach(([key, value]) => {
|
|
1150
|
+
|
|
1151
|
+
if (value !== undefined) {
|
|
1152
|
+
normalizedParams.append(key, value === null ? 'null' : value.toString())
|
|
1153
|
+
}
|
|
1154
|
+
});
|
|
1155
|
+
|
|
1156
|
+
const stringifiedParams = normalizedParams.toString();
|
|
1157
|
+
|
|
1158
|
+
return stringifiedParams.length > 0 ? `/api/v1/email/campaigns/broadcasts/${entityUid}/tags?${stringifiedParams}` : `/api/v1/email/campaigns/broadcasts/${entityUid}/tags`
|
|
1159
|
+
}
|
|
1160
|
+
|
|
1161
|
+
export const campaignGetTagsForEntity = async (entityUid: string | null,
|
|
1162
|
+
params?: CampaignGetTagsForEntityParams, options?: RequestInit): Promise<campaignGetTagsForEntityResponse> => {
|
|
1163
|
+
|
|
1164
|
+
return customFetch<campaignGetTagsForEntityResponse>(getCampaignGetTagsForEntityUrl(entityUid,params),
|
|
1165
|
+
{
|
|
1166
|
+
...options,
|
|
1167
|
+
method: 'GET'
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
}
|
|
1171
|
+
);}
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
/**
|
|
1175
|
+
* Send the full set of tags the record must end with. A tag that the list leaves out is
|
|
1176
|
+
taken off the record, and one that the list names is added. Send an empty list to take
|
|
1177
|
+
every tag off. To add tags without disturbing the others, use POST on this same path.
|
|
1178
|
+
|
|
1179
|
+
A tag belongs to one entity type, so use tags whose EntityType matches this record.
|
|
1180
|
+
List them with GET /attribute/tags. A uid in the list that names no tag is skipped.
|
|
1181
|
+
* @summary Replace the tags on a record.
|
|
1182
|
+
*/
|
|
1183
|
+
export type campaignSetTagsForEntityResponse200 = {
|
|
1184
|
+
data: Blob
|
|
1185
|
+
status: 200
|
|
1186
|
+
}
|
|
1187
|
+
|
|
1188
|
+
export type campaignSetTagsForEntityResponse400 = {
|
|
1189
|
+
data: void
|
|
1190
|
+
status: 400
|
|
1191
|
+
}
|
|
1192
|
+
|
|
1193
|
+
export type campaignSetTagsForEntityResponse401 = {
|
|
1194
|
+
data: void
|
|
1195
|
+
status: 401
|
|
1196
|
+
}
|
|
1197
|
+
|
|
1198
|
+
export type campaignSetTagsForEntityResponse404 = {
|
|
1199
|
+
data: void
|
|
1200
|
+
status: 404
|
|
1201
|
+
}
|
|
1202
|
+
|
|
1203
|
+
export type campaignSetTagsForEntityResponseSuccess = (campaignSetTagsForEntityResponse200) & {
|
|
1204
|
+
headers: Headers;
|
|
1205
|
+
};
|
|
1206
|
+
export type campaignSetTagsForEntityResponseError = (campaignSetTagsForEntityResponse400 | campaignSetTagsForEntityResponse401 | campaignSetTagsForEntityResponse404) & {
|
|
1207
|
+
headers: Headers;
|
|
1208
|
+
};
|
|
1209
|
+
|
|
1210
|
+
export type campaignSetTagsForEntityResponse = (campaignSetTagsForEntityResponseSuccess | campaignSetTagsForEntityResponseError)
|
|
1211
|
+
|
|
1212
|
+
export const getCampaignSetTagsForEntityUrl = (entityUid: string | null,) => {
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
return `/api/v1/email/campaigns/broadcasts/${entityUid}/tags`
|
|
1218
|
+
}
|
|
1219
|
+
|
|
1220
|
+
export const campaignSetTagsForEntity = async (entityUid: string | null,
|
|
1221
|
+
campaignSetTagsForEntityBody: CampaignSetTagsForEntityBody, options?: RequestInit): Promise<campaignSetTagsForEntityResponse> => {
|
|
1222
|
+
|
|
1223
|
+
return customFetch<campaignSetTagsForEntityResponse>(getCampaignSetTagsForEntityUrl(entityUid),
|
|
1224
|
+
{
|
|
1225
|
+
...options,
|
|
1226
|
+
method: 'PUT',
|
|
1227
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
1228
|
+
body: JSON.stringify(
|
|
1229
|
+
campaignSetTagsForEntityBody,)
|
|
1230
|
+
}
|
|
1231
|
+
);}
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
/**
|
|
1235
|
+
* The tag itself is kept and stays available for other records. If the record does not
|
|
1236
|
+
carry the tag, nothing changes and the call still succeeds.
|
|
1237
|
+
* @summary Remove one tag from a record.
|
|
1238
|
+
*/
|
|
1239
|
+
export type campaignRemoveTagFromEntityResponse200 = {
|
|
1240
|
+
data: Blob
|
|
1241
|
+
status: 200
|
|
1242
|
+
}
|
|
1243
|
+
|
|
1244
|
+
export type campaignRemoveTagFromEntityResponse400 = {
|
|
1245
|
+
data: void
|
|
1246
|
+
status: 400
|
|
1247
|
+
}
|
|
1248
|
+
|
|
1249
|
+
export type campaignRemoveTagFromEntityResponse401 = {
|
|
1250
|
+
data: void
|
|
1251
|
+
status: 401
|
|
1252
|
+
}
|
|
1253
|
+
|
|
1254
|
+
export type campaignRemoveTagFromEntityResponse404 = {
|
|
1255
|
+
data: void
|
|
1256
|
+
status: 404
|
|
1257
|
+
}
|
|
1258
|
+
|
|
1259
|
+
export type campaignRemoveTagFromEntityResponseSuccess = (campaignRemoveTagFromEntityResponse200) & {
|
|
1260
|
+
headers: Headers;
|
|
1261
|
+
};
|
|
1262
|
+
export type campaignRemoveTagFromEntityResponseError = (campaignRemoveTagFromEntityResponse400 | campaignRemoveTagFromEntityResponse401 | campaignRemoveTagFromEntityResponse404) & {
|
|
1263
|
+
headers: Headers;
|
|
1264
|
+
};
|
|
1265
|
+
|
|
1266
|
+
export type campaignRemoveTagFromEntityResponse = (campaignRemoveTagFromEntityResponseSuccess | campaignRemoveTagFromEntityResponseError)
|
|
1267
|
+
|
|
1268
|
+
export const getCampaignRemoveTagFromEntityUrl = (entityUid: string | null,
|
|
1269
|
+
tagUid: string | null,) => {
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
return `/api/v1/email/campaigns/broadcasts/${entityUid}/tags/${tagUid}`
|
|
1275
|
+
}
|
|
1276
|
+
|
|
1277
|
+
export const campaignRemoveTagFromEntity = async (entityUid: string | null,
|
|
1278
|
+
tagUid: string | null, options?: RequestInit): Promise<campaignRemoveTagFromEntityResponse> => {
|
|
1279
|
+
|
|
1280
|
+
return customFetch<campaignRemoveTagFromEntityResponse>(getCampaignRemoveTagFromEntityUrl(entityUid,tagUid),
|
|
1281
|
+
{
|
|
1282
|
+
...options,
|
|
1283
|
+
method: 'DELETE'
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
}
|
|
1287
|
+
);}
|
|
1288
|
+
|
|
1289
|
+
|
|
1050
1290
|
/**
|
|
1051
1291
|
* @summary Retrieve all email lists.
|
|
1052
1292
|
*/
|
|
@@ -10,6 +10,7 @@ import type { StripeSubscription } from './stripeSubscription';
|
|
|
10
10
|
import type { Subscription } from './subscription';
|
|
11
11
|
import type { Deal } from './deal';
|
|
12
12
|
import type { AccountTaxId } from './accountTaxId';
|
|
13
|
+
import type { StripeProduct } from './stripeProduct';
|
|
13
14
|
import type { AccountAllOfCurrentSubscription } from './accountAllOfCurrentSubscription';
|
|
14
15
|
import type { AccountAllOfLatestSubscription } from './accountAllOfLatestSubscription';
|
|
15
16
|
import type { AccountAllOfPrimaryContact } from './accountAllOfPrimaryContact';
|
|
@@ -130,6 +131,8 @@ export type AccountAllOf = {
|
|
|
130
131
|
/** @nullable */
|
|
131
132
|
CurrentStripeProducts?: string | null;
|
|
132
133
|
/** @nullable */
|
|
134
|
+
CurrentStripeProductInstances?: StripeProduct[] | null;
|
|
135
|
+
/** @nullable */
|
|
133
136
|
CurrentSubscription?: AccountAllOfCurrentSubscription;
|
|
134
137
|
/** @nullable */
|
|
135
138
|
DomainName?: string | null;
|
|
@@ -10,6 +10,7 @@ import type { AccountWebhookEntityStripeSubscriptionsItem } from './accountWebho
|
|
|
10
10
|
import type { AccountWebhookEntitySubscriptionsItem } from './accountWebhookEntitySubscriptionsItem';
|
|
11
11
|
import type { AccountWebhookEntityDealsItem } from './accountWebhookEntityDealsItem';
|
|
12
12
|
import type { AccountWebhookEntityTaxIdsItem } from './accountWebhookEntityTaxIdsItem';
|
|
13
|
+
import type { AccountWebhookEntityCurrentStripeProductInstancesItem } from './accountWebhookEntityCurrentStripeProductInstancesItem';
|
|
13
14
|
import type { AccountWebhookEntityCurrentSubscription } from './accountWebhookEntityCurrentSubscription';
|
|
14
15
|
import type { AccountWebhookEntityLatestSubscription } from './accountWebhookEntityLatestSubscription';
|
|
15
16
|
import type { AccountWebhookEntityPrimaryContact } from './accountWebhookEntityPrimaryContact';
|
|
@@ -148,6 +149,8 @@ export interface AccountWebhookEntity {
|
|
|
148
149
|
/** @nullable */
|
|
149
150
|
CurrentStripeProducts?: string | null;
|
|
150
151
|
/** @nullable */
|
|
152
|
+
CurrentStripeProductInstances?: AccountWebhookEntityCurrentStripeProductInstancesItem[] | null;
|
|
153
|
+
/** @nullable */
|
|
151
154
|
CurrentSubscription?: AccountWebhookEntityCurrentSubscription;
|
|
152
155
|
/** @nullable */
|
|
153
156
|
DomainName?: string | null;
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
import type { AccountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode } from './accountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode';
|
|
3
|
+
|
|
4
|
+
export type AccountWebhookEntityCurrentStripeProductInstancesItem = {
|
|
5
|
+
/**
|
|
6
|
+
* @maxLength 10
|
|
7
|
+
* @nullable
|
|
8
|
+
*/
|
|
9
|
+
Uid?: string | null;
|
|
10
|
+
/** @nullable */
|
|
11
|
+
_objectType?: string | null;
|
|
12
|
+
/** @minLength 1 */
|
|
13
|
+
Created: string;
|
|
14
|
+
/** @minLength 1 */
|
|
15
|
+
Updated: string;
|
|
16
|
+
/**
|
|
17
|
+
* @maxLength 255
|
|
18
|
+
* @nullable
|
|
19
|
+
*/
|
|
20
|
+
StripeId?: string | null;
|
|
21
|
+
IsLivemode?: boolean;
|
|
22
|
+
/**
|
|
23
|
+
* @maxLength 250
|
|
24
|
+
* @nullable
|
|
25
|
+
*/
|
|
26
|
+
Name?: string | null;
|
|
27
|
+
/**
|
|
28
|
+
* @maxLength 255
|
|
29
|
+
* @nullable
|
|
30
|
+
*/
|
|
31
|
+
DefaultPriceId?: string | null;
|
|
32
|
+
/** @nullable */
|
|
33
|
+
Description?: string | null;
|
|
34
|
+
IsActive?: boolean;
|
|
35
|
+
/**
|
|
36
|
+
* @maxLength 36
|
|
37
|
+
* @nullable
|
|
38
|
+
*/
|
|
39
|
+
TaxCodeId?: string | null;
|
|
40
|
+
/**
|
|
41
|
+
* @maxLength 250
|
|
42
|
+
* @nullable
|
|
43
|
+
*/
|
|
44
|
+
UnitLabel?: string | null;
|
|
45
|
+
/** `1` - Individual, `2` - Team */
|
|
46
|
+
AccountRegistrationMode?: AccountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode;
|
|
47
|
+
ExpiresAfterMonths?: number;
|
|
48
|
+
/** @nullable */
|
|
49
|
+
ExpirationDate?: string | null;
|
|
50
|
+
IsPerUser?: boolean;
|
|
51
|
+
IsQuantityEditable?: boolean;
|
|
52
|
+
/** @nullable */
|
|
53
|
+
MaximumPeople?: number | null;
|
|
54
|
+
/**
|
|
55
|
+
* @maxLength 8
|
|
56
|
+
* @nullable
|
|
57
|
+
*/
|
|
58
|
+
MigratedAddOnUid?: string | null;
|
|
59
|
+
/**
|
|
60
|
+
* @maxLength 8
|
|
61
|
+
* @nullable
|
|
62
|
+
*/
|
|
63
|
+
MigratedPlanUid?: string | null;
|
|
64
|
+
/** @nullable */
|
|
65
|
+
MinimumQuantity?: number | null;
|
|
66
|
+
/**
|
|
67
|
+
* @maxLength 250
|
|
68
|
+
* @nullable
|
|
69
|
+
*/
|
|
70
|
+
PostLoginPath?: string | null;
|
|
71
|
+
/**
|
|
72
|
+
* @maxLength 500
|
|
73
|
+
* @nullable
|
|
74
|
+
*/
|
|
75
|
+
PostPurchaseUrl?: string | null;
|
|
76
|
+
RequirePaymentInformation?: boolean;
|
|
77
|
+
TrialPeriodDays?: number;
|
|
78
|
+
/** @nullable */
|
|
79
|
+
TrialUntilDate?: string | null;
|
|
80
|
+
CanDelete?: boolean;
|
|
81
|
+
NumberOfPurchases?: number;
|
|
82
|
+
NumberOfSubscriptions?: number;
|
|
83
|
+
/** @nullable */
|
|
84
|
+
Quantity?: number | null;
|
|
85
|
+
};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* `1` - Individual, `2` - Team
|
|
5
|
+
*/
|
|
6
|
+
export type AccountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode = typeof AccountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode[keyof typeof AccountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode];
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
10
|
+
export const AccountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode = {
|
|
11
|
+
Individual: 1,
|
|
12
|
+
Team: 2,
|
|
13
|
+
} as const;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
// @ts-nocheck
|
|
2
2
|
import type { SupportArticleStatus } from './supportArticleStatus';
|
|
3
3
|
import type { ArticleAllOfCategory } from './articleAllOfCategory';
|
|
4
|
+
import type { Tag } from './tag';
|
|
4
5
|
|
|
5
6
|
export type ArticleAllOf = {
|
|
6
7
|
Weight?: number;
|
|
@@ -23,4 +24,6 @@ export type ArticleAllOf = {
|
|
|
23
24
|
* @nullable
|
|
24
25
|
*/
|
|
25
26
|
Keywords?: string | null;
|
|
27
|
+
/** @nullable */
|
|
28
|
+
Tags?: Tag[] | null;
|
|
26
29
|
};
|
|
@@ -8,6 +8,14 @@ export type ArticleGetAllArticlesParams = {
|
|
|
8
8
|
* @nullable
|
|
9
9
|
*/
|
|
10
10
|
q?: string | null;
|
|
11
|
+
/**
|
|
12
|
+
* Keep only the records that carry one of these tags. Separate several tag uids with commas. The value none keeps the records that carry no tag at all.
|
|
13
|
+
*/
|
|
14
|
+
tagUid?: string;
|
|
15
|
+
/**
|
|
16
|
+
* Keep only the records that carry none of these tags. Separate several tag uids with commas. Combined with tagUid, the two widen the result instead of narrowing it: a record is kept when it matches either one.
|
|
17
|
+
*/
|
|
18
|
+
withoutTagUid?: string;
|
|
11
19
|
/**
|
|
12
20
|
* Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
|
|
13
21
|
*/
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
import type { LimitParameter } from './limitParameter';
|
|
3
|
+
import type { OffsetParameter } from './offsetParameter';
|
|
4
|
+
|
|
5
|
+
export type ArticleGetTagsForEntityParams = {
|
|
6
|
+
/**
|
|
7
|
+
* Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
|
|
8
|
+
*/
|
|
9
|
+
limit?: LimitParameter;
|
|
10
|
+
/**
|
|
11
|
+
* Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
|
|
12
|
+
*/
|
|
13
|
+
offset?: OffsetParameter;
|
|
14
|
+
};
|
|
@@ -3,6 +3,14 @@ import type { LimitParameter } from './limitParameter';
|
|
|
3
3
|
import type { OffsetParameter } from './offsetParameter';
|
|
4
4
|
|
|
5
5
|
export type CampaignGetAllBroadcastEmailsParams = {
|
|
6
|
+
/**
|
|
7
|
+
* Keep only the records that carry one of these tags. Separate several tag uids with commas. The value none keeps the records that carry no tag at all.
|
|
8
|
+
*/
|
|
9
|
+
tagUid?: string;
|
|
10
|
+
/**
|
|
11
|
+
* Keep only the records that carry none of these tags. Separate several tag uids with commas. Combined with tagUid, the two widen the result instead of narrowing it: a record is kept when it matches either one.
|
|
12
|
+
*/
|
|
13
|
+
withoutTagUid?: string;
|
|
6
14
|
/**
|
|
7
15
|
* Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
|
|
8
16
|
*/
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
import type { LimitParameter } from './limitParameter';
|
|
3
|
+
import type { OffsetParameter } from './offsetParameter';
|
|
4
|
+
|
|
5
|
+
export type CampaignGetTagsForEntityParams = {
|
|
6
|
+
/**
|
|
7
|
+
* Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
|
|
8
|
+
*/
|
|
9
|
+
limit?: LimitParameter;
|
|
10
|
+
/**
|
|
11
|
+
* Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
|
|
12
|
+
*/
|
|
13
|
+
offset?: OffsetParameter;
|
|
14
|
+
};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// @ts-nocheck
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* `0` - None, `1` - Account, `2` - Person, `3` - Deal, `4` - Case, `5` - Invoice, `6` - EmailLog, `7` - Plan, `8` - DiscountCoupon, `9` - AddOn, `10` - Task, `11` - Segment, `12` - Broadcast
|
|
4
|
+
* `0` - None, `1` - Account, `2` - Person, `3` - Deal, `4` - Case, `5` - Invoice, `6` - EmailLog, `7` - Plan, `8` - DiscountCoupon, `9` - AddOn, `10` - Task, `11` - Segment, `12` - Broadcast, `13` - Article
|
|
5
5
|
*/
|
|
6
6
|
export type EntityType = typeof EntityType[keyof typeof EntityType];
|
|
7
7
|
|
|
@@ -21,4 +21,5 @@ export const EntityType = {
|
|
|
21
21
|
Task: 10,
|
|
22
22
|
Segment: 11,
|
|
23
23
|
Broadcast: 12,
|
|
24
|
+
Article: 13,
|
|
24
25
|
} as const;
|
|
@@ -133,6 +133,8 @@ export * from './accountUpdatedWebhookPayload';
|
|
|
133
133
|
export * from './accountWebhookEntity';
|
|
134
134
|
export * from './accountWebhookEntityAccountStage';
|
|
135
135
|
export * from './accountWebhookEntityBillingAddress';
|
|
136
|
+
export * from './accountWebhookEntityCurrentStripeProductInstancesItem';
|
|
137
|
+
export * from './accountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode';
|
|
136
138
|
export * from './accountWebhookEntityCurrentSubscription';
|
|
137
139
|
export * from './accountWebhookEntityCurrentSubscriptionBillingRenewalTerm';
|
|
138
140
|
export * from './accountWebhookEntityCurrentSubscriptionDiscountCouponSubscriptionsItem';
|
|
@@ -227,10 +229,14 @@ export * from './apiKeyAllOfQcount';
|
|
|
227
229
|
export * from './apiKeyType';
|
|
228
230
|
export * from './article';
|
|
229
231
|
export * from './articleAddArticleBody';
|
|
232
|
+
export * from './articleAddTagToEntityBody';
|
|
230
233
|
export * from './articleAllOf';
|
|
231
234
|
export * from './articleAllOfCategory';
|
|
232
235
|
export * from './articleGetAllArticles200';
|
|
233
236
|
export * from './articleGetAllArticlesParams';
|
|
237
|
+
export * from './articleGetTagsForEntity200';
|
|
238
|
+
export * from './articleGetTagsForEntityParams';
|
|
239
|
+
export * from './articleSetTagsForEntityBody';
|
|
234
240
|
export * from './authGetTokenParams';
|
|
235
241
|
export * from './authMagicLinkTokenParams';
|
|
236
242
|
export * from './authResendTwoFactorParams';
|
|
@@ -252,10 +258,14 @@ export * from './broadcastCampaignAllOfMessage';
|
|
|
252
258
|
export * from './broadcastCampaignStatus';
|
|
253
259
|
export * from './campaign';
|
|
254
260
|
export * from './campaignAddBroadcastEmailBody';
|
|
261
|
+
export * from './campaignAddTagToEntityBody';
|
|
255
262
|
export * from './campaignAllOf';
|
|
256
263
|
export * from './campaignGetAllBroadcastEmails200';
|
|
257
264
|
export * from './campaignGetAllBroadcastEmailsParams';
|
|
265
|
+
export * from './campaignGetTagsForEntity200';
|
|
266
|
+
export * from './campaignGetTagsForEntityParams';
|
|
258
267
|
export * from './campaignSendTestCampaignEmailBody';
|
|
268
|
+
export * from './campaignSetTagsForEntityBody';
|
|
259
269
|
export * from './campaignType';
|
|
260
270
|
export * from './campaignUpdateBroadcastEmailBody';
|
|
261
271
|
export * from './cancelationStatus';
|
|
@@ -559,11 +569,15 @@ export * from './qcountStatus';
|
|
|
559
569
|
export * from './registrationField';
|
|
560
570
|
export * from './resendEmailsRequest';
|
|
561
571
|
export * from './segment';
|
|
572
|
+
export * from './segmentAddTagToEntityBody';
|
|
562
573
|
export * from './segmentAllOf';
|
|
574
|
+
export * from './segmentGetTagsForEntity200';
|
|
575
|
+
export * from './segmentGetTagsForEntityParams';
|
|
563
576
|
export * from './segmentPerson';
|
|
564
577
|
export * from './segmentPersonAllOf';
|
|
565
578
|
export * from './segmentPersonAllOfPerson';
|
|
566
579
|
export * from './segmentPersonAllOfSegment';
|
|
580
|
+
export * from './segmentSetTagsForEntityBody';
|
|
567
581
|
export * from './sendGridDomainAuthentication';
|
|
568
582
|
export * from './sendGridDomainAuthenticationAllOf';
|
|
569
583
|
export * from './sendTemplateEmailRequest';
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
import type { LimitParameter } from './limitParameter';
|
|
3
|
+
import type { OffsetParameter } from './offsetParameter';
|
|
4
|
+
|
|
5
|
+
export type SegmentGetTagsForEntityParams = {
|
|
6
|
+
/**
|
|
7
|
+
* Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
|
|
8
|
+
*/
|
|
9
|
+
limit?: LimitParameter;
|
|
10
|
+
/**
|
|
11
|
+
* Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
|
|
12
|
+
*/
|
|
13
|
+
offset?: OffsetParameter;
|
|
14
|
+
};
|
|
@@ -73,6 +73,8 @@ export type StripeProductAllOf = {
|
|
|
73
73
|
NumberOfPurchases?: number;
|
|
74
74
|
NumberOfSubscriptions?: number;
|
|
75
75
|
/** @nullable */
|
|
76
|
+
Quantity?: number | null;
|
|
77
|
+
/** @nullable */
|
|
76
78
|
StripeProductFamily?: StripeProductAllOfStripeProductFamily;
|
|
77
79
|
[key: string]: unknown | null;
|
|
78
80
|
};
|
|
@@ -23,6 +23,8 @@ export type SupportSettingsAllOf = {
|
|
|
23
23
|
/** @nullable */
|
|
24
24
|
KnowledgeBaseFooterLinkJSON?: string | null;
|
|
25
25
|
/** @nullable */
|
|
26
|
+
KnowledgeBaseFilterJSON?: string | null;
|
|
27
|
+
/** @nullable */
|
|
26
28
|
OfficeHoursJSON?: string | null;
|
|
27
29
|
/** @nullable */
|
|
28
30
|
EmailNotificationForNewTickets?: string | null;
|