@outseta/react 0.4.2 → 0.4.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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@outseta/react",
3
- "version": "0.4.2",
3
+ "version": "0.4.4",
4
4
  "description": "React hooks and components for the Outseta API",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -18,7 +18,7 @@
18
18
  }
19
19
  },
20
20
  "dependencies": {
21
- "@outseta/api-client": "0.3.8"
21
+ "@outseta/api-client": "0.3.10"
22
22
  },
23
23
  "peerDependencies": {
24
24
  "react": "^18.0.0 || ^19.0.0"
@@ -870,7 +870,10 @@ export const useAccountAddPersonToAccount = <TError = void,
870
870
  return useMutation(mutationOptions);
871
871
  }
872
872
  /**
873
- * @summary Update an account membership. This is the method by which you can change the primary contact of an account.
873
+ * Update the membership that links a person to an account — for example, to make a different
874
+ person the account's primary contact. The membershipUid identifies which membership to update;
875
+ send the changed PersonAccount fields (such as IsPrimary) in the request body.
876
+ * @summary Update an account membership.
874
877
  */
875
878
  export const accountUpdateMembership = (
876
879
  accountUid: string | null,
@@ -920,7 +923,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
920
923
  export type AccountUpdateMembershipMutationError = void
921
924
 
922
925
  /**
923
- * @summary Update an account membership. This is the method by which you can change the primary contact of an account.
926
+ * @summary Update an account membership.
924
927
  */
925
928
  export const useAccountUpdateMembership = <TError = void,
926
929
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof accountUpdateMembership>>, TError,{accountUid: string | null;membershipUid: string | null;data: NonReadonly<AccountUpdateMembershipBody>}, TContext>, request?: SecondParameter<typeof customFetch>}
@@ -936,7 +939,8 @@ export const useAccountUpdateMembership = <TError = void,
936
939
  return useMutation(mutationOptions);
937
940
  }
938
941
  /**
939
- * @summary Remove a person from an account. Note that you cannot remove the primary contact of an account.
942
+ * Note that you cannot remove the primary contact of an account.
943
+ * @summary Remove a person from an account.
940
944
  */
941
945
  export const accountDeleteMembership = (
942
946
  accountUid: string | null,
@@ -983,7 +987,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
983
987
  export type AccountDeleteMembershipMutationError = void
984
988
 
985
989
  /**
986
- * @summary Remove a person from an account. Note that you cannot remove the primary contact of an account.
990
+ * @summary Remove a person from an account.
987
991
  */
988
992
  export const useAccountDeleteMembership = <TError = void,
989
993
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof accountDeleteMembership>>, TError,{accountUid: string | null;membershipUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
@@ -1590,7 +1594,8 @@ export const usePersonDeletePerson = <TError = void,
1590
1594
  return useMutation(mutationOptions);
1591
1595
  }
1592
1596
  /**
1593
- * @summary Set a temporary password for a user. The user needs to update the password with the next login.
1597
+ * The user needs to update the password with the next login.
1598
+ * @summary Set a temporary password for a user.
1594
1599
  */
1595
1600
  export const personSetTemporaryPassword = (
1596
1601
  personUid: string | null,
@@ -1639,7 +1644,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
1639
1644
  export type PersonSetTemporaryPasswordMutationError = void
1640
1645
 
1641
1646
  /**
1642
- * @summary Set a temporary password for a user. The user needs to update the password with the next login.
1647
+ * @summary Set a temporary password for a user.
1643
1648
  */
1644
1649
  export const usePersonSetTemporaryPassword = <TError = void,
1645
1650
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof personSetTemporaryPassword>>, TError,{personUid: string | null;data: PersonSetTemporaryPasswordBody}, TContext>, request?: SecondParameter<typeof customFetch>}
@@ -1655,11 +1660,11 @@ export const usePersonSetTemporaryPassword = <TError = void,
1655
1660
  return useMutation(mutationOptions);
1656
1661
  }
1657
1662
  /**
1658
- * All prior recovery codes are invalidated. Existing TOTP/Email mechanisms are intentionally
1659
- left in place — the admin returns the new codes to the user out of band, the user logs in
1660
- with one, then re-enrolls their device. Mirrors the temporary-password flow at
1661
- SetTemporaryPassword.
1662
- * @summary Regenerate 2FA recovery codes for a user locked out of their authenticator.
1663
+ * Use this when a user is locked out of their authenticator. All prior recovery codes are
1664
+ invalidated. Existing TOTP/Email mechanisms are intentionally left in place — the admin
1665
+ returns the new codes to the user out of band, the user logs in with one, then re-enrolls
1666
+ their device. Mirrors the temporary-password flow at SetTemporaryPassword.
1667
+ * @summary Regenerate 2FA recovery codes for a user.
1663
1668
  */
1664
1669
  export const personRegenerateTwoFactorRecoveryCodes = (
1665
1670
  personUid: string | null,
@@ -1705,7 +1710,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
1705
1710
  export type PersonRegenerateTwoFactorRecoveryCodesMutationError = void
1706
1711
 
1707
1712
  /**
1708
- * @summary Regenerate 2FA recovery codes for a user locked out of their authenticator.
1713
+ * @summary Regenerate 2FA recovery codes for a user.
1709
1714
  */
1710
1715
  export const usePersonRegenerateTwoFactorRecoveryCodes = <TError = void,
1711
1716
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof personRegenerateTwoFactorRecoveryCodes>>, TError,{personUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}