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,295 +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 ListsApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
-
23
- # Add list.
24
- # Add a list to the users account.
25
- # @param list_name Name of the new list being added
26
- # @param [Hash] opts the optional parameters
27
- # @return [nil]
28
- def add_new_list(list_name, opts = {})
29
- add_new_list_with_http_info(list_name, opts)
30
- return nil
31
- end
32
-
33
- # Add list.
34
- # Add a list to the users account.
35
- # @param list_name Name of the new list being added
36
- # @param [Hash] opts the optional parameters
37
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
38
- def add_new_list_with_http_info(list_name, opts = {})
39
- if @api_client.config.debugging
40
- @api_client.config.logger.debug "Calling API: ListsApi.add_new_list ..."
41
- end
42
- # verify the required parameter 'list_name' is set
43
- if @api_client.config.client_side_validation && list_name.nil?
44
- fail ArgumentError, "Missing the required parameter 'list_name' when calling ListsApi.add_new_list"
45
- end
46
- # resource path
47
- local_var_path = "/lists/"
48
-
49
- # query parameters
50
- query_params = {}
51
-
52
- # header parameters
53
- header_params = {}
54
- # HTTP header 'Accept' (if needed)
55
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
56
- # HTTP header 'Content-Type'
57
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
58
-
59
- # form parameters
60
- form_params = {}
61
- form_params["listName"] = list_name
62
-
63
- # http body (model)
64
- post_body = nil
65
- auth_names = ['BBOAuth2']
66
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
67
- :header_params => header_params,
68
- :query_params => query_params,
69
- :form_params => form_params,
70
- :body => post_body,
71
- :auth_names => auth_names)
72
- if @api_client.config.debugging
73
- @api_client.config.logger.debug "API called: ListsApi#add_new_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
74
- end
75
- return data, status_code, headers
76
- end
77
-
78
- # Clear Contacts from List
79
- # Clears all contacts from a list.
80
- # @param list_id The list to be cleared.
81
- # @param [Hash] opts the optional parameters
82
- # @return [nil]
83
- def clear_list(list_id, opts = {})
84
- clear_list_with_http_info(list_id, opts)
85
- return nil
86
- end
87
-
88
- # Clear Contacts from List
89
- # Clears all contacts from a list.
90
- # @param list_id The list to be cleared.
91
- # @param [Hash] opts the optional parameters
92
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
93
- def clear_list_with_http_info(list_id, opts = {})
94
- if @api_client.config.debugging
95
- @api_client.config.logger.debug "Calling API: ListsApi.clear_list ..."
96
- end
97
- # verify the required parameter 'list_id' is set
98
- if @api_client.config.client_side_validation && list_id.nil?
99
- fail ArgumentError, "Missing the required parameter 'list_id' when calling ListsApi.clear_list"
100
- end
101
- # resource path
102
- local_var_path = "/lists/{listId}/clear".sub('{' + 'listId' + '}', list_id.to_s)
103
-
104
- # query parameters
105
- query_params = {}
106
-
107
- # header parameters
108
- header_params = {}
109
- # HTTP header 'Accept' (if needed)
110
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
111
- # HTTP header 'Content-Type'
112
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
113
-
114
- # form parameters
115
- form_params = {}
116
-
117
- # http body (model)
118
- post_body = nil
119
- auth_names = ['BBOAuth2']
120
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
121
- :header_params => header_params,
122
- :query_params => query_params,
123
- :form_params => form_params,
124
- :body => post_body,
125
- :auth_names => auth_names)
126
- if @api_client.config.debugging
127
- @api_client.config.logger.debug "API called: ListsApi#clear_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
128
- end
129
- return data, status_code, headers
130
- end
131
-
132
- # Copy All Contacts from a List
133
- # Copy all contacts from a list.
134
- # @param from_list_id The list to be cleared.
135
- # @param list_id The list to be cleared.
136
- # @param [Hash] opts the optional parameters
137
- # @return [nil]
138
- def copy_list_contacts(from_list_id, list_id, opts = {})
139
- copy_list_contacts_with_http_info(from_list_id, list_id, opts)
140
- return nil
141
- end
142
-
143
- # Copy All Contacts from a List
144
- # Copy all contacts from a list.
145
- # @param from_list_id The list to be cleared.
146
- # @param list_id The list to be cleared.
147
- # @param [Hash] opts the optional parameters
148
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
149
- def copy_list_contacts_with_http_info(from_list_id, list_id, opts = {})
150
- if @api_client.config.debugging
151
- @api_client.config.logger.debug "Calling API: ListsApi.copy_list_contacts ..."
152
- end
153
- # verify the required parameter 'from_list_id' is set
154
- if @api_client.config.client_side_validation && from_list_id.nil?
155
- fail ArgumentError, "Missing the required parameter 'from_list_id' when calling ListsApi.copy_list_contacts"
156
- end
157
- # verify the required parameter 'list_id' is set
158
- if @api_client.config.client_side_validation && list_id.nil?
159
- fail ArgumentError, "Missing the required parameter 'list_id' when calling ListsApi.copy_list_contacts"
160
- end
161
- # resource path
162
- local_var_path = "/lists/{listId}/copy".sub('{' + 'listId' + '}', list_id.to_s)
163
-
164
- # query parameters
165
- query_params = {}
166
-
167
- # header parameters
168
- header_params = {}
169
- # HTTP header 'Accept' (if needed)
170
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
171
- # HTTP header 'Content-Type'
172
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
173
-
174
- # form parameters
175
- form_params = {}
176
- form_params["fromListId"] = from_list_id
177
-
178
- # http body (model)
179
- post_body = nil
180
- auth_names = ['BBOAuth2']
181
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
182
- :header_params => header_params,
183
- :query_params => query_params,
184
- :form_params => form_params,
185
- :body => post_body,
186
- :auth_names => auth_names)
187
- if @api_client.config.debugging
188
- @api_client.config.logger.debug "API called: ListsApi#copy_list_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
189
- end
190
- return data, status_code, headers
191
- end
192
-
193
- # Get all Lists
194
- # Get all the lists for a specific user.
195
- # @param [Hash] opts the optional parameters
196
- # @return [nil]
197
- def get_all_lists(opts = {})
198
- get_all_lists_with_http_info(opts)
199
- return nil
200
- end
201
-
202
- # Get all Lists
203
- # Get all the lists for a specific user.
204
- # @param [Hash] opts the optional parameters
205
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
206
- def get_all_lists_with_http_info(opts = {})
207
- if @api_client.config.debugging
208
- @api_client.config.logger.debug "Calling API: ListsApi.get_all_lists ..."
209
- end
210
- # resource path
211
- local_var_path = "/lists/"
212
-
213
- # query parameters
214
- query_params = {}
215
-
216
- # header parameters
217
- header_params = {}
218
- # HTTP header 'Accept' (if needed)
219
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
220
- # HTTP header 'Content-Type'
221
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
222
-
223
- # form parameters
224
- form_params = {}
225
-
226
- # http body (model)
227
- post_body = nil
228
- auth_names = ['BBOAuth2']
229
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
230
- :header_params => header_params,
231
- :query_params => query_params,
232
- :form_params => form_params,
233
- :body => post_body,
234
- :auth_names => auth_names)
235
- if @api_client.config.debugging
236
- @api_client.config.logger.debug "API called: ListsApi#get_all_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
237
- end
238
- return data, status_code, headers
239
- end
240
-
241
- # Suppress All Contacts from List
242
- # Suppresses all contacts in a list.
243
- # @param list_id The list to be cleared.
244
- # @param [Hash] opts the optional parameters
245
- # @return [nil]
246
- def suppress_all_in_list(list_id, opts = {})
247
- suppress_all_in_list_with_http_info(list_id, opts)
248
- return nil
249
- end
250
-
251
- # Suppress All Contacts from List
252
- # Suppresses all contacts in a list.
253
- # @param list_id The list to be cleared.
254
- # @param [Hash] opts the optional parameters
255
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
256
- def suppress_all_in_list_with_http_info(list_id, opts = {})
257
- if @api_client.config.debugging
258
- @api_client.config.logger.debug "Calling API: ListsApi.suppress_all_in_list ..."
259
- end
260
- # verify the required parameter 'list_id' is set
261
- if @api_client.config.client_side_validation && list_id.nil?
262
- fail ArgumentError, "Missing the required parameter 'list_id' when calling ListsApi.suppress_all_in_list"
263
- end
264
- # resource path
265
- local_var_path = "/lists/{listId}/suppress".sub('{' + 'listId' + '}', list_id.to_s)
266
-
267
- # query parameters
268
- query_params = {}
269
-
270
- # header parameters
271
- header_params = {}
272
- # HTTP header 'Accept' (if needed)
273
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
274
- # HTTP header 'Content-Type'
275
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
276
-
277
- # form parameters
278
- form_params = {}
279
-
280
- # http body (model)
281
- post_body = nil
282
- auth_names = ['BBOAuth2']
283
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
284
- :header_params => header_params,
285
- :query_params => query_params,
286
- :form_params => form_params,
287
- :body => post_body,
288
- :auth_names => auth_names)
289
- if @api_client.config.debugging
290
- @api_client.config.logger.debug "API called: ListsApi#suppress_all_in_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
291
- end
292
- return data, status_code, headers
293
- end
294
- end
295
- end
@@ -1,78 +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 OrdersApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
-
23
- # Deletes image from user s3 store
24
- # Deletes image from user s3 store
25
- # @param file_name Filename for deletion
26
- # @param [Hash] opts the optional parameters
27
- # @return [nil]
28
- def template_asset_delete(file_name, opts = {})
29
- template_asset_delete_with_http_info(file_name, opts)
30
- return nil
31
- end
32
-
33
- # Deletes image from user s3 store
34
- # Deletes image from user s3 store
35
- # @param file_name Filename for deletion
36
- # @param [Hash] opts the optional parameters
37
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
38
- def template_asset_delete_with_http_info(file_name, opts = {})
39
- if @api_client.config.debugging
40
- @api_client.config.logger.debug "Calling API: OrdersApi.template_asset_delete ..."
41
- end
42
- # verify the required parameter 'file_name' is set
43
- if @api_client.config.client_side_validation && file_name.nil?
44
- fail ArgumentError, "Missing the required parameter 'file_name' when calling OrdersApi.template_asset_delete"
45
- end
46
- # resource path
47
- local_var_path = "/orders/templates/images"
48
-
49
- # query parameters
50
- query_params = {}
51
-
52
- # header parameters
53
- header_params = {}
54
- # HTTP header 'Accept' (if needed)
55
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
56
- # HTTP header 'Content-Type'
57
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
58
-
59
- # form parameters
60
- form_params = {}
61
- form_params["fileName"] = file_name
62
-
63
- # http body (model)
64
- post_body = nil
65
- auth_names = ['BBOAuth2']
66
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
67
- :header_params => header_params,
68
- :query_params => query_params,
69
- :form_params => form_params,
70
- :body => post_body,
71
- :auth_names => auth_names)
72
- if @api_client.config.debugging
73
- @api_client.config.logger.debug "API called: OrdersApi#template_asset_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
74
- end
75
- return data, status_code, headers
76
- end
77
- end
78
- end
@@ -1,714 +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 SocialsApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
-
23
- # Gets facebook pages
24
- # Gets facebook pages by client id
25
- # @param [Hash] opts the optional parameters
26
- # @return [nil]
27
- def get_facebook_pages(opts = {})
28
- get_facebook_pages_with_http_info(opts)
29
- return nil
30
- end
31
-
32
- # Gets facebook pages
33
- # Gets facebook pages by client id
34
- # @param [Hash] opts the optional parameters
35
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
36
- def get_facebook_pages_with_http_info(opts = {})
37
- if @api_client.config.debugging
38
- @api_client.config.logger.debug "Calling API: SocialsApi.get_facebook_pages ..."
39
- end
40
- # resource path
41
- local_var_path = "/socials/facebook/pages"
42
-
43
- # query parameters
44
- query_params = {}
45
-
46
- # header parameters
47
- header_params = {}
48
- # HTTP header 'Accept' (if needed)
49
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
50
- # HTTP header 'Content-Type'
51
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
52
-
53
- # form parameters
54
- form_params = {}
55
-
56
- # http body (model)
57
- post_body = nil
58
- auth_names = ['BBOAuth2']
59
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
60
- :header_params => header_params,
61
- :query_params => query_params,
62
- :form_params => form_params,
63
- :body => post_body,
64
- :auth_names => auth_names)
65
- if @api_client.config.debugging
66
- @api_client.config.logger.debug "API called: SocialsApi#get_facebook_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
67
- end
68
- return data, status_code, headers
69
- end
70
-
71
- # Gets the social email properties
72
- # Gets the social email properties
73
- # @param email_id This is the email Id for the email url
74
- # @param social_content_id This is the social content Id
75
- # @param [Hash] opts the optional parameters
76
- # @return [nil]
77
- def get_social_article_properties(email_id, social_content_id, opts = {})
78
- get_social_article_properties_with_http_info(email_id, social_content_id, opts)
79
- return nil
80
- end
81
-
82
- # Gets the social email properties
83
- # Gets the social email properties
84
- # @param email_id This is the email Id for the email url
85
- # @param social_content_id This is the social content Id
86
- # @param [Hash] opts the optional parameters
87
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
88
- def get_social_article_properties_with_http_info(email_id, social_content_id, opts = {})
89
- if @api_client.config.debugging
90
- @api_client.config.logger.debug "Calling API: SocialsApi.get_social_article_properties ..."
91
- end
92
- # verify the required parameter 'email_id' is set
93
- if @api_client.config.client_side_validation && email_id.nil?
94
- fail ArgumentError, "Missing the required parameter 'email_id' when calling SocialsApi.get_social_article_properties"
95
- end
96
- # verify the required parameter 'social_content_id' is set
97
- if @api_client.config.client_side_validation && social_content_id.nil?
98
- fail ArgumentError, "Missing the required parameter 'social_content_id' when calling SocialsApi.get_social_article_properties"
99
- end
100
- # resource path
101
- local_var_path = "/socials/properties"
102
-
103
- # query parameters
104
- query_params = {}
105
- query_params[:'emailId'] = email_id
106
- query_params[:'socialContentId'] = social_content_id
107
-
108
- # header parameters
109
- header_params = {}
110
- # HTTP header 'Accept' (if needed)
111
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
112
- # HTTP header 'Content-Type'
113
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
114
-
115
- # form parameters
116
- form_params = {}
117
-
118
- # http body (model)
119
- post_body = nil
120
- auth_names = ['BBOAuth2']
121
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
122
- :header_params => header_params,
123
- :query_params => query_params,
124
- :form_params => form_params,
125
- :body => post_body,
126
- :auth_names => auth_names)
127
- if @api_client.config.debugging
128
- @api_client.config.logger.debug "API called: SocialsApi#get_social_article_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
129
- end
130
- return data, status_code, headers
131
- end
132
-
133
- # Get authorizations for all social integration
134
- # Get authorizations and autoshares for all social integration and has redirect for user to login
135
- # @param [Hash] opts the optional parameters
136
- # @option opts [String] :client_group_id ID of the client group association
137
- # @return [nil]
138
- def get_social_authorizations(opts = {})
139
- get_social_authorizations_with_http_info(opts)
140
- return nil
141
- end
142
-
143
- # Get authorizations for all social integration
144
- # Get authorizations and autoshares for all social integration and has redirect for user to login
145
- # @param [Hash] opts the optional parameters
146
- # @option opts [String] :client_group_id ID of the client group association
147
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
148
- def get_social_authorizations_with_http_info(opts = {})
149
- if @api_client.config.debugging
150
- @api_client.config.logger.debug "Calling API: SocialsApi.get_social_authorizations ..."
151
- end
152
- # resource path
153
- local_var_path = "/socials/authorizations"
154
-
155
- # query parameters
156
- query_params = {}
157
- query_params[:'clientGroupId'] = opts[:'client_group_id'] if !opts[:'client_group_id'].nil?
158
-
159
- # header parameters
160
- header_params = {}
161
- # HTTP header 'Accept' (if needed)
162
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
163
- # HTTP header 'Content-Type'
164
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
165
-
166
- # form parameters
167
- form_params = {}
168
-
169
- # http body (model)
170
- post_body = nil
171
- auth_names = ['BBOAuth2']
172
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
173
- :header_params => header_params,
174
- :query_params => query_params,
175
- :form_params => form_params,
176
- :body => post_body,
177
- :auth_names => auth_names)
178
- if @api_client.config.debugging
179
- @api_client.config.logger.debug "API called: SocialsApi#get_social_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
180
- end
181
- return data, status_code, headers
182
- end
183
-
184
- # Gets the profile properties
185
- # Gets the social profile properties
186
- # @param social_type The social type
187
- # @param [Hash] opts the optional parameters
188
- # @return [nil]
189
- def get_social_profile_properties(social_type, opts = {})
190
- get_social_profile_properties_with_http_info(social_type, opts)
191
- return nil
192
- end
193
-
194
- # Gets the profile properties
195
- # Gets the social profile properties
196
- # @param social_type The social type
197
- # @param [Hash] opts the optional parameters
198
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
199
- def get_social_profile_properties_with_http_info(social_type, opts = {})
200
- if @api_client.config.debugging
201
- @api_client.config.logger.debug "Calling API: SocialsApi.get_social_profile_properties ..."
202
- end
203
- # verify the required parameter 'social_type' is set
204
- if @api_client.config.client_side_validation && social_type.nil?
205
- fail ArgumentError, "Missing the required parameter 'social_type' when calling SocialsApi.get_social_profile_properties"
206
- end
207
- # resource path
208
- local_var_path = "/socials/profile"
209
-
210
- # query parameters
211
- query_params = {}
212
- query_params[:'socialType'] = social_type
213
-
214
- # header parameters
215
- header_params = {}
216
- # HTTP header 'Accept' (if needed)
217
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
218
- # HTTP header 'Content-Type'
219
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
220
-
221
- # form parameters
222
- form_params = {}
223
-
224
- # http body (model)
225
- post_body = nil
226
- auth_names = ['BBOAuth2']
227
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
228
- :header_params => header_params,
229
- :query_params => query_params,
230
- :form_params => form_params,
231
- :body => post_body,
232
- :auth_names => auth_names)
233
- if @api_client.config.debugging
234
- @api_client.config.logger.debug "API called: SocialsApi#get_social_profile_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
235
- end
236
- return data, status_code, headers
237
- end
238
-
239
- # Get social stats for a prompt
240
- # Get social stats for a prompt by id
241
- # @param prompt_id ID of the prompt
242
- # @param [Hash] opts the optional parameters
243
- # @return [nil]
244
- def get_social_stats(prompt_id, opts = {})
245
- get_social_stats_with_http_info(prompt_id, opts)
246
- return nil
247
- end
248
-
249
- # Get social stats for a prompt
250
- # Get social stats for a prompt by id
251
- # @param prompt_id ID of the prompt
252
- # @param [Hash] opts the optional parameters
253
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
254
- def get_social_stats_with_http_info(prompt_id, opts = {})
255
- if @api_client.config.debugging
256
- @api_client.config.logger.debug "Calling API: SocialsApi.get_social_stats ..."
257
- end
258
- # verify the required parameter 'prompt_id' is set
259
- if @api_client.config.client_side_validation && prompt_id.nil?
260
- fail ArgumentError, "Missing the required parameter 'prompt_id' when calling SocialsApi.get_social_stats"
261
- end
262
- # resource path
263
- local_var_path = "/socials/{promptId}/stats".sub('{' + 'promptId' + '}', prompt_id.to_s)
264
-
265
- # query parameters
266
- query_params = {}
267
-
268
- # header parameters
269
- header_params = {}
270
- # HTTP header 'Accept' (if needed)
271
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
272
- # HTTP header 'Content-Type'
273
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
274
-
275
- # form parameters
276
- form_params = {}
277
-
278
- # http body (model)
279
- post_body = nil
280
- auth_names = ['BBOAuth2']
281
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
282
- :header_params => header_params,
283
- :query_params => query_params,
284
- :form_params => form_params,
285
- :body => post_body,
286
- :auth_names => auth_names)
287
- if @api_client.config.debugging
288
- @api_client.config.logger.debug "API called: SocialsApi#get_social_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
289
- end
290
- return data, status_code, headers
291
- end
292
-
293
- # Creates social content
294
- # Creates social content for an email
295
- # @param email_id The email&#39;s id
296
- # @param [Hash] opts the optional parameters
297
- # @return [nil]
298
- def post_social_content(email_id, opts = {})
299
- post_social_content_with_http_info(email_id, opts)
300
- return nil
301
- end
302
-
303
- # Creates social content
304
- # Creates social content for an email
305
- # @param email_id The email&#39;s id
306
- # @param [Hash] opts the optional parameters
307
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
308
- def post_social_content_with_http_info(email_id, opts = {})
309
- if @api_client.config.debugging
310
- @api_client.config.logger.debug "Calling API: SocialsApi.post_social_content ..."
311
- end
312
- # verify the required parameter 'email_id' is set
313
- if @api_client.config.client_side_validation && email_id.nil?
314
- fail ArgumentError, "Missing the required parameter 'email_id' when calling SocialsApi.post_social_content"
315
- end
316
- # resource path
317
- local_var_path = "/socials/content"
318
-
319
- # query parameters
320
- query_params = {}
321
-
322
- # header parameters
323
- header_params = {}
324
- # HTTP header 'Accept' (if needed)
325
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
326
- # HTTP header 'Content-Type'
327
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
328
-
329
- # form parameters
330
- form_params = {}
331
- form_params["emailId"] = email_id
332
-
333
- # http body (model)
334
- post_body = nil
335
- auth_names = ['BBOAuth2']
336
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
337
- :header_params => header_params,
338
- :query_params => query_params,
339
- :form_params => form_params,
340
- :body => post_body,
341
- :auth_names => auth_names)
342
- if @api_client.config.debugging
343
- @api_client.config.logger.debug "API called: SocialsApi#post_social_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
344
- end
345
- return data, status_code, headers
346
- end
347
-
348
- # Sends social content
349
- # Sends social content that failed for a user via their associated prompt
350
- # @param prompt_id The prompt id
351
- # @param [Hash] opts the optional parameters
352
- # @return [nil]
353
- def retry_social_send(prompt_id, opts = {})
354
- retry_social_send_with_http_info(prompt_id, opts)
355
- return nil
356
- end
357
-
358
- # Sends social content
359
- # Sends social content that failed for a user via their associated prompt
360
- # @param prompt_id The prompt id
361
- # @param [Hash] opts the optional parameters
362
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
363
- def retry_social_send_with_http_info(prompt_id, opts = {})
364
- if @api_client.config.debugging
365
- @api_client.config.logger.debug "Calling API: SocialsApi.retry_social_send ..."
366
- end
367
- # verify the required parameter 'prompt_id' is set
368
- if @api_client.config.client_side_validation && prompt_id.nil?
369
- fail ArgumentError, "Missing the required parameter 'prompt_id' when calling SocialsApi.retry_social_send"
370
- end
371
- # resource path
372
- local_var_path = "/socials/send/retry"
373
-
374
- # query parameters
375
- query_params = {}
376
-
377
- # header parameters
378
- header_params = {}
379
- # HTTP header 'Accept' (if needed)
380
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
381
- # HTTP header 'Content-Type'
382
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
383
-
384
- # form parameters
385
- form_params = {}
386
- form_params["promptId"] = prompt_id
387
-
388
- # http body (model)
389
- post_body = nil
390
- auth_names = ['BBOAuth2']
391
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
392
- :header_params => header_params,
393
- :query_params => query_params,
394
- :form_params => form_params,
395
- :body => post_body,
396
- :auth_names => auth_names)
397
- if @api_client.config.debugging
398
- @api_client.config.logger.debug "API called: SocialsApi#retry_social_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
399
- end
400
- return data, status_code, headers
401
- end
402
-
403
- # Sends social content
404
- # Sends social content for a user via their associated prompt
405
- # @param prompt_id The prompt id
406
- # @param social_type The destination for social content
407
- # @param [Hash] opts the optional parameters
408
- # @return [nil]
409
- def send_social(prompt_id, social_type, opts = {})
410
- send_social_with_http_info(prompt_id, social_type, opts)
411
- return nil
412
- end
413
-
414
- # Sends social content
415
- # Sends social content for a user via their associated prompt
416
- # @param prompt_id The prompt id
417
- # @param social_type The destination for social content
418
- # @param [Hash] opts the optional parameters
419
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
420
- def send_social_with_http_info(prompt_id, social_type, opts = {})
421
- if @api_client.config.debugging
422
- @api_client.config.logger.debug "Calling API: SocialsApi.send_social ..."
423
- end
424
- # verify the required parameter 'prompt_id' is set
425
- if @api_client.config.client_side_validation && prompt_id.nil?
426
- fail ArgumentError, "Missing the required parameter 'prompt_id' when calling SocialsApi.send_social"
427
- end
428
- # verify the required parameter 'social_type' is set
429
- if @api_client.config.client_side_validation && social_type.nil?
430
- fail ArgumentError, "Missing the required parameter 'social_type' when calling SocialsApi.send_social"
431
- end
432
- # resource path
433
- local_var_path = "/socials/send"
434
-
435
- # query parameters
436
- query_params = {}
437
-
438
- # header parameters
439
- header_params = {}
440
- # HTTP header 'Accept' (if needed)
441
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
442
- # HTTP header 'Content-Type'
443
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
444
-
445
- # form parameters
446
- form_params = {}
447
- form_params["promptId"] = prompt_id
448
- form_params["socialType"] = social_type
449
-
450
- # http body (model)
451
- post_body = nil
452
- auth_names = ['BBOAuth2']
453
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
454
- :header_params => header_params,
455
- :query_params => query_params,
456
- :form_params => form_params,
457
- :body => post_body,
458
- :auth_names => auth_names)
459
- if @api_client.config.debugging
460
- @api_client.config.logger.debug "API called: SocialsApi#send_social\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
461
- end
462
- return data, status_code, headers
463
- end
464
-
465
- # Gets the auto shares from the client group assoc id
466
- # Gets the auto shares from the client group assoc id
467
- # @param send_mechanism The send mechanism for the prompt
468
- # @param client_group_id ID of the client group association
469
- # @param [Hash] opts the optional parameters
470
- # @option opts [String] :enabled Is the send mechanism enabled?
471
- # @return [nil]
472
- def update_client_group_send_mechanism(send_mechanism, client_group_id, opts = {})
473
- update_client_group_send_mechanism_with_http_info(send_mechanism, client_group_id, opts)
474
- return nil
475
- end
476
-
477
- # Gets the auto shares from the client group assoc id
478
- # Gets the auto shares from the client group assoc id
479
- # @param send_mechanism The send mechanism for the prompt
480
- # @param client_group_id ID of the client group association
481
- # @param [Hash] opts the optional parameters
482
- # @option opts [String] :enabled Is the send mechanism enabled?
483
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
484
- def update_client_group_send_mechanism_with_http_info(send_mechanism, client_group_id, opts = {})
485
- if @api_client.config.debugging
486
- @api_client.config.logger.debug "Calling API: SocialsApi.update_client_group_send_mechanism ..."
487
- end
488
- # verify the required parameter 'send_mechanism' is set
489
- if @api_client.config.client_side_validation && send_mechanism.nil?
490
- fail ArgumentError, "Missing the required parameter 'send_mechanism' when calling SocialsApi.update_client_group_send_mechanism"
491
- end
492
- # verify the required parameter 'client_group_id' is set
493
- if @api_client.config.client_side_validation && client_group_id.nil?
494
- fail ArgumentError, "Missing the required parameter 'client_group_id' when calling SocialsApi.update_client_group_send_mechanism"
495
- end
496
- # resource path
497
- local_var_path = "/socials/client/sendMechanism"
498
-
499
- # query parameters
500
- query_params = {}
501
-
502
- # header parameters
503
- header_params = {}
504
- # HTTP header 'Accept' (if needed)
505
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
506
- # HTTP header 'Content-Type'
507
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
508
-
509
- # form parameters
510
- form_params = {}
511
- form_params["sendMechanism"] = send_mechanism
512
- form_params["clientGroupId"] = client_group_id
513
- form_params["enabled"] = opts[:'enabled'] if !opts[:'enabled'].nil?
514
-
515
- # http body (model)
516
- post_body = nil
517
- auth_names = ['BBOAuth2']
518
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
519
- :header_params => header_params,
520
- :query_params => query_params,
521
- :form_params => form_params,
522
- :body => post_body,
523
- :auth_names => auth_names)
524
- if @api_client.config.debugging
525
- @api_client.config.logger.debug "API called: SocialsApi#update_client_group_send_mechanism\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
526
- end
527
- return data, status_code, headers
528
- end
529
-
530
- # Toggles the prompt campaigns in a users account
531
- # Toggles the prompt campaigns in a users account for a social integrations on or off
532
- # @param send_mechanism The send mechanism for the prompt
533
- # @param enabled Is the send mechanism enabled?
534
- # @param [Hash] opts the optional parameters
535
- # @return [nil]
536
- def update_client_groups_send_mechanism(send_mechanism, enabled, opts = {})
537
- update_client_groups_send_mechanism_with_http_info(send_mechanism, enabled, opts)
538
- return nil
539
- end
540
-
541
- # Toggles the prompt campaigns in a users account
542
- # Toggles the prompt campaigns in a users account for a social integrations on or off
543
- # @param send_mechanism The send mechanism for the prompt
544
- # @param enabled Is the send mechanism enabled?
545
- # @param [Hash] opts the optional parameters
546
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
547
- def update_client_groups_send_mechanism_with_http_info(send_mechanism, enabled, opts = {})
548
- if @api_client.config.debugging
549
- @api_client.config.logger.debug "Calling API: SocialsApi.update_client_groups_send_mechanism ..."
550
- end
551
- # verify the required parameter 'send_mechanism' is set
552
- if @api_client.config.client_side_validation && send_mechanism.nil?
553
- fail ArgumentError, "Missing the required parameter 'send_mechanism' when calling SocialsApi.update_client_groups_send_mechanism"
554
- end
555
- # verify the required parameter 'enabled' is set
556
- if @api_client.config.client_side_validation && enabled.nil?
557
- fail ArgumentError, "Missing the required parameter 'enabled' when calling SocialsApi.update_client_groups_send_mechanism"
558
- end
559
- # resource path
560
- local_var_path = "/socials/client/sendMechanisms"
561
-
562
- # query parameters
563
- query_params = {}
564
-
565
- # header parameters
566
- header_params = {}
567
- # HTTP header 'Accept' (if needed)
568
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
569
- # HTTP header 'Content-Type'
570
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
571
-
572
- # form parameters
573
- form_params = {}
574
- form_params["sendMechanism"] = send_mechanism
575
- form_params["enabled"] = enabled
576
-
577
- # http body (model)
578
- post_body = nil
579
- auth_names = ['BBOAuth2']
580
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
581
- :header_params => header_params,
582
- :query_params => query_params,
583
- :form_params => form_params,
584
- :body => post_body,
585
- :auth_names => auth_names)
586
- if @api_client.config.debugging
587
- @api_client.config.logger.debug "API called: SocialsApi#update_client_groups_send_mechanism\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
588
- end
589
- return data, status_code, headers
590
- end
591
-
592
- # Updates facebook page Ids
593
- # Updates facebook page Ids to be sent to for prompts
594
- # @param page_ids Page Ids for the prompt
595
- # @param [Hash] opts the optional parameters
596
- # @return [nil]
597
- def update_facebook_pages(page_ids, opts = {})
598
- update_facebook_pages_with_http_info(page_ids, opts)
599
- return nil
600
- end
601
-
602
- # Updates facebook page Ids
603
- # Updates facebook page Ids to be sent to for prompts
604
- # @param page_ids Page Ids for the prompt
605
- # @param [Hash] opts the optional parameters
606
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
607
- def update_facebook_pages_with_http_info(page_ids, opts = {})
608
- if @api_client.config.debugging
609
- @api_client.config.logger.debug "Calling API: SocialsApi.update_facebook_pages ..."
610
- end
611
- # verify the required parameter 'page_ids' is set
612
- if @api_client.config.client_side_validation && page_ids.nil?
613
- fail ArgumentError, "Missing the required parameter 'page_ids' when calling SocialsApi.update_facebook_pages"
614
- end
615
- # resource path
616
- local_var_path = "/socials/facebook/pages"
617
-
618
- # query parameters
619
- query_params = {}
620
-
621
- # header parameters
622
- header_params = {}
623
- # HTTP header 'Accept' (if needed)
624
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
625
- # HTTP header 'Content-Type'
626
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
627
-
628
- # form parameters
629
- form_params = {}
630
- form_params["pageIds"] = page_ids
631
-
632
- # http body (model)
633
- post_body = nil
634
- auth_names = ['BBOAuth2']
635
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
636
- :header_params => header_params,
637
- :query_params => query_params,
638
- :form_params => form_params,
639
- :body => post_body,
640
- :auth_names => auth_names)
641
- if @api_client.config.debugging
642
- @api_client.config.logger.debug "API called: SocialsApi#update_facebook_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
643
- end
644
- return data, status_code, headers
645
- end
646
-
647
- # Updates social content
648
- # Updates social content for an email
649
- # @param social_id The social id
650
- # @param [Hash] opts the optional parameters
651
- # @option opts [String] :title The title for the article
652
- # @option opts [String] :description The article description
653
- # @option opts [String] :picture_url The article picture url
654
- # @option opts [String] :suggested_message The suggested message to use
655
- # @return [nil]
656
- def update_social_content(social_id, opts = {})
657
- update_social_content_with_http_info(social_id, opts)
658
- return nil
659
- end
660
-
661
- # Updates social content
662
- # Updates social content for an email
663
- # @param social_id The social id
664
- # @param [Hash] opts the optional parameters
665
- # @option opts [String] :title The title for the article
666
- # @option opts [String] :description The article description
667
- # @option opts [String] :picture_url The article picture url
668
- # @option opts [String] :suggested_message The suggested message to use
669
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
670
- def update_social_content_with_http_info(social_id, opts = {})
671
- if @api_client.config.debugging
672
- @api_client.config.logger.debug "Calling API: SocialsApi.update_social_content ..."
673
- end
674
- # verify the required parameter 'social_id' is set
675
- if @api_client.config.client_side_validation && social_id.nil?
676
- fail ArgumentError, "Missing the required parameter 'social_id' when calling SocialsApi.update_social_content"
677
- end
678
- # resource path
679
- local_var_path = "/socials/content"
680
-
681
- # query parameters
682
- query_params = {}
683
-
684
- # header parameters
685
- header_params = {}
686
- # HTTP header 'Accept' (if needed)
687
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
688
- # HTTP header 'Content-Type'
689
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
690
-
691
- # form parameters
692
- form_params = {}
693
- form_params["socialId"] = social_id
694
- form_params["title"] = opts[:'title'] if !opts[:'title'].nil?
695
- form_params["description"] = opts[:'description'] if !opts[:'description'].nil?
696
- form_params["pictureUrl"] = opts[:'picture_url'] if !opts[:'picture_url'].nil?
697
- form_params["suggestedMessage"] = opts[:'suggested_message'] if !opts[:'suggested_message'].nil?
698
-
699
- # http body (model)
700
- post_body = nil
701
- auth_names = ['BBOAuth2']
702
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
703
- :header_params => header_params,
704
- :query_params => query_params,
705
- :form_params => form_params,
706
- :body => post_body,
707
- :auth_names => auth_names)
708
- if @api_client.config.debugging
709
- @api_client.config.logger.debug "API called: SocialsApi#update_social_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
710
- end
711
- return data, status_code, headers
712
- end
713
- end
714
- end