orb-billing 4.72.3 → 4.74.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.
Files changed (138) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/README.md +18 -30
  3. package/index.d.mts +7 -4
  4. package/index.d.ts +7 -4
  5. package/index.d.ts.map +1 -1
  6. package/index.js +3 -0
  7. package/index.js.map +1 -1
  8. package/index.mjs +3 -0
  9. package/index.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/alerts.d.ts +18 -0
  12. package/resources/alerts.d.ts.map +1 -1
  13. package/resources/alerts.js.map +1 -1
  14. package/resources/alerts.mjs.map +1 -1
  15. package/resources/beta/beta.d.ts +7492 -0
  16. package/resources/beta/beta.d.ts.map +1 -0
  17. package/resources/beta/beta.js +67 -0
  18. package/resources/beta/beta.js.map +1 -0
  19. package/resources/beta/beta.mjs +40 -0
  20. package/resources/beta/beta.mjs.map +1 -0
  21. package/resources/beta/external-plan-id.d.ts +7218 -0
  22. package/resources/beta/external-plan-id.d.ts.map +1 -0
  23. package/resources/beta/external-plan-id.js +40 -0
  24. package/resources/beta/external-plan-id.js.map +1 -0
  25. package/resources/beta/external-plan-id.mjs +36 -0
  26. package/resources/beta/external-plan-id.mjs.map +1 -0
  27. package/resources/beta/index.d.ts +3 -0
  28. package/resources/beta/index.d.ts.map +1 -0
  29. package/resources/beta/index.js +9 -0
  30. package/resources/beta/index.js.map +1 -0
  31. package/resources/beta/index.mjs +4 -0
  32. package/resources/beta/index.mjs.map +1 -0
  33. package/resources/beta.d.ts +2 -0
  34. package/resources/beta.d.ts.map +1 -0
  35. package/resources/beta.js +19 -0
  36. package/resources/beta.js.map +1 -0
  37. package/resources/beta.mjs +3 -0
  38. package/resources/beta.mjs.map +1 -0
  39. package/resources/credit-notes.d.ts +4 -4
  40. package/resources/credit-notes.d.ts.map +1 -1
  41. package/resources/customers/balance-transactions.d.ts +0 -7
  42. package/resources/customers/balance-transactions.d.ts.map +1 -1
  43. package/resources/customers/balance-transactions.js.map +1 -1
  44. package/resources/customers/balance-transactions.mjs.map +1 -1
  45. package/resources/customers/credits/ledger.d.ts +17 -0
  46. package/resources/customers/credits/ledger.d.ts.map +1 -1
  47. package/resources/customers/credits/ledger.js.map +1 -1
  48. package/resources/customers/credits/ledger.mjs.map +1 -1
  49. package/resources/customers/credits/top-ups.d.ts +26 -14
  50. package/resources/customers/credits/top-ups.d.ts.map +1 -1
  51. package/resources/customers/credits/top-ups.js.map +1 -1
  52. package/resources/customers/credits/top-ups.mjs.map +1 -1
  53. package/resources/customers/customers.d.ts +16 -7
  54. package/resources/customers/customers.d.ts.map +1 -1
  55. package/resources/customers/customers.js +1 -4
  56. package/resources/customers/customers.js.map +1 -1
  57. package/resources/customers/customers.mjs +1 -4
  58. package/resources/customers/customers.mjs.map +1 -1
  59. package/resources/dimensional-price-groups/dimensional-price-groups.d.ts +1 -1
  60. package/resources/dimensional-price-groups/dimensional-price-groups.js +1 -1
  61. package/resources/dimensional-price-groups/dimensional-price-groups.mjs +1 -1
  62. package/resources/events/events.d.ts +3 -3
  63. package/resources/events/events.d.ts.map +1 -1
  64. package/resources/index.d.ts +3 -2
  65. package/resources/index.d.ts.map +1 -1
  66. package/resources/index.js +3 -1
  67. package/resources/index.js.map +1 -1
  68. package/resources/index.mjs +1 -0
  69. package/resources/index.mjs.map +1 -1
  70. package/resources/invoice-line-items.d.ts +150 -10
  71. package/resources/invoice-line-items.d.ts.map +1 -1
  72. package/resources/invoices.d.ts +388 -28
  73. package/resources/invoices.d.ts.map +1 -1
  74. package/resources/invoices.js.map +1 -1
  75. package/resources/invoices.mjs.map +1 -1
  76. package/resources/items.d.ts +23 -0
  77. package/resources/items.d.ts.map +1 -1
  78. package/resources/items.js +6 -0
  79. package/resources/items.js.map +1 -1
  80. package/resources/items.mjs +6 -0
  81. package/resources/items.mjs.map +1 -1
  82. package/resources/plans/external-plan-id.d.ts +1 -1
  83. package/resources/plans/external-plan-id.js +1 -1
  84. package/resources/plans/external-plan-id.mjs +1 -1
  85. package/resources/plans/plans.d.ts +1153 -22
  86. package/resources/plans/plans.d.ts.map +1 -1
  87. package/resources/plans/plans.js +1 -1
  88. package/resources/plans/plans.js.map +1 -1
  89. package/resources/plans/plans.mjs +1 -1
  90. package/resources/plans/plans.mjs.map +1 -1
  91. package/resources/prices/index.d.ts +1 -1
  92. package/resources/prices/index.d.ts.map +1 -1
  93. package/resources/prices/index.js.map +1 -1
  94. package/resources/prices/index.mjs.map +1 -1
  95. package/resources/prices/prices.d.ts +6180 -123
  96. package/resources/prices/prices.d.ts.map +1 -1
  97. package/resources/prices/prices.js +40 -1
  98. package/resources/prices/prices.js.map +1 -1
  99. package/resources/prices/prices.mjs +40 -1
  100. package/resources/prices/prices.mjs.map +1 -1
  101. package/resources/shared.d.ts +14 -14
  102. package/resources/shared.d.ts.map +1 -1
  103. package/resources/subscription-changes.d.ts +648 -87
  104. package/resources/subscription-changes.d.ts.map +1 -1
  105. package/resources/subscriptions.d.ts +10981 -3716
  106. package/resources/subscriptions.d.ts.map +1 -1
  107. package/resources/subscriptions.js +6 -0
  108. package/resources/subscriptions.js.map +1 -1
  109. package/resources/subscriptions.mjs +6 -0
  110. package/resources/subscriptions.mjs.map +1 -1
  111. package/src/index.ts +25 -0
  112. package/src/resources/alerts.ts +21 -0
  113. package/src/resources/beta/beta.ts +9106 -0
  114. package/src/resources/beta/external-plan-id.ts +8748 -0
  115. package/src/resources/beta/index.ts +14 -0
  116. package/src/resources/beta.ts +3 -0
  117. package/src/resources/credit-notes.ts +4 -4
  118. package/src/resources/customers/balance-transactions.ts +0 -7
  119. package/src/resources/customers/credits/ledger.ts +21 -0
  120. package/src/resources/customers/credits/top-ups.ts +26 -14
  121. package/src/resources/customers/customers.ts +22 -4
  122. package/src/resources/dimensional-price-groups/dimensional-price-groups.ts +1 -1
  123. package/src/resources/events/events.ts +3 -3
  124. package/src/resources/index.ts +11 -0
  125. package/src/resources/invoice-line-items.ts +178 -10
  126. package/src/resources/invoices.ts +460 -28
  127. package/src/resources/items.ts +29 -0
  128. package/src/resources/plans/external-plan-id.ts +1 -1
  129. package/src/resources/plans/plans.ts +1375 -30
  130. package/src/resources/prices/index.ts +2 -0
  131. package/src/resources/prices/prices.ts +7345 -135
  132. package/src/resources/shared.ts +18 -18
  133. package/src/resources/subscription-changes.ts +771 -102
  134. package/src/resources/subscriptions.ts +13383 -4686
  135. package/src/version.ts +1 -1
  136. package/version.d.ts +1 -1
  137. package/version.js +1 -1
  138. package/version.mjs +1 -1
