@outseta/react 0.4.19 → 0.4.21

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.19",
3
+ "version": "0.4.21",
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.25"
21
+ "@outseta/api-client": "0.3.27"
22
22
  },
23
23
  "peerDependencies": {
24
24
  "react": "^18.0.0 || ^19.0.0"
@@ -1248,6 +1248,12 @@ export type StripePriceAllOf = {
1248
1248
  * @nullable
1249
1249
  */
1250
1250
  Currency?: string | null;
1251
+ /** @nullable */
1252
+ CustomUnitAmount_Maximum?: number | null;
1253
+ /** @nullable */
1254
+ CustomUnitAmount_Minimum?: number | null;
1255
+ /** @nullable */
1256
+ CustomUnitAmount_Preset?: number | null;
1251
1257
  IsActive?: boolean;
1252
1258
  /**
1253
1259
  * @maxLength 250
@@ -1275,6 +1281,11 @@ export type StripePriceAllOf = {
1275
1281
  * @nullable
1276
1282
  */
1277
1283
  TaxBehavior?: string | null;
1284
+ /**
1285
+ * @maxLength 36
1286
+ * @nullable
1287
+ */
1288
+ TiersMode?: string | null;
1278
1289
  /** @nullable */
1279
1290
  TransformQuantity_DivideBy?: number | null;
1280
1291
  /**
@@ -8992,22 +9003,22 @@ export type DiscordUserRemovedFromServerWebhookPayloadAllOf = {
8992
9003
  export type DiscordUserRemovedFromServerWebhookPayload = PersonWebhookEntity & DiscordUserRemovedFromServerWebhookPayloadAllOf;
8993
9004
 
8994
9005
  /**
8995
- * Maximum number of records per page.
9006
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
8996
9007
  */
8997
9008
  export type LimitParameter = number;
8998
9009
 
8999
9010
  /**
9000
- * Zero-based page index.
9011
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9001
9012
  */
9002
9013
  export type OffsetParameter = number;
9003
9014
 
9004
9015
  export type DefinitionGetAllDefinitionsParams = {
9005
9016
  /**
9006
- * Maximum number of records per page.
9017
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9007
9018
  */
9008
9019
  limit?: LimitParameter;
9009
9020
  /**
9010
- * Zero-based page index.
9021
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9011
9022
  */
9012
9023
  offset?: OffsetParameter;
9013
9024
  };
@@ -9089,6 +9100,14 @@ q?: string | null;
9089
9100
  * @nullable
9090
9101
  */
9091
9102
  tagUid?: string | null;
9103
+ /**
9104
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9105
+ */
9106
+ limit?: LimitParameter;
9107
+ /**
9108
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9109
+ */
9110
+ offset?: OffsetParameter;
9092
9111
  };
9093
9112
 
9094
9113
  export type CaseGetAllCases200 = {
@@ -9115,6 +9134,14 @@ export type ArticleGetAllArticlesParams = {
9115
9134
  * @nullable
9116
9135
  */
9117
9136
  q?: string | null;
9137
+ /**
9138
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9139
+ */
9140
+ limit?: LimitParameter;
9141
+ /**
9142
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9143
+ */
9144
+ offset?: OffsetParameter;
9118
9145
  };
9119
9146
 
9120
9147
  export type ArticleGetAllArticles200 = {
@@ -9129,11 +9156,11 @@ export type ArticleAddArticleBody = Article | null;
9129
9156
 
9130
9157
  export type CategoryGetAllCategoriesParams = {
9131
9158
  /**
9132
- * Maximum number of records per page.
9159
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9133
9160
  */
9134
9161
  limit?: LimitParameter;
9135
9162
  /**
9136
- * Zero-based page index.
9163
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9137
9164
  */
9138
9165
  offset?: OffsetParameter;
9139
9166
  };
@@ -9145,11 +9172,11 @@ export type CategoryGetAllCategories200 = {
9145
9172
 
9146
9173
  export type DripCampaignGetAllDripCampaignsParams = {
9147
9174
  /**
9148
- * Maximum number of records per page.
9175
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9149
9176
  */
9150
9177
  limit?: LimitParameter;
9151
9178
  /**
9152
- * Zero-based page index.
9179
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9153
9180
  */
9154
9181
  offset?: OffsetParameter;
9155
9182
  };
@@ -9186,11 +9213,11 @@ export type DripCampaignSendTestCampaignEmailBody = SendTestEmailRequest | null;
9186
9213
 
9187
9214
  export type CampaignGetAllBroadcastEmailsParams = {
9188
9215
  /**
9189
- * Maximum number of records per page.
9216
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9190
9217
  */
9191
9218
  limit?: LimitParameter;
9192
9219
  /**
9193
- * Zero-based page index.
9220
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9194
9221
  */
9195
9222
  offset?: OffsetParameter;
9196
9223
  };
@@ -9221,6 +9248,14 @@ export type EmailListGetAllSubscriptionsParams = {
9221
9248
  * @nullable
9222
9249
  */
9223
9250
  q?: string | null;
9251
+ /**
9252
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9253
+ */
9254
+ limit?: LimitParameter;
9255
+ /**
9256
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9257
+ */
9258
+ offset?: OffsetParameter;
9224
9259
  };
9225
9260
 
9226
9261
  export type EmailListGetAllSubscriptions200 = {
@@ -9244,6 +9279,14 @@ ownerUid?: string | null;
9244
9279
  * @nullable
9245
9280
  */
9246
9281
  q?: string | null;
9282
+ /**
9283
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9284
+ */
9285
+ limit?: LimitParameter;
9286
+ /**
9287
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9288
+ */
9289
+ offset?: OffsetParameter;
9247
9290
  };
9248
9291
 
9249
9292
  export type DealGetAllDeals200 = {
@@ -9272,6 +9315,14 @@ segmentUid?: string | null;
9272
9315
  * @nullable
9273
9316
  */
9274
9317
  q?: string | null;
9318
+ /**
9319
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9320
+ */
9321
+ limit?: LimitParameter;
9322
+ /**
9323
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9324
+ */
9325
+ offset?: OffsetParameter;
9275
9326
  };
9276
9327
 
9277
9328
  export type AccountGetAllAccounts200 = {
@@ -9319,6 +9370,14 @@ export type PersonGetAllPeopleParams = {
9319
9370
  * @nullable
9320
9371
  */
9321
9372
  q?: string | null;
9373
+ /**
9374
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9375
+ */
9376
+ limit?: LimitParameter;
9377
+ /**
9378
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9379
+ */
9380
+ offset?: OffsetParameter;
9322
9381
  };
9323
9382
 
9324
9383
  export type PersonGetAllPeople200 = {
@@ -9369,6 +9428,14 @@ q?: string | null;
9369
9428
  * @nullable
9370
9429
  */
9371
9430
  planUid?: string | null;
9431
+ /**
9432
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9433
+ */
9434
+ limit?: LimitParameter;
9435
+ /**
9436
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9437
+ */
9438
+ offset?: OffsetParameter;
9372
9439
  };
9373
9440
 
9374
9441
  export type DiscountCouponGetAllDiscountCoupons200 = {
@@ -9397,6 +9464,14 @@ q?: string | null;
9397
9464
  * @nullable
9398
9465
  */
9399
9466
  isActive?: boolean | null;
9467
+ /**
9468
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9469
+ */
9470
+ limit?: LimitParameter;
9471
+ /**
9472
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9473
+ */
9474
+ offset?: OffsetParameter;
9400
9475
  };
9401
9476
 
9402
9477
  export type DiscountCouponGetDiscountCouponRedemptions200 = {
@@ -9411,11 +9486,11 @@ export type UsageAddUsageBody = Usage | null;
9411
9486
 
9412
9487
  export type TransactionsGetAllTransactionsByAccountIdParams = {
9413
9488
  /**
9414
- * Maximum number of records per page.
9489
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9415
9490
  */
9416
9491
  limit?: LimitParameter;
9417
9492
  /**
9418
- * Zero-based page index.
9493
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9419
9494
  */
9420
9495
  offset?: OffsetParameter;
9421
9496
  };
@@ -9441,6 +9516,14 @@ export type SubscriptionAddOnGetAllSubscriptionsAddOnsParams = {
9441
9516
  * @nullable
9442
9517
  */
9443
9518
  status?: string | null;
9519
+ /**
9520
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9521
+ */
9522
+ limit?: LimitParameter;
9523
+ /**
9524
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9525
+ */
9526
+ offset?: OffsetParameter;
9444
9527
  };
9445
9528
 
9446
9529
  export type SubscriptionAddOnGetAllSubscriptionsAddOns200 = {
@@ -9465,11 +9548,11 @@ export type SubscriptionAddOnSetAddOnUpgradeRequiredBody = SubscriptionAddOn | n
9465
9548
 
9466
9549
  export type InvoiceGetAllInvoicesParams = {
9467
9550
  /**
9468
- * Maximum number of records per page.
9551
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9469
9552
  */
9470
9553
  limit?: LimitParameter;
9471
9554
  /**
9472
- * Zero-based page index.
9555
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9473
9556
  */
9474
9557
  offset?: OffsetParameter;
9475
9558
  /**
@@ -9504,6 +9587,14 @@ current?: string | null;
9504
9587
  * @nullable
9505
9588
  */
9506
9589
  status?: string | null;
9590
+ /**
9591
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9592
+ */
9593
+ limit?: LimitParameter;
9594
+ /**
9595
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9596
+ */
9597
+ offset?: OffsetParameter;
9507
9598
  };
9508
9599
 
9509
9600
  export type SubscriptionGetAllSubscriptions200 = {
@@ -9562,11 +9653,11 @@ export type SubscriptionChangeSubscriptionBody = Subscription | null;
9562
9653
 
9563
9654
  export type PlanGetAllPlansParams = {
9564
9655
  /**
9565
- * Maximum number of records per page.
9656
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9566
9657
  */
9567
9658
  limit?: LimitParameter;
9568
9659
  /**
9569
- * Zero-based page index.
9660
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9570
9661
  */
9571
9662
  offset?: OffsetParameter;
9572
9663
  };
@@ -9588,11 +9679,11 @@ export type PlanUpdatePlanBody = Plan | null;
9588
9679
 
9589
9680
  export type PlanFamilyGetAllPlanFamiliesParams = {
9590
9681
  /**
9591
- * Maximum number of records per page.
9682
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9592
9683
  */
9593
9684
  limit?: LimitParameter;
9594
9685
  /**
9595
- * Zero-based page index.
9686
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9596
9687
  */
9597
9688
  offset?: OffsetParameter;
9598
9689
  };
@@ -9629,6 +9720,14 @@ EntityType?: string | null;
9629
9720
  * @nullable
9630
9721
  */
9631
9722
  EntityUid?: string | null;
9723
+ /**
9724
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
9725
+ */
9726
+ limit?: LimitParameter;
9727
+ /**
9728
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
9729
+ */
9730
+ offset?: OffsetParameter;
9632
9731
  };
9633
9732
 
9634
9733
  export type ActivityGetAll200 = {