Fee Model account migration completed

Event generated when a Fee Model account migration finishes and the result is reported. Result can be either SUCCESS or FAIL.

Type: object
Additional properties: false
Domain: migration
Event: fee_model_account_outgoing
Version: 1

|
code required

Title: Migration message code
Description: A code identifying the type of success or error being reported
Type: string
Example:
MIGR-0001
MIGR-0404
MIGR-0500

message required

Title: Result message
Description: Message describing the fee model account migration result
Type: string
Example:
Fee Model Accounts migrated with success!
Model with the provided key does not exist
Internal error migrating fee model accounts

migration required

Title: Migration Identifiers Object
Description: Identifiers sent on the start of migration process
Type: object
Additional properties: false
Example:

{
    "id": "migration-id",
    "account_ids": [
        "account-1",
        "account-43"
    ]
}
id required

Title: Migration Identifier
Type: string
Example:
migration-id

account_ids required

Type: array
Example:

[
    "account-123"
]
status required

Title: Migration status
Description: If the result of card migration was success or not
Type: string
Must be one of the following:
SUCCESS
FAIL
Example:
SUCCESS
FAIL

entity

Title: Pismo generated Fee Model account information
Type: object
Additional properties: false
Example:

{
    "fee_model_id": "b143d49d-d480-4553-8243-4fb4076519e6",
    "account_ids": [
        10000020,
        1000021
    ]
}
account_ids

Type: array
Example:

[
    9999
]
fee_model_id

Title: Fee Model Identifier
Description: Fee Model identifier as generated by pismo and sent on the start of the migration.
Type: string
Example:
7e5bb331-004d-4f9b-aa74-51fa9abd8975

operation

Title: Migration Operation
Description: If the Card migration is a creation or update
Type: string
Must be one of the following:
CREATION
UPDATE
Example:
UPDATE
CREATION

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$id": "https://pismo.io/events/migration/fee_model_account_outgoing-1.json",
    "type": "object",
    "title": "Fee Model account migration completed",
    "description": "Event generated when a Fee Model account migration finishes and the result is reported. Result can be either `SUCCESS` or `FAIL`.",
    "examples": [
        {
            "operation": "UPDATE",
            "status": "SUCCESS",
            "code": "MIGR-0001",
            "message": "Fee Model Accounts migrated with success!",
            "migration": {
                "id": "migration-id"
            },
            "entity": {
                "account_ids": [
                    10000015,
                    11111112
                ],
                "fee_model_id": "6326418c-b297-403c-a49d-18ce64f5b685",
                "migration": {
                    "account_ids": [
                        "account-migration-1",
                        "account-migration-2"
                    ]
                }
            }
        }
    ],
    "required": [
        "code",
        "message",
        "migration",
        "status"
    ],
    "properties": {
        "code": {
            "$id": "#/properties/code",
            "type": "string",
            "title": "Migration message code",
            "description": "A code identifying the type of success or error being reported",
            "examples": [
                "MIGR-0001",
                "MIGR-0404",
                "MIGR-0500"
            ]
        },
        "message": {
            "$id": "#/properties/message",
            "type": "string",
            "title": "Result message",
            "description": "Message describing the fee model account migration result",
            "examples": [
                "Fee Model Accounts migrated with success!",
                "Model with the provided key does not exist",
                "Internal error migrating fee model accounts"
            ]
        },
        "migration": {
            "$id": "#/properties/migration",
            "type": "object",
            "title": "Migration Identifiers Object",
            "description": "Identifiers sent on the start of migration process",
            "examples": [
                {
                    "id": "migration-id",
                    "account_ids": [
                        "account-1",
                        "account-43"
                    ]
                }
            ],
            "required": [
                "id",
                "account_ids"
            ],
            "properties": {
                "id": {
                    "$id": "#/properties/migration/properties/id",
                    "type": "string",
                    "title": "Migration Identifier",
                    "examples": [
                        "migration-id"
                    ]
                },
                "account_ids": {
                    "$id": "#/properties/migration/properties/account_ids",
                    "type": "array",
                    "title": "Account Migration Identifiers",
                    "description": "Account Migration identifiers, as sent on the start of the migration, of the accounts being associated with the fee model",
                    "items": {
                        "type": "string",
                        "examples": [
                            "account-123"
                        ]
                    }
                }
            },
            "additionalProperties": false
        },
        "status": {
            "$id": "#/properties/status",
            "type": "string",
            "title": "Migration status",
            "description": "If the result of card migration was success or not",
            "enum": [
                "SUCCESS",
                "FAIL"
            ],
            "examples": [
                "SUCCESS",
                "FAIL"
            ]
        },
        "entity": {
            "$id": "#/properties/entity",
            "type": "object",
            "title": "Pismo generated Fee Model account information",
            "examples": [
                {
                    "fee_model_id": "b143d49d-d480-4553-8243-4fb4076519e6",
                    "account_ids": [
                        10000020,
                        1000021
                    ]
                }
            ],
            "properties": {
                "account_ids": {
                    "$id": "#/properties/entity/properties/account_ids",
                    "type": "array",
                    "title": "Account Identifiers",
                    "description": "Account identifiers, previously generated by pismo, of the accounts being associated with the fee model",
                    "items": {
                        "type": "integer",
                        "examples": [
                            9999
                        ]
                    }
                },
                "fee_model_id": {
                    "$id": "#/properties/entity/properties/fee_model_id",
                    "type": "string",
                    "title": "Fee Model Identifier",
                    "description": "Fee Model identifier as generated by pismo and sent on the start of the migration.",
                    "examples": [
                        "7e5bb331-004d-4f9b-aa74-51fa9abd8975"
                    ]
                }
            },
            "additionalProperties": false
        },
        "operation": {
            "$id": "#/properties/operation",
            "type": "string",
            "title": "Migration Operation",
            "description": "If the Card migration is a creation or update",
            "enum": [
                "CREATION",
                "UPDATE"
            ],
            "examples": [
                "UPDATE",
                "CREATION"
            ]
        }
    },
    "additionalProperties": false
}
{
    "operation": "UPDATE",
    "status": "SUCCESS",
    "code": "MIGR-0001",
    "message": "Fee Model Accounts migrated with success!",
    "migration": {
        "id": "migration-id"
    },
    "entity": {
        "account_ids": [
            10000015,
            11111112
        ],
        "fee_model_id": "6326418c-b297-403c-a49d-18ce64f5b685",
        "migration": {
            "account_ids": [
                "account-migration-1",
                "account-migration-2"
            ]
        }
    }
}