Update Management SDK to OpenAPI 3.1.0

.changeset/modern-pears-manage.md

@@ -0,0 +1,5 @@
+---
+"@reflag/management-sdk": minor
+---
+
+Update the generated client to Management API 3.1.0. Add user and company upsert/delete methods, and expose flag-state versions from flag mutations.

packages/management-sdk/README.md

@@ -40,6 +40,7 @@ Core method groups:
 - Applications: `listApps`, `getApp`
 - Environments: `listEnvironments`, `getEnvironment`
 - Flags: `listFlags`, `createFlag`, `updateFlag`
+- User/company management: `upsertUser`, `deleteUser`, `upsertCompany`, `deleteCompany`
 - User/company evaluation: `getUserFlags`, `updateUserFlags`, `getCompanyFlags`, `updateCompanyFlags`
 
 ## Quick start
@@ -127,7 +128,8 @@ console.log(flags.data);
 
 ### Create and update a flag
 
-`createFlag` and `updateFlag` return `{ flag }` with the latest flag details.
+`createFlag` and `updateFlag` return the latest flag details together with
+`flagStateVersions`, keyed by environment ID.
 
 Use `null` to clear nullable fields like `description` or `ownerUserId` on update.
 
@@ -170,6 +172,41 @@ console.log(updated.flag);
 // }
 ```
 
+### Create, update, and delete entities
+
+Use the entity management methods to synchronously manage users and companies in
+an environment. Entity attributes are merged with existing attributes.
+
+```typescript
+const company = await api.upsertCompany({
+  appId: "app-123",
+  envId: "env-456",
+  companyId: "company-1",
+  name: "Acme, Inc.",
+  attributes: { plan: "enterprise", seats: 50 },
+});
+
+const user = await api.upsertUser({
+  appId: "app-123",
+  envId: "env-456",
+  userId: "user-1",
+  name: "Jane Doe",
+  attributes: { role: "admin" },
+});
+
+await api.deleteUser({
+  appId: "app-123",
+  envId: "env-456",
+  userId: user.id,
+});
+await api.deleteCompany({
+  appId: "app-123",
+  envId: "env-456",
+  companyId: company.id,
+  deleteUsers: false,
+});
+```
+
 ### Read user flags for an environment
 
 `getUserFlags` evaluates flag results for one user in one environment and returns
@@ -293,6 +330,41 @@ console.log(updatedCompanyFlags.data);
 // ]
 ```
 
+## Waiting for flag changes to reach an SDK
+
+Flag changes can take a few seconds to propagate to evaluation SDKs.
+`updateUserFlags` and `updateCompanyFlags` return a `flagStateVersion` identifying
+the environment version containing the completed change. `createFlag` and
+`updateFlag` return `flagStateVersions`, keyed by environment ID.
+
+With `@reflag/node-sdk`, pass this number to `client.refreshFlags(version)` before
+evaluating flags to request that version or newer, rather than waiting for the
+next automatic refresh. Use a client configured for the same app and environment.
+
+```typescript
+// Server-side: `api` is the Management SDK client and `client` is an
+// initialized @reflag/node-sdk ReflagClient.
+const { flagStateVersion } = await api.updateCompanyFlags({
+  appId: "app-123",
+  envId: "env-456",
+  companyId: "company-1",
+  updates: [{ flagKey: "new-checkout", specificTargetValue: true }],
+});
+
+await client.refreshFlags(flagStateVersion);
+const flag = client.getFlag("new-checkout", {
+  user: { id: "user-1" },
+  company: { id: "company-1" },
+});
+```
+
+For `createFlag` or `updateFlag`, pass `result.flagStateVersions[envId]` instead.
+The version is a minimum: a successful refresh may receive a newer version that
+also includes subsequent changes.
+
+If the refresh fails, the Node SDK keeps its cached or fallback flags rather than
+throwing, so awaiting the call does not guarantee synchronization on failure.
+
 ## Error handling
 
 The SDK throws `ReflagApiError` for non-2xx API responses.

packages/management-sdk/src/generated/.openapi-generator/FILES

@@ -8,6 +8,7 @@ models/AppHeaderCollection.ts
 models/CreateFlag200Response.ts
 models/CreateFlag200ResponseFlag.ts
 models/CreateFlagRequest.ts
