bombbomb 2.0.831 → 2.0.20679

Sign up to get free protection for your applications and to get access to all the features.
Files changed (118) hide show
  1. checksums.yaml +13 -5
  2. data/README.md +31 -147
  3. data/Rakefile +3 -8
  4. data/bombbomb.gemspec +17 -8
  5. data/docs/InlineResponse200.md +1 -1
  6. data/docs/JerichoConfiguration.md +1 -7
  7. data/docs/JerichoPerformance.md +0 -4
  8. data/docs/PromptsApi.md +6 -712
  9. data/docs/TeamsApi.md +62 -1144
  10. data/docs/UtilitiesApi.md +4 -4
  11. data/docs/VideoEmailPrompt.md +10 -24
  12. data/docs/WebhooksApi.md +4 -45
  13. data/git_push.sh +13 -1
  14. data/lib/bombbomb.rb +14 -30
  15. data/lib/bombbomb/api/prompts_api.rb +42 -833
  16. data/lib/bombbomb/api/teams_api.rb +157 -1331
  17. data/lib/bombbomb/api/utilities_api.rb +44 -23
  18. data/lib/bombbomb/api/webhooks_api.rb +43 -68
  19. data/lib/bombbomb/api_client.rb +45 -55
  20. data/lib/bombbomb/api_error.rb +18 -9
  21. data/lib/bombbomb/configuration.rb +13 -8
  22. data/lib/bombbomb/models/bb_web_hook.rb +17 -6
  23. data/lib/bombbomb/models/inline_response_200.rb +18 -7
  24. data/lib/bombbomb/models/inline_response_200_items.rb +1 -1
  25. data/lib/bombbomb/models/jericho_configuration.rb +22 -75
  26. data/lib/bombbomb/models/jericho_performance.rb +21 -50
  27. data/lib/bombbomb/models/o_auth_client.rb +17 -6
  28. data/lib/bombbomb/models/string.rb +17 -6
  29. data/lib/bombbomb/models/video_email_prompt.rb +90 -214
  30. data/lib/bombbomb/version.rb +14 -3
  31. data/spec/models/{team_public_representation_spec.rb → inline_response_200_items_spec.rb} +14 -8
  32. metadata +56 -168
  33. data/Gemfile +0 -7
  34. data/docs/AccountsApi.md +0 -384
  35. data/docs/AutomationsApi.md +0 -167
  36. data/docs/ClientGroupAssetMetaData.md +0 -11
  37. data/docs/ContactsApi.md +0 -436
  38. data/docs/Curriculum.md +0 -15
  39. data/docs/CurriculumApi.md +0 -109
  40. data/docs/CurriculumUserProgress.md +0 -12
  41. data/docs/CurriculumWithProgress.md +0 -15
  42. data/docs/EmailsApi.md +0 -633
  43. data/docs/FilesApi.md +0 -272
  44. data/docs/FormsApi.md +0 -60
  45. data/docs/HostedDoc.md +0 -13
  46. data/docs/IntegrationsApi.md +0 -285
  47. data/docs/ListsApi.md +0 -265
  48. data/docs/OrdersApi.md +0 -60
  49. data/docs/PromptBot.md +0 -22
  50. data/docs/PromptBotBot.md +0 -18
  51. data/docs/PromptMonthlyPerformance.md +0 -11
  52. data/docs/PromptOverview.md +0 -11
  53. data/docs/PromptSocialPrompt.md +0 -20
  54. data/docs/SignUploadRequest.md +0 -9
  55. data/docs/SignUploadResponse.md +0 -9
  56. data/docs/SocialsApi.md +0 -653
  57. data/docs/TeamPublicRepresentation.md +0 -10
  58. data/docs/UsersApi.md +0 -100
  59. data/docs/VideoEncodingStatusResponse.md +0 -10
  60. data/docs/VideoPublicRepresentation.md +0 -18
  61. data/docs/VideoRecorderMethodResponse.md +0 -15
  62. data/docs/VideosApi.md +0 -287
  63. data/lib/bombbomb/api/accounts_api.rb +0 -432
  64. data/lib/bombbomb/api/automations_api.rb +0 -191
  65. data/lib/bombbomb/api/contacts_api.rb +0 -470
  66. data/lib/bombbomb/api/curriculum_api.rb +0 -124
  67. data/lib/bombbomb/api/emails_api.rb +0 -673
  68. data/lib/bombbomb/api/files_api.rb +0 -302
  69. data/lib/bombbomb/api/forms_api.rb +0 -77
  70. data/lib/bombbomb/api/integrations_api.rb +0 -308
  71. data/lib/bombbomb/api/lists_api.rb +0 -295
  72. data/lib/bombbomb/api/orders_api.rb +0 -78
  73. data/lib/bombbomb/api/socials_api.rb +0 -714
  74. data/lib/bombbomb/api/users_api.rb +0 -119
  75. data/lib/bombbomb/api/videos_api.rb +0 -326
  76. data/lib/bombbomb/models/client_group_asset_meta_data.rb +0 -215
  77. data/lib/bombbomb/models/curriculum.rb +0 -261
  78. data/lib/bombbomb/models/curriculum_user_progress.rb +0 -229
  79. data/lib/bombbomb/models/curriculum_with_progress.rb +0 -261
  80. data/lib/bombbomb/models/hosted_doc.rb +0 -239
  81. data/lib/bombbomb/models/prompt_bot.rb +0 -329
  82. data/lib/bombbomb/models/prompt_bot_bot.rb +0 -300
  83. data/lib/bombbomb/models/prompt_monthly_performance.rb +0 -219
  84. data/lib/bombbomb/models/prompt_overview.rb +0 -219
  85. data/lib/bombbomb/models/prompt_social_prompt.rb +0 -311
  86. data/lib/bombbomb/models/sign_upload_request.rb +0 -199
  87. data/lib/bombbomb/models/sign_upload_response.rb +0 -199
  88. data/lib/bombbomb/models/team_public_representation.rb +0 -209
  89. data/lib/bombbomb/models/video_encoding_status_response.rb +0 -209
  90. data/lib/bombbomb/models/video_public_representation.rb +0 -291
  91. data/lib/bombbomb/models/video_recorder_method_response.rb +0 -259
  92. data/spec/api/accounts_api_spec.rb +0 -96
  93. data/spec/api/automations_api_spec.rb +0 -71
  94. data/spec/api/contacts_api_spec.rb +0 -58
  95. data/spec/api/curriculum_api_spec.rb +0 -69
  96. data/spec/api/emails_api_spec.rb +0 -104
  97. data/spec/api/files_api_spec.rb +0 -58
  98. data/spec/api/forms_api_spec.rb +0 -58
  99. data/spec/api/integrations_api_spec.rb +0 -58
  100. data/spec/api/lists_api_spec.rb +0 -83
  101. data/spec/api/orders_api_spec.rb +0 -58
  102. data/spec/api/socials_api_spec.rb +0 -135
  103. data/spec/api/users_api_spec.rb +0 -57
  104. data/spec/api/videos_api_spec.rb +0 -86
  105. data/spec/models/client_group_asset_meta_data_spec.rb +0 -60
  106. data/spec/models/curriculum_spec.rb +0 -95
  107. data/spec/models/curriculum_user_progress_spec.rb +0 -77
  108. data/spec/models/curriculum_with_progress_spec.rb +0 -95
  109. data/spec/models/hosted_doc_spec.rb +0 -83
  110. data/spec/models/prompt_bot_spec.rb +0 -137
  111. data/spec/models/prompt_monthly_performance_spec.rb +0 -60
  112. data/spec/models/prompt_overview_spec.rb +0 -60
  113. data/spec/models/prompt_social_prompt_spec.rb +0 -125
  114. data/spec/models/sign_upload_request_spec.rb +0 -59
  115. data/spec/models/sign_upload_response_spec.rb +0 -59
  116. data/spec/models/video_encoding_status_response_spec.rb +0 -65
  117. data/spec/models/video_public_representation_spec.rb +0 -113
  118. data/spec/models/video_recorder_method_response_spec.rb +0 -95
