feat(oagen[1/2]): Add new endpoints to the SDK via autogeneration

src/admin-portal/admin-portal.spec.ts

@@ -0,0 +1,46 @@
+// This file is auto-generated by oagen. Do not edit.
+
+import fetch from 'jest-fetch-mock';
+import {
+  fetchOnce,
+  fetchURL,
+  fetchMethod,
+  fetchBody,
+  testUnauthorized,
+} from '../common/utils/test-utils';
+import { WorkOS } from '../workos';
+
+import portalLinkResponseFixture from './fixtures/portal-link-response.fixture.json';
+
+const workos = new WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+
+describe('AdminPortal', () => {
+  beforeEach(() => fetch.resetMocks());
+
+  describe('generatePortalLink', () => {
+    it('sends the correct request and returns result', async () => {
+      fetchOnce(portalLinkResponseFixture);
+
+      const result = await workos.adminPortal.generatePortalLink({
+        organization: 'test_organization',
+      });
+
+      expect(fetchMethod()).toBe('POST');
+      expect(new URL(String(fetchURL())).pathname).toBe(
+        '/portal/generate_link',
+      );
+      expect(fetchBody()).toEqual(
+        expect.objectContaining({ organization: 'test_organization' }),
+      );
+      expect(result.link).toBe(
+        'https://setup.workos.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',
+      );
+    });
+
+    testUnauthorized(() =>
+      workos.adminPortal.generatePortalLink({
+        organization: 'test_organization',
+      }),
+    );
+  });
+});

src/admin-portal/admin-portal.ts

@@ -0,0 +1,32 @@
+// This file is auto-generated by oagen. Do not edit.
+
+import type { WorkOS } from '../workos';
+import type {
+  PortalLinkResponse,
+  PortalLinkResponseWire,
+} from './interfaces/portal-link-response.interface';
+import type { GenerateLink } from './interfaces/generate-link.interface';
+import { deserializePortalLinkResponse } from './serializers/portal-link-response.serializer';
+import { serializeGenerateLink } from './serializers/generate-link.serializer';
+
+export class AdminPortal {
+  constructor(private readonly workos: WorkOS) {}
+
+  /**
+   * Generate a Portal Link
+   *
+   * Generate a Portal Link scoped to an Organization.
+   * @param payload - Object containing organization.
+   * @returns {PortalLinkResponse}
+   * @throws {BadRequestException} 400
+   * @throws {NotFoundException} 404
+   * @throws {UnprocessableEntityException} 422
+   */
+  async generatePortalLink(payload: GenerateLink): Promise<PortalLinkResponse> {
+    const { data } = await this.workos.post<PortalLinkResponseWire>(
+      '/portal/generate_link',
+      serializeGenerateLink(payload),
+    );
+    return deserializePortalLinkResponse(data);
+  }
+}

src/admin-portal/fixtures/generate-link.fixture.json

@@ -0,0 +1,12 @@
+{
+  "return_url": "https://example.com/admin-portal/return",
+  "success_url": "https://example.com/admin-portal/success",
+  "organization": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+  "intent": "sso",
+  "intent_options": {
+    "sso": {
+      "bookmark_slug": "chatgpt",
+      "provider_type": "GoogleSAML"
+    }
+  }
+}

src/admin-portal/fixtures/intent-options.fixture.json

@@ -0,0 +1,6 @@
+{
+  "sso": {
+    "bookmark_slug": "chatgpt",
+    "provider_type": "GoogleSAML"
+  }
+}

src/admin-portal/fixtures/portal-link-response.fixture.json