+models/DeleteCompanyRequest.ts
 models/EntityFlag.ts
 models/EntityFlagUpdate.ts
 models/EntityFlagsResponse.ts
@@ -26,11 +27,18 @@ models/FlagValue.ts
 models/FlagValueTargeting.ts
 models/OrgHeader.ts
 models/ReflagUserHeader.ts
+models/Schema0.ts
+models/Schema1.ts
 models/SegmentHeader.ts
 models/SegmentType.ts
 models/SortOrder.ts
 models/StageHeader.ts
 models/UpdateEntityFlagsBody.ts
+models/UpdateEntityFlagsResponse.ts
 models/UpdateFlagRequest.ts
+models/UpsertCompany200Response.ts
+models/UpsertCompanyRequest.ts
+models/UpsertUser200Response.ts
+models/UpsertUserRequest.ts
 models/index.ts
 runtime.ts

packages/management-sdk/src/generated/models/App.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/AppHeader.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/AppHeaderCollection.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/CreateFlag200Response.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -31,13 +31,19 @@ export interface CreateFlag200Response {
      * @type {CreateFlag200ResponseFlag}
      */
     flag: CreateFlag200ResponseFlag;
+    /**
+     * Current flag-state version keyed by environment ID
+     * @type {{ [key: string]: number; }}
+     */
+    flagStateVersions: { [key: string]: number; };
 }
 
 /**
  * Check if a given object implements the CreateFlag200Response interface.
  */
 export function instanceOfCreateFlag200Response(value: object): value is CreateFlag200Response {
     if (!('flag' in value) || value['flag'] === undefined) return false;
+    if (!('flagStateVersions' in value) || value['flagStateVersions'] === undefined) return false;
     return true;
 }
 
@@ -52,6 +58,7 @@ export function CreateFlag200ResponseFromJSONTyped(json: any, ignoreDiscriminato
     return {
 
         'flag': CreateFlag200ResponseFlagFromJSON(json['flag']),
+        'flagStateVersions': json['flagStateVersions'],
     };
 }
 
@@ -67,6 +74,7 @@ export function CreateFlag200ResponseToJSONTyped(value?: CreateFlag200Response |
     return {
 
         'flag': CreateFlag200ResponseFlagToJSON(value['flag']),
+        'flagStateVersions': value['flagStateVersions'],
     };
 }
 

packages/management-sdk/src/generated/models/CreateFlag200ResponseFlag.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/CreateFlagRequest.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/DeleteCompanyRequest.ts

@@ -0,0 +1,63 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Reflag Management API
+ * Feature flag Management API
+ *
+ * The version of the OpenAPI document: 3.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @interface DeleteCompanyRequest
+ */
+export interface DeleteCompanyRequest {
+    /**
+     * 
+     * @type {boolean}
+     */
+    deleteUsers?: boolean;
+}
+
+/**
+ * Check if a given object implements the DeleteCompanyRequest interface.
+ */
+export function instanceOfDeleteCompanyRequest(value: object): value is DeleteCompanyRequest {
+    return true;
+}
+
+export function DeleteCompanyRequestFromJSON(json: any): DeleteCompanyRequest {
+    return DeleteCompanyRequestFromJSONTyped(json, false);
+}
+
+export function DeleteCompanyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteCompanyRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'deleteUsers': json['deleteUsers'] == null ? undefined : json['deleteUsers'],
+    };
+}
+
+export function DeleteCompanyRequestToJSON(json: any): DeleteCompanyRequest {
+    return DeleteCompanyRequestToJSONTyped(json, false);
+}
+
+export function DeleteCompanyRequestToJSONTyped(value?: DeleteCompanyRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'deleteUsers': value['deleteUsers'],
+    };
+}
+

packages/management-sdk/src/generated/models/EntityFlag.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/EntityFlagUpdate.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/EntityFlagsResponse.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/Environment.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/EnvironmentHeader.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/EnvironmentHeaderCollection.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/EnvironmentHeaderSortByColumn.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/EnvironmentSdkAccess.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/ErrorResponse.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/ErrorResponseError.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/FlagHeader.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

packages/management-sdk/src/generated/models/FlagHeaderCollection.ts

@@ -4,7 +4,7 @@
  * Reflag Management API
  * Feature flag Management API
  *
- * The version of the OpenAPI document: 3.0.1
+ * The version of the OpenAPI document: 3.1.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).