@viu/emporix-sdk 2.21.0 → 2.23.0

package/dist/customer-groups-GlzWhDsi.d.ts

@@ -0,0 +1,706 @@
+import { C as ClientContext, b as AuthContext } from './context-CfXJcYKP.js';
+
+/**
+ * Access control metadata.
+ */
+type AccessControlMetadataQueryDocument = {
+    /**
+     * Access control document version.
+     */
+    version: number;
+    /**
+     * Timestamp indicating when the access control was created.
+     */
+    createdAt: string;
+    /**
+     * Timestamp indicating when the access control was last modified.
+     */
+    modifiedAt?: string;
+};
+/**
+ * Definition of access control
+ */
+type AccessControlQueryDocument = {
+    /**
+     * Assignment unique identifier generated when the assignment is created.
+     */
+    id?: string;
+    /**
+     * Role unique identifier associated with this access control.
+     * @deprecated
+     */
+    roleId?: string;
+    /**
+     * Resource unique identifier associated with this access control.
+     * @deprecated
+     */
+    resourceId?: string;
+    /**
+     * Domain identifiers associated with this access control.
+     */
+    domains?: Array<string>;
+    /**
+     * Localized resource name in the form of a map of translations.
+     */
+    name?: {
+        [key: string]: string;
+    };
+    role?: RoleQueryDocument;
+    resource?: ResourceQueryDocument;
+    metadata?: AccessControlMetadataQueryDocument;
+    /**
+     * A list of resolved scopes for a particular access control.
+     */
+    scopes?: Array<string>;
+    /**
+     * Determines whether this access control generates scopes with restriction suffixes when assigned to a group that has restrictions defined. When `true`, the generated scopes will include restrictions (e.g. order.`order_manage--DE`) based on the group's restrictions list. When `false`, scopes are generated without restriction suffixes regardless of the group's restrictions.
+     */
+    restrictionAware?: boolean;
+    /**
+     * Restricts the type of group this access control can be assigned to.
+     * * `CUSTOMER` - the access control can be assigned only to groups of `CUSTOMER` user type.
+     * * `EMPLOYEE` - the access control can be assigned only to groups of `EMPLOYEE` user type.
+     *
+     * If this property is not present, the access control can be assigned to any group regardless of its user type.
+     *
+     */
+    restrictedTo?: 'CUSTOMER' | 'EMPLOYEE';
+    /**
+     * Indicated whether this access control is predefined in the system or was created by a user.
+     */
+    readonly predefined?: boolean;
+    /**
+     * Indicated whether this access control is associated with vendor scopes.
+     */
+    readonly vendorAware?: boolean;
+};
+/**
+ * Payload for creating or updating an access control.
+ */
+type AccessControlUpsertRequest = {
+    /**
+     * Localized name as a map of language codes to text.
+     */
+    name?: {
+        [key: string]: string;
+    };
+    /**
+     * Localized description as a map of language codes to text.
+     */
+    description?: {
+        [key: string]: string;
+    };
+    /**
+     * Scope codes for this access control. Must not be empty.
+     */
+    scopes: Array<string>;
+    /**
+     * Domain identifiers for the access control.
+     */
+    domains?: Array<string>;
+    /**
+     * Restricts the type of group this access control can be assigned to.
+     * * `CUSTOMER` - the access control can be assigned only to groups of `CUSTOMER` user type.
+     * * `EMPLOYEE` - the access control can be assigned only to groups of `EMPLOYEE` user type.
+     *
+     * If this property is not present, the access control can be assigned to any group regardless of its user type.
+     *
+     * **Note**: This property is immutable. It can only be set when the access control is created and cannot be changed afterwards.
+     *
+     */
+    restrictedTo?: 'CUSTOMER' | 'EMPLOYEE';
+    /**
+     * Metadata for optimistic locking on updates. Only `version` is supported.
+     */
+    metadata?: {
+        /**
+         * Document version. When provided on update, must match the stored version.
+         */
+        version?: number;
+    };
+};
+type AccessControlIdResponse = {
+    /**
+     * ID of the created access control. Matches the `accessControlId` path parameter.
+     */
+    id?: string;
+};
+type AssignmentCreateRequest = {
+    /**
+     * User unique identifier generated when the user is created. Might be customer ID or Management Dashboard user ID.
+     */
+    userId: string;
+    /**
+     * Assignment type, possible values: CUSTOMER, EMPLOYEE
+     */
+    userType?: 'CUSTOMER' | 'EMPLOYEE';
+};
+type AssignmentIdResponse = {
+    /**
+     * ID of generated document.
+     */
+    id?: string;
+};
+type GroupCreateRequest = {
+    /**
+     * Custom group's identifier. If not provided, it is automatically generated
+     */
+    id?: string;
+    /**
+     * An identifier of a vendor to whom the group belongs. Can only be set during creation and is immutable thereafter. A group with vendorId can only be assigned to users of type `EMPLOYEE`
+     */
+    readonly vendorId?: string;
+    /**
+     * Localized group name in the form of a map of translations.
+     */
+    name: {
+        [key: string]: string;
+    };
+    /**
+     * Localized group description in the form of a map of translations.
+     */
+    description?: {
+        [key: string]: string;
+    };
+    /**
+     * Custom group attributes that need to be included directly in the `mixins` object.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Access control unique identifiers associated with this group. Required to perform the request.
+     */
+    accessControls?: Array<string> | null;
+    /**
+     * The type of the group. Possible values: 'CUSTOMER', 'EMPLOYEE'. Default value 'EMPLOYEE' if not provided.
+     */
+    userType?: 'CUSTOMER' | 'EMPLOYEE';
+    /**
+     * Template unique identifier associated with this group. Required to perform the request.
+     */
+    templates?: Array<string> | null;
+    /**
+     * Additional properties for B2B.
+     */
+    b2b?: {
+        /**
+         * Identifier of the assigned legal entity.
+         */
+        legalEntityId?: string;
+    };
+    restrictions?: Restrictions;
+};
+type GroupUpdateRequest = {
+    /**
+     * Localized group name in the form of a map of translations.
+     */
+    name: {
+        [key: string]: string;
+    };
+    /**
+     * Localized group description in the form of a map of translations.
+     */
+    description?: {
+        [key: string]: string;
+    };
+    /**
+     * Custom group attributes that need to be included directly in the `mixins` object.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Access control unique identifiers associated with this group. Required to perform the request.
+     */
+    accessControls?: Array<string> | null;
+    /**
+     * The type of the group. Possible values: 'CUSTOMER', 'EMPLOYEE'. Default value 'EMPLOYEE' if not provided
+     */
+    userType?: 'CUSTOMER' | 'EMPLOYEE';
+    /**
+     * Template unique identifier associated with this group. Required to perform the request.
+     */
+    templates?: Array<string> | null;
+    /**
+     * additional properties for B2B
+     */
+    b2b?: {
+        /**
+         * identifier of the assigned legal entity
+         */
+        legalEntityId?: string;
+    };
+    restrictions?: Restrictions;
+    /**
+     * Metadata of the updated group.
+     */
+    metadata?: {
+        /**
+         * Version of the entity, If provided optimistic locking is enabled and its version must match the version of the document in the database.
+         */
+        version?: number;
+    };
+};
+type GroupIdResponse = {
+    /**
+     * ID of the generated document.
+     */
+    id?: string;
+};
+type UserIdResponse = {
+    /**
+     * ID of the generated/updated user.
+     */
+    id?: string;
+};
+/**
+ * Group metadata.
+ */
+type GroupsMetadataQueryDocument = {
+    /**
+     * Group document version.
+     */
+    version: number;
+    /**
+     * Timestamp indicating when the group was created.
+     */
+    createdAt: string;
+    /**
+     * Timestamp indicating when the group was last modified.
+     */
+    modifiedAt?: string;
+};
+/**
+ * Definition of groups
+ */
+type GroupsQueryDocument = {
+    /**
+     * Group unique identifier generated when the group is created.
+     */
+    id?: string;
+    /**
+     * Localized group name in the form of a map of translations.
+     */
+    name?: {
+        [key: string]: string;
+    };
+    /**
+     * Localized group description in the form of a map of translations.
+     */
+    description?: {
+        [key: string]: string;
+    };
+    /**
+     * An identifier of a vendor to whom the group belongs. Can only be set during creation and is immutable thereafter. A group with vendorId can only be assigned to users of type `EMPLOYEE`
+     */
+    readonly vendorId?: string;
+    /**
+     * Access control unique identifiers associated with this group.
+     */
+    accessControls?: Array<string>;
+    /**
+     * Template unique identifiers associated with this group.
+     */
+    templates?: Array<string>;
+    code?: string;
+    /**
+     * The group type determines if the group can consist of users of the `CUSTOMER` or the `EMPLOYEE` type.
+     */
+    userType?: string;
+    /**
+     * additional properties for B2B
+     */
+    b2b?: {
+        /**
+         * identifier of the assigned legal entity
+         */
+        legalEntityId?: string;
+    };
+    restrictions?: Restrictions;
+    /**
+     * Custom group attributes that need to be included directly in the `mixins` object.
+     */
+    mixins?: {
+        [key: string]: string;
+    };
+    metadata?: GroupsMetadataQueryDocument;
+};
+type Restrictions = Array<string>;
+/**
+ * Resource definition associated with this access control.
+ */
+type ResourceQueryDocument = {
+    /**
+     * Resource unique identifier generated when the resource is created.
+     */
+    id?: string;
+    /**
+     * Localized resource name in the form of a map of translations.
+     */
+    name?: {
+        [key: string]: string;
+    };
+    /**
+     * Localized resource description in the form of a map of translations.
+     */
+    description?: {
+        [key: string]: string;
+    };
+    /**
+     * Resource unique code identifier.
+     */
+    code?: string;
+    metadata?: ResourcesMetadataQueryDocument;
+};
+/**
+ * Resource metadata.
+ */
+type ResourcesMetadataQueryDocument = {
+    /**
+     * Resource document version.
+     */
+    version: number;
+    /**
+     * Timestamp indicating when the resource was created.
+     */
+    createdAt: string;
+    /**
+     * Timestamp indicating when the resource was last modified.
+     */
+    modifiedAt?: string;
+};
+/**
+ * Role permissions list.
+ */
+type RolePermissionsDocument = {
+    /**
+     * Allows you to allowlist resources that the permission is applicable to. Can only contain resources specified in the permission document under `applicableResources`.
+     *
+     */
+    applicablePermissionResources?: Array<string>;
+    /**
+     * Reference to the permission document with specific resources defined.
+     */
+    id: string;
+};
+/**
+ * Role definition associated with this access control.
+ */
+type RoleQueryDocument = {
+    /**
+     * Role unique identifier generated when the role is created.
+     */
+    id?: string;
+    /**
+     * Localized role name in the form of a map of translations.
+     */
+    name?: {
+        [key: string]: string;
+    };
+    /**
+     * Localized role description in the form of a map of translations.
+     */
+    description?: {
+        [key: string]: string;
+    };
+    /**
+     * Permissions unique identifier list declared for this role.
+     */
+    permissions?: Array<RolePermissionsDocument>;
+    metadata?: RolesMetadata;
+};
+type RolesMetadata = {
+    /**
+     * Role document version.
+     */
+    version: number;
+    /**
+     * Timestamp indicating when the role was created.
+     */
+    createdAt: string;
+    /**
+     * Timestamp indicating when the role was last modified.
+     */
+    modifiedAt?: string;
+};
+/**
+ * Definition of user scopes
+ */
+type UserScopesResponse = {
+    /**
+     * User unique identifier.
+     */
+    userId?: string;
+    /**
+     * User scopes.
+     */
+    scopes?: string;
+    /**
+     * An identifier of a vendor to whom the user belongs. Calculated based on groups assignment
+     */
+    readonly vendorId?: string;
+};
+/**
+ * User response schema
+ */
+type UserResponse = {
+    /**
+     * User unique identifier generated when the group is created.
+     */
+    id: string;
+    /**
+     * User first name.
+     */
+    firstName: string;
+    /**
+     * User last name.
+     */
+    lastName: string;
+    /**
+     * For a new user, the value is the same as Id. For an existing user, the value is an internal number. This field should be used when retrieving user details and for user update and deletion.
+     */
+    backofficeUserNumber: string;
+    /**
+     * User preferred site
+     */
+    preferredSite: string;
+    /**
+     * User preferred currency
+     */
+    preferredCurrency: string;
+    /**
+     * User preferred language
+     */
+    preferredLanguage: string;
+    /**
+     * User department
+     */
+    department: string;
+    /**
+     * Account creation date
+     */
+    validFrom: string;
+    /**
+     * Indicates whether user is able to log in to Management Dashboard.
+     */
+    isAccountLocked: boolean;
+    /**
+     * User contact email
+     */
+    contactEmail: string;
+    /**
+     * Indicates user status. May be 'Active' or 'Provisioned' in case user does not confirm their email.
+     */
+    status: string;
+    /**
+     * Group ids where user is assigned to.
+     */
+    groupIds: Array<string>;
+    /**
+     * Group extended definition, may be fetched when `extend` param is used
+     */
+    groups?: Array<{
+        /**
+         * Group unique identifier generated when the group is created.
+         */
+        id?: string;
+        /**
+         * Localized group name in the form of a map of translations.
+         */
+        name?: unknown;
+        /**
+         * Localized group description in the form of a map of translations.
+         */
+        description?: {
+            [key: string]: string;
+        };
+        /**
+         * Internal code of a group.
+         */
+        code?: string;
+        /**
+         * The group type determines if the group can consist of users of the `CUSTOMER` or the `EMPLOYEE` type.
+         */
+        userType?: string;
+    }>;
+};
+/**
+ * User response schema extended with additional information
+ */
+type UserExtendedResponse = UserResponse & {
+    /**
+     * Timestamp of account's last login
+     */
+    lastLogin?: string;
+};
+/**
+ * User update schema
+ */
+type UserUpdateRequest = {
+    /**
+     * User first name.
+     */
+    firstName: string;
+    /**
+     * User last name.
+     */
+    lastName: string;
+    /**
+     * User preferred site
+     */
+    preferredSite: string;
+    /**
+     * User preferred currency
+     */
+    preferredCurrency: string;
+    /**
+     * User preferred language
+     */
+    preferredLanguage: string;
+    /**
+     * User department
+     */
+    department: string;
+    /**
+     * User backoffice user number. For new users, it is the same as ID. For existing users, it may be different.
+     */
+    backofficeUserNumber: string;
+    /**
+     * Groups unique identifier attached to this user. Required to perform the request.
+     */
+    groupIds: Array<string>;
+};
+type UserCreateRequest = {
+    /**
+     * User first name.
+     */
+    firstName: string;
+    /**
+     * User last name.
+     */
+    lastName: string;
+    /**
+     * User preferred site
+     */
+    preferredSite: string;
+    /**
+     * User preferred currency
+     */
+    preferredCurrency: string;
+    /**
+     * User preferred language
+     */
+    preferredLanguage: string;
+    /**
+     * User department
+     */
+    department: string;
+    /**
+     * User contact email
+     */
+    contactEmail: string;
+    /**
+     * Unique identifier of a group associated with to this user. Required to perform the request.
+     */
+    groupIds: Array<string>;
+};
+/**
+ * Scope metadata.
+ */
+type CustomScopeMetadataQueryDocument = {
+    /**
+     * Scope document version.
+     */
+    version: number;
+    /**
+     * Timestamp indicating when the scope was created.
+     */
+    createdAt: string;
+    /**
+     * Timestamp indicating when the scope was last modified.
+     */
+    modifiedAt?: string;
+};
+/**
+ * Definition of a scope.
+ */
+type CustomScopeQueryDocument = {
+    /**
+     * Scope identifier.
+     */
+    id?: string;
+    /**
+     * Localized description as a map of language codes to text.
+     */
+    description?: {
+        [key: string]: string;
+    };
+    /**
+     * Domain identifier for the scope.
+     */
+    domain?: string;
+    /**
+     * Indicates whether this scope is predefined in the system or was created by a user.
+     */
+    readonly predefined?: boolean;
+    metadata?: CustomScopeMetadataQueryDocument;
+};
+/**
+ * Payload for creating or updating a scope.
+ */
+type CustomScopeUpsertRequest = {
+    /**
+     * Localized description as a map of language codes to text.
+     */
+    description?: {
+        [key: string]: string;
+    };
+    /**
+     * Domain identifier for the scope.
+     */
+    domain?: string;
+    /**
+     * Metadata for the scope. Only `version` is supported, for optimistic locking on updates.
+     */
+    metadata?: {
+        /**
+         * Document version. When provided on update, must match the stored version.
+         */
+        version?: number;
+    };
+};
+type CustomScopeIdResponse = {
+    id?: string;
+};
+
+/**
+ * Access to IAM customer groups for a legal entity. Thin B2B-friendly wrapper
+ * over {@link IamService.groups}; kept for backward compatibility.
+ *
+ * `listForCompany` requires `iam.group_read`; the member mutations
+ * (`addMember`/`removeMember`) require `iam.group_manage` — typically only
+ * granted to Admin-group customers; a 403 surfaces as
+ * `EmporixInsufficientScopeError`.
+ */
+declare class CustomerGroupsService {
+    private readonly ctx;
+    static readonly channel: "iam";
+    private readonly iam;
+    constructor(ctx: ClientContext);
+    /** Lists customer groups belonging to one legal entity. */
+    listForCompany(legalEntityId: string, auth: AuthContext): Promise<GroupsQueryDocument[]>;
+    /** Adds a user (customer or employee) to a group. */
+    addMember(groupId: string, member: AssignmentCreateRequest, auth: AuthContext): Promise<{
+        id: string;
+    }>;
+    /**
+     * Removes a user from a group. Uses `DELETE …/groups/{groupId}/users/{userId}`
+     * directly — this endpoint is deprecated upstream and intentionally not
+     * exposed on {@link IamService}, so it is not delegated. No non-deprecated
+     * single-user removal exists.
+     */
+    removeMember(groupId: string, userId: string, auth: AuthContext): Promise<void>;
+}
+
+export { type AccessControlIdResponse as A, type CustomScopeIdResponse as C, type GroupCreateRequest as G, type UserCreateRequest as U, type AccessControlQueryDocument as a, type AccessControlUpsertRequest as b, type AssignmentCreateRequest as c, type AssignmentIdResponse as d, type CustomScopeQueryDocument as e, type CustomScopeUpsertRequest as f, CustomerGroupsService as g, type GroupIdResponse as h, type GroupUpdateRequest as i, type GroupsQueryDocument as j, type UserExtendedResponse as k, type UserIdResponse as l, type UserResponse as m, type UserScopesResponse as n, type UserUpdateRequest as o };