@@ -0,0 +1,3 @@
+{
+  "link": "https://setup.workos.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+}

src/admin-portal/fixtures/sso-intent-options.fixture.json

@@ -0,0 +1,4 @@
+{
+  "bookmark_slug": "chatgpt",
+  "provider_type": "GoogleSAML"
+}

src/admin-portal/interfaces/generate-link.interface.ts

@@ -0,0 +1,38 @@
+// This file is auto-generated by oagen. Do not edit.
+
+import type {
+  IntentOptions,
+  IntentOptionsResponse,
+} from './intent-options.interface';
+import type { GenerateLinkIntent } from '../../common/interfaces/generate-link-intent.interface';
+
+export interface GenerateLink {
+  /** The URL to go to when an admin clicks on your logo in the Admin Portal. If not specified, the return URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used. */
+  returnUrl?: string;
+  /** The URL to redirect the admin to when they finish setup. If not specified, the success URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used. */
+  successUrl?: string;
+  /** An [Organization](https://workos.com/docs/reference/organization) identifier. */
+  organization: string;
+  /**
+   *
+   *       The intent of the Admin Portal.
+   *         - `sso` - Launch Admin Portal for creating SSO connections
+   *         - `dsync` - Launch Admin Portal for creating Directory Sync connections
+   *         - `audit_logs` - Launch Admin Portal for viewing Audit Logs
+   *         - `log_streams` - Launch Admin Portal for creating Log Streams
+   *         - `domain_verification` - Launch Admin Portal for Domain Verification
+   *         - `certificate_renewal` - Launch Admin Portal for renewing SAML Certificates
+   *         - `bring_your_own_key` - Launch Admin Portal for configuring Bring Your Own Key
+   */
+  intent?: GenerateLinkIntent;
+  /** Options to configure the Admin Portal based on the intent. */
+  intentOptions?: IntentOptions;
+}
+
+export interface GenerateLinkResponse {
+  return_url?: string;
+  success_url?: string;
+  organization: string;
+  intent?: GenerateLinkIntent;
+  intent_options?: IntentOptionsResponse;
+}

src/admin-portal/interfaces/index.ts

@@ -0,0 +1,6 @@
+// This file is auto-generated by oagen. Do not edit.
+
+export * from './generate-link.interface';
+export * from './intent-options.interface';
+export * from './portal-link-response.interface';
+export * from './sso-intent-options.interface';

src/admin-portal/interfaces/intent-options.interface.ts

@@ -0,0 +1,15 @@
+// This file is auto-generated by oagen. Do not edit.
+
+import type {
+  SSOIntentOptions,
+  SSOIntentOptionsResponse,
+} from './sso-intent-options.interface';
+
+export interface IntentOptions {
+  /** SSO-specific options for the Admin Portal. */
+  sso: SSOIntentOptions;
+}
+
+export interface IntentOptionsResponse {
+  sso: SSOIntentOptionsResponse;
+}

src/admin-portal/interfaces/portal-link-response.interface.ts

@@ -0,0 +1,10 @@
+// This file is auto-generated by oagen. Do not edit.
+
+export interface PortalLinkResponse {
+  /** An ephemeral link to initiate the Admin Portal. */
+  link: string;
+}
+
+export interface PortalLinkResponseWire {
+  link: string;
+}

src/admin-portal/interfaces/sso-intent-options.interface.ts

@@ -0,0 +1,13 @@
+// This file is auto-generated by oagen. Do not edit.
+
+export interface SSOIntentOptions {
+  /** The bookmark slug to use for SSO. */
+  bookmarkSlug?: string;
+  /** The SSO provider type to configure. */
+  providerType?: 'GoogleSAML';
+}
+
+export interface SSOIntentOptionsResponse {
+  bookmark_slug?: string;
+  provider_type?: 'GoogleSAML';
+}

src/admin-portal/serializers/generate-link.serializer.ts

@@ -0,0 +1,36 @@
+// This file is auto-generated by oagen. Do not edit.
+
+import type {
+  GenerateLink,
+  GenerateLinkResponse,
+} from '../interfaces/generate-link.interface';
+import {
+  deserializeIntentOptions,
+  serializeIntentOptions,
+} from './intent-options.serializer';
+
+export const deserializeGenerateLink = (
+  response: GenerateLinkResponse,
+): GenerateLink => ({
+  returnUrl: response.return_url,
+  successUrl: response.success_url,
+  organization: response.organization,
+  intent: response.intent,
+  intentOptions:
+    response.intent_options != null
+      ? deserializeIntentOptions(response.intent_options)
+      : undefined,
+});
+
+export const serializeGenerateLink = (
+  model: GenerateLink,
+): GenerateLinkResponse => ({
+  return_url: model.returnUrl,
+  success_url: model.successUrl,
+  organization: model.organization,
+  intent: model.intent,
+  intent_options:
+    model.intentOptions != null
+      ? serializeIntentOptions(model.intentOptions)
+      : undefined,
+});

src/admin-portal/serializers/intent-options.serializer.ts

@@ -0,0 +1,22 @@
+// This file is auto-generated by oagen. Do not edit.
+
+import type {
+  IntentOptions,
+  IntentOptionsResponse,
+} from '../interfaces/intent-options.interface';
+import {
+  deserializeSSOIntentOptions,
+  serializeSSOIntentOptions,
+} from './sso-intent-options.serializer';
+
+export const deserializeIntentOptions = (
+  response: IntentOptionsResponse,
+): IntentOptions => ({
+  sso: deserializeSSOIntentOptions(response.sso),
+});
+
+export const serializeIntentOptions = (
+  model: IntentOptions,
+): IntentOptionsResponse => ({
+  sso: serializeSSOIntentOptions(model.sso),
+});

src/admin-portal/serializers/portal-link-response.serializer.ts

@@ -0,0 +1,18 @@
+// This file is auto-generated by oagen. Do not edit.
+
+import type {
+  PortalLinkResponse,
+  PortalLinkResponseWire,
+} from '../interfaces/portal-link-response.interface';
+
+export const deserializePortalLinkResponse = (
+  response: PortalLinkResponseWire,
+): PortalLinkResponse => ({
+  link: response.link,
+});
+
+export const serializePortalLinkResponse = (
+  model: PortalLinkResponse,
+): PortalLinkResponseWire => ({
+  link: model.link,
+});

src/admin-portal/serializers/sso-intent-options.serializer.ts

@@ -0,0 +1,20 @@
+// This file is auto-generated by oagen. Do not edit.
+
+import type {
+  SSOIntentOptions,
+  SSOIntentOptionsResponse,
+} from '../interfaces/sso-intent-options.interface';
+
+export const deserializeSSOIntentOptions = (
+  response: SSOIntentOptionsResponse,
+): SSOIntentOptions => ({
+  bookmarkSlug: response.bookmark_slug,
+  providerType: response.provider_type,
+});
+
+export const serializeSSOIntentOptions = (
+  model: SSOIntentOptions,
+): SSOIntentOptionsResponse => ({
+  bookmark_slug: model.bookmarkSlug,
+  provider_type: model.providerType,
+});

src/authorization/authorization.ts

@@ -230,6 +230,7 @@ export class Authorization {
     );
   }
 
