@trophyso/node
Version:
NodeJS SDK for the Trophy API
1,264 lines • 83.5 kB
JavaScript
"use strict";
// This file was auto-generated by Fern from our API Definition.
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.UsersClient = void 0;
const BaseClient_1 = require("../../../../BaseClient");
const core = __importStar(require("../../../../core"));
const headers_1 = require("../../../../core/headers");
const environments = __importStar(require("../../../../environments"));
const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCodeError");
const errors = __importStar(require("../../../../errors/index"));
const serializers = __importStar(require("../../../../serialization/index"));
const TrophyApi = __importStar(require("../../../index"));
class UsersClient {
constructor(options) {
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
}
/**
* Create a new user.
*
* @param {TrophyApi.UpsertedUser} request
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.BadRequestError}
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.create({
* id: "user-id"
* })
*/
create(request, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
}
__create(request, requestOptions) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, "users"),
method: "POST",
headers: _headers,
contentType: "application/json",
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
requestType: "json",
body: serializers.UpsertedUser.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.User.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new TrophyApi.BadRequestError(_response.error.body, _response.rawResponse);
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/users");
});
}
/**
* Get a single user.
*
* @param {string} id - ID of the user to get.
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.BadRequestError}
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.get("userId")
*/
get(id, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__get(id, requestOptions));
}
__get(id, requestOptions) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}`),
method: "GET",
headers: _headers,
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.User.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new TrophyApi.BadRequestError(_response.error.body, _response.rawResponse);
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/users/{id}");
});
}
/**
* Identify a user.
*
* @param {string} id - ID of the user to identify.
* @param {TrophyApi.UpdatedUser} request
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.BadRequestError}
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.identify("id", {
* email: "user@example.com",
* tz: "Europe/London",
* attributes: {
* "department": "engineering",
* "role": "developer"
* }
* })
*/
identify(id, request, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__identify(id, request, requestOptions));
}
__identify(id, request, requestOptions) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}`),
method: "PUT",
headers: _headers,
contentType: "application/json",
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
requestType: "json",
body: serializers.UpdatedUser.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.User.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new TrophyApi.BadRequestError(_response.error.body, _response.rawResponse);
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PUT", "/users/{id}");
});
}
/**
* Update a user.
*
* @param {string} id - ID of the user to update.
* @param {TrophyApi.UpdatedUser} request
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.BadRequestError}
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.NotFoundError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.update("id", {
* email: "user@example.com",
* tz: "Europe/London",
* attributes: {
* "department": "engineering",
* "role": "developer"
* }
* })
*/
update(id, request, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__update(id, request, requestOptions));
}
__update(id, request, requestOptions) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}`),
method: "PATCH",
headers: _headers,
contentType: "application/json",
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
requestType: "json",
body: serializers.UpdatedUser.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.User.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new TrophyApi.BadRequestError(_response.error.body, _response.rawResponse);
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 404:
throw new TrophyApi.NotFoundError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/users/{id}");
});
}
/**
* Get a user's notification preferences.
*
* @param {string} id - The user's ID in your database.
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.NotFoundError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.getPreferences("user-123")
*/
getPreferences(id, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__getPreferences(id, requestOptions));
}
__getPreferences(id, requestOptions) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}/preferences`),
method: "GET",
headers: _headers,
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.UserPreferencesResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 404:
throw new TrophyApi.NotFoundError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/users/{id}/preferences");
});
}
/**
* Update a user's notification and streak preferences. Streak preferences require streak customization to be enabled in your Trophy dashboard settings.
*
* @param {string} id - The user's ID in your database.
* @param {TrophyApi.UpdateUserPreferencesRequest} request
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.ForbiddenError}
* @throws {@link TrophyApi.NotFoundError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.updatePreferences("user-123", {
* notifications: {
* streakReminder: ["email"]
* }
* })
*
* @example
* await client.users.updatePreferences("user-123", {
* notifications: {
* recap: ["email"]
* }
* })
*
* @example
* await client.users.updatePreferences("user-123", {
* notifications: {
* achievementCompleted: ["email", "push"]
* }
* })
*
* @example
* await client.users.updatePreferences("user-123", {
* streak: {
* evaluationMode: "OR",
* metrics: [{
* key: "words-written",
* threshold: 500
* }]
* }
* })
*/
updatePreferences(id, request = {}, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__updatePreferences(id, request, requestOptions));
}
__updatePreferences(id_1) {
return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}/preferences`),
method: "PATCH",
headers: _headers,
contentType: "application/json",
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
requestType: "json",
body: serializers.UpdateUserPreferencesRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.UserPreferencesResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 403:
throw new TrophyApi.ForbiddenError(_response.error.body, _response.rawResponse);
case 404:
throw new TrophyApi.NotFoundError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/users/{id}/preferences");
});
}
/**
* Get a single user's progress against all active metrics.
*
* @param {string} id - ID of the user
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.NotFoundError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.allMetrics("userId")
*/
allMetrics(id, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__allMetrics(id, requestOptions));
}
__allMetrics(id, requestOptions) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}/metrics`),
method: "GET",
headers: _headers,
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.users.allMetrics.Response.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 404:
throw new TrophyApi.NotFoundError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/users/{id}/metrics");
});
}
/**
* Get a user's progress against a single active metric.
*
* @param {string} id - ID of the user.
* @param {string} key - Unique key of the metric.
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.NotFoundError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.singleMetric("userId", "key")
*/
singleMetric(id, key, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__singleMetric(id, key, requestOptions));
}
__singleMetric(id, key, requestOptions) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}/metrics/${core.url.encodePathParam(key)}`),
method: "GET",
headers: _headers,
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.MetricResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 404:
throw new TrophyApi.NotFoundError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/users/{id}/metrics/{key}");
});
}
/**
* Get a summary of metric events over time for a user.
*
* @param {string} id - ID of the user.
* @param {string} key - Unique key of the metric.
* @param {TrophyApi.UsersMetricEventSummaryRequest} request
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.NotFoundError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.metricEventSummary("userId", "words-written", {
* aggregation: "daily",
* startDate: "2024-01-01",
* endDate: "2024-01-31"
* })
*/
metricEventSummary(id, key, request, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__metricEventSummary(id, key, request, requestOptions));
}
__metricEventSummary(id, key, request, requestOptions) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const { aggregation, startDate, endDate } = request;
const _queryParams = {
aggregation: serializers.UsersMetricEventSummaryRequestAggregation.jsonOrThrow(aggregation, {
unrecognizedObjectKeys: "strip",
}),
startDate,
endDate,
};
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}/metrics/${core.url.encodePathParam(key)}/event-summary`),
method: "GET",
headers: _headers,
queryString: core.url
.queryBuilder()
.addMany(_queryParams)
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
.build(),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.users.metricEventSummary.Response.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 404:
throw new TrophyApi.NotFoundError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/users/{id}/metrics/{key}/event-summary");
});
}
/**
* Get a user's achievements.
*
* @param {string} id - ID of the user.
* @param {TrophyApi.UsersAchievementsRequest} request
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.NotFoundError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.achievements("userId", {
* includeIncomplete: "true"
* })
*/
achievements(id, request = {}, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__achievements(id, request, requestOptions));
}
__achievements(id_1) {
return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const { includeIncomplete } = request;
const _queryParams = {
includeIncomplete: includeIncomplete != null ? includeIncomplete : undefined,
};
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}/achievements`),
method: "GET",
headers: _headers,
queryString: core.url
.queryBuilder()
.addMany(_queryParams)
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
.build(),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.users.achievements.Response.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 404:
throw new TrophyApi.NotFoundError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/users/{id}/achievements");
});
}
/**
* Get a user's streak data.
*
* @param {string} id - ID of the user.
* @param {TrophyApi.UsersStreakRequest} request
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.NotFoundError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.streak("userId", {
* historyPeriods: 1
* })
*/
streak(id, request = {}, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__streak(id, request, requestOptions));
}
__streak(id_1) {
return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const { historyPeriods } = request;
const _queryParams = {
historyPeriods,
};
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}/streak`),
method: "GET",
headers: _headers,
queryString: core.url
.queryBuilder()
.addMany(_queryParams)
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
.build(),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.StreakResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 404:
throw new TrophyApi.NotFoundError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/users/{id}/streak");
});
}
/**
* Get a user's points for a specific points system.
*
* @param {string} id - ID of the user.
* @param {string} key - Key of the points system.
* @param {TrophyApi.UsersPointsRequest} request
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.NotFoundError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.points("userId", "points-system-key", {
* awards: 1
* })
*/
points(id, key, request = {}, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__points(id, key, request, requestOptions));
}
__points(id_1, key_1) {
return __awaiter(this, arguments, void 0, function* (id, key, request = {}, requestOptions) {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const { awards } = request;
const _queryParams = {
awards,
};
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}/points/${core.url.encodePathParam(key)}`),
method: "GET",
headers: _headers,
queryString: core.url
.queryBuilder()
.addMany(_queryParams)
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
.build(),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.GetUserPointsResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 404:
throw new TrophyApi.NotFoundError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/users/{id}/points/{key}");
});
}
/**
* Get active points boosts for a user in a specific points system. Returns both global boosts the user is eligible for and user-specific boosts.
*
* @param {string} id - ID of the user.
* @param {string} key - Key of the points system.
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.NotFoundError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.pointsBoosts("userId", "points-system-key")
*/
pointsBoosts(id, key, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__pointsBoosts(id, key, requestOptions));
}
__pointsBoosts(id, key, requestOptions) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}/points/${core.url.encodePathParam(key)}/boosts`),
method: "GET",
headers: _headers,
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.users.pointsBoosts.Response.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 404:
throw new TrophyApi.NotFoundError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/users/{id}/points/{key}/boosts");
});
}
/**
* Get a summary of points awards over time for a user for a specific points system.
*
* @param {string} id - ID of the user.
* @param {string} key - Key of the points system.
* @param {TrophyApi.UsersPointsEventSummaryRequest} request
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.NotFoundError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.pointsEventSummary("userId", "points-system-key", {
* aggregation: "daily",
* startDate: "2024-01-01",
* endDate: "2024-01-31"
* })
*/
pointsEventSummary(id, key, request, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__pointsEventSummary(id, key, request, requestOptions));
}
__pointsEventSummary(id, key, request, requestOptions) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const { aggregation, startDate, endDate } = request;
const _queryParams = {
aggregation: serializers.UsersPointsEventSummaryRequestAggregation.jsonOrThrow(aggregation, {
unrecognizedObjectKeys: "strip",
}),
startDate,
endDate,
};
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}/points/${core.url.encodePathParam(key)}/event-summary`),
method: "GET",
headers: _headers,
queryString: core.url
.queryBuilder()
.addMany(_queryParams)
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
.build(),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.users.pointsEventSummary.Response.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 404:
throw new TrophyApi.NotFoundError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/users/{id}/points/{key}/event-summary");
});
}
/**
* Get a user's rank, value, and daily ranking history for a specific leaderboard.
*
* @param {string} id - The user's ID in your database.
* @param {string} key - Unique key of the leaderboard as set when created.
* @param {TrophyApi.UsersLeaderboardRequest} request
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.NotFoundError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.leaderboard("user-123", "weekly-words", {
* run: "2025-01-15",
* numEvents: 1
* })
*/
leaderboard(id, key, request = {}, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__leaderboard(id, key, request, requestOptions));
}
__leaderboard(id_1, key_1) {
return __awaiter(this, arguments, void 0, function* (id, key, request = {}, requestOptions) {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const { run, numEvents } = request;
const _queryParams = {
run,
numEvents,
};
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}/leaderboards/${core.url.encodePathParam(key)}`),
method: "GET",
headers: _headers,
queryString: core.url
.queryBuilder()
.addMany(_queryParams)
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
.build(),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.UserLeaderboardResponseWithHistory.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 404:
throw new TrophyApi.NotFoundError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/users/{id}/leaderboards/{key}");
});
}
/**
* Get a user's year-in-review wrapped data.
*
* @param {string} id - The user's ID in your database.
* @param {TrophyApi.UsersWrappedRequest} request
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrophyApi.UnauthorizedError}
* @throws {@link TrophyApi.NotFoundError}
* @throws {@link TrophyApi.UnprocessableEntityError}
*
* @example
* await client.users.wrapped("user-123", {
* year: 1
* })
*/
wrapped(id, request = {}, requestOptions) {
return core.HttpResponsePromise.fromPromise(this.__wrapped(id, request, requestOptions));
}
__wrapped(id_1) {
return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
const { year } = request;
const _queryParams = {
year,
};
const _authRequest = yield this._options.authProvider.getAuthRequest();
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
"X-SDK-VERSION": (_d = (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sdkVersion) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sdkVersion) !== null && _d !== void 0 ? _d : "1.21.1",
"Tenant-ID": (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.tenantId) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.tenantId,
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
const _response = yield core.fetcher({
url: core.url.join((_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : ((_h = (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.TrophyApiEnvironment.Production).api, `users/${core.url.encodePathParam(id)}/wrapped`),
method: "GET",
headers: _headers,
queryString: core.url
.queryBuilder()
.addMany(_queryParams)
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
.build(),
timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
fetchFn: (_p = this._options) === null || _p === void 0 ? void 0 : _p.fetch,
logging: this._options.logging,
});
if (_response.ok) {
return {
data: serializers.WrappedResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
breadcrumbsPrefix: ["response"],
}),
rawResponse: _response.rawResponse,
};
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 401:
throw new TrophyApi.UnauthorizedError(_response.error.body, _response.rawResponse);
case 404:
throw new TrophyApi.NotFoundError(_response.error.body, _response.rawResponse);
case 422:
throw new TrophyApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
default:
throw new errors.TrophyApiError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/users/{id}/wrapped");
});
}
}
exports.UsersClient = UsersClient;