conductor-node 12.0.0-beta.1 → 12.0.0-beta.11

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 (110) hide show
  1. package/CHANGELOG.md +108 -0
  2. package/README.md +32 -27
  3. package/index.d.mts +4 -4
  4. package/index.d.ts +4 -4
  5. package/index.d.ts.map +1 -1
  6. package/index.js.map +1 -1
  7. package/index.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resources/auth-sessions.d.ts +11 -15
  10. package/resources/auth-sessions.d.ts.map +1 -1
  11. package/resources/auth-sessions.js +2 -8
  12. package/resources/auth-sessions.js.map +1 -1
  13. package/resources/auth-sessions.mjs +2 -8
  14. package/resources/auth-sessions.mjs.map +1 -1
  15. package/resources/end-users.d.ts +20 -32
  16. package/resources/end-users.d.ts.map +1 -1
  17. package/resources/end-users.js +4 -12
  18. package/resources/end-users.js.map +1 -1
  19. package/resources/end-users.mjs +4 -12
  20. package/resources/end-users.mjs.map +1 -1
  21. package/resources/index.d.ts +2 -2
  22. package/resources/index.d.ts.map +1 -1
  23. package/resources/index.js.map +1 -1
  24. package/resources/index.mjs.map +1 -1
  25. package/resources/qbd/bill-check-payments.d.ts +4 -4
  26. package/resources/qbd/bill-credit-card-payments.d.ts +4 -4
  27. package/resources/qbd/bills.d.ts +4 -4
  28. package/resources/qbd/checks.d.ts +4 -4
  29. package/resources/qbd/credit-card-charges.d.ts +4 -4
  30. package/resources/qbd/credit-card-credits.d.ts +4 -4
  31. package/resources/qbd/credit-memos.d.ts +4 -4
  32. package/resources/qbd/employees.d.ts +76 -34
  33. package/resources/qbd/employees.d.ts.map +1 -1
  34. package/resources/qbd/employees.js.map +1 -1
  35. package/resources/qbd/employees.mjs.map +1 -1
  36. package/resources/qbd/estimates.d.ts +4 -4
  37. package/resources/qbd/index.d.ts +3 -1
  38. package/resources/qbd/index.d.ts.map +1 -1
  39. package/resources/qbd/index.js +7 -1
  40. package/resources/qbd/index.js.map +1 -1
  41. package/resources/qbd/index.mjs +2 -0
  42. package/resources/qbd/index.mjs.map +1 -1
  43. package/resources/qbd/inventory-adjustments.d.ts +4 -4
  44. package/resources/qbd/inventory-assembly-items.d.ts +1 -1
  45. package/resources/qbd/inventory-assembly-items.d.ts.map +1 -1
  46. package/resources/qbd/inventory-items.d.ts +1 -1
  47. package/resources/qbd/inventory-items.d.ts.map +1 -1
  48. package/resources/qbd/invoices.d.ts +4 -4
  49. package/resources/qbd/journal-entries.d.ts +4 -4
  50. package/resources/qbd/purchase-orders.d.ts +4 -4
  51. package/resources/qbd/qbd.d.ts +36 -0
  52. package/resources/qbd/qbd.d.ts.map +1 -1
  53. package/resources/qbd/qbd.js +25 -0
  54. package/resources/qbd/qbd.js.map +1 -1
  55. package/resources/qbd/qbd.mjs +25 -0
  56. package/resources/qbd/qbd.mjs.map +1 -1
  57. package/resources/qbd/receive-payments.d.ts +4 -4
  58. package/resources/qbd/sales-orders.d.ts +4 -4
  59. package/resources/qbd/sales-receipts.d.ts +4 -4
  60. package/resources/qbd/time-tracking-activities.d.ts +485 -0
  61. package/resources/qbd/time-tracking-activities.d.ts.map +1 -0
  62. package/resources/qbd/time-tracking-activities.js +66 -0
  63. package/resources/qbd/time-tracking-activities.js.map +1 -0
  64. package/resources/qbd/time-tracking-activities.mjs +61 -0
  65. package/resources/qbd/time-tracking-activities.mjs.map +1 -0
  66. package/resources/qbd/transactions.d.ts +312 -0
  67. package/resources/qbd/transactions.d.ts.map +1 -0
  68. package/resources/qbd/transactions.js +41 -0
  69. package/resources/qbd/transactions.js.map +1 -0
  70. package/resources/qbd/transactions.mjs +36 -0
  71. package/resources/qbd/transactions.mjs.map +1 -0
  72. package/resources/qbd/transfers.d.ts +4 -4
  73. package/resources/qbd/vendor-credits.d.ts +4 -4
  74. package/resources/qbd/vendors.d.ts +4 -4
  75. package/src/index.ts +6 -4
  76. package/src/resources/auth-sessions.ts +11 -18
  77. package/src/resources/end-users.ts +19 -40
  78. package/src/resources/index.ts +1 -2
  79. package/src/resources/qbd/bill-check-payments.ts +4 -4
  80. package/src/resources/qbd/bill-credit-card-payments.ts +4 -4
  81. package/src/resources/qbd/bills.ts +4 -4
  82. package/src/resources/qbd/checks.ts +4 -4
  83. package/src/resources/qbd/credit-card-charges.ts +4 -4
  84. package/src/resources/qbd/credit-card-credits.ts +4 -4
  85. package/src/resources/qbd/credit-memos.ts +4 -4
  86. package/src/resources/qbd/employees.ts +76 -34
  87. package/src/resources/qbd/estimates.ts +4 -4
  88. package/src/resources/qbd/index.ts +19 -1
  89. package/src/resources/qbd/inventory-adjustments.ts +4 -4
  90. package/src/resources/qbd/inventory-assembly-items.ts +1 -1
  91. package/src/resources/qbd/inventory-items.ts +1 -1
  92. package/src/resources/qbd/invoices.ts +4 -4
  93. package/src/resources/qbd/journal-entries.ts +4 -4
  94. package/src/resources/qbd/purchase-orders.ts +4 -4
  95. package/src/resources/qbd/qbd.ts +92 -0
  96. package/src/resources/qbd/receive-payments.ts +4 -4
  97. package/src/resources/qbd/sales-orders.ts +4 -4
  98. package/src/resources/qbd/sales-receipts.ts +4 -4
  99. package/src/resources/qbd/time-tracking-activities.ts +615 -0
  100. package/src/resources/qbd/transactions.ts +441 -0
  101. package/src/resources/qbd/transfers.ts +4 -4
  102. package/src/resources/qbd/vendor-credits.ts +4 -4
  103. package/src/resources/qbd/vendors.ts +4 -4
  104. package/src/version.ts +1 -1
  105. package/version.d.ts +1 -1
  106. package/version.d.ts.map +1 -1
  107. package/version.js +1 -1
  108. package/version.js.map +1 -1
  109. package/version.mjs +1 -1
  110. package/version.mjs.map +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,113 @@
