@outseta/api-client 0.3.25 → 0.3.27

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.
Files changed (23) hide show
  1. package/package.json +1 -1
  2. package/src/generated/models/accountGetAllAccountsParams.ts +10 -0
  3. package/src/generated/models/activityGetAllParams.ts +10 -0
  4. package/src/generated/models/articleGetAllArticlesParams.ts +10 -0
  5. package/src/generated/models/campaignGetAllBroadcastEmailsParams.ts +2 -2
  6. package/src/generated/models/caseGetAllCasesParams.ts +10 -0
  7. package/src/generated/models/categoryGetAllCategoriesParams.ts +2 -2
  8. package/src/generated/models/dealGetAllDealsParams.ts +10 -0
  9. package/src/generated/models/definitionGetAllDefinitionsParams.ts +2 -2
  10. package/src/generated/models/discountCouponGetAllDiscountCouponsParams.ts +10 -0
  11. package/src/generated/models/discountCouponGetDiscountCouponRedemptionsParams.ts +10 -0
  12. package/src/generated/models/dripCampaignGetAllDripCampaignsParams.ts +2 -2
  13. package/src/generated/models/emailListGetAllSubscriptionsParams.ts +10 -0
  14. package/src/generated/models/invoiceGetAllInvoicesParams.ts +2 -2
  15. package/src/generated/models/limitParameter.ts +1 -1
  16. package/src/generated/models/offsetParameter.ts +1 -1
  17. package/src/generated/models/personGetAllPeopleParams.ts +10 -0
  18. package/src/generated/models/planFamilyGetAllPlanFamiliesParams.ts +2 -2
  19. package/src/generated/models/planGetAllPlansParams.ts +2 -2
  20. package/src/generated/models/stripePriceAllOf.ts +11 -0
  21. package/src/generated/models/subscriptionAddOnGetAllSubscriptionsAddOnsParams.ts +10 -0
  22. package/src/generated/models/subscriptionGetAllSubscriptionsParams.ts +10 -0
  23. package/src/generated/models/transactionsGetAllTransactionsByAccountIdParams.ts +2 -2
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@outseta/api-client",
3
- "version": "0.3.25",
3
+ "version": "0.3.27",
4
4
  "description": "Generated API client for the Outseta REST API",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -1,4 +1,6 @@
1
1
  // @ts-nocheck
2
+ import type { LimitParameter } from './limitParameter';
3
+ import type { OffsetParameter } from './offsetParameter';
2
4
 
3
5
  export type AccountGetAllAccountsParams = {
4
6
  /**
@@ -11,4 +13,12 @@ segmentUid?: string | null;
11
13
  * @nullable
12
14
  */
13
15
  q?: string | null;
16
+ /**
17
+ * 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.
18
+ */
19
+ limit?: LimitParameter;
20
+ /**
21
+ * 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).
22
+ */
23
+ offset?: OffsetParameter;
14
24
  };
@@ -1,5 +1,7 @@
1
1
  // @ts-nocheck
2
2
  import type { ActivityCriteria } from './activityCriteria';
3
+ import type { LimitParameter } from './limitParameter';
4
+ import type { OffsetParameter } from './offsetParameter';
3
5
 
4
6
  export type ActivityGetAllParams = {
5
7
  /**
@@ -18,4 +20,12 @@ EntityType?: string | null;
18
20
  * @nullable
19
21
  */
20
22
  EntityUid?: string | null;
23
+ /**
24
+ * 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.
25
+ */
26
+ limit?: LimitParameter;
27
+ /**
28
+ * 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).
29
+ */
30
+ offset?: OffsetParameter;
21
31
  };
@@ -1,4 +1,6 @@
1
1
  // @ts-nocheck
2
+ import type { LimitParameter } from './limitParameter';
3
+ import type { OffsetParameter } from './offsetParameter';
2
4
 
3
5
  export type ArticleGetAllArticlesParams = {
4
6
  /**
@@ -6,4 +8,12 @@ export type ArticleGetAllArticlesParams = {
6
8
  * @nullable
7
9
  */
8
10
  q?: string | null;
11
+ /**
12
+ * 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.
13
+ */
14
+ limit?: LimitParameter;
15
+ /**
16
+ * 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).
17
+ */
18
+ offset?: OffsetParameter;
9
19
  };
@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
4
4
 
5
5
  export type CampaignGetAllBroadcastEmailsParams = {
6
6
  /**
7
- * Maximum number of records per page.
7
+ * 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.
8
8
  */
9
9
  limit?: LimitParameter;
10
10
  /**
11
- * Zero-based page index.
11
+ * 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).
12
12
  */
13
13
  offset?: OffsetParameter;
14
14
  };
@@ -1,4 +1,6 @@
1
1
  // @ts-nocheck
