@foru-ms/sdk 2.0.8 → 2.1.1

package/dist/esm/api/resources/ssOs/client/Client.mjs

@@ -26,12 +26,19 @@ import * as environments from "../../../../environments.mjs";
 import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
 import * as errors from "../../../../errors/index.mjs";
 import * as Forum from "../../../index.mjs";
+/**
+ * Operations for sso
+ */
 export class SsOsClient {
-    constructor(options) {
+    constructor(options = {}) {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
-     * @param {Forum.GetSsoRequest} request
+     * Retrieve a paginated list of ssos. Use cursor for pagination.
+     *
+     * **Requires feature: sso**
+     *
+     * @param {Forum.ListSsOsRequest} request
      * @param {SsOsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -40,25 +47,19 @@ export class SsOsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.ssOs.listAllSsOs()
+     *     await client.ssOs.list()
      */
-    listAllSsOs(request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__listAllSsOs(request, requestOptions));
+    list(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
     }
-    __listAllSsOs() {
+    __list() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const { page, limit, search } = request;
-            const _queryParams = {};
-            if (page != null) {
-                _queryParams.page = page.toString();
-            }
-            if (limit != null) {
-                _queryParams.limit = limit.toString();
-            }
-            if (search != null) {
-                _queryParams.search = search;
-            }
+            const { limit, cursor } = request;
+            const _queryParams = {
+                limit,
+                cursor,
+            };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
@@ -97,7 +98,11 @@ export class SsOsClient {
         });
     }
     /**
-     * @param {Forum.PostSsoRequest} request
+     * Create an new sso.
+     *
+     * **Requires feature: sso**
+     *
+     * @param {Forum.CreateSsOsRequest} request
      * @param {SsOsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -107,7 +112,7 @@ export class SsOsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.ssOs.createAnSso({
+     *     await client.ssOs.create({
      *         name: "name",
      *         clientId: "clientId",
      *         clientSecret: "clientSecret",
@@ -117,10 +122,10 @@ export class SsOsClient {
      *         userInfoEndpoint: "userInfoEndpoint"
      *     })
      */
-    createAnSso(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__createAnSso(request, requestOptions));
+    create(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
     }
-    __createAnSso(request, requestOptions) {
+    __create(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
@@ -166,7 +171,11 @@ export class SsOsClient {
         });
     }
     /**
-     * @param {Forum.GetSsoIdRequest} request
+     * Retrieve an sso by ID or slug (if supported).
+     *
+     * **Requires feature: sso**
+     *
+     * @param {Forum.RetrieveSsOsRequest} request
      * @param {SsOsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -176,14 +185,14 @@ export class SsOsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.ssOs.getAnSso({
+     *     await client.ssOs.retrieve({
      *         id: "id"
      *     })
      */
-    getAnSso(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getAnSso(request, requestOptions));
+    retrieve(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__retrieve(request, requestOptions));
     }
-    __getAnSso(request, requestOptions) {
+    __retrieve(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
             const { id } = request;
@@ -227,7 +236,11 @@ export class SsOsClient {
         });
     }
     /**
-     * @param {Forum.DeleteSsoIdRequest} request
+     * Permanently delete an sso.
+     *
+     * **Requires feature: sso**
+     *
+     * @param {Forum.DeleteSsOsRequest} request
      * @param {SsOsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -237,14 +250,14 @@ export class SsOsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.ssOs.deleteAnSso({
+     *     await client.ssOs.delete({
      *         id: "id"
      *     })
      */
-    deleteAnSso(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__deleteAnSso(request, requestOptions));
+    delete(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__delete(request, requestOptions));
     }
-    __deleteAnSso(request, requestOptions) {
+    __delete(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
             const { id } = request;
@@ -288,7 +301,11 @@ export class SsOsClient {
         });
     }
     /**
-     * @param {Forum.PatchSsoIdRequest} request
+     * Update an existing sso. Only provided fields will be modified.
+     *
+     * **Requires feature: sso**
+     *
+     * @param {Forum.UpdateSsOsRequest} request
      * @param {SsOsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -299,14 +316,14 @@ export class SsOsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.ssOs.updateAnSso({
+     *     await client.ssOs.update({
      *         id: "id"
      *     })
      */
-    updateAnSso(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__updateAnSso(request, requestOptions));
+    update(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__update(request, requestOptions));
     }
