@polar-sh/sdk 0.40.3 → 0.41.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 (244) hide show
  1. package/README.md +1 -1
  2. package/dist/commonjs/funcs/eventsList.js +1 -0
  3. package/dist/commonjs/funcs/eventsList.js.map +1 -1
  4. package/dist/commonjs/lib/config.d.ts +3 -3
  5. package/dist/commonjs/lib/config.js +3 -3
  6. package/dist/commonjs/models/components/benefitcycledevent.d.ts +5 -0
  7. package/dist/commonjs/models/components/benefitcycledevent.d.ts.map +1 -1
  8. package/dist/commonjs/models/components/benefitcycledevent.js +4 -0
  9. package/dist/commonjs/models/components/benefitcycledevent.js.map +1 -1
  10. package/dist/commonjs/models/components/benefitgrantedevent.d.ts +5 -0
  11. package/dist/commonjs/models/components/benefitgrantedevent.d.ts.map +1 -1
  12. package/dist/commonjs/models/components/benefitgrantedevent.js +4 -0
  13. package/dist/commonjs/models/components/benefitgrantedevent.js.map +1 -1
  14. package/dist/commonjs/models/components/benefitrevokedevent.d.ts +5 -0
  15. package/dist/commonjs/models/components/benefitrevokedevent.d.ts.map +1 -1
  16. package/dist/commonjs/models/components/benefitrevokedevent.js +4 -0
  17. package/dist/commonjs/models/components/benefitrevokedevent.js.map +1 -1
  18. package/dist/commonjs/models/components/benefitupdatedevent.d.ts +5 -0
  19. package/dist/commonjs/models/components/benefitupdatedevent.d.ts.map +1 -1
  20. package/dist/commonjs/models/components/benefitupdatedevent.js +4 -0
  21. package/dist/commonjs/models/components/benefitupdatedevent.js.map +1 -1
  22. package/dist/commonjs/models/components/customercreate.d.ts +0 -3
  23. package/dist/commonjs/models/components/customercreate.d.ts.map +1 -1
  24. package/dist/commonjs/models/components/customercreate.js.map +1 -1
  25. package/dist/commonjs/models/components/customercreatedevent.d.ts +5 -0
  26. package/dist/commonjs/models/components/customercreatedevent.d.ts.map +1 -1
  27. package/dist/commonjs/models/components/customercreatedevent.js +4 -0
  28. package/dist/commonjs/models/components/customercreatedevent.js.map +1 -1
  29. package/dist/commonjs/models/components/customerdeletedevent.d.ts +5 -0
  30. package/dist/commonjs/models/components/customerdeletedevent.d.ts.map +1 -1
  31. package/dist/commonjs/models/components/customerdeletedevent.js +4 -0
  32. package/dist/commonjs/models/components/customerdeletedevent.js.map +1 -1
  33. package/dist/commonjs/models/components/customerupdate.d.ts +0 -3
  34. package/dist/commonjs/models/components/customerupdate.d.ts.map +1 -1
  35. package/dist/commonjs/models/components/customerupdate.js.map +1 -1
  36. package/dist/commonjs/models/components/customerupdatedevent.d.ts +5 -0
  37. package/dist/commonjs/models/components/customerupdatedevent.d.ts.map +1 -1
  38. package/dist/commonjs/models/components/customerupdatedevent.js +4 -0
  39. package/dist/commonjs/models/components/customerupdatedevent.js.map +1 -1
  40. package/dist/commonjs/models/components/customerupdateexternalid.d.ts +0 -3
  41. package/dist/commonjs/models/components/customerupdateexternalid.d.ts.map +1 -1
  42. package/dist/commonjs/models/components/customerupdateexternalid.js.map +1 -1
  43. package/dist/commonjs/models/components/eventcreatecustomer.d.ts +10 -0
  44. package/dist/commonjs/models/components/eventcreatecustomer.d.ts.map +1 -1
  45. package/dist/commonjs/models/components/eventcreatecustomer.js +8 -0
  46. package/dist/commonjs/models/components/eventcreatecustomer.js.map +1 -1
  47. package/dist/commonjs/models/components/eventcreateexternalcustomer.d.ts +10 -0
  48. package/dist/commonjs/models/components/eventcreateexternalcustomer.d.ts.map +1 -1
  49. package/dist/commonjs/models/components/eventcreateexternalcustomer.js +8 -0
  50. package/dist/commonjs/models/components/eventcreateexternalcustomer.js.map +1 -1
  51. package/dist/commonjs/models/components/eventsingestresponse.d.ts +5 -0
  52. package/dist/commonjs/models/components/eventsingestresponse.d.ts.map +1 -1
  53. package/dist/commonjs/models/components/eventsingestresponse.js +2 -0
  54. package/dist/commonjs/models/components/eventsingestresponse.js.map +1 -1
  55. package/dist/commonjs/models/components/metercreditevent.d.ts +5 -0
  56. package/dist/commonjs/models/components/metercreditevent.d.ts.map +1 -1
  57. package/dist/commonjs/models/components/metercreditevent.js +4 -0
  58. package/dist/commonjs/models/components/metercreditevent.js.map +1 -1
  59. package/dist/commonjs/models/components/meterresetevent.d.ts +5 -0
  60. package/dist/commonjs/models/components/meterresetevent.d.ts.map +1 -1
  61. package/dist/commonjs/models/components/meterresetevent.js +4 -0
  62. package/dist/commonjs/models/components/meterresetevent.js.map +1 -1
  63. package/dist/commonjs/models/components/orderpaidevent.d.ts +5 -0
  64. package/dist/commonjs/models/components/orderpaidevent.d.ts.map +1 -1
  65. package/dist/commonjs/models/components/orderpaidevent.js +4 -0
  66. package/dist/commonjs/models/components/orderpaidevent.js.map +1 -1
  67. package/dist/commonjs/models/components/orderrefundedevent.d.ts +5 -0
  68. package/dist/commonjs/models/components/orderrefundedevent.d.ts.map +1 -1
  69. package/dist/commonjs/models/components/orderrefundedevent.js +4 -0
  70. package/dist/commonjs/models/components/orderrefundedevent.js.map +1 -1
  71. package/dist/commonjs/models/components/subscriptioncycledevent.d.ts +5 -0
  72. package/dist/commonjs/models/components/subscriptioncycledevent.d.ts.map +1 -1
  73. package/dist/commonjs/models/components/subscriptioncycledevent.js +4 -0
  74. package/dist/commonjs/models/components/subscriptioncycledevent.js.map +1 -1
  75. package/dist/commonjs/models/components/subscriptionproductupdatedevent.d.ts +5 -0
  76. package/dist/commonjs/models/components/subscriptionproductupdatedevent.d.ts.map +1 -1
  77. package/dist/commonjs/models/components/subscriptionproductupdatedevent.js +4 -0
  78. package/dist/commonjs/models/components/subscriptionproductupdatedevent.js.map +1 -1
  79. package/dist/commonjs/models/components/subscriptionrevokedevent.d.ts +5 -0
  80. package/dist/commonjs/models/components/subscriptionrevokedevent.d.ts.map +1 -1
  81. package/dist/commonjs/models/components/subscriptionrevokedevent.js +4 -0
  82. package/dist/commonjs/models/components/subscriptionrevokedevent.js.map +1 -1
  83. package/dist/commonjs/models/components/userevent.d.ts +5 -0
  84. package/dist/commonjs/models/components/userevent.d.ts.map +1 -1
  85. package/dist/commonjs/models/components/userevent.js +4 -0
  86. package/dist/commonjs/models/components/userevent.js.map +1 -1
  87. package/dist/commonjs/models/operations/eventslist.d.ts +5 -0
  88. package/dist/commonjs/models/operations/eventslist.d.ts.map +1 -1
  89. package/dist/commonjs/models/operations/eventslist.js +4 -0
  90. package/dist/commonjs/models/operations/eventslist.js.map +1 -1
  91. package/dist/esm/funcs/eventsList.js +1 -0
  92. package/dist/esm/funcs/eventsList.js.map +1 -1
  93. package/dist/esm/lib/config.d.ts +3 -3
  94. package/dist/esm/lib/config.js +3 -3
  95. package/dist/esm/models/components/benefitcycledevent.d.ts +5 -0
  96. package/dist/esm/models/components/benefitcycledevent.d.ts.map +1 -1
  97. package/dist/esm/models/components/benefitcycledevent.js +4 -0
  98. package/dist/esm/models/components/benefitcycledevent.js.map +1 -1
  99. package/dist/esm/models/components/benefitgrantedevent.d.ts +5 -0
  100. package/dist/esm/models/components/benefitgrantedevent.d.ts.map +1 -1
  101. package/dist/esm/models/components/benefitgrantedevent.js +4 -0
  102. package/dist/esm/models/components/benefitgrantedevent.js.map +1 -1
  103. package/dist/esm/models/components/benefitrevokedevent.d.ts +5 -0
  104. package/dist/esm/models/components/benefitrevokedevent.d.ts.map +1 -1
  105. package/dist/esm/models/components/benefitrevokedevent.js +4 -0
  106. package/dist/esm/models/components/benefitrevokedevent.js.map +1 -1
  107. package/dist/esm/models/components/benefitupdatedevent.d.ts +5 -0
  108. package/dist/esm/models/components/benefitupdatedevent.d.ts.map +1 -1
  109. package/dist/esm/models/components/benefitupdatedevent.js +4 -0
  110. package/dist/esm/models/components/benefitupdatedevent.js.map +1 -1
  111. package/dist/esm/models/components/customercreate.d.ts +0 -3
  112. package/dist/esm/models/components/customercreate.d.ts.map +1 -1
  113. package/dist/esm/models/components/customercreate.js.map +1 -1
  114. package/dist/esm/models/components/customercreatedevent.d.ts +5 -0
  115. package/dist/esm/models/components/customercreatedevent.d.ts.map +1 -1
  116. package/dist/esm/models/components/customercreatedevent.js +4 -0
  117. package/dist/esm/models/components/customercreatedevent.js.map +1 -1
  118. package/dist/esm/models/components/customerdeletedevent.d.ts +5 -0
  119. package/dist/esm/models/components/customerdeletedevent.d.ts.map +1 -1
  120. package/dist/esm/models/components/customerdeletedevent.js +4 -0
  121. package/dist/esm/models/components/customerdeletedevent.js.map +1 -1
  122. package/dist/esm/models/components/customerupdate.d.ts +0 -3
  123. package/dist/esm/models/components/customerupdate.d.ts.map +1 -1
  124. package/dist/esm/models/components/customerupdate.js.map +1 -1
  125. package/dist/esm/models/components/customerupdatedevent.d.ts +5 -0
  126. package/dist/esm/models/components/customerupdatedevent.d.ts.map +1 -1
  127. package/dist/esm/models/components/customerupdatedevent.js +4 -0
  128. package/dist/esm/models/components/customerupdatedevent.js.map +1 -1
  129. package/dist/esm/models/components/customerupdateexternalid.d.ts +0 -3
  130. package/dist/esm/models/components/customerupdateexternalid.d.ts.map +1 -1
  131. package/dist/esm/models/components/customerupdateexternalid.js.map +1 -1
  132. package/dist/esm/models/components/eventcreatecustomer.d.ts +10 -0
  133. package/dist/esm/models/components/eventcreatecustomer.d.ts.map +1 -1
  134. package/dist/esm/models/components/eventcreatecustomer.js +8 -0
  135. package/dist/esm/models/components/eventcreatecustomer.js.map +1 -1
  136. package/dist/esm/models/components/eventcreateexternalcustomer.d.ts +10 -0
  137. package/dist/esm/models/components/eventcreateexternalcustomer.d.ts.map +1 -1
  138. package/dist/esm/models/components/eventcreateexternalcustomer.js +8 -0
  139. package/dist/esm/models/components/eventcreateexternalcustomer.js.map +1 -1
  140. package/dist/esm/models/components/eventsingestresponse.d.ts +5 -0
  141. package/dist/esm/models/components/eventsingestresponse.d.ts.map +1 -1
  142. package/dist/esm/models/components/eventsingestresponse.js +2 -0
  143. package/dist/esm/models/components/eventsingestresponse.js.map +1 -1
  144. package/dist/esm/models/components/metercreditevent.d.ts +5 -0
  145. package/dist/esm/models/components/metercreditevent.d.ts.map +1 -1
  146. package/dist/esm/models/components/metercreditevent.js +4 -0
  147. package/dist/esm/models/components/metercreditevent.js.map +1 -1
  148. package/dist/esm/models/components/meterresetevent.d.ts +5 -0
  149. package/dist/esm/models/components/meterresetevent.d.ts.map +1 -1
  150. package/dist/esm/models/components/meterresetevent.js +4 -0
  151. package/dist/esm/models/components/meterresetevent.js.map +1 -1
  152. package/dist/esm/models/components/orderpaidevent.d.ts +5 -0
  153. package/dist/esm/models/components/orderpaidevent.d.ts.map +1 -1
  154. package/dist/esm/models/components/orderpaidevent.js +4 -0
  155. package/dist/esm/models/components/orderpaidevent.js.map +1 -1
  156. package/dist/esm/models/components/orderrefundedevent.d.ts +5 -0
  157. package/dist/esm/models/components/orderrefundedevent.d.ts.map +1 -1
  158. package/dist/esm/models/components/orderrefundedevent.js +4 -0
  159. package/dist/esm/models/components/orderrefundedevent.js.map +1 -1
  160. package/dist/esm/models/components/subscriptioncycledevent.d.ts +5 -0
  161. package/dist/esm/models/components/subscriptioncycledevent.d.ts.map +1 -1
  162. package/dist/esm/models/components/subscriptioncycledevent.js +4 -0
  163. package/dist/esm/models/components/subscriptioncycledevent.js.map +1 -1
  164. package/dist/esm/models/components/subscriptionproductupdatedevent.d.ts +5 -0
  165. package/dist/esm/models/components/subscriptionproductupdatedevent.d.ts.map +1 -1
  166. package/dist/esm/models/components/subscriptionproductupdatedevent.js +4 -0
  167. package/dist/esm/models/components/subscriptionproductupdatedevent.js.map +1 -1
  168. package/dist/esm/models/components/subscriptionrevokedevent.d.ts +5 -0
  169. package/dist/esm/models/components/subscriptionrevokedevent.d.ts.map +1 -1
  170. package/dist/esm/models/components/subscriptionrevokedevent.js +4 -0
  171. package/dist/esm/models/components/subscriptionrevokedevent.js.map +1 -1
  172. package/dist/esm/models/components/userevent.d.ts +5 -0
  173. package/dist/esm/models/components/userevent.d.ts.map +1 -1
  174. package/dist/esm/models/components/userevent.js +4 -0
  175. package/dist/esm/models/components/userevent.js.map +1 -1
  176. package/dist/esm/models/operations/eventslist.d.ts +5 -0
  177. package/dist/esm/models/operations/eventslist.d.ts.map +1 -1
  178. package/dist/esm/models/operations/eventslist.js +4 -0
  179. package/dist/esm/models/operations/eventslist.js.map +1 -1
  180. package/examples/package-lock.json +1 -1
  181. package/jsr.json +1 -1
  182. package/package.json +1 -1
  183. package/src/funcs/eventsList.ts +1 -0
  184. package/src/lib/config.ts +3 -3
  185. package/src/models/components/benefitcycledevent.ts +9 -0
  186. package/src/models/components/benefitgrantedevent.ts +9 -0
  187. package/src/models/components/benefitrevokedevent.ts +9 -0
  188. package/src/models/components/benefitupdatedevent.ts +9 -0
  189. package/src/models/components/customercreate.ts +0 -3
  190. package/src/models/components/customercreatedevent.ts +9 -0
  191. package/src/models/components/customerdeletedevent.ts +9 -0
  192. package/src/models/components/customerupdate.ts +0 -3
  193. package/src/models/components/customerupdatedevent.ts +9 -0
  194. package/src/models/components/customerupdateexternalid.ts +0 -3
  195. package/src/models/components/eventcreatecustomer.ts +18 -0
  196. package/src/models/components/eventcreateexternalcustomer.ts +18 -0
  197. package/src/models/components/eventsingestresponse.ts +7 -0
  198. package/src/models/components/metercreditevent.ts +9 -0
  199. package/src/models/components/meterresetevent.ts +9 -0
  200. package/src/models/components/orderpaidevent.ts +9 -0
  201. package/src/models/components/orderrefundedevent.ts +9 -0
  202. package/src/models/components/subscriptioncycledevent.ts +9 -0
  203. package/src/models/components/subscriptionproductupdatedevent.ts +9 -0
  204. package/src/models/components/subscriptionrevokedevent.ts +9 -0
  205. package/src/models/components/userevent.ts +9 -0
  206. package/src/models/operations/eventslist.ts +9 -0
  207. package/.devcontainer/README.md +0 -35
  208. package/docs/sdks/benefitgrants/README.md +0 -88
  209. package/docs/sdks/benefits/README.md +0 -500
  210. package/docs/sdks/checkoutlinks/README.md +0 -407
  211. package/docs/sdks/checkouts/README.md +0 -600
  212. package/docs/sdks/clients/README.md +0 -331
  213. package/docs/sdks/customermeters/README.md +0 -166
  214. package/docs/sdks/customers/README.md +0 -1036
  215. package/docs/sdks/customerseats/README.md +0 -441
  216. package/docs/sdks/customersession/README.md +0 -79
  217. package/docs/sdks/customersessions/README.md +0 -84
  218. package/docs/sdks/customfields/README.md +0 -417
  219. package/docs/sdks/discounts/README.md +0 -409
  220. package/docs/sdks/downloadables/README.md +0 -83
  221. package/docs/sdks/events/README.md +0 -324
  222. package/docs/sdks/files/README.md +0 -460
  223. package/docs/sdks/licensekeys/README.md +0 -576
  224. package/docs/sdks/meters/README.md +0 -437
  225. package/docs/sdks/metrics/README.md +0 -165
  226. package/docs/sdks/oauth2/README.md +0 -371
  227. package/docs/sdks/orders/README.md +0 -489
  228. package/docs/sdks/organizations/README.md +0 -322
  229. package/docs/sdks/payments/README.md +0 -166
  230. package/docs/sdks/polarbenefitgrants/README.md +0 -250
  231. package/docs/sdks/polarcustomermeters/README.md +0 -164
  232. package/docs/sdks/polarcustomers/README.md +0 -482
  233. package/docs/sdks/polarlicensekeys/README.md +0 -406
  234. package/docs/sdks/polarorders/README.md +0 -574
  235. package/docs/sdks/polarorganizations/README.md +0 -79
  236. package/docs/sdks/polarsubscriptions/README.md +0 -326
  237. package/docs/sdks/polarwallets/README.md +0 -164
  238. package/docs/sdks/products/README.md +0 -441
  239. package/docs/sdks/refunds/README.md +0 -171
  240. package/docs/sdks/seats/README.md +0 -379
  241. package/docs/sdks/subscriptions/README.md +0 -493
  242. package/docs/sdks/wallets/README.md +0 -256
  243. package/docs/sdks/webhooks/README.md +0 -650
  244. package/examples/README.md +0 -31
