@foru-ms/sdk 2.1.1 → 2.1.3

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 (66) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/integrations/client/Client.d.ts +1 -0
  3. package/dist/cjs/api/resources/integrations/client/Client.js +1 -0
  4. package/dist/cjs/api/resources/integrations/client/requests/CreateIntegrationsRequest.d.ts +6 -2
  5. package/dist/cjs/api/resources/reports/client/requests/CreateReportsRequest.d.ts +4 -0
  6. package/dist/cjs/api/resources/reports/types/UpdateReportsResponse.d.ts +4 -2
  7. package/dist/cjs/api/resources/ssOs/client/Client.d.ts +5 -7
  8. package/dist/cjs/api/resources/ssOs/client/Client.js +5 -7
  9. package/dist/cjs/api/resources/ssOs/client/requests/CreateSsOsRequest.d.ts +22 -15
  10. package/dist/cjs/api/resources/ssOs/client/requests/CreateSsOsRequest.js +10 -0
  11. package/dist/cjs/api/resources/ssOs/client/requests/UpdateSsOsRequest.d.ts +13 -8
  12. package/dist/cjs/api/resources/ssOs/client/requests/UpdateSsOsRequest.js +10 -0
  13. package/dist/cjs/api/resources/ssOs/client/requests/index.d.ts +2 -2
  14. package/dist/cjs/api/resources/ssOs/client/requests/index.js +5 -0
  15. package/dist/cjs/api/resources/users/types/UpdateUsersResponse.d.ts +3 -1
  16. package/dist/cjs/api/types/IntegrationCreate.d.ts +5 -2
  17. package/dist/cjs/api/types/LoginResponse.d.ts +35 -1
  18. package/dist/cjs/api/types/MeResponse.d.ts +15 -1
  19. package/dist/cjs/api/types/RegisterResponse.d.ts +35 -1
  20. package/dist/cjs/api/types/Report.d.ts +4 -2
  21. package/dist/cjs/api/types/ReportCreate.d.ts +4 -0
  22. package/dist/cjs/api/types/ReportListResponse.d.ts +4 -2
  23. package/dist/cjs/api/types/ReportResponse.d.ts +4 -2
  24. package/dist/cjs/api/types/SsoCreate.d.ts +17 -11
  25. package/dist/cjs/api/types/SsoCreate.js +10 -0
  26. package/dist/cjs/api/types/SsoUpdate.d.ts +13 -11
  27. package/dist/cjs/api/types/SsoUpdate.js +10 -0
  28. package/dist/cjs/api/types/User.d.ts +2 -0
  29. package/dist/cjs/api/types/UserListResponse.d.ts +2 -0
  30. package/dist/cjs/api/types/UserResponse.d.ts +3 -1
  31. package/dist/cjs/version.d.ts +1 -1
  32. package/dist/cjs/version.js +1 -1
  33. package/dist/esm/BaseClient.mjs +2 -2
  34. package/dist/esm/api/resources/integrations/client/Client.d.mts +1 -0
  35. package/dist/esm/api/resources/integrations/client/Client.mjs +1 -0
  36. package/dist/esm/api/resources/integrations/client/requests/CreateIntegrationsRequest.d.mts +6 -2
  37. package/dist/esm/api/resources/reports/client/requests/CreateReportsRequest.d.mts +4 -0
  38. package/dist/esm/api/resources/reports/types/UpdateReportsResponse.d.mts +4 -2
  39. package/dist/esm/api/resources/ssOs/client/Client.d.mts +5 -7
  40. package/dist/esm/api/resources/ssOs/client/Client.mjs +5 -7
  41. package/dist/esm/api/resources/ssOs/client/requests/CreateSsOsRequest.d.mts +22 -15
  42. package/dist/esm/api/resources/ssOs/client/requests/CreateSsOsRequest.mjs +9 -1
  43. package/dist/esm/api/resources/ssOs/client/requests/UpdateSsOsRequest.d.mts +13 -8
  44. package/dist/esm/api/resources/ssOs/client/requests/UpdateSsOsRequest.mjs +9 -1
  45. package/dist/esm/api/resources/ssOs/client/requests/index.d.mts +2 -2
  46. package/dist/esm/api/resources/ssOs/client/requests/index.mjs +2 -1
  47. package/dist/esm/api/resources/users/types/UpdateUsersResponse.d.mts +3 -1
  48. package/dist/esm/api/types/IntegrationCreate.d.mts +5 -2
  49. package/dist/esm/api/types/LoginResponse.d.mts +35 -1
  50. package/dist/esm/api/types/MeResponse.d.mts +15 -1
  51. package/dist/esm/api/types/RegisterResponse.d.mts +35 -1
  52. package/dist/esm/api/types/Report.d.mts +4 -2
  53. package/dist/esm/api/types/ReportCreate.d.mts +4 -0
  54. package/dist/esm/api/types/ReportListResponse.d.mts +4 -2
  55. package/dist/esm/api/types/ReportResponse.d.mts +4 -2
  56. package/dist/esm/api/types/SsoCreate.d.mts +17 -11
  57. package/dist/esm/api/types/SsoCreate.mjs +9 -1
  58. package/dist/esm/api/types/SsoUpdate.d.mts +13 -11
  59. package/dist/esm/api/types/SsoUpdate.mjs +9 -1
  60. package/dist/esm/api/types/User.d.mts +2 -0
  61. package/dist/esm/api/types/UserListResponse.d.mts +2 -0
  62. package/dist/esm/api/types/UserResponse.d.mts +3 -1
  63. package/dist/esm/version.d.mts +1 -1
  64. package/dist/esm/version.mjs +1 -1
  65. package/package.json +1 -1
  66. package/reference.md +6 -7
