braze_api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 1c2bc1697e96a039c034e07e5168804d4a1fe0f2e5b6b4748defbefdfc5832a7
-  data.tar.gz: b8ce7276733a843fde83473d48c20e7d6d383db28ffefa55b34951ae50d92265
+SHA1:
+  metadata.gz: 707c92f5500178e34ea769e303c2411a4474a2ec
+  data.tar.gz: 90519cbcb89c4be98f3e197d5412852bd1c1f529
 SHA512:
-  metadata.gz: d2da8ba6c4c4cf445fb17ea7b3cd34dfedad13d6255bcd7201483a7737d96f5e4cddc2ac814bbd373e8931bbf761f5dc0ad669c019ecf590884ff844d6b4ebc3
-  data.tar.gz: 216dd16457a7a0fd930b06f92b0e7973862d980b65895848f06208519cd754997352e7240f8c8d0b02e88c5a51c8df27c5d9341a129d5cd7affbaf0eab94141a
+  metadata.gz: c1187499da2c882c3d9662bdbe76531042daff6f0b40fd086cf840a898cefc4b02defaf0befe9dc50e7b6d39a67c77654cf0e968901181ebbc5519a70208c1b7
+  data.tar.gz: 3c022cbe4ebfa4262996c1c7de213b28d80bc29f9138a825e8ee8fa543290b9228977d1099f647c56a09909e206f238dca309e3196c182063f04108461c47e55

data/.github/workflows/main.yml

@@ -15,8 +15,7 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby 2.4
-      uses: actions/setup-ruby@v1
+    - uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.4
         bundler-cache: true

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+2.4.4

data/CHANGELOG.md

@@ -1,3 +1,3 @@
-# v0.1.1
+# v0.1.2
 
-Update faraday dependency to v0.15
+Adds method to delete users.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    braze_api (0.1.1)
+    braze_api (0.1.2)
       faraday (~> 0.15)
 
 GEM

data/README.md

@@ -1,4 +1,5 @@
 # BrazeAPI
+[![Gem Version](https://badge.fury.io/rb/braze_api.svg)](https://badge.fury.io/rb/braze_api) ![Lint & Test](https://github.com/appearhere/braze_api/workflows/Lint%20&%20Test/badge.svg?branch=master&event=push)
 
 The BrazeAPI gem is a Ruby wrapper for the [Braze REST API](https://www.braze.com/docs/api/basics/)
 
@@ -81,6 +82,24 @@ Called with an email and not passed fields to export will return all fields for
 ```ruby
 braze.export_users(email: 'hello@gmail.com')
 ```
+### Users Delete Endpoint:
+
+[Delete Users](https://www.braze.com/docs/api/endpoints/user_data/post_user_delete)
+
+Called with an array of external ids returns an object with the number of users queued for deletion
+```ruby
+braze.delete_users(external_ids: ['123', '345'])
+```
+
+Called with an array of braze ids returns an object with the number of users queued for deletion
+```ruby
+braze.delete_users(braze_ids: ['123', '345'])
+```
+
+Called with an array of user aliases returns an object with the number of users queued for deletion
+```ruby
+braze.delete_users(user_aliases: [ { user_alias: { alias_name: 'pete', alias_label: 'sampras' } } ])
+```
 
 ### Subscription Groups Status Set Endpoint:
 

data/lib/braze_api/client.rb

@@ -8,6 +8,7 @@ require 'braze_api/endpoints/users/track'
 require 'braze_api/endpoints/users/alias'
 require 'braze_api/endpoints/users/identify'
 require 'braze_api/endpoints/users/export'
+require 'braze_api/endpoints/users/delete'
 require 'braze_api/endpoints/subscription_groups/status'
 
 module BrazeAPI
@@ -18,6 +19,7 @@ module BrazeAPI
     include BrazeAPI::Endpoints::Users::Alias
     include BrazeAPI::Endpoints::Users::Identify
     include BrazeAPI::Endpoints::Users::Export
+    include BrazeAPI::Endpoints::Users::Delete
     include BrazeAPI::Endpoints::SubscriptionGroups::Status
 
     def initialize(api_key:, braze_url:, app_id:)

data/lib/braze_api/endpoints/users/delete.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module BrazeAPI
+  module Endpoints
+    module Users
+      # Methods to call the users/delete endpoint from a client instance
+      module Delete
+        PATH = '/users/delete'
+
+        # The main method calling the endpoint.
+        # Called with an object containing optional keys of
+        # external_ids, user_aliases, braze_ids
+        # external_ids => optional array of strings
+        # braze_ids => optional array of strings
+        # user_aliases => optional array of UserAlias objects
+        def delete_users(external_ids: [], user_aliases: [], braze_ids: [])
+          args = {}
+          args[:external_ids] = external_ids unless external_ids.empty?
+          args[:braze_ids] = braze_ids unless braze_ids.empty?
+          args[:user_aliases] = user_aliases unless user_aliases.empty?
+          post(PATH, params: args)
+        end
+      end
+    end
+  end
+end

data/lib/braze_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrazeAPI
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: braze_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Janie Amero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -120,6 +120,7 @@ files:
 - lib/braze_api/client.rb
 - lib/braze_api/endpoints/subscription_groups/status.rb
 - lib/braze_api/endpoints/users/alias.rb
+- lib/braze_api/endpoints/users/delete.rb
 - lib/braze_api/endpoints/users/export.rb
 - lib/braze_api/endpoints/users/identify.rb
 - lib/braze_api/endpoints/users/track.rb
@@ -148,7 +149,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Braze API wrapper for Ruby