Legal Service Agreement Events 0.1.0 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

• Specification ID: http://legal-service
• Protobuf File Spec: agreement.proto

Table of Contents

• Operations
  • PUB agreement

Operations

PUB agreement Operation

Accepts one of the following messages:

Message agreementCreated

message is sent after user accepts legal documentation

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.agreement	object	-	-	-	additional properties are allowed
payload.agreement.policyId	string	policy id	-	-	-
payload.agreement.policyVersionId	string	policy version id	-	-	-
payload.agreement.policyName	string	policy name	-	-	-
payload.agreement.displayVersion	string	display version of policy version	-	-	-
payload.agreement.localizedPolicyVersionId	string	localized policy version id	-	-	-
payload.agreement.localizedDescription	string	description of localized policy	-	-	-
payload.agreement.isAccepted	boolean	a flag indicates whether user accepted this policy	-	-	-
payload.agreement.userId	string	user id, can be publisher/game user id	-	-	-
payload.x-uid0	-	-	"AnonymousSchema1"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "agreement": {
      "policyId": "string",
      "policyVersionId": "string",
      "policyName": "string",
      "displayVersion": "string",
      "localizedPolicyVersionId": "string",
      "localizedDescription": "string",
      "isAccepted": true,
      "userId": "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"
}

Message agreementUpdated

message is sent after user accepts legal documentation

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.agreement	object	-	-	-	additional properties are allowed
payload.agreement.policyId	string	policy id	-	-	-
payload.agreement.policyVersionId	string	policy version id	-	-	-
payload.agreement.policyName	string	policy name	-	-	-
payload.agreement.displayVersion	string	display version of policy version	-	-	-
payload.agreement.localizedPolicyVersionId	string	localized policy version id	-	-	-
payload.agreement.localizedDescription	string	description of localized policy	-	-	-
payload.agreement.isAccepted	boolean	a flag indicates whether user accepted this policy	-	-	-
payload.agreement.userId	string	user id, can be publisher/game user id	-	-	-
payload.x-uid0	-	-	"AnonymousSchema2"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "agreement": {
      "policyId": "string",
      "policyVersionId": "string",
      "policyName": "string",
      "displayVersion": "string",
      "localizedPolicyVersionId": "string",
      "localizedDescription": "string",
      "isAccepted": true,
      "userId": "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"
}