bombbomb 2.0.22196 → 2.0.24005
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +41 -21
- data/bombbomb.gemspec +1 -1
- data/docs/AccountsApi.md +192 -0
- data/docs/ContactsApi.md +60 -0
- data/docs/EmailsApi.md +5 -6
- data/docs/FilesApi.md +60 -0
- data/docs/JerichoPerformance.md +4 -0
- data/docs/ListsApi.md +167 -0
- data/docs/OrdersApi.md +60 -0
- data/docs/PromptBot.md +22 -0
- data/docs/PromptsApi.md +55 -21
- data/docs/SocialsApi.md +387 -0
- data/docs/TeamsApi.md +165 -0
- data/docs/VideoEmailPrompt.md +2 -1
- data/docs/VideoEncodingStatusResponse.md +10 -0
- data/docs/VideosApi.md +53 -0
- data/lib/bombbomb.rb +9 -2
- data/lib/bombbomb/api/accounts_api.rb +254 -0
- data/lib/bombbomb/api/automations_api.rb +1 -1
- data/lib/bombbomb/api/contacts_api.rb +91 -0
- data/lib/bombbomb/api/curriculum_api.rb +1 -1
- data/lib/bombbomb/api/emails_api.rb +9 -11
- data/lib/bombbomb/api/files_api.rb +91 -0
- data/lib/bombbomb/api/lists_api.rb +207 -0
- data/lib/bombbomb/api/orders_api.rb +91 -0
- data/lib/bombbomb/api/prompts_api.rb +92 -40
- data/lib/bombbomb/api/socials_api.rb +458 -0
- data/lib/bombbomb/api/teams_api.rb +184 -1
- data/lib/bombbomb/api/utilities_api.rb +1 -1
- data/lib/bombbomb/api/videos_api.rb +58 -1
- data/lib/bombbomb/api/webhooks_api.rb +1 -1
- data/lib/bombbomb/api_client.rb +1 -1
- data/lib/bombbomb/api_error.rb +1 -1
- data/lib/bombbomb/configuration.rb +1 -1
- data/lib/bombbomb/models/bb_web_hook.rb +1 -1
- data/lib/bombbomb/models/curriculum.rb +1 -1
- data/lib/bombbomb/models/curriculum_user_progress.rb +1 -1
- data/lib/bombbomb/models/curriculum_with_progress.rb +1 -1
- data/lib/bombbomb/models/inline_response_200.rb +1 -1
- data/lib/bombbomb/models/inline_response_200_items.rb +1 -1
- data/lib/bombbomb/models/jericho_configuration.rb +1 -1
- data/lib/bombbomb/models/jericho_performance.rb +45 -5
- data/lib/bombbomb/models/o_auth_client.rb +1 -1
- data/lib/bombbomb/models/prompt_bot.rb +340 -0
- data/lib/bombbomb/models/sign_upload_request.rb +1 -1
- data/lib/bombbomb/models/sign_upload_response.rb +1 -1
- data/lib/bombbomb/models/string.rb +1 -1
- data/lib/bombbomb/models/team_public_representation.rb +1 -1
- data/lib/bombbomb/models/video_email_prompt.rb +19 -11
- data/lib/bombbomb/models/video_encoding_status_response.rb +220 -0
- data/lib/bombbomb/models/video_public_representation.rb +1 -1
- data/lib/bombbomb/models/video_recorder_method_response.rb +1 -1
- data/lib/bombbomb/version.rb +2 -2
- data/spec/api/accounts_api_spec.rb +96 -0
- data/spec/api/contacts_api_spec.rb +58 -0
- data/spec/api/files_api_spec.rb +58 -0
- data/spec/api/lists_api_spec.rb +83 -0
- data/spec/api/orders_api_spec.rb +58 -0
- data/spec/api/socials_api_spec.rb +135 -0
- data/spec/models/prompt_bot_spec.rb +137 -0
- data/spec/models/video_encoding_status_response_spec.rb +65 -0
- metadata +34 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 87da890da0ac568bf4d0fc8fc3ef76cf35b732cd
|
4
|
+
data.tar.gz: 8b7f9190c00c46179b8aed2f94b4e5a4ceea3910
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7d155a01785c46e0fd7acc2741b782cfb2c423a0dee92c90788eb07c50312281105189322df53c4163fcdea5e0eba853b6b9b1e9c0cbe4823e5ad14080e703ff
|
7
|
+
data.tar.gz: 635036faaf54b06547e48b705dd9b860ab7901bb27b4020fa6c88ac89e1267e53f206d6189fed6bef33b76d263a0f903a8e26d786c3d7810a40cc2c4c49b4902
|
data/README.md
CHANGED
@@ -6,9 +6,9 @@ We make it easy to build relationships using simple videos.
|
|
6
6
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
|
-
- API version: 2.0.
|
10
|
-
- Package version: 2.0.
|
11
|
-
- Build date: 2017-
|
9
|
+
- API version: 2.0.24005
|
10
|
+
- Package version: 2.0.24005
|
11
|
+
- Build date: 2017-07-26T15:26:23.980Z
|
12
12
|
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
|
13
13
|
|
14
14
|
## Installation
|
@@ -24,15 +24,15 @@ gem build bombbomb.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./bombbomb-2.0.
|
27
|
+
gem install ./bombbomb-2.0.24005.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./bombbomb-2.0.
|
29
|
+
(for development, run `gem install --dev ./bombbomb-2.0.24005.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'bombbomb', '~> 2.0.
|
35
|
+
gem 'bombbomb', '~> 2.0.24005'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -55,24 +55,19 @@ Please follow the [installation](#installation) procedure and then run the follo
|
|
55
55
|
# Load the gem
|
56
56
|
require 'bombbomb'
|
57
57
|
|
58
|
-
|
59
|
-
BombBomb.configure do |config|
|
60
|
-
# Configure OAuth2 access token for authorization: BBOAuth2
|
61
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
62
|
-
end
|
63
|
-
|
64
|
-
api_instance = BombBomb::AutomationsApi.new
|
65
|
-
|
66
|
-
drip_id = "drip_id_example" # String | The id of the drip
|
67
|
-
|
68
|
-
drip_drop_id = "drip_drop_id_example" # String | The id of the drip drop
|
58
|
+
api_instance = BombBomb::AccountsApi.new
|
69
59
|
|
60
|
+
opts = {
|
61
|
+
email: "email_example", # String | Your login email address
|
62
|
+
pw: "pw_example", # String | Your password
|
63
|
+
api_key: "api_key_example" # String | Your Api Key
|
64
|
+
}
|
70
65
|
|
71
66
|
begin
|
72
|
-
#Get
|
73
|
-
api_instance.
|
67
|
+
#Get account details.
|
68
|
+
api_instance.account_details(opts)
|
74
69
|
rescue BombBomb::ApiError => e
|
75
|
-
puts "Exception when calling
|
70
|
+
puts "Exception when calling AccountsApi->account_details: #{e}"
|
76
71
|
end
|
77
72
|
|
78
73
|
```
|
@@ -83,14 +78,23 @@ All URIs are relative to *https://api.bombbomb.com/v2*
|
|
83
78
|
|
84
79
|
Class | Method | HTTP request | Description
|
85
80
|
------------ | ------------- | ------------- | -------------
|
81
|
+
*BombBomb::AccountsApi* | [**account_details**](docs/AccountsApi.md#account_details) | **GET** /accounts | Get account details.
|
82
|
+
*BombBomb::AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **POST** /accounts | Create Account
|
83
|
+
*BombBomb::AccountsApi* | [**subscription_purchase_allowed**](docs/AccountsApi.md#subscription_purchase_allowed) | **GET** /accounts/purchaseable | Check if subscription purchase allowed.
|
86
84
|
*BombBomb::AutomationsApi* | [**get_drip_drop_stats**](docs/AutomationsApi.md#get_drip_drop_stats) | **GET** /automation/{dripId}/dripdrop/{dripDropId}/stats | Get Automation Email Stats
|
87
85
|
*BombBomb::AutomationsApi* | [**get_drip_stats**](docs/AutomationsApi.md#get_drip_stats) | **GET** /automation/{id}/stats | Get Automation Stats
|
86
|
+
*BombBomb::ContactsApi* | [**delete_contacts**](docs/ContactsApi.md#delete_contacts) | **PUT** /contacts/delete | Delete Contacts
|
88
87
|
*BombBomb::CurriculumApi* | [**get_curricula**](docs/CurriculumApi.md#get_curricula) | **GET** /curricula/ | Get Curricula
|
89
88
|
*BombBomb::CurriculumApi* | [**get_user_curriculum_with_progress**](docs/CurriculumApi.md#get_user_curriculum_with_progress) | **GET** /curriculum/getForUserWithProgress | Get Detailed For User
|
90
89
|
*BombBomb::EmailsApi* | [**create_printing_press_email**](docs/EmailsApi.md#create_printing_press_email) | **POST** /emails/print | Create an Email with Printing Press
|
91
90
|
*BombBomb::EmailsApi* | [**get_email_tracking**](docs/EmailsApi.md#get_email_tracking) | **GET** /emails/{emailId}/tracking | Get Email Tracking
|
92
91
|
*BombBomb::EmailsApi* | [**get_email_tracking_interactions**](docs/EmailsApi.md#get_email_tracking_interactions) | **GET** /emails/{emailId}/tracking/interactions | Get Email Tracking Interactions
|
93
92
|
*BombBomb::EmailsApi* | [**get_hourly_email_tracking**](docs/EmailsApi.md#get_hourly_email_tracking) | **GET** /emails/{emailId}/tracking/hourly | Get Hourly Email Tracking
|
93
|
+
*BombBomb::FilesApi* | [**doc_host_delete**](docs/FilesApi.md#doc_host_delete) | **DELETE** /files | Deletes users file
|
94
|
+
*BombBomb::ListsApi* | [**clear_list**](docs/ListsApi.md#clear_list) | **PUT** /lists/{listId}/clear | Clear Contacts from List
|
95
|
+
*BombBomb::ListsApi* | [**copy_list_contacts**](docs/ListsApi.md#copy_list_contacts) | **POST** /lists/{listId}/copy | Copy All Contacts from a List
|
96
|
+
*BombBomb::ListsApi* | [**suppress_all_in_list**](docs/ListsApi.md#suppress_all_in_list) | **PUT** /lists/{listId}/suppress | Suppress All Contacts from List
|
97
|
+
*BombBomb::OrdersApi* | [**template_asset_delete**](docs/OrdersApi.md#template_asset_delete) | **DELETE** /orders/templates/images | Deletes image from user s3 store
|
94
98
|
*BombBomb::PromptsApi* | [**create_prompt_bot**](docs/PromptsApi.md#create_prompt_bot) | **POST** /prompts/bots | Create a running Prompt Bot for a list
|
95
99
|
*BombBomb::PromptsApi* | [**create_video_email_prompt**](docs/PromptsApi.md#create_video_email_prompt) | **POST** /prompt | Prompts user to send a video
|
96
100
|
*BombBomb::PromptsApi* | [**get_pending_video_email_prompts**](docs/PromptsApi.md#get_pending_video_email_prompts) | **GET** /prompt/pending | List pending prompts
|
@@ -101,21 +105,32 @@ Class | Method | HTTP request | Description
|
|
101
105
|
*BombBomb::PromptsApi* | [**respond_to_video_email_prompt**](docs/PromptsApi.md#respond_to_video_email_prompt) | **POST** /prompt/{id}/response | Respond to a prompt
|
102
106
|
*BombBomb::PromptsApi* | [**update_prompt_bot**](docs/PromptsApi.md#update_prompt_bot) | **PUT** /prompts/bots/{id} | Update Prompt Bot
|
103
107
|
*BombBomb::PromptsApi* | [**update_prompt_campaign**](docs/PromptsApi.md#update_prompt_campaign) | **PUT** /prompts/campaigns/{id} | Update Prompt Campaign
|
108
|
+
*BombBomb::SocialsApi* | [**get_social_article_properties**](docs/SocialsApi.md#get_social_article_properties) | **GET** /socials/properties | Gets the social email properties
|
109
|
+
*BombBomb::SocialsApi* | [**get_social_auto_shares**](docs/SocialsApi.md#get_social_auto_shares) | **GET** /socials/shares | Gets the auto shares from the client group assoc id
|
110
|
+
*BombBomb::SocialsApi* | [**get_social_permissions**](docs/SocialsApi.md#get_social_permissions) | **GET** /socials/permissions | Get permissions for social integration
|
111
|
+
*BombBomb::SocialsApi* | [**get_social_status**](docs/SocialsApi.md#get_social_status) | **GET** /socials/states | Gets the social state
|
112
|
+
*BombBomb::SocialsApi* | [**update_social_auto_shares**](docs/SocialsApi.md#update_social_auto_shares) | **PUT** /socials/shares | Gets the auto shares from the client group assoc id
|
113
|
+
*BombBomb::SocialsApi* | [**update_social_message**](docs/SocialsApi.md#update_social_message) | **PUT** /socials/message | Sets the users social message to what they typed in
|
114
|
+
*BombBomb::SocialsApi* | [**update_social_status**](docs/SocialsApi.md#update_social_status) | **PUT** /socials/state | Updates the social state for the object
|
104
115
|
*BombBomb::TeamsApi* | [**add_team_member**](docs/TeamsApi.md#add_team_member) | **POST** /team/{teamId}/member | Add Member to Team
|
105
116
|
*BombBomb::TeamsApi* | [**cancel_jericho_send**](docs/TeamsApi.md#cancel_jericho_send) | **DELETE** /team/{teamId}/jericho/{jerichoId} | Cancel a Jericho Send
|
106
117
|
*BombBomb::TeamsApi* | [**create_subteam**](docs/TeamsApi.md#create_subteam) | **POST** /team/{teamId}/subteam | Add a Subteam
|
107
118
|
*BombBomb::TeamsApi* | [**delete_subteam**](docs/TeamsApi.md#delete_subteam) | **DELETE** /team/{teamId}/subteam | Delete Subteam
|
119
|
+
*BombBomb::TeamsApi* | [**get_all_client_group_associations**](docs/TeamsApi.md#get_all_client_group_associations) | **GET** /team/associations/ | Lists team associations
|
108
120
|
*BombBomb::TeamsApi* | [**get_client_group_assets**](docs/TeamsApi.md#get_client_group_assets) | **GET** /team/assets/ | Lists team assets
|
109
121
|
*BombBomb::TeamsApi* | [**get_jericho_sends**](docs/TeamsApi.md#get_jericho_sends) | **GET** /team/{teamId}/jericho | List Jericho Sends
|
110
122
|
*BombBomb::TeamsApi* | [**get_jericho_stats**](docs/TeamsApi.md#get_jericho_stats) | **GET** /team/{teamId}/jericho/{jerichoId}/performance | Gets Jericho performance statistics
|
111
123
|
*BombBomb::TeamsApi* | [**get_subteams**](docs/TeamsApi.md#get_subteams) | **GET** /team/{teamId}/subteam | List Subteams
|
112
124
|
*BombBomb::TeamsApi* | [**queue_jericho_send**](docs/TeamsApi.md#queue_jericho_send) | **POST** /team/{teamId}/jericho | Creates a Jericho send.
|
113
125
|
*BombBomb::TeamsApi* | [**remove_member_from_team**](docs/TeamsApi.md#remove_member_from_team) | **DELETE** /team/{teamId}/member/{userId} | Remove Member from Team
|
126
|
+
*BombBomb::TeamsApi* | [**update_jericho_prompt_send**](docs/TeamsApi.md#update_jericho_prompt_send) | **PUT** /team/{teamId}/jericho/{jerichoId} | Updates the Jericho Prompt Settings
|
114
127
|
*BombBomb::TeamsApi* | [**update_team**](docs/TeamsApi.md#update_team) | **POST** /team/{teamId} | Update a team
|
128
|
+
*BombBomb::TeamsApi* | [**update_team_member**](docs/TeamsApi.md#update_team_member) | **PUT** /team/{teamId}/member | Update Member of Team
|
115
129
|
*BombBomb::UtilitiesApi* | [**create_o_auth_client**](docs/UtilitiesApi.md#create_o_auth_client) | **POST** /oauthclient | Create an OAuth Client
|
116
130
|
*BombBomb::UtilitiesApi* | [**delete_o_auth_client**](docs/UtilitiesApi.md#delete_o_auth_client) | **DELETE** /oauthclient/{id} | Delete an OAuth Client
|
117
131
|
*BombBomb::UtilitiesApi* | [**get_o_auth_clients**](docs/UtilitiesApi.md#get_o_auth_clients) | **GET** /oauthclient | Lists OAuth Clients
|
118
132
|
*BombBomb::UtilitiesApi* | [**get_spec**](docs/UtilitiesApi.md#get_spec) | **GET** /spec | Describes this api
|
133
|
+
*BombBomb::VideosApi* | [**get_video_encoding_status**](docs/VideosApi.md#get_video_encoding_status) | **GET** /videos/{videoId}/status | Video Encoding Status
|
119
134
|
*BombBomb::VideosApi* | [**get_video_recorder**](docs/VideosApi.md#get_video_recorder) | **GET** /videos/live/getRecorder | Get Live Video Recorder HTML
|
120
135
|
*BombBomb::VideosApi* | [**mark_live_recording_complete**](docs/VideosApi.md#mark_live_recording_complete) | **POST** /videos/live/markComplete | Completes a live recording
|
121
136
|
*BombBomb::VideosApi* | [**sign_upload**](docs/VideosApi.md#sign_upload) | **POST** /video/signedUpload | Generate Signed Url
|
@@ -137,12 +152,13 @@ Class | Method | HTTP request | Description
|
|
137
152
|
- [BombBomb::JerichoConfiguration](docs/JerichoConfiguration.md)
|
138
153
|
- [BombBomb::JerichoPerformance](docs/JerichoPerformance.md)
|
139
154
|
- [BombBomb::OAuthClient](docs/OAuthClient.md)
|
140
|
-
- [BombBomb::
|
155
|
+
- [BombBomb::PromptBot](docs/PromptBot.md)
|
141
156
|
- [BombBomb::SignUploadRequest](docs/SignUploadRequest.md)
|
142
157
|
- [BombBomb::SignUploadResponse](docs/SignUploadResponse.md)
|
143
158
|
- [BombBomb::String](docs/String.md)
|
144
159
|
- [BombBomb::TeamPublicRepresentation](docs/TeamPublicRepresentation.md)
|
145
160
|
- [BombBomb::VideoEmailPrompt](docs/VideoEmailPrompt.md)
|
161
|
+
- [BombBomb::VideoEncodingStatusResponse](docs/VideoEncodingStatusResponse.md)
|
146
162
|
- [BombBomb::VideoPublicRepresentation](docs/VideoPublicRepresentation.md)
|
147
163
|
- [BombBomb::VideoRecorderMethodResponse](docs/VideoRecorderMethodResponse.md)
|
148
164
|
|
@@ -172,5 +188,9 @@ Class | Method | HTTP request | Description
|
|
172
188
|
- form:read: Read Form
|
173
189
|
- team:manage: Manage Team
|
174
190
|
- team:read: Read Team
|
191
|
+
- order:manage: Manage Order
|
175
192
|
- settings:manage: Manage Settings
|
193
|
+
- file:manage: Manage File
|
194
|
+
- account:manage: Manage Account
|
195
|
+
- account:read: Read Account
|
176
196
|
|
data/bombbomb.gemspec
CHANGED
data/docs/AccountsApi.md
ADDED
@@ -0,0 +1,192 @@
|
|
1
|
+
# BombBomb::AccountsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.bombbomb.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**account_details**](AccountsApi.md#account_details) | **GET** /accounts | Get account details.
|
8
|
+
[**create_account**](AccountsApi.md#create_account) | **POST** /accounts | Create Account
|
9
|
+
[**subscription_purchase_allowed**](AccountsApi.md#subscription_purchase_allowed) | **GET** /accounts/purchaseable | Check if subscription purchase allowed.
|
10
|
+
|
11
|
+
|
12
|
+
# **account_details**
|
13
|
+
> account_details(opts)
|
14
|
+
|
15
|
+
Get account details.
|
16
|
+
|
17
|
+
Get the details of the user's account.
|
18
|
+
|
19
|
+
### Example
|
20
|
+
```ruby
|
21
|
+
# load the gem
|
22
|
+
require 'bombbomb'
|
23
|
+
|
24
|
+
api_instance = BombBomb::AccountsApi.new
|
25
|
+
|
26
|
+
opts = {
|
27
|
+
email: "email_example", # String | Your login email address
|
28
|
+
pw: "pw_example", # String | Your password
|
29
|
+
api_key: "api_key_example" # String | Your Api Key
|
30
|
+
}
|
31
|
+
|
32
|
+
begin
|
33
|
+
#Get account details.
|
34
|
+
api_instance.account_details(opts)
|
35
|
+
rescue BombBomb::ApiError => e
|
36
|
+
puts "Exception when calling AccountsApi->account_details: #{e}"
|
37
|
+
end
|
38
|
+
```
|
39
|
+
|
40
|
+
### Parameters
|
41
|
+
|
42
|
+
Name | Type | Description | Notes
|
43
|
+
------------- | ------------- | ------------- | -------------
|
44
|
+
**email** | **String**| Your login email address | [optional]
|
45
|
+
**pw** | **String**| Your password | [optional]
|
46
|
+
**api_key** | **String**| Your Api Key | [optional]
|
47
|
+
|
48
|
+
### Return type
|
49
|
+
|
50
|
+
nil (empty response body)
|
51
|
+
|
52
|
+
### Authorization
|
53
|
+
|
54
|
+
No authorization required
|
55
|
+
|
56
|
+
### HTTP request headers
|
57
|
+
|
58
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
59
|
+
- **Accept**: application/json
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
# **create_account**
|
64
|
+
> String create_account(team_id, first_name, last_name, email_address, company_name, phone, opts)
|
65
|
+
|
66
|
+
Create Account
|
67
|
+
|
68
|
+
Creates a new BombBomb account. This method is currently only available to paid seat admins.
|
69
|
+
|
70
|
+
### Example
|
71
|
+
```ruby
|
72
|
+
# load the gem
|
73
|
+
require 'bombbomb'
|
74
|
+
# setup authorization
|
75
|
+
BombBomb.configure do |config|
|
76
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
77
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
78
|
+
end
|
79
|
+
|
80
|
+
api_instance = BombBomb::AccountsApi.new
|
81
|
+
|
82
|
+
team_id = "team_id_example" # String | The team id
|
83
|
+
|
84
|
+
first_name = "first_name_example" # String | First name of the user.
|
85
|
+
|
86
|
+
last_name = "last_name_example" # String | Last name of the user.
|
87
|
+
|
88
|
+
email_address = "email_address_example" # String | Email address of the user.
|
89
|
+
|
90
|
+
company_name = "company_name_example" # String | Company of the user.
|
91
|
+
|
92
|
+
phone = "phone_example" # String | Phone number of the user.
|
93
|
+
|
94
|
+
opts = {
|
95
|
+
country: "country_example", # String | Country of the user.
|
96
|
+
industry: "industry_example", # String | Industry of the user.
|
97
|
+
address: "address_example", # String | Street Address of the user.
|
98
|
+
city: "city_example", # String | City of the user.
|
99
|
+
postal_code: "postal_code_example" # String | Postal/Zip code of the user.
|
100
|
+
}
|
101
|
+
|
102
|
+
begin
|
103
|
+
#Create Account
|
104
|
+
result = api_instance.create_account(team_id, first_name, last_name, email_address, company_name, phone, opts)
|
105
|
+
p result
|
106
|
+
rescue BombBomb::ApiError => e
|
107
|
+
puts "Exception when calling AccountsApi->create_account: #{e}"
|
108
|
+
end
|
109
|
+
```
|
110
|
+
|
111
|
+
### Parameters
|
112
|
+
|
113
|
+
Name | Type | Description | Notes
|
114
|
+
------------- | ------------- | ------------- | -------------
|
115
|
+
**team_id** | **String**| The team id |
|
116
|
+
**first_name** | **String**| First name of the user. |
|
117
|
+
**last_name** | **String**| Last name of the user. |
|
118
|
+
**email_address** | **String**| Email address of the user. |
|
119
|
+
**company_name** | **String**| Company of the user. |
|
120
|
+
**phone** | **String**| Phone number of the user. |
|
121
|
+
**country** | **String**| Country of the user. | [optional]
|
122
|
+
**industry** | **String**| Industry of the user. | [optional]
|
123
|
+
**address** | **String**| Street Address of the user. | [optional]
|
124
|
+
**city** | **String**| City of the user. | [optional]
|
125
|
+
**postal_code** | **String**| Postal/Zip code of the user. | [optional]
|
126
|
+
|
127
|
+
### Return type
|
128
|
+
|
129
|
+
**String**
|
130
|
+
|
131
|
+
### Authorization
|
132
|
+
|
133
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
134
|
+
|
135
|
+
### HTTP request headers
|
136
|
+
|
137
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
138
|
+
- **Accept**: application/json
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
# **subscription_purchase_allowed**
|
143
|
+
> subscription_purchase_allowed(opts)
|
144
|
+
|
145
|
+
Check if subscription purchase allowed.
|
146
|
+
|
147
|
+
Check whether the user can purchase a subscription.
|
148
|
+
|
149
|
+
### Example
|
150
|
+
```ruby
|
151
|
+
# load the gem
|
152
|
+
require 'bombbomb'
|
153
|
+
|
154
|
+
api_instance = BombBomb::AccountsApi.new
|
155
|
+
|
156
|
+
opts = {
|
157
|
+
email: "email_example", # String | Your login email address
|
158
|
+
pw: "pw_example", # String | Your password
|
159
|
+
api_key: "api_key_example" # String | Your Api Key
|
160
|
+
}
|
161
|
+
|
162
|
+
begin
|
163
|
+
#Check if subscription purchase allowed.
|
164
|
+
api_instance.subscription_purchase_allowed(opts)
|
165
|
+
rescue BombBomb::ApiError => e
|
166
|
+
puts "Exception when calling AccountsApi->subscription_purchase_allowed: #{e}"
|
167
|
+
end
|
168
|
+
```
|
169
|
+
|
170
|
+
### Parameters
|
171
|
+
|
172
|
+
Name | Type | Description | Notes
|
173
|
+
------------- | ------------- | ------------- | -------------
|
174
|
+
**email** | **String**| Your login email address | [optional]
|
175
|
+
**pw** | **String**| Your password | [optional]
|
176
|
+
**api_key** | **String**| Your Api Key | [optional]
|
177
|
+
|
178
|
+
### Return type
|
179
|
+
|
180
|
+
nil (empty response body)
|
181
|
+
|
182
|
+
### Authorization
|
183
|
+
|
184
|
+
No authorization required
|
185
|
+
|
186
|
+
### HTTP request headers
|
187
|
+
|
188
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
189
|
+
- **Accept**: application/json
|
190
|
+
|
191
|
+
|
192
|
+
|
data/docs/ContactsApi.md
ADDED
@@ -0,0 +1,60 @@
|
|
1
|
+
# BombBomb::ContactsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.bombbomb.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**delete_contacts**](ContactsApi.md#delete_contacts) | **PUT** /contacts/delete | Delete Contacts
|
8
|
+
|
9
|
+
|
10
|
+
# **delete_contacts**
|
11
|
+
> delete_contacts(list_id)
|
12
|
+
|
13
|
+
Delete Contacts
|
14
|
+
|
15
|
+
Delete contacts
|
16
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# load the gem
|
20
|
+
require 'bombbomb'
|
21
|
+
# setup authorization
|
22
|
+
BombBomb.configure do |config|
|
23
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
24
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
25
|
+
end
|
26
|
+
|
27
|
+
api_instance = BombBomb::ContactsApi.new
|
28
|
+
|
29
|
+
list_id = "list_id_example" # String | The list of contacts to be deleted.
|
30
|
+
|
31
|
+
|
32
|
+
begin
|
33
|
+
#Delete Contacts
|
34
|
+
api_instance.delete_contacts(list_id)
|
35
|
+
rescue BombBomb::ApiError => e
|
36
|
+
puts "Exception when calling ContactsApi->delete_contacts: #{e}"
|
37
|
+
end
|
38
|
+
```
|
39
|
+
|
40
|
+
### Parameters
|
41
|
+
|
42
|
+
Name | Type | Description | Notes
|
43
|
+
------------- | ------------- | ------------- | -------------
|
44
|
+
**list_id** | **String**| The list of contacts to be deleted. |
|
45
|
+
|
46
|
+
### Return type
|
47
|
+
|
48
|
+
nil (empty response body)
|
49
|
+
|
50
|
+
### Authorization
|
51
|
+
|
52
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
53
|
+
|
54
|
+
### HTTP request headers
|
55
|
+
|
56
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
57
|
+
- **Accept**: application/json
|
58
|
+
|
59
|
+
|
60
|
+
|
data/docs/EmailsApi.md
CHANGED
@@ -11,11 +11,11 @@ Method | HTTP request | Description
|
|
11
11
|
|
12
12
|
|
13
13
|
# **create_printing_press_email**
|
14
|
-
> create_printing_press_email(template_id, content,
|
14
|
+
> create_printing_press_email(template_id, content, opts)
|
15
15
|
|
16
16
|
Create an Email with Printing Press
|
17
17
|
|
18
|
-
Prints an email using the template id and content to the users account.If a video id
|
18
|
+
Prints an email using the template id and content to the users account.If a video id is included, it will replace any video placeholders with that video.
|
19
19
|
|
20
20
|
### Example
|
21
21
|
```ruby
|
@@ -33,16 +33,15 @@ template_id = "template_id_example" # String | The template id to be printed.
|
|
33
33
|
|
34
34
|
content = "content_example" # String | The content of the email.
|
35
35
|
|
36
|
-
replace = true # BOOLEAN | Set whether to replace video placeholders with video id.
|
37
|
-
|
38
36
|
opts = {
|
37
|
+
email_id: "email_id_example", # String | The email id to be printed to.
|
39
38
|
video_id: "video_id_example", # String | A video to replace video place holders with.
|
40
39
|
subject_line: "subject_line_example" # String | The subject line to be printed.
|
41
40
|
}
|
42
41
|
|
43
42
|
begin
|
44
43
|
#Create an Email with Printing Press
|
45
|
-
api_instance.create_printing_press_email(template_id, content,
|
44
|
+
api_instance.create_printing_press_email(template_id, content, opts)
|
46
45
|
rescue BombBomb::ApiError => e
|
47
46
|
puts "Exception when calling EmailsApi->create_printing_press_email: #{e}"
|
48
47
|
end
|
@@ -54,7 +53,7 @@ Name | Type | Description | Notes
|
|
54
53
|
------------- | ------------- | ------------- | -------------
|
55
54
|
**template_id** | **String**| The template id to be printed. |
|
56
55
|
**content** | **String**| The content of the email. |
|
57
|
-
**
|
56
|
+
**email_id** | **String**| The email id to be printed to. | [optional]
|
58
57
|
**video_id** | **String**| A video to replace video place holders with. | [optional]
|
59
58
|
**subject_line** | **String**| The subject line to be printed. | [optional]
|
60
59
|
|