@outseta/react 0.2.1 → 0.2.3

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.
@@ -1,224 +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
2
  export type TranslationAllOf = {
223
3
  /**
224
4
  * @minLength 1
@@ -257,6 +37,8 @@ export interface AbstractBean {
257
37
  * @nullable
258
38
  */
259
39
  Uid?: string | null;
40
+ /** @nullable */
41
+ _objectType?: string | null;
260
42
  /** @minLength 1 */
261
43
  Created: string;
262
44
  /** @minLength 1 */
@@ -498,18 +280,8 @@ export type PersonAllOf = {
498
280
  LastName?: string | null;
499
281
  /** @nullable */
500
282
  MailingAddress?: PersonAllOfMailingAddress;
501
- /**
502
- * @maxLength 250
503
- * @nullable
504
- */
505
- PasswordHash?: string | null;
506
283
  /** @nullable */
507
284
  PasswordLastUpdated?: string | null;
508
- /**
509
- * @maxLength 250
510
- * @nullable
511
- */
512
- PasswordResetToken?: string | null;
513
285
  PasswordMustChange?: boolean;
514
286
  /**
515
287
  * @maxLength 250
@@ -1505,6 +1277,7 @@ export type StripePriceAllOf = {
1505
1277
  UnitAmount?: number | null;
1506
1278
  /** @nullable */
1507
1279
  UnitAmountDecimal?: number | null;
1280
+ ShowInSignUpForm?: boolean;
1508
1281
  /** @nullable */
1509
1282
  CurrencySymbol?: string | null;
1510
1283
  /** @nullable */
@@ -3374,7 +3147,7 @@ export type QcountConfigAllOf = {
3374
3147
  export type QcountConfig = AbstractQcountBean & QcountConfigAllOf;
3375
3148
 
3376
3149
  /**
3377
- * `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, `115` - Email_MarketingIpPool, `116` - Email_TransactionalIpPool, `117` - Email_LifecycleIpPool, `118` - Email_DomainAuthenticationConfigured, `119` - Email_BlacklistedInboundEmails, `120` - CRM_TeamMemberInviteEmailDisabled, `121` - PasswordPolicy, `123` - CRM_FieldSortingEnabled, `124` - CRM_RegistrationCallbackLocations, `125` - KnowledgeBaseVersion, `126` - Support_SpamThreshold, `127` - Email_RestrictedPhrases, `128` - KnowledgeBaseLanguage, `129` - Email_BroadcastGroupSendEnabled, `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, `300` - SqsQueueEnabled, `301` - PersonSegmentationStatusEnabled, `304` - SqsCampaignEmailQueueEnabled, `310` - Account_AutoIncrementClientIdentifier, `402` - SqsEmailLogQueueUrlOverride, `500` - Logging_Webhook_Enabled, `501` - Logging_Activty_Enabled, `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, `601` - SqsSendGridWebHookEventQueueUrlOverride
3150
+ * `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
3378
3151
  */
3379
3152
  export type QcountConfigSettingType = typeof QcountConfigSettingType[keyof typeof QcountConfigSettingType];
3380
3153
 
@@ -3393,12 +3166,7 @@ export const QcountConfigSettingType = {
3393
3166
  HostedProfileBackLink: 111,
3394
3167
  AccountCancellationReasonRequired: 112,
3395
3168
  Email_OutsetaBrandingDisabled: 114,
3396
- Email_MarketingIpPool: 115,
3397
- Email_TransactionalIpPool: 116,
3398
- Email_LifecycleIpPool: 117,
3399
- Email_DomainAuthenticationConfigured: 118,
3400
3169
  Email_BlacklistedInboundEmails: 119,
3401
- CRM_TeamMemberInviteEmailDisabled: 120,
3402
3170
  PasswordPolicy: 121,
3403
3171
  CRM_FieldSortingEnabled: 123,
3404
3172
  CRM_RegistrationCallbackLocations: 124,
@@ -3406,7 +3174,6 @@ export const QcountConfigSettingType = {
3406
3174
  Support_SpamThreshold: 126,
3407
3175
  Email_RestrictedPhrases: 127,
3408
3176
  KnowledgeBaseLanguage: 128,
3409
- Email_BroadcastGroupSendEnabled: 129,
3410
3177
  Billing_System: 130,
3411
3178
  Billing_RestrictSubscriptionActions: 131,
3412
3179
  Stripe_TaxEnabled: 190,
@@ -3417,13 +3184,6 @@ export const QcountConfigSettingType = {
3417
3184
  Webflow_SyncEnabled: 201,
3418
3185
  Webflow_SyncConfiguration: 202,
3419
3186
  Webflow_ApiVersion: 203,
3420
- SqsQueueEnabled: 300,
3421
- PersonSegmentationStatusEnabled: 301,
3422
- SqsCampaignEmailQueueEnabled: 304,
3423
- Account_AutoIncrementClientIdentifier: 310,
3424
- SqsEmailLogQueueUrlOverride: 402,
3425
- Logging_Webhook_Enabled: 500,
3426
- Logging_Activty_Enabled: 501,
3427
3187
  CopyQcount_AddOnMap: 550,
3428
3188
  CopyQcount_AccountMap: 551,
3429
3189
  CopyQcount_DiscountCouponMap: 552,
@@ -3443,7 +3203,6 @@ export const QcountConfigSettingType = {
3443
3203
  StripeMigration_SubscriptionAddOnExportIds: 577,
3444
3204
  StripeMigration_SubscriptionCutoverDate: 578,
3445
3205
  StripeMigration_LastPreCutoverExportSubscriptionId: 579,
3446
- SqsSendGridWebHookEventQueueUrlOverride: 601,
3447
3206
  } as const;
3448
3207
 
3449
3208
  export type DiscordServerAllOf = {
@@ -3799,6 +3558,11 @@ export type MessageAllOf = {
3799
3558
  EmailLinks?: EmailLink[] | null;
3800
3559
  SpamAssassinScore?: number;
3801
3560
  SpamStatus?: SpamStatus;
3561
+ /**
3562
+ * @maxLength 1024
3563
+ * @nullable
3564
+ */
3565
+ SpamReason?: string | null;
3802
3566
  };
3803
3567
 
3804
3568
  export type Message = AbstractQcountBean & MessageAllOf;
@@ -3845,11 +3609,6 @@ export interface SendTestEmailRequest {
3845
3609
  AdditionalRecipients?: string[] | null;
3846
3610
  }
3847
3611
 
3848
- /**
3849
- * @nullable
3850
- */
3851
- export type QcountAllOfLogDatabase = Database | null;
3852
-
3853
3612
  export type QcountAllOf = {
3854
3613
  /**
3855
3614
  * @maxLength 100
@@ -3936,11 +3695,6 @@ export type QcountAllOf = {
3936
3695
  * @nullable
3937
3696
  */
3938
3697
  AccountUid?: string | null;
3939
- /**
3940
- * @maxLength 250
3941
- * @nullable
3942
- */
3943
- LocationId?: string | null;
3944
3698
  /**
3945
3699
  * @maxLength 250
3946
3700
  * @nullable
@@ -3956,11 +3710,6 @@ export type QcountAllOf = {
3956
3710
  * @nullable
3957
3711
  */
3958
3712
  StripePublishableKey?: string | null;
3959
- /**
3960
- * @maxLength 250
3961
- * @nullable
3962
- */
3963
- StripeSecretKey?: string | null;
3964
3713
  /**
3965
3714
  * @maxLength 3
3966
3715
  * @nullable
@@ -3972,19 +3721,11 @@ export type QcountAllOf = {
3972
3721
  * @nullable
3973
3722
  */
3974
3723
  RecaptchaSiteKey?: string | null;
3975
- /**
3976
- * @maxLength 50
3977
- * @nullable
3978
- */
3979
- RecaptchaSecretKey?: string | null;
3980
3724
  /**
3981
3725
  * @maxLength 250
3982
3726
  * @nullable
3983
3727
  */
3984
3728
  RewardfulAPIKey?: string | null;
3985
- Database: Database;
3986
- /** @nullable */
3987
- LogDatabase?: QcountAllOfLogDatabase;
3988
3729
  /** @nullable */
3989
3730
  DomainPrefix?: string | null;
3990
3731
  /** @nullable */
@@ -3998,7 +3739,7 @@ export type QcountAllOf = {
3998
3739
  TaxEnabled?: boolean;
3999
3740
  };
4000
3741
 
4001
- export type Qcount = AbstractBean & QcountAllOf;
3742
+ export type Qcount = AbstractBean & QcountAllOf & Required<Pick<AbstractBean & QcountAllOf, 'Database'>>;
4002
3743
 
4003
3744
  /**
4004
3745
  * `0` - Active, `1` - Inactive, `2` - MarkedForDeletion, `3` - Deleted
@@ -4072,11 +3813,6 @@ export type ApiKeyAllOf = {
4072
3813
  * @nullable
4073
3814
  */
4074
3815
  Key?: string | null;
4075
- /**
4076
- * @maxLength 255
4077
- * @nullable
4078
- */
4079
- Secret?: string | null;
4080
3816
  /** @nullable */
4081
3817
  Qcount?: ApiKeyAllOfQcount;
4082
3818
  /** @nullable */
@@ -4107,11 +3843,6 @@ export type JwtKeyAllOf = {
4107
3843
  Active?: boolean;
4108
3844
  /** @nullable */
4109
3845
  X509CertificatePublic?: string | null;
4110
- /**
4111
- * @maxLength 255
4112
- * @nullable
4113
- */
4114
- Key?: string | null;
4115
3846
  /** @nullable */
4116
3847
  KeyInitial?: string | null;
4117
3848
  /** @nullable */
@@ -4901,6 +4632,1024 @@ export interface ActivityCriteria {
4901
4632
  ActivityTypes?: string[] | null;
4902
4633
  }
4903
4634
 
4635
+ export interface PersonSegmentAddedActivityData {
4636
+ /** @nullable */
4637
+ SegmentUid?: string | null;
4638
+ /**
4639
+ * @deprecated
4640
+ * @nullable
4641
+ */
4642
+ SegmentId?: string | null;
4643
+ }
4644
+
4645
+ /**
4646
+ * @nullable
4647
+ */
4648
+ export type PersonSegmentAddedWebhookPayloadMailingAddress = {
4649
+ /**
4650
+ * @maxLength 10
4651
+ * @nullable
4652
+ */
4653
+ Uid?: string | null;
4654
+ /** @nullable */
4655
+ _objectType?: string | null;
4656
+ /** @minLength 1 */
4657
+ Created?: string;
4658
+ /** @minLength 1 */
4659
+ Updated?: string;
4660
+ /**
4661
+ * @maxLength 250
4662
+ * @nullable
4663
+ */
4664
+ AddressLine1?: string | null;
4665
+ /**
4666
+ * @maxLength 250
4667
+ * @nullable
4668
+ */
4669
+ AddressLine2?: string | null;
4670
+ /**
4671
+ * @maxLength 250
4672
+ * @nullable
4673
+ */
4674
+ AddressLine3?: string | null;
4675
+ /**
4676
+ * @maxLength 250
4677
+ * @nullable
4678
+ */
4679
+ City?: string | null;
4680
+ /**
4681
+ * @maxLength 250
4682
+ * @nullable
4683
+ */
4684
+ State?: string | null;
4685
+ /**
4686
+ * @maxLength 250
4687
+ * @nullable
4688
+ */
4689
+ PostalCode?: string | null;
4690
+ /**
4691
+ * @maxLength 250
4692
+ * @nullable
4693
+ */
4694
+ Country?: string | null;
4695
+ /**
4696
+ * @maxLength 250
4697
+ * @nullable
4698
+ */
4699
+ GeoLocation?: string | null;
4700
+ } | null;
4701
+
4702
+ /**
4703
+ * @nullable
4704
+ */
4705
+ export type PersonSegmentAddedWebhookPayloadPersonAccountItemAccount = {
4706
+ /**
4707
+ * @maxLength 10
4708
+ * @nullable
4709
+ */
4710
+ Uid?: string | null;
4711
+ /** @nullable */
4712
+ _objectType?: string | null;
4713
+ } | null;
4714
+
4715
+ export type PersonSegmentAddedWebhookPayloadPersonAccountItem = {
4716
+ /**
4717
+ * @maxLength 10
4718
+ * @nullable
4719
+ */
4720
+ Uid?: string | null;
4721
+ /** @nullable */
4722
+ _objectType?: string | null;
4723
+ /** @minLength 1 */
4724
+ Created: string;
4725
+ /** @minLength 1 */
4726
+ Updated: string;
4727
+ /** @nullable */
4728
+ Account?: PersonSegmentAddedWebhookPayloadPersonAccountItemAccount;
4729
+ IsPrimary?: boolean;
4730
+ ReceiveInvoices?: boolean;
4731
+ };
4732
+
4733
+ export type PersonSegmentAddedWebhookPayloadDealPeopleItem = {
4734
+ /**
4735
+ * @maxLength 10
4736
+ * @nullable
4737
+ */
4738
+ Uid?: string | null;
4739
+ /** @nullable */
4740
+ _objectType?: string | null;
4741
+ /** @minLength 1 */
4742
+ Created: string;
4743
+ /** @minLength 1 */
4744
+ Updated: string;
4745
+ };
4746
+
4747
+ export type PersonSegmentAddedWebhookPayloadLeadFormSubmissionsItem = {
4748
+ /**
4749
+ * @maxLength 10
4750
+ * @nullable
4751
+ */
4752
+ Uid?: string | null;
4753
+ /** @nullable */
4754
+ _objectType?: string | null;
4755
+ /** @minLength 1 */
4756
+ Created: string;
4757
+ /** @minLength 1 */
4758
+ Updated: string;
4759
+ /** @nullable */
4760
+ RefererURL?: string | null;
4761
+ /** @nullable */
4762
+ RecaptchaToken?: string | null;
4763
+ /** @nullable */
4764
+ RecaptchaSiteKey?: string | null;
4765
+ };
4766
+
4767
+ /**
4768
+ * `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused, `10` - Created
4769
+ */
4770
+ export type PersonSegmentAddedWebhookPayloadAccountAccountStage = typeof PersonSegmentAddedWebhookPayloadAccountAccountStage[keyof typeof PersonSegmentAddedWebhookPayloadAccountAccountStage];
4771
+
4772
+
4773
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
4774
+ export const PersonSegmentAddedWebhookPayloadAccountAccountStage = {
4775
+ Trialing: 2,
4776
+ Subscribing: 3,
4777
+ Cancelling: 4,
4778
+ Expired: 5,
4779
+ TrialExpired: 6,
4780
+ PastDue: 7,
4781
+ CancellingTrial: 8,
4782
+ Paused: 9,
4783
+ Created: 10,
4784
+ } as const;
4785
+
4786
+ /**
4787
+ * @nullable
4788
+ */
4789
+ export type PersonSegmentAddedWebhookPayloadAccount = {
4790
+ /**
4791
+ * @maxLength 10
4792
+ * @nullable
4793
+ */
4794
+ Uid?: string | null;
4795
+ /** @nullable */
4796
+ _objectType?: string | null;
4797
+ /** @minLength 1 */
4798
+ Created?: string;
4799
+ /** @minLength 1 */
4800
+ Updated?: string;
4801
+ /**
4802
+ * @maxLength 255
4803
+ * @nullable
4804
+ */
4805
+ StripeId?: string | null;
4806
+ IsLivemode?: boolean;
4807
+ /**
4808
+ * @minLength 1
4809
+ * @maxLength 250
4810
+ */
4811
+ Name?: string;
4812
+ /**
4813
+ * @maxLength 250
4814
+ * @nullable
4815
+ */
4816
+ ClientIdentifier?: string | null;
4817
+ /**
4818
+ * @maxLength 3
4819
+ * @nullable
4820
+ */
4821
+ Currency?: string | null;
4822
+ /** @nullable */
4823
+ InvoiceNotes?: string | null;
4824
+ IsDemo?: boolean;
4825
+ /** `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused, `10` - Created */
4826
+ AccountStage?: PersonSegmentAddedWebhookPayloadAccountAccountStage;
4827
+ /**
4828
+ * @maxLength 50
4829
+ * @nullable
4830
+ */
4831
+ StripeDefaultPaymentMethodId?: string | null;
4832
+ /** @nullable */
4833
+ LastLoginDateTime?: string | null;
4834
+ /**
4835
+ * @maxLength 255
4836
+ * @nullable
4837
+ */
4838
+ AccountSpecificPageUrl1?: string | null;
4839
+ /**
4840
+ * @maxLength 255
4841
+ * @nullable
4842
+ */
4843
+ AccountSpecificPageUrl2?: string | null;
4844
+ /**
4845
+ * @maxLength 255
4846
+ * @nullable
4847
+ */
4848
+ AccountSpecificPageUrl3?: string | null;
4849
+ /**
4850
+ * @maxLength 255
4851
+ * @nullable
4852
+ */
4853
+ AccountSpecificPageUrl4?: string | null;
4854
+ /**
4855
+ * @maxLength 255
4856
+ * @nullable
4857
+ */
4858
+ AccountSpecificPageUrl5?: string | null;
4859
+ /**
4860
+ * @maxLength 255
4861
+ * @nullable
4862
+ */
4863
+ AccountSpecificPageUrl6?: string | null;
4864
+ /**
4865
+ * @maxLength 255
4866
+ * @nullable
4867
+ */
4868
+ AccountSpecificPageUrl7?: string | null;
4869
+ /**
4870
+ * @maxLength 255
4871
+ * @nullable
4872
+ */
4873
+ AccountSpecificPageUrl8?: string | null;
4874
+ /**
4875
+ * @maxLength 255
4876
+ * @nullable
4877
+ */
4878
+ AccountSpecificPageUrl9?: string | null;
4879
+ /**
4880
+ * @maxLength 255
4881
+ * @nullable
4882
+ */
4883
+ AccountSpecificPageUrl10?: string | null;
4884
+ /** @nullable */
4885
+ RewardFulReferralId?: string | null;
4886
+ /**
4887
+ * @maxLength 36
4888
+ * @nullable
4889
+ */
4890
+ ToltReferralId?: string | null;
4891
+ /**
4892
+ * @maxLength 20
4893
+ * @nullable
4894
+ */
4895
+ TaxStatus?: string | null;
4896
+ /** @nullable */
4897
+ AccountStageLabel?: string | null;
4898
+ /** @nullable */
4899
+ CurrentStripeProducts?: string | null;
4900
+ /** @nullable */
4901
+ DomainName?: string | null;
4902
+ HasLoggedIn?: boolean;
4903
+ LifetimeRevenue?: number;
4904
+ /** @nullable */
4905
+ NextStripeInvoiceDate?: string | null;
4906
+ /** @nullable */
4907
+ Nonce?: string | null;
4908
+ /** @nullable */
4909
+ RecaptchaToken?: string | null;
4910
+ /** @nullable */
4911
+ StripeNextInvoiceSequence?: number | null;
4912
+ /** @nullable */
4913
+ StripePrice?: string[] | null;
4914
+ /** @nullable */
4915
+ StripePromotionCode?: string | null;
4916
+ /** @nullable */
4917
+ TaxId?: string | null;
4918
+ TaxIdIsInvalid?: boolean;
4919
+ /** @nullable */
4920
+ TaxIdType?: string | null;
4921
+ /** @nullable */
4922
+ WebflowSlug?: string | null;
4923
+ } | null;
4924
+
4925
+ /**
4926
+ * `1` - Subscribed, `2` - Unsubscribed, `3` - Cleaned, `4` - Confirmed
4927
+ */
4928
+ export type PersonSegmentAddedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus = typeof PersonSegmentAddedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus[keyof typeof PersonSegmentAddedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus];
4929
+
4930
+
4931
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
4932
+ export const PersonSegmentAddedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus = {
4933
+ Subscribed: 1,
4934
+ Unsubscribed: 2,
4935
+ Cleaned: 3,
4936
+ Confirmed: 4,
4937
+ } as const;
4938
+
4939
+ export type PersonSegmentAddedWebhookPayloadEmailListPersonItem = {
4940
+ /**
4941
+ * @maxLength 10
4942
+ * @nullable
4943
+ */
4944
+ Uid?: string | null;
4945
+ /** @nullable */
4946
+ _objectType?: string | null;
4947
+ /** @minLength 1 */
4948
+ Created: string;
4949
+ /** @minLength 1 */
4950
+ Updated: string;
4951
+ /** `1` - Subscribed, `2` - Unsubscribed, `3` - Cleaned, `4` - Confirmed */
4952
+ EmailListSubscriberStatus?: PersonSegmentAddedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus;
4953
+ SubscribedDate?: string;
4954
+ /** @nullable */
4955
+ ConfirmedDate?: string | null;
4956
+ /**
4957
+ * @maxLength 500
4958
+ * @nullable
4959
+ */
4960
+ ConfirmationNotes?: string | null;
4961
+ /** @nullable */
4962
+ UnsubscribedDate?: string | null;
4963
+ /** @nullable */
4964
+ CleanedDate?: string | null;
4965
+ /** @nullable */
4966
+ WelcomeEmailDeliverDateTime?: string | null;
4967
+ /** @nullable */
4968
+ WelcomeEmailOpenDateTime?: string | null;
4969
+ /**
4970
+ * @maxLength 20
4971
+ * @nullable
4972
+ */
4973
+ UnsubscribeReason?: string | null;
4974
+ /** @nullable */
4975
+ UnsubscribeReasonOther?: string | null;
4976
+ /** @nullable */
4977
+ RecaptchaToken?: string | null;
4978
+ /** @nullable */
4979
+ RecaptchaSiteKey?: string | null;
4980
+ SendWelcomeEmail?: boolean;
4981
+ /** @nullable */
4982
+ Source?: string | null;
4983
+ };
4984
+
4985
+ /**
4986
+ * `0` - None, `1` - Gmail
4987
+ */
4988
+ export type PersonSegmentAddedWebhookPayloadOAuthIntegrationStatus = typeof PersonSegmentAddedWebhookPayloadOAuthIntegrationStatus[keyof typeof PersonSegmentAddedWebhookPayloadOAuthIntegrationStatus];
4989
+
4990
+
4991
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
4992
+ export const PersonSegmentAddedWebhookPayloadOAuthIntegrationStatus = {
4993
+ None: 0,
4994
+ Gmail: 1,
4995
+ } as const;
4996
+
4997
+ /**
4998
+ * @nullable
4999
+ */
5000
+ export type PersonSegmentAddedWebhookPayloadDiscordUser = {
5001
+ /**
5002
+ * @maxLength 10
5003
+ * @nullable
5004
+ */
5005
+ Uid?: string | null;
5006
+ /** @nullable */
5007
+ _objectType?: string | null;
5008
+ /** @minLength 1 */
5009
+ Created?: string;
5010
+ /** @minLength 1 */
5011
+ Updated?: string;
5012
+ /**
5013
+ * @maxLength 250
5014
+ * @nullable
5015
+ */
5016
+ DiscordUserId?: string | null;
5017
+ /**
5018
+ * @maxLength 250
5019
+ * @nullable
5020
+ */
5021
+ DiscordEmail?: string | null;
5022
+ /**
5023
+ * @maxLength 250
5024
+ * @nullable
5025
+ */
5026
+ DiscordUsername?: string | null;
5027
+ /** @nullable */
5028
+ DiscordOAuthRefreshToken?: string | null;
5029
+ } | null;
5030
+
5031
+ export interface PersonSegmentAddedWebhookPayload {
5032
+ /**
5033
+ * @maxLength 10
5034
+ * @nullable
5035
+ */
5036
+ Uid?: string | null;
5037
+ /** @nullable */
5038
+ _objectType?: string | null;
5039
+ /** @minLength 1 */
5040
+ Created: string;
5041
+ /** @minLength 1 */
5042
+ Updated: string;
5043
+ /**
5044
+ * @maxLength 250
5045
+ * @nullable
5046
+ */
5047
+ Email?: string | null;
5048
+ /**
5049
+ * @maxLength 250
5050
+ * @nullable
5051
+ */
5052
+ FirstName?: string | null;
5053
+ /**
5054
+ * @maxLength 250
5055
+ * @nullable
5056
+ */
5057
+ LastName?: string | null;
5058
+ /** @nullable */
5059
+ MailingAddress?: PersonSegmentAddedWebhookPayloadMailingAddress;
5060
+ /** @nullable */
5061
+ PasswordLastUpdated?: string | null;
5062
+ PasswordMustChange?: boolean;
5063
+ /**
5064
+ * @maxLength 250
5065
+ * @nullable
5066
+ */
5067
+ PhoneMobile?: string | null;
5068
+ /**
5069
+ * @maxLength 250
5070
+ * @nullable
5071
+ */
5072
+ PhoneWork?: string | null;
5073
+ /**
5074
+ * @maxLength 250
5075
+ * @nullable
5076
+ */
5077
+ ProfileImageS3Url?: string | null;
5078
+ /**
5079
+ * @maxLength 250
5080
+ * @nullable
5081
+ */
5082
+ Title?: string | null;
5083
+ /**
5084
+ * @maxLength 100
5085
+ * @nullable
5086
+ */
5087
+ Timezone?: string | null;
5088
+ /**
5089
+ * @maxLength 50
5090
+ * @nullable
5091
+ */
5092
+ Language?: string | null;
5093
+ /**
5094
+ * @maxLength 250
5095
+ * @nullable
5096
+ */
5097
+ IPAddress?: string | null;
5098
+ /**
5099
+ * @maxLength 250
5100
+ * @nullable
5101
+ */
5102
+ Referer?: string | null;
5103
+ /**
5104
+ * @maxLength 1000
5105
+ * @nullable
5106
+ */
5107
+ UserAgent?: string | null;
5108
+ /** @nullable */
5109
+ LastLoginDateTime?: string | null;
5110
+ /**
5111
+ * @maxLength 50
5112
+ * @nullable
5113
+ */
5114
+ OAuthGoogleProfileId?: string | null;
5115
+ /** @nullable */
5116
+ PersonAccount?: PersonSegmentAddedWebhookPayloadPersonAccountItem[] | null;
5117
+ /** @nullable */
5118
+ DealPeople?: PersonSegmentAddedWebhookPayloadDealPeopleItem[] | null;
5119
+ /** @nullable */
5120
+ LeadFormSubmissions?: PersonSegmentAddedWebhookPayloadLeadFormSubmissionsItem[] | null;
5121
+ /** @nullable */
5122
+ Account?: PersonSegmentAddedWebhookPayloadAccount;
5123
+ /** @nullable */
5124
+ AccountUids?: string | null;
5125
+ /** @nullable */
5126
+ EmailListPerson?: PersonSegmentAddedWebhookPayloadEmailListPersonItem[] | null;
5127
+ /** @nullable */
5128
+ FullName?: string | null;
5129
+ HasLoggedIn?: boolean;
5130
+ /** `0` - None, `1` - Gmail */
5131
+ OAuthIntegrationStatus?: PersonSegmentAddedWebhookPayloadOAuthIntegrationStatus;
5132
+ OptInToEmailList?: boolean;
5133
+ /** @nullable */
5134
+ Password?: string | null;
5135
+ /** @nullable */
5136
+ UserAgentPlatformBrowser?: string | null;
5137
+ HasUnsubscribed?: boolean;
5138
+ /** @nullable */
5139
+ DiscordUser?: PersonSegmentAddedWebhookPayloadDiscordUser;
5140
+ IsConnectedToDiscord?: boolean;
5141
+ ActivityEventData?: PersonSegmentAddedActivityData;
5142
+ }
5143
+
5144
+ export interface PersonSegmentRemovedActivityData {
5145
+ /** @nullable */
5146
+ SegmentUid?: string | null;
5147
+ /**
5148
+ * @deprecated
5149
+ * @nullable
5150
+ */
5151
+ SegmentId?: string | null;
5152
+ }
5153
+
5154
+ /**
5155
+ * @nullable
5156
+ */
5157
+ export type PersonSegmentRemovedWebhookPayloadMailingAddress = {
5158
+ /**
5159
+ * @maxLength 10
5160
+ * @nullable
5161
+ */
5162
+ Uid?: string | null;
5163
+ /** @nullable */
5164
+ _objectType?: string | null;
5165
+ /** @minLength 1 */
5166
+ Created?: string;
5167
+ /** @minLength 1 */
5168
+ Updated?: string;
5169
+ /**
5170
+ * @maxLength 250
5171
+ * @nullable
5172
+ */
5173
+ AddressLine1?: string | null;
5174
+ /**
5175
+ * @maxLength 250
5176
+ * @nullable
5177
+ */
5178
+ AddressLine2?: string | null;
5179
+ /**
5180
+ * @maxLength 250
5181
+ * @nullable
5182
+ */
5183
+ AddressLine3?: string | null;
5184
+ /**
5185
+ * @maxLength 250
5186
+ * @nullable
5187
+ */
5188
+ City?: string | null;
5189
+ /**
5190
+ * @maxLength 250
5191
+ * @nullable
5192
+ */
5193
+ State?: string | null;
5194
+ /**
5195
+ * @maxLength 250
5196
+ * @nullable
5197
+ */
5198
+ PostalCode?: string | null;
5199
+ /**
5200
+ * @maxLength 250
5201
+ * @nullable
5202
+ */
5203
+ Country?: string | null;
5204
+ /**
5205
+ * @maxLength 250
5206
+ * @nullable
5207
+ */
5208
+ GeoLocation?: string | null;
5209
+ } | null;
5210
+
5211
+ /**
5212
+ * @nullable
5213
+ */
5214
+ export type PersonSegmentRemovedWebhookPayloadPersonAccountItemAccount = {
5215
+ /**
5216
+ * @maxLength 10
5217
+ * @nullable
5218
+ */
5219
+ Uid?: string | null;
5220
+ /** @nullable */
5221
+ _objectType?: string | null;
5222
+ } | null;
5223
+
5224
+ export type PersonSegmentRemovedWebhookPayloadPersonAccountItem = {
5225
+ /**
5226
+ * @maxLength 10
5227
+ * @nullable
5228
+ */
5229
+ Uid?: string | null;
5230
+ /** @nullable */
5231
+ _objectType?: string | null;
5232
+ /** @minLength 1 */
5233
+ Created: string;
5234
+ /** @minLength 1 */
5235
+ Updated: string;
5236
+ /** @nullable */
5237
+ Account?: PersonSegmentRemovedWebhookPayloadPersonAccountItemAccount;
5238
+ IsPrimary?: boolean;
5239
+ ReceiveInvoices?: boolean;
5240
+ };
5241
+
5242
+ export type PersonSegmentRemovedWebhookPayloadDealPeopleItem = {
5243
+ /**
5244
+ * @maxLength 10
5245
+ * @nullable
5246
+ */
5247
+ Uid?: string | null;
5248
+ /** @nullable */
5249
+ _objectType?: string | null;
5250
+ /** @minLength 1 */
5251
+ Created: string;
5252
+ /** @minLength 1 */
5253
+ Updated: string;
5254
+ };
5255
+
5256
+ export type PersonSegmentRemovedWebhookPayloadLeadFormSubmissionsItem = {
5257
+ /**
5258
+ * @maxLength 10
5259
+ * @nullable
5260
+ */
5261
+ Uid?: string | null;
5262
+ /** @nullable */
5263
+ _objectType?: string | null;
5264
+ /** @minLength 1 */
5265
+ Created: string;
5266
+ /** @minLength 1 */
5267
+ Updated: string;
5268
+ /** @nullable */
5269
+ RefererURL?: string | null;
5270
+ /** @nullable */
5271
+ RecaptchaToken?: string | null;
5272
+ /** @nullable */
5273
+ RecaptchaSiteKey?: string | null;
5274
+ };
5275
+
5276
+ /**
5277
+ * `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused, `10` - Created
5278
+ */
5279
+ export type PersonSegmentRemovedWebhookPayloadAccountAccountStage = typeof PersonSegmentRemovedWebhookPayloadAccountAccountStage[keyof typeof PersonSegmentRemovedWebhookPayloadAccountAccountStage];
5280
+
5281
+
5282
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
5283
+ export const PersonSegmentRemovedWebhookPayloadAccountAccountStage = {
5284
+ Trialing: 2,
5285
+ Subscribing: 3,
5286
+ Cancelling: 4,
5287
+ Expired: 5,
5288
+ TrialExpired: 6,
5289
+ PastDue: 7,
5290
+ CancellingTrial: 8,
5291
+ Paused: 9,
5292
+ Created: 10,
5293
+ } as const;
5294
+
5295
+ /**
5296
+ * @nullable
5297
+ */
5298
+ export type PersonSegmentRemovedWebhookPayloadAccount = {
5299
+ /**
5300
+ * @maxLength 10
5301
+ * @nullable
5302
+ */
5303
+ Uid?: string | null;
5304
+ /** @nullable */
5305
+ _objectType?: string | null;
5306
+ /** @minLength 1 */
5307
+ Created?: string;
5308
+ /** @minLength 1 */
5309
+ Updated?: string;
5310
+ /**
5311
+ * @maxLength 255
5312
+ * @nullable
5313
+ */
5314
+ StripeId?: string | null;
5315
+ IsLivemode?: boolean;
5316
+ /**
5317
+ * @minLength 1
5318
+ * @maxLength 250
5319
+ */
5320
+ Name?: string;
5321
+ /**
5322
+ * @maxLength 250
5323
+ * @nullable
5324
+ */
5325
+ ClientIdentifier?: string | null;
5326
+ /**
5327
+ * @maxLength 3
5328
+ * @nullable
5329
+ */
5330
+ Currency?: string | null;
5331
+ /** @nullable */
5332
+ InvoiceNotes?: string | null;
5333
+ IsDemo?: boolean;
5334
+ /** `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused, `10` - Created */
5335
+ AccountStage?: PersonSegmentRemovedWebhookPayloadAccountAccountStage;
5336
+ /**
5337
+ * @maxLength 50
5338
+ * @nullable
5339
+ */
5340
+ StripeDefaultPaymentMethodId?: string | null;
5341
+ /** @nullable */
5342
+ LastLoginDateTime?: string | null;
5343
+ /**
5344
+ * @maxLength 255
5345
+ * @nullable
5346
+ */
5347
+ AccountSpecificPageUrl1?: string | null;
5348
+ /**
5349
+ * @maxLength 255
5350
+ * @nullable
5351
+ */
5352
+ AccountSpecificPageUrl2?: string | null;
5353
+ /**
5354
+ * @maxLength 255
5355
+ * @nullable
5356
+ */
5357
+ AccountSpecificPageUrl3?: string | null;
5358
+ /**
5359
+ * @maxLength 255
5360
+ * @nullable
5361
+ */
5362
+ AccountSpecificPageUrl4?: string | null;
5363
+ /**
5364
+ * @maxLength 255
5365
+ * @nullable
5366
+ */
5367
+ AccountSpecificPageUrl5?: string | null;
5368
+ /**
5369
+ * @maxLength 255
5370
+ * @nullable
5371
+ */
5372
+ AccountSpecificPageUrl6?: string | null;
5373
+ /**
5374
+ * @maxLength 255
5375
+ * @nullable
5376
+ */
5377
+ AccountSpecificPageUrl7?: string | null;
5378
+ /**
5379
+ * @maxLength 255
5380
+ * @nullable
5381
+ */
5382
+ AccountSpecificPageUrl8?: string | null;
5383
+ /**
5384
+ * @maxLength 255
5385
+ * @nullable
5386
+ */
5387
+ AccountSpecificPageUrl9?: string | null;
5388
+ /**
5389
+ * @maxLength 255
5390
+ * @nullable
5391
+ */
5392
+ AccountSpecificPageUrl10?: string | null;
5393
+ /** @nullable */
5394
+ RewardFulReferralId?: string | null;
5395
+ /**
5396
+ * @maxLength 36
5397
+ * @nullable
5398
+ */
5399
+ ToltReferralId?: string | null;
5400
+ /**
5401
+ * @maxLength 20
5402
+ * @nullable
5403
+ */
5404
+ TaxStatus?: string | null;
5405
+ /** @nullable */
5406
+ AccountStageLabel?: string | null;
5407
+ /** @nullable */
5408
+ CurrentStripeProducts?: string | null;
5409
+ /** @nullable */
5410
+ DomainName?: string | null;
5411
+ HasLoggedIn?: boolean;
5412
+ LifetimeRevenue?: number;
5413
+ /** @nullable */
5414
+ NextStripeInvoiceDate?: string | null;
5415
+ /** @nullable */
5416
+ Nonce?: string | null;
5417
+ /** @nullable */
5418
+ RecaptchaToken?: string | null;
5419
+ /** @nullable */
5420
+ StripeNextInvoiceSequence?: number | null;
5421
+ /** @nullable */
5422
+ StripePrice?: string[] | null;
5423
+ /** @nullable */
5424
+ StripePromotionCode?: string | null;
5425
+ /** @nullable */
5426
+ TaxId?: string | null;
5427
+ TaxIdIsInvalid?: boolean;
5428
+ /** @nullable */
5429
+ TaxIdType?: string | null;
5430
+ /** @nullable */
5431
+ WebflowSlug?: string | null;
5432
+ } | null;
5433
+
5434
+ /**
5435
+ * `1` - Subscribed, `2` - Unsubscribed, `3` - Cleaned, `4` - Confirmed
5436
+ */
5437
+ export type PersonSegmentRemovedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus = typeof PersonSegmentRemovedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus[keyof typeof PersonSegmentRemovedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus];
5438
+
5439
+
5440
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
5441
+ export const PersonSegmentRemovedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus = {
5442
+ Subscribed: 1,
5443
+ Unsubscribed: 2,
5444
+ Cleaned: 3,
5445
+ Confirmed: 4,
5446
+ } as const;
5447
+
5448
+ export type PersonSegmentRemovedWebhookPayloadEmailListPersonItem = {
5449
+ /**
5450
+ * @maxLength 10
5451
+ * @nullable
5452
+ */
5453
+ Uid?: string | null;
5454
+ /** @nullable */
5455
+ _objectType?: string | null;
5456
+ /** @minLength 1 */
5457
+ Created: string;
5458
+ /** @minLength 1 */
5459
+ Updated: string;
5460
+ /** `1` - Subscribed, `2` - Unsubscribed, `3` - Cleaned, `4` - Confirmed */
5461
+ EmailListSubscriberStatus?: PersonSegmentRemovedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus;
5462
+ SubscribedDate?: string;
5463
+ /** @nullable */
5464
+ ConfirmedDate?: string | null;
5465
+ /**
5466
+ * @maxLength 500
5467
+ * @nullable
5468
+ */
5469
+ ConfirmationNotes?: string | null;
5470
+ /** @nullable */
5471
+ UnsubscribedDate?: string | null;
5472
+ /** @nullable */
5473
+ CleanedDate?: string | null;
5474
+ /** @nullable */
5475
+ WelcomeEmailDeliverDateTime?: string | null;
5476
+ /** @nullable */
5477
+ WelcomeEmailOpenDateTime?: string | null;
5478
+ /**
5479
+ * @maxLength 20
5480
+ * @nullable
5481
+ */
5482
+ UnsubscribeReason?: string | null;
5483
+ /** @nullable */
5484
+ UnsubscribeReasonOther?: string | null;
5485
+ /** @nullable */
5486
+ RecaptchaToken?: string | null;
5487
+ /** @nullable */
5488
+ RecaptchaSiteKey?: string | null;
5489
+ SendWelcomeEmail?: boolean;
5490
+ /** @nullable */
5491
+ Source?: string | null;
5492
+ };
5493
+
5494
+ /**
5495
+ * `0` - None, `1` - Gmail
5496
+ */
5497
+ export type PersonSegmentRemovedWebhookPayloadOAuthIntegrationStatus = typeof PersonSegmentRemovedWebhookPayloadOAuthIntegrationStatus[keyof typeof PersonSegmentRemovedWebhookPayloadOAuthIntegrationStatus];
5498
+
5499
+
5500
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
5501
+ export const PersonSegmentRemovedWebhookPayloadOAuthIntegrationStatus = {
5502
+ None: 0,
5503
+ Gmail: 1,
5504
+ } as const;
5505
+
5506
+ /**
5507
+ * @nullable
5508
+ */
5509
+ export type PersonSegmentRemovedWebhookPayloadDiscordUser = {
5510
+ /**
5511
+ * @maxLength 10
5512
+ * @nullable
5513
+ */
5514
+ Uid?: string | null;
5515
+ /** @nullable */
5516
+ _objectType?: string | null;
5517
+ /** @minLength 1 */
5518
+ Created?: string;
5519
+ /** @minLength 1 */
5520
+ Updated?: string;
5521
+ /**
5522
+ * @maxLength 250
5523
+ * @nullable
5524
+ */
5525
+ DiscordUserId?: string | null;
5526
+ /**
5527
+ * @maxLength 250
5528
+ * @nullable
5529
+ */
5530
+ DiscordEmail?: string | null;
5531
+ /**
5532
+ * @maxLength 250
5533
+ * @nullable
5534
+ */
5535
+ DiscordUsername?: string | null;
5536
+ /** @nullable */
5537
+ DiscordOAuthRefreshToken?: string | null;
5538
+ } | null;
5539
+
5540
+ export interface PersonSegmentRemovedWebhookPayload {
5541
+ /**
5542
+ * @maxLength 10
5543
+ * @nullable
5544
+ */
5545
+ Uid?: string | null;
5546
+ /** @nullable */
5547
+ _objectType?: string | null;
5548
+ /** @minLength 1 */
5549
+ Created: string;
5550
+ /** @minLength 1 */
5551
+ Updated: string;
5552
+ /**
5553
+ * @maxLength 250
5554
+ * @nullable
5555
+ */
5556
+ Email?: string | null;
5557
+ /**
5558
+ * @maxLength 250
5559
+ * @nullable
5560
+ */
5561
+ FirstName?: string | null;
5562
+ /**
5563
+ * @maxLength 250
5564
+ * @nullable
5565
+ */
5566
+ LastName?: string | null;
5567
+ /** @nullable */
5568
+ MailingAddress?: PersonSegmentRemovedWebhookPayloadMailingAddress;
5569
+ /** @nullable */
5570
+ PasswordLastUpdated?: string | null;
5571
+ PasswordMustChange?: boolean;
5572
+ /**
5573
+ * @maxLength 250
5574
+ * @nullable
5575
+ */
5576
+ PhoneMobile?: string | null;
5577
+ /**
5578
+ * @maxLength 250
5579
+ * @nullable
5580
+ */
5581
+ PhoneWork?: string | null;
5582
+ /**
5583
+ * @maxLength 250
5584
+ * @nullable
5585
+ */
5586
+ ProfileImageS3Url?: string | null;
5587
+ /**
5588
+ * @maxLength 250
5589
+ * @nullable
5590
+ */
5591
+ Title?: string | null;
5592
+ /**
5593
+ * @maxLength 100
5594
+ * @nullable
5595
+ */
5596
+ Timezone?: string | null;
5597
+ /**
5598
+ * @maxLength 50
5599
+ * @nullable
5600
+ */
5601
+ Language?: string | null;
5602
+ /**
5603
+ * @maxLength 250
5604
+ * @nullable
5605
+ */
5606
+ IPAddress?: string | null;
5607
+ /**
5608
+ * @maxLength 250
5609
+ * @nullable
5610
+ */
5611
+ Referer?: string | null;
5612
+ /**
5613
+ * @maxLength 1000
5614
+ * @nullable
5615
+ */
5616
+ UserAgent?: string | null;
5617
+ /** @nullable */
5618
+ LastLoginDateTime?: string | null;
5619
+ /**
5620
+ * @maxLength 50
5621
+ * @nullable
5622
+ */
5623
+ OAuthGoogleProfileId?: string | null;
5624
+ /** @nullable */
5625
+ PersonAccount?: PersonSegmentRemovedWebhookPayloadPersonAccountItem[] | null;
5626
+ /** @nullable */
5627
+ DealPeople?: PersonSegmentRemovedWebhookPayloadDealPeopleItem[] | null;
5628
+ /** @nullable */
5629
+ LeadFormSubmissions?: PersonSegmentRemovedWebhookPayloadLeadFormSubmissionsItem[] | null;
5630
+ /** @nullable */
5631
+ Account?: PersonSegmentRemovedWebhookPayloadAccount;
5632
+ /** @nullable */
5633
+ AccountUids?: string | null;
5634
+ /** @nullable */
5635
+ EmailListPerson?: PersonSegmentRemovedWebhookPayloadEmailListPersonItem[] | null;
5636
+ /** @nullable */
5637
+ FullName?: string | null;
5638
+ HasLoggedIn?: boolean;
5639
+ /** `0` - None, `1` - Gmail */
5640
+ OAuthIntegrationStatus?: PersonSegmentRemovedWebhookPayloadOAuthIntegrationStatus;
5641
+ OptInToEmailList?: boolean;
5642
+ /** @nullable */
5643
+ Password?: string | null;
5644
+ /** @nullable */
5645
+ UserAgentPlatformBrowser?: string | null;
5646
+ HasUnsubscribed?: boolean;
5647
+ /** @nullable */
5648
+ DiscordUser?: PersonSegmentRemovedWebhookPayloadDiscordUser;
5649
+ IsConnectedToDiscord?: boolean;
5650
+ ActivityEventData?: PersonSegmentRemovedActivityData;
5651
+ }
5652
+
4904
5653
  export type CaseGetAllCasesParams = {
4905
5654
  /**
4906
5655
  * Search string