Release organization metrics API (#310)

lib/b2b/client.ts

@@ -9,6 +9,7 @@ import { Organizations } from "./organizations";
 import { OTPs } from "./otp";
 import { Passwords } from "./passwords";
 import { PolicyCache } from "./rbac_local";
+import { Project } from "../b2c/project";
 import { RBAC } from "./rbac";
 import { RecoveryCodes } from "./recovery_codes";
 import { SCIM } from "./scim";
@@ -25,6 +26,7 @@ export class B2BClient extends BaseClient {
   otps: OTPs;
   organizations: Organizations;
   passwords: Passwords;
+  project: Project;
   rbac: RBAC;
   recoveryCodes: RecoveryCodes;
   scim: SCIM;
@@ -56,6 +58,7 @@ export class B2BClient extends BaseClient {
     this.otps = new OTPs(this.fetchConfig);
     this.organizations = new Organizations(this.fetchConfig);
     this.passwords = new Passwords(this.fetchConfig);
+    this.project = new Project(this.fetchConfig);
     this.rbac = new RBAC(this.fetchConfig);
     this.recoveryCodes = new RecoveryCodes(this.fetchConfig);
     this.scim = new SCIM(this.fetchConfig);

lib/b2b/index.ts

@@ -41,6 +41,8 @@ export type {
   B2BOrganizationsDeleteResponse,
   B2BOrganizationsGetRequest,
   B2BOrganizationsGetResponse,
+  B2BOrganizationsMetricsRequest,
+  B2BOrganizationsMetricsResponse,
   B2BOrganizationsSearchRequest,
   B2BOrganizationsSearchResponse,
   B2BOrganizationsUpdateRequest,

lib/b2b/organizations.ts

@@ -589,6 +589,16 @@ export interface B2BOrganizationsGetResponse {
   status_code: number;
 }
 
+export interface B2BOrganizationsMetricsRequest {
+  organization_id: string;
+}
+
+export interface B2BOrganizationsMetricsResponse {
+  request_id: string;
+  member_count: number;
+  status_code: number;
+}
+
 // Request type for `organizations.search`.
 export interface B2BOrganizationsSearchRequest {
   /**
@@ -1093,4 +1103,23 @@ export class Organizations {
       data,
     });
   }
+
+  /**
+   * @param params {@link B2BOrganizationsMetricsRequest}
+   * @returns {@link B2BOrganizationsMetricsResponse}
+   * @async
+   * @throws A {@link StytchError} on a non-2xx response from the Stytch API
+   * @throws A {@link RequestError} when the Stytch API cannot be reached
+   */
+  metrics(
+    params: B2BOrganizationsMetricsRequest
+  ): Promise<B2BOrganizationsMetricsResponse> {
+    const headers: Record<string, string> = {};
+    return request<B2BOrganizationsMetricsResponse>(this.fetchConfig, {
+      method: "GET",
+      url: `/v1/b2b/organizations/${params.organization_id}/metrics`,
+      headers,
+      params: {},
+    });
+  }
 }

lib/b2b/scim_connections.ts

@@ -23,7 +23,16 @@ export interface B2BSCIMConnectionsCreateRequest {
   organization_id: string;
   // A human-readable display name for the connection.
   display_name?: string;
-  identity_provider?: "unknown" | "okta" | "microsoft-entra" | string;
+  identity_provider?:
+    | "unknown"
+    | "okta"
+    | "microsoft-entra"
+    | "cyberark"
+    | "jumpcloud"
+    | "onelogin"
+    | "pingfederate"
+    | "rippling"
+    | string;
 }
 
 // Response type for `scim.connections.create`.

lib/b2c/client.ts

@@ -7,6 +7,7 @@ import { MagicLinks } from "./magic_links";
 import { OAuth } from "./oauth";
 import { OTPs } from "./otps";
 import { Passwords } from "./passwords";
+import { Project } from "./project";
 import { Sessions } from "./sessions";
 import { TOTPs } from "./totps";
 import { Users } from "./users";
@@ -20,6 +21,7 @@ export class Client extends BaseClient {
   oauth: OAuth;
   otps: OTPs;
   passwords: Passwords;
+  project: Project;
   sessions: Sessions;
   totps: TOTPs;
   users: Users;
@@ -46,6 +48,7 @@ export class Client extends BaseClient {
     this.oauth = new OAuth(this.fetchConfig);
     this.otps = new OTPs(this.fetchConfig);
     this.passwords = new Passwords(this.fetchConfig);
+    this.project = new Project(this.fetchConfig);
     this.sessions = new Sessions(this.fetchConfig, this.jwtConfig);
     this.totps = new TOTPs(this.fetchConfig);
     this.users = new Users(this.fetchConfig);

lib/b2c/index.ts

@@ -238,6 +238,8 @@ export type {
   OTPsEmailSendResponse,
 } from "./otps_email";
 
+export type { ProjectMetric, ProjectMetricsResponse } from "./project";
+
 export type {
   TOTPWithRecoveryCodes,
   TOTPsAuthenticateRequest,

lib/b2c/project.ts

@@ -0,0 +1,51 @@
+// !!!
+// WARNING: This file is autogenerated
+// Only modify code within MANUAL() sections
+// or your changes may be overwritten later!
+// !!!
+
+import {} from "../shared/method_options";
+import { fetchConfig } from "../shared";
+import { request } from "../shared";
+
+export interface ProjectMetric {
+  count: number;
+  metric_type?:
+    | "UNKNOWN"
+    | "USER_COUNT"
+    | "ORGANIZATION_COUNT"
+    | "MEMBER_COUNT"
+    | "M2M_CLIENT_COUNT"
+    | string;
+}
+
+export interface ProjectMetricsResponse {
+  request_id: string;
+  project_id: string;
+  metrics: ProjectMetric[];
+  status_code: number;
+}
+
+export class Project {
+  private fetchConfig: fetchConfig;
+
+  constructor(fetchConfig: fetchConfig) {
+    this.fetchConfig = fetchConfig;
+  }
+
+  /**
+   * @param params {@link ProjectMetricsRequest}
+   * @returns {@link ProjectMetricsResponse}
+   * @async
+   * @throws A {@link StytchError} on a non-2xx response from the Stytch API
+   * @throws A {@link RequestError} when the Stytch API cannot be reached
+   */
+  metrics(): Promise<ProjectMetricsResponse> {
+    const headers: Record<string, string> = {};
+    return request<ProjectMetricsResponse>(this.fetchConfig, {
+      method: "GET",
+      url: `/v1/projects/metrics`,
+      headers,
+    });
+  }
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "stytch",
-  "version": "10.12.0",
+  "version": "10.13.0",
   "description": "A wrapper for the Stytch API",
   "types": "./types/lib/index.d.ts",
   "main": "./dist/index.js",