braze_api_client 0.1.0

data/docs/RestApi.md

@@ -0,0 +1,427 @@
+# BrazeClient::RestApi
+
+All URIs are relative to *https://rest.iad-01.braze.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_users**](RestApi.md#delete_users) | **POST** /users/delete |  |
+| [**identify_users**](RestApi.md#identify_users) | **POST** /users/identify |  |
+| [**new_user_aliases**](RestApi.md#new_user_aliases) | **POST** /users/alias/new |  |
+| [**remove_external_ids**](RestApi.md#remove_external_ids) | **POST** /users/external_ids/remove |  |
+| [**rename_external_ids**](RestApi.md#rename_external_ids) | **POST** /users/external_ids/rename |  |
+| [**track_users**](RestApi.md#track_users) | **POST** /users/track |  |
+
+
+## delete_users
+
+> Object delete_users(body)
+
+
+
+Delete any user profile by specifying a known user identifier
+
+### Examples
+
+```ruby
+require 'time'
+require 'braze_api_client'
+# setup authorization
+BrazeClient.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = BrazeClient::RestApi.new
+body = Object # Object | 
+
+begin
+  
+  result = api_instance.delete_users(body)
+  p result
+rescue BrazeClient::ApiError => e
+  puts "Error when calling RestApi->delete_users: #{e}"
+end
+```
+
+#### Using the delete_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> delete_users_with_http_info(body)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.delete_users_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue BrazeClient::ApiError => e
+  puts "Error when calling RestApi->delete_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **Object** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## identify_users
+
+> Object identify_users(body)
+
+
+
+Identify an unidentified (alias-only) user
+
+### Examples
+
+```ruby
+require 'time'
+require 'braze_api_client'
+# setup authorization
+BrazeClient.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = BrazeClient::RestApi.new
+body = Object # Object | 
+
+begin
+  
+  result = api_instance.identify_users(body)
+  p result
+rescue BrazeClient::ApiError => e
+  puts "Error when calling RestApi->identify_users: #{e}"
+end
+```
+
+#### Using the identify_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> identify_users_with_http_info(body)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.identify_users_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue BrazeClient::ApiError => e
+  puts "Error when calling RestApi->identify_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **Object** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## new_user_aliases
+
+> Object new_user_aliases(body)
+
+
+
+Add new user aliases for existing identified users or create new unidentified users
+
+### Examples
+
+```ruby
+require 'time'
+require 'braze_api_client'
+# setup authorization
+BrazeClient.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = BrazeClient::RestApi.new
+body = Object # Object | 
+
+begin
+  
+  result = api_instance.new_user_aliases(body)
+  p result
+rescue BrazeClient::ApiError => e
+  puts "Error when calling RestApi->new_user_aliases: #{e}"
+end
+```
+
+#### Using the new_user_aliases_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> new_user_aliases_with_http_info(body)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.new_user_aliases_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue BrazeClient::ApiError => e
+  puts "Error when calling RestApi->new_user_aliases_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **Object** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## remove_external_ids
+
+> Object remove_external_ids(body)
+
+
+
+Remove your users' old deprecated external IDs. This endpoint completely removes the deprecated ID and cannot be undone.
+
+### Examples
+
+```ruby
+require 'time'
+require 'braze_api_client'
+# setup authorization
+BrazeClient.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = BrazeClient::RestApi.new
+body = Object # Object | 
+
+begin
+  
+  result = api_instance.remove_external_ids(body)
+  p result
+rescue BrazeClient::ApiError => e
+  puts "Error when calling RestApi->remove_external_ids: #{e}"
+end
+```
+
+#### Using the remove_external_ids_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> remove_external_ids_with_http_info(body)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.remove_external_ids_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue BrazeClient::ApiError => e
+  puts "Error when calling RestApi->remove_external_ids_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **Object** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## rename_external_ids
+
+> Object rename_external_ids(body)
+
+
+
+Set a new (primary) external_id for the user and deprecate their existing external_id
+
+### Examples
+
+```ruby
+require 'time'
+require 'braze_api_client'
+# setup authorization
+BrazeClient.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = BrazeClient::RestApi.new
+body = Object # Object | 
+
+begin
+  
+  result = api_instance.rename_external_ids(body)
+  p result
+rescue BrazeClient::ApiError => e
+  puts "Error when calling RestApi->rename_external_ids: #{e}"
+end
+```
+
+#### Using the rename_external_ids_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> rename_external_ids_with_http_info(body)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.rename_external_ids_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue BrazeClient::ApiError => e
+  puts "Error when calling RestApi->rename_external_ids_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **Object** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## track_users
+
+> <UsersTrackResponse> track_users(users_track_request)
+
+
+
+Record custom events, purchases, and update user profile attributes
+
+### Examples
+
+```ruby
+require 'time'
+require 'braze_api_client'
+# setup authorization
+BrazeClient.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = BrazeClient::RestApi.new
+users_track_request = BrazeClient::UsersTrackRequest.new({attributes: [BrazeClient::Event.new({name: 'name_example', time: Time.now})]}) # UsersTrackRequest | 
+
+begin
+  
+  result = api_instance.track_users(users_track_request)
+  p result
+rescue BrazeClient::ApiError => e
+  puts "Error when calling RestApi->track_users: #{e}"
+end
+```
+
+#### Using the track_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UsersTrackResponse>, Integer, Hash)> track_users_with_http_info(users_track_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.track_users_with_http_info(users_track_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UsersTrackResponse>
+rescue BrazeClient::ApiError => e
+  puts "Error when calling RestApi->track_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **users_track_request** | [**UsersTrackRequest**](UsersTrackRequest.md) |  |  |
+
+### Return type
+
+[**UsersTrackResponse**](UsersTrackResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/UsersTrackRequest.md

@@ -0,0 +1,18 @@
+# BrazeClient::UsersTrackRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attributes** | [**Array<Event>**](Event.md) |  |  |
+
+## Example
+
+```ruby
+require 'braze_api_client'
+
+instance = BrazeClient::UsersTrackRequest.new(
+  attributes: null
+)
+```
+

data/docs/UsersTrackResponse.md

@@ -0,0 +1,24 @@
+# BrazeClient::UsersTrackResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+| **attributes_processed** | **Integer** |  | [optional] |
+| **events_processed** | **Integer** |  | [optional] |
+| **purchases_processed** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'braze_api_client'
+
+instance = BrazeClient::UsersTrackResponse.new(
+  message: null,
+  attributes_processed: null,
+  events_processed: null,
+  purchases_processed: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+parent_path=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
+cd "$parent_path"
+
+if [ -z "$1" ]; then
+  echo "Provide a commit message"
+  exit 1
+fi
+
+git init -b main
+git remote add origin git@github.com:braze-inc/braze-api-client-ruby.git
+git fetch
+git branch main origin/main
+git add .
+git commit -m "$1"
+git push origin main