bombbomb 2.0.21454 → 2.0.22196

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +35 -14
  3. data/bombbomb.gemspec +1 -1
  4. data/docs/AutomationsApi.md +115 -0
  5. data/docs/EmailsApi.md +246 -0
  6. data/docs/JerichoConfiguration.md +5 -1
  7. data/docs/PromptBotBot.md +18 -0
  8. data/docs/PromptsApi.md +384 -3
  9. data/docs/SignUploadRequest.md +9 -0
  10. data/docs/SignUploadResponse.md +9 -0
  11. data/docs/VideoEmailPrompt.md +9 -2
  12. data/docs/VideoPublicRepresentation.md +18 -0
  13. data/docs/VideoRecorderMethodResponse.md +15 -0
  14. data/docs/VideosApi.md +175 -0
  15. data/lib/bombbomb.rb +9 -1
  16. data/lib/bombbomb/api/automations_api.rb +150 -0
  17. data/lib/bombbomb/api/curriculum_api.rb +1 -1
  18. data/lib/bombbomb/api/emails_api.rb +293 -0
  19. data/lib/bombbomb/api/prompts_api.rb +439 -5
  20. data/lib/bombbomb/api/teams_api.rb +1 -1
  21. data/lib/bombbomb/api/utilities_api.rb +1 -1
  22. data/lib/bombbomb/api/videos_api.rb +221 -0
  23. data/lib/bombbomb/api/webhooks_api.rb +1 -1
  24. data/lib/bombbomb/api_client.rb +1 -1
  25. data/lib/bombbomb/api_error.rb +1 -1
  26. data/lib/bombbomb/configuration.rb +1 -1
  27. data/lib/bombbomb/models/bb_web_hook.rb +1 -1
  28. data/lib/bombbomb/models/curriculum.rb +1 -1
  29. data/lib/bombbomb/models/curriculum_user_progress.rb +1 -1
  30. data/lib/bombbomb/models/curriculum_with_progress.rb +1 -1
  31. data/lib/bombbomb/models/inline_response_200.rb +1 -1
  32. data/lib/bombbomb/models/inline_response_200_items.rb +1 -1
  33. data/lib/bombbomb/models/jericho_configuration.rb +43 -3
  34. data/lib/bombbomb/models/jericho_performance.rb +1 -1
  35. data/lib/bombbomb/models/o_auth_client.rb +1 -1
  36. data/lib/bombbomb/models/prompt_bot_bot.rb +300 -0
  37. data/lib/bombbomb/models/sign_upload_request.rb +210 -0
  38. data/lib/bombbomb/models/sign_upload_response.rb +210 -0
  39. data/lib/bombbomb/models/string.rb +1 -1
  40. data/lib/bombbomb/models/team_public_representation.rb +1 -1
  41. data/lib/bombbomb/models/video_email_prompt.rb +79 -9
  42. data/lib/bombbomb/models/video_public_representation.rb +302 -0
  43. data/lib/bombbomb/models/video_recorder_method_response.rb +270 -0
  44. data/lib/bombbomb/version.rb +2 -2
  45. data/spec/api/automations_api_spec.rb +71 -0
  46. data/spec/api/emails_api_spec.rb +104 -0
  47. data/spec/api/videos_api_spec.rb +86 -0
  48. data/spec/models/prompt_bot_bot_spec.rb +113 -0
  49. data/spec/models/sign_upload_request_spec.rb +59 -0
  50. data/spec/models/sign_upload_response_spec.rb +59 -0
  51. data/spec/models/video_public_representation_spec.rb +113 -0
  52. data/spec/models/video_recorder_method_response_spec.rb +95 -0
  53. metadata +34 -2
