@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.
@@ -327,6 +327,7 @@ export declare namespace ContractRetrieveResponse {
327
327
  segment_id: string;
328
328
  timestamp: string;
329
329
  type: 'PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
330
+ contract_id?: string;
330
331
  }
331
332
  interface PrepaidCommitRolloverLedgerEntry {
332
333
  amount: number;
@@ -347,6 +348,7 @@ export declare namespace ContractRetrieveResponse {
347
348
  segment_id: string;
348
349
  timestamp: string;
349
350
  type: 'PREPAID_COMMIT_CANCELED';
351
+ contract_id?: string;
350
352
  }
351
353
  interface PrepaidCommitCreditedLedgerEntry {
352
354
  amount: number;
@@ -354,6 +356,7 @@ export declare namespace ContractRetrieveResponse {
354
356
  segment_id: string;
355
357
  timestamp: string;
356
358
  type: 'PREPAID_COMMIT_CREDITED';
359
+ contract_id?: string;
357
360
  }
358
361
  interface PrepaidCommitSeatBasedAdjustmentLedgerEntry {
359
362
  amount: number;
@@ -372,6 +375,7 @@ export declare namespace ContractRetrieveResponse {
372
375
  segment_id: string;
373
376
  timestamp: string;
374
377
  type: 'POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
378
+ contract_id?: string;
375
379
  }
376
380
  interface PostpaidCommitRolloverLedgerEntry {
377
381
  amount: number;
@@ -385,6 +389,7 @@ export declare namespace ContractRetrieveResponse {
385
389
  invoice_id: string;
386
390
  timestamp: string;
387
391
  type: 'POSTPAID_COMMIT_TRUEUP';
392
+ contract_id?: string;
388
393
  }
389
394
  interface PrepaidCommitManualLedgerEntry {
390
395
  amount: number;
@@ -615,6 +620,7 @@ export declare namespace ContractRetrieveResponse {
615
620
  segment_id: string;
616
621
  timestamp: string;
617
622
  type: 'CREDIT_AUTOMATED_INVOICE_DEDUCTION';
623
+ contract_id?: string;
618
624
  }
619
625
  interface CreditExpirationLedgerEntry {
620
626
  amount: number;
@@ -628,6 +634,7 @@ export declare namespace ContractRetrieveResponse {
628
634
  segment_id: string;
629
635
  timestamp: string;
630
636
  type: 'CREDIT_CANCELED';
637
+ contract_id?: string;
631
638
  }
632
639
  interface CreditCreditedLedgerEntry {
633
640
  amount: number;
@@ -635,6 +642,7 @@ export declare namespace ContractRetrieveResponse {
635
642
  segment_id: string;
636
643
  timestamp: string;
637
644
  type: 'CREDIT_CREDITED';
645
+ contract_id?: string;
638
646
  }
639
647
  interface CreditManualLedgerEntry {
640
648
  amount: number;
@@ -670,6 +678,10 @@ export declare namespace ContractRetrieveResponse {
670
678
  * This field's availability is dependent on your client's configuration.
671
679
  */
672
680
  interface CustomerBillingProviderConfiguration {
681
+ /**
682
+ * ID of Customer's billing provider configuration.
683
+ */
684
+ id: string;
673
685
  billing_provider: 'aws_marketplace' | 'stripe' | 'netsuite' | 'custom' | 'azure_marketplace' | 'quickbooks_online' | 'workday' | 'gcp_marketplace';
674
686
  delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
675
687
  }
@@ -772,6 +784,8 @@ export declare namespace ContractRetrieveResponse {
772
784
  * or credit. A customer's usage needs to meet the condition of at least one of the
773
785
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
774
786
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
787
+ * Instead, to target usage by product or product tag, pass those values in the
788
+ * body of `specifiers`.
775
789
  */
776
790
  specifiers?: Array<Commit.Specifier>;
777
791
  }
@@ -892,7 +906,7 @@ export declare namespace ContractRetrieveResponse {
892
906
  */
893
907
  ending_before?: string;
894
908
  /**
895
- * Optional configuration for recurring commit/credit hierarchy access control
909
+ * Optional configuration for recurring credit hierarchy access control
896
910
  */
897
911
  hierarchy_configuration?: RecurringCommit.HierarchyConfiguration;
898
912
  /**
@@ -932,6 +946,10 @@ export declare namespace ContractRetrieveResponse {
932
946
  * specifiers to contribute to a commit's or credit's drawdown.
933
947
  */
934
948
  specifiers?: Array<RecurringCommit.Specifier>;
949
+ /**
950
+ * Attach a subscription to the recurring commit/credit.
951
+ */
952
+ subscription_config?: RecurringCommit.SubscriptionConfig;
935
953
  }
936
954
  namespace RecurringCommit {
937
955
  /**
@@ -957,7 +975,7 @@ export declare namespace ContractRetrieveResponse {
957
975
  id: string;
958
976
  }
959
977
  /**
960
- * Optional configuration for recurring commit/credit hierarchy access control
978
+ * Optional configuration for recurring credit hierarchy access control
961
979
  */
962
980
  interface HierarchyConfiguration {
963
981
  child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -999,6 +1017,22 @@ export declare namespace ContractRetrieveResponse {
999
1017
  */
1000
1018
  product_tags?: Array<string>;
1001
1019
  }
1020
+ /**
1021
+ * Attach a subscription to the recurring commit/credit.
1022
+ */
1023
+ interface SubscriptionConfig {
1024
+ allocation: 'INDIVIDUAL' | 'POOLED';
1025
+ apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
1026
+ subscription_id: string;
1027
+ }
1028
+ namespace SubscriptionConfig {
1029
+ interface ApplySeatIncreaseConfig {
1030
+ /**
1031
+ * Indicates whether a mid-period seat increase should be prorated.
1032
+ */
1033
+ is_prorated: boolean;
1034
+ }
1035
+ }
1002
1036
  }
1003
1037
  interface RecurringCredit {
1004
1038
  id: string;
@@ -1041,7 +1075,7 @@ export declare namespace ContractRetrieveResponse {
1041
1075
  */
1042
1076
  ending_before?: string;
1043
1077
  /**
1044
- * Optional configuration for recurring commit/credit hierarchy access control
1078
+ * Optional configuration for recurring credit hierarchy access control
1045
1079
  */
1046
1080
  hierarchy_configuration?: RecurringCredit.HierarchyConfiguration;
1047
1081
  /**
@@ -1077,6 +1111,10 @@ export declare namespace ContractRetrieveResponse {
1077
1111
  * specifiers to contribute to a commit's or credit's drawdown.
1078
1112
  */
1079
1113
  specifiers?: Array<RecurringCredit.Specifier>;
1114
+ /**
1115
+ * Attach a subscription to the recurring commit/credit.
1116
+ */
1117
+ subscription_config?: RecurringCredit.SubscriptionConfig;
1080
1118
  }
1081
1119
  namespace RecurringCredit {
1082
1120
  /**
@@ -1102,7 +1140,7 @@ export declare namespace ContractRetrieveResponse {
1102
1140
  id: string;
1103
1141
  }
1104
1142
  /**
1105
- * Optional configuration for recurring commit/credit hierarchy access control
1143
+ * Optional configuration for recurring credit hierarchy access control
1106
1144
  */
1107
1145
  interface HierarchyConfiguration {
1108
1146
  child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -1136,6 +1174,22 @@ export declare namespace ContractRetrieveResponse {
1136
1174
  */
1137
1175
  product_tags?: Array<string>;
1138
1176
  }
1177
+ /**
1178
+ * Attach a subscription to the recurring commit/credit.
1179
+ */
1180
+ interface SubscriptionConfig {
1181
+ allocation: 'INDIVIDUAL' | 'POOLED';
1182
+ apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
1183
+ subscription_id: string;
1184
+ }
1185
+ namespace SubscriptionConfig {
1186
+ interface ApplySeatIncreaseConfig {
1187
+ /**
1188
+ * Indicates whether a mid-period seat increase should be prorated.
1189
+ */
1190
+ is_prorated: boolean;
1191
+ }
1192
+ }
1139
1193
  }
1140
1194
  interface ResellerRoyalty {
1141
1195
  reseller_type: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
@@ -1495,6 +1549,7 @@ export declare namespace ContractListResponse {
1495
1549
  segment_id: string;
1496
1550
  timestamp: string;
1497
1551
  type: 'PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
1552
+ contract_id?: string;
1498
1553
  }
1499
1554
  interface PrepaidCommitRolloverLedgerEntry {
1500
1555
  amount: number;
@@ -1515,6 +1570,7 @@ export declare namespace ContractListResponse {
1515
1570
  segment_id: string;
1516
1571
  timestamp: string;
1517
1572
  type: 'PREPAID_COMMIT_CANCELED';
1573
+ contract_id?: string;
1518
1574
  }
1519
1575
  interface PrepaidCommitCreditedLedgerEntry {
1520
1576
  amount: number;
@@ -1522,6 +1578,7 @@ export declare namespace ContractListResponse {
1522
1578
  segment_id: string;
1523
1579
  timestamp: string;
1524
1580
  type: 'PREPAID_COMMIT_CREDITED';
1581
+ contract_id?: string;
1525
1582
  }
1526
1583
  interface PrepaidCommitSeatBasedAdjustmentLedgerEntry {
1527
1584
  amount: number;
@@ -1540,6 +1597,7 @@ export declare namespace ContractListResponse {
1540
1597
  segment_id: string;
1541
1598
  timestamp: string;
1542
1599
  type: 'POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
1600
+ contract_id?: string;
1543
1601
  }
1544
1602
  interface PostpaidCommitRolloverLedgerEntry {
1545
1603
  amount: number;
@@ -1553,6 +1611,7 @@ export declare namespace ContractListResponse {
1553
1611
  invoice_id: string;
1554
1612
  timestamp: string;
1555
1613
  type: 'POSTPAID_COMMIT_TRUEUP';
1614
+ contract_id?: string;
1556
1615
  }
1557
1616
  interface PrepaidCommitManualLedgerEntry {
1558
1617
  amount: number;
@@ -1783,6 +1842,7 @@ export declare namespace ContractListResponse {
1783
1842
  segment_id: string;
1784
1843
  timestamp: string;
1785
1844
  type: 'CREDIT_AUTOMATED_INVOICE_DEDUCTION';
1845
+ contract_id?: string;
1786
1846
  }
1787
1847
  interface CreditExpirationLedgerEntry {
1788
1848
  amount: number;
@@ -1796,6 +1856,7 @@ export declare namespace ContractListResponse {
1796
1856
  segment_id: string;
1797
1857
  timestamp: string;
1798
1858
  type: 'CREDIT_CANCELED';
1859
+ contract_id?: string;
1799
1860
  }
1800
1861
  interface CreditCreditedLedgerEntry {
1801
1862
  amount: number;
@@ -1803,6 +1864,7 @@ export declare namespace ContractListResponse {
1803
1864
  segment_id: string;
1804
1865
  timestamp: string;
1805
1866
  type: 'CREDIT_CREDITED';
1867
+ contract_id?: string;
1806
1868
  }
1807
1869
  interface CreditManualLedgerEntry {
1808
1870
  amount: number;
@@ -1838,6 +1900,10 @@ export declare namespace ContractListResponse {
1838
1900
  * This field's availability is dependent on your client's configuration.
1839
1901
  */
1840
1902
  interface CustomerBillingProviderConfiguration {
1903
+ /**
1904
+ * ID of Customer's billing provider configuration.
1905
+ */
1906
+ id: string;
1841
1907
  billing_provider: 'aws_marketplace' | 'stripe' | 'netsuite' | 'custom' | 'azure_marketplace' | 'quickbooks_online' | 'workday' | 'gcp_marketplace';
1842
1908
  delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
1843
1909
  }
@@ -1940,6 +2006,8 @@ export declare namespace ContractListResponse {
1940
2006
  * or credit. A customer's usage needs to meet the condition of at least one of the
1941
2007
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
1942
2008
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
2009
+ * Instead, to target usage by product or product tag, pass those values in the
2010
+ * body of `specifiers`.
1943
2011
  */
1944
2012
  specifiers?: Array<Commit.Specifier>;
1945
2013
  }
@@ -2060,7 +2128,7 @@ export declare namespace ContractListResponse {
2060
2128
  */
2061
2129
  ending_before?: string;
2062
2130
  /**
2063
- * Optional configuration for recurring commit/credit hierarchy access control
2131
+ * Optional configuration for recurring credit hierarchy access control
2064
2132
  */
2065
2133
  hierarchy_configuration?: RecurringCommit.HierarchyConfiguration;
2066
2134
  /**
@@ -2100,6 +2168,10 @@ export declare namespace ContractListResponse {
2100
2168
  * specifiers to contribute to a commit's or credit's drawdown.
2101
2169
  */
2102
2170
  specifiers?: Array<RecurringCommit.Specifier>;
2171
+ /**
2172
+ * Attach a subscription to the recurring commit/credit.
2173
+ */
2174
+ subscription_config?: RecurringCommit.SubscriptionConfig;
2103
2175
  }
2104
2176
  namespace RecurringCommit {
2105
2177
  /**
@@ -2125,7 +2197,7 @@ export declare namespace ContractListResponse {
2125
2197
  id: string;
2126
2198
  }
2127
2199
  /**
2128
- * Optional configuration for recurring commit/credit hierarchy access control
2200
+ * Optional configuration for recurring credit hierarchy access control
2129
2201
  */
2130
2202
  interface HierarchyConfiguration {
2131
2203
  child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -2167,6 +2239,22 @@ export declare namespace ContractListResponse {
2167
2239
  */
2168
2240
  product_tags?: Array<string>;
2169
2241
  }
2242
+ /**
2243
+ * Attach a subscription to the recurring commit/credit.
2244
+ */
2245
+ interface SubscriptionConfig {
2246
+ allocation: 'INDIVIDUAL' | 'POOLED';
2247
+ apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
2248
+ subscription_id: string;
2249
+ }
2250
+ namespace SubscriptionConfig {
2251
+ interface ApplySeatIncreaseConfig {
2252
+ /**
2253
+ * Indicates whether a mid-period seat increase should be prorated.
2254
+ */
2255
+ is_prorated: boolean;
2256
+ }
2257
+ }
2170
2258
  }
2171
2259
  interface RecurringCredit {
2172
2260
  id: string;
@@ -2209,7 +2297,7 @@ export declare namespace ContractListResponse {
2209
2297
  */
2210
2298
  ending_before?: string;
2211
2299
  /**
2212
- * Optional configuration for recurring commit/credit hierarchy access control
2300
+ * Optional configuration for recurring credit hierarchy access control
2213
2301
  */
2214
2302
  hierarchy_configuration?: RecurringCredit.HierarchyConfiguration;
2215
2303
  /**
@@ -2245,6 +2333,10 @@ export declare namespace ContractListResponse {
2245
2333
  * specifiers to contribute to a commit's or credit's drawdown.
2246
2334
  */
2247
2335
  specifiers?: Array<RecurringCredit.Specifier>;
2336
+ /**
2337
+ * Attach a subscription to the recurring commit/credit.
2338
+ */
2339
+ subscription_config?: RecurringCredit.SubscriptionConfig;
2248
2340
  }
2249
2341
  namespace RecurringCredit {
2250
2342
  /**
@@ -2270,7 +2362,7 @@ export declare namespace ContractListResponse {
2270
2362
  id: string;
2271
2363
  }
2272
2364
  /**
2273
- * Optional configuration for recurring commit/credit hierarchy access control
2365
+ * Optional configuration for recurring credit hierarchy access control
2274
2366
  */
2275
2367
  interface HierarchyConfiguration {
2276
2368
  child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -2304,6 +2396,22 @@ export declare namespace ContractListResponse {
2304
2396
  */
2305
2397
  product_tags?: Array<string>;
2306
2398
  }
2399
+ /**
2400
+ * Attach a subscription to the recurring commit/credit.
2401
+ */
2402
+ interface SubscriptionConfig {
2403
+ allocation: 'INDIVIDUAL' | 'POOLED';
2404
+ apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
2405
+ subscription_id: string;
2406
+ }
2407
+ namespace SubscriptionConfig {
2408
+ interface ApplySeatIncreaseConfig {
2409
+ /**
2410
+ * Indicates whether a mid-period seat increase should be prorated.
2411
+ */
2412
+ is_prorated: boolean;
2413
+ }
2414
+ }
2307
2415
  }
2308
2416
  interface ResellerRoyalty {
2309
2417
  reseller_type: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
@@ -2523,6 +2631,10 @@ export declare namespace ContractGetEditHistoryResponse {
2523
2631
  applicable_product_ids?: Array<string>;
2524
2632
  applicable_product_tags?: Array<string>;
2525
2633
  description?: string;
2634
+ /**
2635
+ * Optional configuration for commit hierarchy access control
2636
+ */
2637
+ hierarchy_configuration?: AddCommit.HierarchyConfiguration;
2526
2638
  /**
2527
2639
  * The schedule that the customer will be invoiced for this commit.
2528
2640
  */
@@ -2548,6 +2660,8 @@ export declare namespace ContractGetEditHistoryResponse {
2548
2660
  * or credit. A customer's usage needs to meet the condition of at least one of the
2549
2661
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
2550
2662
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
2663
+ * Instead, to target usage by product or product tag, pass those values in the
2664
+ * body of `specifiers`.
2551
2665
  */
2552
2666
  specifiers?: Array<AddCommit.Specifier>;
2553
2667
  }
@@ -2556,6 +2670,24 @@ export declare namespace ContractGetEditHistoryResponse {
2556
2670
  id: string;
2557
2671
  name: string;
2558
2672
  }
2673
+ /**
2674
+ * Optional configuration for commit hierarchy access control
2675
+ */
2676
+ interface HierarchyConfiguration {
2677
+ child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
2678
+ }
2679
+ namespace HierarchyConfiguration {
2680
+ interface CommitHierarchyChildAccessAll {
2681
+ type: 'ALL';
2682
+ }
2683
+ interface CommitHierarchyChildAccessNone {
2684
+ type: 'NONE';
2685
+ }
2686
+ interface CommitHierarchyChildAccessContractIDs {
2687
+ contract_ids: Array<string>;
2688
+ type: 'CONTRACT_IDS';
2689
+ }
2690
+ }
2559
2691
  interface Specifier {
2560
2692
  presentation_group_values?: {
2561
2693
  [key: string]: string;
@@ -2585,6 +2717,10 @@ export declare namespace ContractGetEditHistoryResponse {
2585
2717
  applicable_product_ids?: Array<string>;
2586
2718
  applicable_product_tags?: Array<string>;
2587
2719
  description?: string;
2720
+ /**
2721
+ * Optional configuration for recurring credit hierarchy access control
2722
+ */
2723
+ hierarchy_configuration?: AddCredit.HierarchyConfiguration;
2588
2724
  name?: string;
2589
2725
  /**
2590
2726
  * This field's availability is dependent on your client's configuration.
@@ -2604,6 +2740,8 @@ export declare namespace ContractGetEditHistoryResponse {
2604
2740
  * or credit. A customer's usage needs to meet the condition of at least one of the
2605
2741
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
2606
2742
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
2743
+ * Instead, to target usage by product or product tag, pass those values in the
2744
+ * body of `specifiers`.
2607
2745
  */
2608
2746
  specifiers?: Array<AddCredit.Specifier>;
2609
2747
  }
@@ -2612,6 +2750,24 @@ export declare namespace ContractGetEditHistoryResponse {
2612
2750
  id: string;
2613
2751
  name: string;
2614
2752
  }
2753
+ /**
2754
+ * Optional configuration for recurring credit hierarchy access control
2755
+ */
2756
+ interface HierarchyConfiguration {
2757
+ child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
2758
+ }
2759
+ namespace HierarchyConfiguration {
2760
+ interface CommitHierarchyChildAccessAll {
2761
+ type: 'ALL';
2762
+ }
2763
+ interface CommitHierarchyChildAccessNone {
2764
+ type: 'NONE';
2765
+ }
2766
+ interface CommitHierarchyChildAccessContractIDs {
2767
+ contract_ids: Array<string>;
2768
+ type: 'CONTRACT_IDS';
2769
+ }
2770
+ }
2615
2771
  interface Specifier {
2616
2772
  presentation_group_values?: {
2617
2773
  [key: string]: string;
@@ -2753,6 +2909,8 @@ export declare namespace ContractGetEditHistoryResponse {
2753
2909
  * or credit. A customer's usage needs to meet the condition of at least one of the
2754
2910
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
2755
2911
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
2912
+ * Instead, to target usage by product or product tag, pass those values in the
2913
+ * body of `specifiers`.
2756
2914
  */
2757
2915
  specifiers?: Array<Commit.Specifier>;
2758
2916
  }
@@ -2873,7 +3031,7 @@ export declare namespace ContractGetEditHistoryResponse {
2873
3031
  */
2874
3032
  ending_before?: string;
2875
3033
  /**
2876
- * Optional configuration for recurring commit/credit hierarchy access control
3034
+ * Optional configuration for recurring credit hierarchy access control
2877
3035
  */
2878
3036
  hierarchy_configuration?: AddRecurringCommit.HierarchyConfiguration;
2879
3037
  /**
@@ -2913,6 +3071,10 @@ export declare namespace ContractGetEditHistoryResponse {
2913
3071
  * specifiers to contribute to a commit's or credit's drawdown.
2914
3072
  */
2915
3073
  specifiers?: Array<AddRecurringCommit.Specifier>;
3074
+ /**
3075
+ * Attach a subscription to the recurring commit/credit.
3076
+ */
3077
+ subscription_config?: AddRecurringCommit.SubscriptionConfig;
2916
3078
  }
2917
3079
  namespace AddRecurringCommit {
2918
3080
  /**
@@ -2938,7 +3100,7 @@ export declare namespace ContractGetEditHistoryResponse {
2938
3100
  id: string;
2939
3101
  }
2940
3102
  /**
2941
- * Optional configuration for recurring commit/credit hierarchy access control
3103
+ * Optional configuration for recurring credit hierarchy access control
2942
3104
  */
2943
3105
  interface HierarchyConfiguration {
2944
3106
  child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -2980,6 +3142,22 @@ export declare namespace ContractGetEditHistoryResponse {
2980
3142
  */
2981
3143
  product_tags?: Array<string>;
2982
3144
  }
3145
+ /**
3146
+ * Attach a subscription to the recurring commit/credit.
3147
+ */
3148
+ interface SubscriptionConfig {
3149
+ allocation: 'INDIVIDUAL' | 'POOLED';
3150
+ apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
3151
+ subscription_id: string;
3152
+ }
3153
+ namespace SubscriptionConfig {
3154
+ interface ApplySeatIncreaseConfig {
3155
+ /**
3156
+ * Indicates whether a mid-period seat increase should be prorated.
3157
+ */
3158
+ is_prorated: boolean;
3159
+ }
3160
+ }
2983
3161
  }
2984
3162
  interface AddRecurringCredit {
2985
3163
  id: string;
@@ -3022,7 +3200,7 @@ export declare namespace ContractGetEditHistoryResponse {
3022
3200
  */
3023
3201
  ending_before?: string;
3024
3202
  /**
3025
- * Optional configuration for recurring commit/credit hierarchy access control
3203
+ * Optional configuration for recurring credit hierarchy access control
3026
3204
  */
3027
3205
  hierarchy_configuration?: AddRecurringCredit.HierarchyConfiguration;
3028
3206
  /**
@@ -3058,6 +3236,10 @@ export declare namespace ContractGetEditHistoryResponse {
3058
3236
  * specifiers to contribute to a commit's or credit's drawdown.
3059
3237
  */
3060
3238
  specifiers?: Array<AddRecurringCredit.Specifier>;
3239
+ /**
3240
+ * Attach a subscription to the recurring commit/credit.
3241
+ */
3242
+ subscription_config?: AddRecurringCredit.SubscriptionConfig;
3061
3243
  }
3062
3244
  namespace AddRecurringCredit {
3063
3245
  /**
@@ -3083,7 +3265,7 @@ export declare namespace ContractGetEditHistoryResponse {
3083
3265
  id: string;
3084
3266
  }
3085
3267
  /**
3086
- * Optional configuration for recurring commit/credit hierarchy access control
3268
+ * Optional configuration for recurring credit hierarchy access control
3087
3269
  */
3088
3270
  interface HierarchyConfiguration {
3089
3271
  child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -3117,6 +3299,22 @@ export declare namespace ContractGetEditHistoryResponse {
3117
3299
  */
3118
3300
  product_tags?: Array<string>;
3119
3301
  }
3302
+ /**
3303
+ * Attach a subscription to the recurring commit/credit.
3304
+ */
3305
+ interface SubscriptionConfig {
3306
+ allocation: 'INDIVIDUAL' | 'POOLED';
3307
+ apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
3308
+ subscription_id: string;
3309
+ }
3310
+ namespace SubscriptionConfig {
3311
+ interface ApplySeatIncreaseConfig {
3312
+ /**
3313
+ * Indicates whether a mid-period seat increase should be prorated.
3314
+ */
3315
+ is_prorated: boolean;
3316
+ }
3317
+ }
3120
3318
  }
3121
3319
  interface AddResellerRoyalty {
3122
3320
  reseller_type: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
@@ -3319,6 +3517,10 @@ export declare namespace ContractGetEditHistoryResponse {
3319
3517
  * all products.
3320
3518
  */
3321
3519
  applicable_product_tags?: Array<string> | null;
3520
+ /**
3521
+ * Optional configuration for commit hierarchy access control
3522
+ */
3523
+ hierarchy_configuration?: UpdateCommit.HierarchyConfiguration;
3322
3524
  invoice_schedule?: UpdateCommit.InvoiceSchedule;
3323
3525
  name?: string;
3324
3526
  netsuite_sales_order_id?: string | null;
@@ -3329,6 +3531,8 @@ export declare namespace ContractGetEditHistoryResponse {
3329
3531
  * or credit. A customer's usage needs to meet the condition of at least one of the
3330
3532
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
3331
3533
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
3534
+ * Instead, to target usage by product or product tag, pass those values in the
3535
+ * body of `specifiers`.
3332
3536
  */
3333
3537
  specifiers?: Array<UpdateCommit.Specifier> | null;
3334
3538
  }
@@ -3366,6 +3570,24 @@ export declare namespace ContractGetEditHistoryResponse {
3366
3570
  starting_at?: string;
3367
3571
  }
3368
3572
  }
3573
+ /**
3574
+ * Optional configuration for commit hierarchy access control
3575
+ */
3576
+ interface HierarchyConfiguration {
3577
+ child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
3578
+ }
3579
+ namespace HierarchyConfiguration {
3580
+ interface CommitHierarchyChildAccessAll {
3581
+ type: 'ALL';
3582
+ }
3583
+ interface CommitHierarchyChildAccessNone {
3584
+ type: 'NONE';
3585
+ }
3586
+ interface CommitHierarchyChildAccessContractIDs {
3587
+ contract_ids: Array<string>;
3588
+ type: 'CONTRACT_IDS';
3589
+ }
3590
+ }
3369
3591
  interface InvoiceSchedule {
3370
3592
  add_schedule_items?: Array<InvoiceSchedule.AddScheduleItem>;
3371
3593
  remove_schedule_items?: Array<InvoiceSchedule.RemoveScheduleItem>;
@@ -3410,6 +3632,10 @@ export declare namespace ContractGetEditHistoryResponse {
3410
3632
  interface UpdateCredit {
3411
3633
  id: string;
3412
3634
  access_schedule?: UpdateCredit.AccessSchedule;
3635
+ /**
3636
+ * Optional configuration for credit hierarchy access control
3637
+ */
3638
+ hierarchy_configuration?: UpdateCredit.HierarchyConfiguration;
3413
3639
  name?: string;
3414
3640
  netsuite_sales_order_id?: string | null;
3415
3641
  rollover_fraction?: number | null;
@@ -3448,6 +3674,24 @@ export declare namespace ContractGetEditHistoryResponse {
3448
3674
  starting_at?: string;
3449
3675
  }
3450
3676
  }
3677
+ /**
3678
+ * Optional configuration for credit hierarchy access control
3679
+ */
3680
+ interface HierarchyConfiguration {
3681
+ child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
3682
+ }
3683
+ namespace HierarchyConfiguration {
3684
+ interface CommitHierarchyChildAccessAll {
3685
+ type: 'ALL';
3686
+ }
3687
+ interface CommitHierarchyChildAccessNone {
3688
+ type: 'NONE';
3689
+ }
3690
+ interface CommitHierarchyChildAccessContractIDs {
3691
+ contract_ids: Array<string>;
3692
+ type: 'CONTRACT_IDS';
3693
+ }
3694
+ }
3451
3695
  }
3452
3696
  interface UpdateDiscount {
3453
3697
  id: string;
@@ -3467,7 +3711,7 @@ export declare namespace ContractGetEditHistoryResponse {
3467
3711
  */
3468
3712
  interface Schedule {
3469
3713
  /**
3470
- * Defaults to USD if not passed. Only USD is supported at this time.
3714
+ * Defaults to USD (cents) if not passed.
3471
3715
  */
3472
3716
  credit_type_id?: string;
3473
3717
  /**
@@ -3596,6 +3840,8 @@ export declare namespace ContractGetEditHistoryResponse {
3596
3840
  * or credit. A customer's usage needs to meet the condition of at least one of the
3597
3841
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
3598
3842
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
3843
+ * Instead, to target usage by product or product tag, pass those values in the
3844
+ * body of `specifiers`.
3599
3845
  */
3600
3846
  specifiers?: Array<Commit.Specifier> | null;
3601
3847
  }
@@ -4037,6 +4283,8 @@ export declare namespace ContractEditParams {
4037
4283
  * or credit. A customer's usage needs to meet the condition of at least one of the
4038
4284
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
4039
4285
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
4286
+ * Instead, to target usage by product or product tag, pass those values in the
4287
+ * body of `specifiers`.
4040
4288
  */
4041
4289
  specifiers?: Array<AddCommit.Specifier>;
4042
4290
  /**
@@ -4094,7 +4342,7 @@ export declare namespace ContractEditParams {
4094
4342
  */
4095
4343
  interface InvoiceSchedule {
4096
4344
  /**
4097
- * Defaults to USD if not passed. Only USD is supported at this time.
4345
+ * Defaults to USD (cents) if not passed.
4098
4346
  */
4099
4347
  credit_type_id?: string;
4100
4348
  /**
@@ -4292,6 +4540,8 @@ export declare namespace ContractEditParams {
4292
4540
  * or credit. A customer's usage needs to meet the condition of at least one of the
4293
4541
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
4294
4542
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
4543
+ * Instead, to target usage by product or product tag, pass those values in the
4544
+ * body of `specifiers`.
4295
4545
  */
4296
4546
  specifiers?: Array<AddCredit.Specifier>;
4297
4547
  }
@@ -4376,7 +4626,7 @@ export declare namespace ContractEditParams {
4376
4626
  */
4377
4627
  interface Schedule {
4378
4628
  /**
4379
- * Defaults to USD if not passed. Only USD is supported at this time.
4629
+ * Defaults to USD (cents) if not passed.
4380
4630
  */
4381
4631
  credit_type_id?: string;
4382
4632
  /**
@@ -4650,6 +4900,8 @@ export declare namespace ContractEditParams {
4650
4900
  * or credit. A customer's usage needs to meet the condition of at least one of the
4651
4901
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
4652
4902
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
4903
+ * Instead, to target usage by product or product tag, pass those values in the
4904
+ * body of `specifiers`.
4653
4905
  */
4654
4906
  specifiers?: Array<Commit.Specifier>;
4655
4907
  }
@@ -4791,7 +5043,7 @@ export declare namespace ContractEditParams {
4791
5043
  */
4792
5044
  ending_before?: string;
4793
5045
  /**
4794
- * Optional configuration for recurring commit/credit hierarchy access control
5046
+ * Optional configuration for recurring credit hierarchy access control
4795
5047
  */
4796
5048
  hierarchy_configuration?: AddRecurringCommit.HierarchyConfiguration;
4797
5049
  /**
@@ -4834,8 +5086,14 @@ export declare namespace ContractEditParams {
4834
5086
  * or credit. A customer's usage needs to meet the condition of at least one of the
4835
5087
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
4836
5088
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
5089
+ * Instead, to target usage by product or product tag, pass those values in the
5090
+ * body of `specifiers`.
4837
5091
  */
4838
5092
  specifiers?: Array<AddRecurringCommit.Specifier>;
5093
+ /**
5094
+ * Attach a subscription to the recurring commit/credit.
5095
+ */
5096
+ subscription_config?: AddRecurringCommit.SubscriptionConfig;
4839
5097
  /**
4840
5098
  * A temporary ID that can be used to reference the recurring commit for commit
4841
5099
  * specific overrides.
@@ -4865,7 +5123,7 @@ export declare namespace ContractEditParams {
4865
5123
  unit?: 'PERIODS';
4866
5124
  }
4867
5125
  /**
4868
- * Optional configuration for recurring commit/credit hierarchy access control
5126
+ * Optional configuration for recurring credit hierarchy access control
4869
5127
  */
4870
5128
  interface HierarchyConfiguration {
4871
5129
  child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -4907,6 +5165,28 @@ export declare namespace ContractEditParams {
4907
5165
  */
4908
5166
  product_tags?: Array<string>;
4909
5167
  }
5168
+ /**
5169
+ * Attach a subscription to the recurring commit/credit.
5170
+ */
5171
+ interface SubscriptionConfig {
5172
+ apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
5173
+ /**
5174
+ * ID of the subscription to configure on the recurring commit/credit.
5175
+ */
5176
+ subscription_id: string;
5177
+ /**
5178
+ * If set to POOLED, allocation added per seat is pooled across the account.
5179
+ */
5180
+ allocation?: 'POOLED';
5181
+ }
5182
+ namespace SubscriptionConfig {
5183
+ interface ApplySeatIncreaseConfig {
5184
+ /**
5185
+ * Indicates whether a mid-period seat increase should be prorated.
5186
+ */
5187
+ is_prorated: boolean;
5188
+ }
5189
+ }
4910
5190
  }
4911
5191
  interface AddRecurringCredit {
4912
5192
  /**
@@ -4945,7 +5225,7 @@ export declare namespace ContractEditParams {
4945
5225
  */
4946
5226
  ending_before?: string;
4947
5227
  /**
4948
- * Optional configuration for recurring commit/credit hierarchy access control
5228
+ * Optional configuration for recurring credit hierarchy access control
4949
5229
  */
4950
5230
  hierarchy_configuration?: AddRecurringCredit.HierarchyConfiguration;
4951
5231
  /**
@@ -4984,8 +5264,14 @@ export declare namespace ContractEditParams {
4984
5264
  * or credit. A customer's usage needs to meet the condition of at least one of the
4985
5265
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
4986
5266
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
5267
+ * Instead, to target usage by product or product tag, pass those values in the
5268
+ * body of `specifiers`.
4987
5269
  */
4988
5270
  specifiers?: Array<AddRecurringCredit.Specifier>;
5271
+ /**
5272
+ * Attach a subscription to the recurring commit/credit.
5273
+ */
5274
+ subscription_config?: AddRecurringCredit.SubscriptionConfig;
4989
5275
  /**
4990
5276
  * A temporary ID that can be used to reference the recurring commit for commit
4991
5277
  * specific overrides.
@@ -5015,7 +5301,7 @@ export declare namespace ContractEditParams {
5015
5301
  unit?: 'PERIODS';
5016
5302
  }
5017
5303
  /**
5018
- * Optional configuration for recurring commit/credit hierarchy access control
5304
+ * Optional configuration for recurring credit hierarchy access control
5019
5305
  */
5020
5306
  interface HierarchyConfiguration {
5021
5307
  child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -5049,6 +5335,28 @@ export declare namespace ContractEditParams {
5049
5335
  */
5050
5336
  product_tags?: Array<string>;
5051
5337
  }
5338
+ /**
5339
+ * Attach a subscription to the recurring commit/credit.
5340
+ */
5341
+ interface SubscriptionConfig {
5342
+ apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
5343
+ /**
5344
+ * ID of the subscription to configure on the recurring commit/credit.
5345
+ */
5346
+ subscription_id: string;
5347
+ /**
5348
+ * If set to POOLED, allocation added per seat is pooled across the account.
5349
+ */
5350
+ allocation?: 'POOLED';
5351
+ }
5352
+ namespace SubscriptionConfig {
5353
+ interface ApplySeatIncreaseConfig {
5354
+ /**
5355
+ * Indicates whether a mid-period seat increase should be prorated.
5356
+ */
5357
+ is_prorated: boolean;
5358
+ }
5359
+ }
5052
5360
  }
5053
5361
  interface AddResellerRoyalty {
5054
5362
  reseller_type: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
@@ -5103,7 +5411,7 @@ export declare namespace ContractEditParams {
5103
5411
  */
5104
5412
  interface Schedule {
5105
5413
  /**
5106
- * Defaults to USD if not passed. Only USD is supported at this time.
5414
+ * Defaults to USD (cents) if not passed.
5107
5415
  */
5108
5416
  credit_type_id?: string;
5109
5417
  /**
@@ -5285,14 +5593,20 @@ export declare namespace ContractEditParams {
5285
5593
  * start date
5286
5594
  */
5287
5595
  starting_at?: string;
5596
+ /**
5597
+ * A temporary ID used to reference the subscription in recurring commit/credit
5598
+ * subscription configs created within the same payload.
5599
+ */
5600
+ temporary_id?: string;
5288
5601
  }
5289
5602
  namespace AddSubscription {
5290
5603
  interface Proration {
5291
5604
  /**
5292
- * Indicates how mid-period quantity adjustments are invoiced. If BILL_IMMEDIATELY
5293
- * is selected, the quantity increase will be billed on the scheduled date. If
5294
- * BILL_ON_NEXT_COLLECTION_DATE is selected, the quantity increase will be billed
5295
- * for in-arrears at the end of the period.
5605
+ * Indicates how mid-period quantity adjustments are invoiced.
5606
+ * **BILL_IMMEDIATELY**: Only available when collection schedule is `ADVANCE`. The
5607
+ * quantity increase will be billed immediately on the scheduled date.
5608
+ * **BILL_ON_NEXT_COLLECTION_DATE**: The quantity increase will be billed for
5609
+ * in-arrears at the end of the period.
5296
5610
  */
5297
5611
  invoice_behavior?: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
5298
5612
  /**
@@ -5528,6 +5842,8 @@ export declare namespace ContractEditParams {
5528
5842
  * or credit. A customer's usage needs to meet the condition of at least one of the
5529
5843
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
5530
5844
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
5845
+ * Instead, to target usage by product or product tag, pass those values in the
5846
+ * body of `specifiers`.
5531
5847
  */
5532
5848
  specifiers?: Array<Commit.Specifier> | null;
5533
5849
  }
@@ -5810,6 +6126,8 @@ export interface ContractEditCommitParams {
5810
6126
  * or credit. A customer's usage needs to meet the condition of at least one of the
5811
6127
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
5812
6128
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
6129
+ * Instead, to target usage by product or product tag, pass those values in the
6130
+ * body of `specifiers`.
5813
6131
  */
5814
6132
  specifiers?: Array<ContractEditCommitParams.Specifier> | null;
5815
6133
  }
@@ -5902,6 +6220,8 @@ export interface ContractEditCreditParams {
5902
6220
  * or credit. A customer's usage needs to meet the condition of at least one of the
5903
6221
  * specifiers to contribute to a commit's or credit's drawdown. This field cannot
5904
6222
  * be used together with `applicable_product_ids` or `applicable_product_tags`.
6223
+ * Instead, to target usage by product or product tag, pass those values in the
6224
+ * body of `specifiers`.
5905
6225
  */
5906
6226
  specifiers?: Array<ContractEditCreditParams.Specifier> | null;
5907
6227
  }