1
1
  # Changelog
2
2
 
3
+ ## 12.0.0-beta.11 (2025-03-05)
4
+
5
+ Full Changelog: [v12.0.0-beta.10...v12.0.0-beta.11](https://github.com/conductor-is/quickbooks-desktop-node/compare/v12.0.0-beta.10...v12.0.0-beta.11)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([#67](https://github.com/conductor-is/quickbooks-desktop-node/issues/67)) ([57eff6f](https://github.com/conductor-is/quickbooks-desktop-node/commit/57eff6f2f1f50dd239dff2caab088acb0904a670))
10
+ * **api:** api update ([#68](https://github.com/conductor-is/quickbooks-desktop-node/issues/68)) ([89a10fe](https://github.com/conductor-is/quickbooks-desktop-node/commit/89a10fe7257d423bbf291580ad4e5ec7a3ae1efb))
11
+ * **api:** api update ([#69](https://github.com/conductor-is/quickbooks-desktop-node/issues/69)) ([ee19438](https://github.com/conductor-is/quickbooks-desktop-node/commit/ee194388b3e9a79007de8608d6d78fa15677949f))
12
+ * **api:** api update ([#70](https://github.com/conductor-is/quickbooks-desktop-node/issues/70)) ([5f8eb11](https://github.com/conductor-is/quickbooks-desktop-node/commit/5f8eb11599684f962bd9f596727c552667d7dfbc))
13
+ * **api:** api update ([#71](https://github.com/conductor-is/quickbooks-desktop-node/issues/71)) ([3366574](https://github.com/conductor-is/quickbooks-desktop-node/commit/33665749f70db71a6b2b99b9d8385e1fdff024ed))
14
+ * **api:** api update ([#72](https://github.com/conductor-is/quickbooks-desktop-node/issues/72)) ([593e339](https://github.com/conductor-is/quickbooks-desktop-node/commit/593e3392ec9f411ef5018d7630da24667dab0918))
15
+ * **api:** api update ([#73](https://github.com/conductor-is/quickbooks-desktop-node/issues/73)) ([865944c](https://github.com/conductor-is/quickbooks-desktop-node/commit/865944c917d89a7379f19ee8dbfdd49c80761c3c))
16
+
17
+
18
+ ### Chores
19
+
20
+ * **internal:** codegen related update ([#65](https://github.com/conductor-is/quickbooks-desktop-node/issues/65)) ([67a702f](https://github.com/conductor-is/quickbooks-desktop-node/commit/67a702f1ba6d1603db597e7e4df094ee7042f75d))
21
+
22
+ ## 12.0.0-beta.10 (2025-02-27)
23
+
24
+ Full Changelog: [v12.0.0-beta.9...v12.0.0-beta.10](https://github.com/conductor-is/quickbooks-desktop-node/compare/v12.0.0-beta.9...v12.0.0-beta.10)
25
+
26
+ ### Features
27
+
28
+ * **api:** api update ([#60](https://github.com/conductor-is/quickbooks-desktop-node/issues/60)) ([a064331](https://github.com/conductor-is/quickbooks-desktop-node/commit/a064331a99ac20e3fde0669d09ec369a3bf929d2))
29
+ * **api:** api update ([#62](https://github.com/conductor-is/quickbooks-desktop-node/issues/62)) ([30c55c2](https://github.com/conductor-is/quickbooks-desktop-node/commit/30c55c2f2f88c390f4fb7dd65fdb0ae741d6b609))
30
+ * **api:** api update ([#63](https://github.com/conductor-is/quickbooks-desktop-node/issues/63)) ([e9d35b2](https://github.com/conductor-is/quickbooks-desktop-node/commit/e9d35b2d757eb838993d10aed1a968f5ce135f83))
31
+
32
+ ## 12.0.0-beta.9 (2025-02-24)
33
+
34
+ Full Changelog: [v12.0.0-beta.8...v12.0.0-beta.9](https://github.com/conductor-is/quickbooks-desktop-node/compare/v12.0.0-beta.8...v12.0.0-beta.9)
35
+
36
+ ### Features
37
+
38
+ * **api:** api update ([#56](https://github.com/conductor-is/quickbooks-desktop-node/issues/56)) ([5ae43e7](https://github.com/conductor-is/quickbooks-desktop-node/commit/5ae43e734811448f8be026adc3a083987db14a56))
39
+ * **api:** api update ([#58](https://github.com/conductor-is/quickbooks-desktop-node/issues/58)) ([19059e8](https://github.com/conductor-is/quickbooks-desktop-node/commit/19059e8441810fe594960dbf3af995ea6ac9e4ca))
40
+
41
+ ## 12.0.0-beta.8 (2025-02-24)
42
+
43
+ Full Changelog: [v12.0.0-beta.7...v12.0.0-beta.8](https://github.com/conductor-is/quickbooks-desktop-node/compare/v12.0.0-beta.7...v12.0.0-beta.8)
44
+
45
+ ### Features
46
+
47
+ * **api:** api update ([#52](https://github.com/conductor-is/quickbooks-desktop-node/issues/52)) ([da93300](https://github.com/conductor-is/quickbooks-desktop-node/commit/da9330019d5f88069dfb3fef452ee8d49b3dbc68))
48
+ * **api:** api update ([#54](https://github.com/conductor-is/quickbooks-desktop-node/issues/54)) ([e1a287d](https://github.com/conductor-is/quickbooks-desktop-node/commit/e1a287d2f4264cf229c20ee3db0399e568f00b9a))
49
+
50
+ ## 12.0.0-beta.7 (2025-02-23)
51
+
52
+ Full Changelog: [v12.0.0-beta.6...v12.0.0-beta.7](https://github.com/conductor-is/quickbooks-desktop-node/compare/v12.0.0-beta.6...v12.0.0-beta.7)
53
+
54
+ ### Features
55
+
56
+ * **api:** api update ([#49](https://github.com/conductor-is/quickbooks-desktop-node/issues/49)) ([22bf279](https://github.com/conductor-is/quickbooks-desktop-node/commit/22bf27956d568b34ad22916c069f91d7eaea3556))
57
+
58
+ ## 12.0.0-beta.6 (2025-02-23)
59
+
60
+ Full Changelog: [v12.0.0-beta.5...v12.0.0-beta.6](https://github.com/conductor-is/quickbooks-desktop-node/compare/v12.0.0-beta.5...v12.0.0-beta.6)
61
+
62
+ ### Features
63
+
64
+ * **api:** api update ([#46](https://github.com/conductor-is/quickbooks-desktop-node/issues/46)) ([e135bb5](https://github.com/conductor-is/quickbooks-desktop-node/commit/e135bb5465037e64f2f86229d6db7393c923a72b))
65
+
66
+ ## 12.0.0-beta.5 (2025-02-23)
67
+
68
+ Full Changelog: [v12.0.0-beta.4...v12.0.0-beta.5](https://github.com/conductor-is/quickbooks-desktop-node/compare/v12.0.0-beta.4...v12.0.0-beta.5)
69
+
70
+ ### Features
71
+
72
+ * **api:** api update ([#39](https://github.com/conductor-is/quickbooks-desktop-node/issues/39)) ([2b02cbc](https://github.com/conductor-is/quickbooks-desktop-node/commit/2b02cbc118423a1e65e254eaab43c2cfa8750826))
73
+ * **api:** api update ([#42](https://github.com/conductor-is/quickbooks-desktop-node/issues/42)) ([f4724e0](https://github.com/conductor-is/quickbooks-desktop-node/commit/f4724e09acfcb2567a63510bd6e0b348599aa7f4))
74
+ * **api:** api update ([#43](https://github.com/conductor-is/quickbooks-desktop-node/issues/43)) ([886e7ad](https://github.com/conductor-is/quickbooks-desktop-node/commit/886e7ada0c9f6163dd61386b509bf2e7e8ee228d))
75
+ * **api:** api update ([#44](https://github.com/conductor-is/quickbooks-desktop-node/issues/44)) ([31e96e5](https://github.com/conductor-is/quickbooks-desktop-node/commit/31e96e50ab6042840c48c51d1f88844f8f4e78a2))
76
+
77
+
78
+ ### Chores
79
+
80
+ * **internal:** fix devcontainers setup ([#41](https://github.com/conductor-is/quickbooks-desktop-node/issues/41)) ([5a94758](https://github.com/conductor-is/quickbooks-desktop-node/commit/5a9475838ba0e5550e2bac06cd5085c2b89f024d))
81
+
82
+ ## 12.0.0-beta.4 (2025-02-21)
83
+
84
+ Full Changelog: [v12.0.0-beta.3...v12.0.0-beta.4](https://github.com/conductor-is/quickbooks-desktop-node/compare/v12.0.0-beta.3...v12.0.0-beta.4)
85
+
86
+ ### Features
87
+
88
+ * **api:** api update ([#37](https://github.com/conductor-is/quickbooks-desktop-node/issues/37)) ([2b224de](https://github.com/conductor-is/quickbooks-desktop-node/commit/2b224dee48abe7ccf2a7e251a643341f2fbd40f2))
89
+
90
+
91
+ ### Bug Fixes
92
+
93
+ * **client:** mark some request bodies as optional ([#35](https://github.com/conductor-is/quickbooks-desktop-node/issues/35)) ([7173672](https://github.com/conductor-is/quickbooks-desktop-node/commit/7173672326b1e32040ac18455fb086583ae0b3d8))
94
+
95
+ ## 12.0.0-beta.3 (2025-02-19)
96
+
97
+ Full Changelog: [v12.0.0-beta.2...v12.0.0-beta.3](https://github.com/conductor-is/quickbooks-desktop-node/compare/v12.0.0-beta.2...v12.0.0-beta.3)
98
+
99
+ ### Features
100
+
101
+ * **api:** api update ([#32](https://github.com/conductor-is/quickbooks-desktop-node/issues/32)) ([56e5df2](https://github.com/conductor-is/quickbooks-desktop-node/commit/56e5df25621608a7dfc1cd16bb2561f6a82e1b80))
102
+
103
+ ## 12.0.0-beta.2 (2025-02-18)
104
+
105
+ Full Changelog: [v12.0.0-beta.1...v12.0.0-beta.2](https://github.com/conductor-is/quickbooks-desktop-node/compare/v12.0.0-beta.1...v12.0.0-beta.2)
106
+
107
+ ### Chores
108
+
109
+ * **internal:** codegen related update ([#29](https://github.com/conductor-is/quickbooks-desktop-node/issues/29)) ([8e1d695](https://github.com/conductor-is/quickbooks-desktop-node/commit/8e1d695f94114cd8e494a59f649eaf2e6b2f4779))
110
+
3
111
  ## 12.0.0-beta.1 (2025-02-15)
4
112
 
5
113
  Full Changelog: [v11.9.0...v12.0.0-beta.1](https://github.com/conductor-is/quickbooks-desktop-node/compare/v11.9.0...v12.0.0-beta.1)
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
  <img alt="Conductor logo" src="https://github.com/conductor-is/quickbooks-desktop-api/assets/170023/d67464b8-53a7-4d33-afeb-05a2efde1fa8" width="325">
7
7
  </picture>
8
8
  </a>
9
- <h3>QuickBooks Desktop/Enterprise real-time API for Python, Node.js, and REST</h3>
9
+ <h3>QuickBooks Desktop/Enterprise real-time API for Node.js, Python, and REST</h3>
10
10
  <a href="https://docs.conductor.is/quickstart">Quickstart</a>
11
11
  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
12
12
  <a href="https://conductor.is">Website</a>
@@ -17,7 +17,7 @@
17
17
  <br />
18
18
  <br />
19
19
  <a href="https://npmjs.com/package/conductor-node"><img src="https://img.shields.io/npm/dm/conductor-node.svg?logo=npm" alt="NPM download count"></a>
20
- <a href="https://npmjs.org/package/conductor-node"><img src="https://img.shields.io/npm/v/conductor-node.svg?logo=npm" alt="Package version"></a>
20
+ <a href="https://npmjs.org/package/conductor-node"><img src="https://img.shields.io/npm/v/conductor-node.svg?logo=npm" alt="NPM version"></a>
21
21
  <a href="https://npmjs.org/package/conductor-node"><img src="https://img.shields.io/bundlephobia/minzip/conductor-node" alt="NPM bundle size"></a>
22
22
  <img src="https://img.shields.io/badge/coverage-100%25-brightgreen" alt="Code coverage">
23
23
  <a href="LICENSE"><img src="https://img.shields.io/npm/l/conductor-node.svg?color=blue&logo=github" alt="License" /></a>
@@ -28,7 +28,13 @@
28
28
 
29
29
  ⭐ **Follow our [Quickstart guide](https://docs.conductor.is/quickstart) to get started.**
30
30
 
31
- This repository is for the Node.js (TypeScript/JavaScript) library. For Python, see [conductor-python](https://github.com/conductor-is/quickbooks-desktop-python).
31
+ This repository contains the official Conductor **Node.js** library, which provides convenient access to our QuickBooks Desktop API from any server-side TypeScript or JavaScript application.
32
+
33
+ - For Python, see [conductor-python](https://github.com/conductor-is/quickbooks-desktop-python).
34
+
35
+ ## Documentation
36
+
37
+ The REST API documentation can be found on [docs.conductor.is](https://docs.conductor.is/api-ref). The full API of this library can be found in [api.md](api.md).
32
38
 
33
39
  ## Installation
34
40
 
@@ -36,10 +42,9 @@ This repository is for the Node.js (TypeScript/JavaScript) library. For Python,
36
42
  npm install conductor-node@beta
37
43
  ```
38
44
 
39
- This version of the library is in beta, but it **_is_ stable and ready for production use**. We merely have a few more endpoints to migrate before prompting all existing users to update.
40
-
41
- > [!NOTE]
42
- > If migrating from the old `conductor-node` package, see the [migration guide](https://docs.conductor.is/qbd-api/upgrade-node).
45
+ > **Note:** Though this version of the Node.js SDK uses an NPM `@beta` tag, it **_is_ stable and ready for production use**! We merely have a few more endpoints to migrate before prompting all existing users to update. **Any new Conductor users should absolutely use the beta version**!
46
+ >
47
+ > If you're migrating from the old `conductor-node` package, see the [migration guide](https://docs.conductor.is/qbd-api/upgrade-node).
43
48
 
44
49
  ## Key features
45
50
 
@@ -64,12 +69,12 @@ The full API of this library can be found with code samples at [docs.conductor.i
64
69
  ```js
65
70
  import Conductor from 'conductor-node';
66
71
 
67
- const client = new Conductor({
72
+ const conductor = new Conductor({
68
73
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
69
74
  });
70
75
 
71
76
  async function main() {
72
- const page = await client.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' });
77
+ const page = await conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' });
73
78
  const invoice = page.data[0];
74
79
 
75
80
  console.log(invoice.id);
@@ -86,13 +91,13 @@ This library includes TypeScript definitions for all request params and response
86
91
  ```ts
87
92
  import Conductor from 'conductor-node';
88
93
 
89
- const client = new Conductor({
94
+ const conductor = new Conductor({
90
95
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
91
96
  });
92
97
 
93
98
  async function main() {
94
99
  const params: Conductor.Qbd.InvoiceListParams = { conductorEndUserId: 'YOUR_END_USER_ID' };
95
- const [invoice]: [Conductor.Qbd.Invoice] = await client.qbd.invoices.list(params);
100
+ const [invoice]: [Conductor.Qbd.Invoice] = await conductor.qbd.invoices.list(params);
96
101
  }
97
102
 
98
103
  main();
@@ -109,7 +114,7 @@ a subclass of `APIError` will be thrown:
109
114
  <!-- prettier-ignore -->
110
115
  ```ts
111
116
  async function main() {
112
- const page = await client.qbd.invoices
117
+ const page = await conductor.qbd.invoices
113
118
  .list({ conductorEndUserId: 'YOUR_END_USER_ID' })
114
119
  .catch(async (err) => {
115
120
  if (err instanceof Conductor.APIError) {
@@ -149,12 +154,12 @@ You can use the `maxRetries` option to configure or disable this:
149
154
  <!-- prettier-ignore -->
150
155
  ```js
151
156
  // Configure the default for all requests:
152
- const client = new Conductor({
157
+ const conductor = new Conductor({
153
158
  maxRetries: 0, // default is 2
154
159
  });
155
160
 
156
161
  // Or, configure per-request:
157
- await client.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' }, {
162
+ await conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' }, {
158
163
  maxRetries: 5,
159
164
  });
160
165
  ```
@@ -166,12 +171,12 @@ Requests time out after 2 minutes by default. You can configure this with a `tim
166
171
  <!-- prettier-ignore -->
167
172
  ```ts
168
173
  // Configure the default for all requests:
169
- const client = new Conductor({
174
+ const conductor = new Conductor({
170
175
  timeout: 20 * 1000, // 20 seconds (default is 2 minutes)
171
176
  });
172
177
 
173
178
  // Override per-request:
174
- await client.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' }, {
179
+ await conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' }, {
175
180
  timeout: 5 * 1000,
176
181
  });
177
182
  ```
@@ -189,7 +194,7 @@ You can use the `for await … of` syntax to iterate through items across all pa
189
194
  async function fetchAllQbdInvoices(params) {
190
195
  const allQbdInvoices = [];
191
196
  // Automatically fetches more pages as needed.
192
- for await (const invoice of client.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' })) {
197
+ for await (const invoice of conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' })) {
193
198
  allQbdInvoices.push(invoice);
194
199
  }
195
200
  return allQbdInvoices;
@@ -199,7 +204,7 @@ async function fetchAllQbdInvoices(params) {
199
204
  Alternatively, you can request a single page at a time:
200
205
 
201
206
  ```ts
202
- let page = await client.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' });
207
+ let page = await conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' });
203
208
  for (const invoice of page.data) {
204
209
  console.log(invoice);
205
210
  }
@@ -221,13 +226,13 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
221
226
 
222
227
  <!-- prettier-ignore -->
223
228
  ```ts
224
- const client = new Conductor();
229
+ const conductor = new Conductor();
225
230
 
226
- const response = await client.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' }).asResponse();
231
+ const response = await conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' }).asResponse();
227
232
  console.log(response.headers.get('X-My-Header'));
228
233
  console.log(response.statusText); // access the underlying Response object
229
234
 
230
- const { data: page, response: raw } = await client.qbd.invoices
235
+ const { data: page, response: raw } = await conductor.qbd.invoices
231
236
  .list({ conductorEndUserId: 'YOUR_END_USER_ID' })
232
237
  .withResponse();
233
238
  console.log(raw.headers.get('X-My-Header'));
@@ -243,11 +248,11 @@ endpoints, params, or response properties, the library can still be used.
243
248
 
244
249
  #### Undocumented endpoints
245
250
 
246
- To make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.
251
+ To make requests to undocumented endpoints, you can use `conductor.get`, `conductor.post`, and other HTTP verbs.
247
252
  Options on the client, such as retries, will be respected when making these requests.
248
253
 
249
254
  ```ts
250
- await client.post('/some/path', {
255
+ await conductor.post('/some/path', {
251
256
  body: { some_prop: 'foo' },
252
257
  query: { some_query_arg: 'bar' },
253
258
  });
@@ -260,7 +265,7 @@ parameter. This library doesn't validate at runtime that the request matches the
260
265
  send will be sent as-is.
261
266
 
262
267
  ```ts
263
- client.foo.create({
268
+ conductor.foo.create({
264
269
  foo: 'my_param',
265
270
  bar: 12,
266
271
  // @ts-expect-error baz is not yet public
@@ -307,7 +312,7 @@ which can be used to inspect or alter the `Request` or `Response` before/after e
307
312
  import { fetch } from 'undici'; // as one example
308
313
  import Conductor from 'conductor-node';
309
314
 
310
- const client = new Conductor({
315
+ const conductor = new Conductor({
311
316
  fetch: async (url: RequestInfo, init?: RequestInit): Promise<Response> => {
312
317
  console.log('About to make a request', url, init);
313
318
  const response = await fetch(url, init);
@@ -332,12 +337,12 @@ import http from 'http';
332
337
  import { HttpsProxyAgent } from 'https-proxy-agent';
333
338
 
334
339
  // Configure the default for all requests:
335
- const client = new Conductor({
340
+ const conductor = new Conductor({
336
341
  httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
337
342
  });
338
343
 
339
344
  // Override per-request:
340
- await client.qbd.invoices.list(
345
+ await conductor.qbd.invoices.list(
341
346
  { conductorEndUserId: 'YOUR_END_USER_ID' },
342
347
  {
343
348
  httpAgent: new http.Agent({ keepAlive: false }),
package/index.d.mts CHANGED
@@ -6,8 +6,8 @@ import { type CursorPageParams, CursorPageResponse } from "./pagination.js";
6
6
  import * as Uploads from "./uploads.js";
7
7
  import * as API from "./resources/index.js";
8
8
  import { AuthSession, AuthSessionCreateParams, AuthSessions } from "./resources/auth-sessions.js";
9
- import { EndUser, EndUserCreateParams, EndUserDeleteResponse, EndUserListResponse, EndUserPassthroughParams, EndUserPassthroughResponse, EndUserPingResponse, EndUsers } from "./resources/end-users.js";
10
- import { Qbd } from "./resources/qbd/qbd.js";
9
+ import { EndUser, EndUserCreateParams, EndUserDeleteResponse, EndUserListResponse, EndUserPassthroughParams, EndUserPassthroughResponse, EndUsers } from "./resources/end-users.js";
10
+ import { Qbd, QbdHealthCheckParams, QbdHealthCheckResponse } from "./resources/qbd/qbd.js";
11
11
  export interface ClientOptions {
12
12
  /**
13
13
  * Defaults to process.env['CONDUCTOR_SECRET_KEY'].
@@ -112,8 +112,8 @@ export declare namespace Conductor {
112
112
  export import CursorPage = Pagination.CursorPage;
113
113
  export { type CursorPageParams as CursorPageParams, type CursorPageResponse as CursorPageResponse };
114
114
  export { AuthSessions as AuthSessions, type AuthSession as AuthSession, type AuthSessionCreateParams as AuthSessionCreateParams, };
115
- export { EndUsers as EndUsers, type EndUser as EndUser, type EndUserListResponse as EndUserListResponse, type EndUserDeleteResponse as EndUserDeleteResponse, type EndUserPassthroughResponse as EndUserPassthroughResponse, type EndUserPingResponse as EndUserPingResponse, type EndUserCreateParams as EndUserCreateParams, type EndUserPassthroughParams as EndUserPassthroughParams, };
116
- export { Qbd as Qbd };
115
+ export { EndUsers as EndUsers, type EndUser as EndUser, type EndUserListResponse as EndUserListResponse, type EndUserDeleteResponse as EndUserDeleteResponse, type EndUserPassthroughResponse as EndUserPassthroughResponse, type EndUserCreateParams as EndUserCreateParams, type EndUserPassthroughParams as EndUserPassthroughParams, };
116
+ export { Qbd as Qbd, type QbdHealthCheckResponse as QbdHealthCheckResponse, type QbdHealthCheckParams as QbdHealthCheckParams, };
117
117
  }
118
118
  export { toFile, fileFromPath } from "./uploads.js";
119
119
  export { ConductorError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./error.js";
package/index.d.ts CHANGED
@@ -6,8 +6,8 @@ import { type CursorPageParams, CursorPageResponse } from "./pagination.js";
6
6
  import * as Uploads from "./uploads.js";
7
7
  import * as API from "./resources/index.js";
8
8
  import { AuthSession, AuthSessionCreateParams, AuthSessions } from "./resources/auth-sessions.js";
9
- import { EndUser, EndUserCreateParams, EndUserDeleteResponse, EndUserListResponse, EndUserPassthroughParams, EndUserPassthroughResponse, EndUserPingResponse, EndUsers } from "./resources/end-users.js";
10
- import { Qbd } from "./resources/qbd/qbd.js";
9
+ import { EndUser, EndUserCreateParams, EndUserDeleteResponse, EndUserListResponse, EndUserPassthroughParams, EndUserPassthroughResponse, EndUsers } from "./resources/end-users.js";
10
+ import { Qbd, QbdHealthCheckParams, QbdHealthCheckResponse } from "./resources/qbd/qbd.js";
11
11
  export interface ClientOptions {
12
12
  /**
13
13
  * Defaults to process.env['CONDUCTOR_SECRET_KEY'].
@@ -112,8 +112,8 @@ export declare namespace Conductor {
112
112
  export import CursorPage = Pagination.CursorPage;
113
113
  export { type CursorPageParams as CursorPageParams, type CursorPageResponse as CursorPageResponse };
114
114
  export { AuthSessions as AuthSessions, type AuthSession as AuthSession, type AuthSessionCreateParams as AuthSessionCreateParams, };
115
- export { EndUsers as EndUsers, type EndUser as EndUser, type EndUserListResponse as EndUserListResponse, type EndUserDeleteResponse as EndUserDeleteResponse, type EndUserPassthroughResponse as EndUserPassthroughResponse, type EndUserPingResponse as EndUserPingResponse, type EndUserCreateParams as EndUserCreateParams, type EndUserPassthroughParams as EndUserPassthroughParams, };
116
- export { Qbd as Qbd };
115
+ export { EndUsers as EndUsers, type EndUser as EndUser, type EndUserListResponse as EndUserListResponse, type EndUserDeleteResponse as EndUserDeleteResponse, type EndUserPassthroughResponse as EndUserPassthroughResponse, type EndUserCreateParams as EndUserCreateParams, type EndUserPassthroughParams as EndUserPassthroughParams, };
116
+ export { Qbd as Qbd, type QbdHealthCheckResponse as QbdHealthCheckResponse, type QbdHealthCheckParams as QbdHealthCheckParams, };
117
117
  }
118
118
  export { toFile, fileFromPath } from "./uploads.js";
119
119
  export { ConductorError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./error.js";
package/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACzE,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,uBAAuB,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC/F,OAAO,EACL,OAAO,EACP,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACnB,QAAQ,EACT,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAE1C,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE9B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;CAC9C;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,IAAI,CAAC,SAAS;IAC3C,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;OAWG;gBACS,EACV,OAA4C,EAC5C,MAA6C,EAC7C,GAAG,IAAI,EACR,GAAE,aAAkB;IA0BrB,YAAY,EAAE,GAAG,CAAC,YAAY,CAA8B;IAC5D,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAChD,GAAG,EAAE,GAAG,CAAC,GAAG,CAAqB;cAEd,YAAY,IAAI,IAAI,CAAC,YAAY,GAAG,SAAS;cAI7C,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAO5D,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAIzD,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAIzE,MAAM,CAAC,SAAS,mBAAQ;IACxB,MAAM,CAAC,eAAe,SAAU;IAEhC,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAC/B,MAAM,CAAC,YAAY,8BAAwB;CAC5C;AAKD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,MAAM,QAAQ,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IACjD,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;IAEpG,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EAAE,GAAG,IAAI,GAAG,EAAE,CAAC;CACvB;AAED,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,cAAc,EACd,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,SAAS,CAAC;AAEjB,eAAe,SAAS,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACzE,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,uBAAuB,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC/F,OAAO,EACL,OAAO,EACP,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,wBAAwB,EACxB,0BAA0B,EAC1B,QAAQ,EACT,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,GAAG,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAExF,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE9B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;CAC9C;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,IAAI,CAAC,SAAS;IAC3C,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;OAWG;gBACS,EACV,OAA4C,EAC5C,MAA6C,EAC7C,GAAG,IAAI,EACR,GAAE,aAAkB;IA0BrB,YAAY,EAAE,GAAG,CAAC,YAAY,CAA8B;IAC5D,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAChD,GAAG,EAAE,GAAG,CAAC,GAAG,CAAqB;cAEd,YAAY,IAAI,IAAI,CAAC,YAAY,GAAG,SAAS;cAI7C,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAO5D,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAIzD,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAIzE,MAAM,CAAC,SAAS,mBAAQ;IACxB,MAAM,CAAC,eAAe,SAAU;IAEhC,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAC/B,MAAM,CAAC,YAAY,8BAAwB;CAC5C;AAKD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,MAAM,QAAQ,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IACjD,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;IAEpG,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,GAAG,IAAI,GAAG,EACV,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH;AAED,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,cAAc,EACd,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,SAAS,CAAC;AAEjB,eAAe,SAAS,CAAC"}
package/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtF,2DAAoC;AACpC,gDAA+B;AAC/B,mDAAkC;AAClC,4DAA2C;AAE3C,sDAAqC;AACrC,0DAAyC;AACzC,gEAA+F;AAC/F,wDAS+B;AAC/B,gDAA0C;AAiE1C;;GAEG;AACH,MAAa,SAAU,SAAQ,IAAI,CAAC,SAAS;IAK3C;;;;;;;;;;;OAWG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAC5C,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAC7C,GAAG,IAAI,KACU,EAAE;QACnB,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,MAAM,CAAC,cAAc,CAC7B,gMAAgM,CACjM,CAAC;SACH;QAED,MAAM,OAAO,GAAkB;YAC7B,MAAM;YACN,GAAG,IAAI;YACP,OAAO,EAAE,OAAO,IAAI,6BAA6B;SAClD,CAAC;QAEF,KAAK,CAAC;YACJ,OAAO,EAAE,OAAO,CAAC,OAAQ;YACzB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,MAAM,CAAC,eAAe;YAClD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAOL,iBAAY,GAAqB,IAAI,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC5D,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChD,QAAG,GAAY,IAAI,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAP/B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAMkB,YAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAEkB,cAAc,CAAC,IAA8B;QAC9D,OAAO;YACL,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC;YAC7B,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc;SAChC,CAAC;IACJ,CAAC;IAEkB,WAAW,CAAC,IAA8B;QAC3D,OAAO,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;IACpD,CAAC;IAEkB,cAAc,CAAC,KAA8B;QAC9D,OAAO,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;;AApEH,8BAyFC;;AAnBQ,mBAAS,GAAG,EAAI,CAAC;AACjB,yBAAe,GAAG,MAAM,CAAC,CAAC,YAAY;AAEtC,wBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,kBAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,4BAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,mCAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,2BAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;AAC7C,uBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,uBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,wBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,yBAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,6BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,6BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,+BAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,kCAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAE3D,gBAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACxB,sBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAG7C,SAAS,CAAC,YAAY,GAAG,4BAAY,CAAC;AACtC,SAAS,CAAC,QAAQ,GAAG,oBAAQ,CAAC;AAC9B,SAAS,CAAC,GAAG,GAAG,SAAG,CAAC;AA2BpB,wCAAiD;AAAxC,iGAAA,MAAM,OAAA;AAAE,uGAAA,YAAY,OAAA;AAC7B,oCAciB;AAbf,uGAAA,cAAc,OAAA;AACd,iGAAA,QAAQ,OAAA;AACR,2GAAA,kBAAkB,OAAA;AAClB,kHAAA,yBAAyB,OAAA;AACzB,0GAAA,iBAAiB,OAAA;AACjB,sGAAA,aAAa,OAAA;AACb,sGAAA,aAAa,OAAA;AACb,uGAAA,cAAc,OAAA;AACd,wGAAA,eAAe,OAAA;AACf,4GAAA,mBAAmB,OAAA;AACnB,4GAAA,mBAAmB,OAAA;AACnB,8GAAA,qBAAqB,OAAA;AACrB,iHAAA,wBAAwB,OAAA;AAG1B,kBAAe,SAAS,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtF,2DAAoC;AACpC,gDAA+B;AAC/B,mDAAkC;AAClC,4DAA2C;AAE3C,sDAAqC;AACrC,0DAAyC;AACzC,gEAA+F;AAC/F,wDAQ+B;AAC/B,gDAAwF;AAiExF;;GAEG;AACH,MAAa,SAAU,SAAQ,IAAI,CAAC,SAAS;IAK3C;;;;;;;;;;;OAWG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAC5C,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAC7C,GAAG,IAAI,KACU,EAAE;QACnB,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,MAAM,CAAC,cAAc,CAC7B,gMAAgM,CACjM,CAAC;SACH;QAED,MAAM,OAAO,GAAkB;YAC7B,MAAM;YACN,GAAG,IAAI;YACP,OAAO,EAAE,OAAO,IAAI,6BAA6B;SAClD,CAAC;QAEF,KAAK,CAAC;YACJ,OAAO,EAAE,OAAO,CAAC,OAAQ;YACzB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,MAAM,CAAC,eAAe;YAClD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAOL,iBAAY,GAAqB,IAAI,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC5D,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChD,QAAG,GAAY,IAAI,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAP/B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAMkB,YAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAEkB,cAAc,CAAC,IAA8B;QAC9D,OAAO;YACL,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC;YAC7B,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc;SAChC,CAAC;IACJ,CAAC;IAEkB,WAAW,CAAC,IAA8B;QAC3D,OAAO,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;IACpD,CAAC;IAEkB,cAAc,CAAC,KAA8B;QAC9D,OAAO,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;;AApEH,8BAyFC;;AAnBQ,mBAAS,GAAG,EAAI,CAAC;AACjB,yBAAe,GAAG,MAAM,CAAC,CAAC,YAAY;AAEtC,wBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,kBAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,4BAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,mCAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,2BAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;AAC7C,uBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,uBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,wBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,yBAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,6BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,6BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,+BAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,kCAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAE3D,gBAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACxB,sBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAG7C,SAAS,CAAC,YAAY,GAAG,4BAAY,CAAC;AACtC,SAAS,CAAC,QAAQ,GAAG,oBAAQ,CAAC;AAC9B,SAAS,CAAC,GAAG,GAAG,SAAG,CAAC;AA8BpB,wCAAiD;AAAxC,iGAAA,MAAM,OAAA;AAAE,uGAAA,YAAY,OAAA;AAC7B,oCAciB;AAbf,uGAAA,cAAc,OAAA;AACd,iGAAA,QAAQ,OAAA;AACR,2GAAA,kBAAkB,OAAA;AAClB,kHAAA,yBAAyB,OAAA;AACzB,0GAAA,iBAAiB,OAAA;AACjB,sGAAA,aAAa,OAAA;AACb,sGAAA,aAAa,OAAA;AACb,uGAAA,cAAc,OAAA;AACd,wGAAA,eAAe,OAAA;AACf,4GAAA,mBAAmB,OAAA;AACnB,4GAAA,mBAAmB,OAAA;AACnB,8GAAA,qBAAqB,OAAA;AACrB,iHAAA,wBAAwB,OAAA;AAG1B,kBAAe,SAAS,CAAC"}
package/index.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,KAAK,EAAE;OACP,KAAK,IAAI;OACT,KAAK,MAAM;OACX,KAAK,UAAU;OAEf,KAAK,OAAO;OACZ,KAAK,GAAG;OACR,EAAwC,YAAY,EAAE;OACtD,EAQL,QAAQ,GACT;OACM,EAAE,GAAG,EAAE;AAiEd;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,IAAI,CAAC,SAAS;IAK3C;;;;;;;;;;;OAWG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAC5C,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAC7C,GAAG,IAAI,KACU,EAAE;QACnB,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,MAAM,CAAC,cAAc,CAC7B,gMAAgM,CACjM,CAAC;SACH;QAED,MAAM,OAAO,GAAkB;YAC7B,MAAM;YACN,GAAG,IAAI;YACP,OAAO,EAAE,OAAO,IAAI,6BAA6B;SAClD,CAAC;QAEF,KAAK,CAAC;YACJ,OAAO,EAAE,OAAO,CAAC,OAAQ;YACzB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,MAAM,CAAC,eAAe;YAClD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAOL,iBAAY,GAAqB,IAAI,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC5D,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChD,QAAG,GAAY,IAAI,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAP/B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAMkB,YAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAEkB,cAAc,CAAC,IAA8B;QAC9D,OAAO;YACL,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC;YAC7B,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc;SAChC,CAAC;IACJ,CAAC;IAEkB,WAAW,CAAC,IAA8B;QAC3D,OAAO,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;IACpD,CAAC;IAEkB,cAAc,CAAC,KAA8B;QAC9D,OAAO,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;;;AAEM,mBAAS,GAAG,EAAI,CAAC;AACjB,yBAAe,GAAG,MAAM,CAAC,CAAC,YAAY;AAEtC,wBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,kBAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,4BAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,mCAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,2BAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;AAC7C,uBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,uBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,wBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,yBAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,6BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,6BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,+BAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,kCAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAE3D,gBAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACxB,sBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAG7C,SAAS,CAAC,YAAY,GAAG,YAAY,CAAC;AACtC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC9B,SAAS,CAAC,GAAG,GAAG,GAAG,CAAC;OA2Bb,EAAE,MAAM,EAAE,YAAY,EAAE;OACxB,EACL,cAAc,EACd,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB;AAED,eAAe,SAAS,CAAC"}
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,KAAK,EAAE;OACP,KAAK,IAAI;OACT,KAAK,MAAM;OACX,KAAK,UAAU;OAEf,KAAK,OAAO;OACZ,KAAK,GAAG;OACR,EAAwC,YAAY,EAAE;OACtD,EAOL,QAAQ,GACT;OACM,EAAE,GAAG,EAAgD;AAiE5D;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,IAAI,CAAC,SAAS;IAK3C;;;;;;;;;;;OAWG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAC5C,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAC7C,GAAG,IAAI,KACU,EAAE;QACnB,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,MAAM,CAAC,cAAc,CAC7B,gMAAgM,CACjM,CAAC;SACH;QAED,MAAM,OAAO,GAAkB;YAC7B,MAAM;YACN,GAAG,IAAI;YACP,OAAO,EAAE,OAAO,IAAI,6BAA6B;SAClD,CAAC;QAEF,KAAK,CAAC;YACJ,OAAO,EAAE,OAAO,CAAC,OAAQ;YACzB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,MAAM,CAAC,eAAe;YAClD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAOL,iBAAY,GAAqB,IAAI,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC5D,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChD,QAAG,GAAY,IAAI,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAP/B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAMkB,YAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAEkB,cAAc,CAAC,IAA8B;QAC9D,OAAO;YACL,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC;YAC7B,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc;SAChC,CAAC;IACJ,CAAC;IAEkB,WAAW,CAAC,IAA8B;QAC3D,OAAO,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;IACpD,CAAC;IAEkB,cAAc,CAAC,KAA8B;QAC9D,OAAO,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;;;AAEM,mBAAS,GAAG,EAAI,CAAC;AACjB,yBAAe,GAAG,MAAM,CAAC,CAAC,YAAY;AAEtC,wBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,kBAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,4BAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,mCAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,2BAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;AAC7C,uBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,uBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,wBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,yBAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,6BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,6BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,+BAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,kCAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAE3D,gBAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACxB,sBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAG7C,SAAS,CAAC,YAAY,GAAG,YAAY,CAAC;AACtC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC9B,SAAS,CAAC,GAAG,GAAG,GAAG,CAAC;OA8Bb,EAAE,MAAM,EAAE,YAAY,EAAE;OACxB,EACL,cAAc,EACd,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB;AAED,eAAe,SAAS,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "conductor-node",
3
- "version": "12.0.0-beta.1",
3
+ "version": "12.0.0-beta.11",
4
4
  "description": "The official TypeScript library for the Conductor API",
5
5
  "author": "Conductor <support@conductor.is>",
6
6
  "types": "./index.d.ts",
@@ -2,24 +2,20 @@ import { APIResource } from "../resource.js";
2
2
  import * as Core from "../core.js";
3
3
  export declare class AuthSessions extends APIResource {
4
4
  /**
5
- * To launch the authentication flow, create an AuthSession and pass the returned
6
- * sessions `authFlowUrl` to the client for your end-user to visit in their
5
+ * To launch the authentication flow, create an auth session and pass the returned
6
+ * session's `authFlowUrl` to the client for your end-user to visit in their
7
7
  * browser.
8
8
  */
9
9
  create(body: AuthSessionCreateParams, options?: Core.RequestOptions): Core.APIPromise<AuthSession>;
10
- /**
11
- * Retrieves the details of an AuthSession that has previously been created.
12
- */
13
- retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<AuthSession>;
14
10
  }
15
11
  export interface AuthSession {
16
12
  /**
17
- * The unique identifier for this AuthSession.
13
+ * The unique identifier for this auth session.
18
14
  */
19
15
  id: string;
20
16
  /**
21
17
  * The URL of the authentication flow that you will pass to your client for your
22
- * user to set up their IntegrationConnection.
18
+ * user to set up their integration connection.
23
19
  */
24
20
  authFlowUrl: string;
25
21
  /**
@@ -27,17 +23,17 @@ export interface AuthSession {
27
23
  */
28
24
  clientSecret: string;
29
25
  /**
30
- * The date and time when this AuthSession record was created.
26
+ * The date and time when this auth session record was created.
31
27
  */
32
28
  createdAt: string;
33
29
  /**
34
- * The ID of the EndUser for whom to create an IntegrationConnection.
30
+ * The ID of the end-user for whom to create an integration connection.
35
31
  */
36
32
  endUserId: string;
37
33
  /**
38
- * The date and time when this AuthSession expires. By default, this value is 30
34
+ * The date and time when this auth session expires. By default, this value is 30
39
35
  * minutes from creation. You can extend this time by setting `linkExpiryMins` when
40
- * [creating the AuthSession](/apis/auth-sessions/create).
36
+ * creating the auth session.
41
37
  */
42
38
  expiresAt: string;
43
39
  /**
@@ -53,16 +49,16 @@ export interface AuthSession {
53
49
  }
54
50
  export interface AuthSessionCreateParams {
55
51
  /**
56
- * The ID of the EndUser for whom to create the IntegrationConnection.
52
+ * The ID of the end-user for whom to create the integration connection.
57
53
  */
58
54
  endUserId: string;
59
55
  /**
60
- * Your Conductor publishable key, which we use to create the sessions
56
+ * Your Conductor publishable key, which we use to create the auth session's
61
57
  * `authFlowUrl`.
62
58
  */
63
59
  publishableKey: string;
64
60
  /**
65
- * The number of minutes after which the AuthSession will expire. Must be at least
61
+ * The number of minutes after which the auth session will expire. Must be at least
66
62
  * 15 minutes and no more than 7 days. If not provided, defaults to 30 minutes.
67
63
  */
68
64
  linkExpiryMins?: number;
@@ -1 +1 @@
1
- {"version":3,"file":"auth-sessions.d.ts","sourceRoot":"","sources":["../src/resources/auth-sessions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;IAIlG;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;CAGlF;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,cAAc,CAAC;IAE3B;;;;OAIG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,WAAW,IAAI,WAAW,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;CACrG"}
1
+ {"version":3,"file":"auth-sessions.d.ts","sourceRoot":"","sources":["../src/resources/auth-sessions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;CAGnG;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,cAAc,CAAC;IAE3B;;;;OAIG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,WAAW,IAAI,WAAW,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;CACrG"}
@@ -5,19 +5,13 @@ exports.AuthSessions = void 0;
5
5
  const resource_1 = require("../resource.js");
6
6
  class AuthSessions extends resource_1.APIResource {
7
7
  /**
8
- * To launch the authentication flow, create an AuthSession and pass the returned
9
- * sessions `authFlowUrl` to the client for your end-user to visit in their
8
+ * To launch the authentication flow, create an auth session and pass the returned
9
+ * session's `authFlowUrl` to the client for your end-user to visit in their
10
10
  * browser.
11
11
  */
12
12
  create(body, options) {
13
13
  return this._client.post('/auth-sessions', { body, ...options });
14
14
  }
15
- /**
16
- * Retrieves the details of an AuthSession that has previously been created.
17
- */
18
- retrieve(id, options) {
19
- return this._client.get(`/auth-sessions/${id}`, options);
20
- }
21
15
  }
22
16
  exports.AuthSessions = AuthSessions;
23
17
  //# sourceMappingURL=auth-sessions.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"auth-sessions.js","sourceRoot":"","sources":["../src/resources/auth-sessions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;OAIG;IACH,MAAM,CAAC,IAA6B,EAAE,OAA6B;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAhBD,oCAgBC"}
1
+ {"version":3,"file":"auth-sessions.js","sourceRoot":"","sources":["../src/resources/auth-sessions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;OAIG;IACH,MAAM,CAAC,IAA6B,EAAE,OAA6B;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AATD,oCASC"}
@@ -2,18 +2,12 @@
2
2
  import { APIResource } from "../resource.mjs";
3
3
  export class AuthSessions extends APIResource {
4
4
  /**
5
- * To launch the authentication flow, create an AuthSession and pass the returned
6
- * sessions `authFlowUrl` to the client for your end-user to visit in their
5
+ * To launch the authentication flow, create an auth session and pass the returned
6
+ * session's `authFlowUrl` to the client for your end-user to visit in their
7
7
  * browser.
8
8
  */
9
9
  create(body, options) {
10
10
  return this._client.post('/auth-sessions', { body, ...options });
11
11
  }
12
- /**
13
- * Retrieves the details of an AuthSession that has previously been created.
14
- */
15
- retrieve(id, options) {
16
- return this._client.get(`/auth-sessions/${id}`, options);
17
- }
18
12
  }
19
13
  //# sourceMappingURL=auth-sessions.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"auth-sessions.mjs","sourceRoot":"","sources":["../src/resources/auth-sessions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;OAIG;IACH,MAAM,CAAC,IAA6B,EAAE,OAA6B;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF"}
1
+ {"version":3,"file":"auth-sessions.mjs","sourceRoot":"","sources":["../src/resources/auth-sessions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;OAIG;IACH,MAAM,CAAC,IAA6B,EAAE,OAA6B;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF"}