gcdtech/module-cyclops

A module for retrieving and sending data to Cyclops

Module.Cyclops

Module for retrieving and sending data to cyclops, _(*1)

Commands

• PushStateToCyclopsCommand.php Abstract Custard Command for pushing the state of Cyclops Customers., _(*2)

• PushDeletedToCyclopsCommand.php Deletes a list of Cyclops Customers., _(*3)

• PushStaleToCyclopsCommand.php Updates a list of Cyclops Customers' brand opt ins that have failed before., _(*4)

• PullChangesFromCyclopsCommand.php Retrieves a list of updates made to Cyclops Customers' brand opt ins, allowing us to update project specific members to the same status., _(*5)

Entities

• CustomerEntity.php Used for most of our use cases, this combines a CyclopsIdentityEntity with their BrandOptIn value., _(*6)

• CyclopsIdentityEntity.php How we identify a Cyclops Customer - made up of email, id, forename and surname., _(*7)

• CyclopsCustomerListEntity.php Made up of an array of CustomerEntities, used in our "Push to Cyclops" use cases., _(*8)

Exceptions

Cyclops API has a few exceptions it throws for specific end points. The ones we handle are:, _(*9)

• ConflictException.php Thrown if the parameters we send are invalid., _(*10)

• CustomerNotFoundException.php Thrown if the customer we are updating or deleting is not found in Cyclops API., _(*11)

• CyclopsException.php Base exception that all others extend., _(*12)

• UserForbiddenException.php Thrown if the user we access Cyclops API as does not have read or write permissions., _(*13)

Settings

The url, username and password we use to access the Cyclops API are set in CyclopsSettings.php, _(*14)

Use Cases

• DeleteCustomerUseCase.php, _(*15)

• GetBrandOptInStatusChangesUseCase.php, _(*16)

• GetBrandOptInUseCase.php, _(*17)

• PullChangesFromCyclopsUseCase.php, _(*18)

• PushDeletedToCyclopsUseCase.php, _(*19)

• PushStaleToCyclopsUseCase.php, _(*20)