Legal Service Policy Events 0.1.0 documentation

• Protobuf File Spec: legal.proto

Published Messages (basePolicy)

The service publishes one of these messages below.

basePolicyCreated

Message is sent after base policy is created. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "basePolicy": {
      "id": "string",
      "basePolicyName": "string",
      "description": "string",
      "typeId": "string",
      "policyTypeName": "string",
      "affectedClientIds": [
        "string"
      ],
      "affectedCountries": [
        "string"
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "isMandatory": true,
      "namespace": "string",
      "tags": [
        "string"
      ]
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
basePolicy	basePolicy	-

basePolicyUpdated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "basePolicy": {
      "id": "string",
      "basePolicyName": "string",
      "description": "string",
      "typeId": "string",
      "policyTypeName": "string",
      "affectedClientIds": [
        "string"
      ],
      "affectedCountries": [
        "string"
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "isMandatory": true,
      "namespace": "string",
      "tags": [
        "string"
      ]
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
basePolicy	basePolicy	-

Published Messages (policy)

The service publishes one of these messages below.

policyCreated

Message is sent when country based policy is created. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "policy": {
      "id": "string",
      "policyName": "string",
      "countryCode": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "shouldNotifyOnUpdate": true,
      "countryGroupCode": "string",
      "isMandatory": true,
      "isDefaultOpted": true,
      "basePolicyId": "string",
      "readableId": "string",
      "description": "string",
      "isDefaultSelection": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
policy	policy	-

policyUpdated

Message is sent when country base policy is updated. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "policy": {
      "id": "string",
      "policyName": "string",
      "countryCode": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "shouldNotifyOnUpdate": true,
      "countryGroupCode": "string",
      "isMandatory": true,
      "isDefaultOpted": true,
      "basePolicyId": "string",
      "readableId": "string",
      "description": "string",
      "isDefaultSelection": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
policy	policy	-

defaultPolicyUpdated

Message is sent when country based policy is set to default. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "policy": {
      "id": "string",
      "policyName": "string",
      "countryCode": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "shouldNotifyOnUpdate": true,
      "countryGroupCode": "string",
      "isMandatory": true,
      "isDefaultOpted": true,
      "basePolicyId": "string",
      "readableId": "string",
      "description": "string",
      "isDefaultSelection": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
policy	policy	-

Published Messages (versionedPolicy)

The service publishes one of these messages below.

versionedPolicyCreated

Message is sent when policy version is created. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "versionedPolicy": {
      "id": "string",
      "policyId": "string",
      "displayVersion": "string",
      "description": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "publishedDate": "2019-08-24T14:15:22Z",
      "isCrucial": true,
      "isCommitted": true,
      "isInEffect": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
versionedPolicy	versionedPolicy	-

versionedPolicyUpdated

Message is sent when policy version is updated. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "versionedPolicy": {
      "id": "string",
      "policyId": "string",
      "displayVersion": "string",
      "description": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "publishedDate": "2019-08-24T14:15:22Z",
      "isCrucial": true,
      "isCommitted": true,
      "isInEffect": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
versionedPolicy	versionedPolicy	-

versionedPolicyPublished

Message is sent when policy version is published. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "versionedPolicy": {
      "id": "string",
      "policyId": "string",
      "displayVersion": "string",
      "description": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "publishedDate": "2019-08-24T14:15:22Z",
      "isCrucial": true,
      "isCommitted": true,
      "isInEffect": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
versionedPolicy	versionedPolicy	-

Published Messages (localizedPolicy)

The service publishes one of these messages below.

localizedPolicyCreated

Message is sent when localized policy is created. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "localizedPolicy": {
      "id": "string",
      "versionedPolicyId": "string",
      "description": "string",
      "localeCode": "string",
      "contentType": "string",
      "attachmentLocation": "string",
      "attachmentChecksum": "string",
      "attachmentVersionIdentifier": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "publishedDate": "2019-08-24T14:15:22Z",
      "isDefaultSelection": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
localizedPolicy	localizedPolicy	-

localizedPolicyUpdated

Message is sent when localized policy is updated. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "localizedPolicy": {
      "id": "string",
      "versionedPolicyId": "string",
      "description": "string",
      "localeCode": "string",
      "contentType": "string",
      "attachmentLocation": "string",
      "attachmentChecksum": "string",
      "attachmentVersionIdentifier": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "publishedDate": "2019-08-24T14:15:22Z",
      "isDefaultSelection": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
localizedPolicy	localizedPolicy	-

defaultLocalizedPolicyUpdated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "localizedPolicy": {
      "id": "string",
      "versionedPolicyId": "string",
      "description": "string",
      "localeCode": "string",
      "contentType": "string",
      "attachmentLocation": "string",
      "attachmentChecksum": "string",
      "attachmentVersionIdentifier": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "publishedDate": "2019-08-24T14:15:22Z",
      "isDefaultSelection": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
localizedPolicy	localizedPolicy	-

Schemas

basePolicy

Name	Type	Description
id	string	base policy id
basePolicyName	string	name of the base policy
description	string	description of the base policy
typeId	string	policy type id
policyTypeName	string	policy type name, value can be Legal Document or Marketing Preference
affectedClientIds	array	affected oauth clients
affectedCountries	array	countries included in the base policy
createdAt	string (date-time)	time when the base policy is created
updatedAt	string (date-time)	time when the base policy is updated
isMandatory	boolean	a flag indicates whether this base policy is mandatory
namespace	string	namespace of the base policy
tags	array	tags of this base policy

policy

Name	Type	Description
id	string	policy id
policyName	string	policy name
countryCode	string	country code
createdAt	string (date-time)	time when the policy is created
updatedAt	string (date-time)	time when the policy is updated
shouldNotifyOnUpdate	boolean	a flag indicates whether need to notify users if this policy is updated
countryGroupCode	string	-
isMandatory	boolean	a flag indicates whether this policy is mandatory
isDefaultOpted	boolean	-
basePolicyId	string	-
readableId	string	-
description	string	description of this policy
isDefaultSelection	boolean	a flag indicates whether this country based policy is the default selected

versionedPolicy

Name	Type	Description
id	string	policy version id
policyId	string	policy id this policy version belongs to
displayVersion	string	display version of this policy version
description	string	description of this policy version
status	string	status of this policy version, values can be empty string if never published or PUBLISHED/ACTIVE
createdAt	string (date-time)	time when this version is created
updatedAt	string (date-time)	time when this version is updated
publishedDate	string (date-time)	time when this version is published
isCrucial	boolean	-
isCommitted	boolean	-
isInEffect	boolean	a flag indicates whether this version is currently published

localizedPolicy

Name	Type	Description
id	string	localized policy version id
versionedPolicyId	string	policy version id
description	string	description of localized policy version
localeCode	string	locale/language code
contentType	string	type of the source file, text/html or text/markdown
attachmentLocation	string	location of the source file in the storage
attachmentChecksum	string	checksum of the source file
attachmentVersionIdentifier	string	identifier of the source file
status	string	-
createdAt	string (date-time)	time when this localized version was created
updatedAt	string (date-time)	time when this localized version was updated
publishedDate	string (date-time)	-
isDefaultSelection	boolean	-

event

Name	Type	Description
id	string	-
version	integer	-
name	string	-
namespace	string	-
parentNamespace	string	-
timestamp	string (date-time)	-
clientId	string	-
userId	string	-
traceId	string	-
sessionId	string	-