bombbomb

BombBomb - the Ruby gem for the BombBomb

We make it easy to build relationships using simple videos.

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 2.0.21454
  • Package version: 2.0.21454
  • Build date: 2016-11-16T16:11:14.077Z
  • Build package: class io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build bombbomb.gemspec

Then either install the gem locally:

gem install ./bombbomb-2.0.21454.gem

(for development, run gem install --dev ./bombbomb-2.0.21454.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'bombbomb', '~> 2.0.21454'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'bombbomb', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# 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::CurriculumApi.new

opts = { 
  include_progress: true # BOOLEAN | Whether to return progress with the curriculum.
}

begin
  #Get Curricula
  result = api_instance.get_curricula(opts)
  p result
rescue BombBomb::ApiError => e
  puts "Exception when calling CurriculumApi->get_curricula: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.bombbomb.com/v2

Class Method HTTP request Description
BombBomb::CurriculumApi get_curricula GET /curricula/ Get Curricula
BombBomb::CurriculumApi get_user_curriculum_with_progress GET /curriculum/getForUserWithProgress Get Detailed For User
BombBomb::PromptsApi create_video_email_prompt POST /prompt Prompts user to send a video
BombBomb::PromptsApi get_video_email_prompt GET /prompt/id Gets a prompt
BombBomb::PromptsApi respond_to_video_email_prompt POST /prompt/id/response Respond to a prompt
BombBomb::TeamsApi add_team_member POST /team/teamId/member Add Member to Team
BombBomb::TeamsApi cancel_jericho_send DELETE /team/teamId/jericho/jerichoId Cancel a Jericho Send
BombBomb::TeamsApi create_subteam POST /team/teamId/subteam Add a Subteam
BombBomb::TeamsApi delete_subteam DELETE /team/teamId/subteam Delete Subteam
BombBomb::TeamsApi get_client_group_assets GET /team/assets/ Lists team assets
BombBomb::TeamsApi get_jericho_sends GET /team/teamId/jericho List Jericho Sends
BombBomb::TeamsApi get_jericho_stats GET /team/teamId/jericho/jerichoId/performance Gets Jericho performance statistics
BombBomb::TeamsApi get_subteams GET /team/teamId/subteam List Subteams
BombBomb::TeamsApi queue_jericho_send POST /team/teamId/jericho Creates a Jericho send.
BombBomb::TeamsApi remove_member_from_team DELETE /team/teamId/member/userId Remove Member from Team
BombBomb::TeamsApi update_team POST /team/teamId Update a team
BombBomb::UtilitiesApi create_o_auth_client POST /oauthclient Create an OAuth Client
BombBomb::UtilitiesApi delete_o_auth_client DELETE /oauthclient/id Delete an OAuth Client
BombBomb::UtilitiesApi get_o_auth_clients GET /oauthclient Lists OAuth Clients
BombBomb::UtilitiesApi get_spec GET /spec Describes this api
BombBomb::WebhooksApi add_web_hook POST /webhook Add Webhook
BombBomb::WebhooksApi delete_web_hook DELETE /webhook/hookId Deletes Webhook
BombBomb::WebhooksApi get_web_hooks GET /webhook/ Lists Webhooks
BombBomb::WebhooksApi list_web_hook_events GET /webhook/events Describe WebHook Events
BombBomb::WebhooksApi send_webhook_example POST /webhook/test Sends test Webhook

Documentation for Models

Documentation for Authorization

BBOAuth2

  • Type: OAuth
  • Flow: implicit
  • Authorization URL: https://app.bombbomb.com/auth/authorize
  • Scopes:
    • all:manage: Manage All
    • all:read: Read All
    • email:manage: Manage Email
    • email:read: Read Email
    • video:manage: Manage Video
    • video:read: Read Video
    • contact:manage: Manage Contact
    • contact:read: Read Contact
    • curriculum:manage: Manage Curriculum
    • curriculum:read: Read Curriculum
    • automation:manage: Manage Automation
    • automation:read: Read Automation
    • form:manage: Manage Form
    • form:read: Read Form
    • team:manage: Manage Team
    • team:read: Read Team
    • settings:manage: Manage Settings