@aurora-interactive/sensei-productivity 1.7.0 → 1.9.0

package/src/funcs/categories-create.ts

@@ -24,6 +24,7 @@ import { SenseiProductivityError } from "../models/errors/sensei-productivity-er
 import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
+import * as types$ from "../types/primitives.js";
 
 /**
  * Create a new category (school admins only)
@@ -34,7 +35,7 @@ export function categoriesCreate(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.CreateCategoryResponse,
+    operations.CreateCategoryResponse | undefined,
     | SenseiProductivityError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +60,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.CreateCategoryResponse,
+      operations.CreateCategoryResponse | undefined,
       | SenseiProductivityError
       | ResponseValidationError
       | ConnectionError
@@ -136,7 +137,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["400", "401", "403", "4XX", "5XX"],
+    errorCodes: ["429", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -146,7 +147,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.CreateCategoryResponse,
+    operations.CreateCategoryResponse | undefined,
     | SenseiProductivityError
     | ResponseValidationError
     | ConnectionError
@@ -156,8 +157,15 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(201, operations.CreateCategoryResponse$inboundSchema),
-    M.fail([400, 401, 403, "4XX"]),
+    M.json(
+      201,
+      types$.optional(operations.CreateCategoryResponse$inboundSchema),
+    ),
+    M.nil(
+      [400, 401, 403],
+      types$.optional(operations.CreateCategoryResponse$inboundSchema),
+    ),
+    M.fail(429),
     M.fail("5XX"),
   )(response, req);
   if (!result.ok) {

package/src/funcs/categories-delete.ts

@@ -89,7 +89,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/api/v1/categories/{id}")(pathParams);
 
   const headers = new Headers(compactMap({
@@ -142,7 +141,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["401", "403", "404", "4XX", "5XX"],
+    errorCodes: ["429", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -163,7 +162,8 @@ async function $do(
     | SDKValidationError
   >(
     M.nil(200, z.void()),
-    M.fail([401, 403, 404, "4XX"]),
+    M.nil([401, 403, 404], z.void()),
+    M.fail(429),
     M.fail("5XX"),
   )(response, req);
   if (!result.ok) {

package/src/funcs/categories-get-all.ts

@@ -22,6 +22,7 @@ import { SenseiProductivityError } from "../models/errors/sensei-productivity-er
 import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
+import * as types$ from "../types/primitives.js";
 
 /**
  * List all categories
@@ -31,7 +32,7 @@ export function categoriesGetAll(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    Array<operations.ListCategoriesResponse>,
+    Array<operations.ListCategoriesResponse> | undefined,
     | SenseiProductivityError
     | ResponseValidationError
     | ConnectionError
@@ -54,7 +55,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      Array<operations.ListCategoriesResponse>,
+      Array<operations.ListCategoriesResponse> | undefined,
       | SenseiProductivityError
       | ResponseValidationError
       | ConnectionError
@@ -118,7 +119,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["401", "4XX", "5XX"],
+    errorCodes: ["429", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -128,7 +129,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    Array<operations.ListCategoriesResponse>,
+    Array<operations.ListCategoriesResponse> | undefined,
     | SenseiProductivityError
     | ResponseValidationError
     | ConnectionError
@@ -138,8 +139,15 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, z.array(operations.ListCategoriesResponse$inboundSchema)),
-    M.fail([401, "4XX"]),
+    M.json(
+      200,
+      types$.optional(z.array(operations.ListCategoriesResponse$inboundSchema)),
+    ),
+    M.nil(
+      401,
+      types$.optional(z.array(operations.ListCategoriesResponse$inboundSchema)),
+    ),
+    M.fail(429),
     M.fail("5XX"),
   )(response, req);
   if (!result.ok) {

package/src/funcs/categories-update.ts

@@ -24,6 +24,7 @@ import { SenseiProductivityError } from "../models/errors/sensei-productivity-er
 import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
+import * as types$ from "../types/primitives.js";
 
 /**
  * Update a category (school admins only)
@@ -34,7 +35,7 @@ export function categoriesUpdate(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.UpdateCategoryResponse,
+    operations.UpdateCategoryResponse | undefined,
     | SenseiProductivityError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +60,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.UpdateCategoryResponse,
+      operations.UpdateCategoryResponse | undefined,
       | SenseiProductivityError
       | ResponseValidationError
       | ConnectionError
@@ -89,7 +90,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/api/v1/categories/{id}")(pathParams);
 
   const headers = new Headers(compactMap({
@@ -143,7 +143,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["400", "401", "403", "404", "4XX", "5XX"],
+    errorCodes: ["429", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -153,7 +153,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.UpdateCategoryResponse,
+    operations.UpdateCategoryResponse | undefined,
     | SenseiProductivityError
     | ResponseValidationError
     | ConnectionError
@@ -163,8 +163,15 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.UpdateCategoryResponse$inboundSchema),
-    M.fail([400, 401, 403, 404, "4XX"]),
+    M.json(
+      200,
+      types$.optional(operations.UpdateCategoryResponse$inboundSchema),
+    ),
+    M.nil(
+      [400, 401, 403, 404],
+      types$.optional(operations.UpdateCategoryResponse$inboundSchema),
+    ),
+    M.fail(429),
     M.fail("5XX"),
   )(response, req);
   if (!result.ok) {

package/src/funcs/schools-get-all.ts

@@ -118,7 +118,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["4XX", "5XX"],
+    errorCodes: ["429", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -139,7 +139,7 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, z.array(operations.ListSchoolsResponse$inboundSchema)),
-    M.fail("4XX"),
+    M.fail(429),
     M.fail("5XX"),
   )(response, req);
   if (!result.ok) {

package/src/funcs/schools-get.ts

@@ -24,6 +24,7 @@ import { SenseiProductivityError } from "../models/errors/sensei-productivity-er
 import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
+import * as types$ from "../types/primitives.js";
 
 /**
  * Get a school's details by ID
@@ -34,7 +35,7 @@ export function schoolsGet(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetSchoolByIdResponse,
+    operations.GetSchoolByIdResponse | undefined,
     | SenseiProductivityError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +60,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.GetSchoolByIdResponse,
+      operations.GetSchoolByIdResponse | undefined,
       | SenseiProductivityError
       | ResponseValidationError
       | ConnectionError
@@ -89,7 +90,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/api/v1/schools/{id}")(pathParams);
 
   const headers = new Headers(compactMap({
@@ -142,7 +142,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["404", "4XX", "5XX"],
+    errorCodes: ["429", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -152,7 +152,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.GetSchoolByIdResponse,
+    operations.GetSchoolByIdResponse | undefined,
     | SenseiProductivityError
     | ResponseValidationError
     | ConnectionError
@@ -162,8 +162,12 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetSchoolByIdResponse$inboundSchema),
-    M.fail([404, "4XX"]),
+    M.json(
+      200,
+      types$.optional(operations.GetSchoolByIdResponse$inboundSchema),
+    ),
+    M.nil(404, types$.optional(operations.GetSchoolByIdResponse$inboundSchema)),
+    M.fail(429),
     M.fail("5XX"),
   )(response, req);
   if (!result.ok) {

package/src/funcs/schools-leaderboard.ts

@@ -0,0 +1,184 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { SenseiProductivityCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/http-client-errors.js";
+import { ResponseValidationError } from "../models/errors/response-validation-error.js";
+import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import { SenseiProductivityError } from "../models/errors/sensei-productivity-error.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+import * as types$ from "../types/primitives.js";
+
+/**
+ * Get the top 10 schools (by points) in order
+ */
+export function schoolsLeaderboard(
+  client: SenseiProductivityCore,
+  request?: operations.GetTopSchoolsRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    Array<operations.GetTopSchoolsResponse> | undefined,
+    | SenseiProductivityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SenseiProductivityCore,
+  request?: operations.GetTopSchoolsRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      Array<operations.GetTopSchoolsResponse> | undefined,
+      | SenseiProductivityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(
+        z.optional(operations.GetTopSchoolsRequest$outboundSchema),
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/api/v1/schools/leaderboard")();
+
+  const query = encodeFormQuery({
+    "limit": payload?.limit,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getTopSchools",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 1000,
+          maxInterval: 60000,
+          exponent: 1.3,
+          maxElapsedTime: 3600000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["429", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    Array<operations.GetTopSchoolsResponse> | undefined,
+    | SenseiProductivityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      types$.optional(z.array(operations.GetTopSchoolsResponse$inboundSchema)),
+    ),
+    M.nil(
+      401,
+      types$.optional(z.array(operations.GetTopSchoolsResponse$inboundSchema)),
+    ),
+    M.fail(429),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/users-activities-create.ts

@@ -24,6 +24,7 @@ import { SenseiProductivityError } from "../models/errors/sensei-productivity-er
 import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
+import * as types$ from "../types/primitives.js";
 
 /**
  * Create a new activity
@@ -34,7 +35,7 @@ export function usersActivitiesCreate(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.CreateActivityResponse,
+    operations.CreateActivityResponse | undefined,
     | SenseiProductivityError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +60,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.CreateActivityResponse,
+      operations.CreateActivityResponse | undefined,
       | SenseiProductivityError
       | ResponseValidationError
       | ConnectionError
@@ -136,7 +137,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["400", "401", "4XX", "5XX"],
+    errorCodes: ["429", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -146,7 +147,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.CreateActivityResponse,
+    operations.CreateActivityResponse | undefined,
     | SenseiProductivityError
     | ResponseValidationError
     | ConnectionError
@@ -156,8 +157,15 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(201, operations.CreateActivityResponse$inboundSchema),
-    M.fail([400, 401, "4XX"]),
+    M.json(
+      201,
+      types$.optional(operations.CreateActivityResponse$inboundSchema),
+    ),
+    M.nil(
+      [400, 401],
+      types$.optional(operations.CreateActivityResponse$inboundSchema),
+    ),
+    M.fail(429),
     M.fail("5XX"),
   )(response, req);
   if (!result.ok) {

package/src/funcs/users-activities-delete.ts

@@ -89,7 +89,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/api/v1/activities/{id}")(pathParams);
 
   const headers = new Headers(compactMap({
@@ -142,7 +141,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["401", "403", "404", "4XX", "5XX"],
+    errorCodes: ["429", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -163,7 +162,8 @@ async function $do(
     | SDKValidationError
   >(
     M.nil(200, z.void()),
-    M.fail([401, 403, 404, "4XX"]),
+    M.nil([401, 403, 404], z.void()),
+    M.fail(429),
     M.fail("5XX"),
   )(response, req);
   if (!result.ok) {

package/src/funcs/users-activities-get-all-of-user.ts

@@ -24,6 +24,7 @@ import { SenseiProductivityError } from "../models/errors/sensei-productivity-er
 import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
+import * as types$ from "../types/primitives.js";
 
 /**
  * Get another user's activities (respects privacy)
@@ -34,7 +35,7 @@ export function usersActivitiesGetAllOfUser(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    Array<operations.GetUserActivitiesResponse>,
+    Array<operations.GetUserActivitiesResponse> | undefined,
     | SenseiProductivityError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +60,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      Array<operations.GetUserActivitiesResponse>,
+      Array<operations.GetUserActivitiesResponse> | undefined,
       | SenseiProductivityError
       | ResponseValidationError
       | ConnectionError
@@ -90,7 +91,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/api/v1/users/{id}/activities")(pathParams);
 
   const query = encodeFormQuery({
@@ -148,7 +148,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["401", "403", "404", "4XX", "5XX"],
+    errorCodes: ["429", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -158,7 +158,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    Array<operations.GetUserActivitiesResponse>,
+    Array<operations.GetUserActivitiesResponse> | undefined,
     | SenseiProductivityError
     | ResponseValidationError
     | ConnectionError
@@ -168,8 +168,19 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, z.array(operations.GetUserActivitiesResponse$inboundSchema)),
-    M.fail([401, 403, 404, "4XX"]),
+    M.json(
+      200,
+      types$.optional(
+        z.array(operations.GetUserActivitiesResponse$inboundSchema),
+      ),
+    ),
+    M.nil(
+      [401, 403, 404],
+      types$.optional(
+        z.array(operations.GetUserActivitiesResponse$inboundSchema),
+      ),
+    ),
+    M.fail(429),
     M.fail("5XX"),
   )(response, req);
   if (!result.ok) {