@@ -1,437 +0,0 @@
1
- # Meters
2
- (*meters*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [list](#list) - List Meters
9
- * [create](#create) - Create Meter
10
- * [get](#get) - Get Meter
11
- * [update](#update) - Update Meter
12
- * [quantities](#quantities) - Get Meter Quantities
13
-
14
- ## list
15
-
16
- List meters.
17
-
18
- **Scopes**: `meters:read` `meters:write`
19
-
20
- ### Example Usage
21
-
22
- <!-- UsageSnippet language="typescript" operationID="meters:list" method="get" path="/v1/meters/" -->
23
- ```typescript
24
- import { Polar } from "@polar-sh/sdk";
25
-
26
- const polar = new Polar({
27
- accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
28
- });
29
-
30
- async function run() {
31
- const result = await polar.meters.list({
32
- organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
33
- });
34
-
35
- for await (const page of result) {
36
- console.log(page);
37
- }
38
- }
39
-
40
- run();
41
- ```
42
-
43
- ### Standalone function
44
-
45
- The standalone function version of this method:
46
-
47
- ```typescript
48
- import { PolarCore } from "@polar-sh/sdk/core.js";
49
- import { metersList } from "@polar-sh/sdk/funcs/metersList.js";
50
-
51
- // Use `PolarCore` for best tree-shaking performance.
52
- // You can create one instance of it to use across an application.
53
- const polar = new PolarCore({
54
- accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
55
- });
56
-
57
- async function run() {
58
- const res = await metersList(polar, {
59
- organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
60
- });
61
- if (res.ok) {
62
- const { value: result } = res;
63
- for await (const page of result) {
64
- console.log(page);
65
- }
66
- } else {
67
- console.log("metersList failed:", res.error);
68
- }
69
- }
70
-
71
- run();
72
- ```
73
-
74
- ### Parameters
75
-
76
- | Parameter | Type | Required | Description |
77
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
78
- | `request` | [operations.MetersListRequest](../../models/operations/meterslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
79
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
80
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
81
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
82
-
83
- ### Response
84
-
85
- **Promise\<[operations.MetersListResponse](../../models/operations/meterslistresponse.md)\>**
86
-
87
- ### Errors
88
-
89
- | Error Type | Status Code | Content Type |
90
- | -------------------------- | -------------------------- | -------------------------- |
91
- | errors.HTTPValidationError | 422 | application/json |
92
- | errors.SDKError | 4XX, 5XX | \*/\* |
93
-
94
- ## create
95
-
96
- Create a meter.
97
-
98
- **Scopes**: `meters:write`
99
-
100
- ### Example Usage
101
-
102
- <!-- UsageSnippet language="typescript" operationID="meters:create" method="post" path="/v1/meters/" -->
103
- ```typescript
104
- import { Polar } from "@polar-sh/sdk";
105
-
106
- const polar = new Polar({
107
- accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
108
- });
109
-
110
- async function run() {
111
- const result = await polar.meters.create({
112
- name: "<value>",
113
- filter: {
114
- conjunction: "or",
115
- clauses: [
116
- {
117
- property: "<value>",
118
- operator: "ne",
119
- value: "<value>",
120
- },
121
- ],
122
- },
123
- aggregation: {
124
- func: "max",
125
- property: "<value>",
126
- },
127
- organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
128
- });
129
-
130
- console.log(result);
131
- }
132
-
133
- run();
134
- ```
135
-
136
- ### Standalone function
137
-
138
- The standalone function version of this method:
139
-
140
- ```typescript
141
- import { PolarCore } from "@polar-sh/sdk/core.js";
142
- import { metersCreate } from "@polar-sh/sdk/funcs/metersCreate.js";
143
-
144
- // Use `PolarCore` for best tree-shaking performance.
145
- // You can create one instance of it to use across an application.
146
- const polar = new PolarCore({
147
- accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
148
- });
149
-
150
- async function run() {
151
- const res = await metersCreate(polar, {
152
- name: "<value>",
153
- filter: {
154
- conjunction: "or",
155
- clauses: [
156
- {
157
- property: "<value>",
158
- operator: "ne",
159
- value: "<value>",
160
- },
161
- ],
162
- },
163
- aggregation: {
164
- func: "max",
165
- property: "<value>",
166
- },
167
- organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
168
- });
169
- if (res.ok) {
170
- const { value: result } = res;
171
- console.log(result);
172
- } else {
173
- console.log("metersCreate failed:", res.error);
174
- }
175
- }
176
-
177
- run();
178
- ```
179
-
180
- ### Parameters
181
-
182
- | Parameter | Type | Required | Description |
183
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
184
- | `request` | [components.MeterCreate](../../models/components/metercreate.md) | :heavy_check_mark: | The request object to use for the request. |
185
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
186
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
187
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
188
-
189
- ### Response
190
-
191
- **Promise\<[components.Meter](../../models/components/meter.md)\>**
192
-
193
- ### Errors
194
-
195
- | Error Type | Status Code | Content Type |
196
- | -------------------------- | -------------------------- | -------------------------- |
197
- | errors.HTTPValidationError | 422 | application/json |
198
- | errors.SDKError | 4XX, 5XX | \*/\* |
199
-
200
- ## get
201
-
202
- Get a meter by ID.
203
-
204
- **Scopes**: `meters:read` `meters:write`
205
-
206
- ### Example Usage
207
-
208
- <!-- UsageSnippet language="typescript" operationID="meters:get" method="get" path="/v1/meters/{id}" -->
209
- ```typescript
210
- import { Polar } from "@polar-sh/sdk";
211
-
212
- const polar = new Polar({
213
- accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
214
- });
215
-
216
- async function run() {
217
- const result = await polar.meters.get({
218
- id: "<value>",
219
- });
220
-
221
- console.log(result);
222
- }
223
-
224
- run();
225
- ```
226
-
227
- ### Standalone function
228
-
229
- The standalone function version of this method:
230
-
231
- ```typescript
232
- import { PolarCore } from "@polar-sh/sdk/core.js";
233
- import { metersGet } from "@polar-sh/sdk/funcs/metersGet.js";
234
-
235
- // Use `PolarCore` for best tree-shaking performance.
236
- // You can create one instance of it to use across an application.
237
- const polar = new PolarCore({
238
- accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
239
- });
240
-
241
- async function run() {
242
- const res = await metersGet(polar, {
243
- id: "<value>",
244
- });
245
- if (res.ok) {
246
- const { value: result } = res;
247
- console.log(result);
248
- } else {
249
- console.log("metersGet failed:", res.error);
250
- }
251
- }
252
-
253
- run();
254
- ```
255
-
256
- ### Parameters
257
-
258
- | Parameter | Type | Required | Description |
259
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
260
- | `request` | [operations.MetersGetRequest](../../models/operations/metersgetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
261
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
262
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
263
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
264
-
265
- ### Response
266
-
267
- **Promise\<[components.Meter](../../models/components/meter.md)\>**
268
-
269
- ### Errors
270
-
271
- | Error Type | Status Code | Content Type |
272
- | -------------------------- | -------------------------- | -------------------------- |
273
- | errors.ResourceNotFound | 404 | application/json |
274
- | errors.HTTPValidationError | 422 | application/json |
275
- | errors.SDKError | 4XX, 5XX | \*/\* |
276
-
277
- ## update
278
-
279
- Update a meter.
280
-
281
- **Scopes**: `meters:write`
282
-
283
- ### Example Usage
284
-
285
- <!-- UsageSnippet language="typescript" operationID="meters:update" method="patch" path="/v1/meters/{id}" -->
286
- ```typescript
287
- import { Polar } from "@polar-sh/sdk";
288
-
289
- const polar = new Polar({
290
- accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
291
- });
292
-
293
- async function run() {
294
- const result = await polar.meters.update({
295
- id: "<value>",
296
- meterUpdate: {},
297
- });
298
-
299
- console.log(result);
300
- }
301
-
302
- run();
303
- ```
304
-
305
- ### Standalone function
306
-
307
- The standalone function version of this method:
308
-
309
- ```typescript
310
- import { PolarCore } from "@polar-sh/sdk/core.js";
311
- import { metersUpdate } from "@polar-sh/sdk/funcs/metersUpdate.js";
312
-
313
- // Use `PolarCore` for best tree-shaking performance.
314
- // You can create one instance of it to use across an application.
315
- const polar = new PolarCore({
316
- accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
317
- });
318
-
319
- async function run() {
320
- const res = await metersUpdate(polar, {
321
- id: "<value>",
322
- meterUpdate: {},
323
- });
324
- if (res.ok) {
325
- const { value: result } = res;
326
- console.log(result);
327
- } else {
328
- console.log("metersUpdate failed:", res.error);
329
- }
330
- }
331
-
332
- run();
333
- ```
334
-
335
- ### Parameters
336
-
337
- | Parameter | Type | Required | Description |
338
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
339
- | `request` | [operations.MetersUpdateRequest](../../models/operations/metersupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
340
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
341
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
342
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
343
-
344
- ### Response
345
-
346
- **Promise\<[components.Meter](../../models/components/meter.md)\>**
347
-
348
- ### Errors
349
-
350
- | Error Type | Status Code | Content Type |
351
- | -------------------------- | -------------------------- | -------------------------- |
352
- | errors.ResourceNotFound | 404 | application/json |
353
- | errors.HTTPValidationError | 422 | application/json |
354
- | errors.SDKError | 4XX, 5XX | \*/\* |
355
-
356
- ## quantities
357
-
358
- Get quantities of a meter over a time period.
359
-
360
- **Scopes**: `meters:read` `meters:write`
361
-
362
- ### Example Usage
363
-
364
- <!-- UsageSnippet language="typescript" operationID="meters:quantities" method="get" path="/v1/meters/{id}/quantities" -->
365
- ```typescript
366
- import { Polar } from "@polar-sh/sdk";
367
-
368
- const polar = new Polar({
369
- accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
370
- });
371
-
372
- async function run() {
373
- const result = await polar.meters.quantities({
374
- id: "<value>",
375
- startTimestamp: new Date("2025-11-25T04:37:16.823Z"),
376
- endTimestamp: new Date("2025-11-26T17:06:00.727Z"),
377
- interval: "day",
378
- });
379
-
380
- console.log(result);
381
- }
382
-
383
- run();
384
- ```
385
-
386
- ### Standalone function
387
-
388
- The standalone function version of this method:
389
-
390
- ```typescript
391
- import { PolarCore } from "@polar-sh/sdk/core.js";
392
- import { metersQuantities } from "@polar-sh/sdk/funcs/metersQuantities.js";
393
-
394
- // Use `PolarCore` for best tree-shaking performance.
395
- // You can create one instance of it to use across an application.
396
- const polar = new PolarCore({
397
- accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
398
- });
399
-
400
- async function run() {
401
- const res = await metersQuantities(polar, {
402
- id: "<value>",
403
- startTimestamp: new Date("2025-11-25T04:37:16.823Z"),
404
- endTimestamp: new Date("2025-11-26T17:06:00.727Z"),
405
- interval: "day",
406
- });
407
- if (res.ok) {
408
- const { value: result } = res;
409
- console.log(result);
410
- } else {
411
- console.log("metersQuantities failed:", res.error);
412
- }
413
- }
414
-
415
- run();
416
- ```
417
-
418
- ### Parameters
419
-
420
- | Parameter | Type | Required | Description |
421
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
422
- | `request` | [operations.MetersQuantitiesRequest](../../models/operations/metersquantitiesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
423
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
424
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
425
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
426
-
427
- ### Response
428
-
429
- **Promise\<[components.MeterQuantities](../../models/components/meterquantities.md)\>**
430
-
431
- ### Errors
432
-
433
- | Error Type | Status Code | Content Type |
434
- | -------------------------- | -------------------------- | -------------------------- |
435
- | errors.ResourceNotFound | 404 | application/json |
436
- | errors.HTTPValidationError | 422 | application/json |
437
- | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -1,165 +0,0 @@
1
- # Metrics
2
- (*metrics*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [get](#get) - Get Metrics
9
- * [limits](#limits) - Get Metrics Limits
10
-
11
- ## get
12
-
13
- Get metrics about your orders and subscriptions.
14
-
15
- Currency values are output in cents.
16
-
17
- **Scopes**: `metrics:read`
18
-
19
- ### Example Usage
20
-
21
- <!-- UsageSnippet language="typescript" operationID="metrics:get" method="get" path="/v1/metrics/" -->
22
- ```typescript
23
- import { Polar } from "@polar-sh/sdk";
24
- import { RFCDate } from "@polar-sh/sdk/types/rfcdate.js";
25
-
26
- const polar = new Polar({
27
- accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
28
- });
29
-
30
- async function run() {
31
- const result = await polar.metrics.get({
32
- startDate: new RFCDate("2025-03-14"),
33
- endDate: new RFCDate("2025-03-18"),
34
- interval: "hour",
35
- organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
36
- });
37
-
38
- console.log(result);
39
- }
40
-
41
- run();
42
- ```
43
-
44
- ### Standalone function
45
-
46
- The standalone function version of this method:
47
-
48
- ```typescript
49
- import { PolarCore } from "@polar-sh/sdk/core.js";
50
- import { metricsGet } from "@polar-sh/sdk/funcs/metricsGet.js";
51
- import { RFCDate } from "@polar-sh/sdk/types/rfcdate.js";
52
-
53
- // Use `PolarCore` for best tree-shaking performance.
54
- // You can create one instance of it to use across an application.
55
- const polar = new PolarCore({
56
- accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
57
- });
58
-
59
- async function run() {
60
- const res = await metricsGet(polar, {
61
- startDate: new RFCDate("2025-03-14"),
62
- endDate: new RFCDate("2025-03-18"),
63
- interval: "hour",
64
- organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
65
- });
66
- if (res.ok) {
67
- const { value: result } = res;
68
- console.log(result);
69
- } else {
70
- console.log("metricsGet failed:", res.error);
71
- }
72
- }
73
-
74
- run();
75
- ```
76
-
77
- ### Parameters
78
-
79
- | Parameter | Type | Required | Description |
80
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
81
- | `request` | [operations.MetricsGetRequest](../../models/operations/metricsgetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
82
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
83
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
84
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
85
-
86
- ### Response
87
-
88
- **Promise\<[components.MetricsResponse](../../models/components/metricsresponse.md)\>**
89
-
90
- ### Errors
91
-
92
- | Error Type | Status Code | Content Type |
93
- | -------------------------- | -------------------------- | -------------------------- |
94
- | errors.HTTPValidationError | 422 | application/json |
95
- | errors.SDKError | 4XX, 5XX | \*/\* |
96
-
97
- ## limits
98
-
99
- Get the interval limits for the metrics endpoint.
100
-
101
- **Scopes**: `metrics:read`
102
-
103
- ### Example Usage
104
-
105
- <!-- UsageSnippet language="typescript" operationID="metrics:limits" method="get" path="/v1/metrics/limits" -->
106
- ```typescript
107
- import { Polar } from "@polar-sh/sdk";
108
-
109
- const polar = new Polar({
110
- accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
111
- });
112
-
113
- async function run() {
114
- const result = await polar.metrics.limits();
115
-
116
- console.log(result);
117
- }
118
-
119
- run();
120
- ```
121
-
122
- ### Standalone function
123
-
124
- The standalone function version of this method:
125
-
126
- ```typescript
127
- import { PolarCore } from "@polar-sh/sdk/core.js";
128
- import { metricsLimits } from "@polar-sh/sdk/funcs/metricsLimits.js";
129
-
130
- // Use `PolarCore` for best tree-shaking performance.
131
- // You can create one instance of it to use across an application.
132
- const polar = new PolarCore({
133
- accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
134
- });
135
-
136
- async function run() {
137
- const res = await metricsLimits(polar);
138
- if (res.ok) {
139
- const { value: result } = res;
140
- console.log(result);
141
- } else {
142
- console.log("metricsLimits failed:", res.error);
143
- }
144
- }
145
-
146
- run();
147
- ```
148
-
149
- ### Parameters
150
-
151
- | Parameter | Type | Required | Description |
152
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
153
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
154
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
155
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
156
-
157
- ### Response
158
-
159
- **Promise\<[components.MetricsLimits](../../models/components/metricslimits.md)\>**
160
-
161
- ### Errors
162
-
163
- | Error Type | Status Code | Content Type |
164
- | --------------- | --------------- | --------------- |
165
- | errors.SDKError | 4XX, 5XX | \*/\* |