@outseta/react 0.4.16 → 0.4.18

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.
@@ -1475,6 +1475,8 @@ export type StripeSubscriptionAllOfAccount = Account | null;
1475
1475
  export type StripeSubscriptionAllOfCurrentStripeSubscriptionSchedule = StripeSubscriptionSchedule | null;
1476
1476
 
1477
1477
  export type StripeSubscriptionAllOf = {
1478
+ /** @nullable */
1479
+ ApplicationFeePercent?: number | null;
1478
1480
  /** @nullable */
1479
1481
  CancelAt?: string | null;
1480
1482
  CancelAtPeriodEnd?: boolean;
@@ -1871,6 +1873,13 @@ export type StripeChargeAllOf = {
1871
1873
  Amount?: number;
1872
1874
  AmountCaptured?: number;
1873
1875
  AmountRefunded?: number;
1876
+ /** @nullable */
1877
+ ApplicationFeeAmount?: number | null;
1878
+ /**
1879
+ * @maxLength 255
1880
+ * @nullable
1881
+ */
1882
+ ApplicationFeeId?: string | null;
1874
1883
  Captured?: boolean;
1875
1884
  /**
1876
1885
  * @maxLength 3
@@ -4436,6 +4445,7 @@ export type CrmSettingsAllOf = {
4436
4445
  /** @nullable */
4437
4446
  RegistrationCallbackUrlLocations?: string | null;
4438
4447
  TwoFactorAuthenticationAvailable?: boolean;
4448
+ MagicLinkLoginOnly?: boolean;
4439
4449
  };
4440
4450
 
4441
4451
  export type CrmSettings = AbstractQcountBean & CrmSettingsAllOf;
@@ -4924,6 +4934,12 @@ export interface ActivityCriteria {
4924
4934
  ActivityTypes?: string[] | null;
4925
4935
  }
4926
4936
 
4937
+ export interface CollectionMetadata {
4938
+ limit?: number;
4939
+ offset?: number;
4940
+ total?: number;
4941
+ }
4942
+
4927
4943
  /**
4928
4944
  * @nullable
4929
4945
  */
@@ -5427,6 +5443,8 @@ export type AccountWebhookEntityStripeSubscriptionsItem = {
5427
5443
  StripeId?: string | null;
5428
5444
  IsLivemode?: boolean;
5429
5445
  /** @nullable */
5446
+ ApplicationFeePercent?: number | null;
5447
+ /** @nullable */
5430
5448
  CancelAt?: string | null;
5431
5449
  CancelAtPeriodEnd?: boolean;
5432
5450
  /**
@@ -7073,6 +7091,8 @@ export type AccountWebhookEntityPrimaryStripeSubscription = {
7073
7091
  StripeId?: string | null;
7074
7092
  IsLivemode?: boolean;
7075
7093
  /** @nullable */
7094
+ ApplicationFeePercent?: number | null;
7095
+ /** @nullable */
7076
7096
  CancelAt?: string | null;
7077
7097
  CancelAtPeriodEnd?: boolean;
7078
7098
  /**
@@ -8971,6 +8991,32 @@ export type DiscordUserRemovedFromServerWebhookPayloadAllOf = {
8971
8991
 
8972
8992
  export type DiscordUserRemovedFromServerWebhookPayload = PersonWebhookEntity & DiscordUserRemovedFromServerWebhookPayloadAllOf;
8973
8993
 
8994
+ /**
8995
+ * Maximum number of records per page.
8996
+ */
8997
+ export type LimitParameter = number;
8998
+
8999
+ /**
9000
+ * Zero-based page index.
9001
+ */
9002
+ export type OffsetParameter = number;
9003
+
9004
+ export type DefinitionGetAllDefinitionsParams = {
9005
+ /**
9006
+ * Maximum number of records per page.
9007
+ */
9008
+ limit?: LimitParameter;
9009
+ /**
9010
+ * Zero-based page index.
9011
+ */
9012
+ offset?: OffsetParameter;
9013
+ };
9014
+
9015
+ export type DefinitionGetAllDefinitions200 = {
9016
+ metadata?: CollectionMetadata;
9017
+ items?: Definition[];
9018
+ };
9019
+
8974
9020
  export type AuthGetTokenParams = {
8975
9021
  /**
8976
9022
  * @nullable
@@ -9040,6 +9086,11 @@ q?: string | null;
9040
9086
  tagUid?: string | null;
9041
9087
  };
9042
9088
 
9089
+ export type CaseGetAllCases200 = {
9090
+ metadata?: CollectionMetadata;
9091
+ items?: Case[];
9092
+ };
9093
+
9043
9094
  export type CaseAddCaseParams = {
9044
9095
  /**
9045
9096
  * Indicates whether an automatic message is sent that the ticket has been created.
@@ -9061,11 +9112,48 @@ export type ArticleGetAllArticlesParams = {
9061
9112
  q?: string | null;
9062
9113
  };
9063
9114
 
9115
+ export type ArticleGetAllArticles200 = {
9116
+ metadata?: CollectionMetadata;
9117
+ items?: Article[];
9118
+ };
9119
+
9064
9120
  /**
9065
9121
  * @nullable
9066
9122
  */
9067
9123
  export type ArticleAddArticleBody = Article | null;
9068
9124
 
9125
+ export type CategoryGetAllCategoriesParams = {
9126
+ /**
9127
+ * Maximum number of records per page.
9128
+ */
9129
+ limit?: LimitParameter;
9130
+ /**
9131
+ * Zero-based page index.
9132
+ */
9133
+ offset?: OffsetParameter;
9134
+ };
9135
+
9136
+ export type CategoryGetAllCategories200 = {
9137
+ metadata?: CollectionMetadata;
9138
+ items?: Category[];
9139
+ };
9140
+
9141
+ export type DripCampaignGetAllDripCampaignsParams = {
9142
+ /**
9143
+ * Maximum number of records per page.
9144
+ */
9145
+ limit?: LimitParameter;
9146
+ /**
9147
+ * Zero-based page index.
9148
+ */
9149
+ offset?: OffsetParameter;
9150
+ };
9151
+
9152
+ export type DripCampaignGetAllDripCampaigns200 = {
9153
+ metadata?: CollectionMetadata;
9154
+ items?: DripCampaign[];
9155
+ };
9156
+
9069
9157
  /**
9070
9158
  * @nullable
9071
9159
  */
@@ -9091,6 +9179,22 @@ export type DripCampaignUpdateDripCampaignMessageBody = DripCampaignMessage | nu
9091
9179
  */
9092
9180
  export type DripCampaignSendTestCampaignEmailBody = SendTestEmailRequest | null;
9093
9181
 
9182
+ export type CampaignGetAllBroadcastEmailsParams = {
9183
+ /**
9184
+ * Maximum number of records per page.
9185
+ */
9186
+ limit?: LimitParameter;
9187
+ /**
9188
+ * Zero-based page index.
9189
+ */
9190
+ offset?: OffsetParameter;
9191
+ };
9192
+
9193
+ export type CampaignGetAllBroadcastEmails200 = {
9194
+ metadata?: CollectionMetadata;
9195
+ items?: BroadcastCampaign[];
9196
+ };
9197
+
9094
9198
  /**
9095
9199
  * @nullable
9096
9200
  */
@@ -9114,6 +9218,11 @@ export type EmailListGetAllSubscriptionsParams = {
9114
9218
  q?: string | null;
9115
9219
  };
9116
9220
 
9221
+ export type EmailListGetAllSubscriptions200 = {
9222
+ metadata?: CollectionMetadata;
9223
+ items?: EmailListPerson[];
9224
+ };
9225
+
9117
9226
  /**
9118
9227
  * @nullable
9119
9228
  */
@@ -9132,6 +9241,11 @@ ownerUid?: string | null;
9132
9241
  q?: string | null;
9133
9242
  };
9134
9243
 
9244
+ export type DealGetAllDeals200 = {
9245
+ metadata?: CollectionMetadata;
9246
+ items?: Deal[];
9247
+ };
9248
+
9135
9249
  /**
9136
9250
  * @nullable
9137
9251
  */
@@ -9155,6 +9269,11 @@ segmentUid?: string | null;
9155
9269
  q?: string | null;
9156
9270
  };
9157
9271
 
9272
+ export type AccountGetAllAccounts200 = {
9273
+ metadata?: CollectionMetadata;
9274
+ items?: Account[];
9275
+ };
9276
+
9158
9277
  export type AccountAddAccountParams = {
9159
9278
  isImported?: boolean;
9160
9279
  };
@@ -9197,6 +9316,11 @@ export type PersonGetAllPeopleParams = {
9197
9316
  q?: string | null;
9198
9317
  };
9199
9318
 
9319
+ export type PersonGetAllPeople200 = {
9320
+ metadata?: CollectionMetadata;
9321
+ items?: Person[];
9322
+ };
9323
+
9200
9324
  /**
9201
9325
  * @nullable
9202
9326
  */
@@ -9242,6 +9366,11 @@ q?: string | null;
9242
9366
  planUid?: string | null;
9243
9367
  };
