bombbomb/bombbomb

dev-master 2017-07-26 15:26 UTC

README

We make it easy to build relationships using simple videos.

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 2.0.24005
  • Package version: 2.0.24005
  • Build date: 2017-07-26T15:26:10.088Z
  • Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/bombbomb/bombbomb.git"
    }
  ],
  "require": {
    "bombbomb/bombbomb": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/./autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AccountsApi();
$email = "email_example"; // string | Your login email address
$pw = "pw_example"; // string | Your password
$apiKey = "apiKey_example"; // string | Your Api Key

try {
    $api_instance->accountDetails($email, $pw, $apiKey);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->accountDetails: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountsApi accountDetails GET /accounts Get account details.
AccountsApi createAccount POST /accounts Create Account
AccountsApi subscriptionPurchaseAllowed GET /accounts/purchaseable Check if subscription purchase allowed.
AutomationsApi getDripDropStats GET /automation/{dripId}/dripdrop/{dripDropId}/stats Get Automation Email Stats
AutomationsApi getDripStats GET /automation/{id}/stats Get Automation Stats
ContactsApi deleteContacts PUT /contacts/delete Delete Contacts
CurriculumApi getCurricula GET /curricula/ Get Curricula
CurriculumApi getUserCurriculumWithProgress GET /curriculum/getForUserWithProgress Get Detailed For User
EmailsApi createPrintingPressEmail POST /emails/print Create an Email with Printing Press
EmailsApi getEmailTracking GET /emails/{emailId}/tracking Get Email Tracking
EmailsApi getEmailTrackingInteractions GET /emails/{emailId}/tracking/interactions Get Email Tracking Interactions
EmailsApi getHourlyEmailTracking GET /emails/{emailId}/tracking/hourly Get Hourly Email Tracking
FilesApi docHostDelete DELETE /files Deletes users file
ListsApi clearList PUT /lists/{listId}/clear Clear Contacts from List
ListsApi copyListContacts POST /lists/{listId}/copy Copy All Contacts from a List
ListsApi suppressAllInList PUT /lists/{listId}/suppress Suppress All Contacts from List
OrdersApi templateAssetDelete DELETE /orders/templates/images Deletes image from user s3 store
PromptsApi createPromptBot POST /prompts/bots Create a running Prompt Bot for a list
PromptsApi createVideoEmailPrompt POST /prompt Prompts user to send a video
PromptsApi getPendingVideoEmailPrompts GET /prompt/pending List pending prompts
PromptsApi getPromptBots GET /prompts/bots List Prompt Bots
PromptsApi getPromptCampaigns GET /prompts/campaigns List Prompt Campaigns
PromptsApi getVideoEmailPrompt GET /prompt/{id} Gets a prompt
PromptsApi getVideoEmailPrompts GET /prompt/ List prompts
PromptsApi respondToVideoEmailPrompt POST /prompt/{id}/response Respond to a prompt
PromptsApi updatePromptBot PUT /prompts/bots/{id} Update Prompt Bot
PromptsApi updatePromptCampaign PUT /prompts/campaigns/{id} Update Prompt Campaign
SocialsApi getSocialArticleProperties GET /socials/properties Gets the social email properties
SocialsApi getSocialAutoShares GET /socials/shares Gets the auto shares from the client group assoc id
SocialsApi getSocialPermissions GET /socials/permissions Get permissions for social integration
SocialsApi getSocialStatus GET /socials/states Gets the social state
SocialsApi updateSocialAutoShares PUT /socials/shares Gets the auto shares from the client group assoc id
SocialsApi updateSocialMessage PUT /socials/message Sets the users social message to what they typed in
SocialsApi updateSocialStatus PUT /socials/state Updates the social state for the object
TeamsApi addTeamMember POST /team/{teamId}/member Add Member to Team
TeamsApi cancelJerichoSend DELETE /team/{teamId}/jericho/{jerichoId} Cancel a Jericho Send
TeamsApi createSubteam POST /team/{teamId}/subteam Add a Subteam
TeamsApi deleteSubteam DELETE /team/{teamId}/subteam Delete Subteam
TeamsApi getAllClientGroupAssociations GET /team/associations/ Lists team associations
TeamsApi getClientGroupAssets GET /team/assets/ Lists team assets
TeamsApi getJerichoSends GET /team/{teamId}/jericho List Jericho Sends
TeamsApi getJerichoStats GET /team/{teamId}/jericho/{jerichoId}/performance Gets Jericho performance statistics
TeamsApi getSubteams GET /team/{teamId}/subteam List Subteams
TeamsApi queueJerichoSend POST /team/{teamId}/jericho Creates a Jericho send.
TeamsApi removeMemberFromTeam DELETE /team/{teamId}/member/{userId} Remove Member from Team
TeamsApi updateJerichoPromptSend PUT /team/{teamId}/jericho/{jerichoId} Updates the Jericho Prompt Settings
TeamsApi updateTeam POST /team/{teamId} Update a team
TeamsApi updateTeamMember PUT /team/{teamId}/member Update Member of Team
UtilitiesApi createOAuthClient POST /oauthclient Create an OAuth Client
UtilitiesApi deleteOAuthClient DELETE /oauthclient/{id} Delete an OAuth Client
UtilitiesApi getOAuthClients GET /oauthclient Lists OAuth Clients
UtilitiesApi getSpec GET /spec Describes this api
VideosApi getVideoEncodingStatus GET /videos/{videoId}/status Video Encoding Status
VideosApi getVideoRecorder GET /videos/live/getRecorder Get Live Video Recorder HTML
VideosApi markLiveRecordingComplete POST /videos/live/markComplete Completes a live recording
VideosApi signUpload POST /video/signedUpload Generate Signed Url
WebhooksApi addWebHook POST /webhook Add Webhook
WebhooksApi deleteWebHook DELETE /webhook/{hookId} Deletes Webhook
WebhooksApi getWebHooks GET /webhook/ Lists Webhooks
WebhooksApi listWebHookEvents GET /webhook/events Describe WebHook Events
WebhooksApi sendWebhookExample 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
  • order:manage: Manage Order
  • settings:manage: Manage Settings
  • file:manage: Manage File
  • account:manage: Manage Account
  • account:read: Read Account

Author