bombbomb 2.0.22196 → 2.0.24005
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 +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
@@ -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.24005
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
|
@@ -35,15 +35,18 @@ module BombBomb
|
|
35
35
|
# Creates a Prompt Bot that sends emails to contacts on a list over the span of time defined.
|
36
36
|
# @param list_id The list id to attach the bot to.
|
37
37
|
# @param email_id The default email to use.
|
38
|
-
# @param
|
39
|
-
# @param
|
40
|
-
# @param
|
38
|
+
# @param name The name of the bot.
|
39
|
+
# @param subject The subject of the default email.
|
40
|
+
# @param content The content used in the email.
|
41
|
+
# @param contact_field_value_column The custom field value column with dates for this bot.
|
41
42
|
# @param bot_type_id The type of bot to create.
|
42
43
|
# @param template_id The template used to create the email id.
|
43
44
|
# @param [Hash] opts the optional parameters
|
44
|
-
# @
|
45
|
-
|
46
|
-
|
45
|
+
# @option opts [String] :video_id The video used in the email.
|
46
|
+
# @option opts [String] :end_date The time frame to complete sending to the list.
|
47
|
+
# @return [PromptBot]
|
48
|
+
def create_prompt_bot(list_id, email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts = {})
|
49
|
+
data, _status_code, _headers = create_prompt_bot_with_http_info(list_id, email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts)
|
47
50
|
return data
|
48
51
|
end
|
49
52
|
|
@@ -51,14 +54,17 @@ module BombBomb
|
|
51
54
|
# Creates a Prompt Bot that sends emails to contacts on a list over the span of time defined.
|
52
55
|
# @param list_id The list id to attach the bot to.
|
53
56
|
# @param email_id The default email to use.
|
54
|
-
# @param
|
55
|
-
# @param
|
56
|
-
# @param
|
57
|
+
# @param name The name of the bot.
|
58
|
+
# @param subject The subject of the default email.
|
59
|
+
# @param content The content used in the email.
|
60
|
+
# @param contact_field_value_column The custom field value column with dates for this bot.
|
57
61
|
# @param bot_type_id The type of bot to create.
|
58
62
|
# @param template_id The template used to create the email id.
|
59
63
|
# @param [Hash] opts the optional parameters
|
60
|
-
# @
|
61
|
-
|
64
|
+
# @option opts [String] :video_id The video used in the email.
|
65
|
+
# @option opts [String] :end_date The time frame to complete sending to the list.
|
66
|
+
# @return [Array<(PromptBot, Fixnum, Hash)>] PromptBot data, response status code and response headers
|
67
|
+
def create_prompt_bot_with_http_info(list_id, email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts = {})
|
62
68
|
if @api_client.config.debugging
|
63
69
|
@api_client.config.logger.debug "Calling API: PromptsApi.create_prompt_bot ..."
|
64
70
|
end
|
@@ -66,12 +72,14 @@ module BombBomb
|
|
66
72
|
fail ArgumentError, "Missing the required parameter 'list_id' when calling PromptsApi.create_prompt_bot" if list_id.nil?
|
67
73
|
# verify the required parameter 'email_id' is set
|
68
74
|
fail ArgumentError, "Missing the required parameter 'email_id' when calling PromptsApi.create_prompt_bot" if email_id.nil?
|
69
|
-
# verify the required parameter '
|
70
|
-
fail ArgumentError, "Missing the required parameter '
|
71
|
-
# verify the required parameter '
|
72
|
-
fail ArgumentError, "Missing the required parameter '
|
73
|
-
# verify the required parameter '
|
74
|
-
fail ArgumentError, "Missing the required parameter '
|
75
|
+
# verify the required parameter 'name' is set
|
76
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PromptsApi.create_prompt_bot" if name.nil?
|
77
|
+
# verify the required parameter 'subject' is set
|
78
|
+
fail ArgumentError, "Missing the required parameter 'subject' when calling PromptsApi.create_prompt_bot" if subject.nil?
|
79
|
+
# verify the required parameter 'content' is set
|
80
|
+
fail ArgumentError, "Missing the required parameter 'content' when calling PromptsApi.create_prompt_bot" if content.nil?
|
81
|
+
# verify the required parameter 'contact_field_value_column' is set
|
82
|
+
fail ArgumentError, "Missing the required parameter 'contact_field_value_column' when calling PromptsApi.create_prompt_bot" if contact_field_value_column.nil?
|
75
83
|
# verify the required parameter 'bot_type_id' is set
|
76
84
|
fail ArgumentError, "Missing the required parameter 'bot_type_id' when calling PromptsApi.create_prompt_bot" if bot_type_id.nil?
|
77
85
|
# verify the required parameter 'template_id' is set
|
@@ -97,11 +105,14 @@ module BombBomb
|
|
97
105
|
form_params = {}
|
98
106
|
form_params["listId"] = list_id
|
99
107
|
form_params["emailId"] = email_id
|
100
|
-
form_params["
|
101
|
-
form_params["
|
102
|
-
form_params["
|
108
|
+
form_params["name"] = name
|
109
|
+
form_params["subject"] = subject
|
110
|
+
form_params["content"] = content
|
111
|
+
form_params["contactFieldValueColumn"] = contact_field_value_column
|
103
112
|
form_params["botTypeId"] = bot_type_id
|
104
113
|
form_params["templateId"] = template_id
|
114
|
+
form_params["videoId"] = opts[:'video_id'] if !opts[:'video_id'].nil?
|
115
|
+
form_params["endDate"] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
105
116
|
|
106
117
|
# http body (model)
|
107
118
|
post_body = nil
|
@@ -112,7 +123,7 @@ module BombBomb
|
|
112
123
|
:form_params => form_params,
|
113
124
|
:body => post_body,
|
114
125
|
:auth_names => auth_names,
|
115
|
-
:return_type => '
|
126
|
+
:return_type => 'PromptBot')
|
116
127
|
if @api_client.config.debugging
|
117
128
|
@api_client.config.logger.debug "API called: PromptsApi#create_prompt_bot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
118
129
|
end
|
@@ -232,7 +243,7 @@ module BombBomb
|
|
232
243
|
# List Prompt Bots
|
233
244
|
# Returns a list of all Prompt Bots for the user.
|
234
245
|
# @param [Hash] opts the optional parameters
|
235
|
-
# @return [Array<
|
246
|
+
# @return [Array<PromptBot>]
|
236
247
|
def get_prompt_bots(opts = {})
|
237
248
|
data, _status_code, _headers = get_prompt_bots_with_http_info(opts)
|
238
249
|
return data
|
@@ -241,7 +252,7 @@ module BombBomb
|
|
241
252
|
# List Prompt Bots
|
242
253
|
# Returns a list of all Prompt Bots for the user.
|
243
254
|
# @param [Hash] opts the optional parameters
|
244
|
-
# @return [Array<(Array<
|
255
|
+
# @return [Array<(Array<PromptBot>, Fixnum, Hash)>] Array<PromptBot> data, response status code and response headers
|
245
256
|
def get_prompt_bots_with_http_info(opts = {})
|
246
257
|
if @api_client.config.debugging
|
247
258
|
@api_client.config.logger.debug "Calling API: PromptsApi.get_prompt_bots ..."
|
@@ -275,7 +286,7 @@ module BombBomb
|
|
275
286
|
:form_params => form_params,
|
276
287
|
:body => post_body,
|
277
288
|
:auth_names => auth_names,
|
278
|
-
:return_type => 'Array<
|
289
|
+
:return_type => 'Array<PromptBot>')
|
279
290
|
if @api_client.config.debugging
|
280
291
|
@api_client.config.logger.debug "API called: PromptsApi#get_prompt_bots\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
281
292
|
end
|
@@ -447,10 +458,11 @@ module BombBomb
|
|
447
458
|
# Respond to a prompt
|
448
459
|
# Respond to a prompt by either adding a video, sending without a video or cancelling the prompt.
|
449
460
|
# @param id The id of the prompt.
|
450
|
-
# @param choice The users' selection. Can be: WithVideo, WithEmail, Cancel
|
461
|
+
# @param choice The users' selection. Can be: WithVideo, WithEmail, Cancel, Restore, Reset, Manual
|
451
462
|
# @param [Hash] opts the optional parameters
|
452
463
|
# @option opts [String] :video_id The id of the video.
|
453
|
-
# @option opts [String] :email_id The id of the
|
464
|
+
# @option opts [String] :email_id The id of the email.
|
465
|
+
# @option opts [String] :subject The subject of the email
|
454
466
|
# @return [VideoEmailPrompt]
|
455
467
|
def respond_to_video_email_prompt(id, choice, opts = {})
|
456
468
|
data, _status_code, _headers = respond_to_video_email_prompt_with_http_info(id, choice, opts)
|
@@ -460,10 +472,11 @@ module BombBomb
|
|
460
472
|
# Respond to a prompt
|
461
473
|
# Respond to a prompt by either adding a video, sending without a video or cancelling the prompt.
|
462
474
|
# @param id The id of the prompt.
|
463
|
-
# @param choice The users' selection. Can be: WithVideo, WithEmail, Cancel
|
475
|
+
# @param choice The users' selection. Can be: WithVideo, WithEmail, Cancel, Restore, Reset, Manual
|
464
476
|
# @param [Hash] opts the optional parameters
|
465
477
|
# @option opts [String] :video_id The id of the video.
|
466
|
-
# @option opts [String] :email_id The id of the
|
478
|
+
# @option opts [String] :email_id The id of the email.
|
479
|
+
# @option opts [String] :subject The subject of the email
|
467
480
|
# @return [Array<(VideoEmailPrompt, Fixnum, Hash)>] VideoEmailPrompt data, response status code and response headers
|
468
481
|
def respond_to_video_email_prompt_with_http_info(id, choice, opts = {})
|
469
482
|
if @api_client.config.debugging
|
@@ -474,8 +487,8 @@ module BombBomb
|
|
474
487
|
# verify the required parameter 'choice' is set
|
475
488
|
fail ArgumentError, "Missing the required parameter 'choice' when calling PromptsApi.respond_to_video_email_prompt" if choice.nil?
|
476
489
|
# verify enum value
|
477
|
-
unless ['WithVideo', 'WithEmail', 'Cancel'].include?(choice)
|
478
|
-
fail ArgumentError, "invalid value for 'choice', must be one of WithVideo, WithEmail, Cancel"
|
490
|
+
unless ['WithVideo', 'WithEmail', 'Cancel', 'Restore', 'Reset', 'Manual'].include?(choice)
|
491
|
+
fail ArgumentError, "invalid value for 'choice', must be one of WithVideo, WithEmail, Cancel, Restore, Reset, Manual"
|
479
492
|
end
|
480
493
|
# resource path
|
481
494
|
local_var_path = "/prompt/{id}/response".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
|
@@ -499,6 +512,7 @@ module BombBomb
|
|
499
512
|
form_params["choice"] = choice
|
500
513
|
form_params["videoId"] = opts[:'video_id'] if !opts[:'video_id'].nil?
|
501
514
|
form_params["emailId"] = opts[:'email_id'] if !opts[:'email_id'].nil?
|
515
|
+
form_params["subject"] = opts[:'subject'] if !opts[:'subject'].nil?
|
502
516
|
|
503
517
|
# http body (model)
|
504
518
|
post_body = nil
|
@@ -519,30 +533,58 @@ module BombBomb
|
|
519
533
|
# Update Prompt Bot
|
520
534
|
# Updates a Prompt Bot's settings.
|
521
535
|
# @param id The bot id.
|
536
|
+
# @param list_id The list id to attach the bot to.
|
537
|
+
# @param email_id The default email to use.
|
538
|
+
# @param name The name of the bot.
|
539
|
+
# @param subject The subject of the default email.
|
540
|
+
# @param content The content used in the default email.
|
541
|
+
# @param contact_field_value_column The custom field value column with dates for this bot.
|
542
|
+
# @param template_id The template used to create the email id.
|
522
543
|
# @param [Hash] opts the optional parameters
|
523
|
-
# @option opts [String] :
|
544
|
+
# @option opts [String] :video_id The video used in the default email.
|
524
545
|
# @option opts [String] :end_date The time frame to complete sending to the list.
|
525
546
|
# @option opts [String] :status The status of the bot.
|
526
|
-
# @return [
|
527
|
-
def update_prompt_bot(id, opts = {})
|
528
|
-
data, _status_code, _headers = update_prompt_bot_with_http_info(id, opts)
|
547
|
+
# @return [PromptBot]
|
548
|
+
def update_prompt_bot(id, list_id, email_id, name, subject, content, contact_field_value_column, template_id, opts = {})
|
549
|
+
data, _status_code, _headers = update_prompt_bot_with_http_info(id, list_id, email_id, name, subject, content, contact_field_value_column, template_id, opts)
|
529
550
|
return data
|
530
551
|
end
|
531
552
|
|
532
553
|
# Update Prompt Bot
|
533
554
|
# Updates a Prompt Bot's settings.
|
534
555
|
# @param id The bot id.
|
556
|
+
# @param list_id The list id to attach the bot to.
|
557
|
+
# @param email_id The default email to use.
|
558
|
+
# @param name The name of the bot.
|
559
|
+
# @param subject The subject of the default email.
|
560
|
+
# @param content The content used in the default email.
|
561
|
+
# @param contact_field_value_column The custom field value column with dates for this bot.
|
562
|
+
# @param template_id The template used to create the email id.
|
535
563
|
# @param [Hash] opts the optional parameters
|
536
|
-
# @option opts [String] :
|
564
|
+
# @option opts [String] :video_id The video used in the default email.
|
537
565
|
# @option opts [String] :end_date The time frame to complete sending to the list.
|
538
566
|
# @option opts [String] :status The status of the bot.
|
539
|
-
# @return [Array<(
|
540
|
-
def update_prompt_bot_with_http_info(id, opts = {})
|
567
|
+
# @return [Array<(PromptBot, Fixnum, Hash)>] PromptBot data, response status code and response headers
|
568
|
+
def update_prompt_bot_with_http_info(id, list_id, email_id, name, subject, content, contact_field_value_column, template_id, opts = {})
|
541
569
|
if @api_client.config.debugging
|
542
570
|
@api_client.config.logger.debug "Calling API: PromptsApi.update_prompt_bot ..."
|
543
571
|
end
|
544
572
|
# verify the required parameter 'id' is set
|
545
573
|
fail ArgumentError, "Missing the required parameter 'id' when calling PromptsApi.update_prompt_bot" if id.nil?
|
574
|
+
# verify the required parameter 'list_id' is set
|
575
|
+
fail ArgumentError, "Missing the required parameter 'list_id' when calling PromptsApi.update_prompt_bot" if list_id.nil?
|
576
|
+
# verify the required parameter 'email_id' is set
|
577
|
+
fail ArgumentError, "Missing the required parameter 'email_id' when calling PromptsApi.update_prompt_bot" if email_id.nil?
|
578
|
+
# verify the required parameter 'name' is set
|
579
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PromptsApi.update_prompt_bot" if name.nil?
|
580
|
+
# verify the required parameter 'subject' is set
|
581
|
+
fail ArgumentError, "Missing the required parameter 'subject' when calling PromptsApi.update_prompt_bot" if subject.nil?
|
582
|
+
# verify the required parameter 'content' is set
|
583
|
+
fail ArgumentError, "Missing the required parameter 'content' when calling PromptsApi.update_prompt_bot" if content.nil?
|
584
|
+
# verify the required parameter 'contact_field_value_column' is set
|
585
|
+
fail ArgumentError, "Missing the required parameter 'contact_field_value_column' when calling PromptsApi.update_prompt_bot" if contact_field_value_column.nil?
|
586
|
+
# verify the required parameter 'template_id' is set
|
587
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling PromptsApi.update_prompt_bot" if template_id.nil?
|
546
588
|
# resource path
|
547
589
|
local_var_path = "/prompts/bots/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
|
548
590
|
|
@@ -562,7 +604,14 @@ module BombBomb
|
|
562
604
|
|
563
605
|
# form parameters
|
564
606
|
form_params = {}
|
565
|
-
form_params["
|
607
|
+
form_params["listId"] = list_id
|
608
|
+
form_params["emailId"] = email_id
|
609
|
+
form_params["name"] = name
|
610
|
+
form_params["subject"] = subject
|
611
|
+
form_params["content"] = content
|
612
|
+
form_params["contactFieldValueColumn"] = contact_field_value_column
|
613
|
+
form_params["templateId"] = template_id
|
614
|
+
form_params["videoId"] = opts[:'video_id'] if !opts[:'video_id'].nil?
|
566
615
|
form_params["endDate"] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
567
616
|
form_params["status"] = opts[:'status'] if !opts[:'status'].nil?
|
568
617
|
|
@@ -575,7 +624,7 @@ module BombBomb
|
|
575
624
|
:form_params => form_params,
|
576
625
|
:body => post_body,
|
577
626
|
:auth_names => auth_names,
|
578
|
-
:return_type => '
|
627
|
+
:return_type => 'PromptBot')
|
579
628
|
if @api_client.config.debugging
|
580
629
|
@api_client.config.logger.debug "API called: PromptsApi#update_prompt_bot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
581
630
|
end
|
@@ -589,6 +638,7 @@ module BombBomb
|
|
589
638
|
# @option opts [String] :branded_template_id The template to use for branded feel emails.
|
590
639
|
# @option opts [String] :personal_template_id The template to use for personal feel emails.
|
591
640
|
# @option opts [BOOLEAN] :enabled Set whether the user is able to start receiving prompts.
|
641
|
+
# @option opts [String] :auto_shares These are what we are autosharing to
|
592
642
|
# @return [nil]
|
593
643
|
def update_prompt_campaign(client_group_id, opts = {})
|
594
644
|
update_prompt_campaign_with_http_info(client_group_id, opts)
|
@@ -602,6 +652,7 @@ module BombBomb
|
|
602
652
|
# @option opts [String] :branded_template_id The template to use for branded feel emails.
|
603
653
|
# @option opts [String] :personal_template_id The template to use for personal feel emails.
|
604
654
|
# @option opts [BOOLEAN] :enabled Set whether the user is able to start receiving prompts.
|
655
|
+
# @option opts [String] :auto_shares These are what we are autosharing to
|
605
656
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
606
657
|
def update_prompt_campaign_with_http_info(client_group_id, opts = {})
|
607
658
|
if @api_client.config.debugging
|
@@ -632,6 +683,7 @@ module BombBomb
|
|
632
683
|
form_params["brandedTemplateId"] = opts[:'branded_template_id'] if !opts[:'branded_template_id'].nil?
|
633
684
|
form_params["personalTemplateId"] = opts[:'personal_template_id'] if !opts[:'personal_template_id'].nil?
|
634
685
|
form_params["enabled"] = opts[:'enabled'] if !opts[:'enabled'].nil?
|
686
|
+
form_params["autoShares"] = opts[:'auto_shares'] if !opts[:'auto_shares'].nil?
|
635
687
|
|
636
688
|
# http body (model)
|
637
689
|
post_body = nil
|
@@ -0,0 +1,458 @@
|
|
1
|
+
=begin
|
2
|
+
#BombBomb
|
3
|
+
|
4
|
+
#We make it easy to build relationships using simple videos.
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0.24005
|
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 SocialsApi
|
28
|
+
attr_accessor :api_client
|
29
|
+
|
30
|
+
def initialize(api_client = ApiClient.default)
|
31
|
+
@api_client = api_client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Gets the social email properties
|
35
|
+
# Gets the social email properties
|
36
|
+
# @param jericho_id associated jericho Id
|
37
|
+
# @param email_id This is the email Id for the email url
|
38
|
+
# @param originator_id This is the originator Id
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @return [nil]
|
41
|
+
def get_social_article_properties(jericho_id, email_id, originator_id, opts = {})
|
42
|
+
get_social_article_properties_with_http_info(jericho_id, email_id, originator_id, opts)
|
43
|
+
return nil
|
44
|
+
end
|
45
|
+
|
46
|
+
# Gets the social email properties
|
47
|
+
# Gets the social email properties
|
48
|
+
# @param jericho_id associated jericho Id
|
49
|
+
# @param email_id This is the email Id for the email url
|
50
|
+
# @param originator_id This is the originator Id
|
51
|
+
# @param [Hash] opts the optional parameters
|
52
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
53
|
+
def get_social_article_properties_with_http_info(jericho_id, email_id, originator_id, opts = {})
|
54
|
+
if @api_client.config.debugging
|
55
|
+
@api_client.config.logger.debug "Calling API: SocialsApi.get_social_article_properties ..."
|
56
|
+
end
|
57
|
+
# verify the required parameter 'jericho_id' is set
|
58
|
+
fail ArgumentError, "Missing the required parameter 'jericho_id' when calling SocialsApi.get_social_article_properties" if jericho_id.nil?
|
59
|
+
# verify the required parameter 'email_id' is set
|
60
|
+
fail ArgumentError, "Missing the required parameter 'email_id' when calling SocialsApi.get_social_article_properties" if email_id.nil?
|
61
|
+
# verify the required parameter 'originator_id' is set
|
62
|
+
fail ArgumentError, "Missing the required parameter 'originator_id' when calling SocialsApi.get_social_article_properties" if originator_id.nil?
|
63
|
+
# resource path
|
64
|
+
local_var_path = "/socials/properties".sub('{format}','json')
|
65
|
+
|
66
|
+
# query parameters
|
67
|
+
query_params = {}
|
68
|
+
query_params[:'jerichoId'] = jericho_id
|
69
|
+
query_params[:'emailId'] = email_id
|
70
|
+
query_params[:'originatorId'] = originator_id
|
71
|
+
|
72
|
+
# header parameters
|
73
|
+
header_params = {}
|
74
|
+
|
75
|
+
# HTTP header 'Accept' (if needed)
|
76
|
+
local_header_accept = ['application/json']
|
77
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
78
|
+
|
79
|
+
# HTTP header 'Content-Type'
|
80
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
81
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
82
|
+
|
83
|
+
# form parameters
|
84
|
+
form_params = {}
|
85
|
+
|
86
|
+
# http body (model)
|
87
|
+
post_body = nil
|
88
|
+
auth_names = ['BBOAuth2']
|
89
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
90
|
+
:header_params => header_params,
|
91
|
+
:query_params => query_params,
|
92
|
+
:form_params => form_params,
|
93
|
+
:body => post_body,
|
94
|
+
:auth_names => auth_names)
|
95
|
+
if @api_client.config.debugging
|
96
|
+
@api_client.config.logger.debug "API called: SocialsApi#get_social_article_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
97
|
+
end
|
98
|
+
return data, status_code, headers
|
99
|
+
end
|
100
|
+
|
101
|
+
# Gets the auto shares from the client group assoc id
|
102
|
+
# Gets the auto shares from the client group assoc id
|
103
|
+
# @param client_group_id ID of the client group association
|
104
|
+
# @param [Hash] opts the optional parameters
|
105
|
+
# @return [nil]
|
106
|
+
def get_social_auto_shares(client_group_id, opts = {})
|
107
|
+
get_social_auto_shares_with_http_info(client_group_id, opts)
|
108
|
+
return nil
|
109
|
+
end
|
110
|
+
|
111
|
+
# Gets the auto shares from the client group assoc id
|
112
|
+
# Gets the auto shares from the client group assoc id
|
113
|
+
# @param client_group_id ID of the client group association
|
114
|
+
# @param [Hash] opts the optional parameters
|
115
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
116
|
+
def get_social_auto_shares_with_http_info(client_group_id, opts = {})
|
117
|
+
if @api_client.config.debugging
|
118
|
+
@api_client.config.logger.debug "Calling API: SocialsApi.get_social_auto_shares ..."
|
119
|
+
end
|
120
|
+
# verify the required parameter 'client_group_id' is set
|
121
|
+
fail ArgumentError, "Missing the required parameter 'client_group_id' when calling SocialsApi.get_social_auto_shares" if client_group_id.nil?
|
122
|
+
# resource path
|
123
|
+
local_var_path = "/socials/shares".sub('{format}','json')
|
124
|
+
|
125
|
+
# query parameters
|
126
|
+
query_params = {}
|
127
|
+
query_params[:'clientGroupId'] = client_group_id
|
128
|
+
|
129
|
+
# header parameters
|
130
|
+
header_params = {}
|
131
|
+
|
132
|
+
# HTTP header 'Accept' (if needed)
|
133
|
+
local_header_accept = ['application/json']
|
134
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
135
|
+
|
136
|
+
# HTTP header 'Content-Type'
|
137
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
138
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
139
|
+
|
140
|
+
# form parameters
|
141
|
+
form_params = {}
|
142
|
+
|
143
|
+
# http body (model)
|
144
|
+
post_body = nil
|
145
|
+
auth_names = ['BBOAuth2']
|
146
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
147
|
+
:header_params => header_params,
|
148
|
+
:query_params => query_params,
|
149
|
+
:form_params => form_params,
|
150
|
+
:body => post_body,
|
151
|
+
:auth_names => auth_names)
|
152
|
+
if @api_client.config.debugging
|
153
|
+
@api_client.config.logger.debug "API called: SocialsApi#get_social_auto_shares\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
154
|
+
end
|
155
|
+
return data, status_code, headers
|
156
|
+
end
|
157
|
+
|
158
|
+
# Get permissions for social integration
|
159
|
+
# Get permissions for social integration and has redirect for user to login
|
160
|
+
# @param social_type Type of social integration
|
161
|
+
# @param [Hash] opts the optional parameters
|
162
|
+
# @return [nil]
|
163
|
+
def get_social_permissions(social_type, opts = {})
|
164
|
+
get_social_permissions_with_http_info(social_type, opts)
|
165
|
+
return nil
|
166
|
+
end
|
167
|
+
|
168
|
+
# Get permissions for social integration
|
169
|
+
# Get permissions for social integration and has redirect for user to login
|
170
|
+
# @param social_type Type of social integration
|
171
|
+
# @param [Hash] opts the optional parameters
|
172
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
173
|
+
def get_social_permissions_with_http_info(social_type, opts = {})
|
174
|
+
if @api_client.config.debugging
|
175
|
+
@api_client.config.logger.debug "Calling API: SocialsApi.get_social_permissions ..."
|
176
|
+
end
|
177
|
+
# verify the required parameter 'social_type' is set
|
178
|
+
fail ArgumentError, "Missing the required parameter 'social_type' when calling SocialsApi.get_social_permissions" if social_type.nil?
|
179
|
+
# resource path
|
180
|
+
local_var_path = "/socials/permissions".sub('{format}','json')
|
181
|
+
|
182
|
+
# query parameters
|
183
|
+
query_params = {}
|
184
|
+
query_params[:'socialType'] = social_type
|
185
|
+
|
186
|
+
# header parameters
|
187
|
+
header_params = {}
|
188
|
+
|
189
|
+
# HTTP header 'Accept' (if needed)
|
190
|
+
local_header_accept = ['application/json']
|
191
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
192
|
+
|
193
|
+
# HTTP header 'Content-Type'
|
194
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
195
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
196
|
+
|
197
|
+
# form parameters
|
198
|
+
form_params = {}
|
199
|
+
|
200
|
+
# http body (model)
|
201
|
+
post_body = nil
|
202
|
+
auth_names = ['BBOAuth2']
|
203
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
204
|
+
:header_params => header_params,
|
205
|
+
:query_params => query_params,
|
206
|
+
:form_params => form_params,
|
207
|
+
:body => post_body,
|
208
|
+
:auth_names => auth_names)
|
209
|
+
if @api_client.config.debugging
|
210
|
+
@api_client.config.logger.debug "API called: SocialsApi#get_social_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
211
|
+
end
|
212
|
+
return data, status_code, headers
|
213
|
+
end
|
214
|
+
|
215
|
+
# Gets the social state
|
216
|
+
# Gets the social state
|
217
|
+
# @param originator_id associated originatorId
|
218
|
+
# @param [Hash] opts the optional parameters
|
219
|
+
# @return [nil]
|
220
|
+
def get_social_status(originator_id, opts = {})
|
221
|
+
get_social_status_with_http_info(originator_id, opts)
|
222
|
+
return nil
|
223
|
+
end
|
224
|
+
|
225
|
+
# Gets the social state
|
226
|
+
# Gets the social state
|
227
|
+
# @param originator_id associated originatorId
|
228
|
+
# @param [Hash] opts the optional parameters
|
229
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
230
|
+
def get_social_status_with_http_info(originator_id, opts = {})
|
231
|
+
if @api_client.config.debugging
|
232
|
+
@api_client.config.logger.debug "Calling API: SocialsApi.get_social_status ..."
|
233
|
+
end
|
234
|
+
# verify the required parameter 'originator_id' is set
|
235
|
+
fail ArgumentError, "Missing the required parameter 'originator_id' when calling SocialsApi.get_social_status" if originator_id.nil?
|
236
|
+
# resource path
|
237
|
+
local_var_path = "/socials/states".sub('{format}','json')
|
238
|
+
|
239
|
+
# query parameters
|
240
|
+
query_params = {}
|
241
|
+
query_params[:'originatorId'] = originator_id
|
242
|
+
|
243
|
+
# header parameters
|
244
|
+
header_params = {}
|
245
|
+
|
246
|
+
# HTTP header 'Accept' (if needed)
|
247
|
+
local_header_accept = ['application/json']
|
248
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
249
|
+
|
250
|
+
# HTTP header 'Content-Type'
|
251
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
252
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
253
|
+
|
254
|
+
# form parameters
|
255
|
+
form_params = {}
|
256
|
+
|
257
|
+
# http body (model)
|
258
|
+
post_body = nil
|
259
|
+
auth_names = ['BBOAuth2']
|
260
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
261
|
+
:header_params => header_params,
|
262
|
+
:query_params => query_params,
|
263
|
+
:form_params => form_params,
|
264
|
+
:body => post_body,
|
265
|
+
:auth_names => auth_names)
|
266
|
+
if @api_client.config.debugging
|
267
|
+
@api_client.config.logger.debug "API called: SocialsApi#get_social_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
268
|
+
end
|
269
|
+
return data, status_code, headers
|
270
|
+
end
|
271
|
+
|
272
|
+
# Gets the auto shares from the client group assoc id
|
273
|
+
# Gets the auto shares from the client group assoc id
|
274
|
+
# @param auto_share The social share that will auto share to
|
275
|
+
# @param client_group_id ID of the client group association
|
276
|
+
# @param [Hash] opts the optional parameters
|
277
|
+
# @return [nil]
|
278
|
+
def update_social_auto_shares(auto_share, client_group_id, opts = {})
|
279
|
+
update_social_auto_shares_with_http_info(auto_share, client_group_id, opts)
|
280
|
+
return nil
|
281
|
+
end
|
282
|
+
|
283
|
+
# Gets the auto shares from the client group assoc id
|
284
|
+
# Gets the auto shares from the client group assoc id
|
285
|
+
# @param auto_share The social share that will auto share to
|
286
|
+
# @param client_group_id ID of the client group association
|
287
|
+
# @param [Hash] opts the optional parameters
|
288
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
289
|
+
def update_social_auto_shares_with_http_info(auto_share, client_group_id, opts = {})
|
290
|
+
if @api_client.config.debugging
|
291
|
+
@api_client.config.logger.debug "Calling API: SocialsApi.update_social_auto_shares ..."
|
292
|
+
end
|
293
|
+
# verify the required parameter 'auto_share' is set
|
294
|
+
fail ArgumentError, "Missing the required parameter 'auto_share' when calling SocialsApi.update_social_auto_shares" if auto_share.nil?
|
295
|
+
# verify the required parameter 'client_group_id' is set
|
296
|
+
fail ArgumentError, "Missing the required parameter 'client_group_id' when calling SocialsApi.update_social_auto_shares" if client_group_id.nil?
|
297
|
+
# resource path
|
298
|
+
local_var_path = "/socials/shares".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["autoShare"] = auto_share
|
317
|
+
form_params["clientGroupId"] = client_group_id
|
318
|
+
|
319
|
+
# http body (model)
|
320
|
+
post_body = nil
|
321
|
+
auth_names = ['BBOAuth2']
|
322
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
323
|
+
:header_params => header_params,
|
324
|
+
:query_params => query_params,
|
325
|
+
:form_params => form_params,
|
326
|
+
:body => post_body,
|
327
|
+
:auth_names => auth_names)
|
328
|
+
if @api_client.config.debugging
|
329
|
+
@api_client.config.logger.debug "API called: SocialsApi#update_social_auto_shares\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
330
|
+
end
|
331
|
+
return data, status_code, headers
|
332
|
+
end
|
333
|
+
|
334
|
+
# Sets the users social message to what they typed in
|
335
|
+
# Sets the users social message to what they typed in
|
336
|
+
# @param message The social message the user typed in
|
337
|
+
# @param originator_id The parent id tied to the social share
|
338
|
+
# @param [Hash] opts the optional parameters
|
339
|
+
# @return [nil]
|
340
|
+
def update_social_message(message, originator_id, opts = {})
|
341
|
+
update_social_message_with_http_info(message, originator_id, opts)
|
342
|
+
return nil
|
343
|
+
end
|
344
|
+
|
345
|
+
# Sets the users social message to what they typed in
|
346
|
+
# Sets the users social message to what they typed in
|
347
|
+
# @param message The social message the user typed in
|
348
|
+
# @param originator_id The parent id tied to the social share
|
349
|
+
# @param [Hash] opts the optional parameters
|
350
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
351
|
+
def update_social_message_with_http_info(message, originator_id, opts = {})
|
352
|
+
if @api_client.config.debugging
|
353
|
+
@api_client.config.logger.debug "Calling API: SocialsApi.update_social_message ..."
|
354
|
+
end
|
355
|
+
# verify the required parameter 'message' is set
|
356
|
+
fail ArgumentError, "Missing the required parameter 'message' when calling SocialsApi.update_social_message" if message.nil?
|
357
|
+
# verify the required parameter 'originator_id' is set
|
358
|
+
fail ArgumentError, "Missing the required parameter 'originator_id' when calling SocialsApi.update_social_message" if originator_id.nil?
|
359
|
+
# resource path
|
360
|
+
local_var_path = "/socials/message".sub('{format}','json')
|
361
|
+
|
362
|
+
# query parameters
|
363
|
+
query_params = {}
|
364
|
+
|
365
|
+
# header parameters
|
366
|
+
header_params = {}
|
367
|
+
|
368
|
+
# HTTP header 'Accept' (if needed)
|
369
|
+
local_header_accept = ['application/json']
|
370
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
371
|
+
|
372
|
+
# HTTP header 'Content-Type'
|
373
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
374
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
375
|
+
|
376
|
+
# form parameters
|
377
|
+
form_params = {}
|
378
|
+
form_params["message"] = message
|
379
|
+
form_params["originatorId"] = originator_id
|
380
|
+
|
381
|
+
# http body (model)
|
382
|
+
post_body = nil
|
383
|
+
auth_names = ['BBOAuth2']
|
384
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
385
|
+
:header_params => header_params,
|
386
|
+
:query_params => query_params,
|
387
|
+
:form_params => form_params,
|
388
|
+
:body => post_body,
|
389
|
+
:auth_names => auth_names)
|
390
|
+
if @api_client.config.debugging
|
391
|
+
@api_client.config.logger.debug "API called: SocialsApi#update_social_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
392
|
+
end
|
393
|
+
return data, status_code, headers
|
394
|
+
end
|
395
|
+
|
396
|
+
# Updates the social state for the object
|
397
|
+
# Updates the social state for the object
|
398
|
+
# @param state The state to set to
|
399
|
+
# @param originator_id The parent id tied to the social share
|
400
|
+
# @param [Hash] opts the optional parameters
|
401
|
+
# @return [nil]
|
402
|
+
def update_social_status(state, originator_id, opts = {})
|
403
|
+
update_social_status_with_http_info(state, originator_id, opts)
|
404
|
+
return nil
|
405
|
+
end
|
406
|
+
|
407
|
+
# Updates the social state for the object
|
408
|
+
# Updates the social state for the object
|
409
|
+
# @param state The state to set to
|
410
|
+
# @param originator_id The parent id tied to the social share
|
411
|
+
# @param [Hash] opts the optional parameters
|
412
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
413
|
+
def update_social_status_with_http_info(state, originator_id, opts = {})
|
414
|
+
if @api_client.config.debugging
|
415
|
+
@api_client.config.logger.debug "Calling API: SocialsApi.update_social_status ..."
|
416
|
+
end
|
417
|
+
# verify the required parameter 'state' is set
|
418
|
+
fail ArgumentError, "Missing the required parameter 'state' when calling SocialsApi.update_social_status" if state.nil?
|
419
|
+
# verify the required parameter 'originator_id' is set
|
420
|
+
fail ArgumentError, "Missing the required parameter 'originator_id' when calling SocialsApi.update_social_status" if originator_id.nil?
|
421
|
+
# resource path
|
422
|
+
local_var_path = "/socials/state".sub('{format}','json')
|
423
|
+
|
424
|
+
# query parameters
|
425
|
+
query_params = {}
|
426
|
+
|
427
|
+
# header parameters
|
428
|
+
header_params = {}
|
429
|
+
|
430
|
+
# HTTP header 'Accept' (if needed)
|
431
|
+
local_header_accept = ['application/json']
|
432
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
433
|
+
|
434
|
+
# HTTP header 'Content-Type'
|
435
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
436
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
437
|
+
|
438
|
+
# form parameters
|
439
|
+
form_params = {}
|
440
|
+
form_params["state"] = state
|
441
|
+
form_params["originatorId"] = originator_id
|
442
|
+
|
443
|
+
# http body (model)
|
444
|
+
post_body = nil
|
445
|
+
auth_names = ['BBOAuth2']
|
446
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
447
|
+
:header_params => header_params,
|
448
|
+
:query_params => query_params,
|
449
|
+
:form_params => form_params,
|
450
|
+
:body => post_body,
|
451
|
+
:auth_names => auth_names)
|
452
|
+
if @api_client.config.debugging
|
453
|
+
@api_client.config.logger.debug "API called: SocialsApi#update_social_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
454
|
+
end
|
455
|
+
return data, status_code, headers
|
456
|
+
end
|
457
|
+
end
|
458
|
+
end
|