Golang Client
Go Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.swagger-codegen
api
docs
.gitignore
.swagger-codegen-ignore
.travis.yml
LICENSE
README.md
accounts_api.go
api_client.go
api_response.go
automations_api.go
bb_web_hook.go
client_group_asset_meta_data.go
configuration.go
contacts_api.go
curriculum.go
curriculum_api.go
curriculum_user_progress.go
curriculum_with_progress.go
emails_api.go
files_api.go
forms_api.go
git_push.sh
hosted_doc.go
inline_response_200.go
inline_response_200_items.go
integrations_api.go
jericho_configuration.go
jericho_performance.go
lists_api.go
model_string.go
o_auth_client.go
orders_api.go
pom.xml
prompt_bot.go
prompt_bot_bot.go
prompt_monthly_performance.go
prompt_overview.go
prompt_social_prompt.go
prompts_api.go
sign_upload_request.go
sign_upload_response.go
socials_api.go
string.go
team_public_representation.go
teams_api.go
users_api.go
utilities_api.go
video_email_prompt.go
video_encoding_status_response.go
video_public_representation.go
video_recorder_method_response.go
videos_api.go
webhooks_api.go

README.md

Go API client for bombbomb

We make it easy to build relationships using simple videos.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 2.0.831
  • Package version: 2.0.25798
  • Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

    "./bombbomb"

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 GetClientStatistics Get /accounts/stats Get Client Statistics
AccountsApi GetUserCountry Get /accounts/{clientId}/country Gets user country
AccountsApi ResetApiKey Put /accounts/apikey Reset API key
AccountsApi SubscriptionPurchaseAllowed Get /accounts/purchaseable Check if subscription purchase allowed.
AccountsApi UpdateProfileData Post /account/profile/ Add profile information.
AutomationsApi GetDripDropStats Get /automation/{dripId}/dripdrop/{dripDropId}/stats Get Automation Email Stats
AutomationsApi GetDripStats Get /automation/{id}/stats Get Automation Stats
AutomationsApi GetSchedulingStatus Get /automation/{id}/scheduling/status Get the number of pending scheduling calculations
ContactsApi AddContactsCSV Post /contacts/import_csv Add contacts from a CSV file.
ContactsApi AddNewContact Post /contacts/ Add a contact.
ContactsApi AddNewCustomField Post /contacts/custom_fields/ Add custom fields.
ContactsApi AddPastedContacts Post /contacts/paste Add pasted contacts.
ContactsApi CSVToObject Post /csv-to-object Format CSV.
ContactsApi DeleteContacts Put /contacts/delete Delete Contacts
ContactsApi GetContactById Get /contact/{id} Get Contact Details
ContactsApi GetCustomFields Get /contacts/custom_fields/ Get custom fields.
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 GetAllTemplatesForCurrentUser Get /emails/templates Get all user templates
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
EmailsApi GetLiveFireData Get /emails/livefire Get livefire feed data
EmailsApi GetQuickSendTemplates Get /emails/quicksend/templates Get all quicksend templates
EmailsApi GetTemplateHtmlForTemplateId Get /emails/templates/{templateId}/html Get the HTML for a given template
EmailsApi GetVideoQuickSenderData Get /emails/quicksend Get quicksend data
EmailsApi SaveQuickSenderSettings Post /emails/quicksend/settings Save quicksender settings
EmailsApi VideoQuickSender Post /emails/quicksend Send a quicksend email
FilesApi DocHostDelete Delete /files/{docId} Delete file
FilesApi DocHostGet Get /files/{docId} Get file
FilesApi DocHostList Get /files List all files
FilesApi DocHostUploadV2 Post /files Upload a file
FilesApi GetHostedImagesPaged Get /files/images/paged Get paged hosted images
FormsApi GetFormTrackingAsCsv Get /forms/{id}/tracking/export Get csv
IntegrationsApi ConnectIntegration Post /integrations Activate an integration for a user.
IntegrationsApi DeleteIntegration Delete /integrations Remove an integration for a user.
IntegrationsApi GetIntegrationHealth Get /integrations/health/{code} Get health for a given integration
IntegrationsApi GetIntegrationPageComponents Get /integrations/pageComponents Get page components for a given integration
IntegrationsApi SyncUsersIntegratedLists Get /integrations/sync Synchronize your integration list or lists.
ListsApi AddNewList Post /lists/ Add list.
ListsApi ClearList Put /lists/{listId}/clear Clear Contacts from List
ListsApi CopyListContacts Post /lists/{listId}/copy Copy All Contacts from a List
ListsApi GetAllLists Get /lists/ Get all Lists
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 GetAlternateCampaignContent Get /campaign/{campaignId}/content/alternate List alternate campaign content
PromptsApi GetPendingVideoEmailPrompts Get /prompt/pending List pending prompts
PromptsApi GetPromptBots Get /prompts/bots List Prompt Bots
PromptsApi GetPromptCampaigns Get /prompts/{userId}/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 SendPromptImmediately Post /prompt/{id}/sendit
PromptsApi SyncPromptSubscriptions Post /prompts/campaigns/sync Syncs Campaigns and One to Ones Subscriptions for User
PromptsApi UpdatePrompt Put /prompts/{id} Update Prompt
PromptsApi UpdatePromptBot Put /prompts/bots/{id} Update Prompt Bot
PromptsApi UpdatePromptCampaign Put /prompts/campaigns/{clientGroupId} Update Prompt Campaign
PromptsApi UpdatePromptTemplate Put /prompts/{id}/content Update Prompt Content
SocialsApi GetFacebookPages Get /socials/facebook/pages Gets facebook pages
SocialsApi GetSocialArticleProperties Get /socials/properties Gets the social email properties
SocialsApi GetSocialAuthorizations Get /socials/authorizations Get authorizations for all social integration
SocialsApi GetSocialProfileProperties Get /socials/profile Gets the profile properties
SocialsApi GetSocialStats Get /socials/{promptId}/stats Get social stats for a prompt
SocialsApi PostSocialContent Post /socials/content Creates social content
SocialsApi RetrySocialSend Post /socials/send/retry Sends social content
SocialsApi SendSocial Post /socials/send Sends social content
SocialsApi UpdateClientGroupSendMechanism Put /socials/client/sendMechanism Gets the auto shares from the client group assoc id
SocialsApi UpdateClientGroupsSendMechanism Put /socials/client/sendMechanisms Toggles the prompt campaigns in a users account
SocialsApi UpdateFacebookPages Put /socials/facebook/pages Updates facebook page Ids
SocialsApi UpdateSocialContent Put /socials/content Updates social content
TeamsApi AddTeamMember Post /team/{teamId}/member Add Member to Team
TeamsApi AddUsers Post /team/{teamId}/members Add users to group.
TeamsApi AddUsersFromCsv Post /team/{teamId}/members/csv Add members to group from CSV
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 GetClientGroupStatistics Get /team/{teamId}/stats Get Team statistics
TeamsApi GetJerichoSends Get /team/{teamId}/jericho List Jericho Sends
TeamsApi GetJerichoStats Get /team/{teamId}/jericho/{jerichoId}/performance Gets Jericho performance statistics
TeamsApi GetPagedClientGroupMembers Get /team/{teamId}/members List Team Members
TeamsApi GetPromptMonthlyStats Get /team/{month}/{year}/monthStats Jericho Monthly Stats
TeamsApi GetPromptOverview Get /team/promptOverview Get Prompt Overview
TeamsApi GetSubteams Get /team/{teamId}/subteam List Subteams
TeamsApi GetTeamPromptAggregateStats Get /team/{clientGroupId}/campaign/stats Get aggregate stats for campaigns
TeamsApi GetTeamPromptCampaigns Get /team/{clientGroupId}/campaign Get campaigns for team
TeamsApi InviteToSocialPromptTeam Post /teams/prompt/invite Invite a list to join the admin's social prompt team
TeamsApi QueueJerichoSend Post /team/{teamId}/jericho Creates a Jericho send.
TeamsApi RemoveMemberFromTeam Delete /team/{teamId}/member/{userId} Remove Member from Team
TeamsApi ResendTeamMemberInvitation Post /team/{teamId}/{memberUserId}/rewelcome Resend invite
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
UsersApi GetClientContactInformation Get /clients/contact/information Get client contact information.
UsersApi GetUserProfileInfo Get /users/profile/information Get user profile information.
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
VideosApi UpdateVideoThumbnailV2 Put /videos/thumbnail Upload thumbnail
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: View & Manage your BombBomb information
  • all:read: View your BombBomb information
  • email:manage: View & Manage your BombBomb emails
  • email:read: View your BombBomb emails
  • video:manage: View & Manage your BombBomb videos
  • video:read: View your BombBomb videos
  • contact:manage: View & Manage your BombBomb contacts
  • contact:read: View your BombBomb contacts
  • curriculum:manage: View & Manage your BombBomb challenges
  • curriculum:read: View your BombBomb challenges
  • automation:manage: View & Manage your BombBomb automations
  • automation:read: View your BombBomb automations
  • form:manage: View & Manage your BombBomb forms
  • form:read: View your BombBomb forms
  • list:manage: View & Manage your BombBomb lists
  • team:manage: View & Manage your BombBomb teams
  • team:read: View your BombBomb teams
  • order:manage: Manage your BombBomb orders
  • settings:manage: Manage your BombBomb settings
  • file:manage: View & Manage your BombBomb files
  • file:read: View your BombBomb files
  • account:manage: View & Manage your BombBomb account
  • account:read: View your BombBomb account

Example

	auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
    r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

	import 	"golang.org/x/oauth2"

    / .. Perform OAuth2 round trip request and obtain a token .. //

    tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
	auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
    r, err := client.Service.Operation(auth, args)

Author