@@ -0,0 +1,270 @@
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 'date'
25
+
26
+ module BombBomb
27
+ # The VideoRecorderMethodResponse class
28
+ class VideoRecorderMethodResponse
29
+ # The id of the user for whom this video will be recorded
30
+ attr_accessor :user_id
31
+
32
+ # The email address of the user for whom this video will be recorded
33
+ attr_accessor :email
34
+
35
+ # The client_id of the user for whom this video will be recorded
36
+ attr_accessor :client_id
37
+
38
+ # The id of the video that will be recorded
39
+ attr_accessor :vid_id
40
+
41
+ # An HTML blob that displays a video recorder
42
+ attr_accessor :content
43
+
44
+ # The width of the video recorder
45
+ attr_accessor :width
46
+
47
+ # the Height of the video recorder
48
+ attr_accessor :height
49
+
50
+ # Whether communication from the recorder will be handled via HTTPS (always true)
51
+ attr_accessor :https
52
+
53
+
54
+ # Attribute mapping from ruby-style variable name to JSON key.
55
+ def self.attribute_map
56
+ {
57
+ :'user_id' => :'user_id',
58
+ :'email' => :'email',
59
+ :'client_id' => :'client_id',
60
+ :'vid_id' => :'vid_id',
61
+ :'content' => :'content',
62
+ :'width' => :'width',
63
+ :'height' => :'height',
64
+ :'https' => :'https'
65
+ }
66
+ end
67
+
68
+ # Attribute type mapping.
69
+ def self.swagger_types
70
+ {
71
+ :'user_id' => :'String',
72
+ :'email' => :'String',
73
+ :'client_id' => :'String',
74
+ :'vid_id' => :'String',
75
+ :'content' => :'String',
76
+ :'width' => :'Integer',
77
+ :'height' => :'Integer',
78
+ :'https' => :'BOOLEAN'
79
+ }
80
+ end
81
+
82
+ # Initializes the object
83
+ # @param [Hash] attributes Model attributes in the form of hash
84
+ def initialize(attributes = {})
85
+ return unless attributes.is_a?(Hash)
86
+
87
+ # convert string to symbol for hash key
88
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
89
+
90
+ if attributes.has_key?(:'user_id')
91
+ self.user_id = attributes[:'user_id']
92
+ end
93
+
94
+ if attributes.has_key?(:'email')
95
+ self.email = attributes[:'email']
96
+ end
97
+
98
+ if attributes.has_key?(:'client_id')
99
+ self.client_id = attributes[:'client_id']
100
+ end
101
+
102
+ if attributes.has_key?(:'vid_id')
103
+ self.vid_id = attributes[:'vid_id']
104
+ end
105
+
106
+ if attributes.has_key?(:'content')
107
+ self.content = attributes[:'content']
108
+ end
109
+
110
+ if attributes.has_key?(:'width')
111
+ self.width = attributes[:'width']
112
+ end
113
+
114
+ if attributes.has_key?(:'height')
115
+ self.height = attributes[:'height']
116
+ end
117
+
118
+ if attributes.has_key?(:'https')
119
+ self.https = attributes[:'https']
120
+ end
121
+
122
+ end
123
+
124
+ # Show invalid properties with the reasons. Usually used together with valid?
125
+ # @return Array for valid properies with the reasons
126
+ def list_invalid_properties
127
+ invalid_properties = Array.new
128
+ return invalid_properties
129
+ end
130
+
131
+ # Check to see if the all the properties in the model are valid
132
+ # @return true if the model is valid
133
+ def valid?
134
+ return true
135
+ end
136
+
137
+ # Checks equality by comparing each attribute.
138
+ # @param [Object] Object to be compared
139
+ def ==(o)
140
+ return true if self.equal?(o)
141
+ self.class == o.class &&
142
+ user_id == o.user_id &&
143
+ email == o.email &&
144
+ client_id == o.client_id &&
145
+ vid_id == o.vid_id &&
146
+ content == o.content &&
147
+ width == o.width &&
148
+ height == o.height &&
149
+ https == o.https
150
+ end
151
+
152
+ # @see the `==` method
153
+ # @param [Object] Object to be compared
154
+ def eql?(o)
155
+ self == o
156
+ end
157
+
158
+ # Calculates hash code according to all attributes.
159
+ # @return [Fixnum] Hash code
160
+ def hash
161
+ [user_id, email, client_id, vid_id, content, width, height, https].hash
162
+ end
163
+
164
+ # Builds the object from hash
165
+ # @param [Hash] attributes Model attributes in the form of hash
166
+ # @return [Object] Returns the model itself
167
+ def build_from_hash(attributes)
168
+ return nil unless attributes.is_a?(Hash)
169
+ self.class.swagger_types.each_pair do |key, type|
170
+ if type =~ /^Array<(.*)>/i
171
+ # check to ensure the input is an array given that the the attribute
172
+ # is documented as an array but the input is not
173
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
174
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
175
+ end
176
+ elsif !attributes[self.class.attribute_map[key]].nil?
177
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
178
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
179
+ end
180
+
181
+ self
182
+ end
183
+
184
+ # Deserializes the data based on type
185
+ # @param string type Data type
186
+ # @param string value Value to be deserialized
187
+ # @return [Object] Deserialized data
188
+ def _deserialize(type, value)
189
+ case type.to_sym
190
+ when :DateTime
191
+ DateTime.parse(value)
192
+ when :Date
193
+ Date.parse(value)
194
+ when :String
195
+ value.to_s
196
+ when :Integer
197
+ value.to_i
198
+ when :Float
199
+ value.to_f
200
+ when :BOOLEAN
201
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
202
+ true
203
+ else
204
+ false
205
+ end
206
+ when :Object
207
+ # generic object (usually a Hash), return directly
208
+ value
209
+ when /\AArray<(?<inner_type>.+)>\z/
210
+ inner_type = Regexp.last_match[:inner_type]
211
+ value.map { |v| _deserialize(inner_type, v) }
212
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
213
+ k_type = Regexp.last_match[:k_type]
214
+ v_type = Regexp.last_match[:v_type]
215
+ {}.tap do |hash|
216
+ value.each do |k, v|
217
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
218
+ end
219
+ end
220
+ else # model
221
+ temp_model = BombBomb.const_get(type).new
222
+ temp_model.build_from_hash(value)
223
+ end
224
+ end
225
+
226
+ # Returns the string representation of the object
227
+ # @return [String] String presentation of the object
228
+ def to_s
229
+ to_hash.to_s
230
+ end
231
+
232
+ # to_body is an alias to to_hash (backward compatibility)
233
+ # @return [Hash] Returns the object in the form of hash
234
+ def to_body
235
+ to_hash
236
+ end
237
+
238
+ # Returns the object in the form of hash
239
+ # @return [Hash] Returns the object in the form of hash
240
+ def to_hash
241
+ hash = {}
242
+ self.class.attribute_map.each_pair do |attr, param|
243
+ value = self.send(attr)
244
+ next if value.nil?
245
+ hash[param] = _to_hash(value)
246
+ end
247
+ hash
248
+ end
249
+
250
+ # Outputs non-array value in the form of hash
251
+ # For object, use to_hash. Otherwise, just return the value
252
+ # @param [Object] value Any valid value
253
+ # @return [Hash] Returns the value in the form of hash
254
+ def _to_hash(value)
255
+ if value.is_a?(Array)
256
+ value.compact.map{ |v| _to_hash(v) }
257
+ elsif value.is_a?(Hash)
258
+ {}.tap do |hash|
259
+ value.each { |k, v| hash[k] = _to_hash(v) }
260
+ end
261
+ elsif value.respond_to? :to_hash
262
+ value.to_hash
263
+ else
264
+ value
265
+ end
266
+ end
267
+
268
+ end
269
+
270
+ end
@@ -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.21454
6
+ OpenAPI spec version: 2.0.22196
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
@@ -22,5 +22,5 @@ limitations under the License.
22
22
  =end
