Skip to content

Commit 94e43c2

Browse files
committed
new tokens API uri
1 parent 89bb378 commit 94e43c2

File tree

7 files changed

+120
-112
lines changed

7 files changed

+120
-112
lines changed

README.md

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -100,13 +100,13 @@ console.log(newsletter._response.status); // 200
100100
- [`cloudnode.subscriptions.delete(id)`](#cloudnodesubscriptionsdeleteid)
101101
- [`cloudnode.subscriptions.get(id)`](#cloudnodesubscriptionsgetid)
102102
- [`cloudnode.subscriptions.list([limit], [page])`](#cloudnodesubscriptionslistlimit-page)
103-
- [`cloudnode.token.create(permissions, lifetime, [note])`](#cloudnodetokencreatepermissions-lifetime-note)
104-
- [`cloudnode.token.get(id)`](#cloudnodetokengetid)
105-
- [`cloudnode.token.getRequest(id, request)`](#cloudnodetokengetrequestid-request)
106-
- [`cloudnode.token.list([limit], [page], [internal])`](#cloudnodetokenlistlimit-page-internal)
107-
- [`cloudnode.token.listRequests(id, [limit], [page])`](#cloudnodetokenlistrequestsid-limit-page)
108-
- [`cloudnode.token.revoke(id)`](#cloudnodetokenrevokeid)
109-
- [`cloudnode.tokens.refresh()`](#cloudnodetokensrefresh)
103+
- [`cloudnode.tokens.create(permissions, lifetime, [note])`](#cloudnodetokenscreatepermissions-lifetime-note)
104+
- [`cloudnode.tokens.get(id)`](#cloudnodetokensgetid)
105+
- [`cloudnode.tokens.getRequest(id, request)`](#cloudnodetokensgetrequestid-request)
106+
- [`cloudnode.tokens.list([limit], [page], [internal])`](#cloudnodetokenslistlimit-page-internal)
107+
- [`cloudnode.tokens.listRequests(id, [limit], [page])`](#cloudnodetokenslistrequestsid-limit-page)
108+
- [`cloudnode.tokens.refresh(id)`](#cloudnodetokensrefreshid)
109+
- [`cloudnode.tokens.revoke(id)`](#cloudnodetokensrevokeid)
110110

111111
- [Namespace: `Cloudnode`](#namespace-cloudnode)
112112
- [Class: `Cloudnode.ApiResponse<T>`](#class-cloudnodeapiresponset)
@@ -538,9 +538,9 @@ List newsletter subscriptions. Requires token with scope `newsletter.subscriptio
538538
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "INTERNAL_SERVER_ERROR"}</code>
539539
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "MAINTENANCE"}</code>
540540

541-
<a name="cloudnodetokencreatepermissions-lifetime-note"></a>
541+
<a name="cloudnodetokenscreatepermissions-lifetime-note"></a>
542542

543-
### `cloudnode.token.create(permissions, lifetime, [note])`
543+
### `cloudnode.tokens.create(permissions, lifetime, [note])`
544544

545545
Create token. Requires token with scope `tokens.create.own`.
546546

@@ -555,9 +555,9 @@ Create token. Requires token with scope `tokens.create.own`.
555555
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "INTERNAL_SERVER_ERROR"}</code>
556556
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "MAINTENANCE"}</code>
557557

558-
<a name="cloudnodetokengetid"></a>
558+
<a name="cloudnodetokensgetid"></a>
559559

560-
### `cloudnode.token.get(id)`
560+
### `cloudnode.tokens.get(id)`
561561

562562
Get token details. Requires token with scope `tokens.get.own`.
563563

@@ -571,9 +571,9 @@ Get token details. Requires token with scope `tokens.get.own`.
571571
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "INTERNAL_SERVER_ERROR"}</code>
572572
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "MAINTENANCE"}</code>
573573

574-
<a name="cloudnodetokengetrequestid-request"></a>
574+
<a name="cloudnodetokensgetrequestid-request"></a>
575575

576-
### `cloudnode.token.getRequest(id, request)`
576+
### `cloudnode.tokens.getRequest(id, request)`
577577

578578
Get a recent request by ID. Requires token with scope `tokens.get.own.requests`.
579579

@@ -582,15 +582,16 @@ Get a recent request by ID. Requires token with scope `tokens.get.own.requests`.
582582
- Returns: <code>[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Cloudnode.ApiResponse](#class-cloudnodeapiresponset)&lt;[Cloudnode.Request](#interface-cloudnoderequest)>></code>
583583
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "RESOURCE_NOT_FOUND"}</code>
584584
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "INVALID_DATA"}</code>
585+
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "MODIFICATION_NOT_ALLOWED"}</code>
585586
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "UNAUTHORIZED"}</code>
586587
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "NO_PERMISSION"}</code>
587588
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "RATE_LIMITED"}</code>
588589
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "INTERNAL_SERVER_ERROR"}</code>
589590
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "MAINTENANCE"}</code>
590591

591-
<a name="cloudnodetokenlistlimit-page-internal"></a>
592+
<a name="cloudnodetokenslistlimit-page-internal"></a>
592593

593-
### `cloudnode.token.list([limit], [page], [internal])`
594+
### `cloudnode.tokens.list([limit], [page], [internal])`
594595

595596
List tokens of user. Requires token with scope `tokens.list.own`.
596597

@@ -604,9 +605,9 @@ List tokens of user. Requires token with scope `tokens.list.own`.
604605
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "INTERNAL_SERVER_ERROR"}</code>
605606
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "MAINTENANCE"}</code>
606607

607-
<a name="cloudnodetokenlistrequestsid-limit-page"></a>
608+
<a name="cloudnodetokenslistrequestsid-limit-page"></a>
608609

609-
### `cloudnode.token.listRequests(id, [limit], [page])`
610+
### `cloudnode.tokens.listRequests(id, [limit], [page])`
610611

611612
Get list of recent requests made with the token. Requires token with scope `tokens.get.own.requests`.
612613

@@ -622,32 +623,32 @@ Get list of recent requests made with the token. Requires token with scope `toke
622623
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "INTERNAL_SERVER_ERROR"}</code>
623624
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "MAINTENANCE"}</code>
624625

625-
<a name="cloudnodetokenrevokeid"></a>
626+
<a name="cloudnodetokensrefreshid"></a>
626627

627-
### `cloudnode.token.revoke(id)`
628+
### `cloudnode.tokens.refresh(id)`
628629

629-
Revoke token. Requires token with scope `tokens.revoke.own`.
630+
Refresh current token. The token that was used to authenticate the request will be deleted. A new token with a new ID but the same permissions will be created and returned. The lifespan of the new token will be the same as the old one, starting from the time of the request. This operation effectively allows a token to be used indefinitely. Requires token with scope `token.refresh`.
630631

631-
- `id` <code>string | "current"</code> The ID of the token to revoke. Specify `current` to revoke the token that was used to authenticate the request.
632-
- Returns: <code>[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Cloudnode.ApiResponse](#class-cloudnodeapiresponset)&lt;[void](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)>></code>
633-
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "RESOURCE_NOT_FOUND"}</code>
632+
- `id` <code>string | "current"</code> The ID of the token to refresh. Specify `current` to refresh the token that was used to authenticate the request.
633+
- Returns: <code>[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Cloudnode.ApiResponse](#class-cloudnodeapiresponset)&lt;[Cloudnode.Token](#interface-cloudnodetoken)>></code>
634634
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "INVALID_DATA"}</code>
635-
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "MODIFICATION_NOT_ALLOWED"}</code>
636635
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "UNAUTHORIZED"}</code>
637636
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "NO_PERMISSION"}</code>
638637
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "RATE_LIMITED"}</code>
639638
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "INTERNAL_SERVER_ERROR"}</code>
640639
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "MAINTENANCE"}</code>
641640

642-
<a name="cloudnodetokensrefresh"></a>
641+
<a name="cloudnodetokensrevokeid"></a>
643642

644-
### `cloudnode.tokens.refresh()`
645-
646-
Refresh current token. The token that was used to authenticate the request will be deleted. A new token with a new ID but the same permissions will be created and returned. The lifespan of the new token will be the same as the old one, starting from the time of the request. This operation effectively allows a token to be used indefinitely. Requires token with scope `token.refresh`.
643+
### `cloudnode.tokens.revoke(id)`
647644

645+
Revoke token. Requires token with scope `tokens.revoke.own`.
648646

649-
- Returns: <code>[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Cloudnode.ApiResponse](#class-cloudnodeapiresponset)&lt;[Cloudnode.Token](#interface-cloudnodetoken)>></code>
647+
- `id` <code>string | "current"</code> The ID of the token to revoke. Specify `current` to revoke the token that was used to authenticate the request.
648+
- Returns: <code>[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Cloudnode.ApiResponse](#class-cloudnodeapiresponset)&lt;[void](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)>></code>
649+
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "RESOURCE_NOT_FOUND"}</code>
650650
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "INVALID_DATA"}</code>
651+
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "MODIFICATION_NOT_ALLOWED"}</code>
651652
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "UNAUTHORIZED"}</code>
652653
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "NO_PERMISSION"}</code>
653654
- Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror) & {code: "RATE_LIMITED"}</code>

0 commit comments

Comments
 (0)