userplex 0.4.0 → 0.5.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 (13) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +7 -11
  3. package/package.json +1 -1
  4. package/resources/users.d.mts +6 -6
  5. package/resources/users.d.mts.map +1 -1
  6. package/resources/users.d.ts +6 -6
  7. package/resources/users.d.ts.map +1 -1
  8. package/src/resources/users.ts +6 -6
  9. package/src/version.ts +1 -1
  10. package/version.d.mts +1 -1
  11. package/version.d.ts +1 -1
  12. package/version.js +1 -1
  13. package/version.mjs +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.5.0 (2025-12-13)
4
+
5
+ Full Changelog: [v0.4.0...v0.5.0](https://github.com/dqnamo/userplex-typescript/compare/v0.4.0...v0.5.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([2b8b27e](https://github.com/dqnamo/userplex-typescript/commit/2b8b27ebd4c07df8559c1b69bd81ffcac1c2a7eb))
10
+
3
11
  ## 0.4.0 (2025-12-13)
4
12
 
5
13
  Full Changelog: [v0.3.0...v0.4.0](https://github.com/dqnamo/userplex-typescript/compare/v0.3.0...v0.4.0)
package/README.md CHANGED
@@ -26,11 +26,7 @@ const client = new Userplex({
26
26
  apiKey: process.env['USERPLEX_API_KEY'], // This is the default and can be omitted
27
27
  });
28
28
 
29
- const response = await client.users.identify({
30
- email: 'REPLACE_ME',
31
- name: 'REPLACE_ME',
32
- userId: 'REPLACE_ME',
33
- });
29
+ const response = await client.users.identify({ user_id: 'user_id', email: 'REPLACE_ME', name: 'REPLACE_ME' });
34
30
 
35
31
  console.log(response.success);
36
32
  ```
@@ -47,7 +43,7 @@ const client = new Userplex({
47
43
  apiKey: process.env['USERPLEX_API_KEY'], // This is the default and can be omitted
48
44
  });
49
45
 
50
- const params: Userplex.UserIdentifyParams = { email: 'REPLACE_ME', name: 'REPLACE_ME', userId: 'REPLACE_ME' };
46
+ const params: Userplex.UserIdentifyParams = { user_id: 'user_id', email: 'REPLACE_ME', name: 'REPLACE_ME' };
51
47
  const response: Userplex.UserIdentifyResponse = await client.users.identify(params);
52
48
  ```
53
49
 
@@ -62,7 +58,7 @@ a subclass of `APIError` will be thrown:
62
58
  <!-- prettier-ignore -->
63
59
  ```ts
64
60
  const response = await client.users
65
- .identify({ email: 'REPLACE_ME', name: 'REPLACE_ME', userId: 'REPLACE_ME' })
61
+ .identify({ user_id: 'user_id', email: 'REPLACE_ME', name: 'REPLACE_ME' })
66
62
  .catch(async (err) => {
67
63
  if (err instanceof Userplex.APIError) {
68
64
  console.log(err.status); // 400
@@ -103,7 +99,7 @@ const client = new Userplex({
103
99
  });
104
100
 
105
101
  // Or, configure per-request:
106
- await client.users.identify({ email: 'REPLACE_ME', name: 'REPLACE_ME', userId: 'REPLACE_ME' }, {
102
+ await client.users.identify({ user_id: 'user_id', email: 'REPLACE_ME', name: 'REPLACE_ME' }, {
107
103
  maxRetries: 5,
108
104
  });
109
105
  ```
@@ -120,7 +116,7 @@ const client = new Userplex({
120
116
  });
121
117
 
122
118
  // Override per-request:
123
- await client.users.identify({ email: 'REPLACE_ME', name: 'REPLACE_ME', userId: 'REPLACE_ME' }, {
119
+ await client.users.identify({ user_id: 'user_id', email: 'REPLACE_ME', name: 'REPLACE_ME' }, {
124
120
  timeout: 5 * 1000,
125
121
  });
126
122
  ```
@@ -144,13 +140,13 @@ Unlike `.asResponse()` this method consumes the body, returning once it is parse
144
140
  const client = new Userplex();
145
141
 
146
142
  const response = await client.users
147
- .identify({ email: 'REPLACE_ME', name: 'REPLACE_ME', userId: 'REPLACE_ME' })
143
+ .identify({ user_id: 'user_id', email: 'REPLACE_ME', name: 'REPLACE_ME' })
148
144
  .asResponse();
149
145
  console.log(response.headers.get('X-My-Header'));
150
146
  console.log(response.statusText); // access the underlying Response object
151
147
 
152
148
  const { data: response, response: raw } = await client.users
153
- .identify({ email: 'REPLACE_ME', name: 'REPLACE_ME', userId: 'REPLACE_ME' })
149
+ .identify({ user_id: 'user_id', email: 'REPLACE_ME', name: 'REPLACE_ME' })
154
150
  .withResponse();
155
151
  console.log(raw.headers.get('X-My-Header'));
156
152
  console.log(response.success);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "userplex",
3
- "version": "0.4.0",
3
+ "version": "0.5.0",
4
4
  "description": "The official TypeScript library for the Userplex API",
5
5
  "author": "Userplex <>",
6
6
  "types": "./index.d.ts",
package/resources/users.d.mts CHANGED
@@ -16,17 +16,17 @@ export interface UserIdentifyResponse {
16
16
  }
17
17
  export interface UserIdentifyParams {
18
18
  /**
19
- * User email address
19
+ * Unique identifier for the user
20
20
  */
21
- email: string;
21
+ user_id: string;
22
22
  /**
23
- * User full name
23
+ * User email address
24
24
  */
25
- name: string;
25
+ email?: string;
26
26
  /**
27
- * Unique identifier for the user
27
+ * User full name
28
28
  */
29
- userId: string;
29
+ name?: string;
30
30
  /**
31
31
  * Additional user properties
32
32
  */
package/resources/users.d.mts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG/F;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACzC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC7G"}
1
+ {"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG/F;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACzC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC7G"}
package/resources/users.d.ts CHANGED
@@ -16,17 +16,17 @@ export interface UserIdentifyResponse {
16
16
  }
17
17
  export interface UserIdentifyParams {
18
18
  /**
19
- * User email address
19
+ * Unique identifier for the user
20
20
  */
21
- email: string;
21
+ user_id: string;
22
22
  /**
23
- * User full name
23
+ * User email address
24
24
  */
25
- name: string;
25
+ email?: string;
26
26
  /**
27
- * Unique identifier for the user
27
+ * User full name
28
28
  */
29
- userId: string;
29
+ name?: string;
30
30
  /**
31
31
  * Additional user properties
32
32
  */
package/resources/users.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG/F;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACzC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC7G"}
1
+ {"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG/F;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACzC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC7G"}
package/src/resources/users.ts CHANGED
@@ -23,19 +23,19 @@ export interface UserIdentifyResponse {
23
23
 
24
24
  export interface UserIdentifyParams {
25
25
  /**
26
- * User email address
26
+ * Unique identifier for the user
27
27
  */
28
- email: string;
28
+ user_id: string;
29
29
 
30
30
  /**
31
- * User full name
31
+ * User email address
32
32
  */
33
- name: string;
33
+ email?: string;
34
34
 
35
35
  /**
36
- * Unique identifier for the user
36
+ * User full name
37
37
  */
38
- userId: string;
38
+ name?: string;
39
39
 
40
40
  /**
41
41
  * Additional user properties
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.4.0'; // x-release-please-version
1
+ export const VERSION = '0.5.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.4.0";
1
+ export declare const VERSION = "0.5.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.4.0";
1
+ export declare const VERSION = "0.5.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.4.0'; // x-release-please-version
4
+ exports.VERSION = '0.5.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.4.0'; // x-release-please-version
1
+ export const VERSION = '0.5.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map