@@ -36,6 +36,13 @@ export class Items extends APIResource {
36
36
  return this._client.getAPIList('/items', ItemsPage, { query, ...options });
37
37
  }
38
38
 
39
+ /**
40
+ * Archive item
41
+ */
42
+ archive(itemId: string, options?: Core.RequestOptions): Core.APIPromise<Item> {
43
+ return this._client.post(`/items/${itemId}/archive`, options);
44
+ }
45
+
39
46
  /**
40
47
  * This endpoint returns an item identified by its item_id.
41
48
  */
@@ -58,6 +65,14 @@ export interface Item {
58
65
 
59
66
  external_connections: Array<Item.ExternalConnection>;
60
67
 
68
+ /**
69
+ * User specified key-value pairs for the resource. If not present, this defaults
70
+ * to an empty dictionary. Individual keys can be removed by setting the value to
71
+ * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
72
+ * `null`.
73
+ */
74
+ metadata: Record<string, string>;
75
+
61
76
  name: string;
62
77
  }
63
78
 
@@ -81,11 +96,25 @@ export interface ItemCreateParams {
81
96
  * The name of the item.
82
97
  */
83
98
  name: string;
99
+
100
+ /**
101
+ * User-specified key/value pairs for the resource. Individual keys can be removed
102
+ * by setting the value to `null`, and the entire metadata mapping can be cleared
103
+ * by setting `metadata` to `null`.
104
+ */
105
+ metadata?: Record<string, string | null> | null;
84
106
  }
85
107
 
86
108
  export interface ItemUpdateParams {
87
109
  external_connections?: Array<ItemUpdateParams.ExternalConnection> | null;
88
110
 
111
+ /**
112
+ * User-specified key/value pairs for the resource. Individual keys can be removed
113
+ * by setting the value to `null`, and the entire metadata mapping can be cleared
114
+ * by setting `metadata` to `null`.
115
+ */
116
+ metadata?: Record<string, string | null> | null;
117
+
89
118
  name?: string | null;
90
119
  }
91
120
 
@@ -9,7 +9,7 @@ export class ExternalPlanID extends APIResource {
9
9
  * This endpoint can be used to update the `external_plan_id`, and `metadata` of an
10
10
  * existing plan.
11
11
  *
12
- * Other fields on a customer are currently immutable.
12
+ * Other fields on a plan are currently immutable.
13
13
  */
14
14
  update(
15
15
  otherExternalPlanId: string,