9244
9368
 
9369
+ export type DiscountCouponGetAllDiscountCoupons200 = {
9370
+ metadata?: CollectionMetadata;
9371
+ items?: DiscountCoupon[];
9372
+ };
9373
+
9245
9374
  /**
9246
9375
  * @nullable
9247
9376
  */
@@ -9265,11 +9394,32 @@ q?: string | null;
9265
9394
  isActive?: boolean | null;
9266
9395
  };
9267
9396
 
9397
+ export type DiscountCouponGetDiscountCouponRedemptions200 = {
9398
+ metadata?: CollectionMetadata;
9399
+ items?: DiscountCouponSubscription[];
9400
+ };
9401
+
9268
9402
  /**
9269
9403
  * @nullable
9270
9404
  */
9271
9405
  export type UsageAddUsageBody = Usage | null;
9272
9406
 
9407
+ export type TransactionsGetAllTransactionsByAccountIdParams = {
9408
+ /**
9409
+ * Maximum number of records per page.
9410
+ */
9411
+ limit?: LimitParameter;
9412
+ /**
9413
+ * Zero-based page index.
9414
+ */
9415
+ offset?: OffsetParameter;
9416
+ };
9417
+
9418
+ export type TransactionsGetAllTransactionsByAccountId200 = {
9419
+ metadata?: CollectionMetadata;
9420
+ items?: Transaction[];
9421
+ };
9422
+
9273
9423
  /**
9274
9424
  * @nullable
9275
9425
  */