@@ -1,124 +0,0 @@
1
- =begin
2
- #BombBomb
3
-
4
- #We make it easy to build relationships using simple videos.
5
-
6
- OpenAPI spec version: 2.0.831
7
-
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.3.1
10
-
11
- =end
12
-
13
- require "uri"
14
-
15
- module BombBomb
16
- class CurriculumApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
-
23
- # Get Curricula
24
- # Get Curricula, optionally with progress included.
25
- # @param [Hash] opts the optional parameters
26
- # @option opts [BOOLEAN] :include_progress Whether to return progress with the curriculum.
27
- # @return [Array<Curriculum>]
28
- def get_curricula(opts = {})
29
- data, _status_code, _headers = get_curricula_with_http_info(opts)
30
- return data
31
- end
32
-
33
- # Get Curricula
34
- # Get Curricula, optionally with progress included.
35
- # @param [Hash] opts the optional parameters
36
- # @option opts [BOOLEAN] :include_progress Whether to return progress with the curriculum.
37
- # @return [Array<(Array<Curriculum>, Fixnum, Hash)>] Array<Curriculum> data, response status code and response headers
38
- def get_curricula_with_http_info(opts = {})
39
- if @api_client.config.debugging
40
- @api_client.config.logger.debug "Calling API: CurriculumApi.get_curricula ..."
41
- end
42
- # resource path
43
- local_var_path = "/curricula/"
44
-
45
- # query parameters
46
- query_params = {}
47
- query_params[:'includeProgress'] = opts[:'include_progress'] if !opts[:'include_progress'].nil?
48
-
49
- # header parameters
50
- header_params = {}
51
- # HTTP header 'Accept' (if needed)
52
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
53
- # HTTP header 'Content-Type'
54
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
55
-
56
- # form parameters
57
- form_params = {}
58
-
59
- # http body (model)
60
- post_body = nil
61
- auth_names = ['BBOAuth2']
62
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
63
- :header_params => header_params,
64
- :query_params => query_params,
65
- :form_params => form_params,
66
- :body => post_body,
67
- :auth_names => auth_names,
68
- :return_type => 'Array<Curriculum>')
69
- if @api_client.config.debugging
70
- @api_client.config.logger.debug "API called: CurriculumApi#get_curricula\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
71
- end
72
- return data, status_code, headers
73
- end
74
-
75
- # Get Detailed For User
76
- # Get all curricula for user including progress for each curriculum.
77
- # @param [Hash] opts the optional parameters
78
- # @return [Array<CurriculumWithProgress>]
79
- def get_user_curriculum_with_progress(opts = {})
80
- data, _status_code, _headers = get_user_curriculum_with_progress_with_http_info(opts)
81
- return data
82
- end
83
-
84
- # Get Detailed For User
85
- # Get all curricula for user including progress for each curriculum.
86
- # @param [Hash] opts the optional parameters
87
- # @return [Array<(Array<CurriculumWithProgress>, Fixnum, Hash)>] Array<CurriculumWithProgress> data, response status code and response headers
88
- def get_user_curriculum_with_progress_with_http_info(opts = {})
89
- if @api_client.config.debugging
90
- @api_client.config.logger.debug "Calling API: CurriculumApi.get_user_curriculum_with_progress ..."
91
- end
92
- # resource path
93
- local_var_path = "/curriculum/getForUserWithProgress"
94
-
95
- # query parameters
96
- query_params = {}
97
-
98
- # header parameters
99
- header_params = {}
100
- # HTTP header 'Accept' (if needed)
101
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
102
- # HTTP header 'Content-Type'
103
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
104
-
105
- # form parameters
106
- form_params = {}
107
-
108
- # http body (model)
109
- post_body = nil
110
- auth_names = ['BBOAuth2']
111
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
112
- :header_params => header_params,
113
- :query_params => query_params,
114
- :form_params => form_params,
115
- :body => post_body,
116
- :auth_names => auth_names,
117
- :return_type => 'Array<CurriculumWithProgress>')
118
- if @api_client.config.debugging
119
- @api_client.config.logger.debug "API called: CurriculumApi#get_user_curriculum_with_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
120
- end
121
- return data, status_code, headers
122
- end
123
- end
124
- end
@@ -1,673 +0,0 @@
1
- =begin
2
- #BombBomb
3
-
4
- #We make it easy to build relationships using simple videos.
5
-
6
- OpenAPI spec version: 2.0.831
7
-
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.3.1
10
-
11
- =end
12
-
13
- require "uri"
14
-
15
- module BombBomb
16
- class EmailsApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
-
23
- # Create an Email with Printing Press
24
- # Prints an email using the template id and content to the users account.If a video id is included, it will replace any video placeholders with that video.
25
- # @param template_id The template id to be printed.
26
- # @param content The content of the email.
27
- # @param [Hash] opts the optional parameters
28
- # @option opts [String] :email_id The email id to be printed to.
29
- # @option opts [String] :video_id A video to replace video place holders with.
30
- # @option opts [String] :subject_line The subject line to be printed.
31
- # @return [nil]
32
- def create_printing_press_email(template_id, content, opts = {})
33
- create_printing_press_email_with_http_info(template_id, content, opts)
34
- return nil
35
- end
36
-
37
- # Create an Email with Printing Press
38
- # Prints an email using the template id and content to the users account.If a video id is included, it will replace any video placeholders with that video.
39
- # @param template_id The template id to be printed.
40
- # @param content The content of the email.
41
- # @param [Hash] opts the optional parameters
42
- # @option opts [String] :email_id The email id to be printed to.
43
- # @option opts [String] :video_id A video to replace video place holders with.
44
- # @option opts [String] :subject_line The subject line to be printed.
45
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
46
- def create_printing_press_email_with_http_info(template_id, content, opts = {})
47
- if @api_client.config.debugging
48
- @api_client.config.logger.debug "Calling API: EmailsApi.create_printing_press_email ..."
49
- end
50
- # verify the required parameter 'template_id' is set
51
- if @api_client.config.client_side_validation && template_id.nil?
52
- fail ArgumentError, "Missing the required parameter 'template_id' when calling EmailsApi.create_printing_press_email"
53
- end
54
- # verify the required parameter 'content' is set
55
- if @api_client.config.client_side_validation && content.nil?
56
- fail ArgumentError, "Missing the required parameter 'content' when calling EmailsApi.create_printing_press_email"
57
- end
58
- # resource path
59
- local_var_path = "/emails/print"
60
-
61
- # query parameters
62
- query_params = {}
63
-
64
- # header parameters
65
- header_params = {}
66
- # HTTP header 'Accept' (if needed)
67
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
68
- # HTTP header 'Content-Type'
69
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
70
-
71
- # form parameters
72
- form_params = {}
73
- form_params["templateId"] = template_id
74
- form_params["content"] = content
75
- form_params["emailId"] = opts[:'email_id'] if !opts[:'email_id'].nil?
76
- form_params["videoId"] = opts[:'video_id'] if !opts[:'video_id'].nil?
77
- form_params["subjectLine"] = opts[:'subject_line'] if !opts[:'subject_line'].nil?
78
-
79
- # http body (model)
80
- post_body = nil
81
- auth_names = ['BBOAuth2']
82
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
83
- :header_params => header_params,
84
- :query_params => query_params,
85
- :form_params => form_params,
86
- :body => post_body,
87
- :auth_names => auth_names)
88
- if @api_client.config.debugging
89
- @api_client.config.logger.debug "API called: EmailsApi#create_printing_press_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
90
- end
91
- return data, status_code, headers
92
- end
93
-
94
- # Get all user templates
95
- # Get all templates accessible to the current user
96
- # @param [Hash] opts the optional parameters
97
- # @option opts [BOOLEAN] :quick_send_only Whether to return only quick send templates.
98
- # @return [nil]
99
- def get_all_templates_for_current_user(opts = {})
100
- get_all_templates_for_current_user_with_http_info(opts)
101
- return nil
102
- end
103
-
104
- # Get all user templates
105
- # Get all templates accessible to the current user
106
- # @param [Hash] opts the optional parameters
107
- # @option opts [BOOLEAN] :quick_send_only Whether to return only quick send templates.
108
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
109
- def get_all_templates_for_current_user_with_http_info(opts = {})
110
- if @api_client.config.debugging
111
- @api_client.config.logger.debug "Calling API: EmailsApi.get_all_templates_for_current_user ..."
112
- end
113
- # resource path
114
- local_var_path = "/emails/templates"
115
-
116
- # query parameters
117
- query_params = {}
118
- query_params[:'quickSendOnly'] = opts[:'quick_send_only'] if !opts[:'quick_send_only'].nil?
119
-
120
- # header parameters
121
- header_params = {}
122
- # HTTP header 'Accept' (if needed)
123
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
124
- # HTTP header 'Content-Type'
125
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
126
-
127
- # form parameters
128
- form_params = {}
129
-
130
- # http body (model)
131
- post_body = nil
132
- auth_names = ['BBOAuth2']
133
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
134
- :header_params => header_params,
135
- :query_params => query_params,
136
- :form_params => form_params,
137
- :body => post_body,
138
- :auth_names => auth_names)
139
- if @api_client.config.debugging
140
- @api_client.config.logger.debug "API called: EmailsApi#get_all_templates_for_current_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
141
- end
142
- return data, status_code, headers
143
- end
144
-
145
- # Get Email Tracking
146
- # Get Tracking data for all sends of an Email
147
- # @param email_id ID of the email
148
- # @param [Hash] opts the optional parameters
149
- # @option opts [String] :job_id ID of the Job (or null for all jobs)
150
- # @return [nil]
151
- def get_email_tracking(email_id, opts = {})
152
- get_email_tracking_with_http_info(email_id, opts)
153
- return nil
154
- end
155
-
156
- # Get Email Tracking
157
- # Get Tracking data for all sends of an Email
158
- # @param email_id ID of the email
159
- # @param [Hash] opts the optional parameters
160
- # @option opts [String] :job_id ID of the Job (or null for all jobs)
161
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
162
- def get_email_tracking_with_http_info(email_id, opts = {})
163
- if @api_client.config.debugging
164
- @api_client.config.logger.debug "Calling API: EmailsApi.get_email_tracking ..."
165
- end
166
- # verify the required parameter 'email_id' is set
167
- if @api_client.config.client_side_validation && email_id.nil?
168
- fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailsApi.get_email_tracking"
169
- end
170
- # resource path
171
- local_var_path = "/emails/{emailId}/tracking".sub('{' + 'emailId' + '}', email_id.to_s)
172
-
173
- # query parameters
174
- query_params = {}
175
- query_params[:'jobId'] = opts[:'job_id'] if !opts[:'job_id'].nil?
176
-
177
- # header parameters
178
- header_params = {}
179
- # HTTP header 'Accept' (if needed)
180
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
181
- # HTTP header 'Content-Type'
182
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
183
-
184
- # form parameters
185
- form_params = {}
186
-
187
- # http body (model)
188
- post_body = nil
189
- auth_names = ['BBOAuth2']
190
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
191
- :header_params => header_params,
192
- :query_params => query_params,
193
- :form_params => form_params,
194
- :body => post_body,
195
- :auth_names => auth_names)
196
- if @api_client.config.debugging
197
- @api_client.config.logger.debug "API called: EmailsApi#get_email_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
198
- end
199
- return data, status_code, headers
200
- end
201
-
202
- # Get Email Tracking Interactions
203
- # Get Contact detail interactions for an Email
204
- # @param email_id ID of the email
205
- # @param [Hash] opts the optional parameters
206
- # @option opts [String] :job_id ID of the Job (or null for all jobs)
207
- # @option opts [String] :interaction_type Interaction type to order and filter by
208
- # @option opts [String] :search_term Search term to filer by
209
- # @return [nil]
210
- def get_email_tracking_interactions(email_id, opts = {})
211
- get_email_tracking_interactions_with_http_info(email_id, opts)
212
- return nil
213
- end
214
-
215
- # Get Email Tracking Interactions
216
- # Get Contact detail interactions for an Email
217
- # @param email_id ID of the email
218
- # @param [Hash] opts the optional parameters
219
- # @option opts [String] :job_id ID of the Job (or null for all jobs)
220
- # @option opts [String] :interaction_type Interaction type to order and filter by
221
- # @option opts [String] :search_term Search term to filer by
222
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
223
- def get_email_tracking_interactions_with_http_info(email_id, opts = {})
224
- if @api_client.config.debugging
225
- @api_client.config.logger.debug "Calling API: EmailsApi.get_email_tracking_interactions ..."
226
- end
227
- # verify the required parameter 'email_id' is set
228
- if @api_client.config.client_side_validation && email_id.nil?
229
- fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailsApi.get_email_tracking_interactions"
230
- end
231
- # resource path
232
- local_var_path = "/emails/{emailId}/tracking/interactions".sub('{' + 'emailId' + '}', email_id.to_s)
233
-
234
- # query parameters
235
- query_params = {}
236
- query_params[:'jobId'] = opts[:'job_id'] if !opts[:'job_id'].nil?
237
- query_params[:'interactionType'] = opts[:'interaction_type'] if !opts[:'interaction_type'].nil?
238
- query_params[:'searchTerm'] = opts[:'search_term'] if !opts[:'search_term'].nil?
239
-
240
- # header parameters
241
- header_params = {}
242
- # HTTP header 'Accept' (if needed)
243
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
244
- # HTTP header 'Content-Type'
245
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
246
-
247
- # form parameters
248
- form_params = {}
249
-
250
- # http body (model)
251
- post_body = nil
252
- auth_names = ['BBOAuth2']
253
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
254
- :header_params => header_params,
255
- :query_params => query_params,
256
- :form_params => form_params,
257
- :body => post_body,
258
- :auth_names => auth_names)
259
- if @api_client.config.debugging
260
- @api_client.config.logger.debug "API called: EmailsApi#get_email_tracking_interactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
261
- end
262
- return data, status_code, headers
263
- end
264
-
265
- # Get Hourly Email Tracking
266
- # Get Tracking data for an Email, broken down by the hour and filterable by an Interaction type
267
- # @param email_id ID of the email
268
- # @param [Hash] opts the optional parameters
269
- # @option opts [String] :job_id ID of the Job (or null for all jobs)
270
- # @option opts [String] :interaction_type Interaction type to filter by
271
- # @return [nil]
272
- def get_hourly_email_tracking(email_id, opts = {})
273
- get_hourly_email_tracking_with_http_info(email_id, opts)
274
- return nil
275
- end
276
-
277
- # Get Hourly Email Tracking
278
- # Get Tracking data for an Email, broken down by the hour and filterable by an Interaction type
279
- # @param email_id ID of the email
280
- # @param [Hash] opts the optional parameters
281
- # @option opts [String] :job_id ID of the Job (or null for all jobs)
282
- # @option opts [String] :interaction_type Interaction type to filter by
283
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
284
- def get_hourly_email_tracking_with_http_info(email_id, opts = {})
285
- if @api_client.config.debugging
286
- @api_client.config.logger.debug "Calling API: EmailsApi.get_hourly_email_tracking ..."
287
- end
288
- # verify the required parameter 'email_id' is set
289
- if @api_client.config.client_side_validation && email_id.nil?
290
- fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailsApi.get_hourly_email_tracking"
291
- end
292
- # resource path
293
- local_var_path = "/emails/{emailId}/tracking/hourly".sub('{' + 'emailId' + '}', email_id.to_s)
294
-
295
- # query parameters
296
- query_params = {}
297
- query_params[:'jobId'] = opts[:'job_id'] if !opts[:'job_id'].nil?
298
- query_params[:'interactionType'] = opts[:'interaction_type'] if !opts[:'interaction_type'].nil?
299
-
300
- # header parameters
301
- header_params = {}
302
- # HTTP header 'Accept' (if needed)
303
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
304
- # HTTP header 'Content-Type'
305
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
306
-
307
- # form parameters
308
- form_params = {}
309
-
310
- # http body (model)
311
- post_body = nil
312
- auth_names = ['BBOAuth2']
313
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
314
- :header_params => header_params,
315
- :query_params => query_params,
316
- :form_params => form_params,
317
- :body => post_body,
318
- :auth_names => auth_names)
319
- if @api_client.config.debugging
320
- @api_client.config.logger.debug "API called: EmailsApi#get_hourly_email_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
321
- end
322
- return data, status_code, headers
323
- end
324
-
325
- # Get livefire feed data
326
- # Get the user data for the live fire feed emails
327
- # @param [Hash] opts the optional parameters
328
- # @return [nil]
329
- def get_live_fire_data(opts = {})
330
- get_live_fire_data_with_http_info(opts)
331
- return nil
332
- end
333
-
334
- # Get livefire feed data
335
- # Get the user data for the live fire feed emails
336
- # @param [Hash] opts the optional parameters
337
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
338
- def get_live_fire_data_with_http_info(opts = {})
339
- if @api_client.config.debugging
340
- @api_client.config.logger.debug "Calling API: EmailsApi.get_live_fire_data ..."
341
- end
342
- # resource path
343
- local_var_path = "/emails/livefire"
344
-
345
- # query parameters
346
- query_params = {}
347
-
348
- # header parameters
349
- header_params = {}
350
- # HTTP header 'Accept' (if needed)
351
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
352
- # HTTP header 'Content-Type'
353
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
354
-
355
- # form parameters
356
- form_params = {}
357
-
358
- # http body (model)
359
- post_body = nil
360
- auth_names = ['BBOAuth2']
361
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
362
- :header_params => header_params,
363
- :query_params => query_params,
364
- :form_params => form_params,
365
- :body => post_body,
366
- :auth_names => auth_names)
367
- if @api_client.config.debugging
368
- @api_client.config.logger.debug "API called: EmailsApi#get_live_fire_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
369
- end
370
- return data, status_code, headers
371
- end
372
-
373
- # Get all quicksend templates
374
- # Get all quicksend templates accessible to the user.
375
- # @param [Hash] opts the optional parameters
376
- # @return [nil]
377
- def get_quick_send_templates(opts = {})
378
- get_quick_send_templates_with_http_info(opts)
379
- return nil
380
- end
381
-
382
- # Get all quicksend templates
383
- # Get all quicksend templates accessible to the user.
384
- # @param [Hash] opts the optional parameters
385
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
386
- def get_quick_send_templates_with_http_info(opts = {})
387
- if @api_client.config.debugging
388
- @api_client.config.logger.debug "Calling API: EmailsApi.get_quick_send_templates ..."
389
- end
390
- # resource path
391
- local_var_path = "/emails/quicksend/templates"
392
-
393
- # query parameters
394
- query_params = {}
395
-
396
- # header parameters
397
- header_params = {}
398
- # HTTP header 'Accept' (if needed)
399
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
400
- # HTTP header 'Content-Type'
401
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
402
-
403
- # form parameters
404
- form_params = {}
405
-
406
- # http body (model)
407
- post_body = nil
408
- auth_names = ['BBOAuth2']
409
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
410
- :header_params => header_params,
411
- :query_params => query_params,
412
- :form_params => form_params,
413
- :body => post_body,
414
- :auth_names => auth_names)
415
- if @api_client.config.debugging
416
- @api_client.config.logger.debug "API called: EmailsApi#get_quick_send_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
417
- end
418
- return data, status_code, headers
419
- end
420
-
421
- # Get the HTML for a given template
422
- # Get the HTML for a given template, with or without rendered variables
423
- # @param template_id The id of the template.
424
- # @param [Hash] opts the optional parameters
425
- # @option opts [String] :render_variables Whether to render profile variables in the returned HTML.
426
- # @return [nil]
427
- def get_template_html_for_template_id(template_id, opts = {})
428
- get_template_html_for_template_id_with_http_info(template_id, opts)
429
- return nil
430
- end
431
-
432
- # Get the HTML for a given template
433
- # Get the HTML for a given template, with or without rendered variables
434
- # @param template_id The id of the template.
435
- # @param [Hash] opts the optional parameters
436
- # @option opts [String] :render_variables Whether to render profile variables in the returned HTML.
437
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
438
- def get_template_html_for_template_id_with_http_info(template_id, opts = {})
439
- if @api_client.config.debugging
440
- @api_client.config.logger.debug "Calling API: EmailsApi.get_template_html_for_template_id ..."
441
- end
442
- # verify the required parameter 'template_id' is set
443
- if @api_client.config.client_side_validation && template_id.nil?
444
- fail ArgumentError, "Missing the required parameter 'template_id' when calling EmailsApi.get_template_html_for_template_id"
445
- end
446
- # resource path
447
- local_var_path = "/emails/templates/{templateId}/html".sub('{' + 'templateId' + '}', template_id.to_s)
448
-
449
- # query parameters
450
- query_params = {}
451
- query_params[:'renderVariables'] = opts[:'render_variables'] if !opts[:'render_variables'].nil?
452
-
453
- # header parameters
454
- header_params = {}
455
- # HTTP header 'Accept' (if needed)
456
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
457
- # HTTP header 'Content-Type'
458
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
459
-
460
- # form parameters
461
- form_params = {}
462
-
463
- # http body (model)
464
- post_body = nil
465
- auth_names = ['BBOAuth2']
466
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
467
- :header_params => header_params,
468
- :query_params => query_params,
469
- :form_params => form_params,
470
- :body => post_body,
471
- :auth_names => auth_names)
472
- if @api_client.config.debugging
473
- @api_client.config.logger.debug "API called: EmailsApi#get_template_html_for_template_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
474
- end
475
- return data, status_code, headers
476
- end
477
-
478
- # Get quicksend data
479
- # Get the user data for quicksender, including templates and lists.
480
- # @param [Hash] opts the optional parameters
481
- # @option opts [String] :message A message for the video content.
482
- # @option opts [String] :subject A subject for the video content.
483
- # @option opts [String] :video_id A video ID.
484
- # @option opts [String] :template_id A template ID.
485
- # @option opts [String] :comma_delim_emails Comma delimited emails
486
- # @return [nil]
487
- def get_video_quick_sender_data(opts = {})
488
- get_video_quick_sender_data_with_http_info(opts)
489
- return nil
490
- end
491
-
492
- # Get quicksend data
493
- # Get the user data for quicksender, including templates and lists.
494
- # @param [Hash] opts the optional parameters
495
- # @option opts [String] :message A message for the video content.
496
- # @option opts [String] :subject A subject for the video content.
497
- # @option opts [String] :video_id A video ID.
498
- # @option opts [String] :template_id A template ID.
499
- # @option opts [String] :comma_delim_emails Comma delimited emails
500
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
501
- def get_video_quick_sender_data_with_http_info(opts = {})
502
- if @api_client.config.debugging
503
- @api_client.config.logger.debug "Calling API: EmailsApi.get_video_quick_sender_data ..."
504
- end
505
- # resource path
506
- local_var_path = "/emails/quicksend"
507
-
508
- # query parameters
509
- query_params = {}
510
- query_params[:'message'] = opts[:'message'] if !opts[:'message'].nil?
511
- query_params[:'subject'] = opts[:'subject'] if !opts[:'subject'].nil?
512
- query_params[:'videoId'] = opts[:'video_id'] if !opts[:'video_id'].nil?
513
- query_params[:'templateId'] = opts[:'template_id'] if !opts[:'template_id'].nil?
514
- query_params[:'commaDelimEmails'] = opts[:'comma_delim_emails'] if !opts[:'comma_delim_emails'].nil?
515
-
516
- # header parameters
517
- header_params = {}
518
- # HTTP header 'Accept' (if needed)
519
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
520
- # HTTP header 'Content-Type'
521
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
522
-
523
- # form parameters
524
- form_params = {}
525
-
526
- # http body (model)
527
- post_body = nil
528
- auth_names = ['BBOAuth2']
529
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
530
- :header_params => header_params,
531
- :query_params => query_params,
532
- :form_params => form_params,
533
- :body => post_body,
534
- :auth_names => auth_names)
535
- if @api_client.config.debugging
536
- @api_client.config.logger.debug "API called: EmailsApi#get_video_quick_sender_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
537
- end
538
- return data, status_code, headers
539
- end
540
-
541
- # Save quicksender settings
542
- # Save the quicksender notification and default template settings
543
- # @param [Hash] opts the optional parameters
544
- # @option opts [String] :alert_on_play A preference setting for whether or not to notify user on quicksend email video plays.
545
- # @option opts [String] :alert_on_open A preference setting for whether or not to notify user on quicksend email opens.
546
- # @option opts [String] :template_id Id of a template to use for this send. A null value means use the default for this user.
547
- # @return [nil]
548
- def save_quick_sender_settings(opts = {})
549
- save_quick_sender_settings_with_http_info(opts)
550
- return nil
551
- end
552
-
553
- # Save quicksender settings
554
- # Save the quicksender notification and default template settings
555
- # @param [Hash] opts the optional parameters
556
- # @option opts [String] :alert_on_play A preference setting for whether or not to notify user on quicksend email video plays.
557
- # @option opts [String] :alert_on_open A preference setting for whether or not to notify user on quicksend email opens.
558
- # @option opts [String] :template_id Id of a template to use for this send. A null value means use the default for this user.
559
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
560
- def save_quick_sender_settings_with_http_info(opts = {})
561
- if @api_client.config.debugging
562
- @api_client.config.logger.debug "Calling API: EmailsApi.save_quick_sender_settings ..."
563
- end
564
- # resource path
565
- local_var_path = "/emails/quicksend/settings"
566
-
567
- # query parameters
568
- query_params = {}
569
-
570
- # header parameters
571
- header_params = {}
572
- # HTTP header 'Accept' (if needed)
573
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
574
- # HTTP header 'Content-Type'
575
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
576
-
577
- # form parameters
578
- form_params = {}
579
- form_params["alertOnPlay"] = opts[:'alert_on_play'] if !opts[:'alert_on_play'].nil?
580
- form_params["alertOnOpen"] = opts[:'alert_on_open'] if !opts[:'alert_on_open'].nil?
581
- form_params["templateId"] = opts[:'template_id'] if !opts[:'template_id'].nil?
582
-
583
- # http body (model)
584
- post_body = nil
585
- auth_names = ['BBOAuth2']
586
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
587
- :header_params => header_params,
588
- :query_params => query_params,
589
- :form_params => form_params,
590
- :body => post_body,
591
- :auth_names => auth_names)
592
- if @api_client.config.debugging
593
- @api_client.config.logger.debug "API called: EmailsApi#save_quick_sender_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
594
- end
595
- return data, status_code, headers
596
- end
597
-
598
- # Send a quicksend email
599
- # Send a quicksend video email to the list or users provided.
600
- # @param [Hash] opts the optional parameters
601
- # @option opts [String] :video_id A guid id for the video.
602
- # @option opts [String] :email_addresses A semi-colon separated list of email addresses to send to.
603
- # @option opts [String] :subject Subject line for the email.
604
- # @option opts [String] :message Message for the body of the email.
605
- # @option opts [String] :list_ids An array of list ids
606
- # @option opts [Integer] :scheduled_send_timestamp When to schedule the send (seconds since epoch). null value means send immediately.
607
- # @option opts [String] :extended_properties Bool value that when checked will send back both emailId as well as extra properties
608
- # @option opts [String] :template_id Id of a template to use for this send. A null value means use the default for this user.
609
- # @option opts [String] :strip_html remove HTML elements
610
- # @return [nil]
611
- def video_quick_sender(opts = {})
612
- video_quick_sender_with_http_info(opts)
613
- return nil
614
- end
615
-
616
- # Send a quicksend email
617
- # Send a quicksend video email to the list or users provided.
618
- # @param [Hash] opts the optional parameters
619
- # @option opts [String] :video_id A guid id for the video.
620
- # @option opts [String] :email_addresses A semi-colon separated list of email addresses to send to.
621
- # @option opts [String] :subject Subject line for the email.
622
- # @option opts [String] :message Message for the body of the email.
623
- # @option opts [String] :list_ids An array of list ids
624
- # @option opts [Integer] :scheduled_send_timestamp When to schedule the send (seconds since epoch). null value means send immediately.
625
- # @option opts [String] :extended_properties Bool value that when checked will send back both emailId as well as extra properties
626
- # @option opts [String] :template_id Id of a template to use for this send. A null value means use the default for this user.
627
- # @option opts [String] :strip_html remove HTML elements
628
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
629
- def video_quick_sender_with_http_info(opts = {})
630
- if @api_client.config.debugging
631
- @api_client.config.logger.debug "Calling API: EmailsApi.video_quick_sender ..."
632
- end
633
- # resource path
634
- local_var_path = "/emails/quicksend"
635
-
636
- # query parameters
637
- query_params = {}
638
-
639
- # header parameters
640
- header_params = {}
641
- # HTTP header 'Accept' (if needed)
642
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
643
- # HTTP header 'Content-Type'
644
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
645
-
646
- # form parameters
647
- form_params = {}
648
- form_params["videoId"] = opts[:'video_id'] if !opts[:'video_id'].nil?
649
- form_params["emailAddresses"] = opts[:'email_addresses'] if !opts[:'email_addresses'].nil?
650
- form_params["subject"] = opts[:'subject'] if !opts[:'subject'].nil?
651
- form_params["message"] = opts[:'message'] if !opts[:'message'].nil?
652
- form_params["listIds"] = opts[:'list_ids'] if !opts[:'list_ids'].nil?
653
- form_params["scheduledSendTimestamp"] = opts[:'scheduled_send_timestamp'] if !opts[:'scheduled_send_timestamp'].nil?
654
- form_params["extendedProperties"] = opts[:'extended_properties'] if !opts[:'extended_properties'].nil?
655
- form_params["templateId"] = opts[:'template_id'] if !opts[:'template_id'].nil?
656
- form_params["stripHTML"] = opts[:'strip_html'] if !opts[:'strip_html'].nil?
657
-
658
- # http body (model)
659
- post_body = nil
660
- auth_names = ['BBOAuth2']
661
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
662
- :header_params => header_params,
663
- :query_params => query_params,
664
- :form_params => form_params,
665
- :body => post_body,
666
- :auth_names => auth_names)
667
- if @api_client.config.debugging
668
- @api_client.config.logger.debug "API called: EmailsApi#video_quick_sender\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
669
- end
670
- return data, status_code, headers
671
- end
672
- end
673
- end