23
23
 
24
24
  module BombBomb
25
- VERSION = "2.0.21454"
25
+ VERSION = "2.0.22196"
26
26
  end
@@ -0,0 +1,71 @@
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 'spec_helper'
25
+ require 'json'
26
+
27
+ # Unit tests for BombBomb::AutomationsApi
28
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
29
+ # Please update as you see appropriate
30
+ describe 'AutomationsApi' do
31
+ before do
32
+ # run before each test
33
+ @instance = BombBomb::AutomationsApi.new
34
+ end
35
+
36
+ after do
37
+ # run after each test
38
+ end
39
+
40
+ describe 'test an instance of AutomationsApi' do
41
+ it 'should create an instact of AutomationsApi' do
42
+ expect(@instance).to be_instance_of(BombBomb::AutomationsApi)
43
+ end
44
+ end
45
+
46
+ # unit tests for get_drip_drop_stats
47
+ # Get Automation Email Stats
48
+ # Get Automation Email Stats
49
+ # @param drip_id The id of the drip
50
+ # @param drip_drop_id The id of the drip drop
51
+ # @param [Hash] opts the optional parameters
52
+ # @return [nil]
53
+ describe 'get_drip_drop_stats test' do
54
+ it "should work" do
55
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
+ end
57
+ end
58
+
59
+ # unit tests for get_drip_stats
60
+ # Get Automation Stats
61
+ # Get Automation Stats
62
+ # @param id The id of the automation
63
+ # @param [Hash] opts the optional parameters
64
+ # @return [nil]
65
+ describe 'get_drip_stats test' do
66
+ it "should work" do
67
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
+ end
69
+ end
70
+
71
+ end
@@ -0,0 +1,104 @@
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 'spec_helper'
25
+ require 'json'
26
+
27
+ # Unit tests for BombBomb::EmailsApi
28
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
29
+ # Please update as you see appropriate
30
+ describe 'EmailsApi' do
31
+ before do
32
+ # run before each test
33
+ @instance = BombBomb::EmailsApi.new
34
+ end
35
+
36
+ after do
37
+ # run after each test
38
+ end
39
+
40
+ describe 'test an instance of EmailsApi' do
41
+ it 'should create an instact of EmailsApi' do
42
+ expect(@instance).to be_instance_of(BombBomb::EmailsApi)
43
+ end
44
+ end
45
+
46
+ # unit tests for create_printing_press_email
47
+ # Create an Email with Printing Press
48
+ # Prints an email using the template id and content to the users account.If a video id, is include it will replace any video placeholders with that video.
49
+ # @param template_id The template id to be printed.
50
+ # @param content The content of the email.
51
+ # @param replace Set whether to replace video placeholders with video id.
52
+ # @param [Hash] opts the optional parameters
53
+ # @option opts [String] :video_id A video to replace video place holders with.
54
+ # @option opts [String] :subject_line The subject line to be printed.
55
+ # @return [nil]
56
+ describe 'create_printing_press_email test' do
57
+ it "should work" do
58
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
59
+ end
60
+ end
61
+
62
+ # unit tests for get_email_tracking
63
+ # Get Email Tracking
64
+ # Get Tracking data for all sends of an Email
65
+ # @param email_id ID of the email
66
+ # @param [Hash] opts the optional parameters
67
+ # @option opts [String] :job_id ID of the Job (or null for all jobs)
68
+ # @return [nil]
69
+ describe 'get_email_tracking test' do
70
+ it "should work" do
71
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
72
+ end
73
+ end
74
+
75
+ # unit tests for get_email_tracking_interactions
76
+ # Get Email Tracking Interactions
77
+ # Get Contact detail interactions for an Email
78
+ # @param email_id ID of the email
79
+ # @param [Hash] opts the optional parameters
80
+ # @option opts [String] :job_id ID of the Job (or null for all jobs)
81
+ # @option opts [String] :interaction_type Interaction type to order and filter by
82
+ # @option opts [String] :search_term Search term to filer by
83
+ # @return [nil]
84
+ describe 'get_email_tracking_interactions test' do
85
+ it "should work" do
86
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
87
+ end
88
+ end
89
+
90
+ # unit tests for get_hourly_email_tracking
91
+ # Get Hourly Email Tracking
92
+ # Get Tracking data for an Email, broken down by the hour and filterable by an Interaction type
93
+ # @param email_id ID of the email
94
+ # @param [Hash] opts the optional parameters
95
+ # @option opts [String] :job_id ID of the Job (or null for all jobs)
96
+ # @option opts [String] :interaction_type Interaction type to filter by
97
+ # @return [nil]
98
+ describe 'get_hourly_email_tracking test' do
99
+ it "should work" do
100
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
101
+ end
102
+ end
103
+
104
+ end