braze_api_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f798e36c422e6bf7b20f8a03b3eb14a62f7a33c2169220b716f1f28d4c04155
+  data.tar.gz: 65ef0db1d80017692361d0f54d7347da78b91fc6e378edf1030767682ad15053
+SHA512:
+  metadata.gz: e32681c682c8f6702c7b99dc0d7703b9280abfbecf1a3016d3a8a7563ccf377d93ed28bdc0f574324d4a32d3d0d411ee9c3d0ea19ec695131341ed184dcb6d0d
+  data.tar.gz: a1faaf88c9a086f4897fb3d1f3b4999f4a3f467e7fef2253a48c3e88a578947d457bfbfe715da0eab5f457efc09461f5627f40ad53ebb6a74d5645b25381d84c

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/LICENSE.md

@@ -0,0 +1,9 @@
+Copyright 2022 Braze, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Customer acknowledges and agrees that this software is being provided at no charge by Braze for Customer's use in connection with the Braze Services and that this software is separate from, and not part of, the Braze Services.  In addition, THIS SOFTWARE IS PROVIDED BY BRAZE "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BRAZE BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,191 @@
+# Braze API Ruby Client ![Tests](https://img.shields.io/github/workflow/status/braze-inc/braze-api-client-ruby/rspec) [![Gem Version](https://img.shields.io/gem/v/braze_client.svg)](https://rubygems.org/gems/braze_client)
+
+Track users, send messages, export data, and more
+
+> :warning: **This library is in early development, subject to breaking changes, and may be discontinued.**
+
+## Installation
+
+Add the following line to your Gemfile:
+
+```
+gem "braze_api_client"
+```
+
+Followed by running:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install braze_api_client
+```
+
+## Configuration
+
+Generate an [API key](https://www.braze.com/docs/api/api_key/) with permissions for the endpoints you need to call.
+
+You can determine which API host to use based on your Braze dashboard URL:
+
+|Instance|URL|API Host|
+|---|---|---|
+|US-01| `https://dashboard-01.braze.com` | `rest.iad-01.braze.com` |
+|US-02| `https://dashboard-02.braze.com` | `rest.iad-02.braze.com` |
+|US-03| `https://dashboard-03.braze.com` | `rest.iad-03.braze.com` |
+|US-04| `https://dashboard-04.braze.com` | `rest.iad-04.braze.com` |
+|US-05| `https://dashboard-05.braze.com` | `rest.iad-05.braze.com` |
+|US-06| `https://dashboard-06.braze.com` | `rest.iad-06.braze.com` |
+|US-08| `https://dashboard-08.braze.com` | `rest.iad-08.braze.com` |
+|EU-01| `https://dashboard-01.braze.eu` | `rest.fra-01.braze.eu` |
+|EU-02| `https://dashboard-02.braze.eu` | `rest.fra-02.braze.eu` |
+
+
+```ruby
+# Load the gem
+require 'braze_api_client'
+
+# Setup authorization
+BrazeClient.configure do |config|
+  config.access_token = 'YOUR_API_KEY'
+  config.server_variables[:host] = 'rest.YOUR-REGION.braze.com'
+end
+
+```
+
+
+## Endpoints
+### Track users
+
+You can use the `/users/track` [endpoint](https://www.braze.com/docs/api/endpoints/user_data/post_user_track/) to record custom events, purchases, and update user profile attributes. Provide up to 75 of each type in a single request.
+
+```ruby
+braze_api = BrazeClient::RestApi.new
+
+begin
+  result = braze_api.track_users({
+    :events => [{
+      :external_id => "user123",
+      :app_id => "yourappid",
+      :time => Time.now,
+      :name => "watched_trailer",
+    }],
+    :attributes => [{
+      :external_id => "user456",
+      :first_name => "Alice",
+      :favorite_color => "blue",
+    }],
+    :purchases => [
+      :external_id => "user456",
+      :app_id => "yourappid",
+      :time => Time.now,
+      :product_id => "product_name",
+      :currency => "USD",
+      :price => 12.12,
+      :quantity => 2,
+      :properties => {
+        :color => "blue",
+      }
+    ]
+  })
+  p result
+rescue BrazeClient::ApiError => e
+  puts "Exception when calling RestApi->users_track: #{e}"
+end
+```
+
+### Delete users
+```ruby
+braze_api = BrazeClient::RestApi.new
+
+begin
+  result = braze_api.delete_users({
+    # use any or all of these 3 identifier types
+    :external_ids => ["user1", "user2"],
+    :user_aliases => ["alias123", "alias456"],
+    :braze_ids => ["braze_identifier1", "braze_identifier2"],
+  })
+  p result
+rescue BrazeClient::ApiError => e
+  puts "Exception when calling RestApi->users_track: #{e}"
+end
+```
+
+### Create new user aliases
+```ruby
+braze_api = BrazeClient::RestApi.new
+
+begin
+  result = braze_api.new_user_aliases({
+    :user_aliases => [{
+      :external_id => "user123", # optional
+      :alias_name => "c123",
+      :alias_label => "customer_id",
+    }]
+  })
+  p result
+rescue BrazeClient::ApiError => e
+  puts "Exception when calling RestApi->users_track: #{e}"
+end
+```
+
+### Identify users
+```ruby
+braze_api = BrazeClient::RestApi.new
+
+begin
+  result = braze_api.identify_users({
+    :aliases_to_identify => [{
+      :external_id => "user123",
+      :user_alias => {
+        :alias_name => "c123",
+        :alias_label => "customer_id",
+      }
+    }],
+  })
+  p result
+rescue BrazeClient::ApiError => e
+  puts "Exception when calling RestApi->users_track: #{e}"
+end
+```
+
+### Rename external IDs
+```ruby
+braze_api = BrazeClient::RestApi.new
+
+begin
+  result = braze_api.rename_exernal_ids({
+    :external_id_renames => [{
+      :current_external_id => "user123",
+      :new_external_id => "u123",
+    }],
+  })
+  p result
+rescue BrazeClient::ApiError => e
+  puts "Exception when calling RestApi->users_track: #{e}"
+end
+```
+
+### Remove external IDs
+```ruby
+braze_api = BrazeClient::RestApi.new
+
+begin
+  result = braze_api.remove_exernal_ids({
+    :external_ids => ["user123", "user456"],
+  })
+  p result
+rescue BrazeClient::ApiError => e
+  puts "Exception when calling RestApi->users_track: #{e}"
+end
+```
+
+## Contributing
+
+This library is automatically generated. To make changes, please see [braze-api-client-codegen](https://github.com/braze-inc/braze-api-client-codegen)
+
+- API version: 0.1.0
+- Package version: 0.1.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/braze_api_client.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Braze
+
+#Track users, send messages, export data, and more
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.1
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "braze_api_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "braze_api_client"
+  s.version     = BrazeClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["OpenAPI-Generator"]
+  s.email       = [""]
+  s.homepage    = "https://openapi-generator.tech"
+  s.summary     = "Braze Ruby Gem"
+  s.description = "Track users, send messages, export data, and more"
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 2.4"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/Attributes.md

@@ -0,0 +1,58 @@
+# BrazeClient::Attributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **country** | **String** |  | [optional] |
+| **current_location** | [**AttributesCurrentLocation**](AttributesCurrentLocation.md) |  | [optional] |
+| **date_of_first_session** | **Time** |  | [optional] |
+| **date_of_last_session** | **Time** |  | [optional] |
+| **dob** | **Date** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **email_subscribe** | **String** |  | [optional] |
+| **email_open_tracking_disabled** | **Boolean** |  | [optional] |
+| **email_click_tracking_disabled** | **Boolean** |  | [optional] |
+| **facebook** | [**AttributesFacebook**](AttributesFacebook.md) |  | [optional] |
+| **first_name** | **String** |  | [optional] |
+| **gender** | **String** |  | [optional] |
+| **home_city** | **String** |  | [optional] |
+| **language** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **marked_email_as_spam_at** | **Time** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **push_subscribe** | **String** |  | [optional] |
+| **push_tokens** | [**Array<AttributesPushTokens>**](AttributesPushTokens.md) |  | [optional] |
+| **time_zone** | **String** |  | [optional] |
+| **twitter** | [**AttributesTwitter**](AttributesTwitter.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'braze_api_client'
+
+instance = BrazeClient::Attributes.new(
+  country: null,
+  current_location: null,
+  date_of_first_session: null,
+  date_of_last_session: null,
+  dob: null,
+  email: null,
+  email_subscribe: null,
+  email_open_tracking_disabled: null,
+  email_click_tracking_disabled: null,
+  facebook: null,
+  first_name: null,
+  gender: null,
+  home_city: null,
+  language: null,
+  last_name: null,
+  marked_email_as_spam_at: null,
+  phone: null,
+  push_subscribe: null,
+  push_tokens: null,
+  time_zone: null,
+  twitter: null
+)
+```
+

data/docs/AttributesArray.md

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

data/docs/AttributesCurrentLocation.md

@@ -0,0 +1,20 @@
+# BrazeClient::AttributesCurrentLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **latitude** | **Float** |  | [optional] |
+| **longitude** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'braze_api_client'
+
+instance = BrazeClient::AttributesCurrentLocation.new(
+  latitude: null,
+  longitude: null
+)
+```
+

data/docs/AttributesFacebook.md

@@ -0,0 +1,22 @@
+# BrazeClient::AttributesFacebook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **likes** | **Array<String>** |  | [optional] |
+| **num_friends** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'braze_api_client'
+
+instance = BrazeClient::AttributesFacebook.new(
+  id: null,
+  likes: null,
+  num_friends: null
+)
+```
+

data/docs/AttributesPushTokens.md

@@ -0,0 +1,22 @@
+# BrazeClient::AttributesPushTokens
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+| **token** | **String** |  |  |
+| **device_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'braze_api_client'
+
+instance = BrazeClient::AttributesPushTokens.new(
+  app_id: null,
+  token: null,
+  device_id: null
+)
+```
+

data/docs/AttributesTwitter.md

@@ -0,0 +1,26 @@
+# BrazeClient::AttributesTwitter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **screen_name** | **String** |  | [optional] |
+| **followers_count** | **Integer** |  | [optional] |
+| **friends_count** | **Integer** |  | [optional] |
+| **statuses_count** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'braze_api_client'
+
+instance = BrazeClient::AttributesTwitter.new(
+  id: null,
+  screen_name: null,
+  followers_count: null,
+  friends_count: null,
+  statuses_count: null
+)
+```
+

data/docs/Event.md

@@ -0,0 +1,26 @@
+# BrazeClient::Event
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **time** | **Time** |  |  |
+| **app_id** | **String** |  | [optional] |
+| **properties** | **Object** |  | [optional] |
+| **_update_existing_only** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'braze_api_client'
+
+instance = BrazeClient::Event.new(
+  name: null,
+  time: null,
+  app_id: null,
+  properties: null,
+  _update_existing_only: null
+)
+```
+

data/docs/EventsArray.md

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

data/docs/GeneralError.md

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

data/docs/Identifier.md

@@ -0,0 +1,51 @@
+# BrazeClient::Identifier
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'braze_api_client'
+
+BrazeClient::Identifier.openapi_one_of
+# =>
+# [
+#   :'IdentifierOneOf',
+#   :'IdentifierOneOf1',
+#   :'IdentifierOneOf2'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'braze_api_client'
+
+BrazeClient::Identifier.build(data)
+# => #<IdentifierOneOf:0x00007fdd4aab02a0>
+
+BrazeClient::Identifier.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `IdentifierOneOf`
+- `IdentifierOneOf1`
+- `IdentifierOneOf2`
+- `nil` (if no type matches)
+

data/docs/IdentifierOneOf.md

@@ -0,0 +1,18 @@
+# BrazeClient::IdentifierOneOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'braze_api_client'
+
+instance = BrazeClient::IdentifierOneOf.new(
+  external_id: null
+)
+```
+

data/docs/IdentifierOneOf1.md

@@ -0,0 +1,18 @@
+# BrazeClient::IdentifierOneOf1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_alias** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'braze_api_client'
+
+instance = BrazeClient::IdentifierOneOf1.new(
+  user_alias: null
+)
+```
+

data/docs/IdentifierOneOf2.md

@@ -0,0 +1,18 @@
+# BrazeClient::IdentifierOneOf2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **braze_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'braze_api_client'
+
+instance = BrazeClient::IdentifierOneOf2.new(
+  braze_id: null
+)
+```
+