+  /** @deprecated Use `workos.permissions.create()` instead. */
   async createPermission(
     options: CreatePermissionOptions,
   ): Promise<Permission> {
@@ -240,6 +241,13 @@ export class Authorization {
     return deserializePermission(data);
   }
 
+  /**
+   * @deprecated Use `workos.permissions.list()` instead.  Note that the new
+   * method returns an `AutoPaginatable<Permission>` (with auto-pagination
+   * support) rather than this method's plain `PermissionList`.  The shapes
+   * are largely compatible — `.data` and `.listMetadata` are both available
+   * — but explicit `PermissionList` type annotations won't transfer.
+   */
   async listPermissions(
     options?: ListPermissionsOptions,
   ): Promise<PermissionList> {
@@ -257,13 +265,15 @@ export class Authorization {
     };
   }
 
+  /** @deprecated Use `workos.permissions.find()` instead. */
   async getPermission(slug: string): Promise<Permission> {
     const { data } = await this.workos.get<PermissionResponse>(
       `/authorization/permissions/${slug}`,
     );
     return deserializePermission(data);
   }
 
+  /** @deprecated Use `workos.permissions.update()` instead. */
   async updatePermission(
     slug: string,
     options: UpdatePermissionOptions,
@@ -275,6 +285,7 @@ export class Authorization {
     return deserializePermission(data);
   }
 
+  /** @deprecated Use `workos.permissions.delete()` instead. */
   async deletePermission(slug: string): Promise<void> {
     await this.workos.delete(`/authorization/permissions/${slug}`);
   }

src/authorization/interfaces/update-organization-role.interface.ts

@@ -0,0 +1,13 @@
+// This file is auto-generated by oagen. Do not edit.
+
+export interface UpdateOrganizationRole {
+  /** A descriptive name for the role. */
+  name?: string;
+  /** An optional description of the role's purpose. */
+  description?: string | null;
+}
+
+export interface UpdateOrganizationRoleResponse {
+  name?: string;
+  description?: string | null;
+}

src/authorization/serializers/update-organization-role.serializer.ts

@@ -0,0 +1,20 @@
+// This file is auto-generated by oagen. Do not edit.
+
+import type {
+  UpdateOrganizationRole,
+  UpdateOrganizationRoleResponse,
+} from '../interfaces/update-organization-role.interface';
+
+export const deserializeUpdateOrganizationRole = (
+  response: UpdateOrganizationRoleResponse,
+): UpdateOrganizationRole => ({
+  name: response.name,
+  description: response.description ?? null,
+});
+
+export const serializeUpdateOrganizationRole = (
+  model: UpdateOrganizationRole,
+): UpdateOrganizationRoleResponse => ({
+  name: model.name,
+  description: model.description ?? null,
+});

src/common/fixtures/authentication-factor-totp-2.fixture.json

@@ -0,0 +1,4 @@
+{
+  "issuer": "WorkOS",
+  "user": "user@example.com"
+}

src/common/interfaces/authentication-factor-totp-2.interface.ts

@@ -0,0 +1,13 @@
+// This file is auto-generated by oagen. Do not edit.
+
+export interface AuthenticationFactorTotp2 {
+  /** Your application or company name displayed in the user's authenticator app. Defaults to your WorkOS team name. */
+  issuer: string;
+  /** The user's account name displayed in their authenticator app. Defaults to the user's email. */
+  user: string;
+}
+
+export interface AuthenticationFactorTotp2Response {
+  issuer: string;
+  user: string;
+}