bombbomb 2.0.24005 → 2.0.25797
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/README.md +44 -20
- data/bombbomb.gemspec +1 -1
- data/docs/AccountsApi.md +61 -28
- data/docs/ContactsApi.md +373 -0
- data/docs/EmailsApi.md +168 -0
- data/docs/FilesApi.md +216 -4
- data/docs/HostedDoc.md +13 -0
- data/docs/IntegrationsApi.md +62 -0
- data/docs/ListsApi.md +98 -0
- data/docs/PromptsApi.md +76 -12
- data/docs/SocialsApi.md +172 -71
- data/docs/TeamsApi.md +295 -1
- data/docs/VideoEmailPrompt.md +6 -0
- data/docs/VideosApi.md +59 -0
- data/lib/bombbomb/api/accounts_api.rb +59 -19
- data/lib/bombbomb/api/automations_api.rb +1 -1
- data/lib/bombbomb/api/contacts_api.rb +408 -1
- data/lib/bombbomb/api/curriculum_api.rb +1 -1
- data/lib/bombbomb/api/emails_api.rb +187 -1
- data/lib/bombbomb/api/files_api.rb +239 -7
- data/lib/bombbomb/api/integrations_api.rb +90 -0
- data/lib/bombbomb/api/lists_api.rb +110 -1
- data/lib/bombbomb/api/orders_api.rb +1 -1
- data/lib/bombbomb/api/prompts_api.rb +90 -20
- data/lib/bombbomb/api/socials_api.rb +210 -109
- data/lib/bombbomb/api/teams_api.rb +332 -1
- data/lib/bombbomb/api/utilities_api.rb +1 -1
- data/lib/bombbomb/api/videos_api.rb +66 -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/hosted_doc.rb +250 -0
- 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 +1 -1
- data/lib/bombbomb/models/o_auth_client.rb +1 -1
- data/lib/bombbomb/models/prompt_bot.rb +1 -1
- 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 +67 -5
- data/lib/bombbomb/models/video_encoding_status_response.rb +1 -1
- 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/lib/bombbomb.rb +3 -1
- data/spec/api/integrations_api_spec.rb +58 -0
- data/spec/models/hosted_doc_spec.rb +83 -0
- metadata +11 -3
@@ -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.25797
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
|
@@ -31,6 +31,305 @@ module BombBomb
|
|
31
31
|
@api_client = api_client
|
32
32
|
end
|
33
33
|
|
34
|
+
# Add contacts from a CSV file.
|
35
|
+
# Add multiple contacts through the upload importer from a CSV file.
|
36
|
+
# @param mapping_data The info sent for the contacts
|
37
|
+
# @param list_data The info sent with the import for the list
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [nil]
|
40
|
+
def add_contacts_csv(mapping_data, list_data, opts = {})
|
41
|
+
add_contacts_csv_with_http_info(mapping_data, list_data, opts)
|
42
|
+
return nil
|
43
|
+
end
|
44
|
+
|
45
|
+
# Add contacts from a CSV file.
|
46
|
+
# Add multiple contacts through the upload importer from a CSV file.
|
47
|
+
# @param mapping_data The info sent for the contacts
|
48
|
+
# @param list_data The info sent with the import for the list
|
49
|
+
# @param [Hash] opts the optional parameters
|
50
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
51
|
+
def add_contacts_csv_with_http_info(mapping_data, list_data, opts = {})
|
52
|
+
if @api_client.config.debugging
|
53
|
+
@api_client.config.logger.debug "Calling API: ContactsApi.add_contacts_csv ..."
|
54
|
+
end
|
55
|
+
# verify the required parameter 'mapping_data' is set
|
56
|
+
fail ArgumentError, "Missing the required parameter 'mapping_data' when calling ContactsApi.add_contacts_csv" if mapping_data.nil?
|
57
|
+
# verify the required parameter 'list_data' is set
|
58
|
+
fail ArgumentError, "Missing the required parameter 'list_data' when calling ContactsApi.add_contacts_csv" if list_data.nil?
|
59
|
+
# resource path
|
60
|
+
local_var_path = "/contacts/import_csv".sub('{format}','json')
|
61
|
+
|
62
|
+
# query parameters
|
63
|
+
query_params = {}
|
64
|
+
|
65
|
+
# header parameters
|
66
|
+
header_params = {}
|
67
|
+
|
68
|
+
# HTTP header 'Accept' (if needed)
|
69
|
+
local_header_accept = ['application/json']
|
70
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
71
|
+
|
72
|
+
# HTTP header 'Content-Type'
|
73
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
74
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
75
|
+
|
76
|
+
# form parameters
|
77
|
+
form_params = {}
|
78
|
+
form_params["mappingData"] = mapping_data
|
79
|
+
form_params["listData"] = list_data
|
80
|
+
|
81
|
+
# http body (model)
|
82
|
+
post_body = nil
|
83
|
+
auth_names = ['BBOAuth2']
|
84
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
85
|
+
:header_params => header_params,
|
86
|
+
:query_params => query_params,
|
87
|
+
:form_params => form_params,
|
88
|
+
:body => post_body,
|
89
|
+
:auth_names => auth_names)
|
90
|
+
if @api_client.config.debugging
|
91
|
+
@api_client.config.logger.debug "API called: ContactsApi#add_contacts_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
92
|
+
end
|
93
|
+
return data, status_code, headers
|
94
|
+
end
|
95
|
+
|
96
|
+
# Add a contact.
|
97
|
+
# Add a contact to the users list.
|
98
|
+
# @param contact_email Email of the new contact we are adding
|
99
|
+
# @param [Hash] opts the optional parameters
|
100
|
+
# @option opts [String] :contact_info The info sent for this contact
|
101
|
+
# @return [nil]
|
102
|
+
def add_new_contact(contact_email, opts = {})
|
103
|
+
add_new_contact_with_http_info(contact_email, opts)
|
104
|
+
return nil
|
105
|
+
end
|
106
|
+
|
107
|
+
# Add a contact.
|
108
|
+
# Add a contact to the users list.
|
109
|
+
# @param contact_email Email of the new contact we are adding
|
110
|
+
# @param [Hash] opts the optional parameters
|
111
|
+
# @option opts [String] :contact_info The info sent for this contact
|
112
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
113
|
+
def add_new_contact_with_http_info(contact_email, opts = {})
|
114
|
+
if @api_client.config.debugging
|
115
|
+
@api_client.config.logger.debug "Calling API: ContactsApi.add_new_contact ..."
|
116
|
+
end
|
117
|
+
# verify the required parameter 'contact_email' is set
|
118
|
+
fail ArgumentError, "Missing the required parameter 'contact_email' when calling ContactsApi.add_new_contact" if contact_email.nil?
|
119
|
+
# resource path
|
120
|
+
local_var_path = "/contacts/".sub('{format}','json')
|
121
|
+
|
122
|
+
# query parameters
|
123
|
+
query_params = {}
|
124
|
+
|
125
|
+
# header parameters
|
126
|
+
header_params = {}
|
127
|
+
|
128
|
+
# HTTP header 'Accept' (if needed)
|
129
|
+
local_header_accept = ['application/json']
|
130
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
131
|
+
|
132
|
+
# HTTP header 'Content-Type'
|
133
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
134
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
135
|
+
|
136
|
+
# form parameters
|
137
|
+
form_params = {}
|
138
|
+
form_params["contactEmail"] = contact_email
|
139
|
+
form_params["contactInfo"] = opts[:'contact_info'] if !opts[:'contact_info'].nil?
|
140
|
+
|
141
|
+
# http body (model)
|
142
|
+
post_body = nil
|
143
|
+
auth_names = ['BBOAuth2']
|
144
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
145
|
+
:header_params => header_params,
|
146
|
+
:query_params => query_params,
|
147
|
+
:form_params => form_params,
|
148
|
+
:body => post_body,
|
149
|
+
:auth_names => auth_names)
|
150
|
+
if @api_client.config.debugging
|
151
|
+
@api_client.config.logger.debug "API called: ContactsApi#add_new_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
152
|
+
end
|
153
|
+
return data, status_code, headers
|
154
|
+
end
|
155
|
+
|
156
|
+
# Add custom fields.
|
157
|
+
# Add a new custom field.
|
158
|
+
# @param field_name Custom field name to be added
|
159
|
+
# @param [Hash] opts the optional parameters
|
160
|
+
# @option opts [String] :field_type Custom field type for the field to be added
|
161
|
+
# @return [nil]
|
162
|
+
def add_new_custom_field(field_name, opts = {})
|
163
|
+
add_new_custom_field_with_http_info(field_name, opts)
|
164
|
+
return nil
|
165
|
+
end
|
166
|
+
|
167
|
+
# Add custom fields.
|
168
|
+
# Add a new custom field.
|
169
|
+
# @param field_name Custom field name to be added
|
170
|
+
# @param [Hash] opts the optional parameters
|
171
|
+
# @option opts [String] :field_type Custom field type for the field to be added
|
172
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
173
|
+
def add_new_custom_field_with_http_info(field_name, opts = {})
|
174
|
+
if @api_client.config.debugging
|
175
|
+
@api_client.config.logger.debug "Calling API: ContactsApi.add_new_custom_field ..."
|
176
|
+
end
|
177
|
+
# verify the required parameter 'field_name' is set
|
178
|
+
fail ArgumentError, "Missing the required parameter 'field_name' when calling ContactsApi.add_new_custom_field" if field_name.nil?
|
179
|
+
# resource path
|
180
|
+
local_var_path = "/contacts/custom_fields/".sub('{format}','json')
|
181
|
+
|
182
|
+
# query parameters
|
183
|
+
query_params = {}
|
184
|
+
|
185
|
+
# header parameters
|
186
|
+
header_params = {}
|
187
|
+
|
188
|
+
# HTTP header 'Accept' (if needed)
|
189
|
+
local_header_accept = ['application/json']
|
190
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
191
|
+
|
192
|
+
# HTTP header 'Content-Type'
|
193
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
194
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
195
|
+
|
196
|
+
# form parameters
|
197
|
+
form_params = {}
|
198
|
+
form_params["fieldName"] = field_name
|
199
|
+
form_params["fieldType"] = opts[:'field_type'] if !opts[:'field_type'].nil?
|
200
|
+
|
201
|
+
# http body (model)
|
202
|
+
post_body = nil
|
203
|
+
auth_names = ['BBOAuth2']
|
204
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
205
|
+
:header_params => header_params,
|
206
|
+
:query_params => query_params,
|
207
|
+
:form_params => form_params,
|
208
|
+
:body => post_body,
|
209
|
+
:auth_names => auth_names)
|
210
|
+
if @api_client.config.debugging
|
211
|
+
@api_client.config.logger.debug "API called: ContactsApi#add_new_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
212
|
+
end
|
213
|
+
return data, status_code, headers
|
214
|
+
end
|
215
|
+
|
216
|
+
# Add pasted contacts.
|
217
|
+
# Add the pasted contacts to the users list.
|
218
|
+
# @param contact_emails Emails array of the new contacts we are adding
|
219
|
+
# @param [Hash] opts the optional parameters
|
220
|
+
# @option opts [String] :list_info Information about the lists id, recalculations on totals, consent etc
|
221
|
+
# @return [nil]
|
222
|
+
def add_pasted_contacts(contact_emails, opts = {})
|
223
|
+
add_pasted_contacts_with_http_info(contact_emails, opts)
|
224
|
+
return nil
|
225
|
+
end
|
226
|
+
|
227
|
+
# Add pasted contacts.
|
228
|
+
# Add the pasted contacts to the users list.
|
229
|
+
# @param contact_emails Emails array of the new contacts we are adding
|
230
|
+
# @param [Hash] opts the optional parameters
|
231
|
+
# @option opts [String] :list_info Information about the lists id, recalculations on totals, consent etc
|
232
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
233
|
+
def add_pasted_contacts_with_http_info(contact_emails, opts = {})
|
234
|
+
if @api_client.config.debugging
|
235
|
+
@api_client.config.logger.debug "Calling API: ContactsApi.add_pasted_contacts ..."
|
236
|
+
end
|
237
|
+
# verify the required parameter 'contact_emails' is set
|
238
|
+
fail ArgumentError, "Missing the required parameter 'contact_emails' when calling ContactsApi.add_pasted_contacts" if contact_emails.nil?
|
239
|
+
# resource path
|
240
|
+
local_var_path = "/contacts/paste".sub('{format}','json')
|
241
|
+
|
242
|
+
# query parameters
|
243
|
+
query_params = {}
|
244
|
+
|
245
|
+
# header parameters
|
246
|
+
header_params = {}
|
247
|
+
|
248
|
+
# HTTP header 'Accept' (if needed)
|
249
|
+
local_header_accept = ['application/json']
|
250
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
251
|
+
|
252
|
+
# HTTP header 'Content-Type'
|
253
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
254
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
255
|
+
|
256
|
+
# form parameters
|
257
|
+
form_params = {}
|
258
|
+
form_params["contactEmails"] = contact_emails
|
259
|
+
form_params["listInfo"] = opts[:'list_info'] if !opts[:'list_info'].nil?
|
260
|
+
|
261
|
+
# http body (model)
|
262
|
+
post_body = nil
|
263
|
+
auth_names = ['BBOAuth2']
|
264
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
265
|
+
:header_params => header_params,
|
266
|
+
:query_params => query_params,
|
267
|
+
:form_params => form_params,
|
268
|
+
:body => post_body,
|
269
|
+
:auth_names => auth_names)
|
270
|
+
if @api_client.config.debugging
|
271
|
+
@api_client.config.logger.debug "API called: ContactsApi#add_pasted_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
272
|
+
end
|
273
|
+
return data, status_code, headers
|
274
|
+
end
|
275
|
+
|
276
|
+
# Format CSV.
|
277
|
+
# Format a CSV file to an object.
|
278
|
+
# @param file The CSV file being uploaded
|
279
|
+
# @param [Hash] opts the optional parameters
|
280
|
+
# @return [nil]
|
281
|
+
def c_sv_to_object(file, opts = {})
|
282
|
+
c_sv_to_object_with_http_info(file, opts)
|
283
|
+
return nil
|
284
|
+
end
|
285
|
+
|
286
|
+
# Format CSV.
|
287
|
+
# Format a CSV file to an object.
|
288
|
+
# @param file The CSV file being uploaded
|
289
|
+
# @param [Hash] opts the optional parameters
|
290
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
291
|
+
def c_sv_to_object_with_http_info(file, opts = {})
|
292
|
+
if @api_client.config.debugging
|
293
|
+
@api_client.config.logger.debug "Calling API: ContactsApi.c_sv_to_object ..."
|
294
|
+
end
|
295
|
+
# verify the required parameter 'file' is set
|
296
|
+
fail ArgumentError, "Missing the required parameter 'file' when calling ContactsApi.c_sv_to_object" if file.nil?
|
297
|
+
# resource path
|
298
|
+
local_var_path = "/csv-to-object".sub('{format}','json')
|
299
|
+
|
300
|
+
# query parameters
|
301
|
+
query_params = {}
|
302
|
+
|
303
|
+
# header parameters
|
304
|
+
header_params = {}
|
305
|
+
|
306
|
+
# HTTP header 'Accept' (if needed)
|
307
|
+
local_header_accept = ['application/json']
|
308
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
309
|
+
|
310
|
+
# HTTP header 'Content-Type'
|
311
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
312
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
313
|
+
|
314
|
+
# form parameters
|
315
|
+
form_params = {}
|
316
|
+
form_params["file"] = file
|
317
|
+
|
318
|
+
# http body (model)
|
319
|
+
post_body = nil
|
320
|
+
auth_names = ['BBOAuth2']
|
321
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
322
|
+
:header_params => header_params,
|
323
|
+
:query_params => query_params,
|
324
|
+
:form_params => form_params,
|
325
|
+
:body => post_body,
|
326
|
+
:auth_names => auth_names)
|
327
|
+
if @api_client.config.debugging
|
328
|
+
@api_client.config.logger.debug "API called: ContactsApi#c_sv_to_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
329
|
+
end
|
330
|
+
return data, status_code, headers
|
331
|
+
end
|
332
|
+
|
34
333
|
# Delete Contacts
|
35
334
|
# Delete contacts
|
36
335
|
# @param list_id The list of contacts to be deleted.
|
@@ -87,5 +386,113 @@ module BombBomb
|
|
87
386
|
end
|
88
387
|
return data, status_code, headers
|
89
388
|
end
|
389
|
+
|
390
|
+
# Get Contact Details
|
391
|
+
# Get the contact details
|
392
|
+
# @param id Guid for the contact.
|
393
|
+
# @param [Hash] opts the optional parameters
|
394
|
+
# @return [nil]
|
395
|
+
def get_contact_by_id(id, opts = {})
|
396
|
+
get_contact_by_id_with_http_info(id, opts)
|
397
|
+
return nil
|
398
|
+
end
|
399
|
+
|
400
|
+
# Get Contact Details
|
401
|
+
# Get the contact details
|
402
|
+
# @param id Guid for the contact.
|
403
|
+
# @param [Hash] opts the optional parameters
|
404
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
405
|
+
def get_contact_by_id_with_http_info(id, opts = {})
|
406
|
+
if @api_client.config.debugging
|
407
|
+
@api_client.config.logger.debug "Calling API: ContactsApi.get_contact_by_id ..."
|
408
|
+
end
|
409
|
+
# verify the required parameter 'id' is set
|
410
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ContactsApi.get_contact_by_id" if id.nil?
|
411
|
+
# resource path
|
412
|
+
local_var_path = "/contact/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
|
413
|
+
|
414
|
+
# query parameters
|
415
|
+
query_params = {}
|
416
|
+
|
417
|
+
# header parameters
|
418
|
+
header_params = {}
|
419
|
+
|
420
|
+
# HTTP header 'Accept' (if needed)
|
421
|
+
local_header_accept = ['application/json']
|
422
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
423
|
+
|
424
|
+
# HTTP header 'Content-Type'
|
425
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
426
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
427
|
+
|
428
|
+
# form parameters
|
429
|
+
form_params = {}
|
430
|
+
|
431
|
+
# http body (model)
|
432
|
+
post_body = nil
|
433
|
+
auth_names = ['BBOAuth2']
|
434
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
435
|
+
:header_params => header_params,
|
436
|
+
:query_params => query_params,
|
437
|
+
:form_params => form_params,
|
438
|
+
:body => post_body,
|
439
|
+
:auth_names => auth_names)
|
440
|
+
if @api_client.config.debugging
|
441
|
+
@api_client.config.logger.debug "API called: ContactsApi#get_contact_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
442
|
+
end
|
443
|
+
return data, status_code, headers
|
444
|
+
end
|
445
|
+
|
446
|
+
# Get custom fields.
|
447
|
+
# Get the current users custom fields.
|
448
|
+
# @param [Hash] opts the optional parameters
|
449
|
+
# @return [nil]
|
450
|
+
def get_custom_fields(opts = {})
|
451
|
+
get_custom_fields_with_http_info(opts)
|
452
|
+
return nil
|
453
|
+
end
|
454
|
+
|
455
|
+
# Get custom fields.
|
456
|
+
# Get the current users custom fields.
|
457
|
+
# @param [Hash] opts the optional parameters
|
458
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
459
|
+
def get_custom_fields_with_http_info(opts = {})
|
460
|
+
if @api_client.config.debugging
|
461
|
+
@api_client.config.logger.debug "Calling API: ContactsApi.get_custom_fields ..."
|
462
|
+
end
|
463
|
+
# resource path
|
464
|
+
local_var_path = "/contacts/custom_fields/".sub('{format}','json')
|
465
|
+
|
466
|
+
# query parameters
|
467
|
+
query_params = {}
|
468
|
+
|
469
|
+
# header parameters
|
470
|
+
header_params = {}
|
471
|
+
|
472
|
+
# HTTP header 'Accept' (if needed)
|
473
|
+
local_header_accept = ['application/json']
|
474
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
475
|
+
|
476
|
+
# HTTP header 'Content-Type'
|
477
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
478
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
479
|
+
|
480
|
+
# form parameters
|
481
|
+
form_params = {}
|
482
|
+
|
483
|
+
# http body (model)
|
484
|
+
post_body = nil
|
485
|
+
auth_names = ['BBOAuth2']
|
486
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
487
|
+
:header_params => header_params,
|
488
|
+
:query_params => query_params,
|
489
|
+
:form_params => form_params,
|
490
|
+
:body => post_body,
|
491
|
+
:auth_names => auth_names)
|
492
|
+
if @api_client.config.debugging
|
493
|
+
@api_client.config.logger.debug "API called: ContactsApi#get_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
494
|
+
end
|
495
|
+
return data, status_code, headers
|
496
|
+
end
|
90
497
|
end
|
91
498
|
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.
|
6
|
+
OpenAPI spec version: 2.0.25797
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
|
@@ -102,6 +102,61 @@ module BombBomb
|
|
102
102
|
return data, status_code, headers
|
103
103
|
end
|
104
104
|
|
105
|
+
# Get all user templates
|
106
|
+
# Get all templates accessible to the current user
|
107
|
+
# @param [Hash] opts the optional parameters
|
108
|
+
# @option opts [BOOLEAN] :quick_send_only Whether to return only quick send templates.
|
109
|
+
# @return [nil]
|
110
|
+
def get_all_templates_for_current_user(opts = {})
|
111
|
+
get_all_templates_for_current_user_with_http_info(opts)
|
112
|
+
return nil
|
113
|
+
end
|
114
|
+
|
115
|
+
# Get all user templates
|
116
|
+
# Get all templates accessible to the current user
|
117
|
+
# @param [Hash] opts the optional parameters
|
118
|
+
# @option opts [BOOLEAN] :quick_send_only Whether to return only quick send templates.
|
119
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
120
|
+
def get_all_templates_for_current_user_with_http_info(opts = {})
|
121
|
+
if @api_client.config.debugging
|
122
|
+
@api_client.config.logger.debug "Calling API: EmailsApi.get_all_templates_for_current_user ..."
|
123
|
+
end
|
124
|
+
# resource path
|
125
|
+
local_var_path = "/emails/templates".sub('{format}','json')
|
126
|
+
|
127
|
+
# query parameters
|
128
|
+
query_params = {}
|
129
|
+
query_params[:'quickSendOnly'] = opts[:'quick_send_only'] if !opts[:'quick_send_only'].nil?
|
130
|
+
|
131
|
+
# header parameters
|
132
|
+
header_params = {}
|
133
|
+
|
134
|
+
# HTTP header 'Accept' (if needed)
|
135
|
+
local_header_accept = ['application/json']
|
136
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
137
|
+
|
138
|
+
# HTTP header 'Content-Type'
|
139
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
140
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
141
|
+
|
142
|
+
# form parameters
|
143
|
+
form_params = {}
|
144
|
+
|
145
|
+
# http body (model)
|
146
|
+
post_body = nil
|
147
|
+
auth_names = ['BBOAuth2']
|
148
|
+
data, status_code, headers = @api_client.call_api(:GET, 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
|
+
if @api_client.config.debugging
|
155
|
+
@api_client.config.logger.debug "API called: EmailsApi#get_all_templates_for_current_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
156
|
+
end
|
157
|
+
return data, status_code, headers
|
158
|
+
end
|
159
|
+
|
105
160
|
# Get Email Tracking
|
106
161
|
# Get Tracking data for all sends of an Email
|
107
162
|
# @param email_id ID of the email
|
@@ -287,5 +342,136 @@ module BombBomb
|
|
287
342
|
end
|
288
343
|
return data, status_code, headers
|
289
344
|
end
|
345
|
+
|
346
|
+
# Get all quicksend templates
|
347
|
+
# Get all quicksend templates accessible to the user.
|
348
|
+
# @param [Hash] opts the optional parameters
|
349
|
+
# @return [nil]
|
350
|
+
def get_quick_send_templates(opts = {})
|
351
|
+
get_quick_send_templates_with_http_info(opts)
|
352
|
+
return nil
|
353
|
+
end
|
354
|
+
|
355
|
+
# Get all quicksend templates
|
356
|
+
# Get all quicksend templates accessible to the user.
|
357
|
+
# @param [Hash] opts the optional parameters
|
358
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
359
|
+
def get_quick_send_templates_with_http_info(opts = {})
|
360
|
+
if @api_client.config.debugging
|
361
|
+
@api_client.config.logger.debug "Calling API: EmailsApi.get_quick_send_templates ..."
|
362
|
+
end
|
363
|
+
# resource path
|
364
|
+
local_var_path = "/emails/quicksend/templates".sub('{format}','json')
|
365
|
+
|
366
|
+
# query parameters
|
367
|
+
query_params = {}
|
368
|
+
|
369
|
+
# header parameters
|
370
|
+
header_params = {}
|
371
|
+
|
372
|
+
# HTTP header 'Accept' (if needed)
|
373
|
+
local_header_accept = ['application/json']
|
374
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
375
|
+
|
376
|
+
# HTTP header 'Content-Type'
|
377
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
378
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
379
|
+
|
380
|
+
# form parameters
|
381
|
+
form_params = {}
|
382
|
+
|
383
|
+
# http body (model)
|
384
|
+
post_body = nil
|
385
|
+
auth_names = ['BBOAuth2']
|
386
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
387
|
+
:header_params => header_params,
|
388
|
+
:query_params => query_params,
|
389
|
+
:form_params => form_params,
|
390
|
+
:body => post_body,
|
391
|
+
:auth_names => auth_names)
|
392
|
+
if @api_client.config.debugging
|
393
|
+
@api_client.config.logger.debug "API called: EmailsApi#get_quick_send_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
394
|
+
end
|
395
|
+
return data, status_code, headers
|
396
|
+
end
|
397
|
+
|
398
|
+
# Send a quicksend email
|
399
|
+
# Send a quicksend video email to the list or users provided.
|
400
|
+
# @param [Hash] opts the optional parameters
|
401
|
+
# @option opts [String] :video_id A guid id for the video.
|
402
|
+
# @option opts [String] :email_addresses A semi-colon separated list of email addresses to send to.
|
403
|
+
# @option opts [String] :subject Subject line for the email.
|
404
|
+
# @option opts [String] :message Message for the body of the email.
|
405
|
+
# @option opts [String] :list_ids An array of list ids
|
406
|
+
# @option opts [Integer] :scheduled_send_timestamp When to schedule the send (seconds since epoch). null value means send immediately.
|
407
|
+
# @option opts [String] :extended_properties Bool value that when checked will send back both emailId as well as extra properties
|
408
|
+
# @option opts [String] :template_id Id of a template to use for this send. A null value means use the default for this user.
|
409
|
+
# @option opts [String] :strip_html remove HTML elements
|
410
|
+
# @return [nil]
|
411
|
+
def video_quick_sender(opts = {})
|
412
|
+
video_quick_sender_with_http_info(opts)
|
413
|
+
return nil
|
414
|
+
end
|
415
|
+
|
416
|
+
# Send a quicksend email
|
417
|
+
# Send a quicksend video email to the list or users provided.
|
418
|
+
# @param [Hash] opts the optional parameters
|
419
|
+
# @option opts [String] :video_id A guid id for the video.
|
420
|
+
# @option opts [String] :email_addresses A semi-colon separated list of email addresses to send to.
|
421
|
+
# @option opts [String] :subject Subject line for the email.
|
422
|
+
# @option opts [String] :message Message for the body of the email.
|
423
|
+
# @option opts [String] :list_ids An array of list ids
|
424
|
+
# @option opts [Integer] :scheduled_send_timestamp When to schedule the send (seconds since epoch). null value means send immediately.
|
425
|
+
# @option opts [String] :extended_properties Bool value that when checked will send back both emailId as well as extra properties
|
426
|
+
# @option opts [String] :template_id Id of a template to use for this send. A null value means use the default for this user.
|
427
|
+
# @option opts [String] :strip_html remove HTML elements
|
428
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
429
|
+
def video_quick_sender_with_http_info(opts = {})
|
430
|
+
if @api_client.config.debugging
|
431
|
+
@api_client.config.logger.debug "Calling API: EmailsApi.video_quick_sender ..."
|
432
|
+
end
|
433
|
+
# resource path
|
434
|
+
local_var_path = "/emails/quicksend".sub('{format}','json')
|
435
|
+
|
436
|
+
# query parameters
|
437
|
+
query_params = {}
|
438
|
+
|
439
|
+
# header parameters
|
440
|
+
header_params = {}
|
441
|
+
|
442
|
+
# HTTP header 'Accept' (if needed)
|
443
|
+
local_header_accept = ['application/json']
|
444
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
445
|
+
|
446
|
+
# HTTP header 'Content-Type'
|
447
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
448
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
449
|
+
|
450
|
+
# form parameters
|
451
|
+
form_params = {}
|
452
|
+
form_params["videoId"] = opts[:'video_id'] if !opts[:'video_id'].nil?
|
453
|
+
form_params["emailAddresses"] = opts[:'email_addresses'] if !opts[:'email_addresses'].nil?
|
454
|
+
form_params["subject"] = opts[:'subject'] if !opts[:'subject'].nil?
|
455
|
+
form_params["message"] = opts[:'message'] if !opts[:'message'].nil?
|
456
|
+
form_params["listIds"] = opts[:'list_ids'] if !opts[:'list_ids'].nil?
|
457
|
+
form_params["scheduledSendTimestamp"] = opts[:'scheduled_send_timestamp'] if !opts[:'scheduled_send_timestamp'].nil?
|
458
|
+
form_params["extendedProperties"] = opts[:'extended_properties'] if !opts[:'extended_properties'].nil?
|
459
|
+
form_params["templateId"] = opts[:'template_id'] if !opts[:'template_id'].nil?
|
460
|
+
form_params["stripHTML"] = opts[:'strip_html'] if !opts[:'strip_html'].nil?
|
461
|
+
|
462
|
+
# http body (model)
|
463
|
+
post_body = nil
|
464
|
+
auth_names = ['BBOAuth2']
|
465
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
466
|
+
:header_params => header_params,
|
467
|
+
:query_params => query_params,
|
468
|
+
:form_params => form_params,
|
469
|
+
:body => post_body,
|
470
|
+
:auth_names => auth_names)
|
471
|
+
if @api_client.config.debugging
|
472
|
+
@api_client.config.logger.debug "API called: EmailsApi#video_quick_sender\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
473
|
+
end
|
474
|
+
return data, status_code, headers
|
475
|
+
end
|
290
476
|
end
|
291
477
|
end
|