Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

[SaaS Connector] Outreach (Erasures) #619

Merged
merged 54 commits into from
Jun 13, 2022
Merged

Conversation

galvana
Copy link
Collaborator

@galvana galvana commented Jun 8, 2022

Purpose

Adds erasure functionality for Outreach.

Changes

The following endpoints were added as deletes

prospects
POST /api/v2/complianceRequests

{
  "data": {
    "type": "complianceRequest",
    "attributes": {
      "requester_email": "<requester_email>",
      "request_type": "Delete",
      "object_type": "Prospect",
      "request_object_email": "<email>"
    }
  }
}

recipients
POST /api/v2/complianceRequests

{
  "data": {
    "type": "complianceRequest",
    "attributes": {
      "requester_email": "<requester_email>",
      "request_type": "Delete",
      "object_type": "Recipient",
      "request_object_email": "<email>"
    }
  }
}

Checklist

  • Update CHANGELOG.md file
    • Merge in main so the most recent CHANGELOG.md file is being appended to
    • Add description within the Unreleased section in an appropriate category. Add a new category from the list at the top of the file if the needed one isn't already there.
    • Add a link to this PR at the end of the description with the PR number as the text. example: #1
  • Good unit test/integration test coverage

Ticket

Fixes #618

galvana added 30 commits May 11, 2022 21:05
Misc cleanup associated with change
…xpires_in value in the access token response
@galvana galvana linked an issue Jun 8, 2022 that may be closed by this pull request
@galvana galvana changed the title Starting point for Outreach erasures [SaaS Connector] Outreach (Erasures) Jun 8, 2022
@galvana galvana self-assigned this Jun 8, 2022
@galvana galvana added SaaS Connector The issue indicates development work for a specific SaaS application enhancement New feature or request DON'T MERGE labels Jun 8, 2022
connector_param: requester_email
- name: email
identity: email
body: |
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In YAML the pipe | is used to indicate a "block scalar" value (multiline text). This allows us to denote JSON payloads inline with YAML while avoiding having to escape single or double quotes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's cool, good thing i got to review this PR and learn something new :)

@@ -169,6 +169,7 @@ class ConnectorParam(BaseModel):
"""Used to define the required parameters for the connector (user-provided and constants)"""

name: str
description: Optional[str]
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this to include descriptions for fields that need more of an explanation than what can just be assumed from the name alone. Currently there is no additional logic in Fidesops that makes use of this information but this could be helpful when for when we have a UI to create/manage SaaS configs.

@galvana galvana marked this pull request as ready for review June 9, 2022 22:39
@Kelsey-Ethyca Kelsey-Ethyca requested a review from adamsachs June 10, 2022 15:32
Copy link
Contributor

@adamsachs adamsachs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

generally looks good, one very minor comment on whether to include a certain config in the .toml but if i'm mistaken on that then let me know and i'll 👍

saas_config.toml Outdated
requester_email = ""
identity_email = ""
erasure_identity_email = ""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this is dynamically generated in the fixture (which i like), does it need to be in the toml? (specifically the erasure_identity_email). it seems like it could be misleading. but my understanding may be off.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good point, removed!

Removing unnecessary config value from saas_config.toml
Copy link
Contributor

@adamsachs adamsachs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this all looks good so i'm going to approve but @galvana seems like a merge conflict arose (just FYI)

@galvana galvana merged commit bc6ad23 into main Jun 13, 2022
@galvana galvana deleted the 618-saas-connector-outreach-erasure branch June 13, 2022 22:16
sanders41 pushed a commit that referenced this pull request Sep 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request SaaS Connector The issue indicates development work for a specific SaaS application
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[SaaS Connector] Outreach [Erasure]
2 participants