2
+ import type { LimitParameter } from './limitParameter';
3
+ import type { OffsetParameter } from './offsetParameter';
2
4
 
3
5
  export type CaseGetAllCasesParams = {
4
6
  /**
@@ -11,4 +13,12 @@ q?: string | null;
11
13
  * @nullable
12
14
  */
13
15
  tagUid?: string | null;
16
+ /**
17
+ * 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.
18
+ */
19
+ limit?: LimitParameter;
20
+ /**
21
+ * 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).
22
+ */
23
+ offset?: OffsetParameter;
14
24
  };
@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
4
4
 
5
5
  export type CategoryGetAllCategoriesParams = {
6
6
  /**
7
- * Maximum number of records per page.
7
+ * 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.
8
8
  */
9
9
  limit?: LimitParameter;
10
10
  /**
11
- * Zero-based page index.
11
+ * 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).
12
12
  */
13
13
  offset?: OffsetParameter;
14
14
  };
@@ -1,4 +1,6 @@
1
1
  // @ts-nocheck
2
+ import type { LimitParameter } from './limitParameter';
3
+ import type { OffsetParameter } from './offsetParameter';
2
4
 
3
5
  export type DealGetAllDealsParams = {
4
6
  /**
@@ -11,4 +13,12 @@ ownerUid?: string | null;
11
13
  * @nullable
12
14
  */
13
15
  q?: string | null;
16
+ /**
17
+ * 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.
18
+ */
19
+ limit?: LimitParameter;
20
+ /**
21
+ * 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).
22
+ */
23
+ offset?: OffsetParameter;
14
24
  };
@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
4
4
 
5
5
  export type DefinitionGetAllDefinitionsParams = {
6
6
  /**
7
- * Maximum number of records per page.
7
+ * 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.
8
8
  */
9
9
  limit?: LimitParameter;
10
10
  /**
11
- * Zero-based page index.
11
+ * 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).
12
12
  */
13
13
  offset?: OffsetParameter;
14
14
  };
@@ -1,4 +1,6 @@
1
1
  // @ts-nocheck
2
+ import type { LimitParameter } from './limitParameter';
3
+ import type { OffsetParameter } from './offsetParameter';
2
4
 
3
5
  export type DiscountCouponGetAllDiscountCouponsParams = {
4
6
  /**
@@ -15,4 +17,12 @@ q?: string | null;
15
17
  * @nullable
16
18
  */
17
19
  planUid?: string | null;
20
+ /**
21
+ * 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.
22
+ */
23
+ limit?: LimitParameter;
24
+ /**
25
+ * 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).
26
+ */
27
+ offset?: OffsetParameter;
18
28
  };
@@ -1,4 +1,6 @@
1
1
  // @ts-nocheck
2
+ import type { LimitParameter } from './limitParameter';
3
+ import type { OffsetParameter } from './offsetParameter';
2
4
 
3
5
  export type DiscountCouponGetDiscountCouponRedemptionsParams = {
4
6
  /**
@@ -11,4 +13,12 @@ q?: string | null;
11
13
  * @nullable
12
14
  */
13
15
  isActive?: boolean | null;
16
+ /**
17
+ * 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.
18
+ */
19
+ limit?: LimitParameter;
20
+ /**
21
+ * 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).
22
+ */
23
+ offset?: OffsetParameter;
14
24
  };
@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
4
4
 
5
5
  export type DripCampaignGetAllDripCampaignsParams = {
6
6
  /**
7
- * Maximum number of records per page.
7
+ * 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.
8
8
  */
9
9
  limit?: LimitParameter;
10
10
  /**
11
- * Zero-based page index.
11
+ * 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).
12
12
  */
13
13
  offset?: OffsetParameter;
14
14
  };
@@ -1,4 +1,6 @@
1
1
  // @ts-nocheck
2
+ import type { LimitParameter } from './limitParameter';
3
+ import type { OffsetParameter } from './offsetParameter';
2
4
 
3
5
  export type EmailListGetAllSubscriptionsParams = {
4
6
  /**
@@ -6,4 +8,12 @@ export type EmailListGetAllSubscriptionsParams = {
6
8
  * @nullable
7
9
  */
8
10
  q?: string | null;
11
+ /**
12
+ * 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.
13
+ */
14
+ limit?: LimitParameter;
15
+ /**
16
+ * 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).
17
+ */
18
+ offset?: OffsetParameter;
9
19
  };
@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
4
4
 
