@fonoster/sdk 0.13.2 → 0.13.4
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.
- package/README.md +11 -6
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -2138,7 +2138,7 @@ Note that an active Fonoster deployment is required.
|
|
|
2138
2138
|
* [.createUserWithOauth2Code(request)](#Users+createUserWithOauth2Code) ⇒ <code>Promise.<ExchangeCredentialsResponse></code>
|
|
2139
2139
|
* [.getUser(ref)](#Users+getUser) ⇒ <code>Promise.<Acl></code>
|
|
2140
2140
|
* [.updateUser(request)](#Users+updateUser) ⇒ <code>Promise.<BaseApiObject></code>
|
|
2141
|
-
* [.sendResetPasswordCode(
|
|
2141
|
+
* [.sendResetPasswordCode(request)](#Users+sendResetPasswordCode) ⇒ <code>Promise.<BaseApiObject></code>
|
|
2142
2142
|
* [.resetPassword(request)](#Users+resetPassword) ⇒ <code>Promise.<void></code>
|
|
2143
2143
|
* [.deleteUser(ref)](#Users+deleteUser) ⇒ <code>Promise.<BaseApiObject></code>
|
|
2144
2144
|
|
|
@@ -2284,24 +2284,29 @@ users
|
|
|
2284
2284
|
```
|
|
2285
2285
|
<a name="Users+sendResetPasswordCode"></a>
|
|
2286
2286
|
|
|
2287
|
-
### users.sendResetPasswordCode(
|
|
2287
|
+
### users.sendResetPasswordCode(request) ⇒ <code>Promise.<BaseApiObject></code>
|
|
2288
2288
|
Sends a reset password code to the User.
|
|
2289
2289
|
|
|
2290
2290
|
**Kind**: instance method of [<code>Users</code>](#Users)
|
|
2291
|
-
**Returns**: <code>Promise.<
|
|
2291
|
+
**Returns**: <code>Promise.<BaseApiObject></code> - - The response object that contains the reference to the User
|
|
2292
2292
|
|
|
2293
2293
|
| Param | Type | Description |
|
|
2294
2294
|
| --- | --- | --- |
|
|
2295
|
-
|
|
|
2295
|
+
| request | <code>SendResetPasswordCodeRequest</code> | The request object that contains the necessary information to send a reset password code to a User |
|
|
2296
|
+
| request.username | <code>string</code> | The username of the User |
|
|
2297
|
+
| request.resetPasswordUrl | <code>string</code> | The URL to reset the password |
|
|
2296
2298
|
|
|
2297
2299
|
**Example**
|
|
2298
2300
|
```js
|
|
2299
2301
|
const users = new SDK.Users(client); // Existing client object
|
|
2300
2302
|
|
|
2301
|
-
const
|
|
2303
|
+
const request = {
|
|
2304
|
+
username: "john.doe@example.com",
|
|
2305
|
+
resetPasswordUrl: "https://example.com/reset-password"
|
|
2306
|
+
};
|
|
2302
2307
|
|
|
2303
2308
|
users
|
|
2304
|
-
.sendResetPasswordCode(
|
|
2309
|
+
.sendResetPasswordCode(request)
|
|
2305
2310
|
.then(console.log) // successful response
|
|
2306
2311
|
.catch(console.error); // an error occurred
|
|
2307
2312
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fonoster/sdk",
|
|
3
|
-
"version": "0.13.
|
|
3
|
+
"version": "0.13.4",
|
|
4
4
|
"description": "Web and Node.js SDK for Fonoster",
|
|
5
5
|
"author": "Pedro Sanders <psanders@fonoster.com>",
|
|
6
6
|
"homepage": "https://github.com/fonoster/fonoster#readme",
|
|
@@ -26,8 +26,8 @@
|
|
|
26
26
|
"fonoster"
|
|
27
27
|
],
|
|
28
28
|
"dependencies": {
|
|
29
|
-
"@fonoster/common": "^0.13.
|
|
30
|
-
"@fonoster/types": "^0.13.
|
|
29
|
+
"@fonoster/common": "^0.13.4",
|
|
30
|
+
"@fonoster/types": "^0.13.4",
|
|
31
31
|
"@grpc/grpc-js": "~1.10.6",
|
|
32
32
|
"@grpc/proto-loader": "^0.7.12",
|
|
33
33
|
"google-protobuf": "^3.21.2",
|
|
@@ -62,5 +62,5 @@
|
|
|
62
62
|
"rollup": "^4.18.0",
|
|
63
63
|
"serve": "^14.2.3"
|
|
64
64
|
},
|
|
65
|
-
"gitHead": "
|
|
65
|
+
"gitHead": "78653d90bfd64bb1fe2f5279dfb832894642f17f"
|
|
66
66
|
}
|