@acmekit/js-sdk 2.13.31 → 2.13.32
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/package.json +2 -2
- package/dist/admin/api-key.d.ts +0 -164
- package/dist/admin/api-key.d.ts.map +0 -1
- package/dist/admin/api-key.js +0 -202
- package/dist/admin/api-key.js.map +0 -1
- package/dist/admin/index.d.ts +0 -57
- package/dist/admin/index.d.ts.map +0 -1
- package/dist/admin/index.js +0 -29
- package/dist/admin/index.js.map +0 -1
- package/dist/admin/invite.d.ts +0 -182
- package/dist/admin/invite.d.ts.map +0 -1
- package/dist/admin/invite.js +0 -211
- package/dist/admin/invite.js.map +0 -1
- package/dist/admin/locale.d.ts +0 -95
- package/dist/admin/locale.d.ts.map +0 -1
- package/dist/admin/locale.js +0 -104
- package/dist/admin/locale.js.map +0 -1
- package/dist/admin/notification.d.ts +0 -96
- package/dist/admin/notification.d.ts.map +0 -1
- package/dist/admin/notification.js +0 -107
- package/dist/admin/notification.js.map +0 -1
- package/dist/admin/plugin.d.ts +0 -27
- package/dist/admin/plugin.d.ts.map +0 -1
- package/dist/admin/plugin.js +0 -31
- package/dist/admin/plugin.js.map +0 -1
- package/dist/admin/translation.d.ts +0 -253
- package/dist/admin/translation.d.ts.map +0 -1
- package/dist/admin/translation.js +0 -284
- package/dist/admin/translation.js.map +0 -1
- package/dist/admin/upload.d.ts +0 -97
- package/dist/admin/upload.d.ts.map +0 -1
- package/dist/admin/upload.js +0 -139
- package/dist/admin/upload.js.map +0 -1
- package/dist/admin/user.d.ts +0 -166
- package/dist/admin/user.d.ts.map +0 -1
- package/dist/admin/user.js +0 -192
- package/dist/admin/user.js.map +0 -1
- package/dist/admin/views.d.ts +0 -54
- package/dist/admin/views.d.ts.map +0 -1
- package/dist/admin/views.js +0 -96
- package/dist/admin/views.js.map +0 -1
- package/dist/admin/workflow-execution.d.ts +0 -78
- package/dist/admin/workflow-execution.d.ts.map +0 -1
- package/dist/admin/workflow-execution.js +0 -86
- package/dist/admin/workflow-execution.js.map +0 -1
- package/dist/auth/index.d.ts +0 -264
- package/dist/auth/index.d.ts.map +0 -1
- package/dist/auth/index.js +0 -318
- package/dist/auth/index.js.map +0 -1
- package/dist/client.d.ts +0 -65
- package/dist/client.d.ts.map +0 -1
- package/dist/client.js +0 -315
- package/dist/client.js.map +0 -1
- package/dist/esm/admin/api-key.d.ts +0 -164
- package/dist/esm/admin/api-key.d.ts.map +0 -1
- package/dist/esm/admin/api-key.js +0 -221
- package/dist/esm/admin/api-key.js.map +0 -1
- package/dist/esm/admin/index.d.ts +0 -57
- package/dist/esm/admin/index.d.ts.map +0 -1
- package/dist/esm/admin/index.js +0 -25
- package/dist/esm/admin/index.js.map +0 -1
- package/dist/esm/admin/invite.d.ts +0 -182
- package/dist/esm/admin/invite.d.ts.map +0 -1
- package/dist/esm/admin/invite.js +0 -239
- package/dist/esm/admin/invite.js.map +0 -1
- package/dist/esm/admin/locale.d.ts +0 -95
- package/dist/esm/admin/locale.d.ts.map +0 -1
- package/dist/esm/admin/locale.js +0 -113
- package/dist/esm/admin/locale.js.map +0 -1
- package/dist/esm/admin/notification.d.ts +0 -96
- package/dist/esm/admin/notification.d.ts.map +0 -1
- package/dist/esm/admin/notification.js +0 -116
- package/dist/esm/admin/notification.js.map +0 -1
- package/dist/esm/admin/plugin.d.ts +0 -27
- package/dist/esm/admin/plugin.d.ts.map +0 -1
- package/dist/esm/admin/plugin.js +0 -38
- package/dist/esm/admin/plugin.js.map +0 -1
- package/dist/esm/admin/translation.d.ts +0 -253
- package/dist/esm/admin/translation.d.ts.map +0 -1
- package/dist/esm/admin/translation.js +0 -301
- package/dist/esm/admin/translation.js.map +0 -1
- package/dist/esm/admin/upload.d.ts +0 -97
- package/dist/esm/admin/upload.d.ts.map +0 -1
- package/dist/esm/admin/upload.js +0 -150
- package/dist/esm/admin/upload.js.map +0 -1
- package/dist/esm/admin/user.d.ts +0 -166
- package/dist/esm/admin/user.d.ts.map +0 -1
- package/dist/esm/admin/user.js +0 -207
- package/dist/esm/admin/user.js.map +0 -1
- package/dist/esm/admin/views.d.ts +0 -54
- package/dist/esm/admin/views.d.ts.map +0 -1
- package/dist/esm/admin/views.js +0 -117
- package/dist/esm/admin/views.js.map +0 -1
- package/dist/esm/admin/workflow-execution.d.ts +0 -78
- package/dist/esm/admin/workflow-execution.d.ts.map +0 -1
- package/dist/esm/admin/workflow-execution.js +0 -95
- package/dist/esm/admin/workflow-execution.js.map +0 -1
- package/dist/esm/auth/index.d.ts +0 -264
- package/dist/esm/auth/index.d.ts.map +0 -1
- package/dist/esm/auth/index.js +0 -325
- package/dist/esm/auth/index.js.map +0 -1
- package/dist/esm/client.d.ts +0 -65
- package/dist/esm/client.d.ts.map +0 -1
- package/dist/esm/client.js +0 -317
- package/dist/esm/client.js.map +0 -1
- package/dist/esm/index.d.ts +0 -18
- package/dist/esm/index.d.ts.map +0 -1
- package/dist/esm/index.js +0 -21
- package/dist/esm/index.js.map +0 -1
- package/dist/esm/types.d.ts +0 -60
- package/dist/esm/types.d.ts.map +0 -1
- package/dist/esm/types.js +0 -2
- package/dist/esm/types.js.map +0 -1
- package/dist/index.d.ts +0 -18
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js +0 -28
- package/dist/index.js.map +0 -1
- package/dist/types.d.ts +0 -60
- package/dist/types.d.ts.map +0 -1
- package/dist/types.js +0 -3
- package/dist/types.js.map +0 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@acmekit/js-sdk",
|
|
3
|
-
"version": "2.13.
|
|
3
|
+
"version": "2.13.32",
|
|
4
4
|
"description": "SDK for the AcmeKit API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"author": "AcmeKit",
|
|
30
30
|
"license": "MIT",
|
|
31
31
|
"devDependencies": {
|
|
32
|
-
"@acmekit/types": "2.13.
|
|
32
|
+
"@acmekit/types": "2.13.32"
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
35
|
"fetch-event-stream": "^0.1.5",
|
package/dist/admin/api-key.d.ts
DELETED
|
@@ -1,164 +0,0 @@
|
|
|
1
|
-
import { HttpTypes } from "@acmekit/types";
|
|
2
|
-
import { Client } from "../client";
|
|
3
|
-
import { ClientHeaders } from "../types";
|
|
4
|
-
export declare class ApiKey {
|
|
5
|
-
/**
|
|
6
|
-
* @ignore
|
|
7
|
-
*/
|
|
8
|
-
private client;
|
|
9
|
-
/**
|
|
10
|
-
* @ignore
|
|
11
|
-
*/
|
|
12
|
-
constructor(client: Client);
|
|
13
|
-
/**
|
|
14
|
-
* This methods retrieves a paginated list of API keys. It sends a request to the
|
|
15
|
-
* [List API Keys](https://docs.acmekit.com/api/admin#api-keys_getapikeys) API route.
|
|
16
|
-
*
|
|
17
|
-
* @param queryParams - Filters and pagination configurations.
|
|
18
|
-
* @param headers - Headers to pass in the request.
|
|
19
|
-
* @returns The paginated list of API keys.
|
|
20
|
-
*
|
|
21
|
-
* @example
|
|
22
|
-
* To retrieve the list of API keys:
|
|
23
|
-
*
|
|
24
|
-
* ```ts
|
|
25
|
-
* sdk.admin.apiKey.list()
|
|
26
|
-
* .then(({ api_keys, count, limit, offset }) => {
|
|
27
|
-
* console.log(api_keys)
|
|
28
|
-
* })
|
|
29
|
-
* ```
|
|
30
|
-
*
|
|
31
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
32
|
-
*
|
|
33
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
34
|
-
*
|
|
35
|
-
* ```ts
|
|
36
|
-
* sdk.admin.apiKey.list({
|
|
37
|
-
* limit: 10,
|
|
38
|
-
* offset: 10
|
|
39
|
-
* })
|
|
40
|
-
* .then(({ api_keys, count, limit, offset }) => {
|
|
41
|
-
* console.log(api_keys)
|
|
42
|
-
* })
|
|
43
|
-
* ```
|
|
44
|
-
*
|
|
45
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
46
|
-
* in each API key:
|
|
47
|
-
*
|
|
48
|
-
* ```ts
|
|
49
|
-
* sdk.admin.apiKey.list({
|
|
50
|
-
* fields: "id,*sales_channels"
|
|
51
|
-
* })
|
|
52
|
-
* .then(({ api_keys, count, limit, offset }) => {
|
|
53
|
-
* console.log(api_keys)
|
|
54
|
-
* })
|
|
55
|
-
* ```
|
|
56
|
-
*
|
|
57
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
|
|
58
|
-
*/
|
|
59
|
-
list(queryParams?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyListResponse>;
|
|
60
|
-
/**
|
|
61
|
-
* This method creates an API key. It sends a request to the [Create API Key](https://docs.acmekit.com/api/admin#api-keys_postapikeys)
|
|
62
|
-
* API route.
|
|
63
|
-
*
|
|
64
|
-
* @param body - The API key's details.
|
|
65
|
-
* @param query - Configure the fields to retrieve in the created API key.
|
|
66
|
-
* @param headers - Headers to pass in the request
|
|
67
|
-
* @returns The created API key
|
|
68
|
-
*
|
|
69
|
-
* @example
|
|
70
|
-
* sdk.admin.apiKey.create({
|
|
71
|
-
* title: "Development",
|
|
72
|
-
* type: "publishable"
|
|
73
|
-
* })
|
|
74
|
-
* .then(({ api_key }) => {
|
|
75
|
-
* console.log(api_key)
|
|
76
|
-
* })
|
|
77
|
-
*/
|
|
78
|
-
create(body: HttpTypes.AdminCreateApiKey, query?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
|
|
79
|
-
/**
|
|
80
|
-
* This method revokes an API key. It sends a request to the
|
|
81
|
-
* [Revoke API Key](https://docs.acmekit.com/api/admin#api-keys_postapikeysidrevoke) API route.
|
|
82
|
-
*
|
|
83
|
-
* @param id - The API key's ID.
|
|
84
|
-
* @param headers - Headers to pass in the request.
|
|
85
|
-
* @returns The API key's details.
|
|
86
|
-
*
|
|
87
|
-
* @example
|
|
88
|
-
* sdk.admin.apiKey.revoke("apk_123")
|
|
89
|
-
* .then(({ api_key }) => {
|
|
90
|
-
* console.log(api_key)
|
|
91
|
-
* })
|
|
92
|
-
*/
|
|
93
|
-
revoke(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
|
|
94
|
-
/**
|
|
95
|
-
* This method retrieves an API key's details. It sends a request to the
|
|
96
|
-
* [Get API key](https://docs.acmekit.com/api/admin#api-keys_getapikeysid) API route.
|
|
97
|
-
*
|
|
98
|
-
* @param id - The API key's ID.
|
|
99
|
-
* @param headers - Headers to pass in the request.
|
|
100
|
-
* @returns The API key's details.
|
|
101
|
-
*
|
|
102
|
-
* @example
|
|
103
|
-
* sdk.admin.apiKey.retrieve("apk_123")
|
|
104
|
-
* .then(({ api_key }) => {
|
|
105
|
-
* console.log(api_key)
|
|
106
|
-
* })
|
|
107
|
-
*/
|
|
108
|
-
retrieve(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
|
|
109
|
-
/**
|
|
110
|
-
* This method updates an API key's details. It sends a request to the
|
|
111
|
-
* [Update API Key](https://docs.acmekit.com/api/admin#api-keys_postapikeysid) API route.
|
|
112
|
-
*
|
|
113
|
-
* @param id - The API key's ID.
|
|
114
|
-
* @param body - The data to update in the API key.
|
|
115
|
-
* @param query - Configure the fields to retrieve in the API key.
|
|
116
|
-
* @param headers - Headers to pass in the request.
|
|
117
|
-
* @returns The API key's details.
|
|
118
|
-
*
|
|
119
|
-
* @example
|
|
120
|
-
* sdk.admin.apiKey.update("apk_123", {
|
|
121
|
-
* title: "Development"
|
|
122
|
-
* })
|
|
123
|
-
* .then(({ api_key }) => {
|
|
124
|
-
* console.log(api_key)
|
|
125
|
-
* })
|
|
126
|
-
*/
|
|
127
|
-
update(id: string, body: HttpTypes.AdminUpdateApiKey, query?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
|
|
128
|
-
/**
|
|
129
|
-
* This method deletes an API key by its ID. It sends a request to the
|
|
130
|
-
* [Delete API Key](https://docs.acmekit.com/api/admin#api-keys_deleteapikeysid) API route.
|
|
131
|
-
*
|
|
132
|
-
* @param id - The API key's ID.
|
|
133
|
-
* @param headers - Headers to pass in the request.
|
|
134
|
-
* @returns The deletion's details.
|
|
135
|
-
*
|
|
136
|
-
* @example
|
|
137
|
-
* sdk.admin.apiKey.delete("apk_123")
|
|
138
|
-
* .then(({ deleted }) => {
|
|
139
|
-
* console.log(deleted)
|
|
140
|
-
* })
|
|
141
|
-
*/
|
|
142
|
-
delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyDeleteResponse>;
|
|
143
|
-
/**
|
|
144
|
-
* This method manages the sales channels associated with a publishable API key to either add
|
|
145
|
-
* or remove associations. It sends a request to the [Manage Sales Channels](https://docs.acmekit.com/api/admin#api-keys_postapikeysidsaleschannels)
|
|
146
|
-
* API route.
|
|
147
|
-
*
|
|
148
|
-
* @param id - The API key's ID.
|
|
149
|
-
* @param body - The sales channels to add or remove from the API key.
|
|
150
|
-
* @param headers - Headers to pass in the request.
|
|
151
|
-
* @returns The API key's details.
|
|
152
|
-
*
|
|
153
|
-
* @example
|
|
154
|
-
* sdk.admin.apiKey.batchSalesChannels("apk_123", {
|
|
155
|
-
* add: ["sc_123"],
|
|
156
|
-
* remove: ["sc_321"]
|
|
157
|
-
* })
|
|
158
|
-
* .then(({ api_key }) => {
|
|
159
|
-
* console.log(api_key)
|
|
160
|
-
* })
|
|
161
|
-
*/
|
|
162
|
-
batchSalesChannels(id: string, body: HttpTypes.AdminBatchLink, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
|
|
163
|
-
}
|
|
164
|
-
//# sourceMappingURL=api-key.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../src/admin/api-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,qBAAqB,EAC7C,OAAO,CAAC,EAAE,aAAa;IAUzB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;OAaG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IASlD;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;OAkBG;IACG,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,cAAc,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}
|
package/dist/admin/api-key.js
DELETED
|
@@ -1,202 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ApiKey = void 0;
|
|
4
|
-
class ApiKey {
|
|
5
|
-
/**
|
|
6
|
-
* @ignore
|
|
7
|
-
*/
|
|
8
|
-
constructor(client) {
|
|
9
|
-
this.client = client;
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* This methods retrieves a paginated list of API keys. It sends a request to the
|
|
13
|
-
* [List API Keys](https://docs.acmekit.com/api/admin#api-keys_getapikeys) API route.
|
|
14
|
-
*
|
|
15
|
-
* @param queryParams - Filters and pagination configurations.
|
|
16
|
-
* @param headers - Headers to pass in the request.
|
|
17
|
-
* @returns The paginated list of API keys.
|
|
18
|
-
*
|
|
19
|
-
* @example
|
|
20
|
-
* To retrieve the list of API keys:
|
|
21
|
-
*
|
|
22
|
-
* ```ts
|
|
23
|
-
* sdk.admin.apiKey.list()
|
|
24
|
-
* .then(({ api_keys, count, limit, offset }) => {
|
|
25
|
-
* console.log(api_keys)
|
|
26
|
-
* })
|
|
27
|
-
* ```
|
|
28
|
-
*
|
|
29
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
30
|
-
*
|
|
31
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
32
|
-
*
|
|
33
|
-
* ```ts
|
|
34
|
-
* sdk.admin.apiKey.list({
|
|
35
|
-
* limit: 10,
|
|
36
|
-
* offset: 10
|
|
37
|
-
* })
|
|
38
|
-
* .then(({ api_keys, count, limit, offset }) => {
|
|
39
|
-
* console.log(api_keys)
|
|
40
|
-
* })
|
|
41
|
-
* ```
|
|
42
|
-
*
|
|
43
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
44
|
-
* in each API key:
|
|
45
|
-
*
|
|
46
|
-
* ```ts
|
|
47
|
-
* sdk.admin.apiKey.list({
|
|
48
|
-
* fields: "id,*sales_channels"
|
|
49
|
-
* })
|
|
50
|
-
* .then(({ api_keys, count, limit, offset }) => {
|
|
51
|
-
* console.log(api_keys)
|
|
52
|
-
* })
|
|
53
|
-
* ```
|
|
54
|
-
*
|
|
55
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
|
|
56
|
-
*/
|
|
57
|
-
async list(queryParams, headers) {
|
|
58
|
-
return await this.client.fetch(`/admin/api-keys`, {
|
|
59
|
-
query: queryParams,
|
|
60
|
-
headers,
|
|
61
|
-
});
|
|
62
|
-
}
|
|
63
|
-
/**
|
|
64
|
-
* This method creates an API key. It sends a request to the [Create API Key](https://docs.acmekit.com/api/admin#api-keys_postapikeys)
|
|
65
|
-
* API route.
|
|
66
|
-
*
|
|
67
|
-
* @param body - The API key's details.
|
|
68
|
-
* @param query - Configure the fields to retrieve in the created API key.
|
|
69
|
-
* @param headers - Headers to pass in the request
|
|
70
|
-
* @returns The created API key
|
|
71
|
-
*
|
|
72
|
-
* @example
|
|
73
|
-
* sdk.admin.apiKey.create({
|
|
74
|
-
* title: "Development",
|
|
75
|
-
* type: "publishable"
|
|
76
|
-
* })
|
|
77
|
-
* .then(({ api_key }) => {
|
|
78
|
-
* console.log(api_key)
|
|
79
|
-
* })
|
|
80
|
-
*/
|
|
81
|
-
async create(body, query, headers) {
|
|
82
|
-
return await this.client.fetch(`/admin/api-keys`, {
|
|
83
|
-
method: "POST",
|
|
84
|
-
headers,
|
|
85
|
-
body,
|
|
86
|
-
query,
|
|
87
|
-
});
|
|
88
|
-
}
|
|
89
|
-
/**
|
|
90
|
-
* This method revokes an API key. It sends a request to the
|
|
91
|
-
* [Revoke API Key](https://docs.acmekit.com/api/admin#api-keys_postapikeysidrevoke) API route.
|
|
92
|
-
*
|
|
93
|
-
* @param id - The API key's ID.
|
|
94
|
-
* @param headers - Headers to pass in the request.
|
|
95
|
-
* @returns The API key's details.
|
|
96
|
-
*
|
|
97
|
-
* @example
|
|
98
|
-
* sdk.admin.apiKey.revoke("apk_123")
|
|
99
|
-
* .then(({ api_key }) => {
|
|
100
|
-
* console.log(api_key)
|
|
101
|
-
* })
|
|
102
|
-
*/
|
|
103
|
-
async revoke(id, headers) {
|
|
104
|
-
return await this.client.fetch(`/admin/api-keys/${id}/revoke`, {
|
|
105
|
-
method: "POST",
|
|
106
|
-
headers,
|
|
107
|
-
});
|
|
108
|
-
}
|
|
109
|
-
/**
|
|
110
|
-
* This method retrieves an API key's details. It sends a request to the
|
|
111
|
-
* [Get API key](https://docs.acmekit.com/api/admin#api-keys_getapikeysid) API route.
|
|
112
|
-
*
|
|
113
|
-
* @param id - The API key's ID.
|
|
114
|
-
* @param headers - Headers to pass in the request.
|
|
115
|
-
* @returns The API key's details.
|
|
116
|
-
*
|
|
117
|
-
* @example
|
|
118
|
-
* sdk.admin.apiKey.retrieve("apk_123")
|
|
119
|
-
* .then(({ api_key }) => {
|
|
120
|
-
* console.log(api_key)
|
|
121
|
-
* })
|
|
122
|
-
*/
|
|
123
|
-
async retrieve(id, headers) {
|
|
124
|
-
return await this.client.fetch(`/admin/api-keys/${id}`, {
|
|
125
|
-
headers,
|
|
126
|
-
});
|
|
127
|
-
}
|
|
128
|
-
/**
|
|
129
|
-
* This method updates an API key's details. It sends a request to the
|
|
130
|
-
* [Update API Key](https://docs.acmekit.com/api/admin#api-keys_postapikeysid) API route.
|
|
131
|
-
*
|
|
132
|
-
* @param id - The API key's ID.
|
|
133
|
-
* @param body - The data to update in the API key.
|
|
134
|
-
* @param query - Configure the fields to retrieve in the API key.
|
|
135
|
-
* @param headers - Headers to pass in the request.
|
|
136
|
-
* @returns The API key's details.
|
|
137
|
-
*
|
|
138
|
-
* @example
|
|
139
|
-
* sdk.admin.apiKey.update("apk_123", {
|
|
140
|
-
* title: "Development"
|
|
141
|
-
* })
|
|
142
|
-
* .then(({ api_key }) => {
|
|
143
|
-
* console.log(api_key)
|
|
144
|
-
* })
|
|
145
|
-
*/
|
|
146
|
-
async update(id, body, query, headers) {
|
|
147
|
-
return await this.client.fetch(`/admin/api-keys/${id}`, {
|
|
148
|
-
method: "POST",
|
|
149
|
-
headers,
|
|
150
|
-
body,
|
|
151
|
-
query,
|
|
152
|
-
});
|
|
153
|
-
}
|
|
154
|
-
/**
|
|
155
|
-
* This method deletes an API key by its ID. It sends a request to the
|
|
156
|
-
* [Delete API Key](https://docs.acmekit.com/api/admin#api-keys_deleteapikeysid) API route.
|
|
157
|
-
*
|
|
158
|
-
* @param id - The API key's ID.
|
|
159
|
-
* @param headers - Headers to pass in the request.
|
|
160
|
-
* @returns The deletion's details.
|
|
161
|
-
*
|
|
162
|
-
* @example
|
|
163
|
-
* sdk.admin.apiKey.delete("apk_123")
|
|
164
|
-
* .then(({ deleted }) => {
|
|
165
|
-
* console.log(deleted)
|
|
166
|
-
* })
|
|
167
|
-
*/
|
|
168
|
-
async delete(id, headers) {
|
|
169
|
-
return await this.client.fetch(`/admin/api-keys/${id}`, {
|
|
170
|
-
method: "DELETE",
|
|
171
|
-
headers,
|
|
172
|
-
});
|
|
173
|
-
}
|
|
174
|
-
/**
|
|
175
|
-
* This method manages the sales channels associated with a publishable API key to either add
|
|
176
|
-
* or remove associations. It sends a request to the [Manage Sales Channels](https://docs.acmekit.com/api/admin#api-keys_postapikeysidsaleschannels)
|
|
177
|
-
* API route.
|
|
178
|
-
*
|
|
179
|
-
* @param id - The API key's ID.
|
|
180
|
-
* @param body - The sales channels to add or remove from the API key.
|
|
181
|
-
* @param headers - Headers to pass in the request.
|
|
182
|
-
* @returns The API key's details.
|
|
183
|
-
*
|
|
184
|
-
* @example
|
|
185
|
-
* sdk.admin.apiKey.batchSalesChannels("apk_123", {
|
|
186
|
-
* add: ["sc_123"],
|
|
187
|
-
* remove: ["sc_321"]
|
|
188
|
-
* })
|
|
189
|
-
* .then(({ api_key }) => {
|
|
190
|
-
* console.log(api_key)
|
|
191
|
-
* })
|
|
192
|
-
*/
|
|
193
|
-
async batchSalesChannels(id, body, headers) {
|
|
194
|
-
return await this.client.fetch(`/admin/api-keys/${id}/sales-channels`, {
|
|
195
|
-
method: "POST",
|
|
196
|
-
headers,
|
|
197
|
-
body,
|
|
198
|
-
});
|
|
199
|
-
}
|
|
200
|
-
}
|
|
201
|
-
exports.ApiKey = ApiKey;
|
|
202
|
-
//# sourceMappingURL=api-key.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"api-key.js","sourceRoot":"","sources":["../../src/admin/api-key.ts"],"names":[],"mappings":";;;AAIA,MAAa,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,WAA6C,EAC7C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,iBAAiB,EAAE;YACnB,KAAK,EAAE,WAAW;YAClB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAAiC,EACjC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EACjB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,SAAS,EAC9B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,OAAuB;QAChD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;YACE,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAiC,EACjC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,kBAAkB,CACtB,EAAU,EACV,IAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,iBAAiB,EACtC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AAnPD,wBAmPC"}
|
package/dist/admin/index.d.ts
DELETED
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
import { Client } from "../client";
|
|
2
|
-
import { ApiKey } from "./api-key";
|
|
3
|
-
import { Invite } from "./invite";
|
|
4
|
-
import { Locale } from "./locale";
|
|
5
|
-
import { Notification } from "./notification";
|
|
6
|
-
import { Plugin } from "./plugin";
|
|
7
|
-
import { Translation } from "./translation";
|
|
8
|
-
import { Upload } from "./upload";
|
|
9
|
-
import { User } from "./user";
|
|
10
|
-
import { Views } from "./views";
|
|
11
|
-
import { WorkflowExecution } from "./workflow-execution";
|
|
12
|
-
export declare class Admin {
|
|
13
|
-
/**
|
|
14
|
-
* @tags user
|
|
15
|
-
*/
|
|
16
|
-
invite: Invite;
|
|
17
|
-
/**
|
|
18
|
-
* @tags file
|
|
19
|
-
*/
|
|
20
|
-
upload: Upload;
|
|
21
|
-
/**
|
|
22
|
-
* @tags notification
|
|
23
|
-
*/
|
|
24
|
-
notification: Notification;
|
|
25
|
-
/**
|
|
26
|
-
* @tags user
|
|
27
|
-
*/
|
|
28
|
-
user: User;
|
|
29
|
-
/**
|
|
30
|
-
* @tags locale
|
|
31
|
-
* @since 2.12.3
|
|
32
|
-
*/
|
|
33
|
-
locale: Locale;
|
|
34
|
-
/**
|
|
35
|
-
* @tags api key
|
|
36
|
-
*/
|
|
37
|
-
apiKey: ApiKey;
|
|
38
|
-
/**
|
|
39
|
-
* @tags workflow
|
|
40
|
-
*/
|
|
41
|
-
workflowExecution: WorkflowExecution;
|
|
42
|
-
/**
|
|
43
|
-
* @tags translations
|
|
44
|
-
*/
|
|
45
|
-
translation: Translation;
|
|
46
|
-
/**
|
|
47
|
-
* @tags plugin
|
|
48
|
-
*/
|
|
49
|
-
plugin: Plugin;
|
|
50
|
-
/**
|
|
51
|
-
* @tags views
|
|
52
|
-
* @featureFlag view_configurations
|
|
53
|
-
*/
|
|
54
|
-
views: Views;
|
|
55
|
-
constructor(client: Client);
|
|
56
|
-
}
|
|
57
|
-
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/admin/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAExD,qBAAa,KAAK;IAChB;;OAEG;IACI,MAAM,EAAE,MAAM,CAAA;IACrB;;OAEG;IACI,MAAM,EAAE,MAAM,CAAA;IACrB;;OAEG;IACI,YAAY,EAAE,YAAY,CAAA;IACjC;;OAEG;IACI,IAAI,EAAE,IAAI,CAAA;IACjB;;;OAGG;IACI,MAAM,EAAE,MAAM,CAAA;IACrB;;OAEG;IACI,MAAM,EAAE,MAAM,CAAA;IACrB;;OAEG;IACI,iBAAiB,EAAE,iBAAiB,CAAA;IAC3C;;OAEG;IACI,WAAW,EAAE,WAAW,CAAA;IAC/B;;OAEG;IACI,MAAM,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACI,KAAK,EAAE,KAAK,CAAA;gBAEP,MAAM,EAAE,MAAM;CAY3B"}
|
package/dist/admin/index.js
DELETED
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.Admin = void 0;
|
|
4
|
-
const api_key_1 = require("./api-key");
|
|
5
|
-
const invite_1 = require("./invite");
|
|
6
|
-
const locale_1 = require("./locale");
|
|
7
|
-
const notification_1 = require("./notification");
|
|
8
|
-
const plugin_1 = require("./plugin");
|
|
9
|
-
const translation_1 = require("./translation");
|
|
10
|
-
const upload_1 = require("./upload");
|
|
11
|
-
const user_1 = require("./user");
|
|
12
|
-
const views_1 = require("./views");
|
|
13
|
-
const workflow_execution_1 = require("./workflow-execution");
|
|
14
|
-
class Admin {
|
|
15
|
-
constructor(client) {
|
|
16
|
-
this.invite = new invite_1.Invite(client);
|
|
17
|
-
this.upload = new upload_1.Upload(client);
|
|
18
|
-
this.notification = new notification_1.Notification(client);
|
|
19
|
-
this.user = new user_1.User(client);
|
|
20
|
-
this.locale = new locale_1.Locale(client);
|
|
21
|
-
this.apiKey = new api_key_1.ApiKey(client);
|
|
22
|
-
this.workflowExecution = new workflow_execution_1.WorkflowExecution(client);
|
|
23
|
-
this.translation = new translation_1.Translation(client);
|
|
24
|
-
this.plugin = new plugin_1.Plugin(client);
|
|
25
|
-
this.views = new views_1.Views(client);
|
|
26
|
-
}
|
|
27
|
-
}
|
|
28
|
-
exports.Admin = Admin;
|
|
29
|
-
//# sourceMappingURL=index.js.map
|
package/dist/admin/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/admin/index.ts"],"names":[],"mappings":";;;AACA,uCAAkC;AAClC,qCAAiC;AACjC,qCAAiC;AACjC,iDAA6C;AAC7C,qCAAiC;AACjC,+CAA2C;AAC3C,qCAAiC;AACjC,iCAA6B;AAC7B,mCAA+B;AAC/B,6DAAwD;AAExD,MAAa,KAAK;IA4ChB,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,MAAM,CAAC,CAAA;QAChC,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,MAAM,CAAC,CAAA;QAChC,IAAI,CAAC,YAAY,GAAG,IAAI,2BAAY,CAAC,MAAM,CAAC,CAAA;QAC5C,IAAI,CAAC,IAAI,GAAG,IAAI,WAAI,CAAC,MAAM,CAAC,CAAA;QAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,MAAM,CAAC,CAAA;QAChC,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,MAAM,CAAC,CAAA;QAChC,IAAI,CAAC,iBAAiB,GAAG,IAAI,sCAAiB,CAAC,MAAM,CAAC,CAAA;QACtD,IAAI,CAAC,WAAW,GAAG,IAAI,yBAAW,CAAC,MAAM,CAAC,CAAA;QAC1C,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,MAAM,CAAC,CAAA;QAChC,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAAC,MAAM,CAAC,CAAA;IAChC,CAAC;CACF;AAxDD,sBAwDC"}
|
package/dist/admin/invite.d.ts
DELETED
|
@@ -1,182 +0,0 @@
|
|
|
1
|
-
import { FindParams, HttpTypes, SelectParams } from "@acmekit/types";
|
|
2
|
-
import { Client } from "../client";
|
|
3
|
-
import { ClientHeaders } from "../types";
|
|
4
|
-
export declare class Invite {
|
|
5
|
-
/**
|
|
6
|
-
* @ignore
|
|
7
|
-
*/
|
|
8
|
-
private client;
|
|
9
|
-
/**
|
|
10
|
-
* @ignore
|
|
11
|
-
*/
|
|
12
|
-
constructor(client: Client);
|
|
13
|
-
/**
|
|
14
|
-
* This method accepts an invite. It requires sending a previous request to
|
|
15
|
-
* the {@link Auth.register}.
|
|
16
|
-
*
|
|
17
|
-
* This method sends a request to the [Accept Invite]
|
|
18
|
-
* (https://docs.acmekit.com/api/admin#invites_postinvitesaccept)
|
|
19
|
-
* API route.
|
|
20
|
-
*
|
|
21
|
-
* @param input - The details of the user to create.
|
|
22
|
-
* @param query - Configure the fields to retrieve in the user.
|
|
23
|
-
* @param headers - Headers to pass in the request
|
|
24
|
-
* @returns The user's details.
|
|
25
|
-
*
|
|
26
|
-
* @example
|
|
27
|
-
* await sdk.auth.register("user", "emailpass", {
|
|
28
|
-
* email: "user@gmail.com",
|
|
29
|
-
* password: "supersecret"
|
|
30
|
-
* })
|
|
31
|
-
*
|
|
32
|
-
* // all subsequent requests will use the token in the header
|
|
33
|
-
* const { user } = await sdk.admin.invite.accept(
|
|
34
|
-
* {
|
|
35
|
-
* email: "user@gmail.com",
|
|
36
|
-
* first_name: "John",
|
|
37
|
-
* last_name: "Smith",
|
|
38
|
-
* invite_token: "12345..."
|
|
39
|
-
* },
|
|
40
|
-
* )
|
|
41
|
-
*/
|
|
42
|
-
accept(input: HttpTypes.AdminAcceptInvite & {
|
|
43
|
-
/**
|
|
44
|
-
* The invite's token.
|
|
45
|
-
*/
|
|
46
|
-
invite_token: string;
|
|
47
|
-
}, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminAcceptInviteResponse>;
|
|
48
|
-
/**
|
|
49
|
-
* This method creates an invite. It sends a request to the
|
|
50
|
-
* [Create Invite](https://docs.acmekit.com/api/admin#invites_postinvites)
|
|
51
|
-
* API route.
|
|
52
|
-
*
|
|
53
|
-
* @param body - The invite's details.
|
|
54
|
-
* @param query - Configure the fields to retrieve in the invite.
|
|
55
|
-
* @param headers - Headers to pass in the request
|
|
56
|
-
* @returns The invite's details.
|
|
57
|
-
*
|
|
58
|
-
* @example
|
|
59
|
-
* sdk.admin.invite.create({
|
|
60
|
-
* email: "user@gmail.com",
|
|
61
|
-
* })
|
|
62
|
-
* .then(({ invite }) => {
|
|
63
|
-
* console.log(invite)
|
|
64
|
-
* })
|
|
65
|
-
*/
|
|
66
|
-
create(body: HttpTypes.AdminCreateInvite, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteResponse>;
|
|
67
|
-
/**
|
|
68
|
-
* This method retrieves an invite by its ID. It sends a request to the
|
|
69
|
-
* [Get Invite](https://docs.acmekit.com/api/admin#invites_getinvitesid)
|
|
70
|
-
* API route.
|
|
71
|
-
*
|
|
72
|
-
* @param id - The invite's ID.
|
|
73
|
-
* @param query - Configure the fields to retrieve in the invite.
|
|
74
|
-
* @param headers - Headers to pass in the request
|
|
75
|
-
* @returns The invite's details.
|
|
76
|
-
*
|
|
77
|
-
* @example
|
|
78
|
-
* To retrieve an invite its ID:
|
|
79
|
-
*
|
|
80
|
-
* ```ts
|
|
81
|
-
* sdk.admin.invite.retrieve("invite_123")
|
|
82
|
-
* .then(({ invite }) => {
|
|
83
|
-
* console.log(invite)
|
|
84
|
-
* })
|
|
85
|
-
* ```
|
|
86
|
-
*
|
|
87
|
-
* To specify the fields and relations to retrieve:
|
|
88
|
-
*
|
|
89
|
-
* ```ts
|
|
90
|
-
* sdk.admin.invite.retrieve("invite_123", {
|
|
91
|
-
* fields: "id,email"
|
|
92
|
-
* })
|
|
93
|
-
* .then(({ invite }) => {
|
|
94
|
-
* console.log(invite)
|
|
95
|
-
* })
|
|
96
|
-
* ```
|
|
97
|
-
*
|
|
98
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
|
|
99
|
-
*/
|
|
100
|
-
retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteResponse>;
|
|
101
|
-
/**
|
|
102
|
-
* This method retrieves a paginated list of invites. It sends a request to the
|
|
103
|
-
* [List Invites](https://docs.acmekit.com/api/admin#invites_getinvites)
|
|
104
|
-
* API route.
|
|
105
|
-
*
|
|
106
|
-
* @param queryParams - Filters and pagination configurations.
|
|
107
|
-
* @param headers - Headers to pass in the request.
|
|
108
|
-
* @returns The paginated list of invites.
|
|
109
|
-
*
|
|
110
|
-
* @example
|
|
111
|
-
* To retrieve the list of invites:
|
|
112
|
-
*
|
|
113
|
-
* ```ts
|
|
114
|
-
* sdk.admin.invite.list()
|
|
115
|
-
* .then(({ invites, count, limit, offset }) => {
|
|
116
|
-
* console.log(invites)
|
|
117
|
-
* })
|
|
118
|
-
* ```
|
|
119
|
-
*
|
|
120
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
121
|
-
*
|
|
122
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
123
|
-
*
|
|
124
|
-
* ```ts
|
|
125
|
-
* sdk.admin.invite.list({
|
|
126
|
-
* limit: 10,
|
|
127
|
-
* offset: 10
|
|
128
|
-
* })
|
|
129
|
-
* .then(({ invites, count, limit, offset }) => {
|
|
130
|
-
* console.log(invites)
|
|
131
|
-
* })
|
|
132
|
-
* ```
|
|
133
|
-
*
|
|
134
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
135
|
-
* in each invite:
|
|
136
|
-
*
|
|
137
|
-
* ```ts
|
|
138
|
-
* sdk.admin.invite.list({
|
|
139
|
-
* fields: "id,email"
|
|
140
|
-
* })
|
|
141
|
-
* .then(({ invites, count, limit, offset }) => {
|
|
142
|
-
* console.log(invites)
|
|
143
|
-
* })
|
|
144
|
-
* ```
|
|
145
|
-
*
|
|
146
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
|
|
147
|
-
*/
|
|
148
|
-
list(queryParams?: FindParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteListResponse>;
|
|
149
|
-
/**
|
|
150
|
-
* This method refreshes the token of an invite. It sends a request to the
|
|
151
|
-
* [Refresh Invite Token](https://docs.acmekit.com/api/admin#invites_postinvitesidresend)
|
|
152
|
-
* API route.
|
|
153
|
-
*
|
|
154
|
-
* @param id - The invite's ID.
|
|
155
|
-
* @param headers - Headers to pass in the request.
|
|
156
|
-
* @returns The invite's details.
|
|
157
|
-
*
|
|
158
|
-
* @example
|
|
159
|
-
* sdk.admin.invite.resend("invite_123")
|
|
160
|
-
* .then(({ invite }) => {
|
|
161
|
-
* console.log(invite)
|
|
162
|
-
* })
|
|
163
|
-
*/
|
|
164
|
-
resend(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteResponse>;
|
|
165
|
-
/**
|
|
166
|
-
* This method deletes an invite. It sends a request to the
|
|
167
|
-
* [Delete Invite](https://docs.acmekit.com/api/admin#invites_deleteinvitesid)
|
|
168
|
-
* API route.
|
|
169
|
-
*
|
|
170
|
-
* @param id - The invite's ID.
|
|
171
|
-
* @param headers - Headers to pass in the request.
|
|
172
|
-
* @returns The deletion's details.
|
|
173
|
-
*
|
|
174
|
-
* @example
|
|
175
|
-
* sdk.admin.invite.delete("invite_123")
|
|
176
|
-
* .then(({ deleted }) => {
|
|
177
|
-
* console.log(deleted)
|
|
178
|
-
* })
|
|
179
|
-
*/
|
|
180
|
-
delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteDeleteResponse>;
|
|
181
|
-
}
|
|
182
|
-
//# sourceMappingURL=invite.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"invite.d.ts","sourceRoot":"","sources":["../../src/admin/invite.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EACT,YAAY,EACb,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,MAAM,CACV,KAAK,EAAE,SAAS,CAAC,iBAAiB,GAAG;QACnC;;WAEG;QACH,YAAY,EAAE,MAAM,CAAA;KACrB,EACD,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAczB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;IAUxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,aAAa;IAS5D;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}
|