@outseta/api-client 0.3.4 → 0.3.5

package/src/generated/crm/crm.ts

@@ -52,7 +52,8 @@ type NonReadonly<T> = [T] extends [UnionToIntersection<T>] ? {
 
 
 /**
- * @summary Retrieves all the deals associated with your account.
+ * Returns the deals associated with your account.
+ * @summary Retrieve all deals.
  */
 export type dealGetAllDealsResponse200 = {
   data: Deal[]
@@ -149,7 +150,7 @@ export const dealAddDeal = async (dealAddDealBody: NonReadonly<DealAddDealBody>,
 
 
 /**
- * @summary Retrieves one deal associated with your account.
+ * @summary Retrieve a deal.
  */
 export type dealGetDealResponse200 = {
   data: Deal
@@ -349,7 +350,8 @@ export const registrationRegisterAccount = async (account: NonReadonly<Account>,
 
 
 /**
- * @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 type accountGetAllAccountsResponse200 = {
   data: Account[]
@@ -456,7 +458,7 @@ export const accountAddAccount = async (accountAddAccountBody: NonReadonly<Accou
 
 
 /**
- * @summary Returns a single account by UID.
+ * @summary Retrieve an account.
  */
 export type accountGetAccountResponse200 = {
   data: Account
@@ -999,7 +1001,8 @@ export const accountSendConfirmationEmail = async (accountUid: string | null, op
 
 
 /**
- * @summary Retrieves all the people associated with your account.
+ * Returns the people associated with your account.
+ * @summary Retrieve all people.
  */
 export type personGetAllPeopleResponse200 = {
   data: Person[]
@@ -1091,7 +1094,7 @@ export const personAddPerson = async (personAddPersonBody: NonReadonly<PersonAdd
 
 
 /**
- * @summary Retrieves a person.
+ * @summary Retrieve a person.
  */
 export type personGetPersonResponse200 = {
   data: Person

package/src/generated/email/email.ts

@@ -39,7 +39,8 @@ type NonReadonly<T> = [T] extends [UnionToIntersection<T>] ? {
 
 
 /**
- * @summary Retrieves all non-archived broadcast campaigns.
+ * Archived campaigns are excluded.
+ * @summary Retrieve all broadcast campaigns.
  */
 export type campaignGetAllBroadcastEmailsResponse200 = {
   data: BroadcastCampaign[]
@@ -128,7 +129,7 @@ export const campaignAddBroadcastEmail = async (campaignAddBroadcastEmailBody: N
 
 
 /**
- * @summary Retrieves a single broadcast campaign by its Uid.
+ * @summary Retrieve a broadcast campaign.
  */
 export type campaignGetBroadcastEmailResponse200 = {
   data: BroadcastCampaign
@@ -442,7 +443,7 @@ export const campaignSendTestCampaignEmail = async (campaignSendTestCampaignEmai
 
 
 /**
- * @summary Retrieves all the people subscribing to an email list.
+ * @summary Retrieve all subscribers to an email list.
  */
 export type emailListGetAllSubscriptionsResponse200 = {
   data: EmailListPerson[]

package/src/generated/models/discountCouponGetAllDiscountCouponsParams.ts

@@ -0,0 +1,18 @@
+// @ts-nocheck
+
+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;
+};

package/src/generated/models/discountCouponGetDiscountCouponByCodeParams.ts

@@ -0,0 +1,9 @@
+// @ts-nocheck
+
+export type DiscountCouponGetDiscountCouponByCodeParams = {
+/**
+ * The unique identifier of the plan to validate the coupon against
+ * @nullable
+ */
+planUid: string | null;
+};

package/src/generated/models/discountCouponGetDiscountCouponRedemptionsParams.ts

@@ -0,0 +1,14 @@
+// @ts-nocheck
+
+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;
+};

package/src/generated/models/discountCouponUpdateDiscountCouponBody.ts

@@ -0,0 +1,7 @@
+// @ts-nocheck
+import type { DiscountCoupon } from './discountCoupon';
+
+/**
+ * @nullable
+ */
+export type DiscountCouponUpdateDiscountCouponBody = DiscountCoupon | null;

package/src/generated/models/index.ts

@@ -187,6 +187,9 @@ export * from './discordUserAllOf';
 export * from './discountCoupon';
 export * from './discountCouponAddDiscountCouponBody';
 export * from './discountCouponAllOf';
+export * from './discountCouponGetAllDiscountCouponsParams';
+export * from './discountCouponGetDiscountCouponByCodeParams';
+export * from './discountCouponGetDiscountCouponRedemptionsParams';
 export * from './discountCouponPlan';
 export * from './discountCouponPlanAllOf';
 export * from './discountCouponPlanAllOfDiscountCoupon';
@@ -195,6 +198,7 @@ export * from './discountCouponSubscription';
 export * from './discountCouponSubscriptionAllOf';
 export * from './discountCouponSubscriptionAllOfDiscountCoupon';
 export * from './discountCouponSubscriptionAllOfSubscription';
+export * from './discountCouponUpdateDiscountCouponBody';
 export * from './dnsEntry';
 export * from './dripCampaign';
 export * from './dripCampaignAllOf';
@@ -301,10 +305,14 @@ export * from './planAddOn';
 export * from './planAddOnAllOf';
 export * from './planAddOnAllOfAddOn';
 export * from './planAddOnAllOfPlan';
+export * from './planAddPlanBody';
 export * from './planAllOf';
 export * from './planAllOfPlanFamily';
 export * from './planFamily';
+export * from './planFamilyAddPlanFamilyBody';
 export * from './planFamilyAllOf';
+export * from './planFamilyUpdatePlanFamilyBody';
+export * from './planUpdatePlanBody';
 export * from './processCodePayload';
 export * from './qcount';
 export * from './qcountAllOf';
@@ -428,9 +436,12 @@ export * from './stripeSubscriptionSchedulePhaseItemAllOfStripePrice';
 export * from './subscription';
 export * from './subscriptionAddOn';
 export * from './subscriptionAddOnAddSubscriptionAddOnBody';
+export * from './subscriptionAddOnAddSubscriptionAddOnPreviewBody';
 export * from './subscriptionAddOnAllOf';
 export * from './subscriptionAddOnAllOfAddOn';
 export * from './subscriptionAddOnAllOfSubscription';
+export * from './subscriptionAddOnGetAllSubscriptionsAddOnsParams';
+export * from './subscriptionAddOnSetAddOnUpgradeRequiredBody';
 export * from './subscriptionAllOf';
 export * from './subscriptionAllOfAccount';
 export * from './subscriptionAllOfLatestInvoice';
@@ -442,6 +453,7 @@ export * from './subscriptionChangeSubscriptionPreviewParams';
 export * from './subscriptionFirstTimeSubscriptionBody';
 export * from './subscriptionFirstTimeSubscriptionPreviewBody';
 export * from './subscriptionFirstTimeSubscriptionPreviewParams';
+export * from './subscriptionGetAllSubscriptionsParams';
 export * from './subscriptionSetSubscriptionUpgradeRequiredBody';
 export * from './supportArticleStatus';
 export * from './supportCaseHistoryType';

package/src/generated/models/planAddPlanBody.ts

@@ -0,0 +1,7 @@
+// @ts-nocheck
+import type { Plan } from './plan';
+
+/**
+ * @nullable
+ */
+export type PlanAddPlanBody = Plan | null;

package/src/generated/models/planFamilyAddPlanFamilyBody.ts

@@ -0,0 +1,7 @@
+// @ts-nocheck
+import type { PlanFamily } from './planFamily';
+
+/**
+ * @nullable
+ */
+export type PlanFamilyAddPlanFamilyBody = PlanFamily | null;

package/src/generated/models/planFamilyUpdatePlanFamilyBody.ts

@@ -0,0 +1,7 @@
+// @ts-nocheck
+import type { PlanFamily } from './planFamily';
+
+/**
+ * @nullable
+ */
+export type PlanFamilyUpdatePlanFamilyBody = PlanFamily | null;

package/src/generated/models/planUpdatePlanBody.ts

@@ -0,0 +1,7 @@
+// @ts-nocheck
+import type { Plan } from './plan';
+
+/**
+ * @nullable
+ */
+export type PlanUpdatePlanBody = Plan | null;

package/src/generated/models/subscriptionAddOnAddSubscriptionAddOnPreviewBody.ts

@@ -0,0 +1,7 @@
+// @ts-nocheck
+import type { SubscriptionAddOn } from './subscriptionAddOn';
+
+/**
+ * @nullable
+ */
+export type SubscriptionAddOnAddSubscriptionAddOnPreviewBody = SubscriptionAddOn | null;

package/src/generated/models/subscriptionAddOnGetAllSubscriptionsAddOnsParams.ts

@@ -0,0 +1,9 @@
+// @ts-nocheck
+
+export type SubscriptionAddOnGetAllSubscriptionsAddOnsParams = {
+/**
+ * Filters by the add-on's lifecycle: current, future, or past
+ * @nullable
+ */
+status?: string | null;
+};

package/src/generated/models/subscriptionAddOnSetAddOnUpgradeRequiredBody.ts

@@ -0,0 +1,7 @@
+// @ts-nocheck
+import type { SubscriptionAddOn } from './subscriptionAddOn';
+
+/**
+ * @nullable
+ */
+export type SubscriptionAddOnSetAddOnUpgradeRequiredBody = SubscriptionAddOn | null;

package/src/generated/models/subscriptionGetAllSubscriptionsParams.ts

@@ -0,0 +1,14 @@
+// @ts-nocheck
+
+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;
+};

package/src/generated/public/public.ts

@@ -18,7 +18,9 @@ import type {
 import { customFetch } from '../../client';
 
 /**
- * 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" }
             
@@ -53,7 +55,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 type authGetTokenResponse200 = {
   data: TokenPayload

package/src/generated/support/support.ts

@@ -40,9 +40,10 @@ type NonReadonly<T> = [T] extends [UnionToIntersection<T>] ? {
 
 
 /**
- * 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 type caseGetAllCasesResponse200 = {
   data: Case[]
@@ -147,7 +148,7 @@ export const caseAddCase = async (caseAddCaseBody: NonReadonly<CaseAddCaseBody>,
 
 
 /**
- * @summary Retrieve a specific case
+ * @summary Retrieve a case.
  */
 export type caseGetCaseResponse200 = {
   data: Case
@@ -347,7 +348,7 @@ export const articleGetAllArticles = async (params?: ArticleGetAllArticlesParams
 
 
 /**
- * @summary Retrieves a knowledge base article.
+ * @summary Retrieve a knowledge base article.
  */
 export type articleGetArticleResponse200 = {
   data: Article
@@ -394,7 +395,7 @@ export const articleGetArticle = async (articleUid: string | null, options?: Req
 
 
 /**
- * @summary Retrieves all knowledge base categories.
+ * @summary Retrieve all knowledge base categories.
  */
 export type categoryGetAllCategoriesResponse200 = {
   data: Category[]