@workos-inc/node 7.40.1 → 7.41.0

package/lib/actions/actions.spec.js

@@ -118,6 +118,7 @@ describe('Actions', () => {
                     domains: [],
                     createdAt: '2024-10-22T17:12:50.746Z',
                     updatedAt: '2024-10-22T17:12:50.746Z',
+                    externalId: null,
                 },
                 organizationMembership: {
                     object: 'organization_membership',

package/lib/organizations/interfaces/create-organization-options.interface.d.ts

@@ -3,6 +3,7 @@ import { DomainData } from './domain-data.interface';
 export interface CreateOrganizationOptions {
     name: string;
     domainData?: DomainData[];
+    externalId?: string | null;
     /**
      * @deprecated If you need to allow sign-ins from any email domain, contact support@workos.com.
      */
@@ -15,6 +16,7 @@ export interface CreateOrganizationOptions {
 export interface SerializedCreateOrganizationOptions {
     name: string;
     domain_data?: DomainData[];
+    external_id?: string | null;
     /**
      * @deprecated If you need to allow sign-ins from any email domain, contact support@workos.com.
      */

package/lib/organizations/interfaces/organization.interface.d.ts

@@ -8,6 +8,7 @@ export interface Organization {
     stripeCustomerId?: string;
     createdAt: string;
     updatedAt: string;
+    externalId: string | null;
 }
 export interface OrganizationResponse {
     object: 'organization';
@@ -18,4 +19,5 @@ export interface OrganizationResponse {
     stripe_customer_id?: string;
     created_at: string;
     updated_at: string;
+    external_id?: string | null;
 }

package/lib/organizations/interfaces/update-organization-options.interface.d.ts

@@ -4,6 +4,7 @@ export interface UpdateOrganizationOptions {
     name?: string;
     domainData?: DomainData[];
     stripeCustomerId?: string | null;
+    externalId?: string | null;
     /**
      * @deprecated If you need to allow sign-ins from any email domain, contact support@workos.com.
      */
@@ -17,6 +18,7 @@ export interface SerializedUpdateOrganizationOptions {
     name?: string;
     domain_data?: DomainData[];
     stripe_customer_id?: string | null;
+    external_id?: string | null;
     /**
      * @deprecated If you need to allow sign-ins from any email domain, contact support@workos.com.
      */

package/lib/organizations/organizations.d.ts

@@ -10,6 +10,7 @@ export declare class Organizations {
     createOrganization(payload: CreateOrganizationOptions, requestOptions?: CreateOrganizationRequestOptions): Promise<Organization>;
     deleteOrganization(id: string): Promise<void>;
     getOrganization(id: string): Promise<Organization>;
+    getOrganizationByExternalId(externalId: string): Promise<Organization>;
     updateOrganization(options: UpdateOrganizationOptions): Promise<Organization>;
     listOrganizationRoles(options: ListOrganizationRolesOptions): Promise<RoleList>;
 }

package/lib/organizations/organizations.js

@@ -51,6 +51,12 @@ class Organizations {
             return (0, serializers_1.deserializeOrganization)(data);
         });
     }
+    getOrganizationByExternalId(externalId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.get(`/organizations/external_id/${externalId}`);
+            return (0, serializers_1.deserializeOrganization)(data);
+        });
+    }
     updateOrganization(options) {
         return __awaiter(this, void 0, void 0, function* () {
             const { organization: organizationId } = options, payload = __rest(options, ["organization"]);

package/lib/organizations/organizations.spec.js

@@ -194,6 +194,19 @@ describe('Organizations', () => {
             ]);
         }));
     });
+    describe('getOrganizationByExternalId', () => {
+        it('sends request', () => __awaiter(void 0, void 0, void 0, function* () {
+            const externalId = 'user_external_id';
+            const apiResponse = Object.assign(Object.assign({}, get_organization_json_1.default), { external_id: externalId });
+            (0, test_utils_1.fetchOnce)(apiResponse);
+            const organization = yield workos.organizations.getOrganizationByExternalId(externalId);
+            expect((0, test_utils_1.fetchURL)()).toContain(`/organizations/external_id/${externalId}`);
+            expect(organization).toMatchObject({
+                id: apiResponse.id,
+                externalId: apiResponse.external_id,
+            });
+        }));
+    });
     describe('deleteOrganization', () => {
         it('sends request to delete an Organization', () => __awaiter(void 0, void 0, void 0, function* () {
             (0, test_utils_1.fetchOnce)();

package/lib/organizations/serializers/create-organization-options.serializer.js

@@ -6,5 +6,6 @@ const serializeCreateOrganizationOptions = (options) => ({
     allow_profiles_outside_organization: options.allowProfilesOutsideOrganization,
     domain_data: options.domainData,
     domains: options.domains,
+    external_id: options.externalId,
 });
 exports.serializeCreateOrganizationOptions = serializeCreateOrganizationOptions;

package/lib/organizations/serializers/organization.serializer.js

@@ -2,7 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deserializeOrganization = void 0;
 const organization_domain_serializer_1 = require("../../organization-domains/serializers/organization-domain.serializer");
-const deserializeOrganization = (organization) => (Object.assign(Object.assign({ object: organization.object, id: organization.id, name: organization.name, allowProfilesOutsideOrganization: organization.allow_profiles_outside_organization, domains: organization.domains.map(organization_domain_serializer_1.deserializeOrganizationDomain) }, (typeof organization.stripe_customer_id === 'undefined'
-    ? undefined
-    : { stripeCustomerId: organization.stripe_customer_id })), { createdAt: organization.created_at, updatedAt: organization.updated_at }));
+const deserializeOrganization = (organization) => {
+    var _a;
+    return (Object.assign(Object.assign({ object: organization.object, id: organization.id, name: organization.name, allowProfilesOutsideOrganization: organization.allow_profiles_outside_organization, domains: organization.domains.map(organization_domain_serializer_1.deserializeOrganizationDomain) }, (typeof organization.stripe_customer_id === 'undefined'
+        ? undefined
+        : { stripeCustomerId: organization.stripe_customer_id })), { createdAt: organization.created_at, updatedAt: organization.updated_at, externalId: (_a = organization.external_id) !== null && _a !== void 0 ? _a : null }));
+};
 exports.deserializeOrganization = deserializeOrganization;

package/lib/organizations/serializers/update-organization-options.serializer.js

@@ -7,5 +7,6 @@ const serializeUpdateOrganizationOptions = (options) => ({
     domain_data: options.domainData,
     domains: options.domains,
     stripe_customer_id: options.stripeCustomerId,
+    external_id: options.externalId,
 });
 exports.serializeUpdateOrganizationOptions = serializeUpdateOrganizationOptions;

package/lib/workos.js

@@ -29,7 +29,7 @@ const subtle_crypto_provider_1 = require("./common/crypto/subtle-crypto-provider
 const fetch_client_1 = require("./common/net/fetch-client");
 const widgets_1 = require("./widgets/widgets");
 const actions_1 = require("./actions/actions");
-const VERSION = '7.40.1';
+const VERSION = '7.41.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 const HEADER_AUTHORIZATION = 'Authorization';
 const HEADER_IDEMPOTENCY_KEY = 'Idempotency-Key';

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.40.1",
+  "version": "7.41.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -73,4 +73,3 @@
     }
   }
 }
-