No description, website, or topics provided.
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
docs
src
.gitignore
.swagger-codegen-ignore
.travis.yml
IO.Swagger.sln
LICENSE
README.md
build.bat
build.sh
git_push.sh
mono_nunit_test.sh

README.md

IO.Swagger - the C# library for the BombBomb

We make it easy to build relationships using simple videos.

This C# SDK is automatically generated by the Swagger Codegen project:

  • API version: 2.0.831
  • SDK version: 1.0.0
  • Build package: io.swagger.codegen.languages.CSharpClientCodegen

Frameworks supported

  • .NET 4.0 or later
  • Windows Phone 7.1 (Mango)

Dependencies

The DLLs included in the package may not be the latest version. We recommend using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out IO.Swagger.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Getting Started

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: BBOAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AccountsApi();

            try
            {
                // Get account details.
                apiInstance.AccountDetails();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.AccountDetails: " + e.Message );
            }

        }
    }
}

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