@metronome/sdk 0.1.0 → 0.2.0
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/CHANGELOG.md +15 -0
- package/package.json +1 -5
- package/resources/shared.d.ts +48 -0
- package/resources/shared.d.ts.map +1 -1
- package/resources/v1/alerts.d.ts +4 -8
- package/resources/v1/alerts.d.ts.map +1 -1
- package/resources/v1/contracts/contracts.d.ts +62 -4
- package/resources/v1/contracts/contracts.d.ts.map +1 -1
- package/resources/v1/contracts/contracts.js.map +1 -1
- package/resources/v1/contracts/contracts.mjs.map +1 -1
- package/resources/v1/customers/alerts.d.ts +9 -0
- package/resources/v1/customers/alerts.d.ts.map +1 -1
- package/resources/v1/dashboards.d.ts +1 -1
- package/resources/v1/dashboards.d.ts.map +1 -1
- package/resources/v2/contracts.d.ts +344 -24
- package/resources/v2/contracts.d.ts.map +1 -1
- package/src/resources/shared.ts +66 -0
- package/src/resources/v1/alerts.ts +4 -8
- package/src/resources/v1/contracts/contracts.ts +73 -4
- package/src/resources/v1/customers/alerts.ts +12 -0
- package/src/resources/v1/dashboards.ts +3 -1
- package/src/resources/v2/contracts.ts +439 -24
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -452,6 +452,8 @@ export namespace ContractRetrieveResponse {
|
|
|
452
452
|
timestamp: string;
|
|
453
453
|
|
|
454
454
|
type: 'PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
|
|
455
|
+
|
|
456
|
+
contract_id?: string;
|
|
455
457
|
}
|
|
456
458
|
|
|
457
459
|
export interface PrepaidCommitRolloverLedgerEntry {
|
|
@@ -486,6 +488,8 @@ export namespace ContractRetrieveResponse {
|
|
|
486
488
|
timestamp: string;
|
|
487
489
|
|
|
488
490
|
type: 'PREPAID_COMMIT_CANCELED';
|
|
491
|
+
|
|
492
|
+
contract_id?: string;
|
|
489
493
|
}
|
|
490
494
|
|
|
491
495
|
export interface PrepaidCommitCreditedLedgerEntry {
|
|
@@ -498,6 +502,8 @@ export namespace ContractRetrieveResponse {
|
|
|
498
502
|
timestamp: string;
|
|
499
503
|
|
|
500
504
|
type: 'PREPAID_COMMIT_CREDITED';
|
|
505
|
+
|
|
506
|
+
contract_id?: string;
|
|
501
507
|
}
|
|
502
508
|
|
|
503
509
|
export interface PrepaidCommitSeatBasedAdjustmentLedgerEntry {
|
|
@@ -528,6 +534,8 @@ export namespace ContractRetrieveResponse {
|
|
|
528
534
|
timestamp: string;
|
|
529
535
|
|
|
530
536
|
type: 'POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
|
|
537
|
+
|
|
538
|
+
contract_id?: string;
|
|
531
539
|
}
|
|
532
540
|
|
|
533
541
|
export interface PostpaidCommitRolloverLedgerEntry {
|
|
@@ -550,6 +558,8 @@ export namespace ContractRetrieveResponse {
|
|
|
550
558
|
timestamp: string;
|
|
551
559
|
|
|
552
560
|
type: 'POSTPAID_COMMIT_TRUEUP';
|
|
561
|
+
|
|
562
|
+
contract_id?: string;
|
|
553
563
|
}
|
|
554
564
|
|
|
555
565
|
export interface PrepaidCommitManualLedgerEntry {
|
|
@@ -873,6 +883,8 @@ export namespace ContractRetrieveResponse {
|
|
|
873
883
|
timestamp: string;
|
|
874
884
|
|
|
875
885
|
type: 'CREDIT_AUTOMATED_INVOICE_DEDUCTION';
|
|
886
|
+
|
|
887
|
+
contract_id?: string;
|
|
876
888
|
}
|
|
877
889
|
|
|
878
890
|
export interface CreditExpirationLedgerEntry {
|
|
@@ -895,6 +907,8 @@ export namespace ContractRetrieveResponse {
|
|
|
895
907
|
timestamp: string;
|
|
896
908
|
|
|
897
909
|
type: 'CREDIT_CANCELED';
|
|
910
|
+
|
|
911
|
+
contract_id?: string;
|
|
898
912
|
}
|
|
899
913
|
|
|
900
914
|
export interface CreditCreditedLedgerEntry {
|
|
@@ -907,6 +921,8 @@ export namespace ContractRetrieveResponse {
|
|
|
907
921
|
timestamp: string;
|
|
908
922
|
|
|
909
923
|
type: 'CREDIT_CREDITED';
|
|
924
|
+
|
|
925
|
+
contract_id?: string;
|
|
910
926
|
}
|
|
911
927
|
|
|
912
928
|
export interface CreditManualLedgerEntry {
|
|
@@ -951,6 +967,11 @@ export namespace ContractRetrieveResponse {
|
|
|
951
967
|
* This field's availability is dependent on your client's configuration.
|
|
952
968
|
*/
|
|
953
969
|
export interface CustomerBillingProviderConfiguration {
|
|
970
|
+
/**
|
|
971
|
+
* ID of Customer's billing provider configuration.
|
|
972
|
+
*/
|
|
973
|
+
id: string;
|
|
974
|
+
|
|
954
975
|
billing_provider:
|
|
955
976
|
| 'aws_marketplace'
|
|
956
977
|
| 'stripe'
|
|
@@ -1082,6 +1103,8 @@ export namespace ContractRetrieveResponse {
|
|
|
1082
1103
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
1083
1104
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
1084
1105
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
1106
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
1107
|
+
* body of `specifiers`.
|
|
1085
1108
|
*/
|
|
1086
1109
|
specifiers?: Array<Commit.Specifier>;
|
|
1087
1110
|
}
|
|
@@ -1221,7 +1244,7 @@ export namespace ContractRetrieveResponse {
|
|
|
1221
1244
|
ending_before?: string;
|
|
1222
1245
|
|
|
1223
1246
|
/**
|
|
1224
|
-
* Optional configuration for recurring
|
|
1247
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
1225
1248
|
*/
|
|
1226
1249
|
hierarchy_configuration?: RecurringCommit.HierarchyConfiguration;
|
|
1227
1250
|
|
|
@@ -1268,6 +1291,11 @@ export namespace ContractRetrieveResponse {
|
|
|
1268
1291
|
* specifiers to contribute to a commit's or credit's drawdown.
|
|
1269
1292
|
*/
|
|
1270
1293
|
specifiers?: Array<RecurringCommit.Specifier>;
|
|
1294
|
+
|
|
1295
|
+
/**
|
|
1296
|
+
* Attach a subscription to the recurring commit/credit.
|
|
1297
|
+
*/
|
|
1298
|
+
subscription_config?: RecurringCommit.SubscriptionConfig;
|
|
1271
1299
|
}
|
|
1272
1300
|
|
|
1273
1301
|
export namespace RecurringCommit {
|
|
@@ -1302,7 +1330,7 @@ export namespace ContractRetrieveResponse {
|
|
|
1302
1330
|
}
|
|
1303
1331
|
|
|
1304
1332
|
/**
|
|
1305
|
-
* Optional configuration for recurring
|
|
1333
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
1306
1334
|
*/
|
|
1307
1335
|
export interface HierarchyConfiguration {
|
|
1308
1336
|
child_access:
|
|
@@ -1354,6 +1382,26 @@ export namespace ContractRetrieveResponse {
|
|
|
1354
1382
|
*/
|
|
1355
1383
|
product_tags?: Array<string>;
|
|
1356
1384
|
}
|
|
1385
|
+
|
|
1386
|
+
/**
|
|
1387
|
+
* Attach a subscription to the recurring commit/credit.
|
|
1388
|
+
*/
|
|
1389
|
+
export interface SubscriptionConfig {
|
|
1390
|
+
allocation: 'INDIVIDUAL' | 'POOLED';
|
|
1391
|
+
|
|
1392
|
+
apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
|
|
1393
|
+
|
|
1394
|
+
subscription_id: string;
|
|
1395
|
+
}
|
|
1396
|
+
|
|
1397
|
+
export namespace SubscriptionConfig {
|
|
1398
|
+
export interface ApplySeatIncreaseConfig {
|
|
1399
|
+
/**
|
|
1400
|
+
* Indicates whether a mid-period seat increase should be prorated.
|
|
1401
|
+
*/
|
|
1402
|
+
is_prorated: boolean;
|
|
1403
|
+
}
|
|
1404
|
+
}
|
|
1357
1405
|
}
|
|
1358
1406
|
|
|
1359
1407
|
export interface RecurringCredit {
|
|
@@ -1409,7 +1457,7 @@ export namespace ContractRetrieveResponse {
|
|
|
1409
1457
|
ending_before?: string;
|
|
1410
1458
|
|
|
1411
1459
|
/**
|
|
1412
|
-
* Optional configuration for recurring
|
|
1460
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
1413
1461
|
*/
|
|
1414
1462
|
hierarchy_configuration?: RecurringCredit.HierarchyConfiguration;
|
|
1415
1463
|
|
|
@@ -1451,6 +1499,11 @@ export namespace ContractRetrieveResponse {
|
|
|
1451
1499
|
* specifiers to contribute to a commit's or credit's drawdown.
|
|
1452
1500
|
*/
|
|
1453
1501
|
specifiers?: Array<RecurringCredit.Specifier>;
|
|
1502
|
+
|
|
1503
|
+
/**
|
|
1504
|
+
* Attach a subscription to the recurring commit/credit.
|
|
1505
|
+
*/
|
|
1506
|
+
subscription_config?: RecurringCredit.SubscriptionConfig;
|
|
1454
1507
|
}
|
|
1455
1508
|
|
|
1456
1509
|
export namespace RecurringCredit {
|
|
@@ -1485,7 +1538,7 @@ export namespace ContractRetrieveResponse {
|
|
|
1485
1538
|
}
|
|
1486
1539
|
|
|
1487
1540
|
/**
|
|
1488
|
-
* Optional configuration for recurring
|
|
1541
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
1489
1542
|
*/
|
|
1490
1543
|
export interface HierarchyConfiguration {
|
|
1491
1544
|
child_access:
|
|
@@ -1526,6 +1579,26 @@ export namespace ContractRetrieveResponse {
|
|
|
1526
1579
|
*/
|
|
1527
1580
|
product_tags?: Array<string>;
|
|
1528
1581
|
}
|
|
1582
|
+
|
|
1583
|
+
/**
|
|
1584
|
+
* Attach a subscription to the recurring commit/credit.
|
|
1585
|
+
*/
|
|
1586
|
+
export interface SubscriptionConfig {
|
|
1587
|
+
allocation: 'INDIVIDUAL' | 'POOLED';
|
|
1588
|
+
|
|
1589
|
+
apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
|
|
1590
|
+
|
|
1591
|
+
subscription_id: string;
|
|
1592
|
+
}
|
|
1593
|
+
|
|
1594
|
+
export namespace SubscriptionConfig {
|
|
1595
|
+
export interface ApplySeatIncreaseConfig {
|
|
1596
|
+
/**
|
|
1597
|
+
* Indicates whether a mid-period seat increase should be prorated.
|
|
1598
|
+
*/
|
|
1599
|
+
is_prorated: boolean;
|
|
1600
|
+
}
|
|
1601
|
+
}
|
|
1529
1602
|
}
|
|
1530
1603
|
|
|
1531
1604
|
export interface ResellerRoyalty {
|
|
@@ -2024,6 +2097,8 @@ export namespace ContractListResponse {
|
|
|
2024
2097
|
timestamp: string;
|
|
2025
2098
|
|
|
2026
2099
|
type: 'PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
|
|
2100
|
+
|
|
2101
|
+
contract_id?: string;
|
|
2027
2102
|
}
|
|
2028
2103
|
|
|
2029
2104
|
export interface PrepaidCommitRolloverLedgerEntry {
|
|
@@ -2058,6 +2133,8 @@ export namespace ContractListResponse {
|
|
|
2058
2133
|
timestamp: string;
|
|
2059
2134
|
|
|
2060
2135
|
type: 'PREPAID_COMMIT_CANCELED';
|
|
2136
|
+
|
|
2137
|
+
contract_id?: string;
|
|
2061
2138
|
}
|
|
2062
2139
|
|
|
2063
2140
|
export interface PrepaidCommitCreditedLedgerEntry {
|
|
@@ -2070,6 +2147,8 @@ export namespace ContractListResponse {
|
|
|
2070
2147
|
timestamp: string;
|
|
2071
2148
|
|
|
2072
2149
|
type: 'PREPAID_COMMIT_CREDITED';
|
|
2150
|
+
|
|
2151
|
+
contract_id?: string;
|
|
2073
2152
|
}
|
|
2074
2153
|
|
|
2075
2154
|
export interface PrepaidCommitSeatBasedAdjustmentLedgerEntry {
|
|
@@ -2100,6 +2179,8 @@ export namespace ContractListResponse {
|
|
|
2100
2179
|
timestamp: string;
|
|
2101
2180
|
|
|
2102
2181
|
type: 'POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
|
|
2182
|
+
|
|
2183
|
+
contract_id?: string;
|
|
2103
2184
|
}
|
|
2104
2185
|
|
|
2105
2186
|
export interface PostpaidCommitRolloverLedgerEntry {
|
|
@@ -2122,6 +2203,8 @@ export namespace ContractListResponse {
|
|
|
2122
2203
|
timestamp: string;
|
|
2123
2204
|
|
|
2124
2205
|
type: 'POSTPAID_COMMIT_TRUEUP';
|
|
2206
|
+
|
|
2207
|
+
contract_id?: string;
|
|
2125
2208
|
}
|
|
2126
2209
|
|
|
2127
2210
|
export interface PrepaidCommitManualLedgerEntry {
|
|
@@ -2445,6 +2528,8 @@ export namespace ContractListResponse {
|
|
|
2445
2528
|
timestamp: string;
|
|
2446
2529
|
|
|
2447
2530
|
type: 'CREDIT_AUTOMATED_INVOICE_DEDUCTION';
|
|
2531
|
+
|
|
2532
|
+
contract_id?: string;
|
|
2448
2533
|
}
|
|
2449
2534
|
|
|
2450
2535
|
export interface CreditExpirationLedgerEntry {
|
|
@@ -2467,6 +2552,8 @@ export namespace ContractListResponse {
|
|
|
2467
2552
|
timestamp: string;
|
|
2468
2553
|
|
|
2469
2554
|
type: 'CREDIT_CANCELED';
|
|
2555
|
+
|
|
2556
|
+
contract_id?: string;
|
|
2470
2557
|
}
|
|
2471
2558
|
|
|
2472
2559
|
export interface CreditCreditedLedgerEntry {
|
|
@@ -2479,6 +2566,8 @@ export namespace ContractListResponse {
|
|
|
2479
2566
|
timestamp: string;
|
|
2480
2567
|
|
|
2481
2568
|
type: 'CREDIT_CREDITED';
|
|
2569
|
+
|
|
2570
|
+
contract_id?: string;
|
|
2482
2571
|
}
|
|
2483
2572
|
|
|
2484
2573
|
export interface CreditManualLedgerEntry {
|
|
@@ -2523,6 +2612,11 @@ export namespace ContractListResponse {
|
|
|
2523
2612
|
* This field's availability is dependent on your client's configuration.
|
|
2524
2613
|
*/
|
|
2525
2614
|
export interface CustomerBillingProviderConfiguration {
|
|
2615
|
+
/**
|
|
2616
|
+
* ID of Customer's billing provider configuration.
|
|
2617
|
+
*/
|
|
2618
|
+
id: string;
|
|
2619
|
+
|
|
2526
2620
|
billing_provider:
|
|
2527
2621
|
| 'aws_marketplace'
|
|
2528
2622
|
| 'stripe'
|
|
@@ -2654,6 +2748,8 @@ export namespace ContractListResponse {
|
|
|
2654
2748
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
2655
2749
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
2656
2750
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
2751
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
2752
|
+
* body of `specifiers`.
|
|
2657
2753
|
*/
|
|
2658
2754
|
specifiers?: Array<Commit.Specifier>;
|
|
2659
2755
|
}
|
|
@@ -2793,7 +2889,7 @@ export namespace ContractListResponse {
|
|
|
2793
2889
|
ending_before?: string;
|
|
2794
2890
|
|
|
2795
2891
|
/**
|
|
2796
|
-
* Optional configuration for recurring
|
|
2892
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
2797
2893
|
*/
|
|
2798
2894
|
hierarchy_configuration?: RecurringCommit.HierarchyConfiguration;
|
|
2799
2895
|
|
|
@@ -2840,6 +2936,11 @@ export namespace ContractListResponse {
|
|
|
2840
2936
|
* specifiers to contribute to a commit's or credit's drawdown.
|
|
2841
2937
|
*/
|
|
2842
2938
|
specifiers?: Array<RecurringCommit.Specifier>;
|
|
2939
|
+
|
|
2940
|
+
/**
|
|
2941
|
+
* Attach a subscription to the recurring commit/credit.
|
|
2942
|
+
*/
|
|
2943
|
+
subscription_config?: RecurringCommit.SubscriptionConfig;
|
|
2843
2944
|
}
|
|
2844
2945
|
|
|
2845
2946
|
export namespace RecurringCommit {
|
|
@@ -2874,7 +2975,7 @@ export namespace ContractListResponse {
|
|
|
2874
2975
|
}
|
|
2875
2976
|
|
|
2876
2977
|
/**
|
|
2877
|
-
* Optional configuration for recurring
|
|
2978
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
2878
2979
|
*/
|
|
2879
2980
|
export interface HierarchyConfiguration {
|
|
2880
2981
|
child_access:
|
|
@@ -2926,6 +3027,26 @@ export namespace ContractListResponse {
|
|
|
2926
3027
|
*/
|
|
2927
3028
|
product_tags?: Array<string>;
|
|
2928
3029
|
}
|
|
3030
|
+
|
|
3031
|
+
/**
|
|
3032
|
+
* Attach a subscription to the recurring commit/credit.
|
|
3033
|
+
*/
|
|
3034
|
+
export interface SubscriptionConfig {
|
|
3035
|
+
allocation: 'INDIVIDUAL' | 'POOLED';
|
|
3036
|
+
|
|
3037
|
+
apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
|
|
3038
|
+
|
|
3039
|
+
subscription_id: string;
|
|
3040
|
+
}
|
|
3041
|
+
|
|
3042
|
+
export namespace SubscriptionConfig {
|
|
3043
|
+
export interface ApplySeatIncreaseConfig {
|
|
3044
|
+
/**
|
|
3045
|
+
* Indicates whether a mid-period seat increase should be prorated.
|
|
3046
|
+
*/
|
|
3047
|
+
is_prorated: boolean;
|
|
3048
|
+
}
|
|
3049
|
+
}
|
|
2929
3050
|
}
|
|
2930
3051
|
|
|
2931
3052
|
export interface RecurringCredit {
|
|
@@ -2981,7 +3102,7 @@ export namespace ContractListResponse {
|
|
|
2981
3102
|
ending_before?: string;
|
|
2982
3103
|
|
|
2983
3104
|
/**
|
|
2984
|
-
* Optional configuration for recurring
|
|
3105
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
2985
3106
|
*/
|
|
2986
3107
|
hierarchy_configuration?: RecurringCredit.HierarchyConfiguration;
|
|
2987
3108
|
|
|
@@ -3023,6 +3144,11 @@ export namespace ContractListResponse {
|
|
|
3023
3144
|
* specifiers to contribute to a commit's or credit's drawdown.
|
|
3024
3145
|
*/
|
|
3025
3146
|
specifiers?: Array<RecurringCredit.Specifier>;
|
|
3147
|
+
|
|
3148
|
+
/**
|
|
3149
|
+
* Attach a subscription to the recurring commit/credit.
|
|
3150
|
+
*/
|
|
3151
|
+
subscription_config?: RecurringCredit.SubscriptionConfig;
|
|
3026
3152
|
}
|
|
3027
3153
|
|
|
3028
3154
|
export namespace RecurringCredit {
|
|
@@ -3057,7 +3183,7 @@ export namespace ContractListResponse {
|
|
|
3057
3183
|
}
|
|
3058
3184
|
|
|
3059
3185
|
/**
|
|
3060
|
-
* Optional configuration for recurring
|
|
3186
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
3061
3187
|
*/
|
|
3062
3188
|
export interface HierarchyConfiguration {
|
|
3063
3189
|
child_access:
|
|
@@ -3098,6 +3224,26 @@ export namespace ContractListResponse {
|
|
|
3098
3224
|
*/
|
|
3099
3225
|
product_tags?: Array<string>;
|
|
3100
3226
|
}
|
|
3227
|
+
|
|
3228
|
+
/**
|
|
3229
|
+
* Attach a subscription to the recurring commit/credit.
|
|
3230
|
+
*/
|
|
3231
|
+
export interface SubscriptionConfig {
|
|
3232
|
+
allocation: 'INDIVIDUAL' | 'POOLED';
|
|
3233
|
+
|
|
3234
|
+
apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
|
|
3235
|
+
|
|
3236
|
+
subscription_id: string;
|
|
3237
|
+
}
|
|
3238
|
+
|
|
3239
|
+
export namespace SubscriptionConfig {
|
|
3240
|
+
export interface ApplySeatIncreaseConfig {
|
|
3241
|
+
/**
|
|
3242
|
+
* Indicates whether a mid-period seat increase should be prorated.
|
|
3243
|
+
*/
|
|
3244
|
+
is_prorated: boolean;
|
|
3245
|
+
}
|
|
3246
|
+
}
|
|
3101
3247
|
}
|
|
3102
3248
|
|
|
3103
3249
|
export interface ResellerRoyalty {
|
|
@@ -3406,6 +3552,11 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
3406
3552
|
|
|
3407
3553
|
description?: string;
|
|
3408
3554
|
|
|
3555
|
+
/**
|
|
3556
|
+
* Optional configuration for commit hierarchy access control
|
|
3557
|
+
*/
|
|
3558
|
+
hierarchy_configuration?: AddCommit.HierarchyConfiguration;
|
|
3559
|
+
|
|
3409
3560
|
/**
|
|
3410
3561
|
* The schedule that the customer will be invoiced for this commit.
|
|
3411
3562
|
*/
|
|
@@ -3438,6 +3589,8 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
3438
3589
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
3439
3590
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
3440
3591
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
3592
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
3593
|
+
* body of `specifiers`.
|
|
3441
3594
|
*/
|
|
3442
3595
|
specifiers?: Array<AddCommit.Specifier>;
|
|
3443
3596
|
}
|
|
@@ -3449,6 +3602,32 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
3449
3602
|
name: string;
|
|
3450
3603
|
}
|
|
3451
3604
|
|
|
3605
|
+
/**
|
|
3606
|
+
* Optional configuration for commit hierarchy access control
|
|
3607
|
+
*/
|
|
3608
|
+
export interface HierarchyConfiguration {
|
|
3609
|
+
child_access:
|
|
3610
|
+
| HierarchyConfiguration.CommitHierarchyChildAccessAll
|
|
3611
|
+
| HierarchyConfiguration.CommitHierarchyChildAccessNone
|
|
3612
|
+
| HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
|
|
3613
|
+
}
|
|
3614
|
+
|
|
3615
|
+
export namespace HierarchyConfiguration {
|
|
3616
|
+
export interface CommitHierarchyChildAccessAll {
|
|
3617
|
+
type: 'ALL';
|
|
3618
|
+
}
|
|
3619
|
+
|
|
3620
|
+
export interface CommitHierarchyChildAccessNone {
|
|
3621
|
+
type: 'NONE';
|
|
3622
|
+
}
|
|
3623
|
+
|
|
3624
|
+
export interface CommitHierarchyChildAccessContractIDs {
|
|
3625
|
+
contract_ids: Array<string>;
|
|
3626
|
+
|
|
3627
|
+
type: 'CONTRACT_IDS';
|
|
3628
|
+
}
|
|
3629
|
+
}
|
|
3630
|
+
|
|
3452
3631
|
export interface Specifier {
|
|
3453
3632
|
presentation_group_values?: { [key: string]: string };
|
|
3454
3633
|
|
|
@@ -3485,6 +3664,11 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
3485
3664
|
|
|
3486
3665
|
description?: string;
|
|
3487
3666
|
|
|
3667
|
+
/**
|
|
3668
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
3669
|
+
*/
|
|
3670
|
+
hierarchy_configuration?: AddCredit.HierarchyConfiguration;
|
|
3671
|
+
|
|
3488
3672
|
name?: string;
|
|
3489
3673
|
|
|
3490
3674
|
/**
|
|
@@ -3508,6 +3692,8 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
3508
3692
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
3509
3693
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
3510
3694
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
3695
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
3696
|
+
* body of `specifiers`.
|
|
3511
3697
|
*/
|
|
3512
3698
|
specifiers?: Array<AddCredit.Specifier>;
|
|
3513
3699
|
}
|
|
@@ -3519,6 +3705,32 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
3519
3705
|
name: string;
|
|
3520
3706
|
}
|
|
3521
3707
|
|
|
3708
|
+
/**
|
|
3709
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
3710
|
+
*/
|
|
3711
|
+
export interface HierarchyConfiguration {
|
|
3712
|
+
child_access:
|
|
3713
|
+
| HierarchyConfiguration.CommitHierarchyChildAccessAll
|
|
3714
|
+
| HierarchyConfiguration.CommitHierarchyChildAccessNone
|
|
3715
|
+
| HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
|
|
3716
|
+
}
|
|
3717
|
+
|
|
3718
|
+
export namespace HierarchyConfiguration {
|
|
3719
|
+
export interface CommitHierarchyChildAccessAll {
|
|
3720
|
+
type: 'ALL';
|
|
3721
|
+
}
|
|
3722
|
+
|
|
3723
|
+
export interface CommitHierarchyChildAccessNone {
|
|
3724
|
+
type: 'NONE';
|
|
3725
|
+
}
|
|
3726
|
+
|
|
3727
|
+
export interface CommitHierarchyChildAccessContractIDs {
|
|
3728
|
+
contract_ids: Array<string>;
|
|
3729
|
+
|
|
3730
|
+
type: 'CONTRACT_IDS';
|
|
3731
|
+
}
|
|
3732
|
+
}
|
|
3733
|
+
|
|
3522
3734
|
export interface Specifier {
|
|
3523
3735
|
presentation_group_values?: { [key: string]: string };
|
|
3524
3736
|
|
|
@@ -3698,6 +3910,8 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
3698
3910
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
3699
3911
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
3700
3912
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
3913
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
3914
|
+
* body of `specifiers`.
|
|
3701
3915
|
*/
|
|
3702
3916
|
specifiers?: Array<Commit.Specifier>;
|
|
3703
3917
|
}
|
|
@@ -3837,7 +4051,7 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
3837
4051
|
ending_before?: string;
|
|
3838
4052
|
|
|
3839
4053
|
/**
|
|
3840
|
-
* Optional configuration for recurring
|
|
4054
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
3841
4055
|
*/
|
|
3842
4056
|
hierarchy_configuration?: AddRecurringCommit.HierarchyConfiguration;
|
|
3843
4057
|
|
|
@@ -3884,6 +4098,11 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
3884
4098
|
* specifiers to contribute to a commit's or credit's drawdown.
|
|
3885
4099
|
*/
|
|
3886
4100
|
specifiers?: Array<AddRecurringCommit.Specifier>;
|
|
4101
|
+
|
|
4102
|
+
/**
|
|
4103
|
+
* Attach a subscription to the recurring commit/credit.
|
|
4104
|
+
*/
|
|
4105
|
+
subscription_config?: AddRecurringCommit.SubscriptionConfig;
|
|
3887
4106
|
}
|
|
3888
4107
|
|
|
3889
4108
|
export namespace AddRecurringCommit {
|
|
@@ -3918,7 +4137,7 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
3918
4137
|
}
|
|
3919
4138
|
|
|
3920
4139
|
/**
|
|
3921
|
-
* Optional configuration for recurring
|
|
4140
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
3922
4141
|
*/
|
|
3923
4142
|
export interface HierarchyConfiguration {
|
|
3924
4143
|
child_access:
|
|
@@ -3970,6 +4189,26 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
3970
4189
|
*/
|
|
3971
4190
|
product_tags?: Array<string>;
|
|
3972
4191
|
}
|
|
4192
|
+
|
|
4193
|
+
/**
|
|
4194
|
+
* Attach a subscription to the recurring commit/credit.
|
|
4195
|
+
*/
|
|
4196
|
+
export interface SubscriptionConfig {
|
|
4197
|
+
allocation: 'INDIVIDUAL' | 'POOLED';
|
|
4198
|
+
|
|
4199
|
+
apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
|
|
4200
|
+
|
|
4201
|
+
subscription_id: string;
|
|
4202
|
+
}
|
|
4203
|
+
|
|
4204
|
+
export namespace SubscriptionConfig {
|
|
4205
|
+
export interface ApplySeatIncreaseConfig {
|
|
4206
|
+
/**
|
|
4207
|
+
* Indicates whether a mid-period seat increase should be prorated.
|
|
4208
|
+
*/
|
|
4209
|
+
is_prorated: boolean;
|
|
4210
|
+
}
|
|
4211
|
+
}
|
|
3973
4212
|
}
|
|
3974
4213
|
|
|
3975
4214
|
export interface AddRecurringCredit {
|
|
@@ -4025,7 +4264,7 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
4025
4264
|
ending_before?: string;
|
|
4026
4265
|
|
|
4027
4266
|
/**
|
|
4028
|
-
* Optional configuration for recurring
|
|
4267
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
4029
4268
|
*/
|
|
4030
4269
|
hierarchy_configuration?: AddRecurringCredit.HierarchyConfiguration;
|
|
4031
4270
|
|
|
@@ -4067,6 +4306,11 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
4067
4306
|
* specifiers to contribute to a commit's or credit's drawdown.
|
|
4068
4307
|
*/
|
|
4069
4308
|
specifiers?: Array<AddRecurringCredit.Specifier>;
|
|
4309
|
+
|
|
4310
|
+
/**
|
|
4311
|
+
* Attach a subscription to the recurring commit/credit.
|
|
4312
|
+
*/
|
|
4313
|
+
subscription_config?: AddRecurringCredit.SubscriptionConfig;
|
|
4070
4314
|
}
|
|
4071
4315
|
|
|
4072
4316
|
export namespace AddRecurringCredit {
|
|
@@ -4101,7 +4345,7 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
4101
4345
|
}
|
|
4102
4346
|
|
|
4103
4347
|
/**
|
|
4104
|
-
* Optional configuration for recurring
|
|
4348
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
4105
4349
|
*/
|
|
4106
4350
|
export interface HierarchyConfiguration {
|
|
4107
4351
|
child_access:
|
|
@@ -4142,6 +4386,26 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
4142
4386
|
*/
|
|
4143
4387
|
product_tags?: Array<string>;
|
|
4144
4388
|
}
|
|
4389
|
+
|
|
4390
|
+
/**
|
|
4391
|
+
* Attach a subscription to the recurring commit/credit.
|
|
4392
|
+
*/
|
|
4393
|
+
export interface SubscriptionConfig {
|
|
4394
|
+
allocation: 'INDIVIDUAL' | 'POOLED';
|
|
4395
|
+
|
|
4396
|
+
apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
|
|
4397
|
+
|
|
4398
|
+
subscription_id: string;
|
|
4399
|
+
}
|
|
4400
|
+
|
|
4401
|
+
export namespace SubscriptionConfig {
|
|
4402
|
+
export interface ApplySeatIncreaseConfig {
|
|
4403
|
+
/**
|
|
4404
|
+
* Indicates whether a mid-period seat increase should be prorated.
|
|
4405
|
+
*/
|
|
4406
|
+
is_prorated: boolean;
|
|
4407
|
+
}
|
|
4408
|
+
}
|
|
4145
4409
|
}
|
|
4146
4410
|
|
|
4147
4411
|
export interface AddResellerRoyalty {
|
|
@@ -4408,6 +4672,11 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
4408
4672
|
*/
|
|
4409
4673
|
applicable_product_tags?: Array<string> | null;
|
|
4410
4674
|
|
|
4675
|
+
/**
|
|
4676
|
+
* Optional configuration for commit hierarchy access control
|
|
4677
|
+
*/
|
|
4678
|
+
hierarchy_configuration?: UpdateCommit.HierarchyConfiguration;
|
|
4679
|
+
|
|
4411
4680
|
invoice_schedule?: UpdateCommit.InvoiceSchedule;
|
|
4412
4681
|
|
|
4413
4682
|
name?: string;
|
|
@@ -4423,6 +4692,8 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
4423
4692
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
4424
4693
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
4425
4694
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
4695
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
4696
|
+
* body of `specifiers`.
|
|
4426
4697
|
*/
|
|
4427
4698
|
specifiers?: Array<UpdateCommit.Specifier> | null;
|
|
4428
4699
|
}
|
|
@@ -4472,6 +4743,32 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
4472
4743
|
}
|
|
4473
4744
|
}
|
|
4474
4745
|
|
|
4746
|
+
/**
|
|
4747
|
+
* Optional configuration for commit hierarchy access control
|
|
4748
|
+
*/
|
|
4749
|
+
export interface HierarchyConfiguration {
|
|
4750
|
+
child_access:
|
|
4751
|
+
| HierarchyConfiguration.CommitHierarchyChildAccessAll
|
|
4752
|
+
| HierarchyConfiguration.CommitHierarchyChildAccessNone
|
|
4753
|
+
| HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
|
|
4754
|
+
}
|
|
4755
|
+
|
|
4756
|
+
export namespace HierarchyConfiguration {
|
|
4757
|
+
export interface CommitHierarchyChildAccessAll {
|
|
4758
|
+
type: 'ALL';
|
|
4759
|
+
}
|
|
4760
|
+
|
|
4761
|
+
export interface CommitHierarchyChildAccessNone {
|
|
4762
|
+
type: 'NONE';
|
|
4763
|
+
}
|
|
4764
|
+
|
|
4765
|
+
export interface CommitHierarchyChildAccessContractIDs {
|
|
4766
|
+
contract_ids: Array<string>;
|
|
4767
|
+
|
|
4768
|
+
type: 'CONTRACT_IDS';
|
|
4769
|
+
}
|
|
4770
|
+
}
|
|
4771
|
+
|
|
4475
4772
|
export interface InvoiceSchedule {
|
|
4476
4773
|
add_schedule_items?: Array<InvoiceSchedule.AddScheduleItem>;
|
|
4477
4774
|
|
|
@@ -4531,6 +4828,11 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
4531
4828
|
|
|
4532
4829
|
access_schedule?: UpdateCredit.AccessSchedule;
|
|
4533
4830
|
|
|
4831
|
+
/**
|
|
4832
|
+
* Optional configuration for credit hierarchy access control
|
|
4833
|
+
*/
|
|
4834
|
+
hierarchy_configuration?: UpdateCredit.HierarchyConfiguration;
|
|
4835
|
+
|
|
4534
4836
|
name?: string;
|
|
4535
4837
|
|
|
4536
4838
|
netsuite_sales_order_id?: string | null;
|
|
@@ -4582,6 +4884,32 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
4582
4884
|
starting_at?: string;
|
|
4583
4885
|
}
|
|
4584
4886
|
}
|
|
4887
|
+
|
|
4888
|
+
/**
|
|
4889
|
+
* Optional configuration for credit hierarchy access control
|
|
4890
|
+
*/
|
|
4891
|
+
export interface HierarchyConfiguration {
|
|
4892
|
+
child_access:
|
|
4893
|
+
| HierarchyConfiguration.CommitHierarchyChildAccessAll
|
|
4894
|
+
| HierarchyConfiguration.CommitHierarchyChildAccessNone
|
|
4895
|
+
| HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
|
|
4896
|
+
}
|
|
4897
|
+
|
|
4898
|
+
export namespace HierarchyConfiguration {
|
|
4899
|
+
export interface CommitHierarchyChildAccessAll {
|
|
4900
|
+
type: 'ALL';
|
|
4901
|
+
}
|
|
4902
|
+
|
|
4903
|
+
export interface CommitHierarchyChildAccessNone {
|
|
4904
|
+
type: 'NONE';
|
|
4905
|
+
}
|
|
4906
|
+
|
|
4907
|
+
export interface CommitHierarchyChildAccessContractIDs {
|
|
4908
|
+
contract_ids: Array<string>;
|
|
4909
|
+
|
|
4910
|
+
type: 'CONTRACT_IDS';
|
|
4911
|
+
}
|
|
4912
|
+
}
|
|
4585
4913
|
}
|
|
4586
4914
|
|
|
4587
4915
|
export interface UpdateDiscount {
|
|
@@ -4605,7 +4933,7 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
4605
4933
|
*/
|
|
4606
4934
|
export interface Schedule {
|
|
4607
4935
|
/**
|
|
4608
|
-
* Defaults to USD if not passed.
|
|
4936
|
+
* Defaults to USD (cents) if not passed.
|
|
4609
4937
|
*/
|
|
4610
4938
|
credit_type_id?: string;
|
|
4611
4939
|
|
|
@@ -4759,6 +5087,8 @@ export namespace ContractGetEditHistoryResponse {
|
|
|
4759
5087
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
4760
5088
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
4761
5089
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
5090
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
5091
|
+
* body of `specifiers`.
|
|
4762
5092
|
*/
|
|
4763
5093
|
specifiers?: Array<Commit.Specifier> | null;
|
|
4764
5094
|
}
|
|
@@ -5312,6 +5642,8 @@ export namespace ContractEditParams {
|
|
|
5312
5642
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
5313
5643
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
5314
5644
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
5645
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
5646
|
+
* body of `specifiers`.
|
|
5315
5647
|
*/
|
|
5316
5648
|
specifiers?: Array<AddCommit.Specifier>;
|
|
5317
5649
|
|
|
@@ -5384,7 +5716,7 @@ export namespace ContractEditParams {
|
|
|
5384
5716
|
*/
|
|
5385
5717
|
export interface InvoiceSchedule {
|
|
5386
5718
|
/**
|
|
5387
|
-
* Defaults to USD if not passed.
|
|
5719
|
+
* Defaults to USD (cents) if not passed.
|
|
5388
5720
|
*/
|
|
5389
5721
|
credit_type_id?: string;
|
|
5390
5722
|
|
|
@@ -5611,6 +5943,8 @@ export namespace ContractEditParams {
|
|
|
5611
5943
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
5612
5944
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
5613
5945
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
5946
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
5947
|
+
* body of `specifiers`.
|
|
5614
5948
|
*/
|
|
5615
5949
|
specifiers?: Array<AddCredit.Specifier>;
|
|
5616
5950
|
}
|
|
@@ -5712,7 +6046,7 @@ export namespace ContractEditParams {
|
|
|
5712
6046
|
*/
|
|
5713
6047
|
export interface Schedule {
|
|
5714
6048
|
/**
|
|
5715
|
-
* Defaults to USD if not passed.
|
|
6049
|
+
* Defaults to USD (cents) if not passed.
|
|
5716
6050
|
*/
|
|
5717
6051
|
credit_type_id?: string;
|
|
5718
6052
|
|
|
@@ -6035,6 +6369,8 @@ export namespace ContractEditParams {
|
|
|
6035
6369
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
6036
6370
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
6037
6371
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
6372
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
6373
|
+
* body of `specifiers`.
|
|
6038
6374
|
*/
|
|
6039
6375
|
specifiers?: Array<Commit.Specifier>;
|
|
6040
6376
|
}
|
|
@@ -6197,7 +6533,7 @@ export namespace ContractEditParams {
|
|
|
6197
6533
|
ending_before?: string;
|
|
6198
6534
|
|
|
6199
6535
|
/**
|
|
6200
|
-
* Optional configuration for recurring
|
|
6536
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
6201
6537
|
*/
|
|
6202
6538
|
hierarchy_configuration?: AddRecurringCommit.HierarchyConfiguration;
|
|
6203
6539
|
|
|
@@ -6248,9 +6584,16 @@ export namespace ContractEditParams {
|
|
|
6248
6584
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
6249
6585
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
6250
6586
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
6587
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
6588
|
+
* body of `specifiers`.
|
|
6251
6589
|
*/
|
|
6252
6590
|
specifiers?: Array<AddRecurringCommit.Specifier>;
|
|
6253
6591
|
|
|
6592
|
+
/**
|
|
6593
|
+
* Attach a subscription to the recurring commit/credit.
|
|
6594
|
+
*/
|
|
6595
|
+
subscription_config?: AddRecurringCommit.SubscriptionConfig;
|
|
6596
|
+
|
|
6254
6597
|
/**
|
|
6255
6598
|
* A temporary ID that can be used to reference the recurring commit for commit
|
|
6256
6599
|
* specific overrides.
|
|
@@ -6286,7 +6629,7 @@ export namespace ContractEditParams {
|
|
|
6286
6629
|
}
|
|
6287
6630
|
|
|
6288
6631
|
/**
|
|
6289
|
-
* Optional configuration for recurring
|
|
6632
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
6290
6633
|
*/
|
|
6291
6634
|
export interface HierarchyConfiguration {
|
|
6292
6635
|
child_access:
|
|
@@ -6338,6 +6681,32 @@ export namespace ContractEditParams {
|
|
|
6338
6681
|
*/
|
|
6339
6682
|
product_tags?: Array<string>;
|
|
6340
6683
|
}
|
|
6684
|
+
|
|
6685
|
+
/**
|
|
6686
|
+
* Attach a subscription to the recurring commit/credit.
|
|
6687
|
+
*/
|
|
6688
|
+
export interface SubscriptionConfig {
|
|
6689
|
+
apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
|
|
6690
|
+
|
|
6691
|
+
/**
|
|
6692
|
+
* ID of the subscription to configure on the recurring commit/credit.
|
|
6693
|
+
*/
|
|
6694
|
+
subscription_id: string;
|
|
6695
|
+
|
|
6696
|
+
/**
|
|
6697
|
+
* If set to POOLED, allocation added per seat is pooled across the account.
|
|
6698
|
+
*/
|
|
6699
|
+
allocation?: 'POOLED';
|
|
6700
|
+
}
|
|
6701
|
+
|
|
6702
|
+
export namespace SubscriptionConfig {
|
|
6703
|
+
export interface ApplySeatIncreaseConfig {
|
|
6704
|
+
/**
|
|
6705
|
+
* Indicates whether a mid-period seat increase should be prorated.
|
|
6706
|
+
*/
|
|
6707
|
+
is_prorated: boolean;
|
|
6708
|
+
}
|
|
6709
|
+
}
|
|
6341
6710
|
}
|
|
6342
6711
|
|
|
6343
6712
|
export interface AddRecurringCredit {
|
|
@@ -6386,7 +6755,7 @@ export namespace ContractEditParams {
|
|
|
6386
6755
|
ending_before?: string;
|
|
6387
6756
|
|
|
6388
6757
|
/**
|
|
6389
|
-
* Optional configuration for recurring
|
|
6758
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
6390
6759
|
*/
|
|
6391
6760
|
hierarchy_configuration?: AddRecurringCredit.HierarchyConfiguration;
|
|
6392
6761
|
|
|
@@ -6432,9 +6801,16 @@ export namespace ContractEditParams {
|
|
|
6432
6801
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
6433
6802
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
6434
6803
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
6804
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
6805
|
+
* body of `specifiers`.
|
|
6435
6806
|
*/
|
|
6436
6807
|
specifiers?: Array<AddRecurringCredit.Specifier>;
|
|
6437
6808
|
|
|
6809
|
+
/**
|
|
6810
|
+
* Attach a subscription to the recurring commit/credit.
|
|
6811
|
+
*/
|
|
6812
|
+
subscription_config?: AddRecurringCredit.SubscriptionConfig;
|
|
6813
|
+
|
|
6438
6814
|
/**
|
|
6439
6815
|
* A temporary ID that can be used to reference the recurring commit for commit
|
|
6440
6816
|
* specific overrides.
|
|
@@ -6470,7 +6846,7 @@ export namespace ContractEditParams {
|
|
|
6470
6846
|
}
|
|
6471
6847
|
|
|
6472
6848
|
/**
|
|
6473
|
-
* Optional configuration for recurring
|
|
6849
|
+
* Optional configuration for recurring credit hierarchy access control
|
|
6474
6850
|
*/
|
|
6475
6851
|
export interface HierarchyConfiguration {
|
|
6476
6852
|
child_access:
|
|
@@ -6511,6 +6887,32 @@ export namespace ContractEditParams {
|
|
|
6511
6887
|
*/
|
|
6512
6888
|
product_tags?: Array<string>;
|
|
6513
6889
|
}
|
|
6890
|
+
|
|
6891
|
+
/**
|
|
6892
|
+
* Attach a subscription to the recurring commit/credit.
|
|
6893
|
+
*/
|
|
6894
|
+
export interface SubscriptionConfig {
|
|
6895
|
+
apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
|
|
6896
|
+
|
|
6897
|
+
/**
|
|
6898
|
+
* ID of the subscription to configure on the recurring commit/credit.
|
|
6899
|
+
*/
|
|
6900
|
+
subscription_id: string;
|
|
6901
|
+
|
|
6902
|
+
/**
|
|
6903
|
+
* If set to POOLED, allocation added per seat is pooled across the account.
|
|
6904
|
+
*/
|
|
6905
|
+
allocation?: 'POOLED';
|
|
6906
|
+
}
|
|
6907
|
+
|
|
6908
|
+
export namespace SubscriptionConfig {
|
|
6909
|
+
export interface ApplySeatIncreaseConfig {
|
|
6910
|
+
/**
|
|
6911
|
+
* Indicates whether a mid-period seat increase should be prorated.
|
|
6912
|
+
*/
|
|
6913
|
+
is_prorated: boolean;
|
|
6914
|
+
}
|
|
6915
|
+
}
|
|
6514
6916
|
}
|
|
6515
6917
|
|
|
6516
6918
|
export interface AddResellerRoyalty {
|
|
@@ -6585,7 +6987,7 @@ export namespace ContractEditParams {
|
|
|
6585
6987
|
*/
|
|
6586
6988
|
export interface Schedule {
|
|
6587
6989
|
/**
|
|
6588
|
-
* Defaults to USD if not passed.
|
|
6990
|
+
* Defaults to USD (cents) if not passed.
|
|
6589
6991
|
*/
|
|
6590
6992
|
credit_type_id?: string;
|
|
6591
6993
|
|
|
@@ -6800,15 +7202,22 @@ export namespace ContractEditParams {
|
|
|
6800
7202
|
* start date
|
|
6801
7203
|
*/
|
|
6802
7204
|
starting_at?: string;
|
|
7205
|
+
|
|
7206
|
+
/**
|
|
7207
|
+
* A temporary ID used to reference the subscription in recurring commit/credit
|
|
7208
|
+
* subscription configs created within the same payload.
|
|
7209
|
+
*/
|
|
7210
|
+
temporary_id?: string;
|
|
6803
7211
|
}
|
|
6804
7212
|
|
|
6805
7213
|
export namespace AddSubscription {
|
|
6806
7214
|
export interface Proration {
|
|
6807
7215
|
/**
|
|
6808
|
-
* Indicates how mid-period quantity adjustments are invoiced.
|
|
6809
|
-
*
|
|
6810
|
-
*
|
|
6811
|
-
*
|
|
7216
|
+
* Indicates how mid-period quantity adjustments are invoiced.
|
|
7217
|
+
* **BILL_IMMEDIATELY**: Only available when collection schedule is `ADVANCE`. The
|
|
7218
|
+
* quantity increase will be billed immediately on the scheduled date.
|
|
7219
|
+
* **BILL_ON_NEXT_COLLECTION_DATE**: The quantity increase will be billed for
|
|
7220
|
+
* in-arrears at the end of the period.
|
|
6812
7221
|
*/
|
|
6813
7222
|
invoice_behavior?: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
|
|
6814
7223
|
|
|
@@ -7130,6 +7539,8 @@ export namespace ContractEditParams {
|
|
|
7130
7539
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
7131
7540
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
7132
7541
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
7542
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
7543
|
+
* body of `specifiers`.
|
|
7133
7544
|
*/
|
|
7134
7545
|
specifiers?: Array<Commit.Specifier> | null;
|
|
7135
7546
|
}
|
|
@@ -7475,6 +7886,8 @@ export interface ContractEditCommitParams {
|
|
|
7475
7886
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
7476
7887
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
7477
7888
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
7889
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
7890
|
+
* body of `specifiers`.
|
|
7478
7891
|
*/
|
|
7479
7892
|
specifiers?: Array<ContractEditCommitParams.Specifier> | null;
|
|
7480
7893
|
}
|
|
@@ -7598,6 +8011,8 @@ export interface ContractEditCreditParams {
|
|
|
7598
8011
|
* or credit. A customer's usage needs to meet the condition of at least one of the
|
|
7599
8012
|
* specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
7600
8013
|
* be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
8014
|
+
* Instead, to target usage by product or product tag, pass those values in the
|
|
8015
|
+
* body of `specifiers`.
|
|
7601
8016
|
*/
|
|
7602
8017
|
specifiers?: Array<ContractEditCreditParams.Specifier> | null;
|
|
7603
8018
|
}
|