Skip to main content

updateRatingGroupHierarchy GQL Mutation Usage

Benji Bizzell
  • Updated

Overview

The updateRatingGroupHierarchy GQL Mutation can be leveraged to update details about the Rating Groups of the current Rating Group Hierarchy defined within a Provider tenant.

 

Usage

updateRatingGroupHierarchy takes in a providerID and UpdateRatingGroupHierarchyInput as its arguments. The UpdateRatingGroupHierarchyInput should match the existing RatingGroupHierarchy, often best created by comparing the output of the getRatingGroupHierarchy GQL Query. Failure to match the existing hierarchy will result in failed updates or accidentally deleted rating groups. 

 

Important Usage Notes

  • The root Rating Group is just there to have a point to start.
    • Every rating group immediately after the root has to have a perUnitRounding set, as it's considered a top-level rating group.
    • Every group under a top-level rating group doesn't need perUnitRounding as it uses parent rounding if it doesn't have one.
  • Excluding existing fields within the mutation that are not marked mandatory may result in the current values being removed.
    • To avoid issues during updates, unitType and perUnitRounding should generally be treated as mandatory fields unless you intend to remove their existing values.
    • Similarly, excluding a Rating Group within the Input Hierarchy will result in its removal.
  • Once a Plan has referenced a particular Rating Group, it can no longer be updated or removed until the reference has been removed. Attempting to do so will result in a RatingGroupHierarchyHasReferences exception.

 

Example Query

mutation UpdateRatingGroupHierarchy {
  updateRatingGroupHierarchy(
    input: {
      providerId: "{{_.providerId}}"
      root: {
        children: [
          {
            id: 100
            perUnitRounding: 60
            name: "Voice"
            unitType: TIME
            children: []
          }
          {
            id: 200
            perUnitRounding: 1
            name: "Text"
            unitType: SERVICE_SPECIFIC_UNITS
            children: []
          }
          {
            id: 300
            perUnitRounding: 1024
            name: "Data"
            unitType: VOLUME
            quotaValidityTime: 600
            enableDynamicQuotaAllocation: false
            children: [
              {
                id: 301
                name: "WhatsApp"
                unitType: VOLUME
                quotaValidityTime: 600
                enableDynamicQuotaAllocation: false
              }
            ]
          }
          {
            id: 500
            perUnitRounding: 1073741824
            name: "Fwa"
            quotaValidityTime: 600
            enableDynamicQuotaAllocation: false
            children: []
          }
          {
            id: 400
            name: "Monetary"
            perUnitRounding: 1
            children: []
            unitType: SERVICE_SPECIFIC_UNITS
          }
        ]
        id: 0
        name: "Root"
        perUnitRounding: null
      }
    }
  ) {
      ... on InvalidField {
        errorMessage
        errorCode
      }
      ... on UpdateRatingGroupHierarchyPayload {
        root {
          children {
            id
            name
            perUnitRounding
            children {
              id
              name
            }
          }
        }
      }
      ... on RatingGroupHierarchyHasReferences {
        errorMessage
        errorCode
        ratingGroup {
          id
          name
        }
      }
      ... on RatingGroupValidationFailed {
        errorMessage
        errorCode
        root {
          id
          name
          providerId
          perUnitRounding
        }
      }
    }
  }

 

Example Response

{
  "data": {
    "updateRatingGroupHierarchy": {
      "root": {
        "children": [
          {
            "id": 100,
            "name": "Voice",
            "perUnitRounding": 60,
            "children": []
          },
          {
            "id": 200,
            "name": "Text",
            "perUnitRounding": 1,
            "children": []
          },
          {
            "id": 300,
            "name": "Data",
            "perUnitRounding": 1024,
            "children": [
              {
                "id": 301,
                "name": "WhatsApp"
              }
            ]
          },
          {
            "id": 500,
            "name": "Fwa",
            "perUnitRounding": 1073741824,
            "children": []
          },
          {
            "id": 400,
            "name": "Monetary",
            "perUnitRounding": 1,
            "children": []
          }
        ]
      }
    }
  }
}