Class: Mailfloss::Resources::Erasures

Inherits:
Base
  • Object
show all
Defined in:
lib/mailfloss/resources.rb,
sig/resources.rbs

Overview

POST /erasures

Instance Attribute Summary

Attributes inherited from Base

#client

Instance Method Summary collapse

Methods inherited from Base

#encode, #initialize

Constructor Details

This class inherits a constructor from Mailfloss::Resources::Base

Instance Method Details

#create(emails:, webhook_url: nil, idempotency_key: nil) ⇒ Hash

POST /erasures — GDPR/CCPA delete-my-data requests.

Parameters:

  • emails (Array<String>) —

    addresses to erase

  • webhook_url (String, nil) (defaults to: nil) —

    optional completion callback URL

Returns:

  • (Hash) —

    { success: }



287
288
289
290
291
 
# File 'lib/mailfloss/resources.rb', line 287

def create(emails:, webhook_url: nil, idempotency_key: nil)
  body = { emails: emails }
  body[:webhook_url] = webhook_url if webhook_url
  client.request(:post, "/erasures", body: body, idempotency_key: idempotency_key)
end