late-sdk 0.0.67 → 0.0.69
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +63 -0
- data/docs/AddBroadcastRecipientsRequest.md +20 -0
- data/docs/BroadcastsApi.md +699 -0
- data/docs/BulkCreateContactsRequest.md +24 -0
- data/docs/BulkCreateContactsRequestContactsInner.md +28 -0
- data/docs/CommentAutomationsApi.md +428 -0
- data/docs/ContactsApi.md +500 -0
- data/docs/CreateBroadcastRequest.md +32 -0
- data/docs/CreateBroadcastRequestMessage.md +20 -0
- data/docs/CreateBroadcastRequestMessageAttachmentsInner.md +22 -0
- data/docs/CreateBroadcastRequestSegmentFilters.md +20 -0
- data/docs/CreateBroadcastRequestTemplate.md +22 -0
- data/docs/CreateCommentAutomationRequest.md +36 -0
- data/docs/CreateContactRequest.md +38 -0
- data/docs/CreateCustomFieldRequest.md +26 -0
- data/docs/CreateSequenceRequest.md +32 -0
- data/docs/CreateSequenceRequestStepsInner.md +24 -0
- data/docs/CreateSequenceRequestStepsInnerMessage.md +18 -0
- data/docs/CustomFieldsApi.md +419 -0
- data/docs/EnrollContactsRequest.md +20 -0
- data/docs/ListCommentAutomations200Response.md +20 -0
- data/docs/ListCommentAutomations200ResponseAutomationsInner.md +42 -0
- data/docs/ListCommentAutomations200ResponseAutomationsInnerStats.md +24 -0
- data/docs/ScheduleBroadcastRequest.md +18 -0
- data/docs/SequencesApi.md +697 -0
- data/docs/SetContactFieldValueRequest.md +18 -0
- data/docs/TwitterPlatformData.md +3 -1
- data/docs/TwitterPlatformDataPoll.md +20 -0
- data/docs/UpdateCommentAutomationRequest.md +28 -0
- data/docs/UpdateContactRequest.md +32 -0
- data/docs/UpdateCustomFieldRequest.md +20 -0
- data/docs/WhatsAppApi.md +25 -25
- data/lib/late-sdk/api/broadcasts_api.rb +689 -0
- data/lib/late-sdk/api/comment_automations_api.rb +420 -0
- data/lib/late-sdk/api/contacts_api.rb +503 -0
- data/lib/late-sdk/api/custom_fields_api.rb +424 -0
- data/lib/late-sdk/api/sequences_api.rb +681 -0
- data/lib/late-sdk/api/whats_app_api.rb +50 -50
- data/lib/late-sdk/models/add_broadcast_recipients_request.rb +160 -0
- data/lib/late-sdk/models/bulk_create_contacts_request.rb +253 -0
- data/lib/late-sdk/models/bulk_create_contacts_request_contacts_inner.rb +228 -0
- data/lib/late-sdk/models/create_broadcast_request.rb +302 -0
- data/lib/late-sdk/models/create_broadcast_request_message.rb +158 -0
- data/lib/late-sdk/models/create_broadcast_request_message_attachments_inner.rb +165 -0
- data/lib/late-sdk/models/create_broadcast_request_segment_filters.rb +158 -0
- data/lib/late-sdk/models/create_broadcast_request_template.rb +168 -0
- data/lib/late-sdk/models/create_comment_automation_request.rb +359 -0
- data/lib/late-sdk/models/create_contact_request.rb +276 -0
- data/lib/late-sdk/models/create_custom_field_request.rb +262 -0
- data/lib/late-sdk/models/create_sequence_request.rb +308 -0
- data/lib/late-sdk/models/create_sequence_request_steps_inner.rb +208 -0
- data/lib/late-sdk/models/create_sequence_request_steps_inner_message.rb +147 -0
- data/lib/late-sdk/models/enroll_contacts_request.rb +178 -0
- data/lib/late-sdk/models/list_comment_automations200_response.rb +158 -0
- data/lib/late-sdk/models/list_comment_automations200_response_automations_inner.rb +303 -0
- data/lib/late-sdk/models/list_comment_automations200_response_automations_inner_stats.rb +174 -0
- data/lib/late-sdk/models/schedule_broadcast_request.rb +164 -0
- data/lib/late-sdk/models/set_contact_field_value_request.rb +150 -0
- data/lib/late-sdk/models/twitter_platform_data.rb +13 -4
- data/lib/late-sdk/models/twitter_platform_data_poll.rb +231 -0
- data/lib/late-sdk/models/update_comment_automation_request.rb +228 -0
- data/lib/late-sdk/models/update_contact_request.rb +212 -0
- data/lib/late-sdk/models/update_custom_field_request.rb +158 -0
- data/lib/late-sdk/version.rb +1 -1
- data/lib/late-sdk.rb +29 -0
- data/openapi.yaml +830 -13
- data/spec/api/broadcasts_api_spec.rb +154 -0
- data/spec/api/comment_automations_api_spec.rb +108 -0
- data/spec/api/contacts_api_spec.rb +122 -0
- data/spec/api/custom_fields_api_spec.rb +105 -0
- data/spec/api/sequences_api_spec.rb +153 -0
- data/spec/api/whats_app_api_spec.rb +25 -25
- data/spec/models/add_broadcast_recipients_request_spec.rb +42 -0
- data/spec/models/bulk_create_contacts_request_contacts_inner_spec.rb +66 -0
- data/spec/models/bulk_create_contacts_request_spec.rb +54 -0
- data/spec/models/create_broadcast_request_message_attachments_inner_spec.rb +48 -0
- data/spec/models/create_broadcast_request_message_spec.rb +42 -0
- data/spec/models/create_broadcast_request_segment_filters_spec.rb +42 -0
- data/spec/models/create_broadcast_request_spec.rb +82 -0
- data/spec/models/create_broadcast_request_template_spec.rb +48 -0
- data/spec/models/create_comment_automation_request_spec.rb +94 -0
- data/spec/models/create_contact_request_spec.rb +96 -0
- data/spec/models/create_custom_field_request_spec.rb +64 -0
- data/spec/models/create_sequence_request_spec.rb +82 -0
- data/spec/models/create_sequence_request_steps_inner_message_spec.rb +36 -0
- data/spec/models/create_sequence_request_steps_inner_spec.rb +54 -0
- data/spec/models/enroll_contacts_request_spec.rb +42 -0
- data/spec/models/list_comment_automations200_response_automations_inner_spec.rb +116 -0
- data/spec/models/list_comment_automations200_response_automations_inner_stats_spec.rb +54 -0
- data/spec/models/list_comment_automations200_response_spec.rb +42 -0
- data/spec/models/schedule_broadcast_request_spec.rb +36 -0
- data/spec/models/set_contact_field_value_request_spec.rb +36 -0
- data/spec/models/twitter_platform_data_poll_spec.rb +42 -0
- data/spec/models/twitter_platform_data_spec.rb +6 -0
- data/spec/models/update_comment_automation_request_spec.rb +70 -0
- data/spec/models/update_contact_request_spec.rb +78 -0
- data/spec/models/update_custom_field_request_spec.rb +42 -0
- data/zernio-sdk-0.0.69.gem +0 -0
- metadata +118 -2
- data/zernio-sdk-0.0.67.gem +0 -0
|
@@ -0,0 +1,689 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zernio API
|
|
3
|
+
|
|
4
|
+
#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.1
|
|
7
|
+
Contact: support@zernio.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.19.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'cgi'
|
|
14
|
+
|
|
15
|
+
module Late
|
|
16
|
+
class BroadcastsApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Add recipients to a broadcast
|
|
23
|
+
# @param broadcast_id [String]
|
|
24
|
+
# @param add_broadcast_recipients_request [AddBroadcastRecipientsRequest]
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [nil]
|
|
27
|
+
def add_broadcast_recipients(broadcast_id, add_broadcast_recipients_request, opts = {})
|
|
28
|
+
add_broadcast_recipients_with_http_info(broadcast_id, add_broadcast_recipients_request, opts)
|
|
29
|
+
nil
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Add recipients to a broadcast
|
|
33
|
+
# @param broadcast_id [String]
|
|
34
|
+
# @param add_broadcast_recipients_request [AddBroadcastRecipientsRequest]
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
37
|
+
def add_broadcast_recipients_with_http_info(broadcast_id, add_broadcast_recipients_request, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: BroadcastsApi.add_broadcast_recipients ...'
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'broadcast_id' is set
|
|
42
|
+
if @api_client.config.client_side_validation && broadcast_id.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.add_broadcast_recipients"
|
|
44
|
+
end
|
|
45
|
+
# verify the required parameter 'add_broadcast_recipients_request' is set
|
|
46
|
+
if @api_client.config.client_side_validation && add_broadcast_recipients_request.nil?
|
|
47
|
+
fail ArgumentError, "Missing the required parameter 'add_broadcast_recipients_request' when calling BroadcastsApi.add_broadcast_recipients"
|
|
48
|
+
end
|
|
49
|
+
# resource path
|
|
50
|
+
local_var_path = '/v1/broadcasts/{broadcastId}/recipients'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_id.to_s))
|
|
51
|
+
|
|
52
|
+
# query parameters
|
|
53
|
+
query_params = opts[:query_params] || {}
|
|
54
|
+
|
|
55
|
+
# header parameters
|
|
56
|
+
header_params = opts[:header_params] || {}
|
|
57
|
+
# HTTP header 'Accept' (if needed)
|
|
58
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
59
|
+
# HTTP header 'Content-Type'
|
|
60
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
61
|
+
if !content_type.nil?
|
|
62
|
+
header_params['Content-Type'] = content_type
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
# form parameters
|
|
66
|
+
form_params = opts[:form_params] || {}
|
|
67
|
+
|
|
68
|
+
# http body (model)
|
|
69
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(add_broadcast_recipients_request)
|
|
70
|
+
|
|
71
|
+
# return_type
|
|
72
|
+
return_type = opts[:debug_return_type]
|
|
73
|
+
|
|
74
|
+
# auth_names
|
|
75
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
76
|
+
|
|
77
|
+
new_options = opts.merge(
|
|
78
|
+
:operation => :"BroadcastsApi.add_broadcast_recipients",
|
|
79
|
+
:header_params => header_params,
|
|
80
|
+
:query_params => query_params,
|
|
81
|
+
:form_params => form_params,
|
|
82
|
+
:body => post_body,
|
|
83
|
+
:auth_names => auth_names,
|
|
84
|
+
:return_type => return_type
|
|
85
|
+
)
|
|
86
|
+
|
|
87
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
88
|
+
if @api_client.config.debugging
|
|
89
|
+
@api_client.config.logger.debug "API called: BroadcastsApi#add_broadcast_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
90
|
+
end
|
|
91
|
+
return data, status_code, headers
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# Cancel a broadcast
|
|
95
|
+
# @param broadcast_id [String]
|
|
96
|
+
# @param [Hash] opts the optional parameters
|
|
97
|
+
# @return [nil]
|
|
98
|
+
def cancel_broadcast(broadcast_id, opts = {})
|
|
99
|
+
cancel_broadcast_with_http_info(broadcast_id, opts)
|
|
100
|
+
nil
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# Cancel a broadcast
|
|
104
|
+
# @param broadcast_id [String]
|
|
105
|
+
# @param [Hash] opts the optional parameters
|
|
106
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
107
|
+
def cancel_broadcast_with_http_info(broadcast_id, opts = {})
|
|
108
|
+
if @api_client.config.debugging
|
|
109
|
+
@api_client.config.logger.debug 'Calling API: BroadcastsApi.cancel_broadcast ...'
|
|
110
|
+
end
|
|
111
|
+
# verify the required parameter 'broadcast_id' is set
|
|
112
|
+
if @api_client.config.client_side_validation && broadcast_id.nil?
|
|
113
|
+
fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.cancel_broadcast"
|
|
114
|
+
end
|
|
115
|
+
# resource path
|
|
116
|
+
local_var_path = '/v1/broadcasts/{broadcastId}/cancel'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_id.to_s))
|
|
117
|
+
|
|
118
|
+
# query parameters
|
|
119
|
+
query_params = opts[:query_params] || {}
|
|
120
|
+
|
|
121
|
+
# header parameters
|
|
122
|
+
header_params = opts[:header_params] || {}
|
|
123
|
+
# HTTP header 'Accept' (if needed)
|
|
124
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
125
|
+
|
|
126
|
+
# form parameters
|
|
127
|
+
form_params = opts[:form_params] || {}
|
|
128
|
+
|
|
129
|
+
# http body (model)
|
|
130
|
+
post_body = opts[:debug_body]
|
|
131
|
+
|
|
132
|
+
# return_type
|
|
133
|
+
return_type = opts[:debug_return_type]
|
|
134
|
+
|
|
135
|
+
# auth_names
|
|
136
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
137
|
+
|
|
138
|
+
new_options = opts.merge(
|
|
139
|
+
:operation => :"BroadcastsApi.cancel_broadcast",
|
|
140
|
+
:header_params => header_params,
|
|
141
|
+
:query_params => query_params,
|
|
142
|
+
:form_params => form_params,
|
|
143
|
+
:body => post_body,
|
|
144
|
+
:auth_names => auth_names,
|
|
145
|
+
:return_type => return_type
|
|
146
|
+
)
|
|
147
|
+
|
|
148
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
149
|
+
if @api_client.config.debugging
|
|
150
|
+
@api_client.config.logger.debug "API called: BroadcastsApi#cancel_broadcast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
151
|
+
end
|
|
152
|
+
return data, status_code, headers
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
# Create a broadcast draft
|
|
156
|
+
# @param create_broadcast_request [CreateBroadcastRequest]
|
|
157
|
+
# @param [Hash] opts the optional parameters
|
|
158
|
+
# @return [nil]
|
|
159
|
+
def create_broadcast(create_broadcast_request, opts = {})
|
|
160
|
+
create_broadcast_with_http_info(create_broadcast_request, opts)
|
|
161
|
+
nil
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# Create a broadcast draft
|
|
165
|
+
# @param create_broadcast_request [CreateBroadcastRequest]
|
|
166
|
+
# @param [Hash] opts the optional parameters
|
|
167
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
168
|
+
def create_broadcast_with_http_info(create_broadcast_request, opts = {})
|
|
169
|
+
if @api_client.config.debugging
|
|
170
|
+
@api_client.config.logger.debug 'Calling API: BroadcastsApi.create_broadcast ...'
|
|
171
|
+
end
|
|
172
|
+
# verify the required parameter 'create_broadcast_request' is set
|
|
173
|
+
if @api_client.config.client_side_validation && create_broadcast_request.nil?
|
|
174
|
+
fail ArgumentError, "Missing the required parameter 'create_broadcast_request' when calling BroadcastsApi.create_broadcast"
|
|
175
|
+
end
|
|
176
|
+
# resource path
|
|
177
|
+
local_var_path = '/v1/broadcasts'
|
|
178
|
+
|
|
179
|
+
# query parameters
|
|
180
|
+
query_params = opts[:query_params] || {}
|
|
181
|
+
|
|
182
|
+
# header parameters
|
|
183
|
+
header_params = opts[:header_params] || {}
|
|
184
|
+
# HTTP header 'Accept' (if needed)
|
|
185
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
186
|
+
# HTTP header 'Content-Type'
|
|
187
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
188
|
+
if !content_type.nil?
|
|
189
|
+
header_params['Content-Type'] = content_type
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
# form parameters
|
|
193
|
+
form_params = opts[:form_params] || {}
|
|
194
|
+
|
|
195
|
+
# http body (model)
|
|
196
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_broadcast_request)
|
|
197
|
+
|
|
198
|
+
# return_type
|
|
199
|
+
return_type = opts[:debug_return_type]
|
|
200
|
+
|
|
201
|
+
# auth_names
|
|
202
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
203
|
+
|
|
204
|
+
new_options = opts.merge(
|
|
205
|
+
:operation => :"BroadcastsApi.create_broadcast",
|
|
206
|
+
:header_params => header_params,
|
|
207
|
+
:query_params => query_params,
|
|
208
|
+
:form_params => form_params,
|
|
209
|
+
:body => post_body,
|
|
210
|
+
:auth_names => auth_names,
|
|
211
|
+
:return_type => return_type
|
|
212
|
+
)
|
|
213
|
+
|
|
214
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
215
|
+
if @api_client.config.debugging
|
|
216
|
+
@api_client.config.logger.debug "API called: BroadcastsApi#create_broadcast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
217
|
+
end
|
|
218
|
+
return data, status_code, headers
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
# Delete a broadcast (draft only)
|
|
222
|
+
# @param broadcast_id [String]
|
|
223
|
+
# @param [Hash] opts the optional parameters
|
|
224
|
+
# @return [nil]
|
|
225
|
+
def delete_broadcast(broadcast_id, opts = {})
|
|
226
|
+
delete_broadcast_with_http_info(broadcast_id, opts)
|
|
227
|
+
nil
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
# Delete a broadcast (draft only)
|
|
231
|
+
# @param broadcast_id [String]
|
|
232
|
+
# @param [Hash] opts the optional parameters
|
|
233
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
234
|
+
def delete_broadcast_with_http_info(broadcast_id, opts = {})
|
|
235
|
+
if @api_client.config.debugging
|
|
236
|
+
@api_client.config.logger.debug 'Calling API: BroadcastsApi.delete_broadcast ...'
|
|
237
|
+
end
|
|
238
|
+
# verify the required parameter 'broadcast_id' is set
|
|
239
|
+
if @api_client.config.client_side_validation && broadcast_id.nil?
|
|
240
|
+
fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.delete_broadcast"
|
|
241
|
+
end
|
|
242
|
+
# resource path
|
|
243
|
+
local_var_path = '/v1/broadcasts/{broadcastId}'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_id.to_s))
|
|
244
|
+
|
|
245
|
+
# query parameters
|
|
246
|
+
query_params = opts[:query_params] || {}
|
|
247
|
+
|
|
248
|
+
# header parameters
|
|
249
|
+
header_params = opts[:header_params] || {}
|
|
250
|
+
# HTTP header 'Accept' (if needed)
|
|
251
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
252
|
+
|
|
253
|
+
# form parameters
|
|
254
|
+
form_params = opts[:form_params] || {}
|
|
255
|
+
|
|
256
|
+
# http body (model)
|
|
257
|
+
post_body = opts[:debug_body]
|
|
258
|
+
|
|
259
|
+
# return_type
|
|
260
|
+
return_type = opts[:debug_return_type]
|
|
261
|
+
|
|
262
|
+
# auth_names
|
|
263
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
264
|
+
|
|
265
|
+
new_options = opts.merge(
|
|
266
|
+
:operation => :"BroadcastsApi.delete_broadcast",
|
|
267
|
+
:header_params => header_params,
|
|
268
|
+
:query_params => query_params,
|
|
269
|
+
:form_params => form_params,
|
|
270
|
+
:body => post_body,
|
|
271
|
+
:auth_names => auth_names,
|
|
272
|
+
:return_type => return_type
|
|
273
|
+
)
|
|
274
|
+
|
|
275
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
276
|
+
if @api_client.config.debugging
|
|
277
|
+
@api_client.config.logger.debug "API called: BroadcastsApi#delete_broadcast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
278
|
+
end
|
|
279
|
+
return data, status_code, headers
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
# Get broadcast details
|
|
283
|
+
# @param broadcast_id [String]
|
|
284
|
+
# @param [Hash] opts the optional parameters
|
|
285
|
+
# @return [nil]
|
|
286
|
+
def get_broadcast(broadcast_id, opts = {})
|
|
287
|
+
get_broadcast_with_http_info(broadcast_id, opts)
|
|
288
|
+
nil
|
|
289
|
+
end
|
|
290
|
+
|
|
291
|
+
# Get broadcast details
|
|
292
|
+
# @param broadcast_id [String]
|
|
293
|
+
# @param [Hash] opts the optional parameters
|
|
294
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
295
|
+
def get_broadcast_with_http_info(broadcast_id, opts = {})
|
|
296
|
+
if @api_client.config.debugging
|
|
297
|
+
@api_client.config.logger.debug 'Calling API: BroadcastsApi.get_broadcast ...'
|
|
298
|
+
end
|
|
299
|
+
# verify the required parameter 'broadcast_id' is set
|
|
300
|
+
if @api_client.config.client_side_validation && broadcast_id.nil?
|
|
301
|
+
fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.get_broadcast"
|
|
302
|
+
end
|
|
303
|
+
# resource path
|
|
304
|
+
local_var_path = '/v1/broadcasts/{broadcastId}'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_id.to_s))
|
|
305
|
+
|
|
306
|
+
# query parameters
|
|
307
|
+
query_params = opts[:query_params] || {}
|
|
308
|
+
|
|
309
|
+
# header parameters
|
|
310
|
+
header_params = opts[:header_params] || {}
|
|
311
|
+
# HTTP header 'Accept' (if needed)
|
|
312
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
313
|
+
|
|
314
|
+
# form parameters
|
|
315
|
+
form_params = opts[:form_params] || {}
|
|
316
|
+
|
|
317
|
+
# http body (model)
|
|
318
|
+
post_body = opts[:debug_body]
|
|
319
|
+
|
|
320
|
+
# return_type
|
|
321
|
+
return_type = opts[:debug_return_type]
|
|
322
|
+
|
|
323
|
+
# auth_names
|
|
324
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
325
|
+
|
|
326
|
+
new_options = opts.merge(
|
|
327
|
+
:operation => :"BroadcastsApi.get_broadcast",
|
|
328
|
+
:header_params => header_params,
|
|
329
|
+
:query_params => query_params,
|
|
330
|
+
:form_params => form_params,
|
|
331
|
+
:body => post_body,
|
|
332
|
+
:auth_names => auth_names,
|
|
333
|
+
:return_type => return_type
|
|
334
|
+
)
|
|
335
|
+
|
|
336
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
337
|
+
if @api_client.config.debugging
|
|
338
|
+
@api_client.config.logger.debug "API called: BroadcastsApi#get_broadcast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
339
|
+
end
|
|
340
|
+
return data, status_code, headers
|
|
341
|
+
end
|
|
342
|
+
|
|
343
|
+
# List broadcast recipients
|
|
344
|
+
# @param broadcast_id [String]
|
|
345
|
+
# @param [Hash] opts the optional parameters
|
|
346
|
+
# @option opts [String] :status
|
|
347
|
+
# @option opts [Integer] :limit (default to 50)
|
|
348
|
+
# @option opts [Integer] :skip (default to 0)
|
|
349
|
+
# @return [nil]
|
|
350
|
+
def list_broadcast_recipients(broadcast_id, opts = {})
|
|
351
|
+
list_broadcast_recipients_with_http_info(broadcast_id, opts)
|
|
352
|
+
nil
|
|
353
|
+
end
|
|
354
|
+
|
|
355
|
+
# List broadcast recipients
|
|
356
|
+
# @param broadcast_id [String]
|
|
357
|
+
# @param [Hash] opts the optional parameters
|
|
358
|
+
# @option opts [String] :status
|
|
359
|
+
# @option opts [Integer] :limit (default to 50)
|
|
360
|
+
# @option opts [Integer] :skip (default to 0)
|
|
361
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
362
|
+
def list_broadcast_recipients_with_http_info(broadcast_id, opts = {})
|
|
363
|
+
if @api_client.config.debugging
|
|
364
|
+
@api_client.config.logger.debug 'Calling API: BroadcastsApi.list_broadcast_recipients ...'
|
|
365
|
+
end
|
|
366
|
+
# verify the required parameter 'broadcast_id' is set
|
|
367
|
+
if @api_client.config.client_side_validation && broadcast_id.nil?
|
|
368
|
+
fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.list_broadcast_recipients"
|
|
369
|
+
end
|
|
370
|
+
allowable_values = ["pending", "sent", "delivered", "read", "failed"]
|
|
371
|
+
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
372
|
+
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
373
|
+
end
|
|
374
|
+
# resource path
|
|
375
|
+
local_var_path = '/v1/broadcasts/{broadcastId}/recipients'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_id.to_s))
|
|
376
|
+
|
|
377
|
+
# query parameters
|
|
378
|
+
query_params = opts[:query_params] || {}
|
|
379
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
380
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
381
|
+
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
|
382
|
+
|
|
383
|
+
# header parameters
|
|
384
|
+
header_params = opts[:header_params] || {}
|
|
385
|
+
# HTTP header 'Accept' (if needed)
|
|
386
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
387
|
+
|
|
388
|
+
# form parameters
|
|
389
|
+
form_params = opts[:form_params] || {}
|
|
390
|
+
|
|
391
|
+
# http body (model)
|
|
392
|
+
post_body = opts[:debug_body]
|
|
393
|
+
|
|
394
|
+
# return_type
|
|
395
|
+
return_type = opts[:debug_return_type]
|
|
396
|
+
|
|
397
|
+
# auth_names
|
|
398
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
399
|
+
|
|
400
|
+
new_options = opts.merge(
|
|
401
|
+
:operation => :"BroadcastsApi.list_broadcast_recipients",
|
|
402
|
+
:header_params => header_params,
|
|
403
|
+
:query_params => query_params,
|
|
404
|
+
:form_params => form_params,
|
|
405
|
+
:body => post_body,
|
|
406
|
+
:auth_names => auth_names,
|
|
407
|
+
:return_type => return_type
|
|
408
|
+
)
|
|
409
|
+
|
|
410
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
411
|
+
if @api_client.config.debugging
|
|
412
|
+
@api_client.config.logger.debug "API called: BroadcastsApi#list_broadcast_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
413
|
+
end
|
|
414
|
+
return data, status_code, headers
|
|
415
|
+
end
|
|
416
|
+
|
|
417
|
+
# List broadcasts
|
|
418
|
+
# @param profile_id [String]
|
|
419
|
+
# @param [Hash] opts the optional parameters
|
|
420
|
+
# @option opts [String] :status
|
|
421
|
+
# @option opts [String] :platform
|
|
422
|
+
# @option opts [Integer] :limit (default to 50)
|
|
423
|
+
# @option opts [Integer] :skip (default to 0)
|
|
424
|
+
# @return [nil]
|
|
425
|
+
def list_broadcasts(profile_id, opts = {})
|
|
426
|
+
list_broadcasts_with_http_info(profile_id, opts)
|
|
427
|
+
nil
|
|
428
|
+
end
|
|
429
|
+
|
|
430
|
+
# List broadcasts
|
|
431
|
+
# @param profile_id [String]
|
|
432
|
+
# @param [Hash] opts the optional parameters
|
|
433
|
+
# @option opts [String] :status
|
|
434
|
+
# @option opts [String] :platform
|
|
435
|
+
# @option opts [Integer] :limit (default to 50)
|
|
436
|
+
# @option opts [Integer] :skip (default to 0)
|
|
437
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
438
|
+
def list_broadcasts_with_http_info(profile_id, opts = {})
|
|
439
|
+
if @api_client.config.debugging
|
|
440
|
+
@api_client.config.logger.debug 'Calling API: BroadcastsApi.list_broadcasts ...'
|
|
441
|
+
end
|
|
442
|
+
# verify the required parameter 'profile_id' is set
|
|
443
|
+
if @api_client.config.client_side_validation && profile_id.nil?
|
|
444
|
+
fail ArgumentError, "Missing the required parameter 'profile_id' when calling BroadcastsApi.list_broadcasts"
|
|
445
|
+
end
|
|
446
|
+
allowable_values = ["draft", "scheduled", "sending", "completed", "failed", "cancelled"]
|
|
447
|
+
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
448
|
+
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
449
|
+
end
|
|
450
|
+
# resource path
|
|
451
|
+
local_var_path = '/v1/broadcasts'
|
|
452
|
+
|
|
453
|
+
# query parameters
|
|
454
|
+
query_params = opts[:query_params] || {}
|
|
455
|
+
query_params[:'profileId'] = profile_id
|
|
456
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
457
|
+
query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
|
|
458
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
459
|
+
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
|
460
|
+
|
|
461
|
+
# header parameters
|
|
462
|
+
header_params = opts[:header_params] || {}
|
|
463
|
+
# HTTP header 'Accept' (if needed)
|
|
464
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
465
|
+
|
|
466
|
+
# form parameters
|
|
467
|
+
form_params = opts[:form_params] || {}
|
|
468
|
+
|
|
469
|
+
# http body (model)
|
|
470
|
+
post_body = opts[:debug_body]
|
|
471
|
+
|
|
472
|
+
# return_type
|
|
473
|
+
return_type = opts[:debug_return_type]
|
|
474
|
+
|
|
475
|
+
# auth_names
|
|
476
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
477
|
+
|
|
478
|
+
new_options = opts.merge(
|
|
479
|
+
:operation => :"BroadcastsApi.list_broadcasts",
|
|
480
|
+
:header_params => header_params,
|
|
481
|
+
:query_params => query_params,
|
|
482
|
+
:form_params => form_params,
|
|
483
|
+
:body => post_body,
|
|
484
|
+
:auth_names => auth_names,
|
|
485
|
+
:return_type => return_type
|
|
486
|
+
)
|
|
487
|
+
|
|
488
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
489
|
+
if @api_client.config.debugging
|
|
490
|
+
@api_client.config.logger.debug "API called: BroadcastsApi#list_broadcasts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
491
|
+
end
|
|
492
|
+
return data, status_code, headers
|
|
493
|
+
end
|
|
494
|
+
|
|
495
|
+
# Schedule broadcast for later
|
|
496
|
+
# @param broadcast_id [String]
|
|
497
|
+
# @param schedule_broadcast_request [ScheduleBroadcastRequest]
|
|
498
|
+
# @param [Hash] opts the optional parameters
|
|
499
|
+
# @return [nil]
|
|
500
|
+
def schedule_broadcast(broadcast_id, schedule_broadcast_request, opts = {})
|
|
501
|
+
schedule_broadcast_with_http_info(broadcast_id, schedule_broadcast_request, opts)
|
|
502
|
+
nil
|
|
503
|
+
end
|
|
504
|
+
|
|
505
|
+
# Schedule broadcast for later
|
|
506
|
+
# @param broadcast_id [String]
|
|
507
|
+
# @param schedule_broadcast_request [ScheduleBroadcastRequest]
|
|
508
|
+
# @param [Hash] opts the optional parameters
|
|
509
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
510
|
+
def schedule_broadcast_with_http_info(broadcast_id, schedule_broadcast_request, opts = {})
|
|
511
|
+
if @api_client.config.debugging
|
|
512
|
+
@api_client.config.logger.debug 'Calling API: BroadcastsApi.schedule_broadcast ...'
|
|
513
|
+
end
|
|
514
|
+
# verify the required parameter 'broadcast_id' is set
|
|
515
|
+
if @api_client.config.client_side_validation && broadcast_id.nil?
|
|
516
|
+
fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.schedule_broadcast"
|
|
517
|
+
end
|
|
518
|
+
# verify the required parameter 'schedule_broadcast_request' is set
|
|
519
|
+
if @api_client.config.client_side_validation && schedule_broadcast_request.nil?
|
|
520
|
+
fail ArgumentError, "Missing the required parameter 'schedule_broadcast_request' when calling BroadcastsApi.schedule_broadcast"
|
|
521
|
+
end
|
|
522
|
+
# resource path
|
|
523
|
+
local_var_path = '/v1/broadcasts/{broadcastId}/schedule'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_id.to_s))
|
|
524
|
+
|
|
525
|
+
# query parameters
|
|
526
|
+
query_params = opts[:query_params] || {}
|
|
527
|
+
|
|
528
|
+
# header parameters
|
|
529
|
+
header_params = opts[:header_params] || {}
|
|
530
|
+
# HTTP header 'Accept' (if needed)
|
|
531
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
532
|
+
# HTTP header 'Content-Type'
|
|
533
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
534
|
+
if !content_type.nil?
|
|
535
|
+
header_params['Content-Type'] = content_type
|
|
536
|
+
end
|
|
537
|
+
|
|
538
|
+
# form parameters
|
|
539
|
+
form_params = opts[:form_params] || {}
|
|
540
|
+
|
|
541
|
+
# http body (model)
|
|
542
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(schedule_broadcast_request)
|
|
543
|
+
|
|
544
|
+
# return_type
|
|
545
|
+
return_type = opts[:debug_return_type]
|
|
546
|
+
|
|
547
|
+
# auth_names
|
|
548
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
549
|
+
|
|
550
|
+
new_options = opts.merge(
|
|
551
|
+
:operation => :"BroadcastsApi.schedule_broadcast",
|
|
552
|
+
:header_params => header_params,
|
|
553
|
+
:query_params => query_params,
|
|
554
|
+
:form_params => form_params,
|
|
555
|
+
:body => post_body,
|
|
556
|
+
:auth_names => auth_names,
|
|
557
|
+
:return_type => return_type
|
|
558
|
+
)
|
|
559
|
+
|
|
560
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
561
|
+
if @api_client.config.debugging
|
|
562
|
+
@api_client.config.logger.debug "API called: BroadcastsApi#schedule_broadcast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
563
|
+
end
|
|
564
|
+
return data, status_code, headers
|
|
565
|
+
end
|
|
566
|
+
|
|
567
|
+
# Trigger immediate send
|
|
568
|
+
# @param broadcast_id [String]
|
|
569
|
+
# @param [Hash] opts the optional parameters
|
|
570
|
+
# @return [nil]
|
|
571
|
+
def send_broadcast(broadcast_id, opts = {})
|
|
572
|
+
send_broadcast_with_http_info(broadcast_id, opts)
|
|
573
|
+
nil
|
|
574
|
+
end
|
|
575
|
+
|
|
576
|
+
# Trigger immediate send
|
|
577
|
+
# @param broadcast_id [String]
|
|
578
|
+
# @param [Hash] opts the optional parameters
|
|
579
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
580
|
+
def send_broadcast_with_http_info(broadcast_id, opts = {})
|
|
581
|
+
if @api_client.config.debugging
|
|
582
|
+
@api_client.config.logger.debug 'Calling API: BroadcastsApi.send_broadcast ...'
|
|
583
|
+
end
|
|
584
|
+
# verify the required parameter 'broadcast_id' is set
|
|
585
|
+
if @api_client.config.client_side_validation && broadcast_id.nil?
|
|
586
|
+
fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.send_broadcast"
|
|
587
|
+
end
|
|
588
|
+
# resource path
|
|
589
|
+
local_var_path = '/v1/broadcasts/{broadcastId}/send'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_id.to_s))
|
|
590
|
+
|
|
591
|
+
# query parameters
|
|
592
|
+
query_params = opts[:query_params] || {}
|
|
593
|
+
|
|
594
|
+
# header parameters
|
|
595
|
+
header_params = opts[:header_params] || {}
|
|
596
|
+
# HTTP header 'Accept' (if needed)
|
|
597
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
598
|
+
|
|
599
|
+
# form parameters
|
|
600
|
+
form_params = opts[:form_params] || {}
|
|
601
|
+
|
|
602
|
+
# http body (model)
|
|
603
|
+
post_body = opts[:debug_body]
|
|
604
|
+
|
|
605
|
+
# return_type
|
|
606
|
+
return_type = opts[:debug_return_type]
|
|
607
|
+
|
|
608
|
+
# auth_names
|
|
609
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
610
|
+
|
|
611
|
+
new_options = opts.merge(
|
|
612
|
+
:operation => :"BroadcastsApi.send_broadcast",
|
|
613
|
+
:header_params => header_params,
|
|
614
|
+
:query_params => query_params,
|
|
615
|
+
:form_params => form_params,
|
|
616
|
+
:body => post_body,
|
|
617
|
+
:auth_names => auth_names,
|
|
618
|
+
:return_type => return_type
|
|
619
|
+
)
|
|
620
|
+
|
|
621
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
622
|
+
if @api_client.config.debugging
|
|
623
|
+
@api_client.config.logger.debug "API called: BroadcastsApi#send_broadcast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
624
|
+
end
|
|
625
|
+
return data, status_code, headers
|
|
626
|
+
end
|
|
627
|
+
|
|
628
|
+
# Update a broadcast
|
|
629
|
+
# @param broadcast_id [String]
|
|
630
|
+
# @param [Hash] opts the optional parameters
|
|
631
|
+
# @return [nil]
|
|
632
|
+
def update_broadcast(broadcast_id, opts = {})
|
|
633
|
+
update_broadcast_with_http_info(broadcast_id, opts)
|
|
634
|
+
nil
|
|
635
|
+
end
|
|
636
|
+
|
|
637
|
+
# Update a broadcast
|
|
638
|
+
# @param broadcast_id [String]
|
|
639
|
+
# @param [Hash] opts the optional parameters
|
|
640
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
641
|
+
def update_broadcast_with_http_info(broadcast_id, opts = {})
|
|
642
|
+
if @api_client.config.debugging
|
|
643
|
+
@api_client.config.logger.debug 'Calling API: BroadcastsApi.update_broadcast ...'
|
|
644
|
+
end
|
|
645
|
+
# verify the required parameter 'broadcast_id' is set
|
|
646
|
+
if @api_client.config.client_side_validation && broadcast_id.nil?
|
|
647
|
+
fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.update_broadcast"
|
|
648
|
+
end
|
|
649
|
+
# resource path
|
|
650
|
+
local_var_path = '/v1/broadcasts/{broadcastId}'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_id.to_s))
|
|
651
|
+
|
|
652
|
+
# query parameters
|
|
653
|
+
query_params = opts[:query_params] || {}
|
|
654
|
+
|
|
655
|
+
# header parameters
|
|
656
|
+
header_params = opts[:header_params] || {}
|
|
657
|
+
# HTTP header 'Accept' (if needed)
|
|
658
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
659
|
+
|
|
660
|
+
# form parameters
|
|
661
|
+
form_params = opts[:form_params] || {}
|
|
662
|
+
|
|
663
|
+
# http body (model)
|
|
664
|
+
post_body = opts[:debug_body]
|
|
665
|
+
|
|
666
|
+
# return_type
|
|
667
|
+
return_type = opts[:debug_return_type]
|
|
668
|
+
|
|
669
|
+
# auth_names
|
|
670
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
671
|
+
|
|
672
|
+
new_options = opts.merge(
|
|
673
|
+
:operation => :"BroadcastsApi.update_broadcast",
|
|
674
|
+
:header_params => header_params,
|
|
675
|
+
:query_params => query_params,
|
|
676
|
+
:form_params => form_params,
|
|
677
|
+
:body => post_body,
|
|
678
|
+
:auth_names => auth_names,
|
|
679
|
+
:return_type => return_type
|
|
680
|
+
)
|
|
681
|
+
|
|
682
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
683
|
+
if @api_client.config.debugging
|
|
684
|
+
@api_client.config.logger.debug "API called: BroadcastsApi#update_broadcast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
685
|
+
end
|
|
686
|
+
return data, status_code, headers
|
|
687
|
+
end
|
|
688
|
+
end
|
|
689
|
+
end
|