bombbomb 2.0.21454 → 2.0.22196
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +35 -14
- data/bombbomb.gemspec +1 -1
- data/docs/AutomationsApi.md +115 -0
- data/docs/EmailsApi.md +246 -0
- data/docs/JerichoConfiguration.md +5 -1
- data/docs/PromptBotBot.md +18 -0
- data/docs/PromptsApi.md +384 -3
- data/docs/SignUploadRequest.md +9 -0
- data/docs/SignUploadResponse.md +9 -0
- data/docs/VideoEmailPrompt.md +9 -2
- data/docs/VideoPublicRepresentation.md +18 -0
- data/docs/VideoRecorderMethodResponse.md +15 -0
- data/docs/VideosApi.md +175 -0
- data/lib/bombbomb.rb +9 -1
- data/lib/bombbomb/api/automations_api.rb +150 -0
- data/lib/bombbomb/api/curriculum_api.rb +1 -1
- data/lib/bombbomb/api/emails_api.rb +293 -0
- data/lib/bombbomb/api/prompts_api.rb +439 -5
- data/lib/bombbomb/api/teams_api.rb +1 -1
- data/lib/bombbomb/api/utilities_api.rb +1 -1
- data/lib/bombbomb/api/videos_api.rb +221 -0
- 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 +43 -3
- data/lib/bombbomb/models/jericho_performance.rb +1 -1
- data/lib/bombbomb/models/o_auth_client.rb +1 -1
- data/lib/bombbomb/models/prompt_bot_bot.rb +300 -0
- data/lib/bombbomb/models/sign_upload_request.rb +210 -0
- data/lib/bombbomb/models/sign_upload_response.rb +210 -0
- 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 +79 -9
- data/lib/bombbomb/models/video_public_representation.rb +302 -0
- data/lib/bombbomb/models/video_recorder_method_response.rb +270 -0
- data/lib/bombbomb/version.rb +2 -2
- data/spec/api/automations_api_spec.rb +71 -0
- data/spec/api/emails_api_spec.rb +104 -0
- data/spec/api/videos_api_spec.rb +86 -0
- data/spec/models/prompt_bot_bot_spec.rb +113 -0
- data/spec/models/sign_upload_request_spec.rb +59 -0
- data/spec/models/sign_upload_response_spec.rb +59 -0
- data/spec/models/video_public_representation_spec.rb +113 -0
- data/spec/models/video_recorder_method_response_spec.rb +95 -0
- metadata +34 -2
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#BombBomb
|
|
3
|
+
|
|
4
|
+
#We make it easy to build relationships using simple videos.
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 2.0.22196
|
|
7
|
+
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
|
|
10
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
11
|
+
you may not use this file except in compliance with the License.
|
|
12
|
+
You may obtain a copy of the License at
|
|
13
|
+
|
|
14
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
15
|
+
|
|
16
|
+
Unless required by applicable law or agreed to in writing, software
|
|
17
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
18
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
19
|
+
See the License for the specific language governing permissions and
|
|
20
|
+
limitations under the License.
|
|
21
|
+
|
|
22
|
+
=end
|
|
23
|
+
|
|
24
|
+
require "uri"
|
|
25
|
+
|
|
26
|
+
module BombBomb
|
|
27
|
+
class VideosApi
|
|
28
|
+
attr_accessor :api_client
|
|
29
|
+
|
|
30
|
+
def initialize(api_client = ApiClient.default)
|
|
31
|
+
@api_client = api_client
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# Get Live Video Recorder HTML
|
|
35
|
+
# Returns an object with a number of properties to help you put a video recorder on your site. This is to be used in conjunction with the VideoRecordedLive call one the user has confirmed in your UI that the video is how they want it.
|
|
36
|
+
# @param [Hash] opts the optional parameters
|
|
37
|
+
# @option opts [Integer] :width The width of the recorder to present.
|
|
38
|
+
# @option opts [String] :video_id The id of the video to record
|
|
39
|
+
# @return [VideoRecorderMethodResponse]
|
|
40
|
+
def get_video_recorder(opts = {})
|
|
41
|
+
data, _status_code, _headers = get_video_recorder_with_http_info(opts)
|
|
42
|
+
return data
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# Get Live Video Recorder HTML
|
|
46
|
+
# Returns an object with a number of properties to help you put a video recorder on your site. This is to be used in conjunction with the VideoRecordedLive call one the user has confirmed in your UI that the video is how they want it.
|
|
47
|
+
# @param [Hash] opts the optional parameters
|
|
48
|
+
# @option opts [Integer] :width The width of the recorder to present.
|
|
49
|
+
# @option opts [String] :video_id The id of the video to record
|
|
50
|
+
# @return [Array<(VideoRecorderMethodResponse, Fixnum, Hash)>] VideoRecorderMethodResponse data, response status code and response headers
|
|
51
|
+
def get_video_recorder_with_http_info(opts = {})
|
|
52
|
+
if @api_client.config.debugging
|
|
53
|
+
@api_client.config.logger.debug "Calling API: VideosApi.get_video_recorder ..."
|
|
54
|
+
end
|
|
55
|
+
# resource path
|
|
56
|
+
local_var_path = "/videos/live/getRecorder".sub('{format}','json')
|
|
57
|
+
|
|
58
|
+
# query parameters
|
|
59
|
+
query_params = {}
|
|
60
|
+
query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
|
|
61
|
+
query_params[:'videoId'] = opts[:'video_id'] if !opts[:'video_id'].nil?
|
|
62
|
+
|
|
63
|
+
# header parameters
|
|
64
|
+
header_params = {}
|
|
65
|
+
|
|
66
|
+
# HTTP header 'Accept' (if needed)
|
|
67
|
+
local_header_accept = ['application/json']
|
|
68
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
69
|
+
|
|
70
|
+
# HTTP header 'Content-Type'
|
|
71
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
|
72
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
73
|
+
|
|
74
|
+
# form parameters
|
|
75
|
+
form_params = {}
|
|
76
|
+
|
|
77
|
+
# http body (model)
|
|
78
|
+
post_body = nil
|
|
79
|
+
auth_names = ['BBOAuth2']
|
|
80
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
81
|
+
:header_params => header_params,
|
|
82
|
+
:query_params => query_params,
|
|
83
|
+
:form_params => form_params,
|
|
84
|
+
:body => post_body,
|
|
85
|
+
:auth_names => auth_names,
|
|
86
|
+
:return_type => 'VideoRecorderMethodResponse')
|
|
87
|
+
if @api_client.config.debugging
|
|
88
|
+
@api_client.config.logger.debug "API called: VideosApi#get_video_recorder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
89
|
+
end
|
|
90
|
+
return data, status_code, headers
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# Completes a live recording
|
|
94
|
+
# Used in conjunction with the live recorder method to mark a video recording as complete.
|
|
95
|
+
# @param video_id The id of the video to mark as done.
|
|
96
|
+
# @param filename The filename that was chosen as the final video.
|
|
97
|
+
# @param title The title to give the video
|
|
98
|
+
# @param [Hash] opts the optional parameters
|
|
99
|
+
# @return [VideoPublicRepresentation]
|
|
100
|
+
def mark_live_recording_complete(video_id, filename, title, opts = {})
|
|
101
|
+
data, _status_code, _headers = mark_live_recording_complete_with_http_info(video_id, filename, title, opts)
|
|
102
|
+
return data
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# Completes a live recording
|
|
106
|
+
# Used in conjunction with the live recorder method to mark a video recording as complete.
|
|
107
|
+
# @param video_id The id of the video to mark as done.
|
|
108
|
+
# @param filename The filename that was chosen as the final video.
|
|
109
|
+
# @param title The title to give the video
|
|
110
|
+
# @param [Hash] opts the optional parameters
|
|
111
|
+
# @return [Array<(VideoPublicRepresentation, Fixnum, Hash)>] VideoPublicRepresentation data, response status code and response headers
|
|
112
|
+
def mark_live_recording_complete_with_http_info(video_id, filename, title, opts = {})
|
|
113
|
+
if @api_client.config.debugging
|
|
114
|
+
@api_client.config.logger.debug "Calling API: VideosApi.mark_live_recording_complete ..."
|
|
115
|
+
end
|
|
116
|
+
# verify the required parameter 'video_id' is set
|
|
117
|
+
fail ArgumentError, "Missing the required parameter 'video_id' when calling VideosApi.mark_live_recording_complete" if video_id.nil?
|
|
118
|
+
# verify the required parameter 'filename' is set
|
|
119
|
+
fail ArgumentError, "Missing the required parameter 'filename' when calling VideosApi.mark_live_recording_complete" if filename.nil?
|
|
120
|
+
# verify the required parameter 'title' is set
|
|
121
|
+
fail ArgumentError, "Missing the required parameter 'title' when calling VideosApi.mark_live_recording_complete" if title.nil?
|
|
122
|
+
# resource path
|
|
123
|
+
local_var_path = "/videos/live/markComplete".sub('{format}','json')
|
|
124
|
+
|
|
125
|
+
# query parameters
|
|
126
|
+
query_params = {}
|
|
127
|
+
|
|
128
|
+
# header parameters
|
|
129
|
+
header_params = {}
|
|
130
|
+
|
|
131
|
+
# HTTP header 'Accept' (if needed)
|
|
132
|
+
local_header_accept = ['application/json']
|
|
133
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
134
|
+
|
|
135
|
+
# HTTP header 'Content-Type'
|
|
136
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
|
137
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
138
|
+
|
|
139
|
+
# form parameters
|
|
140
|
+
form_params = {}
|
|
141
|
+
form_params["videoId"] = video_id
|
|
142
|
+
form_params["filename"] = filename
|
|
143
|
+
form_params["title"] = title
|
|
144
|
+
|
|
145
|
+
# http body (model)
|
|
146
|
+
post_body = nil
|
|
147
|
+
auth_names = ['BBOAuth2']
|
|
148
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
149
|
+
:header_params => header_params,
|
|
150
|
+
:query_params => query_params,
|
|
151
|
+
:form_params => form_params,
|
|
152
|
+
:body => post_body,
|
|
153
|
+
:auth_names => auth_names,
|
|
154
|
+
:return_type => 'VideoPublicRepresentation')
|
|
155
|
+
if @api_client.config.debugging
|
|
156
|
+
@api_client.config.logger.debug "API called: VideosApi#mark_live_recording_complete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
157
|
+
end
|
|
158
|
+
return data, status_code, headers
|
|
159
|
+
end
|
|
160
|
+
|
|
161
|
+
# Generate Signed Url
|
|
162
|
+
# Generates a signed url to be used for video uploads.
|
|
163
|
+
# @param policy The policy to sign
|
|
164
|
+
# @param [Hash] opts the optional parameters
|
|
165
|
+
# @option opts [BOOLEAN] :v4 Whether to do v4 signing
|
|
166
|
+
# @return [String]
|
|
167
|
+
def sign_upload(policy, opts = {})
|
|
168
|
+
data, _status_code, _headers = sign_upload_with_http_info(policy, opts)
|
|
169
|
+
return data
|
|
170
|
+
end
|
|
171
|
+
|
|
172
|
+
# Generate Signed Url
|
|
173
|
+
# Generates a signed url to be used for video uploads.
|
|
174
|
+
# @param policy The policy to sign
|
|
175
|
+
# @param [Hash] opts the optional parameters
|
|
176
|
+
# @option opts [BOOLEAN] :v4 Whether to do v4 signing
|
|
177
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
178
|
+
def sign_upload_with_http_info(policy, opts = {})
|
|
179
|
+
if @api_client.config.debugging
|
|
180
|
+
@api_client.config.logger.debug "Calling API: VideosApi.sign_upload ..."
|
|
181
|
+
end
|
|
182
|
+
# verify the required parameter 'policy' is set
|
|
183
|
+
fail ArgumentError, "Missing the required parameter 'policy' when calling VideosApi.sign_upload" if policy.nil?
|
|
184
|
+
# resource path
|
|
185
|
+
local_var_path = "/video/signedUpload".sub('{format}','json')
|
|
186
|
+
|
|
187
|
+
# query parameters
|
|
188
|
+
query_params = {}
|
|
189
|
+
|
|
190
|
+
# header parameters
|
|
191
|
+
header_params = {}
|
|
192
|
+
|
|
193
|
+
# HTTP header 'Accept' (if needed)
|
|
194
|
+
local_header_accept = ['application/json']
|
|
195
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
196
|
+
|
|
197
|
+
# HTTP header 'Content-Type'
|
|
198
|
+
local_header_content_type = ['application/json']
|
|
199
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
200
|
+
|
|
201
|
+
# form parameters
|
|
202
|
+
form_params = {}
|
|
203
|
+
form_params["v4"] = opts[:'v4'] if !opts[:'v4'].nil?
|
|
204
|
+
|
|
205
|
+
# http body (model)
|
|
206
|
+
post_body = @api_client.object_to_http_body(policy)
|
|
207
|
+
auth_names = []
|
|
208
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
209
|
+
:header_params => header_params,
|
|
210
|
+
:query_params => query_params,
|
|
211
|
+
:form_params => form_params,
|
|
212
|
+
:body => post_body,
|
|
213
|
+
:auth_names => auth_names,
|
|
214
|
+
:return_type => 'String')
|
|
215
|
+
if @api_client.config.debugging
|
|
216
|
+
@api_client.config.logger.debug "API called: VideosApi#sign_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
217
|
+
end
|
|
218
|
+
return data, status_code, headers
|
|
219
|
+
end
|
|
220
|
+
end
|
|
221
|
+
end
|
data/lib/bombbomb/api_client.rb
CHANGED
data/lib/bombbomb/api_error.rb
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#We make it easy to build relationships using simple videos.
|
|
5
5
|
|
|
6
|
-
OpenAPI spec version: 2.0.
|
|
6
|
+
OpenAPI spec version: 2.0.22196
|
|
7
7
|
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
9
|
|
|
@@ -33,12 +33,24 @@ module BombBomb
|
|
|
33
33
|
# When the email should be sent.
|
|
34
34
|
attr_accessor :send_date
|
|
35
35
|
|
|
36
|
-
# Determines whether this is a static or prompted send.
|
|
36
|
+
# Video Prompt: Determines whether this is a static or prompted send.
|
|
37
37
|
attr_accessor :is_prompt
|
|
38
38
|
|
|
39
|
+
# Controls whether or not the content is printed into a template.
|
|
40
|
+
attr_accessor :print_to_template
|
|
41
|
+
|
|
39
42
|
# Static send: The Email to send on behalf of the group members.
|
|
40
43
|
attr_accessor :email_id
|
|
41
44
|
|
|
45
|
+
# Video Prompt: The Video to include as an example for prompted users.
|
|
46
|
+
attr_accessor :example_video_id
|
|
47
|
+
|
|
48
|
+
# The Video to include in the tracking follow up.
|
|
49
|
+
attr_accessor :follow_up_video_id
|
|
50
|
+
|
|
51
|
+
# Video Prompt: The intro text directed toward prompted users.
|
|
52
|
+
attr_accessor :prompt_intro
|
|
53
|
+
|
|
42
54
|
# Video Prompt: The subject line prompting the user to record a video.
|
|
43
55
|
attr_accessor :prompt_subject
|
|
44
56
|
|
|
@@ -65,7 +77,11 @@ module BombBomb
|
|
|
65
77
|
:'client_group_id' => :'clientGroupId',
|
|
66
78
|
:'send_date' => :'sendDate',
|
|
67
79
|
:'is_prompt' => :'isPrompt',
|
|
80
|
+
:'print_to_template' => :'printToTemplate',
|
|
68
81
|
:'email_id' => :'emailId',
|
|
82
|
+
:'example_video_id' => :'exampleVideoId',
|
|
83
|
+
:'follow_up_video_id' => :'followUpVideoId',
|
|
84
|
+
:'prompt_intro' => :'promptIntro',
|
|
69
85
|
:'prompt_subject' => :'promptSubject',
|
|
70
86
|
:'prompt_body' => :'promptBody',
|
|
71
87
|
:'email_subject' => :'emailSubject',
|
|
@@ -82,7 +98,11 @@ module BombBomb
|
|
|
82
98
|
:'client_group_id' => :'String',
|
|
83
99
|
:'send_date' => :'DateTime',
|
|
84
100
|
:'is_prompt' => :'BOOLEAN',
|
|
101
|
+
:'print_to_template' => :'BOOLEAN',
|
|
85
102
|
:'email_id' => :'String',
|
|
103
|
+
:'example_video_id' => :'String',
|
|
104
|
+
:'follow_up_video_id' => :'String',
|
|
105
|
+
:'prompt_intro' => :'String',
|
|
86
106
|
:'prompt_subject' => :'String',
|
|
87
107
|
:'prompt_body' => :'String',
|
|
88
108
|
:'email_subject' => :'String',
|
|
@@ -116,10 +136,26 @@ module BombBomb
|
|
|
116
136
|
self.is_prompt = attributes[:'isPrompt']
|
|
117
137
|
end
|
|
118
138
|
|
|
139
|
+
if attributes.has_key?(:'printToTemplate')
|
|
140
|
+
self.print_to_template = attributes[:'printToTemplate']
|
|
141
|
+
end
|
|
142
|
+
|
|
119
143
|
if attributes.has_key?(:'emailId')
|
|
120
144
|
self.email_id = attributes[:'emailId']
|
|
121
145
|
end
|
|
122
146
|
|
|
147
|
+
if attributes.has_key?(:'exampleVideoId')
|
|
148
|
+
self.example_video_id = attributes[:'exampleVideoId']
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
if attributes.has_key?(:'followUpVideoId')
|
|
152
|
+
self.follow_up_video_id = attributes[:'followUpVideoId']
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
if attributes.has_key?(:'promptIntro')
|
|
156
|
+
self.prompt_intro = attributes[:'promptIntro']
|
|
157
|
+
end
|
|
158
|
+
|
|
123
159
|
if attributes.has_key?(:'promptSubject')
|
|
124
160
|
self.prompt_subject = attributes[:'promptSubject']
|
|
125
161
|
end
|
|
@@ -169,7 +205,11 @@ module BombBomb
|
|
|
169
205
|
client_group_id == o.client_group_id &&
|
|
170
206
|
send_date == o.send_date &&
|
|
171
207
|
is_prompt == o.is_prompt &&
|
|
208
|
+
print_to_template == o.print_to_template &&
|
|
172
209
|
email_id == o.email_id &&
|
|
210
|
+
example_video_id == o.example_video_id &&
|
|
211
|
+
follow_up_video_id == o.follow_up_video_id &&
|
|
212
|
+
prompt_intro == o.prompt_intro &&
|
|
173
213
|
prompt_subject == o.prompt_subject &&
|
|
174
214
|
prompt_body == o.prompt_body &&
|
|
175
215
|
email_subject == o.email_subject &&
|
|
@@ -187,7 +227,7 @@ module BombBomb
|
|
|
187
227
|
# Calculates hash code according to all attributes.
|
|
188
228
|
# @return [Fixnum] Hash code
|
|
189
229
|
def hash
|
|
190
|
-
[id, client_group_id, send_date, is_prompt, email_id, prompt_subject, prompt_body, email_subject, email_body, send_without_video, status].hash
|
|
230
|
+
[id, client_group_id, send_date, is_prompt, print_to_template, email_id, example_video_id, follow_up_video_id, prompt_intro, prompt_subject, prompt_body, email_subject, email_body, send_without_video, status].hash
|
|
191
231
|
end
|
|
192
232
|
|
|
193
233
|
# Builds the object from hash
|