bombbomb 1.0.0

data/docs/UtilitiesApi.md

@@ -0,0 +1,204 @@
+# BombBomb::UtilitiesApi
+
+All URIs are relative to *https://dev.api.bombbomb.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_o_auth_client**](UtilitiesApi.md#create_o_auth_client) | **POST** /oauthclient | Create an OAuth Client
+[**delete_o_auth_client**](UtilitiesApi.md#delete_o_auth_client) | **DELETE** /oauthclient/{id} | Delete an OAuth Client
+[**get_o_auth_clients**](UtilitiesApi.md#get_o_auth_clients) | **GET** /oauthclient | Lists OAuth Clients
+[**get_spec**](UtilitiesApi.md#get_spec) | **GET** /spec | Describes this api
+
+
+# **create_o_auth_client**
+> OAuthClient create_o_auth_client(name, redirect_uri)
+
+Create an OAuth Client
+
+Creates an OAuth Client managed by the user
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+# setup authorization
+BombBomb.configure do |config|
+  # Configure OAuth2 access token for authorization: BBOAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BombBomb::UtilitiesApi.new
+
+name = "name_example" # String | The name of the OAuth client. e.g. MyCrm DEV, or MyCrm PROD
+
+redirect_uri = "redirect_uri_example" # String | The URI to direct the client to after logging in.
+
+
+begin
+  #Create an OAuth Client
+  result = api_instance.create_o_auth_client(name, redirect_uri)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling UtilitiesApi->create_o_auth_client: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The name of the OAuth client. e.g. MyCrm DEV, or MyCrm PROD | 
+ **redirect_uri** | **String**| The URI to direct the client to after logging in. | 
+
+### Return type
+
+[**OAuthClient**](OAuthClient.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **delete_o_auth_client**
+> delete_o_auth_client(id)
+
+Delete an OAuth Client
+
+Deletes an OAuth Client managed by the user
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+# setup authorization
+BombBomb.configure do |config|
+  # Configure OAuth2 access token for authorization: BBOAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BombBomb::UtilitiesApi.new
+
+id = "id_example" # String | The id of the OAuth Client
+
+
+begin
+  #Delete an OAuth Client
+  api_instance.delete_o_auth_client(id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling UtilitiesApi->delete_o_auth_client: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The id of the OAuth Client | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_o_auth_clients**
+> Array<OAuthClient> get_o_auth_clients
+
+Lists OAuth Clients
+
+Enumerates OAuth Clients managed by the user
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+# setup authorization
+BombBomb.configure do |config|
+  # Configure OAuth2 access token for authorization: BBOAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BombBomb::UtilitiesApi.new
+
+begin
+  #Lists OAuth Clients
+  result = api_instance.get_o_auth_clients
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling UtilitiesApi->get_o_auth_clients: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<OAuthClient>**](OAuthClient.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_spec**
+> get_spec
+
+Describes this api
+
+Describes methods available through the API.
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+
+api_instance = BombBomb::UtilitiesApi.new
+
+begin
+  #Describes this api
+  api_instance.get_spec
+rescue BombBomb::ApiError => e
+  puts "Exception when calling UtilitiesApi->get_spec: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/VideoEmailPrompt.md

@@ -0,0 +1,25 @@
+# BombBomb::VideoEmailPrompt
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The identifier of the prompt. Read Only. | [optional] 
+**user_id** | **String** | The prompt's owner. Read Only. | [optional] 
+**template_id** | **String** | Optional. The email template to be used in the sent email, if none supplied, the users' default will be applied. | [optional] 
+**email_subject_line** | **String** | The subject line of the final email | 
+**email_content** | **String** | The HTML content of the final email | 
+**to_email_addresses** | **Array<String>** | Email addresses to send the final email to, can be mixed with listIds. | [optional] 
+**to_lists** | **Array<String>** | List Ids to send the final email to | [optional] 
+**jericho_id** | **String** | If sent in a jericho context, this will have the jericho id | [optional] 
+**prompt_subject** | **String** | The prompt's subject line | 
+**prompt_html** | **String** | The HTML body of the prompt | 
+**send_without_video** | **BOOLEAN** | Whether to send the email if no video is recorded. If set to require a video, and none is added before the videoDueDate, the prompt is cancelled. | [optional] 
+**video_due_date** | **DateTime** | When the video must be recorded by | [optional] 
+**scheduled_send_date** | **DateTime** | When the final email is scheduled to be sent | 
+**video_id** | **String** | The video that was added to the prompt. Read Only. | [optional] 
+**email_id** | **String** | The email that was created by the prompt Read Only. | [optional] 
+**job_id** | **String** | The job sent by the prompt Read Only. | [optional] 
+**status** | **Integer** | The status of the prompt: created = 0, sent = 10, recorded = 20, job_created = 30, timed_out = 40, declined = 50 Read Only | [optional] 
+**do_not_apply_template** | **BOOLEAN** | Controls whether a user template is applied to the message as it is sent | [optional] 
+
+

data/docs/WebhooksApi.md

@@ -0,0 +1,207 @@
+# BombBomb::WebhooksApi
+
+All URIs are relative to *https://dev.api.bombbomb.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_web_hook**](WebhooksApi.md#add_web_hook) | **POST** /webhook | Add Webhook
+[**delete_web_hook**](WebhooksApi.md#delete_web_hook) | **DELETE** /webhook/{hookId} | Deletes Webhook
+[**get_web_hooks**](WebhooksApi.md#get_web_hooks) | **GET** /webhook/ | Lists Webhooks
+[**send_webhook_example**](WebhooksApi.md#send_webhook_example) | **POST** /webhook/test | Sends test Webhook
+
+
+# **add_web_hook**
+> BBWebHook add_web_hook(hook_url)
+
+Add Webhook
+
+Idempotently adds a Webhook url
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+# setup authorization
+BombBomb.configure do |config|
+  # Configure OAuth2 access token for authorization: BBOAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BombBomb::WebhooksApi.new
+
+hook_url = "hook_url_example" # String | The Url of your listener
+
+
+begin
+  #Add Webhook
+  result = api_instance.add_web_hook(hook_url)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling WebhooksApi->add_web_hook: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **hook_url** | **String**| The Url of your listener | 
+
+### Return type
+
+[**BBWebHook**](BBWebHook.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **delete_web_hook**
+> String delete_web_hook(hook_id)
+
+Deletes Webhook
+
+Deletes a Webhook
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+# setup authorization
+BombBomb.configure do |config|
+  # Configure OAuth2 access token for authorization: BBOAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BombBomb::WebhooksApi.new
+
+hook_id = "hook_id_example" # String | The id of the webhook to delete
+
+
+begin
+  #Deletes Webhook
+  result = api_instance.delete_web_hook(hook_id)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling WebhooksApi->delete_web_hook: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **hook_id** | **String**| The id of the webhook to delete | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_web_hooks**
+> Array<BBWebHook> get_web_hooks
+
+Lists Webhooks
+
+Lists all registered Webhooks
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+# setup authorization
+BombBomb.configure do |config|
+  # Configure OAuth2 access token for authorization: BBOAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BombBomb::WebhooksApi.new
+
+begin
+  #Lists Webhooks
+  result = api_instance.get_web_hooks
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling WebhooksApi->get_web_hooks: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<BBWebHook>**](BBWebHook.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **send_webhook_example**
+> send_webhook_example
+
+Sends test Webhook
+
+Triggers a test webhook to be sent to your endpoints.
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+# setup authorization
+BombBomb.configure do |config|
+  # Configure OAuth2 access token for authorization: BBOAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BombBomb::WebhooksApi.new
+
+begin
+  #Sends test Webhook
+  api_instance.send_webhook_example
+rescue BombBomb::ApiError => e
+  puts "Exception when calling WebhooksApi->send_webhook_example: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/git_push.sh

@@ -0,0 +1,67 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+