bombbomb 2.0.831 → 2.0.20679
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +13 -5
- data/README.md +31 -147
- data/Rakefile +3 -8
- data/bombbomb.gemspec +17 -8
- data/docs/InlineResponse200.md +1 -1
- data/docs/JerichoConfiguration.md +1 -7
- data/docs/JerichoPerformance.md +0 -4
- data/docs/PromptsApi.md +6 -712
- data/docs/TeamsApi.md +62 -1144
- data/docs/UtilitiesApi.md +4 -4
- data/docs/VideoEmailPrompt.md +10 -24
- data/docs/WebhooksApi.md +4 -45
- data/git_push.sh +13 -1
- data/lib/bombbomb.rb +14 -30
- data/lib/bombbomb/api/prompts_api.rb +42 -833
- data/lib/bombbomb/api/teams_api.rb +157 -1331
- data/lib/bombbomb/api/utilities_api.rb +44 -23
- data/lib/bombbomb/api/webhooks_api.rb +43 -68
- data/lib/bombbomb/api_client.rb +45 -55
- data/lib/bombbomb/api_error.rb +18 -9
- data/lib/bombbomb/configuration.rb +13 -8
- data/lib/bombbomb/models/bb_web_hook.rb +17 -6
- data/lib/bombbomb/models/inline_response_200.rb +18 -7
- data/lib/bombbomb/models/inline_response_200_items.rb +1 -1
- data/lib/bombbomb/models/jericho_configuration.rb +22 -75
- data/lib/bombbomb/models/jericho_performance.rb +21 -50
- data/lib/bombbomb/models/o_auth_client.rb +17 -6
- data/lib/bombbomb/models/string.rb +17 -6
- data/lib/bombbomb/models/video_email_prompt.rb +90 -214
- data/lib/bombbomb/version.rb +14 -3
- data/spec/models/{team_public_representation_spec.rb → inline_response_200_items_spec.rb} +14 -8
- metadata +56 -168
- data/Gemfile +0 -7
- data/docs/AccountsApi.md +0 -384
- data/docs/AutomationsApi.md +0 -167
- data/docs/ClientGroupAssetMetaData.md +0 -11
- data/docs/ContactsApi.md +0 -436
- data/docs/Curriculum.md +0 -15
- data/docs/CurriculumApi.md +0 -109
- data/docs/CurriculumUserProgress.md +0 -12
- data/docs/CurriculumWithProgress.md +0 -15
- data/docs/EmailsApi.md +0 -633
- data/docs/FilesApi.md +0 -272
- data/docs/FormsApi.md +0 -60
- data/docs/HostedDoc.md +0 -13
- data/docs/IntegrationsApi.md +0 -285
- data/docs/ListsApi.md +0 -265
- data/docs/OrdersApi.md +0 -60
- data/docs/PromptBot.md +0 -22
- data/docs/PromptBotBot.md +0 -18
- data/docs/PromptMonthlyPerformance.md +0 -11
- data/docs/PromptOverview.md +0 -11
- data/docs/PromptSocialPrompt.md +0 -20
- data/docs/SignUploadRequest.md +0 -9
- data/docs/SignUploadResponse.md +0 -9
- data/docs/SocialsApi.md +0 -653
- data/docs/TeamPublicRepresentation.md +0 -10
- data/docs/UsersApi.md +0 -100
- data/docs/VideoEncodingStatusResponse.md +0 -10
- data/docs/VideoPublicRepresentation.md +0 -18
- data/docs/VideoRecorderMethodResponse.md +0 -15
- data/docs/VideosApi.md +0 -287
- data/lib/bombbomb/api/accounts_api.rb +0 -432
- data/lib/bombbomb/api/automations_api.rb +0 -191
- data/lib/bombbomb/api/contacts_api.rb +0 -470
- data/lib/bombbomb/api/curriculum_api.rb +0 -124
- data/lib/bombbomb/api/emails_api.rb +0 -673
- data/lib/bombbomb/api/files_api.rb +0 -302
- data/lib/bombbomb/api/forms_api.rb +0 -77
- data/lib/bombbomb/api/integrations_api.rb +0 -308
- data/lib/bombbomb/api/lists_api.rb +0 -295
- data/lib/bombbomb/api/orders_api.rb +0 -78
- data/lib/bombbomb/api/socials_api.rb +0 -714
- data/lib/bombbomb/api/users_api.rb +0 -119
- data/lib/bombbomb/api/videos_api.rb +0 -326
- data/lib/bombbomb/models/client_group_asset_meta_data.rb +0 -215
- data/lib/bombbomb/models/curriculum.rb +0 -261
- data/lib/bombbomb/models/curriculum_user_progress.rb +0 -229
- data/lib/bombbomb/models/curriculum_with_progress.rb +0 -261
- data/lib/bombbomb/models/hosted_doc.rb +0 -239
- data/lib/bombbomb/models/prompt_bot.rb +0 -329
- data/lib/bombbomb/models/prompt_bot_bot.rb +0 -300
- data/lib/bombbomb/models/prompt_monthly_performance.rb +0 -219
- data/lib/bombbomb/models/prompt_overview.rb +0 -219
- data/lib/bombbomb/models/prompt_social_prompt.rb +0 -311
- data/lib/bombbomb/models/sign_upload_request.rb +0 -199
- data/lib/bombbomb/models/sign_upload_response.rb +0 -199
- data/lib/bombbomb/models/team_public_representation.rb +0 -209
- data/lib/bombbomb/models/video_encoding_status_response.rb +0 -209
- data/lib/bombbomb/models/video_public_representation.rb +0 -291
- data/lib/bombbomb/models/video_recorder_method_response.rb +0 -259
- data/spec/api/accounts_api_spec.rb +0 -96
- data/spec/api/automations_api_spec.rb +0 -71
- data/spec/api/contacts_api_spec.rb +0 -58
- data/spec/api/curriculum_api_spec.rb +0 -69
- data/spec/api/emails_api_spec.rb +0 -104
- data/spec/api/files_api_spec.rb +0 -58
- data/spec/api/forms_api_spec.rb +0 -58
- data/spec/api/integrations_api_spec.rb +0 -58
- data/spec/api/lists_api_spec.rb +0 -83
- data/spec/api/orders_api_spec.rb +0 -58
- data/spec/api/socials_api_spec.rb +0 -135
- data/spec/api/users_api_spec.rb +0 -57
- data/spec/api/videos_api_spec.rb +0 -86
- data/spec/models/client_group_asset_meta_data_spec.rb +0 -60
- data/spec/models/curriculum_spec.rb +0 -95
- data/spec/models/curriculum_user_progress_spec.rb +0 -77
- data/spec/models/curriculum_with_progress_spec.rb +0 -95
- data/spec/models/hosted_doc_spec.rb +0 -83
- data/spec/models/prompt_bot_spec.rb +0 -137
- data/spec/models/prompt_monthly_performance_spec.rb +0 -60
- data/spec/models/prompt_overview_spec.rb +0 -60
- data/spec/models/prompt_social_prompt_spec.rb +0 -125
- data/spec/models/sign_upload_request_spec.rb +0 -59
- data/spec/models/sign_upload_response_spec.rb +0 -59
- data/spec/models/video_encoding_status_response_spec.rb +0 -65
- data/spec/models/video_public_representation_spec.rb +0 -113
- data/spec/models/video_recorder_method_response_spec.rb +0 -95
@@ -1,470 +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 ContactsApi
|
17
|
-
attr_accessor :api_client
|
18
|
-
|
19
|
-
def initialize(api_client = ApiClient.default)
|
20
|
-
@api_client = api_client
|
21
|
-
end
|
22
|
-
|
23
|
-
# Add contacts from a CSV file.
|
24
|
-
# Add multiple contacts through the upload importer from a CSV file.
|
25
|
-
# @param mapping_data The info sent for the contacts
|
26
|
-
# @param list_data The info sent with the import for the list
|
27
|
-
# @param [Hash] opts the optional parameters
|
28
|
-
# @return [nil]
|
29
|
-
def add_contacts_csv(mapping_data, list_data, opts = {})
|
30
|
-
add_contacts_csv_with_http_info(mapping_data, list_data, opts)
|
31
|
-
return nil
|
32
|
-
end
|
33
|
-
|
34
|
-
# Add contacts from a CSV file.
|
35
|
-
# Add multiple contacts through the upload importer from a CSV file.
|
36
|
-
# @param mapping_data The info sent for the contacts
|
37
|
-
# @param list_data The info sent with the import for the list
|
38
|
-
# @param [Hash] opts the optional parameters
|
39
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
40
|
-
def add_contacts_csv_with_http_info(mapping_data, list_data, opts = {})
|
41
|
-
if @api_client.config.debugging
|
42
|
-
@api_client.config.logger.debug "Calling API: ContactsApi.add_contacts_csv ..."
|
43
|
-
end
|
44
|
-
# verify the required parameter 'mapping_data' is set
|
45
|
-
if @api_client.config.client_side_validation && mapping_data.nil?
|
46
|
-
fail ArgumentError, "Missing the required parameter 'mapping_data' when calling ContactsApi.add_contacts_csv"
|
47
|
-
end
|
48
|
-
# verify the required parameter 'list_data' is set
|
49
|
-
if @api_client.config.client_side_validation && list_data.nil?
|
50
|
-
fail ArgumentError, "Missing the required parameter 'list_data' when calling ContactsApi.add_contacts_csv"
|
51
|
-
end
|
52
|
-
# resource path
|
53
|
-
local_var_path = "/contacts/import_csv"
|
54
|
-
|
55
|
-
# query parameters
|
56
|
-
query_params = {}
|
57
|
-
|
58
|
-
# header parameters
|
59
|
-
header_params = {}
|
60
|
-
# HTTP header 'Accept' (if needed)
|
61
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
62
|
-
# HTTP header 'Content-Type'
|
63
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
|
64
|
-
|
65
|
-
# form parameters
|
66
|
-
form_params = {}
|
67
|
-
form_params["mappingData"] = mapping_data
|
68
|
-
form_params["listData"] = list_data
|
69
|
-
|
70
|
-
# http body (model)
|
71
|
-
post_body = nil
|
72
|
-
auth_names = ['BBOAuth2']
|
73
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
74
|
-
:header_params => header_params,
|
75
|
-
:query_params => query_params,
|
76
|
-
:form_params => form_params,
|
77
|
-
:body => post_body,
|
78
|
-
:auth_names => auth_names)
|
79
|
-
if @api_client.config.debugging
|
80
|
-
@api_client.config.logger.debug "API called: ContactsApi#add_contacts_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
81
|
-
end
|
82
|
-
return data, status_code, headers
|
83
|
-
end
|
84
|
-
|
85
|
-
# Add a contact.
|
86
|
-
# Add a contact to the users list.
|
87
|
-
# @param contact_email Email of the new contact we are adding
|
88
|
-
# @param [Hash] opts the optional parameters
|
89
|
-
# @option opts [String] :contact_info The info sent for this contact
|
90
|
-
# @return [nil]
|
91
|
-
def add_new_contact(contact_email, opts = {})
|
92
|
-
add_new_contact_with_http_info(contact_email, opts)
|
93
|
-
return nil
|
94
|
-
end
|
95
|
-
|
96
|
-
# Add a contact.
|
97
|
-
# Add a contact to the users list.
|
98
|
-
# @param contact_email Email of the new contact we are adding
|
99
|
-
# @param [Hash] opts the optional parameters
|
100
|
-
# @option opts [String] :contact_info The info sent for this contact
|
101
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
102
|
-
def add_new_contact_with_http_info(contact_email, opts = {})
|
103
|
-
if @api_client.config.debugging
|
104
|
-
@api_client.config.logger.debug "Calling API: ContactsApi.add_new_contact ..."
|
105
|
-
end
|
106
|
-
# verify the required parameter 'contact_email' is set
|
107
|
-
if @api_client.config.client_side_validation && contact_email.nil?
|
108
|
-
fail ArgumentError, "Missing the required parameter 'contact_email' when calling ContactsApi.add_new_contact"
|
109
|
-
end
|
110
|
-
# resource path
|
111
|
-
local_var_path = "/contacts/"
|
112
|
-
|
113
|
-
# query parameters
|
114
|
-
query_params = {}
|
115
|
-
|
116
|
-
# header parameters
|
117
|
-
header_params = {}
|
118
|
-
# HTTP header 'Accept' (if needed)
|
119
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
120
|
-
# HTTP header 'Content-Type'
|
121
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
|
122
|
-
|
123
|
-
# form parameters
|
124
|
-
form_params = {}
|
125
|
-
form_params["contactEmail"] = contact_email
|
126
|
-
form_params["contactInfo"] = opts[:'contact_info'] if !opts[:'contact_info'].nil?
|
127
|
-
|
128
|
-
# http body (model)
|
129
|
-
post_body = nil
|
130
|
-
auth_names = ['BBOAuth2']
|
131
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
132
|
-
:header_params => header_params,
|
133
|
-
:query_params => query_params,
|
134
|
-
:form_params => form_params,
|
135
|
-
:body => post_body,
|
136
|
-
:auth_names => auth_names)
|
137
|
-
if @api_client.config.debugging
|
138
|
-
@api_client.config.logger.debug "API called: ContactsApi#add_new_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
139
|
-
end
|
140
|
-
return data, status_code, headers
|
141
|
-
end
|
142
|
-
|
143
|
-
# Add custom fields.
|
144
|
-
# Add a new custom field.
|
145
|
-
# @param field_name Custom field name to be added
|
146
|
-
# @param [Hash] opts the optional parameters
|
147
|
-
# @option opts [String] :field_type Custom field type for the field to be added
|
148
|
-
# @return [nil]
|
149
|
-
def add_new_custom_field(field_name, opts = {})
|
150
|
-
add_new_custom_field_with_http_info(field_name, opts)
|
151
|
-
return nil
|
152
|
-
end
|
153
|
-
|
154
|
-
# Add custom fields.
|
155
|
-
# Add a new custom field.
|
156
|
-
# @param field_name Custom field name to be added
|
157
|
-
# @param [Hash] opts the optional parameters
|
158
|
-
# @option opts [String] :field_type Custom field type for the field to be added
|
159
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
160
|
-
def add_new_custom_field_with_http_info(field_name, opts = {})
|
161
|
-
if @api_client.config.debugging
|
162
|
-
@api_client.config.logger.debug "Calling API: ContactsApi.add_new_custom_field ..."
|
163
|
-
end
|
164
|
-
# verify the required parameter 'field_name' is set
|
165
|
-
if @api_client.config.client_side_validation && field_name.nil?
|
166
|
-
fail ArgumentError, "Missing the required parameter 'field_name' when calling ContactsApi.add_new_custom_field"
|
167
|
-
end
|
168
|
-
# resource path
|
169
|
-
local_var_path = "/contacts/custom_fields/"
|
170
|
-
|
171
|
-
# query parameters
|
172
|
-
query_params = {}
|
173
|
-
|
174
|
-
# header parameters
|
175
|
-
header_params = {}
|
176
|
-
# HTTP header 'Accept' (if needed)
|
177
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
178
|
-
# HTTP header 'Content-Type'
|
179
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
|
180
|
-
|
181
|
-
# form parameters
|
182
|
-
form_params = {}
|
183
|
-
form_params["fieldName"] = field_name
|
184
|
-
form_params["fieldType"] = opts[:'field_type'] if !opts[:'field_type'].nil?
|
185
|
-
|
186
|
-
# http body (model)
|
187
|
-
post_body = nil
|
188
|
-
auth_names = ['BBOAuth2']
|
189
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
190
|
-
:header_params => header_params,
|
191
|
-
:query_params => query_params,
|
192
|
-
:form_params => form_params,
|
193
|
-
:body => post_body,
|
194
|
-
:auth_names => auth_names)
|
195
|
-
if @api_client.config.debugging
|
196
|
-
@api_client.config.logger.debug "API called: ContactsApi#add_new_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
197
|
-
end
|
198
|
-
return data, status_code, headers
|
199
|
-
end
|
200
|
-
|
201
|
-
# Add pasted contacts.
|
202
|
-
# Add the pasted contacts to the users list.
|
203
|
-
# @param contact_emails Emails array of the new contacts we are adding
|
204
|
-
# @param [Hash] opts the optional parameters
|
205
|
-
# @option opts [String] :list_info Information about the lists id, recalculations on totals, consent etc
|
206
|
-
# @return [nil]
|
207
|
-
def add_pasted_contacts(contact_emails, opts = {})
|
208
|
-
add_pasted_contacts_with_http_info(contact_emails, opts)
|
209
|
-
return nil
|
210
|
-
end
|
211
|
-
|
212
|
-
# Add pasted contacts.
|
213
|
-
# Add the pasted contacts to the users list.
|
214
|
-
# @param contact_emails Emails array of the new contacts we are adding
|
215
|
-
# @param [Hash] opts the optional parameters
|
216
|
-
# @option opts [String] :list_info Information about the lists id, recalculations on totals, consent etc
|
217
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
218
|
-
def add_pasted_contacts_with_http_info(contact_emails, opts = {})
|
219
|
-
if @api_client.config.debugging
|
220
|
-
@api_client.config.logger.debug "Calling API: ContactsApi.add_pasted_contacts ..."
|
221
|
-
end
|
222
|
-
# verify the required parameter 'contact_emails' is set
|
223
|
-
if @api_client.config.client_side_validation && contact_emails.nil?
|
224
|
-
fail ArgumentError, "Missing the required parameter 'contact_emails' when calling ContactsApi.add_pasted_contacts"
|
225
|
-
end
|
226
|
-
# resource path
|
227
|
-
local_var_path = "/contacts/paste"
|
228
|
-
|
229
|
-
# query parameters
|
230
|
-
query_params = {}
|
231
|
-
|
232
|
-
# header parameters
|
233
|
-
header_params = {}
|
234
|
-
# HTTP header 'Accept' (if needed)
|
235
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
236
|
-
# HTTP header 'Content-Type'
|
237
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
|
238
|
-
|
239
|
-
# form parameters
|
240
|
-
form_params = {}
|
241
|
-
form_params["contactEmails"] = contact_emails
|
242
|
-
form_params["listInfo"] = opts[:'list_info'] if !opts[:'list_info'].nil?
|
243
|
-
|
244
|
-
# http body (model)
|
245
|
-
post_body = nil
|
246
|
-
auth_names = ['BBOAuth2']
|
247
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
248
|
-
:header_params => header_params,
|
249
|
-
:query_params => query_params,
|
250
|
-
:form_params => form_params,
|
251
|
-
:body => post_body,
|
252
|
-
:auth_names => auth_names)
|
253
|
-
if @api_client.config.debugging
|
254
|
-
@api_client.config.logger.debug "API called: ContactsApi#add_pasted_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
255
|
-
end
|
256
|
-
return data, status_code, headers
|
257
|
-
end
|
258
|
-
|
259
|
-
# Format CSV.
|
260
|
-
# Format a CSV file to an object.
|
261
|
-
# @param file The CSV file being uploaded
|
262
|
-
# @param [Hash] opts the optional parameters
|
263
|
-
# @return [nil]
|
264
|
-
def c_sv_to_object(file, opts = {})
|
265
|
-
c_sv_to_object_with_http_info(file, opts)
|
266
|
-
return nil
|
267
|
-
end
|
268
|
-
|
269
|
-
# Format CSV.
|
270
|
-
# Format a CSV file to an object.
|
271
|
-
# @param file The CSV file being uploaded
|
272
|
-
# @param [Hash] opts the optional parameters
|
273
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
274
|
-
def c_sv_to_object_with_http_info(file, opts = {})
|
275
|
-
if @api_client.config.debugging
|
276
|
-
@api_client.config.logger.debug "Calling API: ContactsApi.c_sv_to_object ..."
|
277
|
-
end
|
278
|
-
# verify the required parameter 'file' is set
|
279
|
-
if @api_client.config.client_side_validation && file.nil?
|
280
|
-
fail ArgumentError, "Missing the required parameter 'file' when calling ContactsApi.c_sv_to_object"
|
281
|
-
end
|
282
|
-
# resource path
|
283
|
-
local_var_path = "/csv-to-object"
|
284
|
-
|
285
|
-
# query parameters
|
286
|
-
query_params = {}
|
287
|
-
|
288
|
-
# header parameters
|
289
|
-
header_params = {}
|
290
|
-
# HTTP header 'Accept' (if needed)
|
291
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
292
|
-
# HTTP header 'Content-Type'
|
293
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
|
294
|
-
|
295
|
-
# form parameters
|
296
|
-
form_params = {}
|
297
|
-
form_params["file"] = file
|
298
|
-
|
299
|
-
# http body (model)
|
300
|
-
post_body = nil
|
301
|
-
auth_names = ['BBOAuth2']
|
302
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
303
|
-
:header_params => header_params,
|
304
|
-
:query_params => query_params,
|
305
|
-
:form_params => form_params,
|
306
|
-
:body => post_body,
|
307
|
-
:auth_names => auth_names)
|
308
|
-
if @api_client.config.debugging
|
309
|
-
@api_client.config.logger.debug "API called: ContactsApi#c_sv_to_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
310
|
-
end
|
311
|
-
return data, status_code, headers
|
312
|
-
end
|
313
|
-
|
314
|
-
# Delete Contacts
|
315
|
-
# Delete all contacts within a list, or provide a comma separated list of contactIds to delete.
|
316
|
-
# @param [Hash] opts the optional parameters
|
317
|
-
# @option opts [String] :list_id The list of contacts to be deleted.
|
318
|
-
# @option opts [String] :contact_ids comma separated list of contact ids to delete
|
319
|
-
# @return [nil]
|
320
|
-
def delete_contacts(opts = {})
|
321
|
-
delete_contacts_with_http_info(opts)
|
322
|
-
return nil
|
323
|
-
end
|
324
|
-
|
325
|
-
# Delete Contacts
|
326
|
-
# Delete all contacts within a list, or provide a comma separated list of contactIds to delete.
|
327
|
-
# @param [Hash] opts the optional parameters
|
328
|
-
# @option opts [String] :list_id The list of contacts to be deleted.
|
329
|
-
# @option opts [String] :contact_ids comma separated list of contact ids to delete
|
330
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
331
|
-
def delete_contacts_with_http_info(opts = {})
|
332
|
-
if @api_client.config.debugging
|
333
|
-
@api_client.config.logger.debug "Calling API: ContactsApi.delete_contacts ..."
|
334
|
-
end
|
335
|
-
# resource path
|
336
|
-
local_var_path = "/contacts/delete"
|
337
|
-
|
338
|
-
# query parameters
|
339
|
-
query_params = {}
|
340
|
-
|
341
|
-
# header parameters
|
342
|
-
header_params = {}
|
343
|
-
# HTTP header 'Accept' (if needed)
|
344
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
345
|
-
# HTTP header 'Content-Type'
|
346
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
|
347
|
-
|
348
|
-
# form parameters
|
349
|
-
form_params = {}
|
350
|
-
form_params["listId"] = opts[:'list_id'] if !opts[:'list_id'].nil?
|
351
|
-
form_params["contactIds"] = opts[:'contact_ids'] if !opts[:'contact_ids'].nil?
|
352
|
-
|
353
|
-
# http body (model)
|
354
|
-
post_body = nil
|
355
|
-
auth_names = ['BBOAuth2']
|
356
|
-
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
357
|
-
:header_params => header_params,
|
358
|
-
:query_params => query_params,
|
359
|
-
:form_params => form_params,
|
360
|
-
:body => post_body,
|
361
|
-
:auth_names => auth_names)
|
362
|
-
if @api_client.config.debugging
|
363
|
-
@api_client.config.logger.debug "API called: ContactsApi#delete_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
364
|
-
end
|
365
|
-
return data, status_code, headers
|
366
|
-
end
|
367
|
-
|
368
|
-
# Get Contact Details
|
369
|
-
# Get the contact details
|
370
|
-
# @param id Guid for the contact.
|
371
|
-
# @param [Hash] opts the optional parameters
|
372
|
-
# @return [nil]
|
373
|
-
def get_contact_by_id(id, opts = {})
|
374
|
-
get_contact_by_id_with_http_info(id, opts)
|
375
|
-
return nil
|
376
|
-
end
|
377
|
-
|
378
|
-
# Get Contact Details
|
379
|
-
# Get the contact details
|
380
|
-
# @param id Guid for the contact.
|
381
|
-
# @param [Hash] opts the optional parameters
|
382
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
383
|
-
def get_contact_by_id_with_http_info(id, opts = {})
|
384
|
-
if @api_client.config.debugging
|
385
|
-
@api_client.config.logger.debug "Calling API: ContactsApi.get_contact_by_id ..."
|
386
|
-
end
|
387
|
-
# verify the required parameter 'id' is set
|
388
|
-
if @api_client.config.client_side_validation && id.nil?
|
389
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling ContactsApi.get_contact_by_id"
|
390
|
-
end
|
391
|
-
# resource path
|
392
|
-
local_var_path = "/contact/{id}".sub('{' + 'id' + '}', id.to_s)
|
393
|
-
|
394
|
-
# query parameters
|
395
|
-
query_params = {}
|
396
|
-
|
397
|
-
# header parameters
|
398
|
-
header_params = {}
|
399
|
-
# HTTP header 'Accept' (if needed)
|
400
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
401
|
-
# HTTP header 'Content-Type'
|
402
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
|
403
|
-
|
404
|
-
# form parameters
|
405
|
-
form_params = {}
|
406
|
-
|
407
|
-
# http body (model)
|
408
|
-
post_body = nil
|
409
|
-
auth_names = ['BBOAuth2']
|
410
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
411
|
-
:header_params => header_params,
|
412
|
-
:query_params => query_params,
|
413
|
-
:form_params => form_params,
|
414
|
-
:body => post_body,
|
415
|
-
:auth_names => auth_names)
|
416
|
-
if @api_client.config.debugging
|
417
|
-
@api_client.config.logger.debug "API called: ContactsApi#get_contact_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
418
|
-
end
|
419
|
-
return data, status_code, headers
|
420
|
-
end
|
421
|
-
|
422
|
-
# Get custom fields.
|
423
|
-
# Get the current users custom fields.
|
424
|
-
# @param [Hash] opts the optional parameters
|
425
|
-
# @return [nil]
|
426
|
-
def get_custom_fields(opts = {})
|
427
|
-
get_custom_fields_with_http_info(opts)
|
428
|
-
return nil
|
429
|
-
end
|
430
|
-
|
431
|
-
# Get custom fields.
|
432
|
-
# Get the current users custom fields.
|
433
|
-
# @param [Hash] opts the optional parameters
|
434
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
435
|
-
def get_custom_fields_with_http_info(opts = {})
|
436
|
-
if @api_client.config.debugging
|
437
|
-
@api_client.config.logger.debug "Calling API: ContactsApi.get_custom_fields ..."
|
438
|
-
end
|
439
|
-
# resource path
|
440
|
-
local_var_path = "/contacts/custom_fields/"
|
441
|
-
|
442
|
-
# query parameters
|
443
|
-
query_params = {}
|
444
|
-
|
445
|
-
# header parameters
|
446
|
-
header_params = {}
|
447
|
-
# HTTP header 'Accept' (if needed)
|
448
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
449
|
-
# HTTP header 'Content-Type'
|
450
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
|
451
|
-
|
452
|
-
# form parameters
|
453
|
-
form_params = {}
|
454
|
-
|
455
|
-
# http body (model)
|
456
|
-
post_body = nil
|
457
|
-
auth_names = ['BBOAuth2']
|
458
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
459
|
-
:header_params => header_params,
|
460
|
-
:query_params => query_params,
|
461
|
-
:form_params => form_params,
|
462
|
-
:body => post_body,
|
463
|
-
:auth_names => auth_names)
|
464
|
-
if @api_client.config.debugging
|
465
|
-
@api_client.config.logger.debug "API called: ContactsApi#get_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
466
|
-
end
|
467
|
-
return data, status_code, headers
|
468
|
-
end
|
469
|
-
end
|
470
|
-
end
|