@ichos/sdk 1.0.2 → 1.0.4

package/src/api/resources/users/client/Client.ts

@@ -0,0 +1,445 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.js";
+import * as core from "../../../../core/index.js";
+import * as environments from "../../../../environments.js";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js";
+import * as errors from "../../../../errors/index.js";
+import * as Ichos from "../../../index.js";
+
+export declare namespace UsersClient {
+    export type Options = BaseClientOptions;
+
+    export interface RequestOptions extends BaseRequestOptions {}
+}
+
+export class UsersClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<UsersClient.Options>;
+
+    constructor(options: UsersClient.Options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+
+    /**
+     * Retrieve the current virtual user based on the header.
+     *
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.users.getCurrentVirtualUser()
+     */
+    public getCurrentVirtualUser(
+        requestOptions?: UsersClient.RequestOptions,
+    ): core.HttpResponsePromise<Ichos.VirtualUserResponse> {
+        return core.HttpResponsePromise.fromPromise(this.__getCurrentVirtualUser(requestOptions));
+    }
+
+    private async __getCurrentVirtualUser(
+        requestOptions?: UsersClient.RequestOptions,
+    ): Promise<core.WithRawResponse<Ichos.VirtualUserResponse>> {
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({ "x-virtual-user": requestOptions?.virtualUser ?? this._options?.virtualUser }),
+            requestOptions?.headers,
+        );
+        const _response = await core.fetcher({
+            url: core.url.join(
+                (await core.Supplier.get(this._options.baseUrl)) ??
+                    (await core.Supplier.get(this._options.environment)) ??
+                    environments.IchosEnvironment.Default,
+                "v1/users",
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body as Ichos.VirtualUserResponse, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new Ichos.UnauthorizedError(
+                        _response.error.body as Ichos.UnauthorizedErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 403:
+                    throw new Ichos.ForbiddenError(
+                        _response.error.body as Ichos.UnauthenticatedErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 404:
+                    throw new Ichos.NotFoundError(
+                        _response.error.body as Ichos.NotFoundErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 500:
+                    throw new Ichos.InternalServerError(
+                        _response.error.body as Ichos.InternalServerErrorResponse,
+                        _response.rawResponse,
+                    );
+                default:
+                    throw new errors.IchosError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/users");
+    }
+
+    /**
+     * Delete the currently authenticated virtual user.
+     *
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.users.deleteCurrentVirtualUser()
+     */
+    public deleteCurrentVirtualUser(
+        requestOptions?: UsersClient.RequestOptions,
+    ): core.HttpResponsePromise<Ichos.NullResponse> {
+        return core.HttpResponsePromise.fromPromise(this.__deleteCurrentVirtualUser(requestOptions));
+    }
+
+    private async __deleteCurrentVirtualUser(
+        requestOptions?: UsersClient.RequestOptions,
+    ): Promise<core.WithRawResponse<Ichos.NullResponse>> {
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({ "x-virtual-user": requestOptions?.virtualUser ?? this._options?.virtualUser }),
+            requestOptions?.headers,
+        );
+        const _response = await core.fetcher({
+            url: core.url.join(
+                (await core.Supplier.get(this._options.baseUrl)) ??
+                    (await core.Supplier.get(this._options.environment)) ??
+                    environments.IchosEnvironment.Default,
+                "v1/users",
+            ),
+            method: "DELETE",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body as Ichos.NullResponse, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new Ichos.UnauthorizedError(
+                        _response.error.body as Ichos.UnauthorizedErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 403:
+                    throw new Ichos.ForbiddenError(
+                        _response.error.body as Ichos.UnauthenticatedErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 404:
+                    throw new Ichos.NotFoundError(
+                        _response.error.body as Ichos.NotFoundErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 500:
+                    throw new Ichos.InternalServerError(
+                        _response.error.body as Ichos.InternalServerErrorResponse,
+                        _response.rawResponse,
+                    );
+                default:
+                    throw new errors.IchosError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v1/users");
+    }
+
+    /**
+     * Update details of the current virtual user.
+     *
+     * @param {Ichos.UpdateCurrentVirtualUserRequest} request
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.users.updateCurrentVirtualUser()
+     */
+    public updateCurrentVirtualUser(
+        request: Ichos.UpdateCurrentVirtualUserRequest = {},
+        requestOptions?: UsersClient.RequestOptions,
+    ): core.HttpResponsePromise<Ichos.VirtualUserResponse> {
+        return core.HttpResponsePromise.fromPromise(this.__updateCurrentVirtualUser(request, requestOptions));
+    }
+
+    private async __updateCurrentVirtualUser(
+        request: Ichos.UpdateCurrentVirtualUserRequest = {},
+        requestOptions?: UsersClient.RequestOptions,
+    ): Promise<core.WithRawResponse<Ichos.VirtualUserResponse>> {
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({ "x-virtual-user": requestOptions?.virtualUser ?? this._options?.virtualUser }),
+            requestOptions?.headers,
+        );
+        const _response = await core.fetcher({
+            url: core.url.join(
+                (await core.Supplier.get(this._options.baseUrl)) ??
+                    (await core.Supplier.get(this._options.environment)) ??
+                    environments.IchosEnvironment.Default,
+                "v1/users",
+            ),
+            method: "PATCH",
+            headers: _headers,
+            contentType: "application/json",
+            queryParameters: requestOptions?.queryParams,
+            requestType: "json",
+            body: request,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body as Ichos.VirtualUserResponse, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new Ichos.UnauthorizedError(
+                        _response.error.body as Ichos.UnauthorizedErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 403:
+                    throw new Ichos.ForbiddenError(
+                        _response.error.body as Ichos.UnauthenticatedErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 404:
+                    throw new Ichos.NotFoundError(
+                        _response.error.body as Ichos.NotFoundErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 500:
+                    throw new Ichos.InternalServerError(
+                        _response.error.body as Ichos.InternalServerErrorResponse,
+                        _response.rawResponse,
+                    );
+                default:
+                    throw new errors.IchosError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/v1/users");
+    }
+
+    /**
+     * Retrieve all virtual users associated with the authenticated organization.
+     *
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.users.listVirtualUsers()
+     */
+    public listVirtualUsers(
+        requestOptions?: UsersClient.RequestOptions,
+    ): core.HttpResponsePromise<Ichos.VirtualUserListResponse> {
+        return core.HttpResponsePromise.fromPromise(this.__listVirtualUsers(requestOptions));
+    }
+
+    private async __listVirtualUsers(
+        requestOptions?: UsersClient.RequestOptions,
+    ): Promise<core.WithRawResponse<Ichos.VirtualUserListResponse>> {
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({ "x-virtual-user": requestOptions?.virtualUser ?? this._options?.virtualUser }),
+            requestOptions?.headers,
+        );
+        const _response = await core.fetcher({
+            url: core.url.join(
+                (await core.Supplier.get(this._options.baseUrl)) ??
+                    (await core.Supplier.get(this._options.environment)) ??
+                    environments.IchosEnvironment.Default,
+                "v1/users/all",
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body as Ichos.VirtualUserListResponse, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new Ichos.UnauthorizedError(
+                        _response.error.body as Ichos.UnauthorizedErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 403:
+                    throw new Ichos.ForbiddenError(
+                        _response.error.body as Ichos.UnauthenticatedErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 404:
+                    throw new Ichos.NotFoundError(
+                        _response.error.body as Ichos.NotFoundErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 500:
+                    throw new Ichos.InternalServerError(
+                        _response.error.body as Ichos.InternalServerErrorResponse,
+                        _response.rawResponse,
+                    );
+                default:
+                    throw new errors.IchosError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/users/all");
+    }
+
+    /**
+     * Retrieve listener analytics for the current virtual user.
+     *
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.users.getVirtualUserListenersReport()
+     */
+    public getVirtualUserListenersReport(
+        requestOptions?: UsersClient.RequestOptions,
+    ): core.HttpResponsePromise<Ichos.ListenersReportResponse> {
+        return core.HttpResponsePromise.fromPromise(this.__getVirtualUserListenersReport(requestOptions));
+    }
+
+    private async __getVirtualUserListenersReport(
+        requestOptions?: UsersClient.RequestOptions,
+    ): Promise<core.WithRawResponse<Ichos.ListenersReportResponse>> {
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({ "x-virtual-user": requestOptions?.virtualUser ?? this._options?.virtualUser }),
+            requestOptions?.headers,
+        );
+        const _response = await core.fetcher({
+            url: core.url.join(
+                (await core.Supplier.get(this._options.baseUrl)) ??
+                    (await core.Supplier.get(this._options.environment)) ??
+                    environments.IchosEnvironment.Default,
+                "v1/users/analytics/listens",
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body as Ichos.ListenersReportResponse, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new Ichos.UnauthorizedError(
+                        _response.error.body as Ichos.UnauthorizedErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 403:
+                    throw new Ichos.ForbiddenError(
+                        _response.error.body as Ichos.UnauthenticatedErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 404:
+                    throw new Ichos.NotFoundError(
+                        _response.error.body as Ichos.NotFoundErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 500:
+                    throw new Ichos.InternalServerError(
+                        _response.error.body as Ichos.InternalServerErrorResponse,
+                        _response.rawResponse,
+                    );
+                default:
+                    throw new errors.IchosError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/users/analytics/listens");
+    }
+}

package/src/api/resources/users/client/index.ts

@@ -0,0 +1 @@
+export * from "./requests/index.js";

package/src/api/resources/users/client/requests/UpdateCurrentVirtualUserRequest.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {}
+ */
+export interface UpdateCurrentVirtualUserRequest {
+    adsEnabled?: boolean;
+}

package/src/api/resources/users/client/requests/index.ts

@@ -0,0 +1 @@
+export type { UpdateCurrentVirtualUserRequest } from "./UpdateCurrentVirtualUserRequest.js";

package/src/api/resources/users/index.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";