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
|
|
@@ -33,7 +33,6 @@ module BombBomb
|
|
33
33
|
|
34
34
|
# Create a running Prompt Bot for a list
|
35
35
|
# Creates a Prompt Bot that sends emails to contacts on a list over the span of time defined.
|
36
|
-
# @param list_id The list id to attach the bot to.
|
37
36
|
# @param email_id The default email to use.
|
38
37
|
# @param name The name of the bot.
|
39
38
|
# @param subject The subject of the default email.
|
@@ -42,17 +41,17 @@ module BombBomb
|
|
42
41
|
# @param bot_type_id The type of bot to create.
|
43
42
|
# @param template_id The template used to create the email id.
|
44
43
|
# @param [Hash] opts the optional parameters
|
44
|
+
# @option opts [String] :list_id The list id to attach the bot to.
|
45
45
|
# @option opts [String] :video_id The video used in the email.
|
46
46
|
# @option opts [String] :end_date The time frame to complete sending to the list.
|
47
47
|
# @return [PromptBot]
|
48
|
-
def create_prompt_bot(
|
49
|
-
data, _status_code, _headers = create_prompt_bot_with_http_info(
|
48
|
+
def create_prompt_bot(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(email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts)
|
50
50
|
return data
|
51
51
|
end
|
52
52
|
|
53
53
|
# Create a running Prompt Bot for a list
|
54
54
|
# Creates a Prompt Bot that sends emails to contacts on a list over the span of time defined.
|
55
|
-
# @param list_id The list id to attach the bot to.
|
56
55
|
# @param email_id The default email to use.
|
57
56
|
# @param name The name of the bot.
|
58
57
|
# @param subject The subject of the default email.
|
@@ -61,15 +60,14 @@ module BombBomb
|
|
61
60
|
# @param bot_type_id The type of bot to create.
|
62
61
|
# @param template_id The template used to create the email id.
|
63
62
|
# @param [Hash] opts the optional parameters
|
63
|
+
# @option opts [String] :list_id The list id to attach the bot to.
|
64
64
|
# @option opts [String] :video_id The video used in the email.
|
65
65
|
# @option opts [String] :end_date The time frame to complete sending to the list.
|
66
66
|
# @return [Array<(PromptBot, Fixnum, Hash)>] PromptBot data, response status code and response headers
|
67
|
-
def create_prompt_bot_with_http_info(
|
67
|
+
def create_prompt_bot_with_http_info(email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts = {})
|
68
68
|
if @api_client.config.debugging
|
69
69
|
@api_client.config.logger.debug "Calling API: PromptsApi.create_prompt_bot ..."
|
70
70
|
end
|
71
|
-
# verify the required parameter 'list_id' is set
|
72
|
-
fail ArgumentError, "Missing the required parameter 'list_id' when calling PromptsApi.create_prompt_bot" if list_id.nil?
|
73
71
|
# verify the required parameter 'email_id' is set
|
74
72
|
fail ArgumentError, "Missing the required parameter 'email_id' when calling PromptsApi.create_prompt_bot" if email_id.nil?
|
75
73
|
# verify the required parameter 'name' is set
|
@@ -103,7 +101,6 @@ module BombBomb
|
|
103
101
|
|
104
102
|
# form parameters
|
105
103
|
form_params = {}
|
106
|
-
form_params["listId"] = list_id
|
107
104
|
form_params["emailId"] = email_id
|
108
105
|
form_params["name"] = name
|
109
106
|
form_params["subject"] = subject
|
@@ -111,6 +108,7 @@ module BombBomb
|
|
111
108
|
form_params["contactFieldValueColumn"] = contact_field_value_column
|
112
109
|
form_params["botTypeId"] = bot_type_id
|
113
110
|
form_params["templateId"] = template_id
|
111
|
+
form_params["listId"] = opts[:'list_id'] if !opts[:'list_id'].nil?
|
114
112
|
form_params["videoId"] = opts[:'video_id'] if !opts[:'video_id'].nil?
|
115
113
|
form_params["endDate"] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
116
114
|
|
@@ -530,10 +528,83 @@ module BombBomb
|
|
530
528
|
return data, status_code, headers
|
531
529
|
end
|
532
530
|
|
531
|
+
# Update Prompt
|
532
|
+
# Updates a Prompt
|
533
|
+
# @param id The prompt's id
|
534
|
+
# @param [Hash] opts the optional parameters
|
535
|
+
# @option opts [String] :send_mechanism The mechanism for the prompt to be sent
|
536
|
+
# @option opts [String] :facebook_message The facebook message assigned to the prompt
|
537
|
+
# @option opts [String] :twitter_message The twitter message assigned to the prompt
|
538
|
+
# @option opts [String] :video_id The id of the video.
|
539
|
+
# @option opts [String] :email_id The id of the email.
|
540
|
+
# @option opts [String] :subject The subject of the email
|
541
|
+
# @return [nil]
|
542
|
+
def update_prompt(id, opts = {})
|
543
|
+
update_prompt_with_http_info(id, opts)
|
544
|
+
return nil
|
545
|
+
end
|
546
|
+
|
547
|
+
# Update Prompt
|
548
|
+
# Updates a Prompt
|
549
|
+
# @param id The prompt's id
|
550
|
+
# @param [Hash] opts the optional parameters
|
551
|
+
# @option opts [String] :send_mechanism The mechanism for the prompt to be sent
|
552
|
+
# @option opts [String] :facebook_message The facebook message assigned to the prompt
|
553
|
+
# @option opts [String] :twitter_message The twitter message assigned to the prompt
|
554
|
+
# @option opts [String] :video_id The id of the video.
|
555
|
+
# @option opts [String] :email_id The id of the email.
|
556
|
+
# @option opts [String] :subject The subject of the email
|
557
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
558
|
+
def update_prompt_with_http_info(id, opts = {})
|
559
|
+
if @api_client.config.debugging
|
560
|
+
@api_client.config.logger.debug "Calling API: PromptsApi.update_prompt ..."
|
561
|
+
end
|
562
|
+
# verify the required parameter 'id' is set
|
563
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling PromptsApi.update_prompt" if id.nil?
|
564
|
+
# resource path
|
565
|
+
local_var_path = "/prompts/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
|
566
|
+
|
567
|
+
# query parameters
|
568
|
+
query_params = {}
|
569
|
+
|
570
|
+
# header parameters
|
571
|
+
header_params = {}
|
572
|
+
|
573
|
+
# HTTP header 'Accept' (if needed)
|
574
|
+
local_header_accept = ['application/json']
|
575
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
576
|
+
|
577
|
+
# HTTP header 'Content-Type'
|
578
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
579
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
580
|
+
|
581
|
+
# form parameters
|
582
|
+
form_params = {}
|
583
|
+
form_params["sendMechanism"] = opts[:'send_mechanism'] if !opts[:'send_mechanism'].nil?
|
584
|
+
form_params["facebookMessage"] = opts[:'facebook_message'] if !opts[:'facebook_message'].nil?
|
585
|
+
form_params["twitterMessage"] = opts[:'twitter_message'] if !opts[:'twitter_message'].nil?
|
586
|
+
form_params["videoId"] = opts[:'video_id'] if !opts[:'video_id'].nil?
|
587
|
+
form_params["emailId"] = opts[:'email_id'] if !opts[:'email_id'].nil?
|
588
|
+
form_params["subject"] = opts[:'subject'] if !opts[:'subject'].nil?
|
589
|
+
|
590
|
+
# http body (model)
|
591
|
+
post_body = nil
|
592
|
+
auth_names = ['BBOAuth2']
|
593
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
594
|
+
:header_params => header_params,
|
595
|
+
:query_params => query_params,
|
596
|
+
:form_params => form_params,
|
597
|
+
:body => post_body,
|
598
|
+
:auth_names => auth_names)
|
599
|
+
if @api_client.config.debugging
|
600
|
+
@api_client.config.logger.debug "API called: PromptsApi#update_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
601
|
+
end
|
602
|
+
return data, status_code, headers
|
603
|
+
end
|
604
|
+
|
533
605
|
# Update Prompt Bot
|
534
606
|
# Updates a Prompt Bot's settings.
|
535
607
|
# @param id The bot id.
|
536
|
-
# @param list_id The list id to attach the bot to.
|
537
608
|
# @param email_id The default email to use.
|
538
609
|
# @param name The name of the bot.
|
539
610
|
# @param subject The subject of the default email.
|
@@ -541,19 +612,19 @@ module BombBomb
|
|
541
612
|
# @param contact_field_value_column The custom field value column with dates for this bot.
|
542
613
|
# @param template_id The template used to create the email id.
|
543
614
|
# @param [Hash] opts the optional parameters
|
615
|
+
# @option opts [String] :list_id The list id to attach the bot to.
|
544
616
|
# @option opts [String] :video_id The video used in the default email.
|
545
617
|
# @option opts [String] :end_date The time frame to complete sending to the list.
|
546
618
|
# @option opts [String] :status The status of the bot.
|
547
619
|
# @return [PromptBot]
|
548
|
-
def update_prompt_bot(id,
|
549
|
-
data, _status_code, _headers = update_prompt_bot_with_http_info(id,
|
620
|
+
def update_prompt_bot(id, email_id, name, subject, content, contact_field_value_column, template_id, opts = {})
|
621
|
+
data, _status_code, _headers = update_prompt_bot_with_http_info(id, email_id, name, subject, content, contact_field_value_column, template_id, opts)
|
550
622
|
return data
|
551
623
|
end
|
552
624
|
|
553
625
|
# Update Prompt Bot
|
554
626
|
# Updates a Prompt Bot's settings.
|
555
627
|
# @param id The bot id.
|
556
|
-
# @param list_id The list id to attach the bot to.
|
557
628
|
# @param email_id The default email to use.
|
558
629
|
# @param name The name of the bot.
|
559
630
|
# @param subject The subject of the default email.
|
@@ -561,18 +632,17 @@ module BombBomb
|
|
561
632
|
# @param contact_field_value_column The custom field value column with dates for this bot.
|
562
633
|
# @param template_id The template used to create the email id.
|
563
634
|
# @param [Hash] opts the optional parameters
|
635
|
+
# @option opts [String] :list_id The list id to attach the bot to.
|
564
636
|
# @option opts [String] :video_id The video used in the default email.
|
565
637
|
# @option opts [String] :end_date The time frame to complete sending to the list.
|
566
638
|
# @option opts [String] :status The status of the bot.
|
567
639
|
# @return [Array<(PromptBot, Fixnum, Hash)>] PromptBot data, response status code and response headers
|
568
|
-
def update_prompt_bot_with_http_info(id,
|
640
|
+
def update_prompt_bot_with_http_info(id, email_id, name, subject, content, contact_field_value_column, template_id, opts = {})
|
569
641
|
if @api_client.config.debugging
|
570
642
|
@api_client.config.logger.debug "Calling API: PromptsApi.update_prompt_bot ..."
|
571
643
|
end
|
572
644
|
# verify the required parameter 'id' is set
|
573
645
|
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
646
|
# verify the required parameter 'email_id' is set
|
577
647
|
fail ArgumentError, "Missing the required parameter 'email_id' when calling PromptsApi.update_prompt_bot" if email_id.nil?
|
578
648
|
# verify the required parameter 'name' is set
|
@@ -604,13 +674,13 @@ module BombBomb
|
|
604
674
|
|
605
675
|
# form parameters
|
606
676
|
form_params = {}
|
607
|
-
form_params["listId"] = list_id
|
608
677
|
form_params["emailId"] = email_id
|
609
678
|
form_params["name"] = name
|
610
679
|
form_params["subject"] = subject
|
611
680
|
form_params["content"] = content
|
612
681
|
form_params["contactFieldValueColumn"] = contact_field_value_column
|
613
682
|
form_params["templateId"] = template_id
|
683
|
+
form_params["listId"] = opts[:'list_id'] if !opts[:'list_id'].nil?
|
614
684
|
form_params["videoId"] = opts[:'video_id'] if !opts[:'video_id'].nil?
|
615
685
|
form_params["endDate"] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
616
686
|
form_params["status"] = opts[:'status'] if !opts[:'status'].nil?
|
@@ -638,7 +708,7 @@ module BombBomb
|
|
638
708
|
# @option opts [String] :branded_template_id The template to use for branded feel emails.
|
639
709
|
# @option opts [String] :personal_template_id The template to use for personal feel emails.
|
640
710
|
# @option opts [BOOLEAN] :enabled Set whether the user is able to start receiving prompts.
|
641
|
-
# @option opts [String] :
|
711
|
+
# @option opts [String] :send_mechanism The way to send the prompt
|
642
712
|
# @return [nil]
|
643
713
|
def update_prompt_campaign(client_group_id, opts = {})
|
644
714
|
update_prompt_campaign_with_http_info(client_group_id, opts)
|
@@ -652,7 +722,7 @@ module BombBomb
|
|
652
722
|
# @option opts [String] :branded_template_id The template to use for branded feel emails.
|
653
723
|
# @option opts [String] :personal_template_id The template to use for personal feel emails.
|
654
724
|
# @option opts [BOOLEAN] :enabled Set whether the user is able to start receiving prompts.
|
655
|
-
# @option opts [String] :
|
725
|
+
# @option opts [String] :send_mechanism The way to send the prompt
|
656
726
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
657
727
|
def update_prompt_campaign_with_http_info(client_group_id, opts = {})
|
658
728
|
if @api_client.config.debugging
|
@@ -683,7 +753,7 @@ module BombBomb
|
|
683
753
|
form_params["brandedTemplateId"] = opts[:'branded_template_id'] if !opts[:'branded_template_id'].nil?
|
684
754
|
form_params["personalTemplateId"] = opts[:'personal_template_id'] if !opts[:'personal_template_id'].nil?
|
685
755
|
form_params["enabled"] = opts[:'enabled'] if !opts[:'enabled'].nil?
|
686
|
-
form_params["
|
756
|
+
form_params["sendMechanism"] = opts[:'send_mechanism'] if !opts[:'send_mechanism'].nil?
|
687
757
|
|
688
758
|
# http body (model)
|
689
759
|
post_body = nil
|