@outseta/react 0.2.0 → 0.2.2
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/package.json +2 -2
- package/src/generated/activity/activity.ts +175 -0
- package/src/generated/billing/billing.ts +1113 -0
- package/src/generated/crm/crm.ts +1529 -284
- package/src/generated/email/email.ts +772 -0
- package/src/generated/outsetaAPI.schemas.ts +1372 -322
- package/src/generated/support/support.ts +478 -221
- package/src/mutator.ts +32 -11
|
@@ -1,229 +1,4 @@
|
|
|
1
1
|
// @ts-nocheck
|
|
2
|
-
/**
|
|
3
|
-
* Generated by orval v7.21.0 🍺
|
|
4
|
-
* Do not edit manually.
|
|
5
|
-
* Outseta API
|
|
6
|
-
* # Outseta REST API
|
|
7
|
-
|
|
8
|
-
The Outseta REST API enables you to perform a variety of powerful tasks such as creating and updating people, accounts, subscriptions, and invoices. Outseta uses standard HTTP protocols within a compliant architecture that is simple to integrate. You can use the API both on the client or the server side; see the authentication section below for each scenario.
|
|
9
|
-
|
|
10
|
-
**Base URL:** `https://{your-domain}.outseta.com/api/v1/`
|
|
11
|
-
|
|
12
|
-
## API Guidelines
|
|
13
|
-
|
|
14
|
-
1. The API will only respond to secured communication done over **HTTPS**. HTTP requests will be sent a `301` redirect to the corresponding HTTPS resource.
|
|
15
|
-
2. Responses are sent in **JSON** format. In case the API request results in an error, it is represented by an `"error": {}` key in the JSON response.
|
|
16
|
-
3. The request method (verb) determines the nature of the action: **GET** fetches data, **POST** creates new records, **PUT** updates existing records.
|
|
17
|
-
4. The API responds with appropriate **HTTP status codes** for all requests.
|
|
18
|
-
5. Use `donotlog=1` as a query parameter on any API call where you don't want the action to be logged in the activity log.
|
|
19
|
-
|
|
20
|
-
## Authentication
|
|
21
|
-
|
|
22
|
-
All API requests require authentication via one of two methods:
|
|
23
|
-
|
|
24
|
-
### Server-Side (API Keys)
|
|
25
|
-
|
|
26
|
-
Use API keys for server-to-server integrations. Create keys at **Settings > Integrations > API Keys**. Make sure to record the secret key when you create it.
|
|
27
|
-
|
|
28
|
-
```
|
|
29
|
-
Authorization: Outseta {api_key}:{api_secret}
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
**Example:**
|
|
33
|
-
```
|
|
34
|
-
Authorization: Outseta ce08fd5a-e1ee-4472-9c5f-b7575d8369b2:74fc1d2242a4eb7336d34b0e40cfbc5f
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
> **Warning:** Never expose API keys in client-side code. The API key and secret combined give full access to all data in your account.
|
|
38
|
-
|
|
39
|
-
### Client-Side (Bearer Token)
|
|
40
|
-
|
|
41
|
-
Do **not** use API keys on the client side — they can be easily copied. Instead, obtain a JWT access token by calling the `POST /tokens` endpoint from the server side with your credentials, then use it on the client:
|
|
42
|
-
|
|
43
|
-
```
|
|
44
|
-
Authorization: bearer {access_token}
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
Tokens are JWTs containing claims such as `PersonUid`, `AccountUid`, and subscription details. Tokens expire after approximately one year.
|
|
48
|
-
|
|
49
|
-
Verify tokens server-side using Outseta's [JWKS endpoint](https://{your-domain}.outseta.com/.well-known/jwks.json).
|
|
50
|
-
|
|
51
|
-
## Field Selection
|
|
52
|
-
|
|
53
|
-
When you make an API request, you'll automatically get all the basic information from the main object and its immediate child objects. Referenced objects beyond the first level are returned as `null`.
|
|
54
|
-
|
|
55
|
-
Change this behavior using the `fields` query parameter:
|
|
56
|
-
|
|
57
|
-
- **Go deeper** — Request fields lower down in the object tree: `?fields=CurrentSubscription.Plan.*`
|
|
58
|
-
- **Go lighter** — Request only the essentials for faster performance: `?fields=Uid,Name`
|
|
59
|
-
- **Combination** — `?fields=Uid,Name,CurrentSubscription.Plan.Uid`
|
|
60
|
-
- **Wildcard** — Use `*` to get all fields in an object: `?fields=*` or `?fields=CurrentSubscription.Plan.*`
|
|
61
|
-
|
|
62
|
-
> **Tip:** When expanding nested paths, include `*` and intermediate path segments (e.g., `PersonAccount.*`) to preserve root-level and intermediate fields.
|
|
63
|
-
|
|
64
|
-
**Examples:**
|
|
65
|
-
|
|
66
|
-
```
|
|
67
|
-
# Get the current subscription plan UID for an account
|
|
68
|
-
GET /crm/accounts/{uid}?fields=CurrentSubscription.Plan.Uid
|
|
69
|
-
|
|
70
|
-
# Get the account UID and plan UID for a list of accounts
|
|
71
|
-
GET /crm/accounts?fields=Uid,CurrentSubscription.Plan.Uid
|
|
72
|
-
|
|
73
|
-
# Get the full plan object for an account's current subscription
|
|
74
|
-
GET /crm/accounts/{uid}?fields=CurrentSubscription.Plan.*
|
|
75
|
-
|
|
76
|
-
# Get a person with their account and subscription info
|
|
77
|
-
GET /crm/people/{uid}?fields=Uid,PersonAccount.Account.CurrentSubscription.Plan.Uid
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
If your request includes fields from a child object you will be limited to retrieving **25 items** per page. The maximum for requests not expanding child object fields is **100 items**.
|
|
81
|
-
|
|
82
|
-
## Pagination
|
|
83
|
-
|
|
84
|
-
List endpoints return paginated results with a `metadata` object and an `items` array:
|
|
85
|
-
|
|
86
|
-
```json
|
|
87
|
-
{
|
|
88
|
-
"metadata": {
|
|
89
|
-
"limit": 25,
|
|
90
|
-
"offset": 0,
|
|
91
|
-
"total": 142
|
|
92
|
-
},
|
|
93
|
-
"items": [ ... ]
|
|
94
|
-
}
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
| Parameter | Type | Default | Description |
|
|
98
|
-
|-----------|------|---------|-------------|
|
|
99
|
-
| `offset` | integer | `0` | Page number (zero-based) |
|
|
100
|
-
| `limit` | integer | `25` | Maximum number of records per page |
|
|
101
|
-
|
|
102
|
-
**Examples:**
|
|
103
|
-
```
|
|
104
|
-
?offset=0&limit=20 # returns results 1-20
|
|
105
|
-
?offset=1&limit=20 # returns results 21-40
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
## Sorting
|
|
109
|
-
|
|
110
|
-
Sort results using the `orderBy` parameter with a property name and direction:
|
|
111
|
-
|
|
112
|
-
```
|
|
113
|
-
?orderBy=PropertyName+DESC
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
## Filtering
|
|
117
|
-
|
|
118
|
-
Filter results by passing entity properties as query parameters.
|
|
119
|
-
|
|
120
|
-
### Basic Filtering
|
|
121
|
-
|
|
122
|
-
Filter on any field using the field name as a query parameter:
|
|
123
|
-
|
|
124
|
-
```
|
|
125
|
-
GET /crm/people?Email=john@example.com
|
|
126
|
-
GET /crm/accounts?AccountStage=2
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
### Wildcard Matching
|
|
130
|
-
|
|
131
|
-
| Pattern | Match Type | Example |
|
|
132
|
-
|---------|-----------|---------|
|
|
133
|
-
| `*value` | Ends with | `?Email=*@example.com` |
|
|
134
|
-
| `value*` | Starts with | `?Name=Acme*` |
|
|
135
|
-
| `*value*` | Contains | `?Name=*corp*` |
|
|
136
|
-
|
|
137
|
-
### Comparison Operators
|
|
138
|
-
|
|
139
|
-
For advanced filtering, append comparison operators to field names:
|
|
140
|
-
|
|
141
|
-
| Operator | Description | Example |
|
|
142
|
-
|----------|-------------|---------|
|
|
143
|
-
| `__gt` | Greater than | `Created__gt=2024-01-01` |
|
|
144
|
-
| `__gte` | Greater than or equal | `Amount__gte=100` |
|
|
145
|
-
| `__lt` | Less than | `Created__lt=2024-12-31` |
|
|
146
|
-
| `__lte` | Less than or equal | `Amount__lte=500` |
|
|
147
|
-
| `__ne` | Not equal | `Status__ne=Active` |
|
|
148
|
-
| `__isnull` | Is null (true/false) | `ProfileImageS3Url__isnull=true` |
|
|
149
|
-
|
|
150
|
-
**Examples:**
|
|
151
|
-
|
|
152
|
-
```
|
|
153
|
-
# Date filtering
|
|
154
|
-
GET /crm/accounts?Created__gt=2024-01-01
|
|
155
|
-
GET /billing/subscriptions?EndDate__lt=2024-08-01
|
|
156
|
-
|
|
157
|
-
# Numeric filtering
|
|
158
|
-
GET /billing/invoices?Amount__gte=1000
|
|
159
|
-
|
|
160
|
-
# Null value filtering
|
|
161
|
-
GET /crm/people?ProfileImageS3Url__isnull=true
|
|
162
|
-
|
|
163
|
-
# Multiple filters combined with field selection
|
|
164
|
-
GET /billing/subscriptions?StartDate__gte=2024-01-01&Rate__lt=100&DiscountCode__isnull=false&fields=Uid,Amount,StartDate,DiscountCode,Plan.Name
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
## Account Billing Stages
|
|
168
|
-
|
|
169
|
-
Account stages reflect the financial standing of each account and are not directly editable — they change automatically based on subscription activity.
|
|
170
|
-
|
|
171
|
-
| Value | Stage | Description |
|
|
172
|
-
|-------|-------|-------------|
|
|
173
|
-
| `2` | Trialing | Currently on a free trial or free plan |
|
|
174
|
-
| `3` | Subscribing | Active paid subscription (contributes to MRR) |
|
|
175
|
-
| `4` | Canceling | Customer has indicated intent to cancel |
|
|
176
|
-
| `5` | Expired | Subscription has ended after cancellation |
|
|
177
|
-
| `6` | Trial Expired | Free trial ended without conversion to paid |
|
|
178
|
-
|
|
179
|
-
Filter by stage: `GET /crm/accounts?AccountStage=3` returns all actively subscribing accounts.
|
|
180
|
-
|
|
181
|
-
## Webhooks
|
|
182
|
-
|
|
183
|
-
Use **Activity Notifications** to receive real-time callbacks when events occur in Outseta. Configure webhooks at **Settings > Notifications**.
|
|
184
|
-
|
|
185
|
-
Common events include:
|
|
186
|
-
- `Person Created` / `Person Updated`
|
|
187
|
-
- `Account Created` / `Account Updated`
|
|
188
|
-
- `Subscription Created` / `Subscription Updated`
|
|
189
|
-
|
|
190
|
-
Always verify webhook signatures using the SHA256 secret provided in the Outseta dashboard.
|
|
191
|
-
|
|
192
|
-
## Error Responses
|
|
193
|
-
|
|
194
|
-
| Status Code | Description |
|
|
195
|
-
|-------------|-------------|
|
|
196
|
-
| `200` | Success |
|
|
197
|
-
| `301` | Redirect — HTTP requests are redirected to HTTPS |
|
|
198
|
-
| `400` | Bad request — invalid parameters or Uid format |
|
|
199
|
-
| `401` | Unauthorized — missing or invalid authentication |
|
|
200
|
-
| `404` | Entity not found |
|
|
201
|
-
| `4XX` / `5XX` | Client or server error |
|
|
202
|
-
|
|
203
|
-
Validation errors return a JSON body with `ErrorMessage` and `PropertyName` fields:
|
|
204
|
-
|
|
205
|
-
```json
|
|
206
|
-
{
|
|
207
|
-
"ErrorMessage": "Invalid company email",
|
|
208
|
-
"PropertyName": "Email"
|
|
209
|
-
}
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
## Rate Limits
|
|
213
|
-
|
|
214
|
-
Requests authorized by an API Key should not exceed **4 requests/second**.
|
|
215
|
-
|
|
216
|
-
## Support
|
|
217
|
-
|
|
218
|
-
For help regarding the Outseta API please email [support@outseta.com](mailto:support@outseta.com).
|
|
219
|
-
|
|
220
|
-
* OpenAPI spec version: v1
|
|
221
|
-
*/
|
|
222
|
-
export interface TagUidList {
|
|
223
|
-
/** @nullable */
|
|
224
|
-
TagUids?: string[] | null;
|
|
225
|
-
}
|
|
226
|
-
|
|
227
2
|
export type TranslationAllOf = {
|
|
228
3
|
/**
|
|
229
4
|
* @minLength 1
|
|
@@ -262,6 +37,8 @@ export interface AbstractBean {
|
|
|
262
37
|
* @nullable
|
|
263
38
|
*/
|
|
264
39
|
Uid?: string | null;
|
|
40
|
+
/** @nullable */
|
|
41
|
+
_objectType?: string | null;
|
|
265
42
|
/** @minLength 1 */
|
|
266
43
|
Created: string;
|
|
267
44
|
/** @minLength 1 */
|
|
@@ -503,18 +280,8 @@ export type PersonAllOf = {
|
|
|
503
280
|
LastName?: string | null;
|
|
504
281
|
/** @nullable */
|
|
505
282
|
MailingAddress?: PersonAllOfMailingAddress;
|
|
506
|
-
/**
|
|
507
|
-
* @maxLength 250
|
|
508
|
-
* @nullable
|
|
509
|
-
*/
|
|
510
|
-
PasswordHash?: string | null;
|
|
511
283
|
/** @nullable */
|
|
512
284
|
PasswordLastUpdated?: string | null;
|
|
513
|
-
/**
|
|
514
|
-
* @maxLength 250
|
|
515
|
-
* @nullable
|
|
516
|
-
*/
|
|
517
|
-
PasswordResetToken?: string | null;
|
|
518
285
|
PasswordMustChange?: boolean;
|
|
519
286
|
/**
|
|
520
287
|
* @maxLength 250
|
|
@@ -575,12 +342,12 @@ export type PersonAllOf = {
|
|
|
575
342
|
/** @nullable */
|
|
576
343
|
LeadFormSubmissions?: LeadFormSubmission[] | null;
|
|
577
344
|
/** @nullable */
|
|
578
|
-
EmailListPerson?: EmailListPerson[] | null;
|
|
579
|
-
/** @nullable */
|
|
580
345
|
Account?: PersonAllOfAccount;
|
|
581
346
|
/** @nullable */
|
|
582
347
|
AccountUids?: string | null;
|
|
583
348
|
/** @nullable */
|
|
349
|
+
EmailListPerson?: EmailListPerson[] | null;
|
|
350
|
+
/** @nullable */
|
|
584
351
|
FullName?: string | null;
|
|
585
352
|
HasLoggedIn?: boolean;
|
|
586
353
|
OAuthIntegrationStatus?: OAuthService;
|
|
@@ -856,7 +623,7 @@ export type AccountAllOf = {
|
|
|
856
623
|
export type Account = AbstractStripeBeanOfCustomer & AccountAllOf;
|
|
857
624
|
|
|
858
625
|
/**
|
|
859
|
-
* `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused
|
|
626
|
+
* `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused, `10` - Created
|
|
860
627
|
*/
|
|
861
628
|
export type AccountStage = typeof AccountStage[keyof typeof AccountStage];
|
|
862
629
|
|
|
@@ -874,6 +641,7 @@ export const AccountStage = {
|
|
|
874
641
|
/** Cancelling Trial */
|
|
875
642
|
CancellingTrial: 8,
|
|
876
643
|
Paused: 9,
|
|
644
|
+
Created: 10,
|
|
877
645
|
} as const;
|
|
878
646
|
|
|
879
647
|
export type PaymentInformationAllOf = {
|
|
@@ -957,6 +725,8 @@ export type StripeInvoiceAllOf = {
|
|
|
957
725
|
Currency?: string | null;
|
|
958
726
|
/** @nullable */
|
|
959
727
|
Description?: string | null;
|
|
728
|
+
/** @nullable */
|
|
729
|
+
FinalizedAt?: string | null;
|
|
960
730
|
/**
|
|
961
731
|
* @maxLength 500
|
|
962
732
|
* @nullable
|
|
@@ -992,6 +762,11 @@ export type StripeInvoiceAllOf = {
|
|
|
992
762
|
SubTotal?: number;
|
|
993
763
|
/** @nullable */
|
|
994
764
|
SubTotalExcludingTax?: number | null;
|
|
765
|
+
/**
|
|
766
|
+
* @maxLength 255
|
|
767
|
+
* @nullable
|
|
768
|
+
*/
|
|
769
|
+
SubscriptionId?: string | null;
|
|
995
770
|
/** @nullable */
|
|
996
771
|
Tax?: number | null;
|
|
997
772
|
Total?: number;
|
|
@@ -1000,6 +775,8 @@ export type StripeInvoiceAllOf = {
|
|
|
1000
775
|
/** @nullable */
|
|
1001
776
|
Account?: StripeInvoiceAllOfAccount;
|
|
1002
777
|
IsRefunded?: boolean;
|
|
778
|
+
CurrencyAmountCreditedPostPayment?: number;
|
|
779
|
+
CurrencyAmountCreditedPrePayment?: number;
|
|
1003
780
|
CurrencyAmountDue?: number;
|
|
1004
781
|
CurrencyAmountPaid?: number;
|
|
1005
782
|
/** @nullable */
|
|
@@ -1152,6 +929,11 @@ export type StripeProductAllOf = {
|
|
|
1152
929
|
* @nullable
|
|
1153
930
|
*/
|
|
1154
931
|
Name?: string | null;
|
|
932
|
+
/**
|
|
933
|
+
* @maxLength 255
|
|
934
|
+
* @nullable
|
|
935
|
+
*/
|
|
936
|
+
DefaultPriceId?: string | null;
|
|
1155
937
|
/** @nullable */
|
|
1156
938
|
Description?: string | null;
|
|
1157
939
|
IsActive?: boolean;
|
|
@@ -1502,6 +1284,8 @@ export type StripePriceAllOf = {
|
|
|
1502
1284
|
/** @nullable */
|
|
1503
1285
|
CurrencyUnitAmountDecimal?: number | null;
|
|
1504
1286
|
/** @nullable */
|
|
1287
|
+
Recurring_IntervalDays?: number | null;
|
|
1288
|
+
/** @nullable */
|
|
1505
1289
|
Recurring_Description?: string | null;
|
|
1506
1290
|
/** @nullable */
|
|
1507
1291
|
StripeMeterId?: string | null;
|
|
@@ -1719,8 +1503,12 @@ export type StripeSubscriptionAllOf = {
|
|
|
1719
1503
|
/** @nullable */
|
|
1720
1504
|
AccountUid?: string | null;
|
|
1721
1505
|
/** @nullable */
|
|
1506
|
+
CollectionMethod?: string | null;
|
|
1507
|
+
/** @nullable */
|
|
1722
1508
|
CustomerId?: string | null;
|
|
1723
1509
|
/** @nullable */
|
|
1510
|
+
DaysUntilDue?: number | null;
|
|
1511
|
+
/** @nullable */
|
|
1724
1512
|
ScheduleId?: string | null;
|
|
1725
1513
|
/** @nullable */
|
|
1726
1514
|
StripeDiscountIds?: string[] | null;
|
|
@@ -2229,6 +2017,10 @@ export type StripeCreditNoteAllOf = {
|
|
|
2229
2017
|
* @nullable
|
|
2230
2018
|
*/
|
|
2231
2019
|
InvoiceId?: string | null;
|
|
2020
|
+
/** @nullable */
|
|
2021
|
+
OutOfBandAmount?: number | null;
|
|
2022
|
+
PostPaymentAmount?: number;
|
|
2023
|
+
PrePaymentAmount?: number;
|
|
2232
2024
|
/**
|
|
2233
2025
|
* @maxLength 30
|
|
2234
2026
|
* @nullable
|
|
@@ -2240,6 +2032,11 @@ export type StripeCreditNoteAllOf = {
|
|
|
2240
2032
|
*/
|
|
2241
2033
|
Status?: string | null;
|
|
2242
2034
|
Total?: number;
|
|
2035
|
+
/**
|
|
2036
|
+
* @maxLength 30
|
|
2037
|
+
* @nullable
|
|
2038
|
+
*/
|
|
2039
|
+
Type?: string | null;
|
|
2243
2040
|
/** @nullable */
|
|
2244
2041
|
CurrencySymbol?: string | null;
|
|
2245
2042
|
CurrencyTotal?: number;
|
|
@@ -2499,7 +2296,15 @@ export type InvoiceAllOf = {
|
|
|
2499
2296
|
AmountRefunded?: number;
|
|
2500
2297
|
AmountSubtotal?: number;
|
|
2501
2298
|
AmountTax?: number;
|
|
2299
|
+
AmountTaxRefunded?: number;
|
|
2502
2300
|
IsTaxable?: boolean;
|
|
2301
|
+
HasPaymentGatewayTransactions?: boolean;
|
|
2302
|
+
/** @nullable */
|
|
2303
|
+
StripePaymentTransactionIds?: string | null;
|
|
2304
|
+
/** @nullable */
|
|
2305
|
+
StripeRefundTransactionIds?: string | null;
|
|
2306
|
+
/** @nullable */
|
|
2307
|
+
StripeTaxRefundTransactionIds?: string | null;
|
|
2503
2308
|
};
|
|
2504
2309
|
|
|
2505
2310
|
export type Invoice = AbstractQcountBean & InvoiceAllOf;
|
|
@@ -3341,7 +3146,7 @@ export type QcountConfigAllOf = {
|
|
|
3341
3146
|
export type QcountConfig = AbstractQcountBean & QcountConfigAllOf;
|
|
3342
3147
|
|
|
3343
3148
|
/**
|
|
3344
|
-
* `100` - Slack, `102` - MagicLinkApiKey, `103` - MagicLinkApiKeySecret, `104` - OAuth_HideCreateAccountLink, `105` - Chat_IsOffline, `106` - HostedPageCustomCode, `107` - RegistrationConfirmationEmailDelaySeconds, `108` - AccountCancellationReasons, `110` - WebhookSignatureKey, `111` - HostedProfileBackLink, `112` - AccountCancellationReasonRequired, `114` - Email_OutsetaBrandingDisabled, `
|
|
3149
|
+
* `100` - Slack, `102` - MagicLinkApiKey, `103` - MagicLinkApiKeySecret, `104` - OAuth_HideCreateAccountLink, `105` - Chat_IsOffline, `106` - HostedPageCustomCode, `107` - RegistrationConfirmationEmailDelaySeconds, `108` - AccountCancellationReasons, `110` - WebhookSignatureKey, `111` - HostedProfileBackLink, `112` - AccountCancellationReasonRequired, `114` - Email_OutsetaBrandingDisabled, `119` - Email_BlacklistedInboundEmails, `121` - PasswordPolicy, `123` - CRM_FieldSortingEnabled, `124` - CRM_RegistrationCallbackLocations, `125` - KnowledgeBaseVersion, `126` - Support_SpamThreshold, `127` - Email_RestrictedPhrases, `128` - KnowledgeBaseLanguage, `130` - Billing_System, `131` - Billing_RestrictSubscriptionActions, `190` - Stripe_TaxEnabled, `192` - Stripe_TaxIdTypes, `193` - Stripe_ApplePayMerchantIdDomainAssociation, `194` - Stripe_WebhookSecret, `200` - Webflow_AccessToken, `201` - Webflow_SyncEnabled, `202` - Webflow_SyncConfiguration, `203` - Webflow_ApiVersion, `550` - CopyQcount_AddOnMap, `551` - CopyQcount_AccountMap, `552` - CopyQcount_DiscountCouponMap, `553` - CopyQcount_InvoiceMap, `554` - CopyQcount_PersonMap, `555` - CopyQcount_PlanMap, `556` - CopyQcount_PlanFamilyMap, `557` - CopyQcount_SubscriptionMap, `558` - CopyQcount_TransactionMap, `570` - StripeMigration_LastAccountId, `571` - StripeMigration_LastInvoiceId, `572` - StripeMigration_LastExpiredSubscriptionId, `573` - StripeMigration_LastPostExportSubscriptionId, `574` - StripeMigration_LastUsageId, `575` - StripeMigration_SubscriptionExportDate, `576` - StripeMigration_SubscriptionExportIds, `577` - StripeMigration_SubscriptionAddOnExportIds, `578` - StripeMigration_SubscriptionCutoverDate, `579` - StripeMigration_LastPreCutoverExportSubscriptionId
|
|
3345
3150
|
*/
|
|
3346
3151
|
export type QcountConfigSettingType = typeof QcountConfigSettingType[keyof typeof QcountConfigSettingType];
|
|
3347
3152
|
|
|
@@ -3360,14 +3165,10 @@ export const QcountConfigSettingType = {
|
|
|
3360
3165
|
HostedProfileBackLink: 111,
|
|
3361
3166
|
AccountCancellationReasonRequired: 112,
|
|
3362
3167
|
Email_OutsetaBrandingDisabled: 114,
|
|
3363
|
-
Email_MarketingIpPool: 115,
|
|
3364
|
-
Email_TransactionalIpPool: 116,
|
|
3365
|
-
Email_LifecycleIpPool: 117,
|
|
3366
|
-
Email_DomainAuthenticationConfigured: 118,
|
|
3367
3168
|
Email_BlacklistedInboundEmails: 119,
|
|
3368
|
-
CRM_TeamMemberInviteEmailDisabled: 120,
|
|
3369
3169
|
PasswordPolicy: 121,
|
|
3370
3170
|
CRM_FieldSortingEnabled: 123,
|
|
3171
|
+
CRM_RegistrationCallbackLocations: 124,
|
|
3371
3172
|
KnowledgeBaseVersion: 125,
|
|
3372
3173
|
Support_SpamThreshold: 126,
|
|
3373
3174
|
Email_RestrictedPhrases: 127,
|
|
@@ -3382,13 +3183,6 @@ export const QcountConfigSettingType = {
|
|
|
3382
3183
|
Webflow_SyncEnabled: 201,
|
|
3383
3184
|
Webflow_SyncConfiguration: 202,
|
|
3384
3185
|
Webflow_ApiVersion: 203,
|
|
3385
|
-
SqsQueueEnabled: 300,
|
|
3386
|
-
PersonSegmentationStatusEnabled: 301,
|
|
3387
|
-
SqsCampaignEmailQueueEnabled: 304,
|
|
3388
|
-
Account_AutoIncrementClientIdentifier: 310,
|
|
3389
|
-
SqsEmailLogQueueUrlOverride: 402,
|
|
3390
|
-
Logging_Webhook_Enabled: 500,
|
|
3391
|
-
Logging_Activty_Enabled: 501,
|
|
3392
3186
|
CopyQcount_AddOnMap: 550,
|
|
3393
3187
|
CopyQcount_AccountMap: 551,
|
|
3394
3188
|
CopyQcount_DiscountCouponMap: 552,
|
|
@@ -3408,7 +3202,6 @@ export const QcountConfigSettingType = {
|
|
|
3408
3202
|
StripeMigration_SubscriptionAddOnExportIds: 577,
|
|
3409
3203
|
StripeMigration_SubscriptionCutoverDate: 578,
|
|
3410
3204
|
StripeMigration_LastPreCutoverExportSubscriptionId: 579,
|
|
3411
|
-
SqsSendGridWebHookEventQueueUrlOverride: 601,
|
|
3412
3205
|
} as const;
|
|
3413
3206
|
|
|
3414
3207
|
export type DiscordServerAllOf = {
|
|
@@ -3618,6 +3411,7 @@ export type SendGridDomainAuthenticationAllOf = {
|
|
|
3618
3411
|
*/
|
|
3619
3412
|
DomainName: string;
|
|
3620
3413
|
IsValid?: boolean;
|
|
3414
|
+
IsBrandedLinksDisabled?: boolean;
|
|
3621
3415
|
/** @nullable */
|
|
3622
3416
|
LastValidationAttempt?: string | null;
|
|
3623
3417
|
/** @nullable */
|
|
@@ -3627,6 +3421,8 @@ export type SendGridDomainAuthenticationAllOf = {
|
|
|
3627
3421
|
export type SendGridDomainAuthentication = AbstractQcountBean & SendGridDomainAuthenticationAllOf;
|
|
3628
3422
|
|
|
3629
3423
|
export interface DnsEntry {
|
|
3424
|
+
/** @nullable */
|
|
3425
|
+
Name?: string | null;
|
|
3630
3426
|
Valid?: boolean;
|
|
3631
3427
|
/** @nullable */
|
|
3632
3428
|
Type?: string | null;
|
|
@@ -3638,6 +3434,11 @@ export interface DnsEntry {
|
|
|
3638
3434
|
Reason?: string | null;
|
|
3639
3435
|
}
|
|
3640
3436
|
|
|
3437
|
+
export interface ResendEmailsRequest {
|
|
3438
|
+
/** @nullable */
|
|
3439
|
+
EmailLogUids?: string[] | null;
|
|
3440
|
+
}
|
|
3441
|
+
|
|
3641
3442
|
/**
|
|
3642
3443
|
* @nullable
|
|
3643
3444
|
*/
|
|
@@ -3751,6 +3552,7 @@ export type MessageAllOf = {
|
|
|
3751
3552
|
CountTotalOpen?: number;
|
|
3752
3553
|
CountTotalClick?: number;
|
|
3753
3554
|
IgnoredSpamBounce?: number;
|
|
3555
|
+
IsBounceRatePaused?: boolean;
|
|
3754
3556
|
/** @nullable */
|
|
3755
3557
|
EmailLinks?: EmailLink[] | null;
|
|
3756
3558
|
SpamAssassinScore?: number;
|
|
@@ -3801,11 +3603,6 @@ export interface SendTestEmailRequest {
|
|
|
3801
3603
|
AdditionalRecipients?: string[] | null;
|
|
3802
3604
|
}
|
|
3803
3605
|
|
|
3804
|
-
/**
|
|
3805
|
-
* @nullable
|
|
3806
|
-
*/
|
|
3807
|
-
export type QcountAllOfLogDatabase = Database | null;
|
|
3808
|
-
|
|
3809
3606
|
export type QcountAllOf = {
|
|
3810
3607
|
/**
|
|
3811
3608
|
* @maxLength 100
|
|
@@ -3892,11 +3689,6 @@ export type QcountAllOf = {
|
|
|
3892
3689
|
* @nullable
|
|
3893
3690
|
*/
|
|
3894
3691
|
AccountUid?: string | null;
|
|
3895
|
-
/**
|
|
3896
|
-
* @maxLength 250
|
|
3897
|
-
* @nullable
|
|
3898
|
-
*/
|
|
3899
|
-
LocationId?: string | null;
|
|
3900
3692
|
/**
|
|
3901
3693
|
* @maxLength 250
|
|
3902
3694
|
* @nullable
|
|
@@ -3912,11 +3704,6 @@ export type QcountAllOf = {
|
|
|
3912
3704
|
* @nullable
|
|
3913
3705
|
*/
|
|
3914
3706
|
StripePublishableKey?: string | null;
|
|
3915
|
-
/**
|
|
3916
|
-
* @maxLength 250
|
|
3917
|
-
* @nullable
|
|
3918
|
-
*/
|
|
3919
|
-
StripeSecretKey?: string | null;
|
|
3920
3707
|
/**
|
|
3921
3708
|
* @maxLength 3
|
|
3922
3709
|
* @nullable
|
|
@@ -3928,19 +3715,11 @@ export type QcountAllOf = {
|
|
|
3928
3715
|
* @nullable
|
|
3929
3716
|
*/
|
|
3930
3717
|
RecaptchaSiteKey?: string | null;
|
|
3931
|
-
/**
|
|
3932
|
-
* @maxLength 50
|
|
3933
|
-
* @nullable
|
|
3934
|
-
*/
|
|
3935
|
-
RecaptchaSecretKey?: string | null;
|
|
3936
3718
|
/**
|
|
3937
3719
|
* @maxLength 250
|
|
3938
3720
|
* @nullable
|
|
3939
3721
|
*/
|
|
3940
3722
|
RewardfulAPIKey?: string | null;
|
|
3941
|
-
Database: Database;
|
|
3942
|
-
/** @nullable */
|
|
3943
|
-
LogDatabase?: QcountAllOfLogDatabase;
|
|
3944
3723
|
/** @nullable */
|
|
3945
3724
|
DomainPrefix?: string | null;
|
|
3946
3725
|
/** @nullable */
|
|
@@ -3954,7 +3733,7 @@ export type QcountAllOf = {
|
|
|
3954
3733
|
TaxEnabled?: boolean;
|
|
3955
3734
|
};
|
|
3956
3735
|
|
|
3957
|
-
export type Qcount = AbstractBean & QcountAllOf
|
|
3736
|
+
export type Qcount = AbstractBean & QcountAllOf & Required<Pick<AbstractBean & QcountAllOf, 'Database'>>;
|
|
3958
3737
|
|
|
3959
3738
|
/**
|
|
3960
3739
|
* `0` - Active, `1` - Inactive, `2` - MarkedForDeletion, `3` - Deleted
|
|
@@ -4028,11 +3807,6 @@ export type ApiKeyAllOf = {
|
|
|
4028
3807
|
* @nullable
|
|
4029
3808
|
*/
|
|
4030
3809
|
Key?: string | null;
|
|
4031
|
-
/**
|
|
4032
|
-
* @maxLength 255
|
|
4033
|
-
* @nullable
|
|
4034
|
-
*/
|
|
4035
|
-
Secret?: string | null;
|
|
4036
3810
|
/** @nullable */
|
|
4037
3811
|
Qcount?: ApiKeyAllOfQcount;
|
|
4038
3812
|
/** @nullable */
|
|
@@ -4063,11 +3837,6 @@ export type JwtKeyAllOf = {
|
|
|
4063
3837
|
Active?: boolean;
|
|
4064
3838
|
/** @nullable */
|
|
4065
3839
|
X509CertificatePublic?: string | null;
|
|
4066
|
-
/**
|
|
4067
|
-
* @maxLength 255
|
|
4068
|
-
* @nullable
|
|
4069
|
-
*/
|
|
4070
|
-
Key?: string | null;
|
|
4071
3840
|
/** @nullable */
|
|
4072
3841
|
KeyInitial?: string | null;
|
|
4073
3842
|
/** @nullable */
|
|
@@ -4111,6 +3880,10 @@ export type BroadcastCampaignAllOf = {
|
|
|
4111
3880
|
Message?: BroadcastCampaignAllOfMessage;
|
|
4112
3881
|
/** @nullable */
|
|
4113
3882
|
RecipientData?: string | null;
|
|
3883
|
+
/** @nullable */
|
|
3884
|
+
EmailListUids?: string[] | null;
|
|
3885
|
+
/** @nullable */
|
|
3886
|
+
SegmentUids?: string[] | null;
|
|
4114
3887
|
Status?: BroadcastCampaignStatus;
|
|
4115
3888
|
/**
|
|
4116
3889
|
* @maxLength 500
|
|
@@ -4124,7 +3897,7 @@ export type BroadcastCampaignAllOf = {
|
|
|
4124
3897
|
export type BroadcastCampaign = AbstractQcountBean & BroadcastCampaignAllOf;
|
|
4125
3898
|
|
|
4126
3899
|
/**
|
|
4127
|
-
* `1` - Draft, `2` - Pending, `3` - Sent, `4` - Queuing, `5` - Queued, `6` - Sending, `7` - Error, `8` - WaitingToResume, `9` - QueuedEmails
|
|
3900
|
+
* `1` - Draft, `2` - Pending, `3` - Sent, `4` - Queuing, `5` - Queued, `6` - Sending, `7` - Error, `8` - WaitingToResume, `9` - QueuedEmails, `10` - Archived
|
|
4128
3901
|
*/
|
|
4129
3902
|
export type BroadcastCampaignStatus = typeof BroadcastCampaignStatus[keyof typeof BroadcastCampaignStatus];
|
|
4130
3903
|
|
|
@@ -4140,6 +3913,7 @@ export const BroadcastCampaignStatus = {
|
|
|
4140
3913
|
Error: 7,
|
|
4141
3914
|
WaitingToResume: 8,
|
|
4142
3915
|
QueuedEmails: 9,
|
|
3916
|
+
Archived: 10,
|
|
4143
3917
|
} as const;
|
|
4144
3918
|
|
|
4145
3919
|
/**
|
|
@@ -4154,6 +3928,11 @@ export interface SendTestEmailRequest2 {
|
|
|
4154
3928
|
AdditionalRecipients?: string[] | null;
|
|
4155
3929
|
}
|
|
4156
3930
|
|
|
3931
|
+
export interface TagUidList {
|
|
3932
|
+
/** @nullable */
|
|
3933
|
+
TagUids?: string[] | null;
|
|
3934
|
+
}
|
|
3935
|
+
|
|
4157
3936
|
/**
|
|
4158
3937
|
* @nullable
|
|
4159
3938
|
*/
|
|
@@ -4170,7 +3949,7 @@ export interface FlatfileImportData {
|
|
|
4170
3949
|
}
|
|
4171
3950
|
|
|
4172
3951
|
/**
|
|
4173
|
-
* `1` - UpdateSegmentBackGroundTask, `2` - ImportPeopleTask, `3` - ImportAccountTask, `4` - ImportDealTask, `5` - ImportEmailList, `6` - RescheduleDripCampaignTask, `7` - DeleteSegmentPeopleTask, `8` - StartDripCampaignTask, `9` - WebflowSyncTask, `10` - UpdatePersonSegmentsTask, `11` - ImportDiscountCouponTask, `12` - RemoveDiscordUserFromAllServersTask, `13` - SendInvoiceEmailTask, `14` - UpdateDiscordUserRolesTask, `15` - StripeBillingSyncTask, `16` - UpdateStripeDefaultSourceTask, `17` - DeleteScheduledCampaignMessagesTask, `18` - SendSpamCheckEmailTask, `19` - UpdateDiscordMemberRolesTask
|
|
3952
|
+
* `1` - UpdateSegmentBackGroundTask, `2` - ImportPeopleTask, `3` - ImportAccountTask, `4` - ImportDealTask, `5` - ImportEmailList, `6` - RescheduleDripCampaignTask, `7` - DeleteSegmentPeopleTask, `8` - StartDripCampaignTask, `9` - WebflowSyncTask, `10` - UpdatePersonSegmentsTask, `11` - ImportDiscountCouponTask, `12` - RemoveDiscordUserFromAllServersTask, `13` - SendInvoiceEmailTask, `14` - UpdateDiscordUserRolesTask, `15` - StripeBillingSyncTask, `16` - UpdateStripeDefaultSourceTask, `17` - DeleteScheduledCampaignMessagesTask, `18` - SendSpamCheckEmailTask, `19` - UpdateDiscordMemberRolesTask, `20` - SendInvoicePaidEmailTask, `21` - ResendTrialLimitEmailTask
|
|
4174
3953
|
*/
|
|
4175
3954
|
export type BackGroundTaskType = typeof BackGroundTaskType[keyof typeof BackGroundTaskType];
|
|
4176
3955
|
|
|
@@ -4196,6 +3975,8 @@ export const BackGroundTaskType = {
|
|
|
4196
3975
|
DeleteScheduledCampaignMessagesTask: 17,
|
|
4197
3976
|
SendSpamCheckEmailTask: 18,
|
|
4198
3977
|
UpdateDiscordMemberRolesTask: 19,
|
|
3978
|
+
SendInvoicePaidEmailTask: 20,
|
|
3979
|
+
ResendTrialLimitEmailTask: 21,
|
|
4199
3980
|
} as const;
|
|
4200
3981
|
|
|
4201
3982
|
/**
|
|
@@ -4214,6 +3995,7 @@ export type AccountCancelationAllOf = {
|
|
|
4214
3995
|
CancelationReason?: string | null;
|
|
4215
3996
|
/** @nullable */
|
|
4216
3997
|
Comment?: string | null;
|
|
3998
|
+
CancelationStatus?: CancelationStatus;
|
|
4217
3999
|
/** @nullable */
|
|
4218
4000
|
Account?: AccountCancelationAllOfAccount;
|
|
4219
4001
|
/** @nullable */
|
|
@@ -4224,6 +4006,21 @@ export type AccountCancelationAllOf = {
|
|
|
4224
4006
|
|
|
4225
4007
|
export type AccountCancelation = AbstractQcountBean & AccountCancelationAllOf;
|
|
4226
4008
|
|
|
4009
|
+
/**
|
|
4010
|
+
* `0` - Pending, `1` - Unknown, `2` - Completed, `3` - Removed, `4` - Deleted
|
|
4011
|
+
*/
|
|
4012
|
+
export type CancelationStatus = typeof CancelationStatus[keyof typeof CancelationStatus];
|
|
4013
|
+
|
|
4014
|
+
|
|
4015
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
4016
|
+
export const CancelationStatus = {
|
|
4017
|
+
Pending: 0,
|
|
4018
|
+
Unknown: 1,
|
|
4019
|
+
Completed: 2,
|
|
4020
|
+
Removed: 3,
|
|
4021
|
+
Deleted: 4,
|
|
4022
|
+
} as const;
|
|
4023
|
+
|
|
4227
4024
|
export interface PasswordChangeModel {
|
|
4228
4025
|
/** @nullable */
|
|
4229
4026
|
ExistingPassword?: string | null;
|
|
@@ -4340,6 +4137,8 @@ export type CrmSettingsAllOf = {
|
|
|
4340
4137
|
/** @nullable */
|
|
4341
4138
|
SummaryDisplayFieldConfiguration?: string | null;
|
|
4342
4139
|
RegistrationConfirmationEmailDelaySeconds?: number;
|
|
4140
|
+
/** @nullable */
|
|
4141
|
+
RegistrationCallbackUrlLocations?: string | null;
|
|
4343
4142
|
};
|
|
4344
4143
|
|
|
4345
4144
|
export type CrmSettings = AbstractQcountBean & CrmSettingsAllOf;
|
|
@@ -4622,6 +4421,10 @@ export interface PauseCollectionOptions {
|
|
|
4622
4421
|
ResumesAt?: string | null;
|
|
4623
4422
|
}
|
|
4624
4423
|
|
|
4424
|
+
export interface ExtendSubscriptionOptions {
|
|
4425
|
+
ToDate?: string;
|
|
4426
|
+
}
|
|
4427
|
+
|
|
4625
4428
|
export type BillSettingsAllOf = {
|
|
4626
4429
|
DaysPastDueToSetAccountToCanceling?: number;
|
|
4627
4430
|
IsInvoicePaymentEmailDisabled: boolean;
|
|
@@ -4750,6 +4553,8 @@ export interface SetupIntent {
|
|
|
4750
4553
|
PaymentToken?: string | null;
|
|
4751
4554
|
/** @nullable */
|
|
4752
4555
|
PlanUid?: string | null;
|
|
4556
|
+
/** @nullable */
|
|
4557
|
+
ToltReferralId?: string | null;
|
|
4753
4558
|
}
|
|
4754
4559
|
|
|
4755
4560
|
/**
|
|
@@ -4786,22 +4591,6 @@ export type ActivityNotificationAllOf = {
|
|
|
4786
4591
|
|
|
4787
4592
|
export type ActivityNotification = AbstractQcountBean & ActivityNotificationAllOf;
|
|
4788
4593
|
|
|
4789
|
-
/**
|
|
4790
|
-
* @nullable
|
|
4791
|
-
*/
|
|
4792
|
-
export type ActivityCriteriaActivityType = ActivityType | null;
|
|
4793
|
-
|
|
4794
|
-
export interface ActivityCriteria {
|
|
4795
|
-
/** @nullable */
|
|
4796
|
-
EntityType?: string | null;
|
|
4797
|
-
/** @nullable */
|
|
4798
|
-
EntityUid?: string | null;
|
|
4799
|
-
/** @nullable */
|
|
4800
|
-
ActivityType?: ActivityCriteriaActivityType;
|
|
4801
|
-
/** @nullable */
|
|
4802
|
-
ActivityTypes?: string[] | null;
|
|
4803
|
-
}
|
|
4804
|
-
|
|
4805
4594
|
export type ActivityAllOf = {
|
|
4806
4595
|
/**
|
|
4807
4596
|
* @maxLength 250
|
|
@@ -4821,38 +4610,1299 @@ export type ActivityAllOf = {
|
|
|
4821
4610
|
|
|
4822
4611
|
export type Activity = AbstractQcountBean & ActivityAllOf;
|
|
4823
4612
|
|
|
4824
|
-
export type CaseGetAllCasesParams = {
|
|
4825
|
-
/**
|
|
4826
|
-
* Search string
|
|
4827
|
-
* @nullable
|
|
4828
|
-
*/
|
|
4829
|
-
q?: string | null;
|
|
4830
4613
|
/**
|
|
4831
|
-
* Uid of tag that is on the case
|
|
4832
4614
|
* @nullable
|
|
4833
4615
|
*/
|
|
4834
|
-
|
|
4835
|
-
|
|
4616
|
+
export type ActivityCriteriaActivityType = ActivityType | null;
|
|
4617
|
+
|
|
4618
|
+
export interface ActivityCriteria {
|
|
4619
|
+
/** @nullable */
|
|
4620
|
+
EntityType?: string | null;
|
|
4621
|
+
/** @nullable */
|
|
4622
|
+
EntityUid?: string | null;
|
|
4623
|
+
/** @nullable */
|
|
4624
|
+
ActivityType?: ActivityCriteriaActivityType;
|
|
4625
|
+
/** @nullable */
|
|
4626
|
+
ActivityTypes?: string[] | null;
|
|
4627
|
+
}
|
|
4628
|
+
|
|
4629
|
+
export interface PersonSegmentAddedActivityData {
|
|
4630
|
+
/** @nullable */
|
|
4631
|
+
SegmentUid?: string | null;
|
|
4632
|
+
/**
|
|
4633
|
+
* @deprecated
|
|
4634
|
+
* @nullable
|
|
4635
|
+
*/
|
|
4636
|
+
SegmentId?: string | null;
|
|
4637
|
+
}
|
|
4836
4638
|
|
|
4837
|
-
export type AccountGetAllAccountsParams = {
|
|
4838
4639
|
/**
|
|
4839
|
-
* Accounts are filtered based on whether they are associated with the segment
|
|
4840
4640
|
* @nullable
|
|
4841
4641
|
*/
|
|
4842
|
-
|
|
4642
|
+
export type PersonSegmentAddedWebhookPayloadMailingAddress = {
|
|
4643
|
+
/**
|
|
4644
|
+
* @maxLength 10
|
|
4645
|
+
* @nullable
|
|
4646
|
+
*/
|
|
4647
|
+
Uid?: string | null;
|
|
4648
|
+
/** @nullable */
|
|
4649
|
+
_objectType?: string | null;
|
|
4650
|
+
/** @minLength 1 */
|
|
4651
|
+
Created?: string;
|
|
4652
|
+
/** @minLength 1 */
|
|
4653
|
+
Updated?: string;
|
|
4654
|
+
/**
|
|
4655
|
+
* @maxLength 250
|
|
4656
|
+
* @nullable
|
|
4657
|
+
*/
|
|
4658
|
+
AddressLine1?: string | null;
|
|
4659
|
+
/**
|
|
4660
|
+
* @maxLength 250
|
|
4661
|
+
* @nullable
|
|
4662
|
+
*/
|
|
4663
|
+
AddressLine2?: string | null;
|
|
4664
|
+
/**
|
|
4665
|
+
* @maxLength 250
|
|
4666
|
+
* @nullable
|
|
4667
|
+
*/
|
|
4668
|
+
AddressLine3?: string | null;
|
|
4669
|
+
/**
|
|
4670
|
+
* @maxLength 250
|
|
4671
|
+
* @nullable
|
|
4672
|
+
*/
|
|
4673
|
+
City?: string | null;
|
|
4674
|
+
/**
|
|
4675
|
+
* @maxLength 250
|
|
4676
|
+
* @nullable
|
|
4677
|
+
*/
|
|
4678
|
+
State?: string | null;
|
|
4679
|
+
/**
|
|
4680
|
+
* @maxLength 250
|
|
4681
|
+
* @nullable
|
|
4682
|
+
*/
|
|
4683
|
+
PostalCode?: string | null;
|
|
4684
|
+
/**
|
|
4685
|
+
* @maxLength 250
|
|
4686
|
+
* @nullable
|
|
4687
|
+
*/
|
|
4688
|
+
Country?: string | null;
|
|
4689
|
+
/**
|
|
4690
|
+
* @maxLength 250
|
|
4691
|
+
* @nullable
|
|
4692
|
+
*/
|
|
4693
|
+
GeoLocation?: string | null;
|
|
4694
|
+
} | null;
|
|
4695
|
+
|
|
4843
4696
|
/**
|
|
4844
|
-
* Partial match on account name or exact account Uid
|
|
4845
4697
|
* @nullable
|
|
4846
4698
|
*/
|
|
4847
|
-
|
|
4699
|
+
export type PersonSegmentAddedWebhookPayloadPersonAccountItemAccount = {
|
|
4700
|
+
/**
|
|
4701
|
+
* @maxLength 10
|
|
4702
|
+
* @nullable
|
|
4703
|
+
*/
|
|
4704
|
+
Uid?: string | null;
|
|
4705
|
+
/** @nullable */
|
|
4706
|
+
_objectType?: string | null;
|
|
4707
|
+
} | null;
|
|
4708
|
+
|
|
4709
|
+
export type PersonSegmentAddedWebhookPayloadPersonAccountItem = {
|
|
4710
|
+
/**
|
|
4711
|
+
* @maxLength 10
|
|
4712
|
+
* @nullable
|
|
4713
|
+
*/
|
|
4714
|
+
Uid?: string | null;
|
|
4715
|
+
/** @nullable */
|
|
4716
|
+
_objectType?: string | null;
|
|
4717
|
+
/** @minLength 1 */
|
|
4718
|
+
Created: string;
|
|
4719
|
+
/** @minLength 1 */
|
|
4720
|
+
Updated: string;
|
|
4721
|
+
/** @nullable */
|
|
4722
|
+
Account?: PersonSegmentAddedWebhookPayloadPersonAccountItemAccount;
|
|
4723
|
+
IsPrimary?: boolean;
|
|
4724
|
+
ReceiveInvoices?: boolean;
|
|
4848
4725
|
};
|
|
4849
4726
|
|
|
4850
|
-
export type
|
|
4851
|
-
|
|
4727
|
+
export type PersonSegmentAddedWebhookPayloadDealPeopleItem = {
|
|
4728
|
+
/**
|
|
4729
|
+
* @maxLength 10
|
|
4730
|
+
* @nullable
|
|
4731
|
+
*/
|
|
4732
|
+
Uid?: string | null;
|
|
4733
|
+
/** @nullable */
|
|
4734
|
+
_objectType?: string | null;
|
|
4735
|
+
/** @minLength 1 */
|
|
4736
|
+
Created: string;
|
|
4737
|
+
/** @minLength 1 */
|
|
4738
|
+
Updated: string;
|
|
4739
|
+
};
|
|
4740
|
+
|
|
4741
|
+
export type PersonSegmentAddedWebhookPayloadLeadFormSubmissionsItem = {
|
|
4742
|
+
/**
|
|
4743
|
+
* @maxLength 10
|
|
4744
|
+
* @nullable
|
|
4745
|
+
*/
|
|
4746
|
+
Uid?: string | null;
|
|
4747
|
+
/** @nullable */
|
|
4748
|
+
_objectType?: string | null;
|
|
4749
|
+
/** @minLength 1 */
|
|
4750
|
+
Created: string;
|
|
4751
|
+
/** @minLength 1 */
|
|
4752
|
+
Updated: string;
|
|
4753
|
+
/** @nullable */
|
|
4754
|
+
RefererURL?: string | null;
|
|
4755
|
+
/** @nullable */
|
|
4756
|
+
RecaptchaToken?: string | null;
|
|
4757
|
+
/** @nullable */
|
|
4758
|
+
RecaptchaSiteKey?: string | null;
|
|
4852
4759
|
};
|
|
4853
4760
|
|
|
4854
4761
|
/**
|
|
4855
|
-
*
|
|
4762
|
+
* `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused, `10` - Created
|
|
4856
4763
|
*/
|
|
4857
|
-
export type
|
|
4764
|
+
export type PersonSegmentAddedWebhookPayloadAccountAccountStage = typeof PersonSegmentAddedWebhookPayloadAccountAccountStage[keyof typeof PersonSegmentAddedWebhookPayloadAccountAccountStage];
|
|
4765
|
+
|
|
4766
|
+
|
|
4767
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
4768
|
+
export const PersonSegmentAddedWebhookPayloadAccountAccountStage = {
|
|
4769
|
+
Trialing: 2,
|
|
4770
|
+
Subscribing: 3,
|
|
4771
|
+
Cancelling: 4,
|
|
4772
|
+
Expired: 5,
|
|
4773
|
+
TrialExpired: 6,
|
|
4774
|
+
PastDue: 7,
|
|
4775
|
+
CancellingTrial: 8,
|
|
4776
|
+
Paused: 9,
|
|
4777
|
+
Created: 10,
|
|
4778
|
+
} as const;
|
|
4779
|
+
|
|
4780
|
+
/**
|
|
4781
|
+
* @nullable
|
|
4782
|
+
*/
|
|
4783
|
+
export type PersonSegmentAddedWebhookPayloadAccount = {
|
|
4784
|
+
/**
|
|
4785
|
+
* @maxLength 10
|
|
4786
|
+
* @nullable
|
|
4787
|
+
*/
|
|
4788
|
+
Uid?: string | null;
|
|
4789
|
+
/** @nullable */
|
|
4790
|
+
_objectType?: string | null;
|
|
4791
|
+
/** @minLength 1 */
|
|
4792
|
+
Created?: string;
|
|
4793
|
+
/** @minLength 1 */
|
|
4794
|
+
Updated?: string;
|
|
4795
|
+
/**
|
|
4796
|
+
* @maxLength 255
|
|
4797
|
+
* @nullable
|
|
4798
|
+
*/
|
|
4799
|
+
StripeId?: string | null;
|
|
4800
|
+
IsLivemode?: boolean;
|
|
4801
|
+
/**
|
|
4802
|
+
* @minLength 1
|
|
4803
|
+
* @maxLength 250
|
|
4804
|
+
*/
|
|
4805
|
+
Name?: string;
|
|
4806
|
+
/**
|
|
4807
|
+
* @maxLength 250
|
|
4808
|
+
* @nullable
|
|
4809
|
+
*/
|
|
4810
|
+
ClientIdentifier?: string | null;
|
|
4811
|
+
/**
|
|
4812
|
+
* @maxLength 3
|
|
4813
|
+
* @nullable
|
|
4814
|
+
*/
|
|
4815
|
+
Currency?: string | null;
|
|
4816
|
+
/** @nullable */
|
|
4817
|
+
InvoiceNotes?: string | null;
|
|
4818
|
+
IsDemo?: boolean;
|
|
4819
|
+
/** `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused, `10` - Created */
|
|
4820
|
+
AccountStage?: PersonSegmentAddedWebhookPayloadAccountAccountStage;
|
|
4821
|
+
/**
|
|
4822
|
+
* @maxLength 50
|
|
4823
|
+
* @nullable
|
|
4824
|
+
*/
|
|
4825
|
+
StripeDefaultPaymentMethodId?: string | null;
|
|
4826
|
+
/** @nullable */
|
|
4827
|
+
LastLoginDateTime?: string | null;
|
|
4828
|
+
/**
|
|
4829
|
+
* @maxLength 255
|
|
4830
|
+
* @nullable
|
|
4831
|
+
*/
|
|
4832
|
+
AccountSpecificPageUrl1?: string | null;
|
|
4833
|
+
/**
|
|
4834
|
+
* @maxLength 255
|
|
4835
|
+
* @nullable
|
|
4836
|
+
*/
|
|
4837
|
+
AccountSpecificPageUrl2?: string | null;
|
|
4838
|
+
/**
|
|
4839
|
+
* @maxLength 255
|
|
4840
|
+
* @nullable
|
|
4841
|
+
*/
|
|
4842
|
+
AccountSpecificPageUrl3?: string | null;
|
|
4843
|
+
/**
|
|
4844
|
+
* @maxLength 255
|
|
4845
|
+
* @nullable
|
|
4846
|
+
*/
|
|
4847
|
+
AccountSpecificPageUrl4?: string | null;
|
|
4848
|
+
/**
|
|
4849
|
+
* @maxLength 255
|
|
4850
|
+
* @nullable
|
|
4851
|
+
*/
|
|
4852
|
+
AccountSpecificPageUrl5?: string | null;
|
|
4853
|
+
/**
|
|
4854
|
+
* @maxLength 255
|
|
4855
|
+
* @nullable
|
|
4856
|
+
*/
|
|
4857
|
+
AccountSpecificPageUrl6?: string | null;
|
|
4858
|
+
/**
|
|
4859
|
+
* @maxLength 255
|
|
4860
|
+
* @nullable
|
|
4861
|
+
*/
|
|
4862
|
+
AccountSpecificPageUrl7?: string | null;
|
|
4863
|
+
/**
|
|
4864
|
+
* @maxLength 255
|
|
4865
|
+
* @nullable
|
|
4866
|
+
*/
|
|
4867
|
+
AccountSpecificPageUrl8?: string | null;
|
|
4868
|
+
/**
|
|
4869
|
+
* @maxLength 255
|
|
4870
|
+
* @nullable
|
|
4871
|
+
*/
|
|
4872
|
+
AccountSpecificPageUrl9?: string | null;
|
|
4873
|
+
/**
|
|
4874
|
+
* @maxLength 255
|
|
4875
|
+
* @nullable
|
|
4876
|
+
*/
|
|
4877
|
+
AccountSpecificPageUrl10?: string | null;
|
|
4878
|
+
/** @nullable */
|
|
4879
|
+
RewardFulReferralId?: string | null;
|
|
4880
|
+
/**
|
|
4881
|
+
* @maxLength 36
|
|
4882
|
+
* @nullable
|
|
4883
|
+
*/
|
|
4884
|
+
ToltReferralId?: string | null;
|
|
4885
|
+
/**
|
|
4886
|
+
* @maxLength 20
|
|
4887
|
+
* @nullable
|
|
4888
|
+
*/
|
|
4889
|
+
TaxStatus?: string | null;
|
|
4890
|
+
/** @nullable */
|
|
4891
|
+
AccountStageLabel?: string | null;
|
|
4892
|
+
/** @nullable */
|
|
4893
|
+
CurrentStripeProducts?: string | null;
|
|
4894
|
+
/** @nullable */
|
|
4895
|
+
DomainName?: string | null;
|
|
4896
|
+
HasLoggedIn?: boolean;
|
|
4897
|
+
LifetimeRevenue?: number;
|
|
4898
|
+
/** @nullable */
|
|
4899
|
+
NextStripeInvoiceDate?: string | null;
|
|
4900
|
+
/** @nullable */
|
|
4901
|
+
Nonce?: string | null;
|
|
4902
|
+
/** @nullable */
|
|
4903
|
+
RecaptchaToken?: string | null;
|
|
4904
|
+
/** @nullable */
|
|
4905
|
+
StripeNextInvoiceSequence?: number | null;
|
|
4906
|
+
/** @nullable */
|
|
4907
|
+
StripePrice?: string[] | null;
|
|
4908
|
+
/** @nullable */
|
|
4909
|
+
StripePromotionCode?: string | null;
|
|
4910
|
+
/** @nullable */
|
|
4911
|
+
TaxId?: string | null;
|
|
4912
|
+
TaxIdIsInvalid?: boolean;
|
|
4913
|
+
/** @nullable */
|
|
4914
|
+
TaxIdType?: string | null;
|
|
4915
|
+
/** @nullable */
|
|
4916
|
+
WebflowSlug?: string | null;
|
|
4917
|
+
} | null;
|
|
4918
|
+
|
|
4919
|
+
/**
|
|
4920
|
+
* `1` - Subscribed, `2` - Unsubscribed, `3` - Cleaned, `4` - Confirmed
|
|
4921
|
+
*/
|
|
4922
|
+
export type PersonSegmentAddedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus = typeof PersonSegmentAddedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus[keyof typeof PersonSegmentAddedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus];
|
|
4923
|
+
|
|
4924
|
+
|
|
4925
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
4926
|
+
export const PersonSegmentAddedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus = {
|
|
4927
|
+
Subscribed: 1,
|
|
4928
|
+
Unsubscribed: 2,
|
|
4929
|
+
Cleaned: 3,
|
|
4930
|
+
Confirmed: 4,
|
|
4931
|
+
} as const;
|
|
4932
|
+
|
|
4933
|
+
export type PersonSegmentAddedWebhookPayloadEmailListPersonItem = {
|
|
4934
|
+
/**
|
|
4935
|
+
* @maxLength 10
|
|
4936
|
+
* @nullable
|
|
4937
|
+
*/
|
|
4938
|
+
Uid?: string | null;
|
|
4939
|
+
/** @nullable */
|
|
4940
|
+
_objectType?: string | null;
|
|
4941
|
+
/** @minLength 1 */
|
|
4942
|
+
Created: string;
|
|
4943
|
+
/** @minLength 1 */
|
|
4944
|
+
Updated: string;
|
|
4945
|
+
/** `1` - Subscribed, `2` - Unsubscribed, `3` - Cleaned, `4` - Confirmed */
|
|
4946
|
+
EmailListSubscriberStatus?: PersonSegmentAddedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus;
|
|
4947
|
+
SubscribedDate?: string;
|
|
4948
|
+
/** @nullable */
|
|
4949
|
+
ConfirmedDate?: string | null;
|
|
4950
|
+
/**
|
|
4951
|
+
* @maxLength 500
|
|
4952
|
+
* @nullable
|
|
4953
|
+
*/
|
|
4954
|
+
ConfirmationNotes?: string | null;
|
|
4955
|
+
/** @nullable */
|
|
4956
|
+
UnsubscribedDate?: string | null;
|
|
4957
|
+
/** @nullable */
|
|
4958
|
+
CleanedDate?: string | null;
|
|
4959
|
+
/** @nullable */
|
|
4960
|
+
WelcomeEmailDeliverDateTime?: string | null;
|
|
4961
|
+
/** @nullable */
|
|
4962
|
+
WelcomeEmailOpenDateTime?: string | null;
|
|
4963
|
+
/**
|
|
4964
|
+
* @maxLength 20
|
|
4965
|
+
* @nullable
|
|
4966
|
+
*/
|
|
4967
|
+
UnsubscribeReason?: string | null;
|
|
4968
|
+
/** @nullable */
|
|
4969
|
+
UnsubscribeReasonOther?: string | null;
|
|
4970
|
+
/** @nullable */
|
|
4971
|
+
RecaptchaToken?: string | null;
|
|
4972
|
+
/** @nullable */
|
|
4973
|
+
RecaptchaSiteKey?: string | null;
|
|
4974
|
+
SendWelcomeEmail?: boolean;
|
|
4975
|
+
/** @nullable */
|
|
4976
|
+
Source?: string | null;
|
|
4977
|
+
};
|
|
4978
|
+
|
|
4979
|
+
/**
|
|
4980
|
+
* `0` - None, `1` - Gmail
|
|
4981
|
+
*/
|
|
4982
|
+
export type PersonSegmentAddedWebhookPayloadOAuthIntegrationStatus = typeof PersonSegmentAddedWebhookPayloadOAuthIntegrationStatus[keyof typeof PersonSegmentAddedWebhookPayloadOAuthIntegrationStatus];
|
|
4983
|
+
|
|
4984
|
+
|
|
4985
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
4986
|
+
export const PersonSegmentAddedWebhookPayloadOAuthIntegrationStatus = {
|
|
4987
|
+
None: 0,
|
|
4988
|
+
Gmail: 1,
|
|
4989
|
+
} as const;
|
|
4990
|
+
|
|
4991
|
+
/**
|
|
4992
|
+
* @nullable
|
|
4993
|
+
*/
|
|
4994
|
+
export type PersonSegmentAddedWebhookPayloadDiscordUser = {
|
|
4995
|
+
/**
|
|
4996
|
+
* @maxLength 10
|
|
4997
|
+
* @nullable
|
|
4998
|
+
*/
|
|
4999
|
+
Uid?: string | null;
|
|
5000
|
+
/** @nullable */
|
|
5001
|
+
_objectType?: string | null;
|
|
5002
|
+
/** @minLength 1 */
|
|
5003
|
+
Created?: string;
|
|
5004
|
+
/** @minLength 1 */
|
|
5005
|
+
Updated?: string;
|
|
5006
|
+
/**
|
|
5007
|
+
* @maxLength 250
|
|
5008
|
+
* @nullable
|
|
5009
|
+
*/
|
|
5010
|
+
DiscordUserId?: string | null;
|
|
5011
|
+
/**
|
|
5012
|
+
* @maxLength 250
|
|
5013
|
+
* @nullable
|
|
5014
|
+
*/
|
|
5015
|
+
DiscordEmail?: string | null;
|
|
5016
|
+
/**
|
|
5017
|
+
* @maxLength 250
|
|
5018
|
+
* @nullable
|
|
5019
|
+
*/
|
|
5020
|
+
DiscordUsername?: string | null;
|
|
5021
|
+
/** @nullable */
|
|
5022
|
+
DiscordOAuthRefreshToken?: string | null;
|
|
5023
|
+
} | null;
|
|
5024
|
+
|
|
5025
|
+
export interface PersonSegmentAddedWebhookPayload {
|
|
5026
|
+
/**
|
|
5027
|
+
* @maxLength 10
|
|
5028
|
+
* @nullable
|
|
5029
|
+
*/
|
|
5030
|
+
Uid?: string | null;
|
|
5031
|
+
/** @nullable */
|
|
5032
|
+
_objectType?: string | null;
|
|
5033
|
+
/** @minLength 1 */
|
|
5034
|
+
Created: string;
|
|
5035
|
+
/** @minLength 1 */
|
|
5036
|
+
Updated: string;
|
|
5037
|
+
/**
|
|
5038
|
+
* @maxLength 250
|
|
5039
|
+
* @nullable
|
|
5040
|
+
*/
|
|
5041
|
+
Email?: string | null;
|
|
5042
|
+
/**
|
|
5043
|
+
* @maxLength 250
|
|
5044
|
+
* @nullable
|
|
5045
|
+
*/
|
|
5046
|
+
FirstName?: string | null;
|
|
5047
|
+
/**
|
|
5048
|
+
* @maxLength 250
|
|
5049
|
+
* @nullable
|
|
5050
|
+
*/
|
|
5051
|
+
LastName?: string | null;
|
|
5052
|
+
/** @nullable */
|
|
5053
|
+
MailingAddress?: PersonSegmentAddedWebhookPayloadMailingAddress;
|
|
5054
|
+
/** @nullable */
|
|
5055
|
+
PasswordLastUpdated?: string | null;
|
|
5056
|
+
PasswordMustChange?: boolean;
|
|
5057
|
+
/**
|
|
5058
|
+
* @maxLength 250
|
|
5059
|
+
* @nullable
|
|
5060
|
+
*/
|
|
5061
|
+
PhoneMobile?: string | null;
|
|
5062
|
+
/**
|
|
5063
|
+
* @maxLength 250
|
|
5064
|
+
* @nullable
|
|
5065
|
+
*/
|
|
5066
|
+
PhoneWork?: string | null;
|
|
5067
|
+
/**
|
|
5068
|
+
* @maxLength 250
|
|
5069
|
+
* @nullable
|
|
5070
|
+
*/
|
|
5071
|
+
ProfileImageS3Url?: string | null;
|
|
5072
|
+
/**
|
|
5073
|
+
* @maxLength 250
|
|
5074
|
+
* @nullable
|
|
5075
|
+
*/
|
|
5076
|
+
Title?: string | null;
|
|
5077
|
+
/**
|
|
5078
|
+
* @maxLength 100
|
|
5079
|
+
* @nullable
|
|
5080
|
+
*/
|
|
5081
|
+
Timezone?: string | null;
|
|
5082
|
+
/**
|
|
5083
|
+
* @maxLength 50
|
|
5084
|
+
* @nullable
|
|
5085
|
+
*/
|
|
5086
|
+
Language?: string | null;
|
|
5087
|
+
/**
|
|
5088
|
+
* @maxLength 250
|
|
5089
|
+
* @nullable
|
|
5090
|
+
*/
|
|
5091
|
+
IPAddress?: string | null;
|
|
5092
|
+
/**
|
|
5093
|
+
* @maxLength 250
|
|
5094
|
+
* @nullable
|
|
5095
|
+
*/
|
|
5096
|
+
Referer?: string | null;
|
|
5097
|
+
/**
|
|
5098
|
+
* @maxLength 1000
|
|
5099
|
+
* @nullable
|
|
5100
|
+
*/
|
|
5101
|
+
UserAgent?: string | null;
|
|
5102
|
+
/** @nullable */
|
|
5103
|
+
LastLoginDateTime?: string | null;
|
|
5104
|
+
/**
|
|
5105
|
+
* @maxLength 50
|
|
5106
|
+
* @nullable
|
|
5107
|
+
*/
|
|
5108
|
+
OAuthGoogleProfileId?: string | null;
|
|
5109
|
+
/** @nullable */
|
|
5110
|
+
PersonAccount?: PersonSegmentAddedWebhookPayloadPersonAccountItem[] | null;
|
|
5111
|
+
/** @nullable */
|
|
5112
|
+
DealPeople?: PersonSegmentAddedWebhookPayloadDealPeopleItem[] | null;
|
|
5113
|
+
/** @nullable */
|
|
5114
|
+
LeadFormSubmissions?: PersonSegmentAddedWebhookPayloadLeadFormSubmissionsItem[] | null;
|
|
5115
|
+
/** @nullable */
|
|
5116
|
+
Account?: PersonSegmentAddedWebhookPayloadAccount;
|
|
5117
|
+
/** @nullable */
|
|
5118
|
+
AccountUids?: string | null;
|
|
5119
|
+
/** @nullable */
|
|
5120
|
+
EmailListPerson?: PersonSegmentAddedWebhookPayloadEmailListPersonItem[] | null;
|
|
5121
|
+
/** @nullable */
|
|
5122
|
+
FullName?: string | null;
|
|
5123
|
+
HasLoggedIn?: boolean;
|
|
5124
|
+
/** `0` - None, `1` - Gmail */
|
|
5125
|
+
OAuthIntegrationStatus?: PersonSegmentAddedWebhookPayloadOAuthIntegrationStatus;
|
|
5126
|
+
OptInToEmailList?: boolean;
|
|
5127
|
+
/** @nullable */
|
|
5128
|
+
Password?: string | null;
|
|
5129
|
+
/** @nullable */
|
|
5130
|
+
UserAgentPlatformBrowser?: string | null;
|
|
5131
|
+
HasUnsubscribed?: boolean;
|
|
5132
|
+
/** @nullable */
|
|
5133
|
+
DiscordUser?: PersonSegmentAddedWebhookPayloadDiscordUser;
|
|
5134
|
+
IsConnectedToDiscord?: boolean;
|
|
5135
|
+
ActivityEventData?: PersonSegmentAddedActivityData;
|
|
5136
|
+
}
|
|
5137
|
+
|
|
5138
|
+
export interface PersonSegmentRemovedActivityData {
|
|
5139
|
+
/** @nullable */
|
|
5140
|
+
SegmentUid?: string | null;
|
|
5141
|
+
/**
|
|
5142
|
+
* @deprecated
|
|
5143
|
+
* @nullable
|
|
5144
|
+
*/
|
|
5145
|
+
SegmentId?: string | null;
|
|
5146
|
+
}
|
|
5147
|
+
|
|
5148
|
+
/**
|
|
5149
|
+
* @nullable
|
|
5150
|
+
*/
|
|
5151
|
+
export type PersonSegmentRemovedWebhookPayloadMailingAddress = {
|
|
5152
|
+
/**
|
|
5153
|
+
* @maxLength 10
|
|
5154
|
+
* @nullable
|
|
5155
|
+
*/
|
|
5156
|
+
Uid?: string | null;
|
|
5157
|
+
/** @nullable */
|
|
5158
|
+
_objectType?: string | null;
|
|
5159
|
+
/** @minLength 1 */
|
|
5160
|
+
Created?: string;
|
|
5161
|
+
/** @minLength 1 */
|
|
5162
|
+
Updated?: string;
|
|
5163
|
+
/**
|
|
5164
|
+
* @maxLength 250
|
|
5165
|
+
* @nullable
|
|
5166
|
+
*/
|
|
5167
|
+
AddressLine1?: string | null;
|
|
5168
|
+
/**
|
|
5169
|
+
* @maxLength 250
|
|
5170
|
+
* @nullable
|
|
5171
|
+
*/
|
|
5172
|
+
AddressLine2?: string | null;
|
|
5173
|
+
/**
|
|
5174
|
+
* @maxLength 250
|
|
5175
|
+
* @nullable
|
|
5176
|
+
*/
|
|
5177
|
+
AddressLine3?: string | null;
|
|
5178
|
+
/**
|
|
5179
|
+
* @maxLength 250
|
|
5180
|
+
* @nullable
|
|
5181
|
+
*/
|
|
5182
|
+
City?: string | null;
|
|
5183
|
+
/**
|
|
5184
|
+
* @maxLength 250
|
|
5185
|
+
* @nullable
|
|
5186
|
+
*/
|
|
5187
|
+
State?: string | null;
|
|
5188
|
+
/**
|
|
5189
|
+
* @maxLength 250
|
|
5190
|
+
* @nullable
|
|
5191
|
+
*/
|
|
5192
|
+
PostalCode?: string | null;
|
|
5193
|
+
/**
|
|
5194
|
+
* @maxLength 250
|
|
5195
|
+
* @nullable
|
|
5196
|
+
*/
|
|
5197
|
+
Country?: string | null;
|
|
5198
|
+
/**
|
|
5199
|
+
* @maxLength 250
|
|
5200
|
+
* @nullable
|
|
5201
|
+
*/
|
|
5202
|
+
GeoLocation?: string | null;
|
|
5203
|
+
} | null;
|
|
5204
|
+
|
|
5205
|
+
/**
|
|
5206
|
+
* @nullable
|
|
5207
|
+
*/
|
|
5208
|
+
export type PersonSegmentRemovedWebhookPayloadPersonAccountItemAccount = {
|
|
5209
|
+
/**
|
|
5210
|
+
* @maxLength 10
|
|
5211
|
+
* @nullable
|
|
5212
|
+
*/
|
|
5213
|
+
Uid?: string | null;
|
|
5214
|
+
/** @nullable */
|
|
5215
|
+
_objectType?: string | null;
|
|
5216
|
+
} | null;
|
|
5217
|
+
|
|
5218
|
+
export type PersonSegmentRemovedWebhookPayloadPersonAccountItem = {
|
|
5219
|
+
/**
|
|
5220
|
+
* @maxLength 10
|
|
5221
|
+
* @nullable
|
|
5222
|
+
*/
|
|
5223
|
+
Uid?: string | null;
|
|
5224
|
+
/** @nullable */
|
|
5225
|
+
_objectType?: string | null;
|
|
5226
|
+
/** @minLength 1 */
|
|
5227
|
+
Created: string;
|
|
5228
|
+
/** @minLength 1 */
|
|
5229
|
+
Updated: string;
|
|
5230
|
+
/** @nullable */
|
|
5231
|
+
Account?: PersonSegmentRemovedWebhookPayloadPersonAccountItemAccount;
|
|
5232
|
+
IsPrimary?: boolean;
|
|
5233
|
+
ReceiveInvoices?: boolean;
|
|
5234
|
+
};
|
|
5235
|
+
|
|
5236
|
+
export type PersonSegmentRemovedWebhookPayloadDealPeopleItem = {
|
|
5237
|
+
/**
|
|
5238
|
+
* @maxLength 10
|
|
5239
|
+
* @nullable
|
|
5240
|
+
*/
|
|
5241
|
+
Uid?: string | null;
|
|
5242
|
+
/** @nullable */
|
|
5243
|
+
_objectType?: string | null;
|
|
5244
|
+
/** @minLength 1 */
|
|
5245
|
+
Created: string;
|
|
5246
|
+
/** @minLength 1 */
|
|
5247
|
+
Updated: string;
|
|
5248
|
+
};
|
|
5249
|
+
|
|
5250
|
+
export type PersonSegmentRemovedWebhookPayloadLeadFormSubmissionsItem = {
|
|
5251
|
+
/**
|
|
5252
|
+
* @maxLength 10
|
|
5253
|
+
* @nullable
|
|
5254
|
+
*/
|
|
5255
|
+
Uid?: string | null;
|
|
5256
|
+
/** @nullable */
|
|
5257
|
+
_objectType?: string | null;
|
|
5258
|
+
/** @minLength 1 */
|
|
5259
|
+
Created: string;
|
|
5260
|
+
/** @minLength 1 */
|
|
5261
|
+
Updated: string;
|
|
5262
|
+
/** @nullable */
|
|
5263
|
+
RefererURL?: string | null;
|
|
5264
|
+
/** @nullable */
|
|
5265
|
+
RecaptchaToken?: string | null;
|
|
5266
|
+
/** @nullable */
|
|
5267
|
+
RecaptchaSiteKey?: string | null;
|
|
5268
|
+
};
|
|
5269
|
+
|
|
5270
|
+
/**
|
|
5271
|
+
* `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused, `10` - Created
|
|
5272
|
+
*/
|
|
5273
|
+
export type PersonSegmentRemovedWebhookPayloadAccountAccountStage = typeof PersonSegmentRemovedWebhookPayloadAccountAccountStage[keyof typeof PersonSegmentRemovedWebhookPayloadAccountAccountStage];
|
|
5274
|
+
|
|
5275
|
+
|
|
5276
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
5277
|
+
export const PersonSegmentRemovedWebhookPayloadAccountAccountStage = {
|
|
5278
|
+
Trialing: 2,
|
|
5279
|
+
Subscribing: 3,
|
|
5280
|
+
Cancelling: 4,
|
|
5281
|
+
Expired: 5,
|
|
5282
|
+
TrialExpired: 6,
|
|
5283
|
+
PastDue: 7,
|
|
5284
|
+
CancellingTrial: 8,
|
|
5285
|
+
Paused: 9,
|
|
5286
|
+
Created: 10,
|
|
5287
|
+
} as const;
|
|
5288
|
+
|
|
5289
|
+
/**
|
|
5290
|
+
* @nullable
|
|
5291
|
+
*/
|
|
5292
|
+
export type PersonSegmentRemovedWebhookPayloadAccount = {
|
|
5293
|
+
/**
|
|
5294
|
+
* @maxLength 10
|
|
5295
|
+
* @nullable
|
|
5296
|
+
*/
|
|
5297
|
+
Uid?: string | null;
|
|
5298
|
+
/** @nullable */
|
|
5299
|
+
_objectType?: string | null;
|
|
5300
|
+
/** @minLength 1 */
|
|
5301
|
+
Created?: string;
|
|
5302
|
+
/** @minLength 1 */
|
|
5303
|
+
Updated?: string;
|
|
5304
|
+
/**
|
|
5305
|
+
* @maxLength 255
|
|
5306
|
+
* @nullable
|
|
5307
|
+
*/
|
|
5308
|
+
StripeId?: string | null;
|
|
5309
|
+
IsLivemode?: boolean;
|
|
5310
|
+
/**
|
|
5311
|
+
* @minLength 1
|
|
5312
|
+
* @maxLength 250
|
|
5313
|
+
*/
|
|
5314
|
+
Name?: string;
|
|
5315
|
+
/**
|
|
5316
|
+
* @maxLength 250
|
|
5317
|
+
* @nullable
|
|
5318
|
+
*/
|
|
5319
|
+
ClientIdentifier?: string | null;
|
|
5320
|
+
/**
|
|
5321
|
+
* @maxLength 3
|
|
5322
|
+
* @nullable
|
|
5323
|
+
*/
|
|
5324
|
+
Currency?: string | null;
|
|
5325
|
+
/** @nullable */
|
|
5326
|
+
InvoiceNotes?: string | null;
|
|
5327
|
+
IsDemo?: boolean;
|
|
5328
|
+
/** `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused, `10` - Created */
|
|
5329
|
+
AccountStage?: PersonSegmentRemovedWebhookPayloadAccountAccountStage;
|
|
5330
|
+
/**
|
|
5331
|
+
* @maxLength 50
|
|
5332
|
+
* @nullable
|
|
5333
|
+
*/
|
|
5334
|
+
StripeDefaultPaymentMethodId?: string | null;
|
|
5335
|
+
/** @nullable */
|
|
5336
|
+
LastLoginDateTime?: string | null;
|
|
5337
|
+
/**
|
|
5338
|
+
* @maxLength 255
|
|
5339
|
+
* @nullable
|
|
5340
|
+
*/
|
|
5341
|
+
AccountSpecificPageUrl1?: string | null;
|
|
5342
|
+
/**
|
|
5343
|
+
* @maxLength 255
|
|
5344
|
+
* @nullable
|
|
5345
|
+
*/
|
|
5346
|
+
AccountSpecificPageUrl2?: string | null;
|
|
5347
|
+
/**
|
|
5348
|
+
* @maxLength 255
|
|
5349
|
+
* @nullable
|
|
5350
|
+
*/
|
|
5351
|
+
AccountSpecificPageUrl3?: string | null;
|
|
5352
|
+
/**
|
|
5353
|
+
* @maxLength 255
|
|
5354
|
+
* @nullable
|
|
5355
|
+
*/
|
|
5356
|
+
AccountSpecificPageUrl4?: string | null;
|
|
5357
|
+
/**
|
|
5358
|
+
* @maxLength 255
|
|
5359
|
+
* @nullable
|
|
5360
|
+
*/
|
|
5361
|
+
AccountSpecificPageUrl5?: string | null;
|
|
5362
|
+
/**
|
|
5363
|
+
* @maxLength 255
|
|
5364
|
+
* @nullable
|
|
5365
|
+
*/
|
|
5366
|
+
AccountSpecificPageUrl6?: string | null;
|
|
5367
|
+
/**
|
|
5368
|
+
* @maxLength 255
|
|
5369
|
+
* @nullable
|
|
5370
|
+
*/
|
|
5371
|
+
AccountSpecificPageUrl7?: string | null;
|
|
5372
|
+
/**
|
|
5373
|
+
* @maxLength 255
|
|
5374
|
+
* @nullable
|
|
5375
|
+
*/
|
|
5376
|
+
AccountSpecificPageUrl8?: string | null;
|
|
5377
|
+
/**
|
|
5378
|
+
* @maxLength 255
|
|
5379
|
+
* @nullable
|
|
5380
|
+
*/
|
|
5381
|
+
AccountSpecificPageUrl9?: string | null;
|
|
5382
|
+
/**
|
|
5383
|
+
* @maxLength 255
|
|
5384
|
+
* @nullable
|
|
5385
|
+
*/
|
|
5386
|
+
AccountSpecificPageUrl10?: string | null;
|
|
5387
|
+
/** @nullable */
|
|
5388
|
+
RewardFulReferralId?: string | null;
|
|
5389
|
+
/**
|
|
5390
|
+
* @maxLength 36
|
|
5391
|
+
* @nullable
|
|
5392
|
+
*/
|
|
5393
|
+
ToltReferralId?: string | null;
|
|
5394
|
+
/**
|
|
5395
|
+
* @maxLength 20
|
|
5396
|
+
* @nullable
|
|
5397
|
+
*/
|
|
5398
|
+
TaxStatus?: string | null;
|
|
5399
|
+
/** @nullable */
|
|
5400
|
+
AccountStageLabel?: string | null;
|
|
5401
|
+
/** @nullable */
|
|
5402
|
+
CurrentStripeProducts?: string | null;
|
|
5403
|
+
/** @nullable */
|
|
5404
|
+
DomainName?: string | null;
|
|
5405
|
+
HasLoggedIn?: boolean;
|
|
5406
|
+
LifetimeRevenue?: number;
|
|
5407
|
+
/** @nullable */
|
|
5408
|
+
NextStripeInvoiceDate?: string | null;
|
|
5409
|
+
/** @nullable */
|
|
5410
|
+
Nonce?: string | null;
|
|
5411
|
+
/** @nullable */
|
|
5412
|
+
RecaptchaToken?: string | null;
|
|
5413
|
+
/** @nullable */
|
|
5414
|
+
StripeNextInvoiceSequence?: number | null;
|
|
5415
|
+
/** @nullable */
|
|
5416
|
+
StripePrice?: string[] | null;
|
|
5417
|
+
/** @nullable */
|
|
5418
|
+
StripePromotionCode?: string | null;
|
|
5419
|
+
/** @nullable */
|
|
5420
|
+
TaxId?: string | null;
|
|
5421
|
+
TaxIdIsInvalid?: boolean;
|
|
5422
|
+
/** @nullable */
|
|
5423
|
+
TaxIdType?: string | null;
|
|
5424
|
+
/** @nullable */
|
|
5425
|
+
WebflowSlug?: string | null;
|
|
5426
|
+
} | null;
|
|
5427
|
+
|
|
5428
|
+
/**
|
|
5429
|
+
* `1` - Subscribed, `2` - Unsubscribed, `3` - Cleaned, `4` - Confirmed
|
|
5430
|
+
*/
|
|
5431
|
+
export type PersonSegmentRemovedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus = typeof PersonSegmentRemovedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus[keyof typeof PersonSegmentRemovedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus];
|
|
5432
|
+
|
|
5433
|
+
|
|
5434
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
5435
|
+
export const PersonSegmentRemovedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus = {
|
|
5436
|
+
Subscribed: 1,
|
|
5437
|
+
Unsubscribed: 2,
|
|
5438
|
+
Cleaned: 3,
|
|
5439
|
+
Confirmed: 4,
|
|
5440
|
+
} as const;
|
|
5441
|
+
|
|
5442
|
+
export type PersonSegmentRemovedWebhookPayloadEmailListPersonItem = {
|
|
5443
|
+
/**
|
|
5444
|
+
* @maxLength 10
|
|
5445
|
+
* @nullable
|
|
5446
|
+
*/
|
|
5447
|
+
Uid?: string | null;
|
|
5448
|
+
/** @nullable */
|
|
5449
|
+
_objectType?: string | null;
|
|
5450
|
+
/** @minLength 1 */
|
|
5451
|
+
Created: string;
|
|
5452
|
+
/** @minLength 1 */
|
|
5453
|
+
Updated: string;
|
|
5454
|
+
/** `1` - Subscribed, `2` - Unsubscribed, `3` - Cleaned, `4` - Confirmed */
|
|
5455
|
+
EmailListSubscriberStatus?: PersonSegmentRemovedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus;
|
|
5456
|
+
SubscribedDate?: string;
|
|
5457
|
+
/** @nullable */
|
|
5458
|
+
ConfirmedDate?: string | null;
|
|
5459
|
+
/**
|
|
5460
|
+
* @maxLength 500
|
|
5461
|
+
* @nullable
|
|
5462
|
+
*/
|
|
5463
|
+
ConfirmationNotes?: string | null;
|
|
5464
|
+
/** @nullable */
|
|
5465
|
+
UnsubscribedDate?: string | null;
|
|
5466
|
+
/** @nullable */
|
|
5467
|
+
CleanedDate?: string | null;
|
|
5468
|
+
/** @nullable */
|
|
5469
|
+
WelcomeEmailDeliverDateTime?: string | null;
|
|
5470
|
+
/** @nullable */
|
|
5471
|
+
WelcomeEmailOpenDateTime?: string | null;
|
|
5472
|
+
/**
|
|
5473
|
+
* @maxLength 20
|
|
5474
|
+
* @nullable
|
|
5475
|
+
*/
|
|
5476
|
+
UnsubscribeReason?: string | null;
|
|
5477
|
+
/** @nullable */
|
|
5478
|
+
UnsubscribeReasonOther?: string | null;
|
|
5479
|
+
/** @nullable */
|
|
5480
|
+
RecaptchaToken?: string | null;
|
|
5481
|
+
/** @nullable */
|
|
5482
|
+
RecaptchaSiteKey?: string | null;
|
|
5483
|
+
SendWelcomeEmail?: boolean;
|
|
5484
|
+
/** @nullable */
|
|
5485
|
+
Source?: string | null;
|
|
5486
|
+
};
|
|
5487
|
+
|
|
5488
|
+
/**
|
|
5489
|
+
* `0` - None, `1` - Gmail
|
|
5490
|
+
*/
|
|
5491
|
+
export type PersonSegmentRemovedWebhookPayloadOAuthIntegrationStatus = typeof PersonSegmentRemovedWebhookPayloadOAuthIntegrationStatus[keyof typeof PersonSegmentRemovedWebhookPayloadOAuthIntegrationStatus];
|
|
5492
|
+
|
|
5493
|
+
|
|
5494
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
5495
|
+
export const PersonSegmentRemovedWebhookPayloadOAuthIntegrationStatus = {
|
|
5496
|
+
None: 0,
|
|
5497
|
+
Gmail: 1,
|
|
5498
|
+
} as const;
|
|
5499
|
+
|
|
5500
|
+
/**
|
|
5501
|
+
* @nullable
|
|
5502
|
+
*/
|
|
5503
|
+
export type PersonSegmentRemovedWebhookPayloadDiscordUser = {
|
|
5504
|
+
/**
|
|
5505
|
+
* @maxLength 10
|
|
5506
|
+
* @nullable
|
|
5507
|
+
*/
|
|
5508
|
+
Uid?: string | null;
|
|
5509
|
+
/** @nullable */
|
|
5510
|
+
_objectType?: string | null;
|
|
5511
|
+
/** @minLength 1 */
|
|
5512
|
+
Created?: string;
|
|
5513
|
+
/** @minLength 1 */
|
|
5514
|
+
Updated?: string;
|
|
5515
|
+
/**
|
|
5516
|
+
* @maxLength 250
|
|
5517
|
+
* @nullable
|
|
5518
|
+
*/
|
|
5519
|
+
DiscordUserId?: string | null;
|
|
5520
|
+
/**
|
|
5521
|
+
* @maxLength 250
|
|
5522
|
+
* @nullable
|
|
5523
|
+
*/
|
|
5524
|
+
DiscordEmail?: string | null;
|
|
5525
|
+
/**
|
|
5526
|
+
* @maxLength 250
|
|
5527
|
+
* @nullable
|
|
5528
|
+
*/
|
|
5529
|
+
DiscordUsername?: string | null;
|
|
5530
|
+
/** @nullable */
|
|
5531
|
+
DiscordOAuthRefreshToken?: string | null;
|
|
5532
|
+
} | null;
|
|
5533
|
+
|
|
5534
|
+
export interface PersonSegmentRemovedWebhookPayload {
|
|
5535
|
+
/**
|
|
5536
|
+
* @maxLength 10
|
|
5537
|
+
* @nullable
|
|
5538
|
+
*/
|
|
5539
|
+
Uid?: string | null;
|
|
5540
|
+
/** @nullable */
|
|
5541
|
+
_objectType?: string | null;
|
|
5542
|
+
/** @minLength 1 */
|
|
5543
|
+
Created: string;
|
|
5544
|
+
/** @minLength 1 */
|
|
5545
|
+
Updated: string;
|
|
5546
|
+
/**
|
|
5547
|
+
* @maxLength 250
|
|
5548
|
+
* @nullable
|
|
5549
|
+
*/
|
|
5550
|
+
Email?: string | null;
|
|
5551
|
+
/**
|
|
5552
|
+
* @maxLength 250
|
|
5553
|
+
* @nullable
|
|
5554
|
+
*/
|
|
5555
|
+
FirstName?: string | null;
|
|
5556
|
+
/**
|
|
5557
|
+
* @maxLength 250
|
|
5558
|
+
* @nullable
|
|
5559
|
+
*/
|
|
5560
|
+
LastName?: string | null;
|
|
5561
|
+
/** @nullable */
|
|
5562
|
+
MailingAddress?: PersonSegmentRemovedWebhookPayloadMailingAddress;
|
|
5563
|
+
/** @nullable */
|
|
5564
|
+
PasswordLastUpdated?: string | null;
|
|
5565
|
+
PasswordMustChange?: boolean;
|
|
5566
|
+
/**
|
|
5567
|
+
* @maxLength 250
|
|
5568
|
+
* @nullable
|
|
5569
|
+
*/
|
|
5570
|
+
PhoneMobile?: string | null;
|
|
5571
|
+
/**
|
|
5572
|
+
* @maxLength 250
|
|
5573
|
+
* @nullable
|
|
5574
|
+
*/
|
|
5575
|
+
PhoneWork?: string | null;
|
|
5576
|
+
/**
|
|
5577
|
+
* @maxLength 250
|
|
5578
|
+
* @nullable
|
|
5579
|
+
*/
|
|
5580
|
+
ProfileImageS3Url?: string | null;
|
|
5581
|
+
/**
|
|
5582
|
+
* @maxLength 250
|
|
5583
|
+
* @nullable
|
|
5584
|
+
*/
|
|
5585
|
+
Title?: string | null;
|
|
5586
|
+
/**
|
|
5587
|
+
* @maxLength 100
|
|
5588
|
+
* @nullable
|
|
5589
|
+
*/
|
|
5590
|
+
Timezone?: string | null;
|
|
5591
|
+
/**
|
|
5592
|
+
* @maxLength 50
|
|
5593
|
+
* @nullable
|
|
5594
|
+
*/
|
|
5595
|
+
Language?: string | null;
|
|
5596
|
+
/**
|
|
5597
|
+
* @maxLength 250
|
|
5598
|
+
* @nullable
|
|
5599
|
+
*/
|
|
5600
|
+
IPAddress?: string | null;
|
|
5601
|
+
/**
|
|
5602
|
+
* @maxLength 250
|
|
5603
|
+
* @nullable
|
|
5604
|
+
*/
|
|
5605
|
+
Referer?: string | null;
|
|
5606
|
+
/**
|
|
5607
|
+
* @maxLength 1000
|
|
5608
|
+
* @nullable
|
|
5609
|
+
*/
|
|
5610
|
+
UserAgent?: string | null;
|
|
5611
|
+
/** @nullable */
|
|
5612
|
+
LastLoginDateTime?: string | null;
|
|
5613
|
+
/**
|
|
5614
|
+
* @maxLength 50
|
|
5615
|
+
* @nullable
|
|
5616
|
+
*/
|
|
5617
|
+
OAuthGoogleProfileId?: string | null;
|
|
5618
|
+
/** @nullable */
|
|
5619
|
+
PersonAccount?: PersonSegmentRemovedWebhookPayloadPersonAccountItem[] | null;
|
|
5620
|
+
/** @nullable */
|
|
5621
|
+
DealPeople?: PersonSegmentRemovedWebhookPayloadDealPeopleItem[] | null;
|
|
5622
|
+
/** @nullable */
|
|
5623
|
+
LeadFormSubmissions?: PersonSegmentRemovedWebhookPayloadLeadFormSubmissionsItem[] | null;
|
|
5624
|
+
/** @nullable */
|
|
5625
|
+
Account?: PersonSegmentRemovedWebhookPayloadAccount;
|
|
5626
|
+
/** @nullable */
|
|
5627
|
+
AccountUids?: string | null;
|
|
5628
|
+
/** @nullable */
|
|
5629
|
+
EmailListPerson?: PersonSegmentRemovedWebhookPayloadEmailListPersonItem[] | null;
|
|
5630
|
+
/** @nullable */
|
|
5631
|
+
FullName?: string | null;
|
|
5632
|
+
HasLoggedIn?: boolean;
|
|
5633
|
+
/** `0` - None, `1` - Gmail */
|
|
5634
|
+
OAuthIntegrationStatus?: PersonSegmentRemovedWebhookPayloadOAuthIntegrationStatus;
|
|
5635
|
+
OptInToEmailList?: boolean;
|
|
5636
|
+
/** @nullable */
|
|
5637
|
+
Password?: string | null;
|
|
5638
|
+
/** @nullable */
|
|
5639
|
+
UserAgentPlatformBrowser?: string | null;
|
|
5640
|
+
HasUnsubscribed?: boolean;
|
|
5641
|
+
/** @nullable */
|
|
5642
|
+
DiscordUser?: PersonSegmentRemovedWebhookPayloadDiscordUser;
|
|
5643
|
+
IsConnectedToDiscord?: boolean;
|
|
5644
|
+
ActivityEventData?: PersonSegmentRemovedActivityData;
|
|
5645
|
+
}
|
|
5646
|
+
|
|
5647
|
+
export type CaseGetAllCasesParams = {
|
|
5648
|
+
/**
|
|
5649
|
+
* Search string
|
|
5650
|
+
* @nullable
|
|
5651
|
+
*/
|
|
5652
|
+
q?: string | null;
|
|
5653
|
+
/**
|
|
5654
|
+
* Uid of tag that is on the case
|
|
5655
|
+
* @nullable
|
|
5656
|
+
*/
|
|
5657
|
+
tagUid?: string | null;
|
|
5658
|
+
};
|
|
5659
|
+
|
|
5660
|
+
export type CaseAddCaseParams = {
|
|
5661
|
+
/**
|
|
5662
|
+
* Indicates whether an automatic message is sent that the ticket has been created.
|
|
5663
|
+
* @nullable
|
|
5664
|
+
*/
|
|
5665
|
+
sendautoresponder?: string | null;
|
|
5666
|
+
};
|
|
5667
|
+
|
|
5668
|
+
/**
|
|
5669
|
+
* @nullable
|
|
5670
|
+
*/
|
|
5671
|
+
export type CaseAddCaseBody = Case | null;
|
|
5672
|
+
|
|
5673
|
+
export type ArticleGetAllArticlesParams = {
|
|
5674
|
+
/**
|
|
5675
|
+
* @nullable
|
|
5676
|
+
*/
|
|
5677
|
+
q?: string | null;
|
|
5678
|
+
};
|
|
5679
|
+
|
|
5680
|
+
/**
|
|
5681
|
+
* @nullable
|
|
5682
|
+
*/
|
|
5683
|
+
export type CampaignAddBroadcastEmailBody = BroadcastCampaign | null;
|
|
5684
|
+
|
|
5685
|
+
/**
|
|
5686
|
+
* @nullable
|
|
5687
|
+
*/
|
|
5688
|
+
export type CampaignUpdateBroadcastEmailBody = BroadcastCampaign | null;
|
|
5689
|
+
|
|
5690
|
+
/**
|
|
5691
|
+
* @nullable
|
|
5692
|
+
*/
|
|
5693
|
+
export type CampaignSendTestCampaignEmailBody = SendTestEmailRequest2 | null;
|
|
5694
|
+
|
|
5695
|
+
export type EmailListGetAllSubscriptionsParams = {
|
|
5696
|
+
/**
|
|
5697
|
+
* Matches person's first name or last name or email address.
|
|
5698
|
+
* @nullable
|
|
5699
|
+
*/
|
|
5700
|
+
q?: string | null;
|
|
5701
|
+
};
|
|
5702
|
+
|
|
5703
|
+
/**
|
|
5704
|
+
* @nullable
|
|
5705
|
+
*/
|
|
5706
|
+
export type EmailListAddSubscriptionBody = EmailListPerson | null;
|
|
5707
|
+
|
|
5708
|
+
export type DealGetAllDealsParams = {
|
|
5709
|
+
/**
|
|
5710
|
+
* Uid of the owner of the deal, or -1 for unassigned deals and -2 for all assigned deals.
|
|
5711
|
+
* @nullable
|
|
5712
|
+
*/
|
|
5713
|
+
ownerUid?: string | null;
|
|
5714
|
+
/**
|
|
5715
|
+
* Match on the deal name, the pipeline stage name, or the account name.
|
|
5716
|
+
* @nullable
|
|
5717
|
+
*/
|
|
5718
|
+
q?: string | null;
|
|
5719
|
+
};
|
|
5720
|
+
|
|
5721
|
+
/**
|
|
5722
|
+
* @nullable
|
|
5723
|
+
*/
|
|
5724
|
+
export type DealAddDealBody = Deal | null;
|
|
5725
|
+
|
|
5726
|
+
/**
|
|
5727
|
+
* @nullable
|
|
5728
|
+
*/
|
|
5729
|
+
export type DealUpdateDealBody = Deal | null;
|
|
5730
|
+
|
|
5731
|
+
export type AccountGetAllAccountsParams = {
|
|
5732
|
+
/**
|
|
5733
|
+
* Accounts are filtered based on whether they are associated with the segment
|
|
5734
|
+
* @nullable
|
|
5735
|
+
*/
|
|
5736
|
+
segmentUid?: string | null;
|
|
5737
|
+
/**
|
|
5738
|
+
* Partial match on account name or exact account Uid
|
|
5739
|
+
* @nullable
|
|
5740
|
+
*/
|
|
5741
|
+
q?: string | null;
|
|
5742
|
+
};
|
|
5743
|
+
|
|
5744
|
+
export type AccountAddAccountParams = {
|
|
5745
|
+
isImported?: boolean;
|
|
5746
|
+
};
|
|
5747
|
+
|
|
5748
|
+
/**
|
|
5749
|
+
* @nullable
|
|
5750
|
+
*/
|
|
5751
|
+
export type AccountAddAccountBody = Account | null;
|
|
5752
|
+
|
|
5753
|
+
/**
|
|
5754
|
+
* @nullable
|
|
5755
|
+
*/
|
|
5756
|
+
export type AccountUpdateAccountBody = Account | null;
|
|
5757
|
+
|
|
5758
|
+
/**
|
|
5759
|
+
* @nullable
|
|
5760
|
+
*/
|
|
5761
|
+
export type AccountAddPersonToAccountBody = PersonAccount | null;
|
|
5762
|
+
|
|
5763
|
+
/**
|
|
5764
|
+
* @nullable
|
|
5765
|
+
*/
|
|
5766
|
+
export type AccountUpdateMembershipBody = PersonAccount | null;
|
|
5767
|
+
|
|
5768
|
+
/**
|
|
5769
|
+
* @nullable
|
|
5770
|
+
*/
|
|
5771
|
+
export type AccountCancelAccountBody = AccountCancelation | null;
|
|
5772
|
+
|
|
5773
|
+
/**
|
|
5774
|
+
* @nullable
|
|
5775
|
+
*/
|
|
5776
|
+
export type AccountExtendTrialBody = ExtendTrialParams | null;
|
|
5777
|
+
|
|
5778
|
+
export type PersonGetAllPeopleParams = {
|
|
5779
|
+
/**
|
|
5780
|
+
* Match on the person's first or last name or email address
|
|
5781
|
+
* @nullable
|
|
5782
|
+
*/
|
|
5783
|
+
q?: string | null;
|
|
5784
|
+
};
|
|
5785
|
+
|
|
5786
|
+
/**
|
|
5787
|
+
* @nullable
|
|
5788
|
+
*/
|
|
5789
|
+
export type PersonAddPersonBody = Person | null;
|
|
5790
|
+
|
|
5791
|
+
/**
|
|
5792
|
+
* @nullable
|
|
5793
|
+
*/
|
|
5794
|
+
export type PersonUpdatePersonBody = Person | null;
|
|
5795
|
+
|
|
5796
|
+
/**
|
|
5797
|
+
* @nullable
|
|
5798
|
+
*/
|
|
5799
|
+
export type PersonSetTemporaryPasswordBody = TemporaryPasswordModel | null;
|
|
5800
|
+
|
|
5801
|
+
/**
|
|
5802
|
+
* @nullable
|
|
5803
|
+
*/
|
|
5804
|
+
export type PersonForgotPasswordBody = Person | null;
|
|
5805
|
+
|
|
5806
|
+
/**
|
|
5807
|
+
* @nullable
|
|
5808
|
+
*/
|
|
5809
|
+
export type DiscountCouponAddDiscountCouponBody = DiscountCoupon | null;
|
|
5810
|
+
|
|
5811
|
+
/**
|
|
5812
|
+
* @nullable
|
|
5813
|
+
*/
|
|
5814
|
+
export type UsageAddUsageBody = Usage | null;
|
|
5815
|
+
|
|
5816
|
+
/**
|
|
5817
|
+
* @nullable
|
|
5818
|
+
*/
|
|
5819
|
+
export type TransactionsAddPaymentTransactionBody = Transaction | null;
|
|
5820
|
+
|
|
5821
|
+
/**
|
|
5822
|
+
* @nullable
|
|
5823
|
+
*/
|
|
5824
|
+
export type PaymentInformationSavePaymentInformationBody = PaymentInformation | null;
|
|
5825
|
+
|
|
5826
|
+
/**
|
|
5827
|
+
* @nullable
|
|
5828
|
+
*/
|
|
5829
|
+
export type SubscriptionAddOnAddSubscriptionAddOnBody = SubscriptionAddOn | null;
|
|
5830
|
+
|
|
5831
|
+
/**
|
|
5832
|
+
* @nullable
|
|
5833
|
+
*/
|
|
5834
|
+
export type InvoiceAddInvoiceBody = Invoice | null;
|
|
5835
|
+
|
|
5836
|
+
/**
|
|
5837
|
+
* @nullable
|
|
5838
|
+
*/
|
|
5839
|
+
export type SubscriptionSetSubscriptionUpgradeRequiredBody = Subscription | null;
|
|
5840
|
+
|
|
5841
|
+
export type SubscriptionFirstTimeSubscriptionPreviewParams = {
|
|
5842
|
+
/**
|
|
5843
|
+
* Set to "renewal" to see the renewal invoice. Defaults to "now".
|
|
5844
|
+
* @nullable
|
|
5845
|
+
*/
|
|
5846
|
+
asOf?: string | null;
|
|
5847
|
+
};
|
|
5848
|
+
|
|
5849
|
+
/**
|
|
5850
|
+
* @nullable
|
|
5851
|
+
*/
|
|
5852
|
+
export type SubscriptionFirstTimeSubscriptionPreviewBody = Subscription | null;
|
|
5853
|
+
|
|
5854
|
+
/**
|
|
5855
|
+
* @nullable
|
|
5856
|
+
*/
|
|
5857
|
+
export type SubscriptionFirstTimeSubscriptionBody = Subscription | null;
|
|
5858
|
+
|
|
5859
|
+
export type SubscriptionChangeSubscriptionPreviewParams = {
|
|
5860
|
+
/**
|
|
5861
|
+
* If true, the subscription change takes effect immediately
|
|
5862
|
+
* @nullable
|
|
5863
|
+
*/
|
|
5864
|
+
startImmediately?: string | null;
|
|
5865
|
+
};
|
|
5866
|
+
|
|
5867
|
+
/**
|
|
5868
|
+
* @nullable
|
|
5869
|
+
*/
|
|
5870
|
+
export type SubscriptionChangeSubscriptionPreviewBody = Subscription | null;
|
|
5871
|
+
|
|
5872
|
+
export type SubscriptionChangeSubscriptionParams = {
|
|
5873
|
+
/**
|
|
5874
|
+
* If true, the subscription change takes effect immediately
|
|
5875
|
+
* @nullable
|
|
5876
|
+
*/
|
|
5877
|
+
startImmediately?: string | null;
|
|
5878
|
+
};
|
|
5879
|
+
|
|
5880
|
+
/**
|
|
5881
|
+
* @nullable
|
|
5882
|
+
*/
|
|
5883
|
+
export type SubscriptionChangeSubscriptionBody = Subscription | null;
|
|
5884
|
+
|
|
5885
|
+
export type ActivityGetAllParams = {
|
|
5886
|
+
/**
|
|
5887
|
+
* @nullable
|
|
5888
|
+
*/
|
|
5889
|
+
criteria?: ActivityCriteria[] | null;
|
|
5890
|
+
/**
|
|
5891
|
+
* @nullable
|
|
5892
|
+
*/
|
|
5893
|
+
ActivityType?: string | null;
|
|
5894
|
+
/**
|
|
5895
|
+
* @nullable
|
|
5896
|
+
*/
|
|
5897
|
+
EntityType?: string | null;
|
|
5898
|
+
/**
|
|
5899
|
+
* @nullable
|
|
5900
|
+
*/
|
|
5901
|
+
EntityUid?: string | null;
|
|
5902
|
+
};
|
|
5903
|
+
|
|
5904
|
+
/**
|
|
5905
|
+
* @nullable
|
|
5906
|
+
*/
|
|
5907
|
+
export type ActivityAddCustomActivityBody = Activity | null;
|
|
4858
5908
|
|