@viu/emporix-sdk 2.8.0 → 2.9.0

package/dist/customer-groups.d.cts

@@ -1,36 +1,109 @@
 import { C as ClientContext, b as AuthContext } from './context-DJDTlhLW.cjs';
 
+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';
+};
 /**
- * Hand-written mirror of the minimal IAM Service group shape needed for
- * B2B foundation reads. The Emporix IAM API exposes groups keyed by
- * `b2b.legalEntityId`. Membership-mutation endpoints exist on the server
- * but their exact path/body shape is not in the current SDK input set —
- * `customer-groups.ts` ships read-only here; mutations follow in a small
- * follow-up plan once the API reference is confirmed.
+ * Group metadata.
  */
-interface IamGroupB2B {
-    legalEntityId?: string;
-}
-interface IamGroup {
-    id: string;
-    name?: Record<string, string>;
-    role?: string;
-    b2b?: IamGroupB2B;
-}
+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>;
 
 /**
- * Read-only access to IAM customer groups for a legal entity.
+ * Access to IAM customer groups for a legal entity.
  *
- * Member-management endpoints (`addMember`/`removeMember`) are deferred —
- * the exact IAM path/body shape isn't in the SDK input set yet. They will
- * land in a small follow-up plan once the API reference is confirmed.
+ * `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;
     constructor(ctx: ClientContext);
     private base;
     /** Lists customer groups belonging to one legal entity. */
-    listForCompany(legalEntityId: string, auth: AuthContext): Promise<IamGroup[]>;
+    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. */
+    removeMember(groupId: string, userId: string, auth: AuthContext): Promise<void>;
 }
 
-export { CustomerGroupsService, type IamGroup, type IamGroupB2B };
+export { CustomerGroupsService, type GroupsQueryDocument as IamGroup, type AssignmentCreateRequest as IamGroupMemberAssignment };

package/dist/customer-groups.d.ts

@@ -1,36 +1,109 @@
 import { C as ClientContext, b as AuthContext } from './context-DJDTlhLW.js';
 
+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';
+};
 /**
- * Hand-written mirror of the minimal IAM Service group shape needed for
- * B2B foundation reads. The Emporix IAM API exposes groups keyed by
- * `b2b.legalEntityId`. Membership-mutation endpoints exist on the server
- * but their exact path/body shape is not in the current SDK input set —
- * `customer-groups.ts` ships read-only here; mutations follow in a small
- * follow-up plan once the API reference is confirmed.
+ * Group metadata.
  */
-interface IamGroupB2B {
-    legalEntityId?: string;
-}
-interface IamGroup {
-    id: string;
-    name?: Record<string, string>;
-    role?: string;
-    b2b?: IamGroupB2B;
-}
+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>;
 
 /**
- * Read-only access to IAM customer groups for a legal entity.
+ * Access to IAM customer groups for a legal entity.
  *
- * Member-management endpoints (`addMember`/`removeMember`) are deferred —
- * the exact IAM path/body shape isn't in the SDK input set yet. They will
- * land in a small follow-up plan once the API reference is confirmed.
+ * `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;
     constructor(ctx: ClientContext);
     private base;
     /** Lists customer groups belonging to one legal entity. */
-    listForCompany(legalEntityId: string, auth: AuthContext): Promise<IamGroup[]>;
+    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. */
+    removeMember(groupId: string, userId: string, auth: AuthContext): Promise<void>;
 }
 
-export { CustomerGroupsService, type IamGroup, type IamGroupB2B };
+export { CustomerGroupsService, type GroupsQueryDocument as IamGroup, type AssignmentCreateRequest as IamGroupMemberAssignment };

package/dist/customer-groups.js

@@ -1,3 +1,3 @@
-export { CustomerGroupsService } from './chunk-SKX7KCMH.js';
+export { CustomerGroupsService } from './chunk-LGOC5XOI.js';
 //# sourceMappingURL=customer-groups.js.map
 //# sourceMappingURL=customer-groups.js.map

package/dist/index.cjs

@@ -1001,6 +1001,16 @@ var ProductService = class {
     });
     return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
   }
