late-sdk 0.0.68 → 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 +62 -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/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/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 +28 -0
- data/openapi.yaml +809 -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/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 +114 -2
- data/zernio-sdk-0.0.68.gem +0 -0
|
@@ -0,0 +1,681 @@
|
|
|
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 SequencesApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Activate a sequence
|
|
23
|
+
# @param sequence_id [String]
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @return [nil]
|
|
26
|
+
def activate_sequence(sequence_id, opts = {})
|
|
27
|
+
activate_sequence_with_http_info(sequence_id, opts)
|
|
28
|
+
nil
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# Activate a sequence
|
|
32
|
+
# @param sequence_id [String]
|
|
33
|
+
# @param [Hash] opts the optional parameters
|
|
34
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
35
|
+
def activate_sequence_with_http_info(sequence_id, opts = {})
|
|
36
|
+
if @api_client.config.debugging
|
|
37
|
+
@api_client.config.logger.debug 'Calling API: SequencesApi.activate_sequence ...'
|
|
38
|
+
end
|
|
39
|
+
# verify the required parameter 'sequence_id' is set
|
|
40
|
+
if @api_client.config.client_side_validation && sequence_id.nil?
|
|
41
|
+
fail ArgumentError, "Missing the required parameter 'sequence_id' when calling SequencesApi.activate_sequence"
|
|
42
|
+
end
|
|
43
|
+
# resource path
|
|
44
|
+
local_var_path = '/v1/sequences/{sequenceId}/activate'.sub('{' + 'sequenceId' + '}', CGI.escape(sequence_id.to_s))
|
|
45
|
+
|
|
46
|
+
# query parameters
|
|
47
|
+
query_params = opts[:query_params] || {}
|
|
48
|
+
|
|
49
|
+
# header parameters
|
|
50
|
+
header_params = opts[:header_params] || {}
|
|
51
|
+
# HTTP header 'Accept' (if needed)
|
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
53
|
+
|
|
54
|
+
# form parameters
|
|
55
|
+
form_params = opts[:form_params] || {}
|
|
56
|
+
|
|
57
|
+
# http body (model)
|
|
58
|
+
post_body = opts[:debug_body]
|
|
59
|
+
|
|
60
|
+
# return_type
|
|
61
|
+
return_type = opts[:debug_return_type]
|
|
62
|
+
|
|
63
|
+
# auth_names
|
|
64
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
65
|
+
|
|
66
|
+
new_options = opts.merge(
|
|
67
|
+
:operation => :"SequencesApi.activate_sequence",
|
|
68
|
+
:header_params => header_params,
|
|
69
|
+
:query_params => query_params,
|
|
70
|
+
:form_params => form_params,
|
|
71
|
+
:body => post_body,
|
|
72
|
+
:auth_names => auth_names,
|
|
73
|
+
:return_type => return_type
|
|
74
|
+
)
|
|
75
|
+
|
|
76
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
77
|
+
if @api_client.config.debugging
|
|
78
|
+
@api_client.config.logger.debug "API called: SequencesApi#activate_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
79
|
+
end
|
|
80
|
+
return data, status_code, headers
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# Create a sequence
|
|
84
|
+
# @param create_sequence_request [CreateSequenceRequest]
|
|
85
|
+
# @param [Hash] opts the optional parameters
|
|
86
|
+
# @return [nil]
|
|
87
|
+
def create_sequence(create_sequence_request, opts = {})
|
|
88
|
+
create_sequence_with_http_info(create_sequence_request, opts)
|
|
89
|
+
nil
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# Create a sequence
|
|
93
|
+
# @param create_sequence_request [CreateSequenceRequest]
|
|
94
|
+
# @param [Hash] opts the optional parameters
|
|
95
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
96
|
+
def create_sequence_with_http_info(create_sequence_request, opts = {})
|
|
97
|
+
if @api_client.config.debugging
|
|
98
|
+
@api_client.config.logger.debug 'Calling API: SequencesApi.create_sequence ...'
|
|
99
|
+
end
|
|
100
|
+
# verify the required parameter 'create_sequence_request' is set
|
|
101
|
+
if @api_client.config.client_side_validation && create_sequence_request.nil?
|
|
102
|
+
fail ArgumentError, "Missing the required parameter 'create_sequence_request' when calling SequencesApi.create_sequence"
|
|
103
|
+
end
|
|
104
|
+
# resource path
|
|
105
|
+
local_var_path = '/v1/sequences'
|
|
106
|
+
|
|
107
|
+
# query parameters
|
|
108
|
+
query_params = opts[:query_params] || {}
|
|
109
|
+
|
|
110
|
+
# header parameters
|
|
111
|
+
header_params = opts[:header_params] || {}
|
|
112
|
+
# HTTP header 'Accept' (if needed)
|
|
113
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
114
|
+
# HTTP header 'Content-Type'
|
|
115
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
116
|
+
if !content_type.nil?
|
|
117
|
+
header_params['Content-Type'] = content_type
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# form parameters
|
|
121
|
+
form_params = opts[:form_params] || {}
|
|
122
|
+
|
|
123
|
+
# http body (model)
|
|
124
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_sequence_request)
|
|
125
|
+
|
|
126
|
+
# return_type
|
|
127
|
+
return_type = opts[:debug_return_type]
|
|
128
|
+
|
|
129
|
+
# auth_names
|
|
130
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
131
|
+
|
|
132
|
+
new_options = opts.merge(
|
|
133
|
+
:operation => :"SequencesApi.create_sequence",
|
|
134
|
+
:header_params => header_params,
|
|
135
|
+
:query_params => query_params,
|
|
136
|
+
:form_params => form_params,
|
|
137
|
+
:body => post_body,
|
|
138
|
+
:auth_names => auth_names,
|
|
139
|
+
:return_type => return_type
|
|
140
|
+
)
|
|
141
|
+
|
|
142
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
143
|
+
if @api_client.config.debugging
|
|
144
|
+
@api_client.config.logger.debug "API called: SequencesApi#create_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
145
|
+
end
|
|
146
|
+
return data, status_code, headers
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
# Delete a sequence
|
|
150
|
+
# @param sequence_id [String]
|
|
151
|
+
# @param [Hash] opts the optional parameters
|
|
152
|
+
# @return [nil]
|
|
153
|
+
def delete_sequence(sequence_id, opts = {})
|
|
154
|
+
delete_sequence_with_http_info(sequence_id, opts)
|
|
155
|
+
nil
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Delete a sequence
|
|
159
|
+
# @param sequence_id [String]
|
|
160
|
+
# @param [Hash] opts the optional parameters
|
|
161
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
162
|
+
def delete_sequence_with_http_info(sequence_id, opts = {})
|
|
163
|
+
if @api_client.config.debugging
|
|
164
|
+
@api_client.config.logger.debug 'Calling API: SequencesApi.delete_sequence ...'
|
|
165
|
+
end
|
|
166
|
+
# verify the required parameter 'sequence_id' is set
|
|
167
|
+
if @api_client.config.client_side_validation && sequence_id.nil?
|
|
168
|
+
fail ArgumentError, "Missing the required parameter 'sequence_id' when calling SequencesApi.delete_sequence"
|
|
169
|
+
end
|
|
170
|
+
# resource path
|
|
171
|
+
local_var_path = '/v1/sequences/{sequenceId}'.sub('{' + 'sequenceId' + '}', CGI.escape(sequence_id.to_s))
|
|
172
|
+
|
|
173
|
+
# query parameters
|
|
174
|
+
query_params = opts[:query_params] || {}
|
|
175
|
+
|
|
176
|
+
# header parameters
|
|
177
|
+
header_params = opts[:header_params] || {}
|
|
178
|
+
# HTTP header 'Accept' (if needed)
|
|
179
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
180
|
+
|
|
181
|
+
# form parameters
|
|
182
|
+
form_params = opts[:form_params] || {}
|
|
183
|
+
|
|
184
|
+
# http body (model)
|
|
185
|
+
post_body = opts[:debug_body]
|
|
186
|
+
|
|
187
|
+
# return_type
|
|
188
|
+
return_type = opts[:debug_return_type]
|
|
189
|
+
|
|
190
|
+
# auth_names
|
|
191
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
192
|
+
|
|
193
|
+
new_options = opts.merge(
|
|
194
|
+
:operation => :"SequencesApi.delete_sequence",
|
|
195
|
+
:header_params => header_params,
|
|
196
|
+
:query_params => query_params,
|
|
197
|
+
:form_params => form_params,
|
|
198
|
+
:body => post_body,
|
|
199
|
+
:auth_names => auth_names,
|
|
200
|
+
:return_type => return_type
|
|
201
|
+
)
|
|
202
|
+
|
|
203
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
204
|
+
if @api_client.config.debugging
|
|
205
|
+
@api_client.config.logger.debug "API called: SequencesApi#delete_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
206
|
+
end
|
|
207
|
+
return data, status_code, headers
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
# Enroll contacts in a sequence
|
|
211
|
+
# @param sequence_id [String]
|
|
212
|
+
# @param enroll_contacts_request [EnrollContactsRequest]
|
|
213
|
+
# @param [Hash] opts the optional parameters
|
|
214
|
+
# @return [nil]
|
|
215
|
+
def enroll_contacts(sequence_id, enroll_contacts_request, opts = {})
|
|
216
|
+
enroll_contacts_with_http_info(sequence_id, enroll_contacts_request, opts)
|
|
217
|
+
nil
|
|
218
|
+
end
|
|
219
|
+
|
|
220
|
+
# Enroll contacts in a sequence
|
|
221
|
+
# @param sequence_id [String]
|
|
222
|
+
# @param enroll_contacts_request [EnrollContactsRequest]
|
|
223
|
+
# @param [Hash] opts the optional parameters
|
|
224
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
225
|
+
def enroll_contacts_with_http_info(sequence_id, enroll_contacts_request, opts = {})
|
|
226
|
+
if @api_client.config.debugging
|
|
227
|
+
@api_client.config.logger.debug 'Calling API: SequencesApi.enroll_contacts ...'
|
|
228
|
+
end
|
|
229
|
+
# verify the required parameter 'sequence_id' is set
|
|
230
|
+
if @api_client.config.client_side_validation && sequence_id.nil?
|
|
231
|
+
fail ArgumentError, "Missing the required parameter 'sequence_id' when calling SequencesApi.enroll_contacts"
|
|
232
|
+
end
|
|
233
|
+
# verify the required parameter 'enroll_contacts_request' is set
|
|
234
|
+
if @api_client.config.client_side_validation && enroll_contacts_request.nil?
|
|
235
|
+
fail ArgumentError, "Missing the required parameter 'enroll_contacts_request' when calling SequencesApi.enroll_contacts"
|
|
236
|
+
end
|
|
237
|
+
# resource path
|
|
238
|
+
local_var_path = '/v1/sequences/{sequenceId}/enroll'.sub('{' + 'sequenceId' + '}', CGI.escape(sequence_id.to_s))
|
|
239
|
+
|
|
240
|
+
# query parameters
|
|
241
|
+
query_params = opts[:query_params] || {}
|
|
242
|
+
|
|
243
|
+
# header parameters
|
|
244
|
+
header_params = opts[:header_params] || {}
|
|
245
|
+
# HTTP header 'Accept' (if needed)
|
|
246
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
247
|
+
# HTTP header 'Content-Type'
|
|
248
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
249
|
+
if !content_type.nil?
|
|
250
|
+
header_params['Content-Type'] = content_type
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
# form parameters
|
|
254
|
+
form_params = opts[:form_params] || {}
|
|
255
|
+
|
|
256
|
+
# http body (model)
|
|
257
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(enroll_contacts_request)
|
|
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 => :"SequencesApi.enroll_contacts",
|
|
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(:POST, local_var_path, new_options)
|
|
276
|
+
if @api_client.config.debugging
|
|
277
|
+
@api_client.config.logger.debug "API called: SequencesApi#enroll_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
278
|
+
end
|
|
279
|
+
return data, status_code, headers
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
# Get sequence with steps
|
|
283
|
+
# @param sequence_id [String]
|
|
284
|
+
# @param [Hash] opts the optional parameters
|
|
285
|
+
# @return [nil]
|
|
286
|
+
def get_sequence(sequence_id, opts = {})
|
|
287
|
+
get_sequence_with_http_info(sequence_id, opts)
|
|
288
|
+
nil
|
|
289
|
+
end
|
|
290
|
+
|
|
291
|
+
# Get sequence with steps
|
|
292
|
+
# @param sequence_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_sequence_with_http_info(sequence_id, opts = {})
|
|
296
|
+
if @api_client.config.debugging
|
|
297
|
+
@api_client.config.logger.debug 'Calling API: SequencesApi.get_sequence ...'
|
|
298
|
+
end
|
|
299
|
+
# verify the required parameter 'sequence_id' is set
|
|
300
|
+
if @api_client.config.client_side_validation && sequence_id.nil?
|
|
301
|
+
fail ArgumentError, "Missing the required parameter 'sequence_id' when calling SequencesApi.get_sequence"
|
|
302
|
+
end
|
|
303
|
+
# resource path
|
|
304
|
+
local_var_path = '/v1/sequences/{sequenceId}'.sub('{' + 'sequenceId' + '}', CGI.escape(sequence_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 => :"SequencesApi.get_sequence",
|
|
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: SequencesApi#get_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
339
|
+
end
|
|
340
|
+
return data, status_code, headers
|
|
341
|
+
end
|
|
342
|
+
|
|
343
|
+
# List enrollments for a sequence
|
|
344
|
+
# @param sequence_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_sequence_enrollments(sequence_id, opts = {})
|
|
351
|
+
list_sequence_enrollments_with_http_info(sequence_id, opts)
|
|
352
|
+
nil
|
|
353
|
+
end
|
|
354
|
+
|
|
355
|
+
# List enrollments for a sequence
|
|
356
|
+
# @param sequence_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_sequence_enrollments_with_http_info(sequence_id, opts = {})
|
|
363
|
+
if @api_client.config.debugging
|
|
364
|
+
@api_client.config.logger.debug 'Calling API: SequencesApi.list_sequence_enrollments ...'
|
|
365
|
+
end
|
|
366
|
+
# verify the required parameter 'sequence_id' is set
|
|
367
|
+
if @api_client.config.client_side_validation && sequence_id.nil?
|
|
368
|
+
fail ArgumentError, "Missing the required parameter 'sequence_id' when calling SequencesApi.list_sequence_enrollments"
|
|
369
|
+
end
|
|
370
|
+
allowable_values = ["active", "completed", "exited", "paused"]
|
|
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/sequences/{sequenceId}/enrollments'.sub('{' + 'sequenceId' + '}', CGI.escape(sequence_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 => :"SequencesApi.list_sequence_enrollments",
|
|
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: SequencesApi#list_sequence_enrollments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
413
|
+
end
|
|
414
|
+
return data, status_code, headers
|
|
415
|
+
end
|
|
416
|
+
|
|
417
|
+
# List sequences
|
|
418
|
+
# @param profile_id [String]
|
|
419
|
+
# @param [Hash] opts the optional parameters
|
|
420
|
+
# @option opts [String] :status
|
|
421
|
+
# @option opts [Integer] :limit (default to 50)
|
|
422
|
+
# @option opts [Integer] :skip (default to 0)
|
|
423
|
+
# @return [nil]
|
|
424
|
+
def list_sequences(profile_id, opts = {})
|
|
425
|
+
list_sequences_with_http_info(profile_id, opts)
|
|
426
|
+
nil
|
|
427
|
+
end
|
|
428
|
+
|
|
429
|
+
# List sequences
|
|
430
|
+
# @param profile_id [String]
|
|
431
|
+
# @param [Hash] opts the optional parameters
|
|
432
|
+
# @option opts [String] :status
|
|
433
|
+
# @option opts [Integer] :limit (default to 50)
|
|
434
|
+
# @option opts [Integer] :skip (default to 0)
|
|
435
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
436
|
+
def list_sequences_with_http_info(profile_id, opts = {})
|
|
437
|
+
if @api_client.config.debugging
|
|
438
|
+
@api_client.config.logger.debug 'Calling API: SequencesApi.list_sequences ...'
|
|
439
|
+
end
|
|
440
|
+
# verify the required parameter 'profile_id' is set
|
|
441
|
+
if @api_client.config.client_side_validation && profile_id.nil?
|
|
442
|
+
fail ArgumentError, "Missing the required parameter 'profile_id' when calling SequencesApi.list_sequences"
|
|
443
|
+
end
|
|
444
|
+
allowable_values = ["draft", "active", "paused"]
|
|
445
|
+
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
446
|
+
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
447
|
+
end
|
|
448
|
+
# resource path
|
|
449
|
+
local_var_path = '/v1/sequences'
|
|
450
|
+
|
|
451
|
+
# query parameters
|
|
452
|
+
query_params = opts[:query_params] || {}
|
|
453
|
+
query_params[:'profileId'] = profile_id
|
|
454
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
455
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
456
|
+
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
|
457
|
+
|
|
458
|
+
# header parameters
|
|
459
|
+
header_params = opts[:header_params] || {}
|
|
460
|
+
# HTTP header 'Accept' (if needed)
|
|
461
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
462
|
+
|
|
463
|
+
# form parameters
|
|
464
|
+
form_params = opts[:form_params] || {}
|
|
465
|
+
|
|
466
|
+
# http body (model)
|
|
467
|
+
post_body = opts[:debug_body]
|
|
468
|
+
|
|
469
|
+
# return_type
|
|
470
|
+
return_type = opts[:debug_return_type]
|
|
471
|
+
|
|
472
|
+
# auth_names
|
|
473
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
474
|
+
|
|
475
|
+
new_options = opts.merge(
|
|
476
|
+
:operation => :"SequencesApi.list_sequences",
|
|
477
|
+
:header_params => header_params,
|
|
478
|
+
:query_params => query_params,
|
|
479
|
+
:form_params => form_params,
|
|
480
|
+
:body => post_body,
|
|
481
|
+
:auth_names => auth_names,
|
|
482
|
+
:return_type => return_type
|
|
483
|
+
)
|
|
484
|
+
|
|
485
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
486
|
+
if @api_client.config.debugging
|
|
487
|
+
@api_client.config.logger.debug "API called: SequencesApi#list_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
488
|
+
end
|
|
489
|
+
return data, status_code, headers
|
|
490
|
+
end
|
|
491
|
+
|
|
492
|
+
# Pause a sequence
|
|
493
|
+
# @param sequence_id [String]
|
|
494
|
+
# @param [Hash] opts the optional parameters
|
|
495
|
+
# @return [nil]
|
|
496
|
+
def pause_sequence(sequence_id, opts = {})
|
|
497
|
+
pause_sequence_with_http_info(sequence_id, opts)
|
|
498
|
+
nil
|
|
499
|
+
end
|
|
500
|
+
|
|
501
|
+
# Pause a sequence
|
|
502
|
+
# @param sequence_id [String]
|
|
503
|
+
# @param [Hash] opts the optional parameters
|
|
504
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
505
|
+
def pause_sequence_with_http_info(sequence_id, opts = {})
|
|
506
|
+
if @api_client.config.debugging
|
|
507
|
+
@api_client.config.logger.debug 'Calling API: SequencesApi.pause_sequence ...'
|
|
508
|
+
end
|
|
509
|
+
# verify the required parameter 'sequence_id' is set
|
|
510
|
+
if @api_client.config.client_side_validation && sequence_id.nil?
|
|
511
|
+
fail ArgumentError, "Missing the required parameter 'sequence_id' when calling SequencesApi.pause_sequence"
|
|
512
|
+
end
|
|
513
|
+
# resource path
|
|
514
|
+
local_var_path = '/v1/sequences/{sequenceId}/pause'.sub('{' + 'sequenceId' + '}', CGI.escape(sequence_id.to_s))
|
|
515
|
+
|
|
516
|
+
# query parameters
|
|
517
|
+
query_params = opts[:query_params] || {}
|
|
518
|
+
|
|
519
|
+
# header parameters
|
|
520
|
+
header_params = opts[:header_params] || {}
|
|
521
|
+
# HTTP header 'Accept' (if needed)
|
|
522
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
523
|
+
|
|
524
|
+
# form parameters
|
|
525
|
+
form_params = opts[:form_params] || {}
|
|
526
|
+
|
|
527
|
+
# http body (model)
|
|
528
|
+
post_body = opts[:debug_body]
|
|
529
|
+
|
|
530
|
+
# return_type
|
|
531
|
+
return_type = opts[:debug_return_type]
|
|
532
|
+
|
|
533
|
+
# auth_names
|
|
534
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
535
|
+
|
|
536
|
+
new_options = opts.merge(
|
|
537
|
+
:operation => :"SequencesApi.pause_sequence",
|
|
538
|
+
:header_params => header_params,
|
|
539
|
+
:query_params => query_params,
|
|
540
|
+
:form_params => form_params,
|
|
541
|
+
:body => post_body,
|
|
542
|
+
:auth_names => auth_names,
|
|
543
|
+
:return_type => return_type
|
|
544
|
+
)
|
|
545
|
+
|
|
546
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
547
|
+
if @api_client.config.debugging
|
|
548
|
+
@api_client.config.logger.debug "API called: SequencesApi#pause_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
549
|
+
end
|
|
550
|
+
return data, status_code, headers
|
|
551
|
+
end
|
|
552
|
+
|
|
553
|
+
# Unenroll a contact from a sequence
|
|
554
|
+
# @param sequence_id [String]
|
|
555
|
+
# @param contact_id [String]
|
|
556
|
+
# @param [Hash] opts the optional parameters
|
|
557
|
+
# @return [nil]
|
|
558
|
+
def unenroll_contact(sequence_id, contact_id, opts = {})
|
|
559
|
+
unenroll_contact_with_http_info(sequence_id, contact_id, opts)
|
|
560
|
+
nil
|
|
561
|
+
end
|
|
562
|
+
|
|
563
|
+
# Unenroll a contact from a sequence
|
|
564
|
+
# @param sequence_id [String]
|
|
565
|
+
# @param contact_id [String]
|
|
566
|
+
# @param [Hash] opts the optional parameters
|
|
567
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
568
|
+
def unenroll_contact_with_http_info(sequence_id, contact_id, opts = {})
|
|
569
|
+
if @api_client.config.debugging
|
|
570
|
+
@api_client.config.logger.debug 'Calling API: SequencesApi.unenroll_contact ...'
|
|
571
|
+
end
|
|
572
|
+
# verify the required parameter 'sequence_id' is set
|
|
573
|
+
if @api_client.config.client_side_validation && sequence_id.nil?
|
|
574
|
+
fail ArgumentError, "Missing the required parameter 'sequence_id' when calling SequencesApi.unenroll_contact"
|
|
575
|
+
end
|
|
576
|
+
# verify the required parameter 'contact_id' is set
|
|
577
|
+
if @api_client.config.client_side_validation && contact_id.nil?
|
|
578
|
+
fail ArgumentError, "Missing the required parameter 'contact_id' when calling SequencesApi.unenroll_contact"
|
|
579
|
+
end
|
|
580
|
+
# resource path
|
|
581
|
+
local_var_path = '/v1/sequences/{sequenceId}/enroll/{contactId}'.sub('{' + 'sequenceId' + '}', CGI.escape(sequence_id.to_s)).sub('{' + 'contactId' + '}', CGI.escape(contact_id.to_s))
|
|
582
|
+
|
|
583
|
+
# query parameters
|
|
584
|
+
query_params = opts[:query_params] || {}
|
|
585
|
+
|
|
586
|
+
# header parameters
|
|
587
|
+
header_params = opts[:header_params] || {}
|
|
588
|
+
# HTTP header 'Accept' (if needed)
|
|
589
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
590
|
+
|
|
591
|
+
# form parameters
|
|
592
|
+
form_params = opts[:form_params] || {}
|
|
593
|
+
|
|
594
|
+
# http body (model)
|
|
595
|
+
post_body = opts[:debug_body]
|
|
596
|
+
|
|
597
|
+
# return_type
|
|
598
|
+
return_type = opts[:debug_return_type]
|
|
599
|
+
|
|
600
|
+
# auth_names
|
|
601
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
602
|
+
|
|
603
|
+
new_options = opts.merge(
|
|
604
|
+
:operation => :"SequencesApi.unenroll_contact",
|
|
605
|
+
:header_params => header_params,
|
|
606
|
+
:query_params => query_params,
|
|
607
|
+
:form_params => form_params,
|
|
608
|
+
:body => post_body,
|
|
609
|
+
:auth_names => auth_names,
|
|
610
|
+
:return_type => return_type
|
|
611
|
+
)
|
|
612
|
+
|
|
613
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
614
|
+
if @api_client.config.debugging
|
|
615
|
+
@api_client.config.logger.debug "API called: SequencesApi#unenroll_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
616
|
+
end
|
|
617
|
+
return data, status_code, headers
|
|
618
|
+
end
|
|
619
|
+
|
|
620
|
+
# Update a sequence
|
|
621
|
+
# @param sequence_id [String]
|
|
622
|
+
# @param [Hash] opts the optional parameters
|
|
623
|
+
# @return [nil]
|
|
624
|
+
def update_sequence(sequence_id, opts = {})
|
|
625
|
+
update_sequence_with_http_info(sequence_id, opts)
|
|
626
|
+
nil
|
|
627
|
+
end
|
|
628
|
+
|
|
629
|
+
# Update a sequence
|
|
630
|
+
# @param sequence_id [String]
|
|
631
|
+
# @param [Hash] opts the optional parameters
|
|
632
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
633
|
+
def update_sequence_with_http_info(sequence_id, opts = {})
|
|
634
|
+
if @api_client.config.debugging
|
|
635
|
+
@api_client.config.logger.debug 'Calling API: SequencesApi.update_sequence ...'
|
|
636
|
+
end
|
|
637
|
+
# verify the required parameter 'sequence_id' is set
|
|
638
|
+
if @api_client.config.client_side_validation && sequence_id.nil?
|
|
639
|
+
fail ArgumentError, "Missing the required parameter 'sequence_id' when calling SequencesApi.update_sequence"
|
|
640
|
+
end
|
|
641
|
+
# resource path
|
|
642
|
+
local_var_path = '/v1/sequences/{sequenceId}'.sub('{' + 'sequenceId' + '}', CGI.escape(sequence_id.to_s))
|
|
643
|
+
|
|
644
|
+
# query parameters
|
|
645
|
+
query_params = opts[:query_params] || {}
|
|
646
|
+
|
|
647
|
+
# header parameters
|
|
648
|
+
header_params = opts[:header_params] || {}
|
|
649
|
+
# HTTP header 'Accept' (if needed)
|
|
650
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
651
|
+
|
|
652
|
+
# form parameters
|
|
653
|
+
form_params = opts[:form_params] || {}
|
|
654
|
+
|
|
655
|
+
# http body (model)
|
|
656
|
+
post_body = opts[:debug_body]
|
|
657
|
+
|
|
658
|
+
# return_type
|
|
659
|
+
return_type = opts[:debug_return_type]
|
|
660
|
+
|
|
661
|
+
# auth_names
|
|
662
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
663
|
+
|
|
664
|
+
new_options = opts.merge(
|
|
665
|
+
:operation => :"SequencesApi.update_sequence",
|
|
666
|
+
:header_params => header_params,
|
|
667
|
+
:query_params => query_params,
|
|
668
|
+
:form_params => form_params,
|
|
669
|
+
:body => post_body,
|
|
670
|
+
:auth_names => auth_names,
|
|
671
|
+
:return_type => return_type
|
|
672
|
+
)
|
|
673
|
+
|
|
674
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
675
|
+
if @api_client.config.debugging
|
|
676
|
+
@api_client.config.logger.debug "API called: SequencesApi#update_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
677
|
+
end
|
|
678
|
+
return data, status_code, headers
|
|
679
|
+
end
|
|
680
|
+
end
|
|
681
|
+
end
|