@outseta/react 0.3.5 → 0.3.7

package/src/generated/crm/crm.ts

@@ -71,7 +71,8 @@ type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
 
 /**
- * @summary Retrieves all the deals associated with your account.
+ * Returns the deals associated with your account.
+ * @summary Retrieve all deals.
  */
 export const dealGetAllDeals = (
     params?: DealGetAllDealsParams,
@@ -119,7 +120,7 @@ export type DealGetAllDealsQueryError = void
 
 
 /**
- * @summary Retrieves all the deals associated with your account.
+ * @summary Retrieve all deals.
  */
 
 export function useDealGetAllDeals<TData = Awaited<ReturnType<typeof dealGetAllDeals>>, TError = void>(
@@ -204,7 +205,7 @@ export const useDealAddDeal = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * @summary Retrieves one deal associated with your account.
+ * @summary Retrieve a deal.
  */
 export const dealGetDeal = (
     dealUid: string | null,
@@ -251,7 +252,7 @@ export type DealGetDealQueryError = void
 
 
 /**
- * @summary Retrieves one deal associated with your account.
+ * @summary Retrieve a deal.
  */
 
 export function useDealGetDeal<TData = Awaited<ReturnType<typeof dealGetDeal>>, TError = void>(
@@ -468,7 +469,8 @@ export const useRegistrationRegisterAccount = <TError = unknown,
       return useMutation(mutationOptions);
     }
     /**
- * @summary Returns all accounts, optionally filtered by segment or search query.
+ * Optionally filtered by segment (segmentUid) or search query (q).
+ * @summary Retrieve all accounts.
  */
 export const accountGetAllAccounts = (
     params?: AccountGetAllAccountsParams,
@@ -516,7 +518,7 @@ export type AccountGetAllAccountsQueryError = void
 
 
 /**
- * @summary Returns all accounts, optionally filtered by segment or search query.
+ * @summary Retrieve all accounts.
  */
 
 export function useAccountGetAllAccounts<TData = Awaited<ReturnType<typeof accountGetAllAccounts>>, TError = void>(
@@ -606,7 +608,7 @@ export const useAccountAddAccount = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * @summary Returns a single account by UID.
+ * @summary Retrieve an account.
  */
 export const accountGetAccount = (
     accountUid: string | null,
@@ -653,7 +655,7 @@ export type AccountGetAccountQueryError = void
 
 
 /**
- * @summary Returns a single account by UID.
+ * @summary Retrieve an account.
  */
 
 export function useAccountGetAccount<TData = Awaited<ReturnType<typeof accountGetAccount>>, TError = void>(
@@ -1257,7 +1259,8 @@ export const useAccountSendConfirmationEmail = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * @summary Retrieves all the people associated with your account.
+ * Returns the people associated with your account.
+ * @summary Retrieve all people.
  */
 export const personGetAllPeople = (
     params?: PersonGetAllPeopleParams,
@@ -1305,7 +1308,7 @@ export type PersonGetAllPeopleQueryError = void
 
 
 /**
- * @summary Retrieves all the people associated with your account.
+ * @summary Retrieve all people.
  */
 
 export function usePersonGetAllPeople<TData = Awaited<ReturnType<typeof personGetAllPeople>>, TError = void>(
@@ -1390,7 +1393,7 @@ export const usePersonAddPerson = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * @summary Retrieves a person.
+ * @summary Retrieve a person.
  */
 export const personGetPerson = (
     personUid: string | null,
@@ -1437,7 +1440,7 @@ export type PersonGetPersonQueryError = void
 
 
 /**
- * @summary Retrieves a person.
+ * @summary Retrieve a person.
  */
 
 export function usePersonGetPerson<TData = Awaited<ReturnType<typeof personGetPerson>>, TError = void>(

package/src/generated/email/email.ts

@@ -58,7 +58,8 @@ type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
 
 /**
- * @summary Retrieves all non-archived broadcast campaigns.
+ * Archived campaigns are excluded.
+ * @summary Retrieve all broadcast campaigns.
  */
 export const campaignGetAllBroadcastEmails = (
     
@@ -105,7 +106,7 @@ export type CampaignGetAllBroadcastEmailsQueryError = void
 
 
 /**
- * @summary Retrieves all non-archived broadcast campaigns.
+ * @summary Retrieve all broadcast campaigns.
  */
 
 export function useCampaignGetAllBroadcastEmails<TData = Awaited<ReturnType<typeof campaignGetAllBroadcastEmails>>, TError = void>(
@@ -194,7 +195,7 @@ export const useCampaignAddBroadcastEmail = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * @summary Retrieves a single broadcast campaign by its Uid.
+ * @summary Retrieve a broadcast campaign.
  */
 export const campaignGetBroadcastEmail = (
     broadcastCampaignUid: string | null,
@@ -241,7 +242,7 @@ export type CampaignGetBroadcastEmailQueryError = void
 
 
 /**
- * @summary Retrieves a single broadcast campaign by its Uid.
+ * @summary Retrieve a broadcast campaign.
  */
 
 export function useCampaignGetBroadcastEmail<TData = Awaited<ReturnType<typeof campaignGetBroadcastEmail>>, TError = void>(
@@ -587,7 +588,7 @@ export const useCampaignSendTestCampaignEmail = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * @summary Retrieves all the people subscribing to an email list.
+ * @summary Retrieve all subscribers to an email list.
  */
 export const emailListGetAllSubscriptions = (
     emailListUid: string | null,
@@ -638,7 +639,7 @@ export type EmailListGetAllSubscriptionsQueryError = void
 
 
 /**
- * @summary Retrieves all the people subscribing to an email list.
+ * @summary Retrieve all subscribers to an email list.
  */
 
 export function useEmailListGetAllSubscriptions<TData = Awaited<ReturnType<typeof emailListGetAllSubscriptions>>, TError = void>(

package/src/generated/outsetaAPI.schemas.ts

@@ -3785,6 +3785,11 @@ export type MessageAllOf = {
    * @nullable
    */
   Subject?: string | null;
+  /**
+   * @maxLength 250
+   * @nullable
+   */
+  PreviewText?: string | null;
   /** @nullable */
   Body?: string | null;
   /** @nullable */
@@ -6073,11 +6078,54 @@ export type PersonSetTemporaryPasswordBody = TemporaryPasswordModel | null;
  */
 export type PersonForgotPasswordBody = Person | null;
 
+export type DiscountCouponGetDiscountCouponByCodeParams = {
+/**
+ * The unique identifier of the plan to validate the coupon against
+ * @nullable
+ */
+planUid: string | null;
+};
+
+export type DiscountCouponGetAllDiscountCouponsParams = {
+/**
+ * When true, returns only coupons that can still be redeemed
+ */
+canRedeem?: boolean;
+/**
+ * Searches coupons by name or code
+ * @nullable
+ */
+q?: string | null;
+/**
+ * Returns only coupons that apply to the plan with this unique identifier
+ * @nullable
+ */
+planUid?: string | null;
+};
+
 /**
  * @nullable
  */
 export type DiscountCouponAddDiscountCouponBody = DiscountCoupon | null;
 
+/**
+ * @nullable
+ */
+export type DiscountCouponUpdateDiscountCouponBody = DiscountCoupon | null;
+
+export type DiscountCouponGetDiscountCouponRedemptionsParams = {
+/**
+ * Searches redemptions by account or plan name
+ * @nullable
+ */
+q?: string | null;
+/**
+ * When set, filters by whether the redemption is still active
+ * @nullable
+ */
+isActive?: boolean | null;
+};
+
 /**
  * @nullable
  */
@@ -6093,11 +6141,29 @@ export type TransactionsAddPaymentTransactionBody = Transaction | null;
  */
 export type PaymentInformationSavePaymentInformationBody = PaymentInformation | null;
 
+export type SubscriptionAddOnGetAllSubscriptionsAddOnsParams = {
+/**
+ * Filters by the add-on's lifecycle: current, future, or past
+ * @nullable
+ */
+status?: string | null;
+};
+
 /**
  * @nullable
  */
 export type SubscriptionAddOnAddSubscriptionAddOnBody = SubscriptionAddOn | null;
 
+/**
+ * @nullable
+ */
+export type SubscriptionAddOnAddSubscriptionAddOnPreviewBody = SubscriptionAddOn | null;
+
+/**
+ * @nullable
+ */
+export type SubscriptionAddOnSetAddOnUpgradeRequiredBody = SubscriptionAddOn | null;
+
 /**
  * @nullable
  */
@@ -6108,6 +6174,19 @@ export type InvoiceAddInvoiceBody = Invoice | null;
  */
 export type InvoiceUpdateInvoiceBody = Invoice | null;
 
+export type SubscriptionGetAllSubscriptionsParams = {
+/**
+ * Pass 1 to return only the most recent subscription per account, expired or not
+ * @nullable
+ */
+current?: string | null;
+/**
+ * Filters by the subscription's lifecycle: current, future, or past
+ * @nullable
+ */
+status?: string | null;
+};
+
 /**
  * @nullable
  */
@@ -6157,6 +6236,26 @@ startImmediately?: string | null;
  */
 export type SubscriptionChangeSubscriptionBody = Subscription | null;
 
+/**
+ * @nullable
+ */
+export type PlanAddPlanBody = Plan | null;
+
+/**
+ * @nullable
+ */
+export type PlanUpdatePlanBody = Plan | null;
+
+/**
+ * @nullable
+ */
+export type PlanFamilyAddPlanFamilyBody = PlanFamily | null;
+
+/**
+ * @nullable
+ */
+export type PlanFamilyUpdatePlanFamilyBody = PlanFamily | null;
+
 export type ActivityGetAllParams = {
 /**
  * @nullable

package/src/generated/public/public.ts

@@ -32,7 +32,9 @@ type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
 
 /**
- * Post a JSON body with the user's credentials:
+ * Authenticates a user and returns a JWT access token (plus a refresh token).
+            
+Post a JSON body with the user's credentials:
             
     { "username": "user@example.com", "password": "their-password" }
             
@@ -67,7 +69,7 @@ body instead contains `"two_factor_enrollment_required": true` with a
 `challenge_token` to drive the mid-login enrollment endpoints.
             
 Invalid credentials return `400` with a body of `invalid_grant`.
- * @summary Log a user in and obtain a JWT access token.
+ * @summary Log a user in.
  */
 export const authGetToken = (
     params: AuthGetTokenParams,
@@ -114,7 +116,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
     export type AuthGetTokenMutationError = string
 
     /**
- * @summary Log a user in and obtain a JWT access token.
+ * @summary Log a user in.
  */
 export const useAuthGetToken = <TError = string,
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof authGetToken>>, TError,{params: AuthGetTokenParams}, TContext>, request?: SecondParameter<typeof customFetch>}

package/src/generated/support/support.ts

@@ -59,9 +59,10 @@ type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
 
 /**
- * Assigned cases can be filtered by passing in the AssignedToPersonClientIdentifier,
+ * Optionally filtered by search string, tag, and/or assignment.
+Assigned cases can be filtered by passing in the AssignedToPersonClientIdentifier,
 which is the Uid of the person the case is assigned to.
- * @summary Returns all cases, optionally filtered by search string, tag, and/or assignment.
+ * @summary Retrieve all cases.
  */
 export const caseGetAllCases = (
     params?: CaseGetAllCasesParams,
@@ -109,7 +110,7 @@ export type CaseGetAllCasesQueryError = void
 
 
 /**
- * @summary Returns all cases, optionally filtered by search string, tag, and/or assignment.
+ * @summary Retrieve all cases.
  */
 
 export function useCaseGetAllCases<TData = Awaited<ReturnType<typeof caseGetAllCases>>, TError = void>(
@@ -196,7 +197,7 @@ export const useCaseAddCase = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * @summary Retrieve a specific case
+ * @summary Retrieve a case.
  */
 export const caseGetCase = (
     caseUid: string | null,
@@ -243,7 +244,7 @@ export type CaseGetCaseQueryError = void
 
 
 /**
- * @summary Retrieve a specific case
+ * @summary Retrieve a case.
  */
 
 export function useCaseGetCase<TData = Awaited<ReturnType<typeof caseGetCase>>, TError = void>(
@@ -459,7 +460,7 @@ export function useArticleGetAllArticles<TData = Awaited<ReturnType<typeof artic
 
 
 /**
- * @summary Retrieves a knowledge base article.
+ * @summary Retrieve a knowledge base article.
  */
 export const articleGetArticle = (
     articleUid: string | null,
@@ -506,7 +507,7 @@ export type ArticleGetArticleQueryError = void
 
 
 /**
- * @summary Retrieves a knowledge base article.
+ * @summary Retrieve a knowledge base article.
  */
 
 export function useArticleGetArticle<TData = Awaited<ReturnType<typeof articleGetArticle>>, TError = void>(
@@ -527,7 +528,7 @@ export function useArticleGetArticle<TData = Awaited<ReturnType<typeof articleGe
 
 
 /**
- * @summary Retrieves all knowledge base categories.
+ * @summary Retrieve all knowledge base categories.
  */
 export const categoryGetAllCategories = (
     
@@ -574,7 +575,7 @@ export type CategoryGetAllCategoriesQueryError = unknown
 
 
 /**
- * @summary Retrieves all knowledge base categories.
+ * @summary Retrieve all knowledge base categories.
  */
 
 export function useCategoryGetAllCategories<TData = Awaited<ReturnType<typeof categoryGetAllCategories>>, TError = unknown>(