fix!: rename portal to adminPortal

src/admin-portal/admin-portal.ts

@@ -0,0 +1,33 @@
+// 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 {Promise<PortalLinkResponse>}
+   * @throws {BadRequestException} 400
+   * @throws {AuthorizationException} 403
+   * @throws {NotFoundException} 404
+   * @throws {UnprocessableEntityException} 422
+   */
+  async generateLink(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,13 @@
+{
+  "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"
+    }
+  },
+  "admin_emails": ["admin@example.com"]
+}

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,41 @@
+// 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;
+  /** The email addresses of the IT admins to grant access to the Admin Portal for the given organization. Accepts up to 20 emails. */
+  adminEmails?: string[];
+}
+
+export interface GenerateLinkResponse {
+  return_url?: string;
+  success_url?: string;
+  organization: string;
+  intent?: GenerateLinkIntent;
+  intent_options?: IntentOptionsResponse;
+  admin_emails?: string[];
+}

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.spec.ts

@@ -0,0 +1,62 @@
+// This file is auto-generated by oagen. Do not edit.
+
+import {
+  deserializeSSOIntentOptions,
+  serializeSSOIntentOptions,
+} from './serializers/sso-intent-options.serializer';
+import {
+  deserializeIntentOptions,
+  serializeIntentOptions,
+} from './serializers/intent-options.serializer';
+import {
+  deserializeGenerateLink,
+  serializeGenerateLink,
+} from './serializers/generate-link.serializer';
+import {
+  deserializePortalLinkResponse,
+  serializePortalLinkResponse,
+} from './serializers/portal-link-response.serializer';
+import type { SSOIntentOptionsResponse } from './interfaces/sso-intent-options.interface';
+import type { IntentOptionsResponse } from './interfaces/intent-options.interface';
+import type { GenerateLinkResponse } from './interfaces/generate-link.interface';
+import type { PortalLinkResponseWire } from './interfaces/portal-link-response.interface';
+import sSOIntentOptionsFixture from './fixtures/sso-intent-options.fixture.json';
+import intentOptionsFixture from './fixtures/intent-options.fixture.json';
+import generateLinkFixture from './fixtures/generate-link.fixture.json';
+import portalLinkResponseFixture from './fixtures/portal-link-response.fixture.json';
+
+describe('SSOIntentOptionsSerializer', () => {
+  it('round-trips through serialize/deserialize', () => {
+    const fixture = sSOIntentOptionsFixture as SSOIntentOptionsResponse;
+    const deserialized = deserializeSSOIntentOptions(fixture);
+    const reserialized = serializeSSOIntentOptions(deserialized);
+    expect(reserialized).toEqual(expect.objectContaining(fixture));
+  });
+});
+
+describe('IntentOptionsSerializer', () => {
+  it('round-trips through serialize/deserialize', () => {
+    const fixture = intentOptionsFixture as IntentOptionsResponse;
+    const deserialized = deserializeIntentOptions(fixture);
+    const reserialized = serializeIntentOptions(deserialized);
+    expect(reserialized).toEqual(expect.objectContaining(fixture));
+  });
+});
+
+describe('GenerateLinkSerializer', () => {
+  it('round-trips through serialize/deserialize', () => {
+    const fixture = generateLinkFixture as GenerateLinkResponse;
+    const deserialized = deserializeGenerateLink(fixture);
+    const reserialized = serializeGenerateLink(deserialized);
+    expect(reserialized).toEqual(expect.objectContaining(fixture));
+  });
+});
+
+describe('PortalLinkResponseSerializer', () => {
+  it('round-trips through serialize/deserialize', () => {
+    const fixture = portalLinkResponseFixture as PortalLinkResponseWire;
+    const deserialized = deserializePortalLinkResponse(fixture);
+    const reserialized = serializePortalLinkResponse(deserialized);
+    expect(reserialized).toEqual(expect.objectContaining(fixture));
+  });
+});

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

@@ -0,0 +1,38 @@
+// 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,
+  adminEmails: response.admin_emails,
+});
+
+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,
+  admin_emails: model.adminEmails,
+});

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/common/interfaces/generate-link-intent.interface.ts

@@ -0,0 +1,10 @@
+// This file is auto-generated by oagen. Do not edit.
+
+export type GenerateLinkIntent =
+  | 'sso'
+  | 'dsync'
+  | 'audit_logs'
+  | 'log_streams'
+  | 'domain_verification'
+  | 'certificate_renewal'
+  | 'bring_your_own_key';

src/index.ts

@@ -1,3 +1,5 @@
+// This file is auto-generated by oagen. Do not edit.
+
 import { SubtleCryptoProvider } from './common/crypto/subtle-crypto-provider';
 import { CryptoProvider } from './common/crypto/crypto-provider';
 
@@ -23,7 +25,7 @@ export { FeatureFlagsRuntimeClient } from './feature-flags/runtime-client';
 export * from './organizations/interfaces';
 export * from './organization-domains/interfaces';
 export * from './passwordless/interfaces';
-export * from './portal/interfaces';
+export * from './admin-portal/interfaces';
 export * from './roles/interfaces';
 export * from './sso/interfaces';
 export * from './user-management/interfaces';

src/index.worker.ts

@@ -18,7 +18,7 @@ export * from './events/interfaces';
 export * from './organizations/interfaces';
 export * from './organization-domains/interfaces';
 export * from './passwordless/interfaces';
-export * from './portal/interfaces';
+export * from './admin-portal/interfaces';
 export * from './sso/interfaces';
 export * from './user-management/interfaces';
 export * from './roles/interfaces';