Skip to content

Commit

Permalink
Add migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
dvacca-onfido committed Oct 23, 2024
1 parent 308b931 commit ba57077
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Migration Guide

## Upgrading from 7.x to 8.x

### Core Resources

- Applicants
- Replace broken `ConsentsBuilder` object with a list of `ApplicantConsentBuilder` ones
- Workflow Runs
- Rename `WorkflowRunSharedLink` object into `WorkflowRunLink`
- Define `WorkflowRunStatus` enum for storing status information
- Rename `WorkflowRunResponseError` object into `WorkflowRunError`
- Documents
- Reuse already existent `DocumentTypes` enum when uploading documents

### Other Endpoints

- Webhooks
- Define `WebhookEventObjectStatus` enum to collect webhook event object's status
- Define `WebhookEventResourceType` enum to collect webhhok event resource's type
- Define `WebhookEventPayloadResource` object to store webhook payload's contents
- Checks
- Rename `Check::Status*` enum into `CheckStatus::*` for accessing checks status
- Reports
- Remove properties from `DeviceIntelligenceBreakdownPropertiesDevice` object: `true_os`, `os_anomaly`, `rooted` and `remote_software`
- Remove properties from `DeviceIntelligenceBreakdownPropertiesIp` object: `vpn_detection`, `proxy_detection` and `type`
- Deprecate `records` object from `WatchlistStandardProperties` and `WatchlistAmlProperties` objects (includes `WatchlistPepsOnly` and `WatchlistSanctionsOnly` ones)

### OpenAPI generator

- Version upgraded from 7.6.0 to 7.9.0

0 comments on commit ba57077

Please sign in to comment.