+  /**
+   * Free-text product search by name. The product `q` is a `field:value` DSL,
+   * so a bare term (e.g. "in time") 400s with "No value for key …". This builds
+   * a `name:(~<term>)` regex filter (regex metacharacters escaped) and delegates
+   * to {@link search}.
+   */
+  async searchByName(query, params = {}, auth2 = ANON) {
+    const escaped = query.trim().replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+    return this.search(`name:(~${escaped})`, params, auth2);
+  }
   /**
    * Bulk fetch by id. POSTs `/products/search` with `q="id:(id1,id2,…)"`,
    * chunking when the list is larger than `options.chunkSize` (default
@@ -1464,6 +1474,16 @@ var PaymentGatewayService = class {
 };
 
 // src/services/price.ts
+function normalizeMatch(raw) {
+  const itemId = raw.itemId ?? raw.itemRef;
+  const base = raw;
+  if (!itemId) return base;
+  const itemRef = {
+    ...itemId.itemType !== void 0 ? { itemType: itemId.itemType } : {},
+    ...itemId.id !== void 0 ? { id: itemId.id } : {}
+  };
+  return { ...base, itemId, itemRef };
+}
 var ANON3 = { kind: "anonymous" };
 var SERVICE = { kind: "service" };
 function requireContextAuth(auth2) {
@@ -1484,24 +1504,26 @@ var PriceService = class {
    * anonymous; pass a customer/raw context for personalized pricing.
    */
   async matchByContext(input, auth2) {
-    return this.ctx.http.request({
+    const rows = await this.ctx.http.request({
       method: "POST",
       path: `/price/${this.ctx.tenant}/match-prices-by-context`,
       auth: requireContextAuth(auth2),
       body: input
     });
+    return rows.map(normalizeMatch);
   }
   /**
    * Resolves prices from an explicit context. Default auth: service
    * (requires `price.price_read` / `price.price_manage`).
    */
   async match(input, auth2 = SERVICE) {
-    return this.ctx.http.request({
+    const rows = await this.ctx.http.request({
       method: "POST",
       path: `/price/${this.ctx.tenant}/match-prices`,
       auth: auth2,
       body: input
     });
+    return rows.map(normalizeMatch);
   }
   /**
    * Chunked variant of {@link matchByContext} for large `items` arrays. The
@@ -1514,7 +1536,7 @@ var PriceService = class {
    * `throwOnAnyChunkError: true` to reject on the first failure instead.
    *
    * **Result order is not guaranteed** — match entries back to your items by
-   * `priceId` / `itemRef.id`.
+   * `priceId` / `itemId.id`.
    */
   async matchByContextChunked(input, opts = {}, auth2) {
     const chunkSize = opts.chunkSize ?? 50;
@@ -2064,7 +2086,10 @@ var CompaniesService = class {
       body: input
     });
   }
-  /** Patches a legal entity. */
+  /**
+   * Patches a legal entity. The endpoint is a PATCH, so the body is a partial
+   * of the generated `LegalEntityUpdate` (full-replace) shape.
+   */
   async update(legalEntityId, patch, auth2) {
     return this.ctx.http.request({
       method: "PATCH",
@@ -2110,7 +2135,10 @@ var ContactsService = class {
       body: input
     });
   }
-  /** Patches a contact assignment. */
+  /**
+   * Patches a contact assignment. PATCH endpoint, so the body is a partial of
+   * the generated `ContactAssignmentUpdate` shape.
+   */
   async update(contactAssignmentId, patch, auth2) {
     return this.ctx.http.request({
       method: "PATCH",
@@ -2164,7 +2192,10 @@ var LocationsService = class {
       body: input
     });
   }
-  /** Patches a location. */
+  /**
+   * Patches a location. PATCH endpoint, so the body is a partial of the
+   * generated `LocationUpdate` shape.
+   */
   async update(locationId, patch, auth2) {
     return this.ctx.http.request({
       method: "PATCH",
@@ -2201,6 +2232,23 @@ var CustomerGroupsService = class {
       auth: auth2
     });
   }
+  /** Adds a user (customer or employee) to a group. */
+  async addMember(groupId, member, auth2) {
+    return this.ctx.http.request({
+      method: "POST",
+      path: `${this.base()}/${groupId}/users`,
+      auth: auth2,
+      body: member
+    });
+  }
+  /** Removes a user from a group. */
+  async removeMember(groupId, userId, auth2) {
+    await this.ctx.http.request({
+      method: "DELETE",
+      path: `${this.base()}/${groupId}/users/${userId}`,
+      auth: auth2
+    });
+  }
 };
 
 // src/services/orders.ts
@@ -5020,7 +5068,7 @@ var ApprovalService = class {
 };
 
 // package.json
-var version = "2.8.0";
+var version = "2.9.0";
 
 // src/version.ts
 var SDK_VERSION = version;
@@ -5191,6 +5239,13 @@ var EmporixClient = class {
   }
 };
 
+// src/core/yrn.ts
+function productIdFromYrn(yrn) {
+  if (!yrn) return "";
+  const semi = yrn.lastIndexOf(";");
+  return semi >= 0 ? yrn.slice(semi + 1) : "";
+}
+
 exports.AiService = AiService;
 exports.ApprovalService = ApprovalService;
 exports.AvailabilityService = AvailabilityService;
@@ -5254,6 +5309,7 @@ exports.createConsoleLogger = createConsoleLogger;
 exports.createNoopLogger = createNoopLogger;
 exports.errorFromResponse = errorFromResponse;
 exports.iterateAll = iterateAll;
+exports.productIdFromYrn = productIdFromYrn;
 exports.redact = redact;
 exports.resolveToken = resolveToken;
 exports.validateConfig = validateConfig;