@@ -9288,6 +9438,11 @@ export type SubscriptionAddOnGetAllSubscriptionsAddOnsParams = {
9288
9438
  status?: string | null;
9289
9439
  };
9290
9440
 
9441
+ export type SubscriptionAddOnGetAllSubscriptionsAddOns200 = {
9442
+ metadata?: CollectionMetadata;
9443
+ items?: SubscriptionAddOn[];
9444
+ };
9445
+
9291
9446
  /**
9292
9447
  * @nullable
9293
9448
  */
@@ -9303,6 +9458,26 @@ export type SubscriptionAddOnAddSubscriptionAddOnPreviewBody = SubscriptionAddOn
9303
9458
  */
9304
9459
  export type SubscriptionAddOnSetAddOnUpgradeRequiredBody = SubscriptionAddOn | null;
9305
9460
 
9461
+ export type InvoiceGetAllInvoicesParams = {
9462
+ /**
9463
+ * Maximum number of records per page.
9464
+ */
9465
+ limit?: LimitParameter;
9466
+ /**
9467
+ * Zero-based page index.
9468
+ */
9469
+ offset?: OffsetParameter;
9470
+ /**
9471
+ * The invoice Uid to omit from the result set.
9472
+ */
9473
+ excludeInvoiceUid?: string;
9474
+ };
9475
+
9476
+ export type InvoiceGetAllInvoices200 = {
9477
+ metadata?: CollectionMetadata;
9478
+ items?: Invoice[];
9479
+ };
9480
+
9306
9481
  /**
9307
9482
  * @nullable
9308
9483
  */
@@ -9326,6 +9501,11 @@ current?: string | null;
9326
9501
  status?: string | null;
9327
9502
  };
9328
9503
 
9504
+ export type SubscriptionGetAllSubscriptions200 = {
9505
+ metadata?: CollectionMetadata;
9506
+ items?: Subscription[];
9507
+ };
9508
+
9329
9509
  /**
9330
9510
  * @nullable
9331
9511
  */
@@ -9375,6 +9555,22 @@ startImmediately?: string | null;
9375
9555
  */
9376
9556
  export type SubscriptionChangeSubscriptionBody = Subscription | null;
9377
9557
 
9558
+ export type PlanGetAllPlansParams = {
9559
+ /**
9560
+ * Maximum number of records per page.
9561
+ */
9562
+ limit?: LimitParameter;
9563
+ /**
9564
+ * Zero-based page index.
9565
+ */
9566
+ offset?: OffsetParameter;
9567
+ };
9568
+
9569
+ export type PlanGetAllPlans200 = {
9570
+ metadata?: CollectionMetadata;
9571
+ items?: Plan[];
9572
+ };
9573
+
9378
9574
  /**
9379
9575
  * @nullable
9380
9576
  */
@@ -9385,6 +9581,22 @@ export type PlanAddPlanBody = Plan | null;
9385
9581
  */
9386
9582
  export type PlanUpdatePlanBody = Plan | null;
9387
9583
 
9584
+ export type PlanFamilyGetAllPlanFamiliesParams = {
9585
+ /**
9586
+ * Maximum number of records per page.
9587
+ */
9588
+ limit?: LimitParameter;
9589
+ /**
9590
+ * Zero-based page index.
9591
+ */
9592
+ offset?: OffsetParameter;
9593
+ };
9594
+
9595
+ export type PlanFamilyGetAllPlanFamilies200 = {
9596
+ metadata?: CollectionMetadata;
9597
+ items?: PlanFamily[];
9598
+ };
9599
+
9388
9600
  /**
9389
9601
  * @nullable
9390
9602
  */
@@ -9414,6 +9626,11 @@ EntityType?: string | null;
9414
9626
  EntityUid?: string | null;
9415
9627
  };
