@foru-ms/sdk 2.0.5 → 2.0.7
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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +1 -1
- package/dist/cjs/Client.js +1 -1
- package/dist/cjs/api/resources/auth/client/Client.d.ts +13 -1
- package/dist/cjs/api/resources/auth/client/Client.js +29 -5
- package/dist/cjs/api/resources/auth/types/GetAuthMeResponse.d.ts +7 -2
- package/dist/cjs/api/resources/auth/types/PostAuthForgotPasswordResponse.d.ts +7 -2
- package/dist/cjs/api/resources/auth/types/PostAuthLoginResponse.d.ts +20 -1
- package/dist/cjs/api/resources/auth/types/PostAuthRegisterResponse.d.ts +20 -1
- package/dist/cjs/api/resources/auth/types/PostAuthResetPasswordResponse.d.ts +6 -1
- package/dist/cjs/api/resources/integrations/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/integrations/client/Client.js +1 -1
- package/dist/cjs/api/resources/integrations/types/GetIntegrationsResponse.d.ts +35 -32
- package/dist/cjs/api/resources/integrations/types/GetIntegrationsResponse.js +15 -12
- package/dist/cjs/api/resources/notifications/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/notifications/client/Client.js +1 -1
- package/dist/cjs/api/resources/notifications/types/GetNotificationsResponse.d.ts +35 -32
- package/dist/cjs/api/resources/posts/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/posts/client/Client.js +1 -1
- package/dist/cjs/api/resources/posts/types/GetPostsResponse.d.ts +28 -25
- package/dist/cjs/api/resources/privateMessages/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/privateMessages/client/Client.js +1 -1
- package/dist/cjs/api/resources/privateMessages/types/GetPrivateMessagesResponse.d.ts +31 -28
- package/dist/cjs/api/resources/reports/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/reports/client/Client.js +1 -1
- package/dist/cjs/api/resources/reports/types/GetReportsResponse.d.ts +33 -30
- package/dist/cjs/api/resources/roles/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/roles/client/Client.js +1 -1
- package/dist/cjs/api/resources/roles/types/GetRolesResponse.d.ts +27 -24
- package/dist/cjs/api/resources/ssOs/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/ssOs/client/Client.js +1 -1
- package/dist/cjs/api/resources/ssOs/types/GetSsoResponse.d.ts +32 -29
- package/dist/cjs/api/resources/ssOs/types/GetSsoResponse.js +12 -9
- package/dist/cjs/api/resources/tags/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tags/client/Client.js +1 -1
- package/dist/cjs/api/resources/tags/types/GetTagsResponse.d.ts +27 -24
- package/dist/cjs/api/resources/threads/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/threads/client/Client.js +1 -1
- package/dist/cjs/api/resources/threads/types/GetThreadsResponse.d.ts +55 -52
- package/dist/cjs/api/resources/users/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/users/client/Client.js +1 -1
- package/dist/cjs/api/resources/users/types/GetUsersResponse.d.ts +46 -43
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/webhooks/client/Client.js +1 -1
- package/dist/cjs/api/resources/webhooks/types/GetWebhooksResponse.d.ts +29 -26
- package/dist/cjs/auth/HeaderAuthProvider.d.ts +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +1 -1
- package/dist/esm/Client.mjs +1 -1
- package/dist/esm/api/resources/auth/client/Client.d.mts +13 -1
- package/dist/esm/api/resources/auth/client/Client.mjs +29 -5
- package/dist/esm/api/resources/auth/types/GetAuthMeResponse.d.mts +7 -2
- package/dist/esm/api/resources/auth/types/PostAuthForgotPasswordResponse.d.mts +7 -2
- package/dist/esm/api/resources/auth/types/PostAuthLoginResponse.d.mts +20 -1
- package/dist/esm/api/resources/auth/types/PostAuthRegisterResponse.d.mts +20 -1
- package/dist/esm/api/resources/auth/types/PostAuthResetPasswordResponse.d.mts +6 -1
- package/dist/esm/api/resources/integrations/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/integrations/client/Client.mjs +1 -1
- package/dist/esm/api/resources/integrations/types/GetIntegrationsResponse.d.mts +35 -32
- package/dist/esm/api/resources/integrations/types/GetIntegrationsResponse.mjs +15 -12
- package/dist/esm/api/resources/notifications/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/notifications/client/Client.mjs +1 -1
- package/dist/esm/api/resources/notifications/types/GetNotificationsResponse.d.mts +35 -32
- package/dist/esm/api/resources/posts/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/posts/client/Client.mjs +1 -1
- package/dist/esm/api/resources/posts/types/GetPostsResponse.d.mts +28 -25
- package/dist/esm/api/resources/privateMessages/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/privateMessages/client/Client.mjs +1 -1
- package/dist/esm/api/resources/privateMessages/types/GetPrivateMessagesResponse.d.mts +31 -28
- package/dist/esm/api/resources/reports/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/reports/client/Client.mjs +1 -1
- package/dist/esm/api/resources/reports/types/GetReportsResponse.d.mts +33 -30
- package/dist/esm/api/resources/roles/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/roles/client/Client.mjs +1 -1
- package/dist/esm/api/resources/roles/types/GetRolesResponse.d.mts +27 -24
- package/dist/esm/api/resources/ssOs/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/ssOs/client/Client.mjs +1 -1
- package/dist/esm/api/resources/ssOs/types/GetSsoResponse.d.mts +32 -29
- package/dist/esm/api/resources/ssOs/types/GetSsoResponse.mjs +12 -9
- package/dist/esm/api/resources/tags/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tags/client/Client.mjs +1 -1
- package/dist/esm/api/resources/tags/types/GetTagsResponse.d.mts +27 -24
- package/dist/esm/api/resources/threads/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/threads/client/Client.mjs +1 -1
- package/dist/esm/api/resources/threads/types/GetThreadsResponse.d.mts +55 -52
- package/dist/esm/api/resources/users/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/users/client/Client.mjs +1 -1
- package/dist/esm/api/resources/users/types/GetUsersResponse.d.mts +46 -43
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/webhooks/client/Client.mjs +1 -1
- package/dist/esm/api/resources/webhooks/types/GetWebhooksResponse.d.mts +29 -26
- package/dist/esm/auth/HeaderAuthProvider.d.mts +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +2 -4
- package/reference.md +56 -0
|
@@ -1,35 +1,38 @@
|
|
|
1
1
|
export interface GetPrivateMessagesResponse {
|
|
2
|
-
data: GetPrivateMessagesResponse.Data
|
|
3
|
-
meta: GetPrivateMessagesResponse.Meta;
|
|
2
|
+
data: GetPrivateMessagesResponse.Data;
|
|
4
3
|
}
|
|
5
4
|
export declare namespace GetPrivateMessagesResponse {
|
|
6
|
-
|
|
5
|
+
interface Data {
|
|
6
|
+
items: Data.Items.Item[];
|
|
7
|
+
/** Cursor for next page */
|
|
8
|
+
nextCursor?: string;
|
|
9
|
+
/** Total count of items */
|
|
10
|
+
count: number;
|
|
11
|
+
}
|
|
7
12
|
namespace Data {
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
13
|
+
type Items = Items.Item[];
|
|
14
|
+
namespace Items {
|
|
15
|
+
interface Item {
|
|
16
|
+
/** Recipient User ID */
|
|
17
|
+
recipientId: string;
|
|
18
|
+
/** Sender user ID (required for API key auth, ignored for JWT auth) */
|
|
19
|
+
senderId?: string;
|
|
20
|
+
/** Message title (optional for replies) */
|
|
21
|
+
title?: string;
|
|
22
|
+
/** Message content */
|
|
23
|
+
body: string;
|
|
24
|
+
/** Parent Message ID (for replies) */
|
|
25
|
+
parentId?: string;
|
|
26
|
+
/** Extended data */
|
|
27
|
+
extendedData?: Record<string, unknown>;
|
|
28
|
+
id: string;
|
|
29
|
+
/** Message status (sent, delivered, read, archived) */
|
|
30
|
+
status: string | null;
|
|
31
|
+
/** Message sent timestamp */
|
|
32
|
+
createdAt: string;
|
|
33
|
+
/** Message last update timestamp */
|
|
34
|
+
updatedAt: string;
|
|
35
|
+
}
|
|
28
36
|
}
|
|
29
37
|
}
|
|
30
|
-
interface Meta {
|
|
31
|
-
total: number;
|
|
32
|
-
page: number;
|
|
33
|
-
limit: number;
|
|
34
|
-
}
|
|
35
38
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace ReportsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class ReportsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<ReportsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options: ReportsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* @param {Forum.GetReportsRequest} request
|
|
15
15
|
* @param {ReportsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -52,7 +52,7 @@ const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatu
|
|
|
52
52
|
const errors = __importStar(require("../../../../errors/index.js"));
|
|
53
53
|
const Forum = __importStar(require("../../../index.js"));
|
|
54
54
|
class ReportsClient {
|
|
55
|
-
constructor(options
|
|
55
|
+
constructor(options) {
|
|
56
56
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -1,37 +1,40 @@
|
|
|
1
1
|
export interface GetReportsResponse {
|
|
2
|
-
data: GetReportsResponse.Data
|
|
3
|
-
meta: GetReportsResponse.Meta;
|
|
2
|
+
data: GetReportsResponse.Data;
|
|
4
3
|
}
|
|
5
4
|
export declare namespace GetReportsResponse {
|
|
6
|
-
|
|
5
|
+
interface Data {
|
|
6
|
+
items: Data.Items.Item[];
|
|
7
|
+
/** Cursor for next page */
|
|
8
|
+
nextCursor?: string;
|
|
9
|
+
/** Total count of items */
|
|
10
|
+
count: number;
|
|
11
|
+
}
|
|
7
12
|
namespace Data {
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
13
|
+
type Items = Items.Item[];
|
|
14
|
+
namespace Items {
|
|
15
|
+
interface Item {
|
|
16
|
+
/** Report type (e.g. spam, abuse) */
|
|
17
|
+
type: string;
|
|
18
|
+
/** Reason for reporting */
|
|
19
|
+
description?: string;
|
|
20
|
+
/** Reporter user ID (required for API key auth, ignored for JWT auth) */
|
|
21
|
+
userId?: string;
|
|
22
|
+
/** ID of user being reported */
|
|
23
|
+
reportedId?: string;
|
|
24
|
+
/** ID of thread being reported */
|
|
25
|
+
threadId?: string;
|
|
26
|
+
/** ID of post being reported */
|
|
27
|
+
postId?: string;
|
|
28
|
+
/** ID of private message being reported */
|
|
29
|
+
privateMessageId?: string;
|
|
30
|
+
id: string;
|
|
31
|
+
/** Report status (pending, reviewed, resolved, dismissed) */
|
|
32
|
+
status: string | null;
|
|
33
|
+
/** Report creation timestamp */
|
|
34
|
+
createdAt: string;
|
|
35
|
+
/** Report last update timestamp */
|
|
36
|
+
updatedAt: string;
|
|
37
|
+
}
|
|
30
38
|
}
|
|
31
39
|
}
|
|
32
|
-
interface Meta {
|
|
33
|
-
total: number;
|
|
34
|
-
page: number;
|
|
35
|
-
limit: number;
|
|
36
|
-
}
|
|
37
40
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace RolesClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class RolesClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<RolesClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options: RolesClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* @param {Forum.GetRolesRequest} request
|
|
15
15
|
* @param {RolesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -63,7 +63,7 @@ const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatu
|
|
|
63
63
|
const errors = __importStar(require("../../../../errors/index.js"));
|
|
64
64
|
const Forum = __importStar(require("../../../index.js"));
|
|
65
65
|
class RolesClient {
|
|
66
|
-
constructor(options
|
|
66
|
+
constructor(options) {
|
|
67
67
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
@@ -1,31 +1,34 @@
|
|
|
1
1
|
export interface GetRolesResponse {
|
|
2
|
-
data: GetRolesResponse.Data
|
|
3
|
-
meta: GetRolesResponse.Meta;
|
|
2
|
+
data: GetRolesResponse.Data;
|
|
4
3
|
}
|
|
5
4
|
export declare namespace GetRolesResponse {
|
|
6
|
-
|
|
5
|
+
interface Data {
|
|
6
|
+
items: Data.Items.Item[];
|
|
7
|
+
/** Cursor for next page */
|
|
8
|
+
nextCursor?: string;
|
|
9
|
+
/** Total count of items */
|
|
10
|
+
count: number;
|
|
11
|
+
}
|
|
7
12
|
namespace Data {
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
13
|
+
type Items = Items.Item[];
|
|
14
|
+
namespace Items {
|
|
15
|
+
interface Item {
|
|
16
|
+
/** Role name */
|
|
17
|
+
name: string;
|
|
18
|
+
/** Role slug (unique identifier) */
|
|
19
|
+
slug?: string;
|
|
20
|
+
/** Role description */
|
|
21
|
+
description?: string;
|
|
22
|
+
/** Role color hex */
|
|
23
|
+
color?: string;
|
|
24
|
+
/** Extended data */
|
|
25
|
+
extendedData?: Record<string, unknown>;
|
|
26
|
+
id: string;
|
|
27
|
+
/** Role creation timestamp */
|
|
28
|
+
createdAt: string;
|
|
29
|
+
/** Role last update timestamp */
|
|
30
|
+
updatedAt: string;
|
|
31
|
+
}
|
|
24
32
|
}
|
|
25
33
|
}
|
|
26
|
-
interface Meta {
|
|
27
|
-
total: number;
|
|
28
|
-
page: number;
|
|
29
|
-
limit: number;
|
|
30
|
-
}
|
|
31
34
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace SsOsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class SsOsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<SsOsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options: SsOsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* @param {Forum.GetSsoRequest} request
|
|
15
15
|
* @param {SsOsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -63,7 +63,7 @@ const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatu
|
|
|
63
63
|
const errors = __importStar(require("../../../../errors/index.js"));
|
|
64
64
|
const Forum = __importStar(require("../../../index.js"));
|
|
65
65
|
class SsOsClient {
|
|
66
|
-
constructor(options
|
|
66
|
+
constructor(options) {
|
|
67
67
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
@@ -1,36 +1,39 @@
|
|
|
1
1
|
export interface GetSsoResponse {
|
|
2
|
-
data: GetSsoResponse.Data
|
|
3
|
-
meta: GetSsoResponse.Meta;
|
|
2
|
+
data: GetSsoResponse.Data;
|
|
4
3
|
}
|
|
5
4
|
export declare namespace GetSsoResponse {
|
|
6
|
-
|
|
5
|
+
interface Data {
|
|
6
|
+
items: Data.Items.Item[];
|
|
7
|
+
/** Cursor for next page */
|
|
8
|
+
nextCursor?: string;
|
|
9
|
+
/** Total count of items */
|
|
10
|
+
count: number;
|
|
11
|
+
}
|
|
7
12
|
namespace Data {
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
13
|
+
type Items = Items.Item[];
|
|
14
|
+
namespace Items {
|
|
15
|
+
interface Item {
|
|
16
|
+
id: string;
|
|
17
|
+
/** SSO provider type */
|
|
18
|
+
provider: Item.Provider;
|
|
19
|
+
/** Email domain for this provider */
|
|
20
|
+
domain: string;
|
|
21
|
+
/** Whether SSO is active */
|
|
22
|
+
active: boolean;
|
|
23
|
+
/** SSO configuration creation timestamp */
|
|
24
|
+
createdAt: string;
|
|
25
|
+
/** SSO configuration last update timestamp */
|
|
26
|
+
updatedAt: string;
|
|
27
|
+
}
|
|
28
|
+
namespace Item {
|
|
29
|
+
/** SSO provider type */
|
|
30
|
+
const Provider: {
|
|
31
|
+
readonly Okta: "OKTA";
|
|
32
|
+
readonly Auth0: "AUTH0";
|
|
33
|
+
readonly Saml: "SAML";
|
|
34
|
+
};
|
|
35
|
+
type Provider = (typeof Provider)[keyof typeof Provider];
|
|
36
|
+
}
|
|
29
37
|
}
|
|
30
38
|
}
|
|
31
|
-
interface Meta {
|
|
32
|
-
total: number;
|
|
33
|
-
page: number;
|
|
34
|
-
limit: number;
|
|
35
|
-
}
|
|
36
39
|
}
|
|
@@ -6,14 +6,17 @@ var GetSsoResponse;
|
|
|
6
6
|
(function (GetSsoResponse) {
|
|
7
7
|
let Data;
|
|
8
8
|
(function (Data) {
|
|
9
|
-
let
|
|
10
|
-
(function (
|
|
11
|
-
|
|
12
|
-
Item
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
9
|
+
let Items;
|
|
10
|
+
(function (Items) {
|
|
11
|
+
let Item;
|
|
12
|
+
(function (Item) {
|
|
13
|
+
/** SSO provider type */
|
|
14
|
+
Item.Provider = {
|
|
15
|
+
Okta: "OKTA",
|
|
16
|
+
Auth0: "AUTH0",
|
|
17
|
+
Saml: "SAML",
|
|
18
|
+
};
|
|
19
|
+
})(Item = Items.Item || (Items.Item = {}));
|
|
20
|
+
})(Items = Data.Items || (Data.Items = {}));
|
|
18
21
|
})(Data = GetSsoResponse.Data || (GetSsoResponse.Data = {}));
|
|
19
22
|
})(GetSsoResponse || (exports.GetSsoResponse = GetSsoResponse = {}));
|
|
@@ -9,7 +9,7 @@ export declare namespace TagsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class TagsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<TagsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options: TagsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* @param {Forum.GetTagsRequest} request
|
|
15
15
|
* @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -63,7 +63,7 @@ const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatu
|
|
|
63
63
|
const errors = __importStar(require("../../../../errors/index.js"));
|
|
64
64
|
const Forum = __importStar(require("../../../index.js"));
|
|
65
65
|
class TagsClient {
|
|
66
|
-
constructor(options
|
|
66
|
+
constructor(options) {
|
|
67
67
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
@@ -1,31 +1,34 @@
|
|
|
1
1
|
export interface GetTagsResponse {
|
|
2
|
-
data: GetTagsResponse.Data
|
|
3
|
-
meta: GetTagsResponse.Meta;
|
|
2
|
+
data: GetTagsResponse.Data;
|
|
4
3
|
}
|
|
5
4
|
export declare namespace GetTagsResponse {
|
|
6
|
-
|
|
5
|
+
interface Data {
|
|
6
|
+
items: Data.Items.Item[];
|
|
7
|
+
/** Cursor for next page */
|
|
8
|
+
nextCursor?: string;
|
|
9
|
+
/** Total count of items */
|
|
10
|
+
count: number;
|
|
11
|
+
}
|
|
7
12
|
namespace Data {
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
13
|
+
type Items = Items.Item[];
|
|
14
|
+
namespace Items {
|
|
15
|
+
interface Item {
|
|
16
|
+
/** Tag name */
|
|
17
|
+
name: string;
|
|
18
|
+
/** Tag slug (unique identifier) */
|
|
19
|
+
slug?: string;
|
|
20
|
+
/** Tag description */
|
|
21
|
+
description?: string;
|
|
22
|
+
/** Hex color code */
|
|
23
|
+
color?: string;
|
|
24
|
+
/** Extended data */
|
|
25
|
+
extendedData?: Record<string, unknown>;
|
|
26
|
+
id: string;
|
|
27
|
+
/** Tag creation timestamp */
|
|
28
|
+
createdAt: string;
|
|
29
|
+
/** Tag last update timestamp */
|
|
30
|
+
updatedAt: string;
|
|
31
|
+
}
|
|
24
32
|
}
|
|
25
33
|
}
|
|
26
|
-
interface Meta {
|
|
27
|
-
total: number;
|
|
28
|
-
page: number;
|
|
29
|
-
limit: number;
|
|
30
|
-
}
|
|
31
34
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace ThreadsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class ThreadsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<ThreadsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options: ThreadsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* @param {Forum.GetThreadsRequest} request
|
|
15
15
|
* @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -63,7 +63,7 @@ const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatu
|
|
|
63
63
|
const errors = __importStar(require("../../../../errors/index.js"));
|
|
64
64
|
const Forum = __importStar(require("../../../index.js"));
|
|
65
65
|
class ThreadsClient {
|
|
66
|
-
constructor(options
|
|
66
|
+
constructor(options) {
|
|
67
67
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
@@ -1,64 +1,67 @@
|
|
|
1
1
|
export interface GetThreadsResponse {
|
|
2
|
-
data: GetThreadsResponse.Data
|
|
3
|
-
meta: GetThreadsResponse.Meta;
|
|
2
|
+
data: GetThreadsResponse.Data;
|
|
4
3
|
}
|
|
5
4
|
export declare namespace GetThreadsResponse {
|
|
6
|
-
|
|
5
|
+
interface Data {
|
|
6
|
+
items: Data.Items.Item[];
|
|
7
|
+
/** Cursor for next page */
|
|
8
|
+
nextCursor?: string;
|
|
9
|
+
/** Total count of items */
|
|
10
|
+
count: number;
|
|
11
|
+
}
|
|
7
12
|
namespace Data {
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
body: string;
|
|
13
|
-
/** Author user ID (required for API key auth, ignored for JWT auth) */
|
|
14
|
-
userId?: string;
|
|
15
|
-
/** List of tag slugs, names, or IDs to attach */
|
|
16
|
-
tags?: string[];
|
|
17
|
-
/** Poll data */
|
|
18
|
-
poll?: Item.Poll;
|
|
19
|
-
id: string;
|
|
20
|
-
/** URL-friendly identifier */
|
|
21
|
-
slug: string | null;
|
|
22
|
-
/** Whether thread is locked */
|
|
23
|
-
locked: boolean | null;
|
|
24
|
-
/** Whether thread is pinned */
|
|
25
|
-
pinned: boolean | null;
|
|
26
|
-
/** View count */
|
|
27
|
-
views: number;
|
|
28
|
-
/** Number of posts/replies */
|
|
29
|
-
postsCount: number;
|
|
30
|
-
/** Timestamp of the last post */
|
|
31
|
-
lastPostAt: string | null;
|
|
32
|
-
/** Custom metadata */
|
|
33
|
-
extendedData: Record<string, unknown> | null;
|
|
34
|
-
createdAt: string;
|
|
35
|
-
updatedAt: string;
|
|
36
|
-
}
|
|
37
|
-
namespace Item {
|
|
38
|
-
/**
|
|
39
|
-
* Poll data
|
|
40
|
-
*/
|
|
41
|
-
interface Poll {
|
|
42
|
-
/** Poll title */
|
|
13
|
+
type Items = Items.Item[];
|
|
14
|
+
namespace Items {
|
|
15
|
+
interface Item {
|
|
16
|
+
/** Thread title */
|
|
43
17
|
title: string;
|
|
44
|
-
/**
|
|
45
|
-
|
|
18
|
+
/** Thread content (Markdown supported) */
|
|
19
|
+
body: string;
|
|
20
|
+
/** Author user ID (required for API key auth, ignored for JWT auth) */
|
|
21
|
+
userId?: string;
|
|
22
|
+
/** List of tag slugs, names, or IDs to attach */
|
|
23
|
+
tags?: string[];
|
|
24
|
+
/** Poll data */
|
|
25
|
+
poll?: Item.Poll;
|
|
26
|
+
id: string;
|
|
27
|
+
/** URL-friendly identifier */
|
|
28
|
+
slug: string | null;
|
|
29
|
+
/** Whether thread is locked */
|
|
30
|
+
locked: boolean | null;
|
|
31
|
+
/** Whether thread is pinned */
|
|
32
|
+
pinned: boolean | null;
|
|
33
|
+
/** View count */
|
|
34
|
+
views: number;
|
|
35
|
+
/** Number of posts/replies */
|
|
36
|
+
postsCount: number;
|
|
37
|
+
/** Timestamp of the last post */
|
|
38
|
+
lastPostAt: string | null;
|
|
39
|
+
/** Custom metadata */
|
|
40
|
+
extendedData: Record<string, unknown> | null;
|
|
41
|
+
createdAt: string;
|
|
42
|
+
updatedAt: string;
|
|
46
43
|
}
|
|
47
|
-
namespace
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
44
|
+
namespace Item {
|
|
45
|
+
/**
|
|
46
|
+
* Poll data
|
|
47
|
+
*/
|
|
48
|
+
interface Poll {
|
|
49
|
+
/** Poll title */
|
|
50
|
+
title: string;
|
|
51
|
+
/** Poll options */
|
|
52
|
+
options: Poll.Options.Item[];
|
|
53
|
+
}
|
|
54
|
+
namespace Poll {
|
|
55
|
+
type Options = Options.Item[];
|
|
56
|
+
namespace Options {
|
|
57
|
+
interface Item {
|
|
58
|
+
title: string;
|
|
59
|
+
color?: string;
|
|
60
|
+
extendedData?: Record<string, unknown>;
|
|
61
|
+
}
|
|
54
62
|
}
|
|
55
63
|
}
|
|
56
64
|
}
|
|
57
65
|
}
|
|
58
66
|
}
|
|
59
|
-
interface Meta {
|
|
60
|
-
total: number;
|
|
61
|
-
page: number;
|
|
62
|
-
limit: number;
|
|
63
|
-
}
|
|
64
67
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace UsersClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class UsersClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<UsersClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options: UsersClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* @param {Forum.GetUsersRequest} request
|
|
15
15
|
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -63,7 +63,7 @@ const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatu
|
|
|
63
63
|
const errors = __importStar(require("../../../../errors/index.js"));
|
|
64
64
|
const Forum = __importStar(require("../../../index.js"));
|
|
65
65
|
class UsersClient {
|
|
66
|
-
constructor(options
|
|
66
|
+
constructor(options) {
|
|
67
67
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|