@outseta/react 0.2.2 → 0.2.4
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 +9 -9
- package/src/generated/activity/activity.ts +12 -15
- package/src/generated/attribute/attribute.ts +163 -0
- package/src/generated/billing/billing.ts +500 -34
- package/src/generated/crm/crm.ts +100 -44
- package/src/generated/email/email.ts +26 -32
- package/src/generated/outsetaAPI.schemas.ts +21 -3
- package/src/generated/support/support.ts +4 -8
package/src/generated/crm/crm.ts
CHANGED
|
@@ -371,11 +371,13 @@ export const useDealDeleteDeal = <TError = void,
|
|
|
371
371
|
return useMutation(mutationOptions);
|
|
372
372
|
}
|
|
373
373
|
/**
|
|
374
|
-
*
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
374
|
+
* This is the same endpoint the sign up embed uses to create accounts. At a minimum you
|
|
375
|
+
must pass one Primary Contact with an Email address and one Subscription record with a
|
|
376
|
+
reference to a Plan. Other fields (e.g. Account Name, Billing Address, Payment
|
|
377
|
+
Information, etc.) can be passed as desired. A confirmation email will be sent to the
|
|
378
|
+
user unless you've specifically toggled this option off on the AUTH > SIGN UP AND LOGIN
|
|
379
|
+
page.
|
|
380
|
+
* @summary Register a new account.
|
|
379
381
|
*/
|
|
380
382
|
export const registrationRegisterAccount = (
|
|
381
383
|
|
|
@@ -421,11 +423,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
|
421
423
|
export type RegistrationRegisterAccountMutationError = unknown
|
|
422
424
|
|
|
423
425
|
/**
|
|
424
|
-
* @summary Register a new account.
|
|
425
|
-
At a minimum you must pass one Primary Contact with an Email address and one Subscription
|
|
426
|
-
record with a reference to a Plan. Other fields (e.g. Account Name, Billing Address,
|
|
427
|
-
Payment Information, etc.) can be passed as desired. A confirmation email will be sent
|
|
428
|
-
to the user unless you've specifically toggled this option off on the AUTH > SIGN UP AND LOGIN page.
|
|
426
|
+
* @summary Register a new account.
|
|
429
427
|
*/
|
|
430
428
|
export const useRegistrationRegisterAccount = <TError = unknown,
|
|
431
429
|
TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof registrationRegisterAccount>>, TError,void, TContext>, request?: SecondParameter<typeof customFetch>}
|
|
@@ -510,9 +508,9 @@ export function useAccountGetAllAccounts<TData = Awaited<ReturnType<typeof accou
|
|
|
510
508
|
|
|
511
509
|
|
|
512
510
|
/**
|
|
513
|
-
*
|
|
514
|
-
To add an account with an existing person, the Account payload include something like this:
|
|
511
|
+
* To add an account with an existing person, the Account payload include something like this:
|
|
515
512
|
{ ... other Account properties ..., "PersonAccount": [ { "Person": { "Uid": [personUid] }, "IsPrimary": "true" } ] }
|
|
513
|
+
* @summary Add a new account.
|
|
516
514
|
*/
|
|
517
515
|
export const accountAddAccount = (
|
|
518
516
|
accountAddAccountBody: AccountAddAccountBody,
|
|
@@ -564,8 +562,6 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
|
564
562
|
|
|
565
563
|
/**
|
|
566
564
|
* @summary Add a new account.
|
|
567
|
-
To add an account with an existing person, the Account payload include something like this:
|
|
568
|
-
{ ... other Account properties ..., "PersonAccount": [ { "Person": { "Uid": [personUid] }, "IsPrimary": "true" } ] }
|
|
569
565
|
*/
|
|
570
566
|
export const useAccountAddAccount = <TError = void,
|
|
571
567
|
TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof accountAddAccount>>, TError,{data: AccountAddAccountBody;params?: AccountAddAccountParams}, TContext>, request?: SecondParameter<typeof customFetch>}
|
|
@@ -711,9 +707,10 @@ export const useAccountDeleteAccount = <TError = void,
|
|
|
711
707
|
return useMutation(mutationOptions);
|
|
712
708
|
}
|
|
713
709
|
/**
|
|
714
|
-
*
|
|
715
|
-
|
|
716
|
-
|
|
710
|
+
* You can update one or multiple properties on the object. Any property that you
|
|
711
|
+
include in the json schema will be updated. To update custom properties just
|
|
712
|
+
include them in the same way that they are included when you do a get on the object.
|
|
713
|
+
* @summary Update account information.
|
|
717
714
|
*/
|
|
718
715
|
export const accountUpdateAccount = (
|
|
719
716
|
accountUid: string | null,
|
|
@@ -761,9 +758,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
|
761
758
|
export type AccountUpdateAccountMutationError = void
|
|
762
759
|
|
|
763
760
|
/**
|
|
764
|
-
* @summary Update account information.
|
|
765
|
-
Any property that you include in the json schema will be updated.
|
|
766
|
-
To update custom properties just include them in the same way that they are included when you do a get on the object.
|
|
761
|
+
* @summary Update account information.
|
|
767
762
|
*/
|
|
768
763
|
export const useAccountUpdateAccount = <TError = void,
|
|
769
764
|
TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof accountUpdateAccount>>, TError,{accountUid: string | null;data: AccountUpdateAccountBody}, TContext>, request?: SecondParameter<typeof customFetch>}
|
|
@@ -973,10 +968,10 @@ export const useAccountDeleteMembership = <TError = void,
|
|
|
973
968
|
return useMutation(mutationOptions);
|
|
974
969
|
}
|
|
975
970
|
/**
|
|
976
|
-
*
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
971
|
+
* The account needs to be in subscribing stage. The stage will automatically change over to
|
|
972
|
+
cancelling. If the account has a subscription attached to it then at the subscription
|
|
973
|
+
renewal the subscription will end and the account will be automatically set to expired.
|
|
974
|
+
* @summary Add a cancellation request to an account.
|
|
980
975
|
*/
|
|
981
976
|
export const accountCancelAccount = (
|
|
982
977
|
accountUid: string | null,
|
|
@@ -1025,10 +1020,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
|
1025
1020
|
export type AccountCancelAccountMutationError = void
|
|
1026
1021
|
|
|
1027
1022
|
/**
|
|
1028
|
-
* @summary Add a cancellation request to an account.
|
|
1029
|
-
The stage will automatically change over to cancelling. If the account has a subscription
|
|
1030
|
-
attached to it then at the subscription renewal the subscription will end and the account
|
|
1031
|
-
will be automatically set to expired.
|
|
1023
|
+
* @summary Add a cancellation request to an account.
|
|
1032
1024
|
*/
|
|
1033
1025
|
export const useAccountCancelAccount = <TError = void,
|
|
1034
1026
|
TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof accountCancelAccount>>, TError,{accountUid: string | null;data: AccountCancelAccountBody}, TContext>, request?: SecondParameter<typeof customFetch>}
|
|
@@ -1171,9 +1163,10 @@ export const useAccountExtendTrial = <TError = void,
|
|
|
1171
1163
|
return useMutation(mutationOptions);
|
|
1172
1164
|
}
|
|
1173
1165
|
/**
|
|
1174
|
-
*
|
|
1175
|
-
to
|
|
1176
|
-
|
|
1166
|
+
* Pass personUid as a query parameter to send to a specific person, or personUid=* to send
|
|
1167
|
+
to all people on the account. If no personUid is provided, the email is sent to the
|
|
1168
|
+
primary contact.
|
|
1169
|
+
* @summary Send a confirmation email to people on an account.
|
|
1177
1170
|
*/
|
|
1178
1171
|
export const accountSendConfirmationEmail = (
|
|
1179
1172
|
accountUid: string | null,
|
|
@@ -1219,9 +1212,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
|
1219
1212
|
export type AccountSendConfirmationEmailMutationError = void
|
|
1220
1213
|
|
|
1221
1214
|
/**
|
|
1222
|
-
* @summary Send a confirmation email to people on an account.
|
|
1223
|
-
to send to a specific person, or personUid=* to send to all people on the account.
|
|
1224
|
-
If no personUid is provided, the email is sent to the primary contact.
|
|
1215
|
+
* @summary Send a confirmation email to people on an account.
|
|
1225
1216
|
*/
|
|
1226
1217
|
export const useAccountSendConfirmationEmail = <TError = void,
|
|
1227
1218
|
TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof accountSendConfirmationEmail>>, TError,{accountUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
|
|
@@ -1438,9 +1429,10 @@ export function usePersonGetPerson<TData = Awaited<ReturnType<typeof personGetPe
|
|
|
1438
1429
|
|
|
1439
1430
|
|
|
1440
1431
|
/**
|
|
1441
|
-
*
|
|
1442
|
-
|
|
1443
|
-
|
|
1432
|
+
* You can update one or multiple properties on the object. Any property that you
|
|
1433
|
+
include in the json schema will be updated. To update custom properties just
|
|
1434
|
+
include them in the same way that they are included when you do a get on the object.
|
|
1435
|
+
* @summary Update a person record.
|
|
1444
1436
|
*/
|
|
1445
1437
|
export const personUpdatePerson = (
|
|
1446
1438
|
personUid: string | null,
|
|
@@ -1488,9 +1480,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
|
1488
1480
|
export type PersonUpdatePersonMutationError = void
|
|
1489
1481
|
|
|
1490
1482
|
/**
|
|
1491
|
-
* @summary Update a person record.
|
|
1492
|
-
Any property that you include in the json schema will be updated.
|
|
1493
|
-
To update custom properties just include them in the same way that they are included when you do a get on the object.
|
|
1483
|
+
* @summary Update a person record.
|
|
1494
1484
|
*/
|
|
1495
1485
|
export const usePersonUpdatePerson = <TError = void,
|
|
1496
1486
|
TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof personUpdatePerson>>, TError,{personUid: string | null;data: PersonUpdatePersonBody}, TContext>, request?: SecondParameter<typeof customFetch>}
|
|
@@ -1633,8 +1623,75 @@ export const usePersonSetTemporaryPassword = <TError = void,
|
|
|
1633
1623
|
return useMutation(mutationOptions);
|
|
1634
1624
|
}
|
|
1635
1625
|
/**
|
|
1636
|
-
*
|
|
1637
|
-
|
|
1626
|
+
* All prior recovery codes are invalidated. Existing TOTP/Email mechanisms are intentionally
|
|
1627
|
+
left in place — the admin returns the new codes to the user out of band, the user logs in
|
|
1628
|
+
with one, then re-enrolls their device. Mirrors the temporary-password flow at
|
|
1629
|
+
SetTemporaryPassword.
|
|
1630
|
+
* @summary Regenerate 2FA recovery codes for a user locked out of their authenticator.
|
|
1631
|
+
*/
|
|
1632
|
+
export const personRegenerateTwoFactorRecoveryCodes = (
|
|
1633
|
+
personUid: string | null,
|
|
1634
|
+
options?: SecondParameter<typeof customFetch>,) => {
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
return customFetch<Blob>(
|
|
1638
|
+
{url: `/api/v1/crm/people/${personUid}/regenerateTwoFactorRecoveryCodes`, method: 'PUT',
|
|
1639
|
+
responseType: 'blob'
|
|
1640
|
+
},
|
|
1641
|
+
options);
|
|
1642
|
+
}
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
export const getPersonRegenerateTwoFactorRecoveryCodesMutationOptions = <TError = void,
|
|
1647
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof personRegenerateTwoFactorRecoveryCodes>>, TError,{personUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
|
|
1648
|
+
): UseMutationOptions<Awaited<ReturnType<typeof personRegenerateTwoFactorRecoveryCodes>>, TError,{personUid: string | null}, TContext> => {
|
|
1649
|
+
|
|
1650
|
+
const mutationKey = ['personRegenerateTwoFactorRecoveryCodes'];
|
|
1651
|
+
const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
1652
|
+
options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
|
|
1653
|
+
options
|
|
1654
|
+
: {...options, mutation: {...options.mutation, mutationKey}}
|
|
1655
|
+
: {mutation: { mutationKey, }, request: undefined};
|
|
1656
|
+
|
|
1657
|
+
|
|
1658
|
+
|
|
1659
|
+
|
|
1660
|
+
const mutationFn: MutationFunction<Awaited<ReturnType<typeof personRegenerateTwoFactorRecoveryCodes>>, {personUid: string | null}> = (props) => {
|
|
1661
|
+
const {personUid} = props ?? {};
|
|
1662
|
+
|
|
1663
|
+
return personRegenerateTwoFactorRecoveryCodes(personUid,requestOptions)
|
|
1664
|
+
}
|
|
1665
|
+
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
return { mutationFn, ...mutationOptions }}
|
|
1670
|
+
|
|
1671
|
+
export type PersonRegenerateTwoFactorRecoveryCodesMutationResult = NonNullable<Awaited<ReturnType<typeof personRegenerateTwoFactorRecoveryCodes>>>
|
|
1672
|
+
|
|
1673
|
+
export type PersonRegenerateTwoFactorRecoveryCodesMutationError = void
|
|
1674
|
+
|
|
1675
|
+
/**
|
|
1676
|
+
* @summary Regenerate 2FA recovery codes for a user locked out of their authenticator.
|
|
1677
|
+
*/
|
|
1678
|
+
export const usePersonRegenerateTwoFactorRecoveryCodes = <TError = void,
|
|
1679
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof personRegenerateTwoFactorRecoveryCodes>>, TError,{personUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
|
|
1680
|
+
): UseMutationResult<
|
|
1681
|
+
Awaited<ReturnType<typeof personRegenerateTwoFactorRecoveryCodes>>,
|
|
1682
|
+
TError,
|
|
1683
|
+
{personUid: string | null},
|
|
1684
|
+
TContext
|
|
1685
|
+
> => {
|
|
1686
|
+
|
|
1687
|
+
const mutationOptions = getPersonRegenerateTwoFactorRecoveryCodesMutationOptions(options);
|
|
1688
|
+
|
|
1689
|
+
return useMutation(mutationOptions);
|
|
1690
|
+
}
|
|
1691
|
+
/**
|
|
1692
|
+
* Sends an email to the user with a link to a page where they can reset their password.
|
|
1693
|
+
The reset password token in the link is valid for 30 minutes.
|
|
1694
|
+
* @summary Initiate the forgot password flow.
|
|
1638
1695
|
*/
|
|
1639
1696
|
export const personForgotPassword = (
|
|
1640
1697
|
personForgotPasswordBody: PersonForgotPasswordBody,
|
|
@@ -1683,8 +1740,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
|
1683
1740
|
export type PersonForgotPasswordMutationError = unknown
|
|
1684
1741
|
|
|
1685
1742
|
/**
|
|
1686
|
-
* @summary Initiate the forgot password flow
|
|
1687
|
-
where they can reset their password. The reset password token in the link is valid for 30 minutes.
|
|
1743
|
+
* @summary Initiate the forgot password flow.
|
|
1688
1744
|
*/
|
|
1689
1745
|
export const usePersonForgotPassword = <TError = unknown,
|
|
1690
1746
|
TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof personForgotPassword>>, TError,{data: PersonForgotPasswordBody}, TContext>, request?: SecondParameter<typeof customFetch>}
|
|
@@ -99,10 +99,11 @@ export function useCampaignGetAllBroadcastEmails<TData = Awaited<ReturnType<type
|
|
|
99
99
|
|
|
100
100
|
|
|
101
101
|
/**
|
|
102
|
-
*
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
102
|
+
* To copy an existing broadcast, retrieve it and pass its data as the request body — the
|
|
103
|
+
Uid, SendDateTime, and message counts are automatically reset. Recipients can be
|
|
104
|
+
specified using EmailListUids and SegmentUids instead of populating RecipientData
|
|
105
|
+
directly. If both are provided, they are merged.
|
|
106
|
+
* @summary Create a new broadcast campaign.
|
|
106
107
|
*/
|
|
107
108
|
export const campaignAddBroadcastEmail = (
|
|
108
109
|
campaignAddBroadcastEmailBody: CampaignAddBroadcastEmailBody,
|
|
@@ -150,10 +151,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
|
150
151
|
export type CampaignAddBroadcastEmailMutationError = void
|
|
151
152
|
|
|
152
153
|
/**
|
|
153
|
-
* @summary
|
|
154
|
-
data as the request body — the Uid, SendDateTime, and message counts are automatically reset.
|
|
155
|
-
Recipients can be specified using EmailListUids and SegmentUids instead of populating
|
|
156
|
-
RecipientData directly. If both are provided, they are merged.
|
|
154
|
+
* @summary Create a new broadcast campaign.
|
|
157
155
|
*/
|
|
158
156
|
export const useCampaignAddBroadcastEmail = <TError = void,
|
|
159
157
|
TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignAddBroadcastEmail>>, TError,{data: CampaignAddBroadcastEmailBody}, TContext>, request?: SecondParameter<typeof customFetch>}
|
|
@@ -237,10 +235,11 @@ export function useCampaignGetBroadcastEmail<TData = Awaited<ReturnType<typeof c
|
|
|
237
235
|
|
|
238
236
|
|
|
239
237
|
/**
|
|
240
|
-
*
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
238
|
+
* Setting SendDateTime to a future date schedules the broadcast for sending and its status
|
|
239
|
+
changes to Pending. Clearing SendDateTime unschedules the broadcast. Recipients can be
|
|
240
|
+
specified using EmailListUids and SegmentUids instead of populating RecipientData
|
|
241
|
+
directly. If both are provided, they are merged.
|
|
242
|
+
* @summary Update a broadcast campaign.
|
|
244
243
|
*/
|
|
245
244
|
export const campaignUpdateBroadcastEmail = (
|
|
246
245
|
broadcastCampaignUid: string | null,
|
|
@@ -288,10 +287,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
|
288
287
|
export type CampaignUpdateBroadcastEmailMutationError = void
|
|
289
288
|
|
|
290
289
|
/**
|
|
291
|
-
* @summary
|
|
292
|
-
for sending and its status changes to Pending. Clearing SendDateTime unschedules the broadcast.
|
|
293
|
-
Recipients can be specified using EmailListUids and SegmentUids instead of populating
|
|
294
|
-
RecipientData directly. If both are provided, they are merged.
|
|
290
|
+
* @summary Update a broadcast campaign.
|
|
295
291
|
*/
|
|
296
292
|
export const useCampaignUpdateBroadcastEmail = <TError = void,
|
|
297
293
|
TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>, TError,{broadcastCampaignUid: string | null;data: CampaignUpdateBroadcastEmailBody}, TContext>, request?: SecondParameter<typeof customFetch>}
|
|
@@ -307,8 +303,9 @@ export const useCampaignUpdateBroadcastEmail = <TError = void,
|
|
|
307
303
|
return useMutation(mutationOptions);
|
|
308
304
|
}
|
|
309
305
|
/**
|
|
310
|
-
*
|
|
311
|
-
|
|
306
|
+
* Only campaigns in Draft or Pending status can be deleted. Campaigns that have been
|
|
307
|
+
processed should be archived instead.
|
|
308
|
+
* @summary Delete a broadcast campaign.
|
|
312
309
|
*/
|
|
313
310
|
export const campaignDeleteBroadcastCampaign = (
|
|
314
311
|
broadcastCampaignUid: string | null,
|
|
@@ -354,8 +351,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
|
354
351
|
export type CampaignDeleteBroadcastCampaignMutationError = void
|
|
355
352
|
|
|
356
353
|
/**
|
|
357
|
-
* @summary
|
|
358
|
-
Campaigns that have been processed should be archived instead.
|
|
354
|
+
* @summary Delete a broadcast campaign.
|
|
359
355
|
*/
|
|
360
356
|
export const useCampaignDeleteBroadcastCampaign = <TError = void,
|
|
361
357
|
TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignDeleteBroadcastCampaign>>, TError,{broadcastCampaignUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
|
|
@@ -496,9 +492,10 @@ export const useCampaignArchiveBroadcastCampaign = <TError = void,
|
|
|
496
492
|
return useMutation(mutationOptions);
|
|
497
493
|
}
|
|
498
494
|
/**
|
|
499
|
-
*
|
|
500
|
-
recipients
|
|
501
|
-
|
|
495
|
+
* Sends to the logged-in user and optionally to additional recipients. Additional
|
|
496
|
+
recipients are specified as a list of person Uids and must belong to the same account
|
|
497
|
+
as the logged-in user.
|
|
498
|
+
* @summary Send a test email for a broadcast campaign.
|
|
502
499
|
*/
|
|
503
500
|
export const campaignSendTestCampaignEmail = (
|
|
504
501
|
campaignSendTestCampaignEmailBody: CampaignSendTestCampaignEmailBody,
|
|
@@ -547,9 +544,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
|
547
544
|
export type CampaignSendTestCampaignEmailMutationError = void
|
|
548
545
|
|
|
549
546
|
/**
|
|
550
|
-
* @summary
|
|
551
|
-
recipients. Additional recipients are specified as a list of person Uids and must belong to the
|
|
552
|
-
same account as the logged-in user.
|
|
547
|
+
* @summary Send a test email for a broadcast campaign.
|
|
553
548
|
*/
|
|
554
549
|
export const useCampaignSendTestCampaignEmail = <TError = void,
|
|
555
550
|
TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignSendTestCampaignEmail>>, TError,{data: CampaignSendTestCampaignEmailBody}, TContext>, request?: SecondParameter<typeof customFetch>}
|
|
@@ -638,9 +633,10 @@ export function useEmailListGetAllSubscriptions<TData = Awaited<ReturnType<typeo
|
|
|
638
633
|
|
|
639
634
|
|
|
640
635
|
/**
|
|
641
|
-
*
|
|
642
|
-
|
|
643
|
-
|
|
636
|
+
* To subscribe a new person, pass a Person object with an Email address. To subscribe an
|
|
637
|
+
existing person, pass a Person object with a Uid. The SendWelcomeEmail property
|
|
638
|
+
determines if the person is sent a welcome email and defaults to false.
|
|
639
|
+
* @summary Subscribe a person to an email list.
|
|
644
640
|
*/
|
|
645
641
|
export const emailListAddSubscription = (
|
|
646
642
|
emailListUid: string | null,
|
|
@@ -689,9 +685,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
|
689
685
|
export type EmailListAddSubscriptionMutationError = void
|
|
690
686
|
|
|
691
687
|
/**
|
|
692
|
-
* @summary Subscribe a person to an email list.
|
|
693
|
-
Email address. To subscribe an existing person, pass a Person object with a Uid. The
|
|
694
|
-
SendWelcomeEmail property determines if the person is sent a welcome email and defaults to false.
|
|
688
|
+
* @summary Subscribe a person to an email list.
|
|
695
689
|
*/
|
|
696
690
|
export const useEmailListAddSubscription = <TError = void,
|
|
697
691
|
TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof emailListAddSubscription>>, TError,{emailListUid: string | null;data: EmailListAddSubscriptionBody}, TContext>, request?: SecondParameter<typeof customFetch>}
|
|
@@ -1277,6 +1277,7 @@ export type StripePriceAllOf = {
|
|
|
1277
1277
|
UnitAmount?: number | null;
|
|
1278
1278
|
/** @nullable */
|
|
1279
1279
|
UnitAmountDecimal?: number | null;
|
|
1280
|
+
ShowInSignUpForm?: boolean;
|
|
1280
1281
|
/** @nullable */
|
|
1281
1282
|
CurrencySymbol?: string | null;
|
|
1282
1283
|
/** @nullable */
|
|
@@ -3146,7 +3147,7 @@ export type QcountConfigAllOf = {
|
|
|
3146
3147
|
export type QcountConfig = AbstractQcountBean & QcountConfigAllOf;
|
|
3147
3148
|
|
|
3148
3149
|
/**
|
|
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
|
|
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, `140` - TwoFactorAuthenticationEnabled, `142` - ForceTwoFactorAuthentication, `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
|
|
3150
3151
|
*/
|
|
3151
3152
|
export type QcountConfigSettingType = typeof QcountConfigSettingType[keyof typeof QcountConfigSettingType];
|
|
3152
3153
|
|
|
@@ -3175,6 +3176,8 @@ export const QcountConfigSettingType = {
|
|
|
3175
3176
|
KnowledgeBaseLanguage: 128,
|
|
3176
3177
|
Billing_System: 130,
|
|
3177
3178
|
Billing_RestrictSubscriptionActions: 131,
|
|
3179
|
+
TwoFactorAuthenticationEnabled: 140,
|
|
3180
|
+
ForceTwoFactorAuthentication: 142,
|
|
3178
3181
|
Stripe_TaxEnabled: 190,
|
|
3179
3182
|
Stripe_TaxIdTypes: 192,
|
|
3180
3183
|
Stripe_ApplePayMerchantIdDomainAssociation: 193,
|
|
@@ -3295,7 +3298,7 @@ export interface SlackChannelSetting {
|
|
|
3295
3298
|
}
|
|
3296
3299
|
|
|
3297
3300
|
/**
|
|
3298
|
-
* `10` - Custom, `50` - Note, `51` - Email, `52` - PhoneCall, `53` - Meeting, `54` - Chat, `100` - AccountCreated, `101` - AccountUpdated, `102` - AccountAddPerson, `103` - AccountStageUpdated, `104` - AccountDeleted, `105` - AccountBillingInformationUpdated, `106` - AccountSubscriptionPlanUpdated, `107` - AccountSubscriptionPaymentCollected, `108` - AccountSubscriptionPaymentDeclined, `109` - AccountBillingInformationRequested, `110` - AccountBillingInvoiceEmailSent, `111` - AccountRemovePerson, `112` - AccountPaidSubscriptionCreated, `113` - AccountBillingInformationRemoved, `114` - AccountPrimaryPersonUpdated, `115` - AccountBillingInvoiceCreated, `116` - AccountSubscriptionStarted, `117` - AccountSubscriptionRenewalExtended, `118` - AccountSubscriptionAddOnsChanged, `119` - AccountSubscriptionCancellationRequested, `120` - AccountBillingInvoiceDeleted, `200` - PersonCreated, `201` - PersonUpdated, `202` - PersonDeleted, `203` - PersonLogin, `204` - PersonListSubscribed, `205` - PersonListUnsubscribed, `206` - PersonSegmentAdded, `207` - PersonSegmentRemoved, `208` - PersonEmailOpened, `209` - PersonEmailClicked, `210` - PersonEmailBounce, `211` - PersonEmailSpam, `212` - PersonSupportTicketCreated, `213` - PersonSupportTicketUpdated, `214` - PersonLeadFormSubmitted, `215` - PersonListConfirmed, `216` - PersonEmailSubscribed, `217` - PersonEmailUnsubscribed, `218` - PersonTemporaryPasswordSet, `219` - PersonSupportTicketClosed, `300` - DealCreated, `301` - DealUpdated, `302` - DealAddPerson, `303` - DealAddAccount, `304` - DealDeleted, `305` - DealDueDate, `306` - TaskCreated, `307` - TaskUpdated, `400` - PlanCreated, `401` - PlanUpdated, `402` - AddOnCreated, `403` - AddOnUpdated, `500` - DiscordUserLinked, `501` - DiscordUserAddedToServer, `502` - DiscordUserRolesUpdated, `503` - DiscordUserRemovedFromServer, `1000` - OutsetaSuspiciousBehavior
|
|
3301
|
+
* `10` - Custom, `50` - Note, `51` - Email, `52` - PhoneCall, `53` - Meeting, `54` - Chat, `100` - AccountCreated, `101` - AccountUpdated, `102` - AccountAddPerson, `103` - AccountStageUpdated, `104` - AccountDeleted, `105` - AccountBillingInformationUpdated, `106` - AccountSubscriptionPlanUpdated, `107` - AccountSubscriptionPaymentCollected, `108` - AccountSubscriptionPaymentDeclined, `109` - AccountBillingInformationRequested, `110` - AccountBillingInvoiceEmailSent, `111` - AccountRemovePerson, `112` - AccountPaidSubscriptionCreated, `113` - AccountBillingInformationRemoved, `114` - AccountPrimaryPersonUpdated, `115` - AccountBillingInvoiceCreated, `116` - AccountSubscriptionStarted, `117` - AccountSubscriptionRenewalExtended, `118` - AccountSubscriptionAddOnsChanged, `119` - AccountSubscriptionCancellationRequested, `120` - AccountBillingInvoiceDeleted, `200` - PersonCreated, `201` - PersonUpdated, `202` - PersonDeleted, `203` - PersonLogin, `204` - PersonListSubscribed, `205` - PersonListUnsubscribed, `206` - PersonSegmentAdded, `207` - PersonSegmentRemoved, `208` - PersonEmailOpened, `209` - PersonEmailClicked, `210` - PersonEmailBounce, `211` - PersonEmailSpam, `212` - PersonSupportTicketCreated, `213` - PersonSupportTicketUpdated, `214` - PersonLeadFormSubmitted, `215` - PersonListConfirmed, `216` - PersonEmailSubscribed, `217` - PersonEmailUnsubscribed, `218` - PersonTemporaryPasswordSet, `219` - PersonSupportTicketClosed, `220` - PersonTwoFactorRecoveryCodesRegenerated, `300` - DealCreated, `301` - DealUpdated, `302` - DealAddPerson, `303` - DealAddAccount, `304` - DealDeleted, `305` - DealDueDate, `306` - TaskCreated, `307` - TaskUpdated, `400` - PlanCreated, `401` - PlanUpdated, `402` - AddOnCreated, `403` - AddOnUpdated, `500` - DiscordUserLinked, `501` - DiscordUserAddedToServer, `502` - DiscordUserRolesUpdated, `503` - DiscordUserRemovedFromServer, `1000` - OutsetaSuspiciousBehavior
|
|
3299
3302
|
*/
|
|
3300
3303
|
export type ActivityType = typeof ActivityType[keyof typeof ActivityType];
|
|
3301
3304
|
|
|
@@ -3349,6 +3352,7 @@ export const ActivityType = {
|
|
|
3349
3352
|
PersonEmailUnsubscribed: 217,
|
|
3350
3353
|
PersonTemporaryPasswordSet: 218,
|
|
3351
3354
|
PersonSupportTicketClosed: 219,
|
|
3355
|
+
PersonTwoFactorRecoveryCodesRegenerated: 220,
|
|
3352
3356
|
DealCreated: 300,
|
|
3353
3357
|
DealUpdated: 301,
|
|
3354
3358
|
DealAddPerson: 302,
|
|
@@ -3557,6 +3561,11 @@ export type MessageAllOf = {
|
|
|
3557
3561
|
EmailLinks?: EmailLink[] | null;
|
|
3558
3562
|
SpamAssassinScore?: number;
|
|
3559
3563
|
SpamStatus?: SpamStatus;
|
|
3564
|
+
/**
|
|
3565
|
+
* @maxLength 1024
|
|
3566
|
+
* @nullable
|
|
3567
|
+
*/
|
|
3568
|
+
SpamReason?: string | null;
|
|
3560
3569
|
};
|
|
3561
3570
|
|
|
3562
3571
|
export type Message = AbstractQcountBean & MessageAllOf;
|
|
@@ -3750,7 +3759,7 @@ export const QcountStatus = {
|
|
|
3750
3759
|
} as const;
|
|
3751
3760
|
|
|
3752
3761
|
/**
|
|
3753
|
-
* `0` - Disabled, `1` - ForteEnabled, `2` - StripeEnabled
|
|
3762
|
+
* `0` - Disabled, `1` - ForteEnabled, `2` - StripeEnabled, `3` - CustomEnabled
|
|
3754
3763
|
*/
|
|
3755
3764
|
export type PaymentsGatewayActivationStatus = typeof PaymentsGatewayActivationStatus[keyof typeof PaymentsGatewayActivationStatus];
|
|
3756
3765
|
|
|
@@ -3760,6 +3769,7 @@ export const PaymentsGatewayActivationStatus = {
|
|
|
3760
3769
|
Disabled: 0,
|
|
3761
3770
|
ForteEnabled: 1,
|
|
3762
3771
|
StripeEnabled: 2,
|
|
3772
|
+
CustomEnabled: 3,
|
|
3763
3773
|
} as const;
|
|
3764
3774
|
|
|
3765
3775
|
export type DatabaseAllOf = {
|
|
@@ -4139,6 +4149,7 @@ export type CrmSettingsAllOf = {
|
|
|
4139
4149
|
RegistrationConfirmationEmailDelaySeconds?: number;
|
|
4140
4150
|
/** @nullable */
|
|
4141
4151
|
RegistrationCallbackUrlLocations?: string | null;
|
|
4152
|
+
TwoFactorAuthenticationAvailable?: boolean;
|
|
4142
4153
|
};
|
|
4143
4154
|
|
|
4144
4155
|
export type CrmSettings = AbstractQcountBean & CrmSettingsAllOf;
|
|
@@ -4553,6 +4564,7 @@ export interface SetupIntent {
|
|
|
4553
4564
|
PaymentToken?: string | null;
|
|
4554
4565
|
/** @nullable */
|
|
4555
4566
|
PlanUid?: string | null;
|
|
4567
|
+
SetupFutureUsage?: boolean;
|
|
4556
4568
|
/** @nullable */
|
|
4557
4569
|
ToltReferralId?: string | null;
|
|
4558
4570
|
}
|
|
@@ -5672,6 +5684,7 @@ export type CaseAddCaseBody = Case | null;
|
|
|
5672
5684
|
|
|
5673
5685
|
export type ArticleGetAllArticlesParams = {
|
|
5674
5686
|
/**
|
|
5687
|
+
* Matches on title or body of the article
|
|
5675
5688
|
* @nullable
|
|
5676
5689
|
*/
|
|
5677
5690
|
q?: string | null;
|
|
@@ -5833,6 +5846,11 @@ export type SubscriptionAddOnAddSubscriptionAddOnBody = SubscriptionAddOn | null
|
|
|
5833
5846
|
*/
|
|
5834
5847
|
export type InvoiceAddInvoiceBody = Invoice | null;
|
|
5835
5848
|
|
|
5849
|
+
/**
|
|
5850
|
+
* @nullable
|
|
5851
|
+
*/
|
|
5852
|
+
export type InvoiceUpdateInvoiceBody = Invoice | null;
|
|
5853
|
+
|
|
5836
5854
|
/**
|
|
5837
5855
|
* @nullable
|
|
5838
5856
|
*/
|
|
@@ -32,9 +32,9 @@ type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
|
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
36
|
-
Assigned cases can be filtered by passing in the AssignedToPersonClientIdentifier,
|
|
35
|
+
* Assigned cases can be filtered by passing in the AssignedToPersonClientIdentifier,
|
|
37
36
|
which is the Uid of the person the case is assigned to.
|
|
37
|
+
* @summary Returns all cases, optionally filtered by search string, tag, and/or assignment.
|
|
38
38
|
*/
|
|
39
39
|
export const caseGetAllCases = (
|
|
40
40
|
params?: CaseGetAllCasesParams,
|
|
@@ -83,8 +83,6 @@ export type CaseGetAllCasesQueryError = void
|
|
|
83
83
|
|
|
84
84
|
/**
|
|
85
85
|
* @summary Returns all cases, optionally filtered by search string, tag, and/or assignment.
|
|
86
|
-
Assigned cases can be filtered by passing in the AssignedToPersonClientIdentifier,
|
|
87
|
-
which is the Uid of the person the case is assigned to.
|
|
88
86
|
*/
|
|
89
87
|
|
|
90
88
|
export function useCaseGetAllCases<TData = Awaited<ReturnType<typeof caseGetAllCases>>, TError = void>(
|
|
@@ -365,8 +363,7 @@ export const useCaseAddClientResponse = <TError = void,
|
|
|
365
363
|
return useMutation(mutationOptions);
|
|
366
364
|
}
|
|
367
365
|
/**
|
|
368
|
-
* @summary
|
|
369
|
-
Matches on title or body of the article"
|
|
366
|
+
* @summary Retrieve all knowledge base articles.
|
|
370
367
|
*/
|
|
371
368
|
export const articleGetAllArticles = (
|
|
372
369
|
params?: ArticleGetAllArticlesParams,
|
|
@@ -414,8 +411,7 @@ export type ArticleGetAllArticlesQueryError = unknown
|
|
|
414
411
|
|
|
415
412
|
|
|
416
413
|
/**
|
|
417
|
-
* @summary
|
|
418
|
-
Matches on title or body of the article"
|
|
414
|
+
* @summary Retrieve all knowledge base articles.
|
|
419
415
|
*/
|
|
420
416
|
|
|
421
417
|
export function useArticleGetAllArticles<TData = Awaited<ReturnType<typeof articleGetAllArticles>>, TError = unknown>(
|