-    __updateAnSso(request, requestOptions) {
+    __update(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
             const { id } = request, _body = __rest(request, ["id"]);

package/dist/esm/api/resources/ssOs/client/requests/CreateSsOsRequest.d.mts

@@ -0,0 +1,24 @@
+/**
+ * @example
+ *     {
+ *         name: "name",
+ *         clientId: "clientId",
+ *         clientSecret: "clientSecret",
+ *         issuer: "issuer",
+ *         authorizationEndpoint: "authorizationEndpoint",
+ *         tokenEndpoint: "tokenEndpoint",
+ *         userInfoEndpoint: "userInfoEndpoint"
+ *     }
+ */
+export interface CreateSsOsRequest {
+    /** Provider name (e.g. Google) */
+    name: string;
+    clientId: string;
+    clientSecret: string;
+    issuer: string;
+    authorizationEndpoint: string;
+    tokenEndpoint: string;
+    userInfoEndpoint: string;
+    /** Custom extended data */
+    extendedData?: Record<string, unknown>;
+}

package/dist/esm/api/resources/ssOs/client/requests/DeleteSsOsRequest.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface DeleteSsOsRequest {
+    /** SSO ID */
+    id: string;
+}

package/dist/esm/api/resources/ssOs/client/requests/ListSsOsRequest.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {}
+ */
+export interface ListSsOsRequest {
+    /** Items per page (max 75) */
+    limit?: number;
+    /** Cursor for pagination */
+    cursor?: string;
+}

package/dist/esm/api/resources/ssOs/client/requests/RetrieveSsOsRequest.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface RetrieveSsOsRequest {
+    /** SSO ID */
+    id: string;
+}

package/dist/esm/api/resources/ssOs/client/requests/UpdateSsOsRequest.d.mts

@@ -0,0 +1,24 @@
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface UpdateSsOsRequest {
+    /** SSO ID */
+    id: string;
+    /** Provider name */
+    name?: string;
+    /** Email domain to match */
+    domain?: string;
+    clientId?: string;
+    clientSecret?: string;
+    issuer?: string;
+    authorizationEndpoint?: string;
+    tokenEndpoint?: string;
+    userInfoEndpoint?: string;
+    /** Enable/disable provider */
+    active?: boolean;
+    /** Custom extended data */
+    extendedData?: Record<string, unknown>;
+}

package/dist/esm/api/resources/ssOs/client/requests/index.d.mts

@@ -1,5 +1,5 @@
-export type { DeleteSsoIdRequest } from "./DeleteSsoIdRequest.mjs";
-export type { GetSsoIdRequest } from "./GetSsoIdRequest.mjs";
-export type { GetSsoRequest } from "./GetSsoRequest.mjs";
-export type { PatchSsoIdRequest } from "./PatchSsoIdRequest.mjs";
-export type { PostSsoRequest } from "./PostSsoRequest.mjs";
+export type { CreateSsOsRequest } from "./CreateSsOsRequest.mjs";
+export type { DeleteSsOsRequest } from "./DeleteSsOsRequest.mjs";
+export type { ListSsOsRequest } from "./ListSsOsRequest.mjs";
+export type { RetrieveSsOsRequest } from "./RetrieveSsOsRequest.mjs";
+export type { UpdateSsOsRequest } from "./UpdateSsOsRequest.mjs";

package/dist/esm/api/resources/ssOs/types/UpdateSsOsResponse.d.mts

@@ -0,0 +1,29 @@
+export interface UpdateSsOsResponse {
+    data?: UpdateSsOsResponse.Data;
+}
+export declare namespace UpdateSsOsResponse {
+    interface Data {
+        id: string;
+        /** SSO provider type */
+        provider: Data.Provider;
+        /** Email domain for this provider */
+        domain: string;
+        /** Whether SSO is active */
+        active: boolean;
+        /** Custom extended data */
+        extendedData: Record<string, unknown> | null;
+        /** SSO configuration creation timestamp */
+        createdAt: string;
+        /** SSO configuration last update timestamp */
+        updatedAt: string;
+    }
+    namespace Data {
+        /** SSO provider type */
+        const Provider: {
+            readonly Okta: "OKTA";
+            readonly Auth0: "AUTH0";
+            readonly Saml: "SAML";
+        };
+        type Provider = (typeof Provider)[keyof typeof Provider];
+    }
+}

package/dist/esm/api/resources/ssOs/types/UpdateSsOsResponse.mjs

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+export var UpdateSsOsResponse;
+(function (UpdateSsOsResponse) {
+    let Data;
+    (function (Data) {
+        /** SSO provider type */
+        Data.Provider = {
+            Okta: "OKTA",
+            Auth0: "AUTH0",
+            Saml: "SAML",
+        };
+    })(Data = UpdateSsOsResponse.Data || (UpdateSsOsResponse.Data = {}));
+})(UpdateSsOsResponse || (UpdateSsOsResponse = {}));

package/dist/esm/api/resources/ssOs/types/index.d.mts

@@ -1,5 +1 @@
-export * from "./DeleteSsoIdResponse.mjs";
-export * from "./GetSsoIdResponse.mjs";
-export * from "./GetSsoResponse.mjs";
-export * from "./PatchSsoIdResponse.mjs";
-export * from "./PostSsoResponse.mjs";
+export * from "./UpdateSsOsResponse.mjs";

package/dist/esm/api/resources/ssOs/types/index.mjs

@@ -1,5 +1 @@
-export * from "./DeleteSsoIdResponse.mjs";
-export * from "./GetSsoIdResponse.mjs";
-export * from "./GetSsoResponse.mjs";
-export * from "./PatchSsoIdResponse.mjs";
-export * from "./PostSsoResponse.mjs";
+export * from "./UpdateSsOsResponse.mjs";

package/dist/esm/api/resources/tags/client/Client.d.mts

@@ -7,11 +7,16 @@ export declare namespace TagsClient {
     interface RequestOptions extends BaseRequestOptions {
     }
 }
+/**
+ * Operations for tags
+ */
 export declare class TagsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<TagsClient.Options>;
-    constructor(options: TagsClient.Options);
+    constructor(options?: TagsClient.Options);
     /**
-     * @param {Forum.GetTagsRequest} request
+     * Retrieve a paginated list of tags. Use cursor for pagination.
+     *
+     * @param {Forum.ListTagsRequest} request
      * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -20,12 +25,14 @@ export declare class TagsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.tags.listAllTags()
+     *     await client.tags.list()
      */
-    listAllTags(request?: Forum.GetTagsRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.GetTagsResponse>;
-    private __listAllTags;
+    list(request?: Forum.ListTagsRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.TagListResponse>;
+    private __list;
     /**
-     * @param {Forum.PostTagsRequest} request
+     * Create a new tag.
+     *
+     * @param {Forum.CreateTagsRequest} request
      * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -35,14 +42,16 @@ export declare class TagsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.tags.createATag({
+     *     await client.tags.create({
      *         name: "name"
      *     })
      */
-    createATag(request: Forum.PostTagsRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.PostTagsResponse>;
-    private __createATag;
+    create(request: Forum.CreateTagsRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.TagResponse>;
+    private __create;
     /**
-     * @param {Forum.GetTagsIdRequest} request
+     * Retrieve a tag by ID or slug (if supported).
+     *
+     * @param {Forum.RetrieveTagsRequest} request
      * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -52,14 +61,16 @@ export declare class TagsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.tags.getATag({
+     *     await client.tags.retrieve({
      *         id: "id"
      *     })
      */
-    getATag(request: Forum.GetTagsIdRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.GetTagsIdResponse>;
-    private __getATag;
+    retrieve(request: Forum.RetrieveTagsRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.TagResponse>;
+    private __retrieve;
     /**
-     * @param {Forum.DeleteTagsIdRequest} request
+     * Permanently delete a tag.
+     *
+     * @param {Forum.DeleteTagsRequest} request
      * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -69,14 +80,16 @@ export declare class TagsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.tags.deleteATag({
+     *     await client.tags.delete({
      *         id: "id"
      *     })
      */
-    deleteATag(request: Forum.DeleteTagsIdRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.DeleteTagsIdResponse>;
-    private __deleteATag;
+    delete(request: Forum.DeleteTagsRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.SuccessResponse>;
+    private __delete;
     /**
-     * @param {Forum.PatchTagsIdRequest} request
+     * Update an existing tag. Only provided fields will be modified.
+     *
+     * @param {Forum.UpdateTagsRequest} request
      * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -87,14 +100,16 @@ export declare class TagsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.tags.updateATag({
+     *     await client.tags.update({
      *         id: "id"
      *     })
      */
-    updateATag(request: Forum.PatchTagsIdRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.PatchTagsIdResponse>;
-    private __updateATag;
+    update(request: Forum.UpdateTagsRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.UpdateTagsResponse>;
+    private __update;
     /**
-     * @param {Forum.GetTagsIdSubscribersRequest} request
+     * Retrieve a paginated list of subscribers for Tag.
+     *
+     * @param {Forum.ListSubscribersTagsRequest} request
      * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -103,14 +118,14 @@ export declare class TagsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.tags.listTagSubscribers({
+     *     await client.tags.listSubscribers({
      *         id: "id"
      *     })
      */
-    listTagSubscribers(request: Forum.GetTagsIdSubscribersRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.GetTagsIdSubscribersResponse>;
-    private __listTagSubscribers;
+    listSubscribers(request: Forum.ListSubscribersTagsRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.TagSubscriberListResponse>;
+    private __listSubscribers;
     /**
-     * @param {Forum.GetTagsIdSubscribersSubIdRequest} request
+     * @param {Forum.RetrieveSubscriberTagsRequest} request
      * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -119,15 +134,15 @@ export declare class TagsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.tags.getASubscriberFromTag({
+     *     await client.tags.retrieveSubscriber({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    getASubscriberFromTag(request: Forum.GetTagsIdSubscribersSubIdRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.GetTagsIdSubscribersSubIdResponse>;
-    private __getASubscriberFromTag;
+    retrieveSubscriber(request: Forum.RetrieveSubscriberTagsRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.RetrieveSubscriberTagsResponse>;
+    private __retrieveSubscriber;
     /**
-     * @param {Forum.DeleteTagsIdSubscribersSubIdRequest} request
+     * @param {Forum.DeleteSubscriberTagsRequest} request
      * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -136,11 +151,11 @@ export declare class TagsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.tags.deleteASubscriberFromTag({
+     *     await client.tags.deleteSubscriber({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    deleteASubscriberFromTag(request: Forum.DeleteTagsIdSubscribersSubIdRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.DeleteTagsIdSubscribersSubIdResponse>;
-    private __deleteASubscriberFromTag;
+    deleteSubscriber(request: Forum.DeleteSubscriberTagsRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Forum.SuccessResponse>;
+    private __deleteSubscriber;
 }