9416
9628
 
9629
+ export type ActivityGetAll200 = {
9630
+ metadata?: CollectionMetadata;
9631
+ items?: Activity[];
9632
+ };
9633
+
9417
9634
  /**
9418
9635
  * @nullable
9419
9636
  */
@@ -16,13 +16,16 @@ import type {
16
16
  import type {
17
17
  Article,
18
18
  ArticleAddArticleBody,
19
+ ArticleGetAllArticles200,
19
20
  ArticleGetAllArticlesParams,
20
21
  Case,
21
22
  CaseAddCaseBody,
22
23
  CaseAddCaseParams,
24
+ CaseGetAllCases200,
23
25
  CaseGetAllCasesParams,
24
26
  CaseHistory,
25
- Category
27
+ CategoryGetAllCategories200,
28
+ CategoryGetAllCategoriesParams
26
29
  } from '../outsetaAPI.schemas';
27
30
 
28
31
  import { customFetch } from '../../mutator';
@@ -71,7 +74,7 @@ export const caseGetAllCases = (
71
74
  ) => {
72
75
 
73
76
 
74
- return customFetch<Case[]>(
77
+ return customFetch<CaseGetAllCases200>(
75
78
  {url: `/api/v1/support/cases`, method: 'GET',
76
79
  params, signal
77
80
  },
@@ -400,7 +403,7 @@ export const articleGetAllArticles = (
400
403
  ) => {
401
404
 
402
405
 
403
- return customFetch<Article[]>(
406
+ return customFetch<ArticleGetAllArticles200>(
404
407
  {url: `/api/v1/support/articles`, method: 'GET',
405
408
  params, signal
406
409
  },
@@ -596,13 +599,14 @@ export function useArticleGetArticle<TData = Awaited<ReturnType<typeof articleGe
596
599
  * @summary Retrieve all knowledge base categories.
597
600
  */
598
601
  export const categoryGetAllCategories = (
599
-
602
+ params?: CategoryGetAllCategoriesParams,
600
603
  options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
601
604
  ) => {
602
605
 
603
606
 
604
- return customFetch<Category[]>(
605
- {url: `/api/v1/support/categories`, method: 'GET', signal
607
+ return customFetch<CategoryGetAllCategories200>(
608
+ {url: `/api/v1/support/categories`, method: 'GET',
609
+ params, signal
606
610
  },
607
611
  options);
608
612
  }
@@ -610,23 +614,23 @@ export const categoryGetAllCategories = (
610
614
 
611
615
 
612
616
 
613
- export const getCategoryGetAllCategoriesQueryKey = () => {
617
+ export const getCategoryGetAllCategoriesQueryKey = (params?: CategoryGetAllCategoriesParams,) => {
614
618
  return [
615
- `/api/v1/support/categories`
619
+ `/api/v1/support/categories`, ...(params ? [params]: [])
616
620
  ] as const;
617
621
  }
618
622
 
619
623
 
620
- export const getCategoryGetAllCategoriesQueryOptions = <TData = Awaited<ReturnType<typeof categoryGetAllCategories>>, TError = unknown>( options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof categoryGetAllCategories>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
624
+ export const getCategoryGetAllCategoriesQueryOptions = <TData = Awaited<ReturnType<typeof categoryGetAllCategories>>, TError = unknown>(params?: CategoryGetAllCategoriesParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof categoryGetAllCategories>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
621
625
  ) => {
622
626
 
623
627
  const {query: queryOptions, request: requestOptions} = options ?? {};
624
628
 
625
- const queryKey = queryOptions?.queryKey ?? getCategoryGetAllCategoriesQueryKey();
629
+ const queryKey = queryOptions?.queryKey ?? getCategoryGetAllCategoriesQueryKey(params);
626
630
 
627
631
 
628
632
 
629
- const queryFn: QueryFunction<Awaited<ReturnType<typeof categoryGetAllCategories>>> = ({ signal }) => categoryGetAllCategories(requestOptions, signal);
633
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof categoryGetAllCategories>>> = ({ signal }) => categoryGetAllCategories(params, requestOptions, signal);
630
634
 
631
635
 
632
636
 
@@ -644,11 +648,11 @@ export type CategoryGetAllCategoriesQueryError = unknown
644
648
  */
645
649
 
646
650
  export function useCategoryGetAllCategories<TData = Awaited<ReturnType<typeof categoryGetAllCategories>>, TError = unknown>(
647
- options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof categoryGetAllCategories>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
651
+ params?: CategoryGetAllCategoriesParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof categoryGetAllCategories>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
648
652
 
649
653
  ): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
650
654
 
651
- const queryOptions = getCategoryGetAllCategoriesQueryOptions(options)
655
+ const queryOptions = getCategoryGetAllCategoriesQueryOptions(params,options)
652
656
 
653
657
  const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
654
658