5
5
  export type InvoiceGetAllInvoicesParams = {
6
6
  /**
7
- * Maximum number of records per page.
7
+ * 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.
8
8
  */
9
9
  limit?: LimitParameter;
10
10
  /**
11
- * Zero-based page index.
11
+ * 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).
12
12
  */
13
13
  offset?: OffsetParameter;
14
14
  /**
@@ -1,6 +1,6 @@
1
1
  // @ts-nocheck
2
2
 
3
3
  /**
4
- * Maximum number of records per page.
4
+ * 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.
5
5
  */
6
6
  export type LimitParameter = number;
@@ -1,6 +1,6 @@
1
1
  // @ts-nocheck
2
2
 
3
3
  /**
4
- * Zero-based page index.
4
+ * 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).
5
5
  */
6
6
  export type OffsetParameter = number;
@@ -1,4 +1,6 @@
1
1
  // @ts-nocheck
2
+ import type { LimitParameter } from './limitParameter';
3
+ import type { OffsetParameter } from './offsetParameter';
2
4
 
3
5
  export type PersonGetAllPeopleParams = {
4
6
  /**
@@ -6,4 +8,12 @@ export type PersonGetAllPeopleParams = {
6
8
  * @nullable
7
9
  */
8
10
  q?: string | null;
11
+ /**
12
+ * 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.
13
+ */
14
+ limit?: LimitParameter;
15
+ /**
16
+ * 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).
17
+ */
18
+ offset?: OffsetParameter;
9
19
  };
@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
4
4
 
5
5
  export type PlanFamilyGetAllPlanFamiliesParams = {
6
6
  /**
7
- * Maximum number of records per page.
7
+ * 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.
8
8
  */
9
9
  limit?: LimitParameter;
10
10
  /**
11
- * Zero-based page index.
11
+ * 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).
12
12
  */
13
13
  offset?: OffsetParameter;
14
14
  };
@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
4
4
 
5
5
  export type PlanGetAllPlansParams = {
6
6
  /**
7
- * Maximum number of records per page.
7
+ * 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.
8
8
  */
9
9
  limit?: LimitParameter;
10
10
  /**
11
- * Zero-based page index.
11
+ * 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).
12
12
  */
13
13
  offset?: OffsetParameter;
14
14
  };
@@ -13,6 +13,12 @@ export type StripePriceAllOf = {
13
13
  * @nullable
14
14
  */
15
15
  Currency?: string | null;
16
+ /** @nullable */
17
+ CustomUnitAmount_Maximum?: number | null;
18
+ /** @nullable */
19
+ CustomUnitAmount_Minimum?: number | null;
20
+ /** @nullable */
21
+ CustomUnitAmount_Preset?: number | null;
16
22
  IsActive?: boolean;
17
23
  /**
18
24
  * @maxLength 250
@@ -40,6 +46,11 @@ export type StripePriceAllOf = {
40
46
  * @nullable
41
47
  */
42
48
  TaxBehavior?: string | null;
49
+ /**
50
+ * @maxLength 36
51
+ * @nullable
52
+ */
53
+ TiersMode?: string | null;
43
54
  /** @nullable */
44
55
  TransformQuantity_DivideBy?: number | null;
45
56
  /**
@@ -1,4 +1,6 @@
1
1
  // @ts-nocheck
2
+ import type { LimitParameter } from './limitParameter';
3
+ import type { OffsetParameter } from './offsetParameter';
2
4
 
3
5
  export type SubscriptionAddOnGetAllSubscriptionsAddOnsParams = {
4
6
  /**
@@ -6,4 +8,12 @@ export type SubscriptionAddOnGetAllSubscriptionsAddOnsParams = {
6
8
  * @nullable
7
9
  */
8
10
  status?: string | null;
11
+ /**
12
+ * 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.
13
+ */
14
+ limit?: LimitParameter;
15
+ /**
16
+ * 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).
17
+ */
18
+ offset?: OffsetParameter;
9
19
  };
@@ -1,4 +1,6 @@
1
1
  // @ts-nocheck
2
+ import type { LimitParameter } from './limitParameter';
3
+ import type { OffsetParameter } from './offsetParameter';
2
4
 
3
5
  export type SubscriptionGetAllSubscriptionsParams = {
4
6
  /**
@@ -11,4 +13,12 @@ current?: string | null;
11
13
  * @nullable
12
14
  */
13
15
  status?: string | null;
16
+ /**
17
+ * 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.
18
+ */
19
+ limit?: LimitParameter;
20
+ /**
21
+ * 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).
22
+ */
23
+ offset?: OffsetParameter;
14
24
  };
@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
4
4
 
5
5
  export type TransactionsGetAllTransactionsByAccountIdParams = {
6
6
  /**
7
- * Maximum number of records per page.
7
+ * 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.
8
8
  */
9
9
  limit?: LimitParameter;
10
10
  /**
11
- * Zero-based page index.
11
+ * 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).
12
12
  */
13
13
  offset?: OffsetParameter;
14
14
  };