@@ -48,6 +48,7 @@ export declare class IntegrationsClient {
48
48
  * @example
49
49
  * await client.integrations.create({
50
50
  * type: "type",
51
+ * name: "name",
51
52
  * config: {
52
53
  * "key": "value"
53
54
  * }
@@ -114,6 +114,7 @@ export class IntegrationsClient {
114
114
  * @example
115
115
  * await client.integrations.create({
116
116
  * type: "type",
117
+ * name: "name",
117
118
  * config: {
118
119
  * "key": "value"
119
120
  * }
@@ -2,17 +2,21 @@
2
2
  * @example
3
3
  * {
4
4
  * type: "type",
5
+ * name: "name",
5
6
  * config: {
6
7
  * "key": "value"
7
8
  * }
8
9
  * }
9
10
  */
10
11
  export interface CreateIntegrationsRequest {
11
- /** Integration type (e.g. slack, discord) */
12
+ /** Integration type (e.g. SLACK, DISCORD) */
12
13
  type: string;
14
+ /** Integration name */
15
+ name: string;
13
16
  /** JSON configuration */
14
17
  config: Record<string, unknown>;
15
- enabled?: boolean;
18
+ /** Whether integration is active */
19
+ active?: boolean;
16
20
  /** Custom extended data */
17
21
  extendedData?: Record<string, unknown>;
18
22
  }
@@ -7,6 +7,8 @@
7
7
  export interface CreateReportsRequest {
8
8
  /** Report type (e.g. spam, abuse) */
9
9
  type: string;
10
+ /** Report status (default: pending) */
11
+ status?: string;
10
12
  /** Reason for reporting */
11
13
  description?: string;
12
14
  /** Reporter user ID (required for API key auth, ignored for JWT auth) */
@@ -19,4 +21,6 @@ export interface CreateReportsRequest {
19
21
  postId?: string;
20
22
  /** ID of private message being reported */
21
23
  privateMessageId?: string;
24
+ /** Custom extended data */
25
+ extendedData?: Record<string, unknown>;
22
26
  }
@@ -5,6 +5,8 @@ export declare namespace UpdateReportsResponse {
5
5
  interface Data {
6
6
  /** Report type (e.g. spam, abuse) */
7
7
  type: string;
8
+ /** Report status (pending, reviewed, resolved, dismissed) */
9
+ status: string | null;
8
10
  /** Reason for reporting */
9
11
  description?: string;
10
12
  /** Reporter user ID (required for API key auth, ignored for JWT auth) */
@@ -17,9 +19,9 @@ export declare namespace UpdateReportsResponse {
17
19
  postId?: string;
18
20
  /** ID of private message being reported */
19
21
  privateMessageId?: string;
22
+ /** Custom extended data */
23
+ extendedData?: Record<string, unknown>;
20
24
  id: string;
21
- /** Report status (pending, reviewed, resolved, dismissed) */
22
- status: string | null;
23
25
  /** Report creation timestamp */
24
26
  createdAt: string;
25
27
  /** Report last update timestamp */
@@ -47,13 +47,11 @@ export declare class SsOsClient {
47
47
  *
48
48
  * @example
49
49
  * await client.ssOs.create({
50
- * name: "name",
51
- * clientId: "clientId",
52
- * clientSecret: "clientSecret",
53
- * issuer: "issuer",
54
- * authorizationEndpoint: "authorizationEndpoint",
55
- * tokenEndpoint: "tokenEndpoint",
56
- * userInfoEndpoint: "userInfoEndpoint"
50
+ * provider: "OKTA",
51
+ * domain: "domain",
52
+ * config: {
53
+ * "key": "value"
54
+ * }
57
55
  * })
58
56
  */
59
57
  create(request: Forum.CreateSsOsRequest, requestOptions?: SsOsClient.RequestOptions): core.HttpResponsePromise<Forum.SsoResponse>;
@@ -113,13 +113,11 @@ export class SsOsClient {
113
113
  *
114
114
  * @example
115
115
  * await client.ssOs.create({
116
- * name: "name",
117
- * clientId: "clientId",
118
- * clientSecret: "clientSecret",
119
- * issuer: "issuer",
120
- * authorizationEndpoint: "authorizationEndpoint",
121
- * tokenEndpoint: "tokenEndpoint",
122
- * userInfoEndpoint: "userInfoEndpoint"
116
+ * provider: "OKTA",
117
+ * domain: "domain",
118
+ * config: {
119
+ * "key": "value"
120
+ * }
123
121
  * })
124
122
  */
125
123
  create(request, requestOptions) {
@@ -1,24 +1,31 @@
1
1
  /**
2
2
  * @example
3
3
  * {
4
- * name: "name",
5
- * clientId: "clientId",
6
- * clientSecret: "clientSecret",
7
- * issuer: "issuer",
8
- * authorizationEndpoint: "authorizationEndpoint",
9
- * tokenEndpoint: "tokenEndpoint",
10
- * userInfoEndpoint: "userInfoEndpoint"
4
+ * provider: "OKTA",
5
+ * domain: "domain",
6
+ * config: {
7
+ * "key": "value"
8
+ * }
11
9
  * }
12
10
  */
13
11
  export interface CreateSsOsRequest {
14
- /** Provider name (e.g. Google) */
15
- name: string;
16
- clientId: string;
17
- clientSecret: string;
18
- issuer: string;
19
- authorizationEndpoint: string;
20
- tokenEndpoint: string;
21
- userInfoEndpoint: string;
12
+ /** SSO provider type */
13
+ provider: CreateSsOsRequest.Provider;
14
+ /** Email domain to match (e.g. 'acme.com') */
15
+ domain: string;
16
+ /** Provider configuration (clientId, issuer, etc.) */
17
+ config: Record<string, unknown>;
18
+ /** Whether SSO is active */
19
+ active?: boolean;
22
20
  /** Custom extended data */
23
21
  extendedData?: Record<string, unknown>;
24
22
  }
23
+ export declare namespace CreateSsOsRequest {
24
+ /** SSO provider type */
25
+ const Provider: {
26
+ readonly Okta: "OKTA";
27
+ readonly Auth0: "AUTH0";
28
+ readonly Saml: "SAML";
29
+ };
30
+ type Provider = (typeof Provider)[keyof typeof Provider];
31
+ }
@@ -1,2 +1,10 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
- export {};
2
+ export var CreateSsOsRequest;
3
+ (function (CreateSsOsRequest) {
4
+ /** SSO provider type */
5
+ CreateSsOsRequest.Provider = {
6
+ Okta: "OKTA",
7
+ Auth0: "AUTH0",
8
+ Saml: "SAML",
9
+ };
10
+ })(CreateSsOsRequest || (CreateSsOsRequest = {}));
@@ -7,18 +7,23 @@
7
7
  export interface UpdateSsOsRequest {
8
8
  /** SSO ID */
9
9
  id: string;
10
- /** Provider name */
11
- name?: string;
10
+ /** SSO provider type */
11
+ provider?: UpdateSsOsRequest.Provider;
12
12
  /** Email domain to match */
13
13
  domain?: string;
14
- clientId?: string;
15
- clientSecret?: string;
16
- issuer?: string;
17
- authorizationEndpoint?: string;
18
- tokenEndpoint?: string;
19
- userInfoEndpoint?: string;
14
+ /** Provider configuration */
15
+ config?: Record<string, unknown>;
20
16
  /** Enable/disable provider */
21
17
  active?: boolean;
22
18
  /** Custom extended data */
23
19
  extendedData?: Record<string, unknown>;
24
20
  }
21
+ export declare namespace UpdateSsOsRequest {
22
+ /** SSO provider type */
23
+ const Provider: {
24
+ readonly Okta: "OKTA";
25
+ readonly Auth0: "AUTH0";
26
+ readonly Saml: "SAML";
27
+ };
28
+ type Provider = (typeof Provider)[keyof typeof Provider];
29
+ }
@@ -1,2 +1,10 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
- export {};
2
+ export var UpdateSsOsRequest;
3
+ (function (UpdateSsOsRequest) {
4
+ /** SSO provider type */
5
+ UpdateSsOsRequest.Provider = {
6
+ Okta: "OKTA",
7
+ Auth0: "AUTH0",
8
+ Saml: "SAML",
9
+ };
10
+ })(UpdateSsOsRequest || (UpdateSsOsRequest = {}));
@@ -1,5 +1,5 @@
1
- export type { CreateSsOsRequest } from "./CreateSsOsRequest.mjs";
1
+ export { CreateSsOsRequest } from "./CreateSsOsRequest.mjs";
2
2
  export type { DeleteSsOsRequest } from "./DeleteSsOsRequest.mjs";
3
3
  export type { ListSsOsRequest } from "./ListSsOsRequest.mjs";
4
4
  export type { RetrieveSsOsRequest } from "./RetrieveSsOsRequest.mjs";
5
- export type { UpdateSsOsRequest } from "./UpdateSsOsRequest.mjs";
5
+ export { UpdateSsOsRequest } from "./UpdateSsOsRequest.mjs";
@@ -1 +1,2 @@
1
- export {};
1
+ export { CreateSsOsRequest } from "./CreateSsOsRequest.mjs";
2
+ export { UpdateSsOsRequest } from "./UpdateSsOsRequest.mjs";
@@ -1,10 +1,12 @@
1
1
  export interface UpdateUsersResponse {
2
- data?: UpdateUsersResponse.Data;
2
+ data: UpdateUsersResponse.Data;
3
3
  }
4
4
  export declare namespace UpdateUsersResponse {
5
5
  interface Data {
6
6
  id: string;
7
7
  username: string;
8
+ /** Email address */
9
+ email: string | null;
8
10
  /** Display name */
9
11
  displayName: string | null;
10
12
  /** User bio */
@@ -1,9 +1,12 @@
1
1
  export interface IntegrationCreate {
2
- /** Integration type (e.g. slack, discord) */
2
+ /** Integration type (e.g. SLACK, DISCORD) */
3
3
  type: string;
4
+ /** Integration name */
5
+ name: string;
4
6
  /** JSON configuration */
5
7
  config: Record<string, unknown>;
6
- enabled?: boolean;
8
+ /** Whether integration is active */
9
+ active?: boolean;
7
10
  /** Custom extended data */
8
11
  extendedData?: Record<string, unknown>;
9
12
  }
@@ -15,8 +15,42 @@ export declare namespace LoginResponse {
15
15
  interface User {
16
16
  id: string;
17
17
  username: string;
18
- email?: string;
18
+ /** Email address */
19
+ email: string | null;
20
+ /** Display name */
19
21
  displayName: string | null;
22
+ /** User bio */
23
+ bio: string | null;
24
+ /** Forum signature */
25
+ signature: string | null;
26
+ /** User website URL */
27
+ url: string | null;
28
+ /** Total posts by user */
29
+ postsCount?: number;
30
+ /** Total threads by user */
31
+ threadsCount?: number;
32
+ /** Online status */
33
+ isOnline: boolean | null;
34
+ /** Last activity timestamp */
35
+ lastSeenAt: string | null;
36
+ /** User roles */
37
+ roles?: User.Roles.Item[];
38
+ /** Custom user data */
39
+ extendedData: Record<string, unknown> | null;
40
+ /** Account creation timestamp */
41
+ createdAt: string;
42
+ /** Profile last update timestamp */
43
+ updatedAt: string;
44
+ }
45
+ namespace User {
46
+ type Roles = Roles.Item[];
47
+ namespace Roles {
48
+ interface Item {
49
+ id: string;
50
+ name: string;
51
+ slug: string | null;
52
+ }
53
+ }
20
54
  }
21
55
  }
22
56
  }
@@ -5,18 +5,32 @@ export declare namespace MeResponse {
5
5
  interface Data {
6
6
  id: string;
7
7
  username: string;
8
- displayName: string | null;
8
+ /** Email address */
9
9
  email: string | null;
10
+ /** Display name */
11
+ displayName: string | null;
12
+ /** User bio */
10
13
  bio: string | null;
14
+ /** Forum signature */
11
15
  signature: string | null;
16
+ /** User website URL */
12
17
  url: string | null;
18
+ /** Total posts by user */
13
19
  postsCount?: number;
20
+ /** Total threads by user */
14
21
  threadsCount?: number;
22
+ /** Online status */
15
23
  isOnline: boolean | null;
24
+ /** Last activity timestamp */
16
25
  lastSeenAt: string | null;
26
+ /** User roles */
17
27
  roles?: Data.Roles.Item[];
28
+ /** Custom user data */
18
29
  extendedData: Record<string, unknown> | null;
30
+ /** Account creation timestamp */
19
31
  createdAt: string;
32
+ /** Profile last update timestamp */
33
+ updatedAt: string;
20
34
  }
21
35
  namespace Data {
22
36
  type Roles = Roles.Item[];
@@ -15,8 +15,42 @@ export declare namespace RegisterResponse {
15
15
  interface User {
16
16
  id: string;
17
17
  username: string;
18
- email?: string;
18
+ /** Email address */
19
+ email: string | null;
20
+ /** Display name */
19
21
  displayName: string | null;
22
+ /** User bio */
23
+ bio: string | null;
24
+ /** Forum signature */
25
+ signature: string | null;
26
+ /** User website URL */
27
+ url: string | null;
28
+ /** Total posts by user */
29
+ postsCount?: number;
30
+ /** Total threads by user */
31
+ threadsCount?: number;
32
+ /** Online status */
33
+ isOnline: boolean | null;
34
+ /** Last activity timestamp */
35
+ lastSeenAt: string | null;
36
+ /** User roles */
37
+ roles?: User.Roles.Item[];
38
+ /** Custom user data */
39
+ extendedData: Record<string, unknown> | null;
40
+ /** Account creation timestamp */
41
+ createdAt: string;
42
+ /** Profile last update timestamp */
43
+ updatedAt: string;
44
+ }
45
+ namespace User {
46
+ type Roles = Roles.Item[];
47
+ namespace Roles {
48
+ interface Item {
49
+ id: string;
50
+ name: string;
51
+ slug: string | null;
52
+ }
53
+ }
20
54
  }
21
55
  }
22
56
  }
@@ -1,6 +1,8 @@
1
1
  export interface Report {
2
2
  /** Report type (e.g. spam, abuse) */
3
3
  type: string;
4
+ /** Report status (pending, reviewed, resolved, dismissed) */
5
+ status: string | null;
4
6
  /** Reason for reporting */
5
7
  description?: string;
6
8
  /** Reporter user ID (required for API key auth, ignored for JWT auth) */
@@ -13,9 +15,9 @@ export interface Report {
13
15
  postId?: string;
14
16
  /** ID of private message being reported */
15
17
  privateMessageId?: string;
18
+ /** Custom extended data */
19
+ extendedData?: Record<string, unknown>;
16
20
  id: string;
17
- /** Report status (pending, reviewed, resolved, dismissed) */
18
- status: string | null;
19
21
  /** Report creation timestamp */
20
22
  createdAt: string;
21
23
  /** Report last update timestamp */
@@ -1,6 +1,8 @@
1
1
  export interface ReportCreate {
2
2
  /** Report type (e.g. spam, abuse) */
3
3
  type: string;
4
+ /** Report status (default: pending) */
5
+ status?: string;
4
6
  /** Reason for reporting */
5
7
  description?: string;
6
8
  /** Reporter user ID (required for API key auth, ignored for JWT auth) */
@@ -13,4 +15,6 @@ export interface ReportCreate {
13
15
  postId?: string;
14
16
  /** ID of private message being reported */
15
17
  privateMessageId?: string;
18
+ /** Custom extended data */
19
+ extendedData?: Record<string, unknown>;
16
20
  }
@@ -15,6 +15,8 @@ export declare namespace ReportListResponse {
15
15
  interface Item {
16
16
  /** Report type (e.g. spam, abuse) */
17
17
  type: string;
18
+ /** Report status (pending, reviewed, resolved, dismissed) */
19
+ status: string | null;
18
20
  /** Reason for reporting */
19
21
  description?: string;
20
22
  /** Reporter user ID (required for API key auth, ignored for JWT auth) */
@@ -27,9 +29,9 @@ export declare namespace ReportListResponse {
27
29
  postId?: string;
28
30
  /** ID of private message being reported */
29
31
  privateMessageId?: string;
32
+ /** Custom extended data */
33
+ extendedData?: Record<string, unknown>;
30
34
  id: string;
31
- /** Report status (pending, reviewed, resolved, dismissed) */
32
- status: string | null;
33
35
  /** Report creation timestamp */
34
36
  createdAt: string;
35
37
  /** Report last update timestamp */
@@ -5,6 +5,8 @@ export declare namespace ReportResponse {
5
5
  interface Data {
6
6
  /** Report type (e.g. spam, abuse) */
7
7
  type: string;
8
+ /** Report status (pending, reviewed, resolved, dismissed) */
9
+ status: string | null;
8
10
  /** Reason for reporting */
9
11
  description?: string;
10
12
  /** Reporter user ID (required for API key auth, ignored for JWT auth) */
@@ -17,9 +19,9 @@ export declare namespace ReportResponse {
17
19
  postId?: string;
18
20
  /** ID of private message being reported */
19
21
  privateMessageId?: string;
22
+ /** Custom extended data */
23
+ extendedData?: Record<string, unknown>;
20
24
  id: string;
21
- /** Report status (pending, reviewed, resolved, dismissed) */
22
- status: string | null;
23
25
  /** Report creation timestamp */
24
26
  createdAt: string;
25
27
  /** Report last update timestamp */
@@ -1,15 +1,21 @@
1
- /**
2
- * OIDC provider config
3
- */
4
1
  export interface SsoCreate {
5
- /** Provider name (e.g. Google) */
6
- name: string;
7
- clientId: string;
8
- clientSecret: string;
9
- issuer: string;
10
- authorizationEndpoint: string;
11
- tokenEndpoint: string;
12
- userInfoEndpoint: string;
2
+ /** SSO provider type */
3
+ provider: SsoCreate.Provider;
4
+ /** Email domain to match (e.g. 'acme.com') */
5
+ domain: string;
6
+ /** Provider configuration (clientId, issuer, etc.) */
7
+ config: Record<string, unknown>;
8
+ /** Whether SSO is active */
9
+ active?: boolean;
13
10
  /** Custom extended data */
14
11
  extendedData?: Record<string, unknown>;
15
12
  }
13
+ export declare namespace SsoCreate {
14
+ /** SSO provider type */
15
+ const Provider: {
16
+ readonly Okta: "OKTA";
17
+ readonly Auth0: "AUTH0";
18
+ readonly Saml: "SAML";
19
+ };
20
+ type Provider = (typeof Provider)[keyof typeof Provider];
21
+ }
@@ -1,2 +1,10 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
- export {};
2
+ export var SsoCreate;
3
+ (function (SsoCreate) {
4
+ /** SSO provider type */
5
+ SsoCreate.Provider = {
6
+ Okta: "OKTA",
7
+ Auth0: "AUTH0",
8
+ Saml: "SAML",
9
+ };
10
+ })(SsoCreate || (SsoCreate = {}));
@@ -1,19 +1,21 @@
1
- /**
2
- * Partial OIDC provider update
3
- */
4
1
  export interface SsoUpdate {
5
- /** Provider name */
6
- name?: string;
2
+ /** SSO provider type */
3
+ provider?: SsoUpdate.Provider;
7
4
  /** Email domain to match */
8
5
  domain?: string;
9
- clientId?: string;
10
- clientSecret?: string;
11
- issuer?: string;
12
- authorizationEndpoint?: string;
13
- tokenEndpoint?: string;
14
- userInfoEndpoint?: string;
6
+ /** Provider configuration */
7
+ config?: Record<string, unknown>;
15
8
  /** Enable/disable provider */
16
9
  active?: boolean;
17
10
  /** Custom extended data */
18
11
  extendedData?: Record<string, unknown>;
19
12
  }
13
+ export declare namespace SsoUpdate {
14
+ /** SSO provider type */
15
+ const Provider: {
16
+ readonly Okta: "OKTA";
17
+ readonly Auth0: "AUTH0";
18
+ readonly Saml: "SAML";
19
+ };
20
+ type Provider = (typeof Provider)[keyof typeof Provider];
21
+ }
@@ -1,2 +1,10 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
- export {};
2
+ export var SsoUpdate;
3
+ (function (SsoUpdate) {
4
+ /** SSO provider type */
5
+ SsoUpdate.Provider = {
6
+ Okta: "OKTA",
7
+ Auth0: "AUTH0",
8
+ Saml: "SAML",
9
+ };
10
+ })(SsoUpdate || (SsoUpdate = {}));
@@ -1,6 +1,8 @@
1
1
  export interface User {
2
2
  id: string;
3
3
  username: string;
4
+ /** Email address */
5
+ email: string | null;
4
6
  /** Display name */
5
7
  displayName: string | null;
6
8
  /** User bio */
@@ -15,6 +15,8 @@ export declare namespace UserListResponse {
15
15
  interface Item {
16
16
  id: string;
17
17
  username: string;
18
+ /** Email address */
19
+ email: string | null;
18
20
  /** Display name */
19
21
  displayName: string | null;
20
22
  /** User bio */
@@ -1,10 +1,12 @@
1
1
  export interface UserResponse {
2
- data?: UserResponse.Data;
2
+ data: UserResponse.Data;
3
3
  }
4
4
  export declare namespace UserResponse {
5
5
  interface Data {
6
6
  id: string;
7
7
  username: string;
8
+ /** Email address */
9
+ email: string | null;
8
10
  /** Display name */
9
11
  displayName: string | null;
10
12
  /** User bio */
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "2.1.1";
1
+ export declare const SDK_VERSION = "2.1.3";
@@ -1 +1 @@
1
- export const SDK_VERSION = "2.1.1";
1
+ export const SDK_VERSION = "2.1.3";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@foru-ms/sdk",
3
- "version": "2.1.1",
3
+ "version": "2.1.3",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -5423,6 +5423,7 @@ Create an new integration.
5423
5423
  ```typescript
5424
5424
  await client.integrations.create({
5425
5425
  type: "type",
5426
+ name: "name",
5426
5427
  config: {
5427
5428
  "key": "value"
5428
5429
  }
@@ -5759,13 +5760,11 @@ Create an new sso.
5759
5760
 
5760
5761
  ```typescript
5761
5762
  await client.ssOs.create({
5762
- name: "name",
5763
- clientId: "clientId",
5764
- clientSecret: "clientSecret",
5765
- issuer: "issuer",
5766
- authorizationEndpoint: "authorizationEndpoint",
5767
- tokenEndpoint: "tokenEndpoint",
5768
- userInfoEndpoint: "userInfoEndpoint"
5763
+ provider: "OKTA",
5764
+ domain: "domain",
5765
+ config: {
5766
+ "key": "value"
5767
+ }
5769
5768
  });
5770
5769
 
5771
5770
  ```