Audit Log now tracks changes on Associate Roles | HTTP API

Audit Log now tracks changes on Associate Roles

18 July 2023

Composable Commerce

HTTP API

Enhancement

Deprecation

B2BAudit LogGraphQL

We have extended the capabilities of Audit Log to track changes to Associate Roles. In addition, we introduced new Change Types for Business Units.

To ensure a consistent experience when working with different Change Types across the Change History API, we are adjusting the implementation of SetNameChange and introducing SetLocalizedNameChange.

From 18 October 2023:

SetNameChange fields previousValue and nextValue will change to type String.
The following update actions will trigger SetLocalizedNameChange instead of SetNameChange:
- Set Name on Discount Codes.
- Set State Name on States.
- Set Name on Stores.

Changes:

[API] Added the following Change Types:
- Associate Roles: ChangeBuyerAssignableChange, SetPermissionsChange.
- Business Units: AddInheritedAssociateChange, ChangeInheritedAssociateChange, RemoveInheritedAssociateChange.
[API] Added Label AssociateRoleLabel.
[API] Added associate-role to ChangeHistoryResourceType enum.
[GraphQL API] Added the following types to the GraphQL schema: AssociateRoleChangeInput, AssociateRoleLabel.

[GraphQL API] Changed the ResourceTypes type:
- Added AssociateRole to the enum ResourceTypes.
[GraphQL API] Changed the BusinessUnitChangeInput type:
- Added addInheritedAssociate, changeInheritedAssociate, removeInheritedAssociate to the enum BusinessUnitChangeInput.
[GraphQL API] Changed the Query type:
- Added associateRoles and associateRole fields to the Query type.

The following change was introduced in terms of GraphQL SDL:

  enum AssociateRoleChangeInput {
    changeBuyerAssignable
    setCustomField
    setCustomType
    setName
    setPermissions
  }

  type AssociateRoleLabel {
    key: String!
    name: String
  }

  extend enum ResourceTypes {
    AssociateRole
  }

  extend enum BusinessUnitChangeInput {
    addInheritedAssociate
    changeInheritedAssociate
    removeInheritedAssociate
  }

  extend type Query {
    associateRoles(
      date: DateRange
      limit: Int
      offset: Int
      source: Source
      type: Type
      clientId: String
      userId: String
      customerId: String
      changes: [AssociateRoleChangeInput!]
      expand: Boolean
      stores: [String!]
      resourceKey: String
    ): ChangeHistoryQueryResults!

    associateRole(
      id: String!
      date: DateRange
      limit: Int
      offset: Int
      source: Source
      type: Type
      clientId: String
      userId: String
      customerId: String
      changes: [AssociateRoleChangeInput!]
      expand: Boolean
      stores: [String!]
    ): ChangeHistoryQueryResults!
  }