@foru-ms/sdk 2.1.0 → 2.1.2
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 +4 -1
- package/dist/cjs/Client.js +16 -11
- package/dist/cjs/api/resources/auth/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/auth/client/Client.js +1 -1
- package/dist/cjs/api/resources/index.d.ts +3 -0
- package/dist/cjs/api/resources/index.js +4 -1
- package/dist/cjs/api/resources/integrations/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/integrations/client/Client.js +7 -9
- package/dist/cjs/api/resources/integrations/client/requests/CreateIntegrationsRequest.d.ts +8 -2
- package/dist/cjs/api/resources/integrations/client/requests/ListIntegrationsRequest.d.ts +2 -2
- package/dist/cjs/api/resources/integrations/client/requests/UpdateIntegrationsRequest.d.ts +2 -0
- package/dist/cjs/api/resources/integrations/types/UpdateIntegrationsResponse.d.ts +2 -0
- package/dist/cjs/api/resources/notifications/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/notifications/client/Client.js +7 -14
- package/dist/cjs/api/resources/notifications/client/requests/index.d.ts +2 -2
- package/dist/cjs/api/resources/notifications/client/requests/index.js +5 -0
- package/dist/cjs/api/resources/posts/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/posts/client/Client.js +22 -49
- package/dist/cjs/api/resources/posts/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/posts/client/requests/index.js +3 -0
- package/dist/cjs/api/resources/privateMessages/client/Client.d.ts +21 -1
- package/dist/cjs/api/resources/privateMessages/client/Client.js +79 -18
- package/dist/cjs/api/resources/privateMessages/client/requests/UpdatePrivateMessagesRequest.d.ts +16 -0
- package/dist/cjs/api/resources/privateMessages/client/requests/UpdatePrivateMessagesRequest.js +3 -0
- package/dist/cjs/api/resources/privateMessages/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/privateMessages/types/UpdatePrivateMessagesResponse.d.ts +26 -0
- package/dist/cjs/api/resources/privateMessages/types/UpdatePrivateMessagesResponse.js +3 -0
- package/dist/cjs/api/resources/privateMessages/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/privateMessages/types/index.js +1 -0
- package/dist/cjs/api/resources/reports/client/Client.d.ts +21 -1
- package/dist/cjs/api/resources/reports/client/Client.js +88 -17
- package/dist/cjs/api/resources/reports/client/requests/CreateReportsRequest.d.ts +4 -0
- package/dist/cjs/api/resources/reports/client/requests/UpdateReportsRequest.d.ts +16 -0
- package/dist/cjs/api/resources/reports/client/requests/UpdateReportsRequest.js +3 -0
- package/dist/cjs/api/resources/reports/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/reports/index.d.ts +1 -0
- package/dist/cjs/api/resources/reports/index.js +1 -0
- package/dist/cjs/api/resources/reports/types/UpdateReportsResponse.d.ts +30 -0
- package/dist/cjs/api/resources/reports/types/UpdateReportsResponse.js +3 -0
- package/dist/cjs/api/resources/reports/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/reports/types/index.js +17 -0
- package/dist/cjs/api/resources/roles/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/roles/client/Client.js +8 -9
- package/dist/cjs/api/resources/roles/client/requests/ListRolesRequest.d.ts +7 -2
- package/dist/cjs/api/resources/roles/types/ListRolesRequestSort.d.ts +6 -0
- package/dist/cjs/api/resources/roles/types/ListRolesRequestSort.js +9 -0
- package/dist/cjs/api/resources/roles/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/roles/types/index.js +1 -0
- package/dist/cjs/api/resources/search/client/Client.d.ts +29 -0
- package/dist/cjs/api/resources/search/client/Client.js +115 -0
- package/dist/cjs/api/resources/search/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/search/client/index.js +2 -0
- package/dist/cjs/api/resources/search/index.d.ts +2 -0
- package/dist/cjs/api/resources/search/index.js +18 -0
- package/dist/cjs/api/resources/search/types/SearchSearchResponse.d.ts +33 -0
- package/dist/cjs/api/resources/search/types/SearchSearchResponse.js +22 -0
- package/dist/cjs/api/resources/search/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/search/types/index.js +17 -0
- package/dist/cjs/api/resources/ssOs/client/Client.d.ts +6 -8
- package/dist/cjs/api/resources/ssOs/client/Client.js +11 -16
- package/dist/cjs/api/resources/ssOs/client/requests/CreateSsOsRequest.d.ts +24 -15
- package/dist/cjs/api/resources/ssOs/client/requests/CreateSsOsRequest.js +10 -0
- package/dist/cjs/api/resources/ssOs/client/requests/ListSsOsRequest.d.ts +2 -2
- package/dist/cjs/api/resources/ssOs/client/requests/UpdateSsOsRequest.d.ts +15 -8
- package/dist/cjs/api/resources/ssOs/client/requests/UpdateSsOsRequest.js +10 -0
- package/dist/cjs/api/resources/ssOs/client/requests/index.d.ts +2 -2
- package/dist/cjs/api/resources/ssOs/client/requests/index.js +5 -0
- package/dist/cjs/api/resources/ssOs/types/UpdateSsOsResponse.d.ts +2 -0
- package/dist/cjs/api/resources/tags/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tags/client/Client.js +10 -18
- package/dist/cjs/api/resources/threads/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/threads/client/Client.js +26 -56
- package/dist/cjs/api/resources/threads/client/requests/CreateThreadsRequest.d.ts +6 -0
- package/dist/cjs/api/resources/threads/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/threads/client/requests/index.js +3 -0
- package/dist/cjs/api/resources/threads/types/UpdateThreadsResponse.d.ts +5 -5
- package/dist/cjs/api/resources/users/client/Client.d.ts +20 -1
- package/dist/cjs/api/resources/users/client/Client.js +80 -28
- package/dist/cjs/api/resources/users/client/requests/CreateUsersRequest.d.ts +26 -0
- package/dist/cjs/api/resources/users/client/requests/CreateUsersRequest.js +3 -0
- package/dist/cjs/api/resources/users/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +23 -1
- package/dist/cjs/api/resources/webhooks/client/Client.js +91 -15
- package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhooksRequest.d.ts +4 -0
- package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhooksRequest.d.ts +22 -0
- package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhooksRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhooksResponse.d.ts +26 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhooksResponse.js +3 -0
- package/dist/cjs/api/resources/webhooks/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/webhooks/types/index.js +1 -0
- package/dist/cjs/api/types/Integration.d.ts +2 -0
- package/dist/cjs/api/types/IntegrationCreate.d.ts +7 -2
- package/dist/cjs/api/types/IntegrationList.d.ts +6 -0
- package/dist/cjs/api/types/IntegrationList.js +3 -0
- package/dist/cjs/api/types/IntegrationListResponse.d.ts +2 -0
- package/dist/cjs/api/types/IntegrationResponse.d.ts +2 -0
- package/dist/cjs/api/types/IntegrationUpdate.d.ts +2 -0
- package/dist/cjs/api/types/MeResponse.d.ts +22 -0
- package/dist/cjs/api/types/PrivateMessageUpdate.d.ts +8 -0
- package/dist/cjs/api/types/PrivateMessageUpdate.js +3 -0
- package/dist/cjs/api/types/Report.d.ts +4 -2
- package/dist/cjs/api/types/ReportCreate.d.ts +4 -0
- package/dist/cjs/api/types/ReportListResponse.d.ts +4 -2
- package/dist/cjs/api/types/ReportResponse.d.ts +4 -2
- package/dist/cjs/api/types/ReportUpdate.d.ts +8 -0
- package/dist/cjs/api/types/ReportUpdate.js +3 -0
- package/dist/cjs/api/types/RoleList.d.ts +19 -0
- package/dist/cjs/api/types/RoleList.js +13 -0
- package/dist/cjs/api/types/Search.d.ts +1 -0
- package/dist/cjs/api/types/Search.js +3 -0
- package/dist/cjs/api/types/SearchListResponse.d.ts +18 -0
- package/dist/cjs/api/types/SearchListResponse.js +3 -0
- package/dist/cjs/api/types/SearchResponse.d.ts +6 -0
- package/dist/cjs/api/types/SearchResponse.js +3 -0
- package/dist/cjs/api/types/Sso.d.ts +2 -0
- package/dist/cjs/api/types/SsoCreate.d.ts +19 -11
- package/dist/cjs/api/types/SsoCreate.js +10 -0
- package/dist/cjs/api/types/SsoList.d.ts +6 -0
- package/dist/cjs/api/types/SsoList.js +3 -0
- package/dist/cjs/api/types/SsoListResponse.d.ts +2 -0
- package/dist/cjs/api/types/SsoResponse.d.ts +2 -0
- package/dist/cjs/api/types/SsoUpdate.d.ts +15 -11
- package/dist/cjs/api/types/SsoUpdate.js +10 -0
- package/dist/cjs/api/types/Thread.d.ts +5 -5
- package/dist/cjs/api/types/ThreadCreate.d.ts +6 -0
- package/dist/cjs/api/types/ThreadListResponse.d.ts +5 -5
- package/dist/cjs/api/types/ThreadResponse.d.ts +5 -5
- package/dist/cjs/api/types/UserCreate.d.ts +20 -0
- package/dist/cjs/api/types/UserCreate.js +3 -0
- package/dist/cjs/api/types/Webhook.d.ts +2 -0
- package/dist/cjs/api/types/WebhookCreate.d.ts +4 -0
- package/dist/cjs/api/types/WebhookListResponse.d.ts +2 -0
- package/dist/cjs/api/types/WebhookResponse.d.ts +2 -0
- package/dist/cjs/api/types/WebhookUpdate.d.ts +14 -0
- package/dist/cjs/api/types/WebhookUpdate.js +3 -0
- package/dist/cjs/api/types/index.d.ts +10 -0
- package/dist/cjs/api/types/index.js +10 -0
- package/dist/cjs/auth/HeaderAuthProvider.d.ts +14 -10
- package/dist/cjs/auth/HeaderAuthProvider.js +18 -9
- package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +2 -2
- package/dist/cjs/core/fetcher/Fetcher.d.ts +1 -2
- package/dist/cjs/core/headers.d.ts +2 -2
- 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 +4 -1
- package/dist/esm/Client.mjs +6 -1
- package/dist/esm/api/resources/auth/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/auth/client/Client.mjs +1 -1
- package/dist/esm/api/resources/index.d.mts +3 -0
- package/dist/esm/api/resources/index.mjs +3 -0
- package/dist/esm/api/resources/integrations/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/integrations/client/Client.mjs +7 -9
- package/dist/esm/api/resources/integrations/client/requests/CreateIntegrationsRequest.d.mts +8 -2
- package/dist/esm/api/resources/integrations/client/requests/ListIntegrationsRequest.d.mts +2 -2
- package/dist/esm/api/resources/integrations/client/requests/UpdateIntegrationsRequest.d.mts +2 -0
- package/dist/esm/api/resources/integrations/types/UpdateIntegrationsResponse.d.mts +2 -0
- package/dist/esm/api/resources/notifications/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/notifications/client/Client.mjs +7 -14
- package/dist/esm/api/resources/notifications/client/requests/index.d.mts +2 -2
- package/dist/esm/api/resources/notifications/client/requests/index.mjs +2 -1
- package/dist/esm/api/resources/posts/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/posts/client/Client.mjs +22 -49
- package/dist/esm/api/resources/posts/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/posts/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/privateMessages/client/Client.d.mts +21 -1
- package/dist/esm/api/resources/privateMessages/client/Client.mjs +79 -18
- package/dist/esm/api/resources/privateMessages/client/requests/UpdatePrivateMessagesRequest.d.mts +16 -0
- package/dist/esm/api/resources/privateMessages/client/requests/UpdatePrivateMessagesRequest.mjs +2 -0
- package/dist/esm/api/resources/privateMessages/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/privateMessages/types/UpdatePrivateMessagesResponse.d.mts +26 -0
- package/dist/esm/api/resources/privateMessages/types/UpdatePrivateMessagesResponse.mjs +2 -0
- package/dist/esm/api/resources/privateMessages/types/index.d.mts +1 -0
- package/dist/esm/api/resources/privateMessages/types/index.mjs +1 -0
- package/dist/esm/api/resources/reports/client/Client.d.mts +21 -1
- package/dist/esm/api/resources/reports/client/Client.mjs +88 -17
- package/dist/esm/api/resources/reports/client/requests/CreateReportsRequest.d.mts +4 -0
- package/dist/esm/api/resources/reports/client/requests/UpdateReportsRequest.d.mts +16 -0
- package/dist/esm/api/resources/reports/client/requests/UpdateReportsRequest.mjs +2 -0
- package/dist/esm/api/resources/reports/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/reports/index.d.mts +1 -0
- package/dist/esm/api/resources/reports/index.mjs +1 -0
- package/dist/esm/api/resources/reports/types/UpdateReportsResponse.d.mts +30 -0
- package/dist/esm/api/resources/reports/types/UpdateReportsResponse.mjs +2 -0
- package/dist/esm/api/resources/reports/types/index.d.mts +1 -0
- package/dist/esm/api/resources/reports/types/index.mjs +1 -0
- package/dist/esm/api/resources/roles/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/roles/client/Client.mjs +8 -9
- package/dist/esm/api/resources/roles/client/requests/ListRolesRequest.d.mts +7 -2
- package/dist/esm/api/resources/roles/types/ListRolesRequestSort.d.mts +6 -0
- package/dist/esm/api/resources/roles/types/ListRolesRequestSort.mjs +6 -0
- package/dist/esm/api/resources/roles/types/index.d.mts +1 -0
- package/dist/esm/api/resources/roles/types/index.mjs +1 -0
- package/dist/esm/api/resources/search/client/Client.d.mts +29 -0
- package/dist/esm/api/resources/search/client/Client.mjs +78 -0
- package/dist/esm/api/resources/search/client/index.d.mts +1 -0
- package/dist/esm/api/resources/search/client/index.mjs +1 -0
- package/dist/esm/api/resources/search/index.d.mts +2 -0
- package/dist/esm/api/resources/search/index.mjs +2 -0
- package/dist/esm/api/resources/search/types/SearchSearchResponse.d.mts +33 -0
- package/dist/esm/api/resources/search/types/SearchSearchResponse.mjs +19 -0
- package/dist/esm/api/resources/search/types/index.d.mts +1 -0
- package/dist/esm/api/resources/search/types/index.mjs +1 -0
- package/dist/esm/api/resources/ssOs/client/Client.d.mts +6 -8
- package/dist/esm/api/resources/ssOs/client/Client.mjs +11 -16
- package/dist/esm/api/resources/ssOs/client/requests/CreateSsOsRequest.d.mts +24 -15
- package/dist/esm/api/resources/ssOs/client/requests/CreateSsOsRequest.mjs +9 -1
- package/dist/esm/api/resources/ssOs/client/requests/ListSsOsRequest.d.mts +2 -2
- package/dist/esm/api/resources/ssOs/client/requests/UpdateSsOsRequest.d.mts +15 -8
- package/dist/esm/api/resources/ssOs/client/requests/UpdateSsOsRequest.mjs +9 -1
- package/dist/esm/api/resources/ssOs/client/requests/index.d.mts +2 -2
- package/dist/esm/api/resources/ssOs/client/requests/index.mjs +2 -1
- package/dist/esm/api/resources/ssOs/types/UpdateSsOsResponse.d.mts +2 -0
- package/dist/esm/api/resources/tags/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tags/client/Client.mjs +10 -18
- package/dist/esm/api/resources/threads/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/threads/client/Client.mjs +26 -56
- package/dist/esm/api/resources/threads/client/requests/CreateThreadsRequest.d.mts +6 -0
- package/dist/esm/api/resources/threads/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/threads/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/threads/types/UpdateThreadsResponse.d.mts +5 -5
- package/dist/esm/api/resources/users/client/Client.d.mts +20 -1
- package/dist/esm/api/resources/users/client/Client.mjs +80 -28
- package/dist/esm/api/resources/users/client/requests/CreateUsersRequest.d.mts +26 -0
- package/dist/esm/api/resources/users/client/requests/CreateUsersRequest.mjs +2 -0
- package/dist/esm/api/resources/users/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +23 -1
- package/dist/esm/api/resources/webhooks/client/Client.mjs +91 -15
- package/dist/esm/api/resources/webhooks/client/requests/CreateWebhooksRequest.d.mts +4 -0
- package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhooksRequest.d.mts +22 -0
- package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhooksRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/webhooks/types/UpdateWebhooksResponse.d.mts +26 -0
- package/dist/esm/api/resources/webhooks/types/UpdateWebhooksResponse.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/index.d.mts +1 -0
- package/dist/esm/api/resources/webhooks/types/index.mjs +1 -0
- package/dist/esm/api/types/Integration.d.mts +2 -0
- package/dist/esm/api/types/IntegrationCreate.d.mts +7 -2
- package/dist/esm/api/types/IntegrationList.d.mts +6 -0
- package/dist/esm/api/types/IntegrationList.mjs +2 -0
- package/dist/esm/api/types/IntegrationListResponse.d.mts +2 -0
- package/dist/esm/api/types/IntegrationResponse.d.mts +2 -0
- package/dist/esm/api/types/IntegrationUpdate.d.mts +2 -0
- package/dist/esm/api/types/MeResponse.d.mts +22 -0
- package/dist/esm/api/types/PrivateMessageUpdate.d.mts +8 -0
- package/dist/esm/api/types/PrivateMessageUpdate.mjs +2 -0
- package/dist/esm/api/types/Report.d.mts +4 -2
- package/dist/esm/api/types/ReportCreate.d.mts +4 -0
- package/dist/esm/api/types/ReportListResponse.d.mts +4 -2
- package/dist/esm/api/types/ReportResponse.d.mts +4 -2
- package/dist/esm/api/types/ReportUpdate.d.mts +8 -0
- package/dist/esm/api/types/ReportUpdate.mjs +2 -0
- package/dist/esm/api/types/RoleList.d.mts +19 -0
- package/dist/esm/api/types/RoleList.mjs +10 -0
- package/dist/esm/api/types/Search.d.mts +1 -0
- package/dist/esm/api/types/Search.mjs +2 -0
- package/dist/esm/api/types/SearchListResponse.d.mts +18 -0
- package/dist/esm/api/types/SearchListResponse.mjs +2 -0
- package/dist/esm/api/types/SearchResponse.d.mts +6 -0
- package/dist/esm/api/types/SearchResponse.mjs +2 -0
- package/dist/esm/api/types/Sso.d.mts +2 -0
- package/dist/esm/api/types/SsoCreate.d.mts +19 -11
- package/dist/esm/api/types/SsoCreate.mjs +9 -1
- package/dist/esm/api/types/SsoList.d.mts +6 -0
- package/dist/esm/api/types/SsoList.mjs +2 -0
- package/dist/esm/api/types/SsoListResponse.d.mts +2 -0
- package/dist/esm/api/types/SsoResponse.d.mts +2 -0
- package/dist/esm/api/types/SsoUpdate.d.mts +15 -11
- package/dist/esm/api/types/SsoUpdate.mjs +9 -1
- package/dist/esm/api/types/Thread.d.mts +5 -5
- package/dist/esm/api/types/ThreadCreate.d.mts +6 -0
- package/dist/esm/api/types/ThreadListResponse.d.mts +5 -5
- package/dist/esm/api/types/ThreadResponse.d.mts +5 -5
- package/dist/esm/api/types/UserCreate.d.mts +20 -0
- package/dist/esm/api/types/UserCreate.mjs +2 -0
- package/dist/esm/api/types/Webhook.d.mts +2 -0
- package/dist/esm/api/types/WebhookCreate.d.mts +4 -0
- package/dist/esm/api/types/WebhookListResponse.d.mts +2 -0
- package/dist/esm/api/types/WebhookResponse.d.mts +2 -0
- package/dist/esm/api/types/WebhookUpdate.d.mts +14 -0
- package/dist/esm/api/types/WebhookUpdate.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +10 -0
- package/dist/esm/api/types/index.mjs +10 -0
- package/dist/esm/auth/HeaderAuthProvider.d.mts +14 -10
- package/dist/esm/auth/HeaderAuthProvider.mjs +18 -9
- package/dist/esm/core/fetcher/EndpointSupplier.d.mts +2 -2
- package/dist/esm/core/fetcher/Fetcher.d.mts +1 -2
- package/dist/esm/core/headers.d.mts +2 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +2 -2
- package/reference.md +310 -7
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export interface RoleList {
|
|
2
|
+
/** Items per page (max 75) */
|
|
3
|
+
limit?: number;
|
|
4
|
+
/** Cursor for pagination */
|
|
5
|
+
cursor?: string;
|
|
6
|
+
/** Search by name or slug */
|
|
7
|
+
search?: string;
|
|
8
|
+
/** Sort order */
|
|
9
|
+
sort?: RoleList.Sort;
|
|
10
|
+
}
|
|
11
|
+
export declare namespace RoleList {
|
|
12
|
+
/** Sort order */
|
|
13
|
+
const Sort: {
|
|
14
|
+
readonly Newest: "newest";
|
|
15
|
+
readonly Oldest: "oldest";
|
|
16
|
+
readonly Name: "name";
|
|
17
|
+
};
|
|
18
|
+
type Sort = (typeof Sort)[keyof typeof Sort];
|
|
19
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.RoleList = void 0;
|
|
5
|
+
var RoleList;
|
|
6
|
+
(function (RoleList) {
|
|
7
|
+
/** Sort order */
|
|
8
|
+
RoleList.Sort = {
|
|
9
|
+
Newest: "newest",
|
|
10
|
+
Oldest: "oldest",
|
|
11
|
+
Name: "name",
|
|
12
|
+
};
|
|
13
|
+
})(RoleList || (exports.RoleList = RoleList = {}));
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type Search = {};
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export interface SearchListResponse {
|
|
2
|
+
data: SearchListResponse.Data;
|
|
3
|
+
}
|
|
4
|
+
export declare namespace SearchListResponse {
|
|
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
|
+
}
|
|
12
|
+
namespace Data {
|
|
13
|
+
type Items = Items.Item[];
|
|
14
|
+
namespace Items {
|
|
15
|
+
type Item = {};
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
}
|
|
@@ -6,6 +6,8 @@ export interface Sso {
|
|
|
6
6
|
domain: string;
|
|
7
7
|
/** Whether SSO is active */
|
|
8
8
|
active: boolean;
|
|
9
|
+
/** Custom extended data */
|
|
10
|
+
extendedData: Record<string, unknown> | null;
|
|
9
11
|
/** SSO configuration creation timestamp */
|
|
10
12
|
createdAt: string;
|
|
11
13
|
/** SSO configuration last update timestamp */
|
|
@@ -1,13 +1,21 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* OIDC provider config
|
|
3
|
-
*/
|
|
4
1
|
export interface SsoCreate {
|
|
5
|
-
/**
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
issuer
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
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;
|
|
10
|
+
/** Custom extended data */
|
|
11
|
+
extendedData?: Record<string, unknown>;
|
|
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];
|
|
13
21
|
}
|
|
@@ -1,3 +1,13 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.SsoCreate = void 0;
|
|
5
|
+
var SsoCreate;
|
|
6
|
+
(function (SsoCreate) {
|
|
7
|
+
/** SSO provider type */
|
|
8
|
+
SsoCreate.Provider = {
|
|
9
|
+
Okta: "OKTA",
|
|
10
|
+
Auth0: "AUTH0",
|
|
11
|
+
Saml: "SAML",
|
|
12
|
+
};
|
|
13
|
+
})(SsoCreate || (exports.SsoCreate = SsoCreate = {}));
|
|
@@ -20,6 +20,8 @@ export declare namespace SsoListResponse {
|
|
|
20
20
|
domain: string;
|
|
21
21
|
/** Whether SSO is active */
|
|
22
22
|
active: boolean;
|
|
23
|
+
/** Custom extended data */
|
|
24
|
+
extendedData: Record<string, unknown> | null;
|
|
23
25
|
/** SSO configuration creation timestamp */
|
|
24
26
|
createdAt: string;
|
|
25
27
|
/** SSO configuration last update timestamp */
|
|
@@ -10,6 +10,8 @@ export declare namespace SsoResponse {
|
|
|
10
10
|
domain: string;
|
|
11
11
|
/** Whether SSO is active */
|
|
12
12
|
active: boolean;
|
|
13
|
+
/** Custom extended data */
|
|
14
|
+
extendedData: Record<string, unknown> | null;
|
|
13
15
|
/** SSO configuration creation timestamp */
|
|
14
16
|
createdAt: string;
|
|
15
17
|
/** SSO configuration last update timestamp */
|
|
@@ -1,17 +1,21 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Partial OIDC provider update
|
|
3
|
-
*/
|
|
4
1
|
export interface SsoUpdate {
|
|
5
|
-
/**
|
|
6
|
-
|
|
2
|
+
/** SSO provider type */
|
|
3
|
+
provider?: SsoUpdate.Provider;
|
|
7
4
|
/** Email domain to match */
|
|
8
5
|
domain?: string;
|
|
9
|
-
|
|
10
|
-
|
|
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;
|
|
10
|
+
/** Custom extended data */
|
|
11
|
+
extendedData?: Record<string, unknown>;
|
|
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];
|
|
17
21
|
}
|
|
@@ -1,3 +1,13 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.SsoUpdate = void 0;
|
|
5
|
+
var SsoUpdate;
|
|
6
|
+
(function (SsoUpdate) {
|
|
7
|
+
/** SSO provider type */
|
|
8
|
+
SsoUpdate.Provider = {
|
|
9
|
+
Okta: "OKTA",
|
|
10
|
+
Auth0: "AUTH0",
|
|
11
|
+
Saml: "SAML",
|
|
12
|
+
};
|
|
13
|
+
})(SsoUpdate || (exports.SsoUpdate = SsoUpdate = {}));
|
|
@@ -10,21 +10,21 @@ export interface Thread {
|
|
|
10
10
|
tags?: string[];
|
|
11
11
|
/** Poll data */
|
|
12
12
|
poll?: Forum.ThreadPoll;
|
|
13
|
-
id: string;
|
|
14
|
-
/** URL-friendly identifier */
|
|
15
|
-
slug: string | null;
|
|
16
13
|
/** Whether thread is locked */
|
|
17
14
|
locked: boolean | null;
|
|
18
15
|
/** Whether thread is pinned */
|
|
19
16
|
pinned: boolean | null;
|
|
17
|
+
/** Custom metadata */
|
|
18
|
+
extendedData: Record<string, unknown> | null;
|
|
19
|
+
id: string;
|
|
20
|
+
/** URL-friendly identifier */
|
|
21
|
+
slug: string | null;
|
|
20
22
|
/** View count */
|
|
21
23
|
views: number;
|
|
22
24
|
/** Number of posts/replies */
|
|
23
25
|
postsCount: number;
|
|
24
26
|
/** Timestamp of the last post */
|
|
25
27
|
lastPostAt: string | null;
|
|
26
|
-
/** Custom metadata */
|
|
27
|
-
extendedData: Record<string, unknown> | null;
|
|
28
28
|
createdAt: string;
|
|
29
29
|
updatedAt: string;
|
|
30
30
|
}
|
|
@@ -9,6 +9,12 @@ export interface ThreadCreate {
|
|
|
9
9
|
tags?: string[];
|
|
10
10
|
/** Poll data */
|
|
11
11
|
poll?: ThreadCreate.Poll;
|
|
12
|
+
/** Lock thread on creation */
|
|
13
|
+
locked?: boolean;
|
|
14
|
+
/** Pin thread on creation */
|
|
15
|
+
pinned?: boolean;
|
|
16
|
+
/** Custom extended data */
|
|
17
|
+
extendedData?: Record<string, unknown>;
|
|
12
18
|
}
|
|
13
19
|
export declare namespace ThreadCreate {
|
|
14
20
|
/**
|
|
@@ -23,21 +23,21 @@ export declare namespace ThreadListResponse {
|
|
|
23
23
|
tags?: string[];
|
|
24
24
|
/** Poll data */
|
|
25
25
|
poll?: Item.Poll;
|
|
26
|
-
id: string;
|
|
27
|
-
/** URL-friendly identifier */
|
|
28
|
-
slug: string | null;
|
|
29
26
|
/** Whether thread is locked */
|
|
30
27
|
locked: boolean | null;
|
|
31
28
|
/** Whether thread is pinned */
|
|
32
29
|
pinned: boolean | null;
|
|
30
|
+
/** Custom metadata */
|
|
31
|
+
extendedData: Record<string, unknown> | null;
|
|
32
|
+
id: string;
|
|
33
|
+
/** URL-friendly identifier */
|
|
34
|
+
slug: string | null;
|
|
33
35
|
/** View count */
|
|
34
36
|
views: number;
|
|
35
37
|
/** Number of posts/replies */
|
|
36
38
|
postsCount: number;
|
|
37
39
|
/** Timestamp of the last post */
|
|
38
40
|
lastPostAt: string | null;
|
|
39
|
-
/** Custom metadata */
|
|
40
|
-
extendedData: Record<string, unknown> | null;
|
|
41
41
|
createdAt: string;
|
|
42
42
|
updatedAt: string;
|
|
43
43
|
}
|
|
@@ -13,21 +13,21 @@ export declare namespace ThreadResponse {
|
|
|
13
13
|
tags?: string[];
|
|
14
14
|
/** Poll data */
|
|
15
15
|
poll?: Data.Poll;
|
|
16
|
-
id: string;
|
|
17
|
-
/** URL-friendly identifier */
|
|
18
|
-
slug: string | null;
|
|
19
16
|
/** Whether thread is locked */
|
|
20
17
|
locked: boolean | null;
|
|
21
18
|
/** Whether thread is pinned */
|
|
22
19
|
pinned: boolean | null;
|
|
20
|
+
/** Custom metadata */
|
|
21
|
+
extendedData: Record<string, unknown> | null;
|
|
22
|
+
id: string;
|
|
23
|
+
/** URL-friendly identifier */
|
|
24
|
+
slug: string | null;
|
|
23
25
|
/** View count */
|
|
24
26
|
views: number;
|
|
25
27
|
/** Number of posts/replies */
|
|
26
28
|
postsCount: number;
|
|
27
29
|
/** Timestamp of the last post */
|
|
28
30
|
lastPostAt: string | null;
|
|
29
|
-
/** Custom metadata */
|
|
30
|
-
extendedData: Record<string, unknown> | null;
|
|
31
31
|
createdAt: string;
|
|
32
32
|
updatedAt: string;
|
|
33
33
|
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
export interface UserCreate {
|
|
2
|
+
/** Username (letters, numbers, underscores, hyphens) */
|
|
3
|
+
username: string;
|
|
4
|
+
/** Email address */
|
|
5
|
+
email?: string;
|
|
6
|
+
/** Password (min 8 chars) */
|
|
7
|
+
password?: string;
|
|
8
|
+
/** Display name */
|
|
9
|
+
displayName?: string;
|
|
10
|
+
/** User bio */
|
|
11
|
+
bio?: string;
|
|
12
|
+
/** Forum signature */
|
|
13
|
+
signature?: string;
|
|
14
|
+
/** Website URL */
|
|
15
|
+
url?: string;
|
|
16
|
+
/** Role slugs to assign */
|
|
17
|
+
roles?: string[];
|
|
18
|
+
/** Custom extended data */
|
|
19
|
+
extendedData?: Record<string, unknown>;
|
|
20
|
+
}
|
|
@@ -8,6 +8,8 @@ export interface Webhook {
|
|
|
8
8
|
events: string[];
|
|
9
9
|
/** Whether webhook is active */
|
|
10
10
|
active: boolean;
|
|
11
|
+
/** Custom extended data */
|
|
12
|
+
extendedData: Record<string, unknown> | null;
|
|
11
13
|
/** Last trigger timestamp */
|
|
12
14
|
lastTriggered: string | null;
|
|
13
15
|
/** Consecutive failure count */
|
|
@@ -7,4 +7,8 @@ export interface WebhookCreate {
|
|
|
7
7
|
events: string[];
|
|
8
8
|
/** Secret for signature verification (auto-generated if missing) */
|
|
9
9
|
secret?: string;
|
|
10
|
+
/** Whether webhook is active */
|
|
11
|
+
active?: boolean;
|
|
12
|
+
/** Custom extended data */
|
|
13
|
+
extendedData?: Record<string, unknown>;
|
|
10
14
|
}
|
|
@@ -22,6 +22,8 @@ export declare namespace WebhookListResponse {
|
|
|
22
22
|
events: string[];
|
|
23
23
|
/** Whether webhook is active */
|
|
24
24
|
active: boolean;
|
|
25
|
+
/** Custom extended data */
|
|
26
|
+
extendedData: Record<string, unknown> | null;
|
|
25
27
|
/** Last trigger timestamp */
|
|
26
28
|
lastTriggered: string | null;
|
|
27
29
|
/** Consecutive failure count */
|
|
@@ -12,6 +12,8 @@ export declare namespace WebhookResponse {
|
|
|
12
12
|
events: string[];
|
|
13
13
|
/** Whether webhook is active */
|
|
14
14
|
active: boolean;
|
|
15
|
+
/** Custom extended data */
|
|
16
|
+
extendedData: Record<string, unknown> | null;
|
|
15
17
|
/** Last trigger timestamp */
|
|
16
18
|
lastTriggered: string | null;
|
|
17
19
|
/** Consecutive failure count */
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export interface WebhookUpdate {
|
|
2
|
+
/** Webhook name */
|
|
3
|
+
name?: string;
|
|
4
|
+
/** Target URL */
|
|
5
|
+
url?: string;
|
|
6
|
+
/** Event types to trigger on */
|
|
7
|
+
events?: string[];
|
|
8
|
+
/** New secret */
|
|
9
|
+
secret?: string;
|
|
10
|
+
/** Enable/disable webhook */
|
|
11
|
+
active?: boolean;
|
|
12
|
+
/** Custom extended data */
|
|
13
|
+
extendedData?: Record<string, unknown>;
|
|
14
|
+
}
|
|
@@ -5,6 +5,7 @@ export * from "./ErrorResponse.js";
|
|
|
5
5
|
export * from "./ForgotPasswordResponse.js";
|
|
6
6
|
export * from "./Integration.js";
|
|
7
7
|
export * from "./IntegrationCreate.js";
|
|
8
|
+
export * from "./IntegrationList.js";
|
|
8
9
|
export * from "./IntegrationListResponse.js";
|
|
9
10
|
export * from "./IntegrationResponse.js";
|
|
10
11
|
export * from "./IntegrationUpdate.js";
|
|
@@ -38,20 +39,27 @@ export * from "./PrivateMessageReplyCreate.js";
|
|
|
38
39
|
export * from "./PrivateMessageReplyListResponse.js";
|
|
39
40
|
export * from "./PrivateMessageReplyResponse.js";
|
|
40
41
|
export * from "./PrivateMessageResponse.js";
|
|
42
|
+
export * from "./PrivateMessageUpdate.js";
|
|
41
43
|
export * from "./RegisterResponse.js";
|
|
42
44
|
export * from "./Report.js";
|
|
43
45
|
export * from "./ReportCreate.js";
|
|
44
46
|
export * from "./ReportList.js";
|
|
45
47
|
export * from "./ReportListResponse.js";
|
|
46
48
|
export * from "./ReportResponse.js";
|
|
49
|
+
export * from "./ReportUpdate.js";
|
|
47
50
|
export * from "./ResetPasswordResponse.js";
|
|
48
51
|
export * from "./Role.js";
|
|
49
52
|
export * from "./RoleCreate.js";
|
|
53
|
+
export * from "./RoleList.js";
|
|
50
54
|
export * from "./RoleListResponse.js";
|
|
51
55
|
export * from "./RoleResponse.js";
|
|
52
56
|
export * from "./RoleUpdate.js";
|
|
57
|
+
export * from "./Search.js";
|
|
58
|
+
export * from "./SearchListResponse.js";
|
|
59
|
+
export * from "./SearchResponse.js";
|
|
53
60
|
export * from "./Sso.js";
|
|
54
61
|
export * from "./SsoCreate.js";
|
|
62
|
+
export * from "./SsoList.js";
|
|
55
63
|
export * from "./SsoListResponse.js";
|
|
56
64
|
export * from "./SsoResponse.js";
|
|
57
65
|
export * from "./SsoUpdate.js";
|
|
@@ -86,6 +94,7 @@ export * from "./ThreadSubscriberListResponse.js";
|
|
|
86
94
|
export * from "./ThreadSubscriberResponse.js";
|
|
87
95
|
export * from "./ThreadUpdate.js";
|
|
88
96
|
export * from "./User.js";
|
|
97
|
+
export * from "./UserCreate.js";
|
|
89
98
|
export * from "./UserFollower.js";
|
|
90
99
|
export * from "./UserFollowerListResponse.js";
|
|
91
100
|
export * from "./UserFollowerResponse.js";
|
|
@@ -104,3 +113,4 @@ export * from "./WebhookDeliveryResponse.js";
|
|
|
104
113
|
export * from "./WebhookList.js";
|
|
105
114
|
export * from "./WebhookListResponse.js";
|
|
106
115
|
export * from "./WebhookResponse.js";
|
|
116
|
+
export * from "./WebhookUpdate.js";
|
|
@@ -21,6 +21,7 @@ __exportStar(require("./ErrorResponse.js"), exports);
|
|
|
21
21
|
__exportStar(require("./ForgotPasswordResponse.js"), exports);
|
|
22
22
|
__exportStar(require("./Integration.js"), exports);
|
|
23
23
|
__exportStar(require("./IntegrationCreate.js"), exports);
|
|
24
|
+
__exportStar(require("./IntegrationList.js"), exports);
|
|
24
25
|
__exportStar(require("./IntegrationListResponse.js"), exports);
|
|
25
26
|
__exportStar(require("./IntegrationResponse.js"), exports);
|
|
26
27
|
__exportStar(require("./IntegrationUpdate.js"), exports);
|
|
@@ -54,20 +55,27 @@ __exportStar(require("./PrivateMessageReplyCreate.js"), exports);
|
|
|
54
55
|
__exportStar(require("./PrivateMessageReplyListResponse.js"), exports);
|
|
55
56
|
__exportStar(require("./PrivateMessageReplyResponse.js"), exports);
|
|
56
57
|
__exportStar(require("./PrivateMessageResponse.js"), exports);
|
|
58
|
+
__exportStar(require("./PrivateMessageUpdate.js"), exports);
|
|
57
59
|
__exportStar(require("./RegisterResponse.js"), exports);
|
|
58
60
|
__exportStar(require("./Report.js"), exports);
|
|
59
61
|
__exportStar(require("./ReportCreate.js"), exports);
|
|
60
62
|
__exportStar(require("./ReportList.js"), exports);
|
|
61
63
|
__exportStar(require("./ReportListResponse.js"), exports);
|
|
62
64
|
__exportStar(require("./ReportResponse.js"), exports);
|
|
65
|
+
__exportStar(require("./ReportUpdate.js"), exports);
|
|
63
66
|
__exportStar(require("./ResetPasswordResponse.js"), exports);
|
|
64
67
|
__exportStar(require("./Role.js"), exports);
|
|
65
68
|
__exportStar(require("./RoleCreate.js"), exports);
|
|
69
|
+
__exportStar(require("./RoleList.js"), exports);
|
|
66
70
|
__exportStar(require("./RoleListResponse.js"), exports);
|
|
67
71
|
__exportStar(require("./RoleResponse.js"), exports);
|
|
68
72
|
__exportStar(require("./RoleUpdate.js"), exports);
|
|
73
|
+
__exportStar(require("./Search.js"), exports);
|
|
74
|
+
__exportStar(require("./SearchListResponse.js"), exports);
|
|
75
|
+
__exportStar(require("./SearchResponse.js"), exports);
|
|
69
76
|
__exportStar(require("./Sso.js"), exports);
|
|
70
77
|
__exportStar(require("./SsoCreate.js"), exports);
|
|
78
|
+
__exportStar(require("./SsoList.js"), exports);
|
|
71
79
|
__exportStar(require("./SsoListResponse.js"), exports);
|
|
72
80
|
__exportStar(require("./SsoResponse.js"), exports);
|
|
73
81
|
__exportStar(require("./SsoUpdate.js"), exports);
|
|
@@ -102,6 +110,7 @@ __exportStar(require("./ThreadSubscriberListResponse.js"), exports);
|
|
|
102
110
|
__exportStar(require("./ThreadSubscriberResponse.js"), exports);
|
|
103
111
|
__exportStar(require("./ThreadUpdate.js"), exports);
|
|
104
112
|
__exportStar(require("./User.js"), exports);
|
|
113
|
+
__exportStar(require("./UserCreate.js"), exports);
|
|
105
114
|
__exportStar(require("./UserFollower.js"), exports);
|
|
106
115
|
__exportStar(require("./UserFollowerListResponse.js"), exports);
|
|
107
116
|
__exportStar(require("./UserFollowerResponse.js"), exports);
|
|
@@ -120,3 +129,4 @@ __exportStar(require("./WebhookDeliveryResponse.js"), exports);
|
|
|
120
129
|
__exportStar(require("./WebhookList.js"), exports);
|
|
121
130
|
__exportStar(require("./WebhookListResponse.js"), exports);
|
|
122
131
|
__exportStar(require("./WebhookResponse.js"), exports);
|
|
132
|
+
__exportStar(require("./WebhookUpdate.js"), exports);
|
|
@@ -1,16 +1,20 @@
|
|
|
1
1
|
import * as core from "../core/index.js";
|
|
2
|
-
|
|
3
|
-
interface AuthOptions {
|
|
4
|
-
apiKey: core.Supplier<string>;
|
|
5
|
-
}
|
|
6
|
-
interface Options extends AuthOptions {
|
|
7
|
-
}
|
|
8
|
-
}
|
|
2
|
+
declare const PARAM_KEY: "apiKey";
|
|
9
3
|
export declare class HeaderAuthProvider implements core.AuthProvider {
|
|
10
|
-
private readonly
|
|
4
|
+
private readonly options;
|
|
11
5
|
constructor(options: HeaderAuthProvider.Options);
|
|
12
|
-
static canCreate(options: HeaderAuthProvider.Options): boolean;
|
|
13
|
-
getAuthRequest(
|
|
6
|
+
static canCreate(options: Partial<HeaderAuthProvider.Options>): boolean;
|
|
7
|
+
getAuthRequest({ endpointMetadata, }?: {
|
|
14
8
|
endpointMetadata?: core.EndpointMetadata;
|
|
15
9
|
}): Promise<core.AuthRequest>;
|
|
16
10
|
}
|
|
11
|
+
export declare namespace HeaderAuthProvider {
|
|
12
|
+
const AUTH_SCHEME: "ApiKeyAuth";
|
|
13
|
+
const AUTH_CONFIG_ERROR_MESSAGE: string;
|
|
14
|
+
type Options = AuthOptions;
|
|
15
|
+
type AuthOptions = {
|
|
16
|
+
[PARAM_KEY]?: core.Supplier<string>;
|
|
17
|
+
};
|
|
18
|
+
function createInstance(options: Options): core.AuthProvider;
|
|
19
|
+
}
|
|
20
|
+
export {};
|
|
@@ -46,26 +46,35 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
46
46
|
exports.HeaderAuthProvider = void 0;
|
|
47
47
|
const core = __importStar(require("../core/index.js"));
|
|
48
48
|
const errors = __importStar(require("../errors/index.js"));
|
|
49
|
+
const PARAM_KEY = "apiKey";
|
|
50
|
+
const HEADER_NAME = "x-api-key";
|
|
49
51
|
class HeaderAuthProvider {
|
|
50
52
|
constructor(options) {
|
|
51
|
-
this.
|
|
53
|
+
this.options = options;
|
|
52
54
|
}
|
|
53
55
|
static canCreate(options) {
|
|
54
|
-
return options
|
|
56
|
+
return (options === null || options === void 0 ? void 0 : options[PARAM_KEY]) != null;
|
|
55
57
|
}
|
|
56
|
-
getAuthRequest(
|
|
57
|
-
return __awaiter(this,
|
|
58
|
-
const
|
|
59
|
-
if (
|
|
58
|
+
getAuthRequest() {
|
|
59
|
+
return __awaiter(this, arguments, void 0, function* ({ endpointMetadata, } = {}) {
|
|
60
|
+
const headerValue = yield core.Supplier.get(this.options[PARAM_KEY]);
|
|
61
|
+
if (headerValue == null) {
|
|
60
62
|
throw new errors.ForumError({
|
|
61
|
-
message:
|
|
63
|
+
message: HeaderAuthProvider.AUTH_CONFIG_ERROR_MESSAGE,
|
|
62
64
|
});
|
|
63
65
|
}
|
|
64
|
-
const headerValue = apiKey;
|
|
65
66
|
return {
|
|
66
|
-
headers: {
|
|
67
|
+
headers: { [HEADER_NAME]: headerValue },
|
|
67
68
|
};
|
|
68
69
|
});
|
|
69
70
|
}
|
|
70
71
|
}
|
|
71
72
|
exports.HeaderAuthProvider = HeaderAuthProvider;
|
|
73
|
+
(function (HeaderAuthProvider) {
|
|
74
|
+
HeaderAuthProvider.AUTH_SCHEME = "ApiKeyAuth";
|
|
75
|
+
HeaderAuthProvider.AUTH_CONFIG_ERROR_MESSAGE = `Please provide '${PARAM_KEY}' when initializing the client`;
|
|
76
|
+
function createInstance(options) {
|
|
77
|
+
return new HeaderAuthProvider(options);
|
|
78
|
+
}
|
|
79
|
+
HeaderAuthProvider.createInstance = createInstance;
|
|
80
|
+
})(HeaderAuthProvider || (exports.HeaderAuthProvider = HeaderAuthProvider = {}));
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type { EndpointMetadata } from "./EndpointMetadata.js";
|
|
2
2
|
import type { Supplier } from "./Supplier.js";
|
|
3
3
|
type EndpointSupplierFn<T> = (arg: {
|
|
4
|
-
endpointMetadata
|
|
4
|
+
endpointMetadata?: EndpointMetadata;
|
|
5
5
|
}) => T | Promise<T>;
|
|
6
6
|
export type EndpointSupplier<T> = Supplier<T> | EndpointSupplierFn<T>;
|
|
7
7
|
export declare const EndpointSupplier: {
|
|
8
8
|
get: <T>(supplier: EndpointSupplier<T>, arg: {
|
|
9
|
-
endpointMetadata
|
|
9
|
+
endpointMetadata?: EndpointMetadata;
|
|
10
10
|
}) => Promise<T>;
|
|
11
11
|
};
|
|
12
12
|
export {};
|
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
import { type LogConfig, type Logger } from "../logging/logger.js";
|
|
2
2
|
import type { APIResponse } from "./APIResponse.js";
|
|
3
3
|
import type { EndpointMetadata } from "./EndpointMetadata.js";
|
|
4
|
-
import { EndpointSupplier } from "./EndpointSupplier.js";
|
|
5
4
|
export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
|
|
6
5
|
export declare namespace Fetcher {
|
|
7
6
|
interface Args {
|
|
8
7
|
url: string;
|
|
9
8
|
method: string;
|
|
10
9
|
contentType?: string;
|
|
11
|
-
headers?: Record<string,
|
|
10
|
+
headers?: Record<string, unknown>;
|
|
12
11
|
queryParameters?: Record<string, unknown>;
|
|
13
12
|
body?: unknown;
|
|
14
13
|
timeoutMs?: number;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare function mergeHeaders
|
|
2
|
-
export declare function mergeOnlyDefinedHeaders
|
|
1
|
+
export declare function mergeHeaders(...headersArray: (Record<string, unknown> | null | undefined)[]): Record<string, unknown>;
|
|
2
|
+
export declare function mergeOnlyDefinedHeaders(...headersArray: (Record<string, unknown> | null | undefined)[]): Record<string, unknown>;
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "2.
|
|
1
|
+
export declare const SDK_VERSION = "2.1.2";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
|
|
|
6
6
|
const headers = mergeHeaders({
|
|
7
7
|
"X-Fern-Language": "JavaScript",
|
|
8
8
|
"X-Fern-SDK-Name": "@foru-ms/sdk",
|
|
9
|
-
"X-Fern-SDK-Version": "2.
|
|
10
|
-
"User-Agent": "@foru-ms/sdk/2.
|
|
9
|
+
"X-Fern-SDK-Version": "2.1.2",
|
|
10
|
+
"User-Agent": "@foru-ms/sdk/2.1.2",
|
|
11
11
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
12
12
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
13
13
|
}, options === null || options === void 0 ? void 0 : options.headers);
|