@vindentech/api-client 0.3.0-next.12 → 0.3.0-next.14

package/dist/generated/index.schemas.d.ts

@@ -987,6 +987,83 @@ export interface UpdateOrganizationDto {
     preferredWarehouseId?: string;
     metadata?: UpdateOrganizationDtoMetadata;
 }
+export interface OrganizationMemberDto {
+    /** Keycloak subject of the member. Within one organization this identifies the membership — it is the `memberId` path segment on the member routes. */
+    sub: string;
+    organizationId: string;
+    /** Role the user holds in this organization. New memberships carry one of the organization roles; rows bootstrapped by `/v1/me` can carry any client role the token held. */
+    role: string;
+    /** When the membership was created (organization_member.created_at). */
+    joinedAt: string;
+    /**
+     * From the member's user_profile row — null until their first `/v1/me` call creates it (an invited user has no profile yet).
+     * @nullable
+     */
+    displayName: string | null;
+    /**
+     * From the member's user_profile row — null until their first `/v1/me` call creates it.
+     * @nullable
+     */
+    email: string | null;
+}
+export type AddMemberDtoRole = typeof AddMemberDtoRole[keyof typeof AddMemberDtoRole];
+export declare const AddMemberDtoRole: {
+    readonly 'org-admin': "org-admin";
+    readonly 'org-orders': "org-orders";
+    readonly 'org-billing': "org-billing";
+    readonly 'org-viewer': "org-viewer";
+    readonly owner: "owner";
+    readonly member: "member";
+};
+export interface AddMemberDto {
+    /** Keycloak subject of an EXISTING user to bind to this organization. Mutually exclusive with `email`. */
+    userSub?: string;
+    /** Email address to invite. An existing realm user with this address is bound; otherwise a disabled-until-activated user is created and emailed an invite link. Mutually exclusive with `userSub`. */
+    email?: string;
+    role: AddMemberDtoRole;
+}
+/**
+ * Outcome of the best-effort Keycloak push made after the database commit. `synced` — the Keycloak side was updated by this call. `failed` — the push was attempted and failed; the database change stands, and re-running the command re-attempts the push. `not_configured` — no push was attempted because no Keycloak sync client is provisioned for the tenant.
+ */
+export type OrganizationMemberSyncResultDtoKeycloakSyncStatus = typeof OrganizationMemberSyncResultDtoKeycloakSyncStatus[keyof typeof OrganizationMemberSyncResultDtoKeycloakSyncStatus];
+export declare const OrganizationMemberSyncResultDtoKeycloakSyncStatus: {
+    readonly synced: "synced";
+    readonly failed: "failed";
+    readonly not_configured: "not_configured";
+};
+export interface OrganizationMemberSyncResultDto {
+    /** Keycloak subject of the member. Within one organization this identifies the membership — it is the `memberId` path segment on the member routes. */
+    sub: string;
+    organizationId: string;
+    /** Role the user holds in this organization. New memberships carry one of the organization roles; rows bootstrapped by `/v1/me` can carry any client role the token held. */
+    role: string;
+    /** When the membership was created (organization_member.created_at). */
+    joinedAt: string;
+    /**
+     * From the member's user_profile row — null until their first `/v1/me` call creates it (an invited user has no profile yet).
+     * @nullable
+     */
+    displayName: string | null;
+    /**
+     * From the member's user_profile row — null until their first `/v1/me` call creates it.
+     * @nullable
+     */
+    email: string | null;
+    /** Outcome of the best-effort Keycloak push made after the database commit. `synced` — the Keycloak side was updated by this call. `failed` — the push was attempted and failed; the database change stands, and re-running the command re-attempts the push. `not_configured` — no push was attempted because no Keycloak sync client is provisioned for the tenant. */
+    keycloakSyncStatus: OrganizationMemberSyncResultDtoKeycloakSyncStatus;
+}
+export type UpdateMemberDtoRole = typeof UpdateMemberDtoRole[keyof typeof UpdateMemberDtoRole];
+export declare const UpdateMemberDtoRole: {
+    readonly 'org-admin': "org-admin";
+    readonly 'org-orders': "org-orders";
+    readonly 'org-billing': "org-billing";
+    readonly 'org-viewer': "org-viewer";
+    readonly owner: "owner";
+    readonly member: "member";
+};
+export interface UpdateMemberDto {
+    role?: UpdateMemberDtoRole;
+}
 export type OrganizationSettingDtoServiceType = typeof OrganizationSettingDtoServiceType[keyof typeof OrganizationSettingDtoServiceType];
 export declare const OrganizationSettingDtoServiceType: {
     readonly STORAGE: "STORAGE";
@@ -1380,6 +1457,13 @@ export interface AssignmentDto {
     role: string;
     active: boolean;
 }
+/**
+ * Opaque per-user preferences object (0079); null when unset.
+ * @nullable
+ */
+export type MeResponseDtoPreferences = {
+    [key: string]: unknown;
+} | null;
 export interface MeResponseDto {
     /** Keycloak subject identifier */
     sub: string;
@@ -1397,6 +1481,16 @@ export interface MeResponseDto {
     email: string | null;
     /** @nullable */
     displayName: string | null;
+    /**
+     * Self-editable contact number (0079).
+     * @nullable
+     */
+    phone: string | null;
+    /**
+     * Opaque per-user preferences object (0079); null when unset.
+     * @nullable
+     */
+    preferences: MeResponseDtoPreferences;
     memberships: MembershipDto[];
     /** Cross-cutting permissions (resource:action) from platform/tenant-wide/warehouse/carrier roles for the active context — drives client-side component visibility. Org-scoped permissions are on each membership. */
     capabilities: string[];
@@ -1410,8 +1504,31 @@ export interface MeResponseDto {
     /** Long-form staff assignments (own rows only) from employee_assignment — the authoritative warehouse/carrier reach behind the warehouseIds/carrierId summary. */
     assignments: AssignmentDto[];
 }
+/**
+ * Opaque per-user preferences object (JSON object, ≤ 16 KB serialized); null clears it.
+ * @nullable
+ */
+export type UpdateMeDtoPreferences = {
+    [key: string]: unknown;
+} | null;
 export interface UpdateMeDto {
-    displayName?: string;
+    /** @nullable */
+    displayName?: string | null;
+    /**
+     * Self-editable contact number; null clears it.
+     * @maxLength 50
+     * @nullable
+     */
+    phone?: string | null;
+    /**
+     * Opaque per-user preferences object (JSON object, ≤ 16 KB serialized); null clears it.
+     * @nullable
+     */
+    preferences?: UpdateMeDtoPreferences;
+}
+export interface UpdateIdentityNumberDto {
+    /** Swedish personal identity number — YYMMDDNNNN, YYMMDD-NNNN, YYMMDD+NNNN, YYYYMMDDNNNN or YYYYMMDD-NNNN, with a valid Luhn check digit. Stored digits-only. Never returned by any endpoint. */
+    personalIdentityNumber: string;
 }
 export interface AnonymousSessionDto {
     /** Opaque bearer token for the anonymous session. Send it as the X-Session-Token header on guest-capable endpoints. Shown once — it is stored only as a hash. */
@@ -6714,6 +6831,272 @@ export interface BillableEventsWebhookAckDto {
     /** Events rejected before enqueue, with a reason (e.g. unknown event_type). */
     skipped: BillableEventsWebhookAckDtoSkippedItem[];
 }
+export interface UserDirectoryEntryDto {
+    /** The user's Keycloak subject — the id every staffing and membership command takes. */
+    sub: string;
+    /**
+     * The user's display name; null until they set one on their profile.
+     * @nullable
+     */
+    displayName: string | null;
+    /** The user's email address. */
+    email: string;
+}
+export interface DeactivateUserDto {
+    /**
+     * Optional free-text reason, recorded on the admin_action audit row.
+     * @maxLength 2000
+     */
+    reason?: string;
+}
+/**
+ * Outcome of the best-effort Keycloak push made after the database commit. `synced` — the Keycloak side was updated by this call. `failed` — the push was attempted and failed; the database change stands, and re-running the command re-attempts the push. `not_configured` — no push was attempted because no Keycloak sync client is provisioned for the tenant.
+ */
+export type DeactivateUserResultDtoKeycloakSyncStatus = typeof DeactivateUserResultDtoKeycloakSyncStatus[keyof typeof DeactivateUserResultDtoKeycloakSyncStatus];
+export declare const DeactivateUserResultDtoKeycloakSyncStatus: {
+    readonly synced: "synced";
+    readonly failed: "failed";
+    readonly not_configured: "not_configured";
+};
+export interface DeactivateUserResultDto {
+    /** The deactivated user's Keycloak subject. */
+    sub: string;
+    /** When the account was tombstoned. */
+    deactivatedAt: string;
+    /** Outcome of the best-effort Keycloak push made after the database commit. `synced` — the Keycloak side was updated by this call. `failed` — the push was attempted and failed; the database change stands, and re-running the command re-attempts the push. `not_configured` — no push was attempted because no Keycloak sync client is provisioned for the tenant. */
+    keycloakSyncStatus: DeactivateUserResultDtoKeycloakSyncStatus;
+    /** True when this call replayed a prior deactivation (same Idempotency-Key, or an already-deactivated target) with no new mutation. */
+    idempotent: boolean;
+}
+export interface ForgetUserDto {
+    /**
+     * Required free-text reason for the erasure, recorded on the admin_action audit row.
+     * @maxLength 2000
+     */
+    reason: string;
+}
+/**
+ * Outcome of the best-effort Keycloak push made after the database commit. `synced` — the Keycloak side was updated by this call. `failed` — the push was attempted and failed; the database change stands, and re-running the command re-attempts the push. `not_configured` — no push was attempted because no Keycloak sync client is provisioned for the tenant.
+ */
+export type ForgetUserResultDtoKeycloakSyncStatus = typeof ForgetUserResultDtoKeycloakSyncStatus[keyof typeof ForgetUserResultDtoKeycloakSyncStatus];
+export declare const ForgetUserResultDtoKeycloakSyncStatus: {
+    readonly synced: "synced";
+    readonly failed: "failed";
+    readonly not_configured: "not_configured";
+};
+export interface ForgetUserResultDto {
+    /** The forgotten user's Keycloak subject. */
+    sub: string;
+    /** When the erasure scrub completed (user_profile.forgotten_at). */
+    forgottenAt: string;
+    /** Outcome of the best-effort Keycloak push made after the database commit. `synced` — the Keycloak side was updated by this call. `failed` — the push was attempted and failed; the database change stands, and re-running the command re-attempts the push. `not_configured` — no push was attempted because no Keycloak sync client is provisioned for the tenant. */
+    keycloakSyncStatus: ForgetUserResultDtoKeycloakSyncStatus;
+    /** True when this call replayed a prior forget (same Idempotency-Key, or an already-forgotten target) with no new mutation. */
+    idempotent: boolean;
+}
+export interface ExportUserDataDto {
+    /**
+     * Required free-text reason for the disclosure, recorded on the admin_action audit row.
+     * @maxLength 2000
+     */
+    reason: string;
+}
+/**
+ * @nullable
+ */
+export type ExportedProfileDtoPreferences = {
+    [key: string]: unknown;
+} | null;
+export interface ExportedProfileDto {
+    sub: string;
+    email: string;
+    /** @nullable */
+    displayName: string | null;
+    /** @nullable */
+    phone: string | null;
+    /** @nullable */
+    preferences: ExportedProfileDtoPreferences;
+    createdAt: string;
+    lastSeenAt: string;
+    /** @nullable */
+    deletedAt: string | null;
+    /** @nullable */
+    forgottenAt: string | null;
+}
+export interface ExportedMembershipDto {
+    organizationId: string;
+    role: string;
+    createdAt: string;
+    /** @nullable */
+    deletedAt: string | null;
+}
+export interface ExportedAssignmentDto {
+    employeeAssignmentId: string;
+    kind: string;
+    /** @nullable */
+    warehouseId: string | null;
+    /** @nullable */
+    tenantCarrierId: string | null;
+    role: string;
+    active: boolean;
+    /** @nullable */
+    startedAt: string | null;
+    /** @nullable */
+    endedAt: string | null;
+    createdAt: string;
+    /** @nullable */
+    deletedAt: string | null;
+}
+export interface ExportUserDataResultDto {
+    /** The exported user's Keycloak subject. */
+    sub: string;
+    /** When this export was generated. */
+    exportedAt: string;
+    profile: ExportedProfileDto;
+    organizationMemberships: ExportedMembershipDto[];
+    employeeAssignments: ExportedAssignmentDto[];
+    /** Personal data categories this export deliberately does NOT include (e.g. the sensitive personnummer column, billing/invoice records, order history, audit history) — this is Core API's identity-domain slice of a GDPR Article 15 fulfilment, not the complete record. */
+    notIncluded: string[];
+}
+export type EmployeeAssignmentDtoKind = typeof EmployeeAssignmentDtoKind[keyof typeof EmployeeAssignmentDtoKind];
+export declare const EmployeeAssignmentDtoKind: {
+    readonly warehouse: "warehouse";
+    readonly carrier: "carrier";
+    readonly tenant_wide: "tenant_wide";
+};
+export interface EmployeeAssignmentDto {
+    employeeAssignmentId: string;
+    /** Keycloak subject of the assigned staff member. */
+    userSub: string;
+    kind: EmployeeAssignmentDtoKind;
+    /**
+     * Set for `kind=warehouse`, null otherwise.
+     * @nullable
+     */
+    warehouseId: string | null;
+    /**
+     * The `tenant_carrier` this assignment scopes to. Set for `kind=carrier`, null otherwise.
+     * @nullable
+     */
+    tenantCarrierId: string | null;
+    /** Staff role the assignment grants. Rows created here carry one of the assignment roles; rows imported or seeded elsewhere can carry any client role. */
+    role: string;
+    /** False once the assignment has been offboarded. Only active assignments contribute to the Keycloak claims. */
+    active: boolean;
+    /** @nullable */
+    startedAt: string | null;
+    /** @nullable */
+    endedAt: string | null;
+    /**
+     * Display name of the assigned staff member, from their `user_profile`. Null when the user has no profile row yet (it is created by their first `/v1/me` call) or has not set a name.
+     * @nullable
+     */
+    displayName: string | null;
+    /**
+     * Email of the assigned staff member, from their `user_profile`. Null when the user has no profile row yet (it is created by their first `/v1/me` call).
+     * @nullable
+     */
+    email: string | null;
+}
+export type CreateEmployeeAssignmentDtoKind = typeof CreateEmployeeAssignmentDtoKind[keyof typeof CreateEmployeeAssignmentDtoKind];
+export declare const CreateEmployeeAssignmentDtoKind: {
+    readonly warehouse: "warehouse";
+    readonly carrier: "carrier";
+    readonly tenant_wide: "tenant_wide";
+};
+export type CreateEmployeeAssignmentDtoRole = typeof CreateEmployeeAssignmentDtoRole[keyof typeof CreateEmployeeAssignmentDtoRole];
+export declare const CreateEmployeeAssignmentDtoRole: {
+    readonly 'operations-manager': "operations-manager";
+    readonly 'warehouse-admin': "warehouse-admin";
+    readonly 'warehouse-operator': "warehouse-operator";
+    readonly 'carrier-admin': "carrier-admin";
+    readonly 'carrier-driver': "carrier-driver";
+};
+export interface CreateEmployeeAssignmentDto {
+    /** Keycloak subject of the staff member to hire. They must already exist as a user (their `user_profile` row is created by their first `/v1/me` call). */
+    userSub: string;
+    kind: CreateEmployeeAssignmentDtoKind;
+    role: CreateEmployeeAssignmentDtoRole;
+    /** Required for `kind=warehouse`, rejected for any other kind. */
+    warehouseId?: string;
+    /** Required for `kind=carrier` (drivers are `kind=carrier`), rejected for any other kind. */
+    tenantCarrierId?: string;
+    /** First day of the assignment; defaults to today. */
+    startedAt?: string;
+}
+export type EmployeeAssignmentSyncResultDtoKind = typeof EmployeeAssignmentSyncResultDtoKind[keyof typeof EmployeeAssignmentSyncResultDtoKind];
+export declare const EmployeeAssignmentSyncResultDtoKind: {
+    readonly warehouse: "warehouse";
+    readonly carrier: "carrier";
+    readonly tenant_wide: "tenant_wide";
+};
+/**
+ * Outcome of the best-effort Keycloak push made after the database commit. `synced` — the Keycloak side was updated by this call. `failed` — the push was attempted and failed; the database change stands, and re-running the command re-attempts the push. `not_configured` — no push was attempted because no Keycloak sync client is provisioned for the tenant.
+ */
+export type EmployeeAssignmentSyncResultDtoKeycloakSyncStatus = typeof EmployeeAssignmentSyncResultDtoKeycloakSyncStatus[keyof typeof EmployeeAssignmentSyncResultDtoKeycloakSyncStatus];
+export declare const EmployeeAssignmentSyncResultDtoKeycloakSyncStatus: {
+    readonly synced: "synced";
+    readonly failed: "failed";
+    readonly not_configured: "not_configured";
+};
+export interface EmployeeAssignmentSyncResultDto {
+    employeeAssignmentId: string;
+    /** Keycloak subject of the assigned staff member. */
+    userSub: string;
+    kind: EmployeeAssignmentSyncResultDtoKind;
+    /**
+     * Set for `kind=warehouse`, null otherwise.
+     * @nullable
+     */
+    warehouseId: string | null;
+    /**
+     * The `tenant_carrier` this assignment scopes to. Set for `kind=carrier`, null otherwise.
+     * @nullable
+     */
+    tenantCarrierId: string | null;
+    /** Staff role the assignment grants. Rows created here carry one of the assignment roles; rows imported or seeded elsewhere can carry any client role. */
+    role: string;
+    /** False once the assignment has been offboarded. Only active assignments contribute to the Keycloak claims. */
+    active: boolean;
+    /** @nullable */
+    startedAt: string | null;
+    /** @nullable */
+    endedAt: string | null;
+    /**
+     * Display name of the assigned staff member, from their `user_profile`. Null when the user has no profile row yet (it is created by their first `/v1/me` call) or has not set a name.
+     * @nullable
+     */
+    displayName: string | null;
+    /**
+     * Email of the assigned staff member, from their `user_profile`. Null when the user has no profile row yet (it is created by their first `/v1/me` call).
+     * @nullable
+     */
+    email: string | null;
+    /** Outcome of the best-effort Keycloak push made after the database commit. `synced` — the Keycloak side was updated by this call. `failed` — the push was attempted and failed; the database change stands, and re-running the command re-attempts the push. `not_configured` — no push was attempted because no Keycloak sync client is provisioned for the tenant. */
+    keycloakSyncStatus: EmployeeAssignmentSyncResultDtoKeycloakSyncStatus;
+}
+export type UpdateEmployeeAssignmentDtoRole = typeof UpdateEmployeeAssignmentDtoRole[keyof typeof UpdateEmployeeAssignmentDtoRole];
+export declare const UpdateEmployeeAssignmentDtoRole: {
+    readonly 'operations-manager': "operations-manager";
+    readonly 'warehouse-admin': "warehouse-admin";
+    readonly 'warehouse-operator': "warehouse-operator";
+    readonly 'carrier-admin': "carrier-admin";
+    readonly 'carrier-driver': "carrier-driver";
+};
+export interface UpdateEmployeeAssignmentDto {
+    role?: UpdateEmployeeAssignmentDtoRole;
+    /** Move a `kind=warehouse` assignment to another warehouse. */
+    warehouseId?: string;
+    /** Move a `kind=carrier` assignment to another carrier. */
+    tenantCarrierId?: string;
+    startedAt?: string;
+}
+export interface OffboardEmployeeDto {
+    /** Last day of the assignment; defaults to today. */
+    endedAt?: string;
+    /** Free-text reason, recorded in the service log for ops follow-up. `employee_assignment` has no column for it, so it is not stored on the row or echoed back. */
+    reason?: string;
+}
 export type OrdersControllerListV1Params = {
     /**
      * Max rows to return (1–100).
@@ -7665,4 +8048,44 @@ export type PricingRulesControllerListPricingRulesV1Params = {
      */
     offset?: number;
 };
+export type UsersControllerListV1Params = {
+    /**
+     * Case-insensitive substring match over display name OR email. Omit to list the first page of the directory.
+     * @maxLength 200
+     */
+    search?: string;
+    /**
+     * Max rows to return. Values above 50 are clamped to 50; a non-integer is a 400.
+     * @minimum 1
+     */
+    limit?: number;
+};
+export type EmployeeAssignmentsControllerListV1Params = {
+    /**
+     * Filter by scope family.
+     */
+    kind?: EmployeeAssignmentsControllerListV1Kind;
+    /**
+     * Filter to one warehouse's staff.
+     */
+    warehouseId?: string;
+    /**
+     * Filter to one carrier's staff (matches `tenantCarrierId`).
+     */
+    carrierId?: string;
+    /**
+     * Filter by active state; omit for both.
+     */
+    active?: boolean;
+    /**
+     * Filter to one staff member's assignments.
+     */
+    userSub?: string;
+};
+export type EmployeeAssignmentsControllerListV1Kind = typeof EmployeeAssignmentsControllerListV1Kind[keyof typeof EmployeeAssignmentsControllerListV1Kind];
+export declare const EmployeeAssignmentsControllerListV1Kind: {
+    readonly warehouse: "warehouse";
+    readonly carrier: "carrier";
+    readonly tenant_wide: "tenant_wide";
+};
 //# sourceMappingURL=index.schemas.d.ts.map