2.0.22196 • Published 7 years ago

bombbomb v2.0.22196

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
7 years ago

bombbomb

Bombbomb - JavaScript client for 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.22196
  • Package version: 2.0.22196
  • Build date: 2017-01-23T18:33:03.004Z
  • Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install bombbomb --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var Bombbomb = require('bombbomb');

var defaultClient = Bombbomb.ApiClient.instance;

// Configure OAuth2 access token for authorization: BBOAuth2
var BBOAuth2 = defaultClient.authentications['BBOAuth2'];
BBOAuth2.accessToken = "YOUR ACCESS TOKEN"

var api = new Bombbomb.AutomationsApi()

var dripId = "dripId_example"; // {String} The id of the drip

var dripDropId = "dripDropId_example"; // {String} The id of the drip drop


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getDripDropStats(dripId, dripDropId, callback);

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
Bombbomb.AutomationsApigetDripDropStatsGET /automation/{dripId}/dripdrop/{dripDropId}/statsGet Automation Email Stats
Bombbomb.AutomationsApigetDripStatsGET /automation/{id}/statsGet Automation Stats
Bombbomb.CurriculumApigetCurriculaGET /curricula/Get Curricula
Bombbomb.CurriculumApigetUserCurriculumWithProgressGET /curriculum/getForUserWithProgressGet Detailed For User
Bombbomb.EmailsApicreatePrintingPressEmailPOST /emails/printCreate an Email with Printing Press
Bombbomb.EmailsApigetEmailTrackingGET /emails/{emailId}/trackingGet Email Tracking
Bombbomb.EmailsApigetEmailTrackingInteractionsGET /emails/{emailId}/tracking/interactionsGet Email Tracking Interactions
Bombbomb.EmailsApigetHourlyEmailTrackingGET /emails/{emailId}/tracking/hourlyGet Hourly Email Tracking
Bombbomb.PromptsApicreatePromptBotPOST /prompts/botsCreate a running Prompt Bot for a list
Bombbomb.PromptsApicreateVideoEmailPromptPOST /promptPrompts user to send a video
Bombbomb.PromptsApigetPendingVideoEmailPromptsGET /prompt/pendingList pending prompts
Bombbomb.PromptsApigetPromptBotsGET /prompts/botsList Prompt Bots
Bombbomb.PromptsApigetPromptCampaignsGET /prompts/campaignsList Prompt Campaigns
Bombbomb.PromptsApigetVideoEmailPromptGET /prompt/{id}Gets a prompt
Bombbomb.PromptsApigetVideoEmailPromptsGET /prompt/List prompts
Bombbomb.PromptsApirespondToVideoEmailPromptPOST /prompt/{id}/responseRespond to a prompt
Bombbomb.PromptsApiupdatePromptBotPUT /prompts/bots/{id}Update Prompt Bot
Bombbomb.PromptsApiupdatePromptCampaignPUT /prompts/campaigns/{id}Update Prompt Campaign
Bombbomb.TeamsApiaddTeamMemberPOST /team/{teamId}/memberAdd Member to Team
Bombbomb.TeamsApicancelJerichoSendDELETE /team/{teamId}/jericho/{jerichoId}Cancel a Jericho Send
Bombbomb.TeamsApicreateSubteamPOST /team/{teamId}/subteamAdd a Subteam
Bombbomb.TeamsApideleteSubteamDELETE /team/{teamId}/subteamDelete Subteam
Bombbomb.TeamsApigetClientGroupAssetsGET /team/assets/Lists team assets
Bombbomb.TeamsApigetJerichoSendsGET /team/{teamId}/jerichoList Jericho Sends
Bombbomb.TeamsApigetJerichoStatsGET /team/{teamId}/jericho/{jerichoId}/performanceGets Jericho performance statistics
Bombbomb.TeamsApigetSubteamsGET /team/{teamId}/subteamList Subteams
Bombbomb.TeamsApiqueueJerichoSendPOST /team/{teamId}/jerichoCreates a Jericho send.
Bombbomb.TeamsApiremoveMemberFromTeamDELETE /team/{teamId}/member/{userId}Remove Member from Team
Bombbomb.TeamsApiupdateTeamPOST /team/{teamId}Update a team
Bombbomb.UtilitiesApicreateOAuthClientPOST /oauthclientCreate an OAuth Client
Bombbomb.UtilitiesApideleteOAuthClientDELETE /oauthclient/{id}Delete an OAuth Client
Bombbomb.UtilitiesApigetOAuthClientsGET /oauthclientLists OAuth Clients
Bombbomb.UtilitiesApigetSpecGET /specDescribes this api
Bombbomb.VideosApigetVideoRecorderGET /videos/live/getRecorderGet Live Video Recorder HTML
Bombbomb.VideosApimarkLiveRecordingCompletePOST /videos/live/markCompleteCompletes a live recording
Bombbomb.VideosApisignUploadPOST /video/signedUploadGenerate Signed Url
Bombbomb.WebhooksApiaddWebHookPOST /webhookAdd Webhook
Bombbomb.WebhooksApideleteWebHookDELETE /webhook/{hookId}Deletes Webhook
Bombbomb.WebhooksApigetWebHooksGET /webhook/Lists Webhooks
Bombbomb.WebhooksApilistWebHookEventsGET /webhook/eventsDescribe WebHook Events
Bombbomb.WebhooksApisendWebhookExamplePOST /webhook/testSends 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