zernio-sdk 0.0.76 → 0.0.78
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 +27 -1
- data/docs/ActivateSequence200Response.md +20 -0
- data/docs/AddBroadcastRecipients200Response.md +22 -0
- data/docs/BroadcastsApi.md +49 -42
- data/docs/CancelBroadcast200Response.md +20 -0
- data/docs/CancelBroadcast200ResponseBroadcast.md +20 -0
- data/docs/CreateBroadcast200Response.md +20 -0
- data/docs/CreateBroadcast200ResponseBroadcast.md +30 -0
- data/docs/CreateSequence200Response.md +20 -0
- data/docs/CreateSequence200ResponseSequence.md +30 -0
- data/docs/CreateSequenceRequestStepsInner.md +1 -1
- data/docs/EnrollContacts200Response.md +22 -0
- data/docs/GetBroadcast200Response.md +20 -0
- data/docs/GetBroadcast200ResponseBroadcast.md +54 -0
- data/docs/{CreateSequenceRequestStepsInnerMessage.md → GetBroadcast200ResponseBroadcastMessage.md} +2 -2
- data/docs/GetBroadcast200ResponseBroadcastSegmentFilters.md +18 -0
- data/docs/GetSequence200Response.md +20 -0
- data/docs/GetSequence200ResponseSequence.md +44 -0
- data/docs/GetSequence200ResponseSequenceStepsInner.md +24 -0
- data/docs/GetSequence200ResponseSequenceStepsInnerTemplate.md +22 -0
- data/docs/ListBroadcastRecipients200Response.md +22 -0
- data/docs/ListBroadcastRecipients200ResponseRecipientsInner.md +38 -0
- data/docs/ListSequenceEnrollments200Response.md +22 -0
- data/docs/ListSequenceEnrollments200ResponseEnrollmentsInner.md +40 -0
- data/docs/ScheduleBroadcast200Response.md +20 -0
- data/docs/ScheduleBroadcast200ResponseBroadcast.md +22 -0
- data/docs/SequencesApi.md +49 -42
- data/docs/UpdateBroadcast200Response.md +20 -0
- data/docs/UpdateBroadcast200ResponseBroadcast.md +26 -0
- data/docs/UpdateSequence200Response.md +20 -0
- data/docs/UpdateSequence200ResponseSequence.md +32 -0
- data/lib/late-sdk/api/broadcasts_api.rb +35 -35
- data/lib/late-sdk/api/sequences_api.rb +35 -35
- data/lib/late-sdk/models/activate_sequence200_response.rb +156 -0
- data/lib/late-sdk/models/add_broadcast_recipients200_response.rb +167 -0
- data/lib/late-sdk/models/cancel_broadcast200_response.rb +156 -0
- data/lib/late-sdk/models/cancel_broadcast200_response_broadcast.rb +156 -0
- data/lib/late-sdk/models/create_broadcast200_response.rb +156 -0
- data/lib/late-sdk/models/create_broadcast200_response_broadcast.rb +201 -0
- data/lib/late-sdk/models/create_sequence200_response.rb +156 -0
- data/lib/late-sdk/models/create_sequence200_response_sequence.rb +201 -0
- data/lib/late-sdk/models/create_sequence_request_steps_inner.rb +1 -1
- data/lib/late-sdk/models/enroll_contacts200_response.rb +167 -0
- data/lib/late-sdk/models/get_broadcast200_response.rb +156 -0
- data/lib/late-sdk/models/get_broadcast200_response_broadcast.rb +343 -0
- data/lib/late-sdk/models/{create_sequence_request_steps_inner_message.rb → get_broadcast200_response_broadcast_message.rb} +3 -3
- data/lib/late-sdk/models/get_broadcast200_response_broadcast_segment_filters.rb +149 -0
- data/lib/late-sdk/models/get_sequence200_response.rb +156 -0
- data/lib/late-sdk/models/get_sequence200_response_sequence.rb +300 -0
- data/lib/late-sdk/models/get_sequence200_response_sequence_steps_inner.rb +174 -0
- data/lib/late-sdk/models/get_sequence200_response_sequence_steps_inner_template.rb +165 -0
- data/lib/late-sdk/models/list_broadcast_recipients200_response.rb +167 -0
- data/lib/late-sdk/models/list_broadcast_recipients200_response_recipients_inner.rb +271 -0
- data/lib/late-sdk/models/list_sequence_enrollments200_response.rb +167 -0
- data/lib/late-sdk/models/list_sequence_enrollments200_response_enrollments_inner.rb +280 -0
- data/lib/late-sdk/models/schedule_broadcast200_response.rb +156 -0
- data/lib/late-sdk/models/schedule_broadcast200_response_broadcast.rb +165 -0
- data/lib/late-sdk/models/update_broadcast200_response.rb +156 -0
- data/lib/late-sdk/models/update_broadcast200_response_broadcast.rb +183 -0
- data/lib/late-sdk/models/update_sequence200_response.rb +156 -0
- data/lib/late-sdk/models/update_sequence200_response_sequence.rb +212 -0
- data/lib/late-sdk/version.rb +1 -1
- data/lib/late-sdk.rb +27 -1
- data/openapi.yaml +270 -14
- data/spec/api/broadcasts_api_spec.rb +7 -7
- data/spec/api/sequences_api_spec.rb +7 -7
- data/spec/models/activate_sequence200_response_spec.rb +42 -0
- data/spec/models/add_broadcast_recipients200_response_spec.rb +48 -0
- data/spec/models/cancel_broadcast200_response_broadcast_spec.rb +42 -0
- data/spec/models/cancel_broadcast200_response_spec.rb +42 -0
- data/spec/models/create_broadcast200_response_broadcast_spec.rb +72 -0
- data/spec/models/create_broadcast200_response_spec.rb +42 -0
- data/spec/models/create_sequence200_response_sequence_spec.rb +72 -0
- data/spec/models/create_sequence200_response_spec.rb +42 -0
- data/spec/models/enroll_contacts200_response_spec.rb +48 -0
- data/spec/models/{create_sequence_request_steps_inner_message_spec.rb → get_broadcast200_response_broadcast_message_spec.rb} +6 -6
- data/spec/models/get_broadcast200_response_broadcast_segment_filters_spec.rb +36 -0
- data/spec/models/get_broadcast200_response_broadcast_spec.rb +148 -0
- data/spec/models/get_broadcast200_response_spec.rb +42 -0
- data/spec/models/get_sequence200_response_sequence_spec.rb +118 -0
- data/spec/models/get_sequence200_response_sequence_steps_inner_spec.rb +54 -0
- data/spec/models/get_sequence200_response_sequence_steps_inner_template_spec.rb +48 -0
- data/spec/models/get_sequence200_response_spec.rb +42 -0
- data/spec/models/list_broadcast_recipients200_response_recipients_inner_spec.rb +100 -0
- data/spec/models/list_broadcast_recipients200_response_spec.rb +48 -0
- data/spec/models/list_sequence_enrollments200_response_enrollments_inner_spec.rb +106 -0
- data/spec/models/list_sequence_enrollments200_response_spec.rb +48 -0
- data/spec/models/schedule_broadcast200_response_broadcast_spec.rb +48 -0
- data/spec/models/schedule_broadcast200_response_spec.rb +42 -0
- data/spec/models/update_broadcast200_response_broadcast_spec.rb +60 -0
- data/spec/models/update_broadcast200_response_spec.rb +42 -0
- data/spec/models/update_sequence200_response_sequence_spec.rb +78 -0
- data/spec/models/update_sequence200_response_spec.rb +42 -0
- metadata +109 -5
data/lib/late-sdk/version.rb
CHANGED
data/lib/late-sdk.rb
CHANGED
|
@@ -22,6 +22,8 @@ require 'late-sdk/models/account_get_response'
|
|
|
22
22
|
require 'late-sdk/models/account_with_follower_stats'
|
|
23
23
|
require 'late-sdk/models/account_with_follower_stats_all_of_account_stats'
|
|
24
24
|
require 'late-sdk/models/accounts_list_response'
|
|
25
|
+
require 'late-sdk/models/activate_sequence200_response'
|
|
26
|
+
require 'late-sdk/models/add_broadcast_recipients200_response'
|
|
25
27
|
require 'late-sdk/models/add_broadcast_recipients_request'
|
|
26
28
|
require 'late-sdk/models/add_whats_app_broadcast_recipients200_response'
|
|
27
29
|
require 'late-sdk/models/add_whats_app_broadcast_recipients_request'
|
|
@@ -46,6 +48,8 @@ require 'late-sdk/models/bulk_update_whats_app_contacts_request'
|
|
|
46
48
|
require 'late-sdk/models/bulk_upload_posts200_response'
|
|
47
49
|
require 'late-sdk/models/bulk_upload_posts200_response_errors_inner'
|
|
48
50
|
require 'late-sdk/models/bulk_upload_posts429_response'
|
|
51
|
+
require 'late-sdk/models/cancel_broadcast200_response'
|
|
52
|
+
require 'late-sdk/models/cancel_broadcast200_response_broadcast'
|
|
49
53
|
require 'late-sdk/models/cancel_whats_app_broadcast_schedule200_response'
|
|
50
54
|
require 'late-sdk/models/cancel_whats_app_broadcast_schedule200_response_broadcast'
|
|
51
55
|
require 'late-sdk/models/caption_response'
|
|
@@ -69,6 +73,8 @@ require 'late-sdk/models/create_account_group201_response'
|
|
|
69
73
|
require 'late-sdk/models/create_account_group_request'
|
|
70
74
|
require 'late-sdk/models/create_api_key201_response'
|
|
71
75
|
require 'late-sdk/models/create_api_key_request'
|
|
76
|
+
require 'late-sdk/models/create_broadcast200_response'
|
|
77
|
+
require 'late-sdk/models/create_broadcast200_response_broadcast'
|
|
72
78
|
require 'late-sdk/models/create_broadcast_request'
|
|
73
79
|
require 'late-sdk/models/create_broadcast_request_message'
|
|
74
80
|
require 'late-sdk/models/create_broadcast_request_message_attachments_inner'
|
|
@@ -93,9 +99,10 @@ require 'late-sdk/models/create_post_request_platforms_inner_platform_specific_d
|
|
|
93
99
|
require 'late-sdk/models/create_profile_request'
|
|
94
100
|
require 'late-sdk/models/create_queue_slot201_response'
|
|
95
101
|
require 'late-sdk/models/create_queue_slot_request'
|
|
102
|
+
require 'late-sdk/models/create_sequence200_response'
|
|
103
|
+
require 'late-sdk/models/create_sequence200_response_sequence'
|
|
96
104
|
require 'late-sdk/models/create_sequence_request'
|
|
97
105
|
require 'late-sdk/models/create_sequence_request_steps_inner'
|
|
98
|
-
require 'late-sdk/models/create_sequence_request_steps_inner_message'
|
|
99
106
|
require 'late-sdk/models/create_sequence_request_steps_inner_template'
|
|
100
107
|
require 'late-sdk/models/create_sequence_request_steps_inner_template_variable_mapping_value'
|
|
101
108
|
require 'late-sdk/models/create_webhook_settings_request'
|
|
@@ -133,6 +140,7 @@ require 'late-sdk/models/edit_inbox_message200_response_data'
|
|
|
133
140
|
require 'late-sdk/models/edit_inbox_message_request'
|
|
134
141
|
require 'late-sdk/models/edit_inbox_message_request_reply_markup'
|
|
135
142
|
require 'late-sdk/models/edit_inbox_message_request_reply_markup_keyboard_inner_inner'
|
|
143
|
+
require 'late-sdk/models/enroll_contacts200_response'
|
|
136
144
|
require 'late-sdk/models/enroll_contacts_request'
|
|
137
145
|
require 'late-sdk/models/error_response'
|
|
138
146
|
require 'late-sdk/models/expired'
|
|
@@ -163,6 +171,10 @@ require 'late-sdk/models/get_analytics402_response'
|
|
|
163
171
|
require 'late-sdk/models/get_best_time_to_post200_response'
|
|
164
172
|
require 'late-sdk/models/get_best_time_to_post200_response_slots_inner'
|
|
165
173
|
require 'late-sdk/models/get_best_time_to_post403_response'
|
|
174
|
+
require 'late-sdk/models/get_broadcast200_response'
|
|
175
|
+
require 'late-sdk/models/get_broadcast200_response_broadcast'
|
|
176
|
+
require 'late-sdk/models/get_broadcast200_response_broadcast_message'
|
|
177
|
+
require 'late-sdk/models/get_broadcast200_response_broadcast_segment_filters'
|
|
166
178
|
require 'late-sdk/models/get_connect_url200_response'
|
|
167
179
|
require 'late-sdk/models/get_content_decay200_response'
|
|
168
180
|
require 'late-sdk/models/get_content_decay200_response_buckets_inner'
|
|
@@ -248,6 +260,10 @@ require 'late-sdk/models/get_reddit_flairs200_response'
|
|
|
248
260
|
require 'late-sdk/models/get_reddit_flairs200_response_flairs_inner'
|
|
249
261
|
require 'late-sdk/models/get_reddit_subreddits200_response'
|
|
250
262
|
require 'late-sdk/models/get_reddit_subreddits200_response_subreddits_inner'
|
|
263
|
+
require 'late-sdk/models/get_sequence200_response'
|
|
264
|
+
require 'late-sdk/models/get_sequence200_response_sequence'
|
|
265
|
+
require 'late-sdk/models/get_sequence200_response_sequence_steps_inner'
|
|
266
|
+
require 'late-sdk/models/get_sequence200_response_sequence_steps_inner_template'
|
|
251
267
|
require 'late-sdk/models/get_telegram_commands200_response'
|
|
252
268
|
require 'late-sdk/models/get_telegram_commands200_response_data_inner'
|
|
253
269
|
require 'late-sdk/models/get_telegram_connect_status200_response'
|
|
@@ -334,6 +350,8 @@ require 'late-sdk/models/list_account_groups200_response'
|
|
|
334
350
|
require 'late-sdk/models/list_account_groups200_response_groups_inner'
|
|
335
351
|
require 'late-sdk/models/list_accounts200_response'
|
|
336
352
|
require 'late-sdk/models/list_api_keys200_response'
|
|
353
|
+
require 'late-sdk/models/list_broadcast_recipients200_response'
|
|
354
|
+
require 'late-sdk/models/list_broadcast_recipients200_response_recipients_inner'
|
|
337
355
|
require 'late-sdk/models/list_broadcasts200_response'
|
|
338
356
|
require 'late-sdk/models/list_broadcasts200_response_broadcasts_inner'
|
|
339
357
|
require 'late-sdk/models/list_comment_automations200_response'
|
|
@@ -371,6 +389,8 @@ require 'late-sdk/models/list_posts_logs200_response_pagination'
|
|
|
371
389
|
require 'late-sdk/models/list_queue_slots200_response'
|
|
372
390
|
require 'late-sdk/models/list_queue_slots200_response_one_of'
|
|
373
391
|
require 'late-sdk/models/list_queue_slots200_response_one_of1'
|
|
392
|
+
require 'late-sdk/models/list_sequence_enrollments200_response'
|
|
393
|
+
require 'late-sdk/models/list_sequence_enrollments200_response_enrollments_inner'
|
|
374
394
|
require 'late-sdk/models/list_sequences200_response'
|
|
375
395
|
require 'late-sdk/models/list_sequences200_response_sequences_inner'
|
|
376
396
|
require 'late-sdk/models/list_snapchat_profiles200_response'
|
|
@@ -438,6 +458,8 @@ require 'late-sdk/models/reply_to_inbox_review200_response_reply'
|
|
|
438
458
|
require 'late-sdk/models/reply_to_inbox_review_request'
|
|
439
459
|
require 'late-sdk/models/retweet_post200_response'
|
|
440
460
|
require 'late-sdk/models/retweet_post_request'
|
|
461
|
+
require 'late-sdk/models/schedule_broadcast200_response'
|
|
462
|
+
require 'late-sdk/models/schedule_broadcast200_response_broadcast'
|
|
441
463
|
require 'late-sdk/models/schedule_broadcast_request'
|
|
442
464
|
require 'late-sdk/models/schedule_whats_app_broadcast200_response'
|
|
443
465
|
require 'late-sdk/models/schedule_whats_app_broadcast200_response_broadcast'
|
|
@@ -511,6 +533,8 @@ require 'late-sdk/models/update_account200_response'
|
|
|
511
533
|
require 'late-sdk/models/update_account_group200_response'
|
|
512
534
|
require 'late-sdk/models/update_account_group_request'
|
|
513
535
|
require 'late-sdk/models/update_account_request'
|
|
536
|
+
require 'late-sdk/models/update_broadcast200_response'
|
|
537
|
+
require 'late-sdk/models/update_broadcast200_response_broadcast'
|
|
514
538
|
require 'late-sdk/models/update_comment_automation_request'
|
|
515
539
|
require 'late-sdk/models/update_contact_request'
|
|
516
540
|
require 'late-sdk/models/update_custom_field_request'
|
|
@@ -548,6 +572,8 @@ require 'late-sdk/models/update_queue_slot200_response'
|
|
|
548
572
|
require 'late-sdk/models/update_queue_slot_request'
|
|
549
573
|
require 'late-sdk/models/update_reddit_subreddits200_response'
|
|
550
574
|
require 'late-sdk/models/update_reddit_subreddits_request'
|
|
575
|
+
require 'late-sdk/models/update_sequence200_response'
|
|
576
|
+
require 'late-sdk/models/update_sequence200_response_sequence'
|
|
551
577
|
require 'late-sdk/models/update_webhook_settings200_response'
|
|
552
578
|
require 'late-sdk/models/update_webhook_settings_request'
|
|
553
579
|
require 'late-sdk/models/update_whats_app_business_profile_request'
|
data/openapi.yaml
CHANGED
|
@@ -14899,7 +14899,24 @@ paths:
|
|
|
14899
14899
|
tags: { type: array, items: { type: string } }
|
|
14900
14900
|
isSubscribed: { type: boolean }
|
|
14901
14901
|
responses:
|
|
14902
|
-
'200':
|
|
14902
|
+
'200':
|
|
14903
|
+
description: Broadcast created
|
|
14904
|
+
content:
|
|
14905
|
+
application/json:
|
|
14906
|
+
schema:
|
|
14907
|
+
type: object
|
|
14908
|
+
properties:
|
|
14909
|
+
success: { type: boolean }
|
|
14910
|
+
broadcast:
|
|
14911
|
+
type: object
|
|
14912
|
+
properties:
|
|
14913
|
+
id: { type: string }
|
|
14914
|
+
name: { type: string }
|
|
14915
|
+
description: { type: string }
|
|
14916
|
+
platform: { type: string }
|
|
14917
|
+
accountId: { type: string }
|
|
14918
|
+
status: { type: string }
|
|
14919
|
+
createdAt: { type: string, format: date-time }
|
|
14903
14920
|
'401': { $ref: '#/components/responses/Unauthorized' }
|
|
14904
14921
|
|
|
14905
14922
|
/v1/broadcasts/{broadcastId}:
|
|
@@ -14910,7 +14927,36 @@ paths:
|
|
|
14910
14927
|
parameters:
|
|
14911
14928
|
- { name: broadcastId, in: path, required: true, schema: { type: string } }
|
|
14912
14929
|
responses:
|
|
14913
|
-
'200':
|
|
14930
|
+
'200':
|
|
14931
|
+
description: Broadcast details with stats
|
|
14932
|
+
content:
|
|
14933
|
+
application/json:
|
|
14934
|
+
schema:
|
|
14935
|
+
type: object
|
|
14936
|
+
properties:
|
|
14937
|
+
success: { type: boolean }
|
|
14938
|
+
broadcast:
|
|
14939
|
+
type: object
|
|
14940
|
+
properties:
|
|
14941
|
+
id: { type: string }
|
|
14942
|
+
name: { type: string }
|
|
14943
|
+
description: { type: string }
|
|
14944
|
+
platform: { type: string }
|
|
14945
|
+
accountId: { type: string }
|
|
14946
|
+
message: { type: object, properties: { text: { type: string } } }
|
|
14947
|
+
template: { type: object, properties: { name: { type: string }, language: { type: string } } }
|
|
14948
|
+
segmentFilters: { type: object, properties: { tags: { type: array, items: { type: string } } } }
|
|
14949
|
+
status: { type: string, enum: [draft, scheduled, sending, completed, failed, cancelled] }
|
|
14950
|
+
scheduledAt: { type: string, format: date-time }
|
|
14951
|
+
startedAt: { type: string, format: date-time }
|
|
14952
|
+
completedAt: { type: string, format: date-time }
|
|
14953
|
+
recipientCount: { type: integer }
|
|
14954
|
+
sentCount: { type: integer }
|
|
14955
|
+
deliveredCount: { type: integer }
|
|
14956
|
+
readCount: { type: integer }
|
|
14957
|
+
failedCount: { type: integer }
|
|
14958
|
+
createdAt: { type: string, format: date-time }
|
|
14959
|
+
updatedAt: { type: string, format: date-time }
|
|
14914
14960
|
'401': { $ref: '#/components/responses/Unauthorized' }
|
|
14915
14961
|
'404': { $ref: '#/components/responses/NotFound' }
|
|
14916
14962
|
patch:
|
|
@@ -14920,7 +14966,22 @@ paths:
|
|
|
14920
14966
|
parameters:
|
|
14921
14967
|
- { name: broadcastId, in: path, required: true, schema: { type: string } }
|
|
14922
14968
|
responses:
|
|
14923
|
-
'200':
|
|
14969
|
+
'200':
|
|
14970
|
+
description: Broadcast updated
|
|
14971
|
+
content:
|
|
14972
|
+
application/json:
|
|
14973
|
+
schema:
|
|
14974
|
+
type: object
|
|
14975
|
+
properties:
|
|
14976
|
+
success: { type: boolean }
|
|
14977
|
+
broadcast:
|
|
14978
|
+
type: object
|
|
14979
|
+
properties:
|
|
14980
|
+
id: { type: string }
|
|
14981
|
+
name: { type: string }
|
|
14982
|
+
description: { type: string }
|
|
14983
|
+
status: { type: string }
|
|
14984
|
+
updatedAt: { type: string, format: date-time }
|
|
14924
14985
|
'401': { $ref: '#/components/responses/Unauthorized' }
|
|
14925
14986
|
'404': { $ref: '#/components/responses/NotFound' }
|
|
14926
14987
|
delete:
|
|
@@ -14975,7 +15036,20 @@ paths:
|
|
|
14975
15036
|
properties:
|
|
14976
15037
|
scheduledAt: { type: string, format: date-time }
|
|
14977
15038
|
responses:
|
|
14978
|
-
'200':
|
|
15039
|
+
'200':
|
|
15040
|
+
description: Broadcast scheduled
|
|
15041
|
+
content:
|
|
15042
|
+
application/json:
|
|
15043
|
+
schema:
|
|
15044
|
+
type: object
|
|
15045
|
+
properties:
|
|
15046
|
+
success: { type: boolean }
|
|
15047
|
+
broadcast:
|
|
15048
|
+
type: object
|
|
15049
|
+
properties:
|
|
15050
|
+
id: { type: string }
|
|
15051
|
+
status: { type: string }
|
|
15052
|
+
scheduledAt: { type: string, format: date-time }
|
|
14979
15053
|
'400': { description: Invalid date or status }
|
|
14980
15054
|
'401': { $ref: '#/components/responses/Unauthorized' }
|
|
14981
15055
|
'404': { $ref: '#/components/responses/NotFound' }
|
|
@@ -14988,7 +15062,19 @@ paths:
|
|
|
14988
15062
|
parameters:
|
|
14989
15063
|
- { name: broadcastId, in: path, required: true, schema: { type: string } }
|
|
14990
15064
|
responses:
|
|
14991
|
-
'200':
|
|
15065
|
+
'200':
|
|
15066
|
+
description: Broadcast cancelled
|
|
15067
|
+
content:
|
|
15068
|
+
application/json:
|
|
15069
|
+
schema:
|
|
15070
|
+
type: object
|
|
15071
|
+
properties:
|
|
15072
|
+
success: { type: boolean }
|
|
15073
|
+
broadcast:
|
|
15074
|
+
type: object
|
|
15075
|
+
properties:
|
|
15076
|
+
id: { type: string }
|
|
15077
|
+
status: { type: string }
|
|
14992
15078
|
'400': { description: Cannot cancel in current status }
|
|
14993
15079
|
'401': { $ref: '#/components/responses/Unauthorized' }
|
|
14994
15080
|
'404': { $ref: '#/components/responses/NotFound' }
|
|
@@ -15004,7 +15090,37 @@ paths:
|
|
|
15004
15090
|
- { name: limit, in: query, schema: { type: integer, default: 50 } }
|
|
15005
15091
|
- { name: skip, in: query, schema: { type: integer, default: 0 } }
|
|
15006
15092
|
responses:
|
|
15007
|
-
'200':
|
|
15093
|
+
'200':
|
|
15094
|
+
description: Recipients list with delivery status
|
|
15095
|
+
content:
|
|
15096
|
+
application/json:
|
|
15097
|
+
schema:
|
|
15098
|
+
type: object
|
|
15099
|
+
properties:
|
|
15100
|
+
success: { type: boolean }
|
|
15101
|
+
recipients:
|
|
15102
|
+
type: array
|
|
15103
|
+
items:
|
|
15104
|
+
type: object
|
|
15105
|
+
properties:
|
|
15106
|
+
id: { type: string }
|
|
15107
|
+
contactId: { type: string }
|
|
15108
|
+
channelId: { type: string }
|
|
15109
|
+
platformIdentifier: { type: string }
|
|
15110
|
+
contactName: { type: string }
|
|
15111
|
+
status: { type: string, enum: [pending, sent, delivered, read, failed] }
|
|
15112
|
+
messageId: { type: string }
|
|
15113
|
+
error: { type: string }
|
|
15114
|
+
sentAt: { type: string, format: date-time }
|
|
15115
|
+
deliveredAt: { type: string, format: date-time }
|
|
15116
|
+
readAt: { type: string, format: date-time }
|
|
15117
|
+
pagination:
|
|
15118
|
+
type: object
|
|
15119
|
+
properties:
|
|
15120
|
+
total: { type: integer }
|
|
15121
|
+
limit: { type: integer }
|
|
15122
|
+
skip: { type: integer }
|
|
15123
|
+
hasMore: { type: boolean }
|
|
15008
15124
|
'401': { $ref: '#/components/responses/Unauthorized' }
|
|
15009
15125
|
'404': { $ref: '#/components/responses/NotFound' }
|
|
15010
15126
|
post:
|
|
@@ -15024,7 +15140,16 @@ paths:
|
|
|
15024
15140
|
phones: { type: array, items: { type: string }, description: Raw phone numbers (auto-creates contacts). Useful for WhatsApp/Telegram manual entry }
|
|
15025
15141
|
useSegment: { type: boolean, description: Auto-populate from broadcast segment filters }
|
|
15026
15142
|
responses:
|
|
15027
|
-
'200':
|
|
15143
|
+
'200':
|
|
15144
|
+
description: Recipients added
|
|
15145
|
+
content:
|
|
15146
|
+
application/json:
|
|
15147
|
+
schema:
|
|
15148
|
+
type: object
|
|
15149
|
+
properties:
|
|
15150
|
+
success: { type: boolean }
|
|
15151
|
+
added: { type: integer, description: Number of recipients successfully added }
|
|
15152
|
+
skipped: { type: integer, description: Number skipped (duplicates or missing channels) }
|
|
15028
15153
|
'401': { $ref: '#/components/responses/Unauthorized' }
|
|
15029
15154
|
'404': { $ref: '#/components/responses/NotFound' }
|
|
15030
15155
|
|
|
@@ -15119,7 +15244,24 @@ paths:
|
|
|
15119
15244
|
exitOnReply: { type: boolean, default: true }
|
|
15120
15245
|
exitOnUnsubscribe: { type: boolean, default: true }
|
|
15121
15246
|
responses:
|
|
15122
|
-
'200':
|
|
15247
|
+
'200':
|
|
15248
|
+
description: Sequence created
|
|
15249
|
+
content:
|
|
15250
|
+
application/json:
|
|
15251
|
+
schema:
|
|
15252
|
+
type: object
|
|
15253
|
+
properties:
|
|
15254
|
+
success: { type: boolean }
|
|
15255
|
+
sequence:
|
|
15256
|
+
type: object
|
|
15257
|
+
properties:
|
|
15258
|
+
id: { type: string }
|
|
15259
|
+
name: { type: string }
|
|
15260
|
+
description: { type: string }
|
|
15261
|
+
platform: { type: string }
|
|
15262
|
+
status: { type: string }
|
|
15263
|
+
stepsCount: { type: integer }
|
|
15264
|
+
createdAt: { type: string, format: date-time }
|
|
15123
15265
|
'401': { $ref: '#/components/responses/Unauthorized' }
|
|
15124
15266
|
|
|
15125
15267
|
/v1/sequences/{sequenceId}:
|
|
@@ -15130,7 +15272,39 @@ paths:
|
|
|
15130
15272
|
parameters:
|
|
15131
15273
|
- { name: sequenceId, in: path, required: true, schema: { type: string } }
|
|
15132
15274
|
responses:
|
|
15133
|
-
'200':
|
|
15275
|
+
'200':
|
|
15276
|
+
description: Sequence details with steps
|
|
15277
|
+
content:
|
|
15278
|
+
application/json:
|
|
15279
|
+
schema:
|
|
15280
|
+
type: object
|
|
15281
|
+
properties:
|
|
15282
|
+
success: { type: boolean }
|
|
15283
|
+
sequence:
|
|
15284
|
+
type: object
|
|
15285
|
+
properties:
|
|
15286
|
+
id: { type: string }
|
|
15287
|
+
name: { type: string }
|
|
15288
|
+
description: { type: string }
|
|
15289
|
+
platform: { type: string }
|
|
15290
|
+
accountId: { type: string }
|
|
15291
|
+
status: { type: string, enum: [draft, active, paused] }
|
|
15292
|
+
steps:
|
|
15293
|
+
type: array
|
|
15294
|
+
items:
|
|
15295
|
+
type: object
|
|
15296
|
+
properties:
|
|
15297
|
+
order: { type: integer }
|
|
15298
|
+
delayMinutes: { type: integer }
|
|
15299
|
+
message: { type: object, properties: { text: { type: string } } }
|
|
15300
|
+
template: { type: object, properties: { name: { type: string }, language: { type: string }, variableMapping: { type: object } } }
|
|
15301
|
+
exitOnReply: { type: boolean }
|
|
15302
|
+
exitOnUnsubscribe: { type: boolean }
|
|
15303
|
+
totalEnrolled: { type: integer }
|
|
15304
|
+
totalCompleted: { type: integer }
|
|
15305
|
+
totalExited: { type: integer }
|
|
15306
|
+
createdAt: { type: string, format: date-time }
|
|
15307
|
+
updatedAt: { type: string, format: date-time }
|
|
15134
15308
|
'401': { $ref: '#/components/responses/Unauthorized' }
|
|
15135
15309
|
'404': { $ref: '#/components/responses/NotFound' }
|
|
15136
15310
|
patch:
|
|
@@ -15140,7 +15314,25 @@ paths:
|
|
|
15140
15314
|
parameters:
|
|
15141
15315
|
- { name: sequenceId, in: path, required: true, schema: { type: string } }
|
|
15142
15316
|
responses:
|
|
15143
|
-
'200':
|
|
15317
|
+
'200':
|
|
15318
|
+
description: Sequence updated
|
|
15319
|
+
content:
|
|
15320
|
+
application/json:
|
|
15321
|
+
schema:
|
|
15322
|
+
type: object
|
|
15323
|
+
properties:
|
|
15324
|
+
success: { type: boolean }
|
|
15325
|
+
sequence:
|
|
15326
|
+
type: object
|
|
15327
|
+
properties:
|
|
15328
|
+
id: { type: string }
|
|
15329
|
+
name: { type: string }
|
|
15330
|
+
description: { type: string }
|
|
15331
|
+
status: { type: string }
|
|
15332
|
+
steps: { type: array, items: { type: object } }
|
|
15333
|
+
exitOnReply: { type: boolean }
|
|
15334
|
+
exitOnUnsubscribe: { type: boolean }
|
|
15335
|
+
updatedAt: { type: string, format: date-time }
|
|
15144
15336
|
'401': { $ref: '#/components/responses/Unauthorized' }
|
|
15145
15337
|
'404': { $ref: '#/components/responses/NotFound' }
|
|
15146
15338
|
delete:
|
|
@@ -15162,7 +15354,19 @@ paths:
|
|
|
15162
15354
|
parameters:
|
|
15163
15355
|
- { name: sequenceId, in: path, required: true, schema: { type: string } }
|
|
15164
15356
|
responses:
|
|
15165
|
-
'200':
|
|
15357
|
+
'200':
|
|
15358
|
+
description: Sequence activated
|
|
15359
|
+
content:
|
|
15360
|
+
application/json:
|
|
15361
|
+
schema:
|
|
15362
|
+
type: object
|
|
15363
|
+
properties:
|
|
15364
|
+
success: { type: boolean }
|
|
15365
|
+
sequence:
|
|
15366
|
+
type: object
|
|
15367
|
+
properties:
|
|
15368
|
+
id: { type: string }
|
|
15369
|
+
status: { type: string }
|
|
15166
15370
|
'400': { description: Invalid status or no steps }
|
|
15167
15371
|
'401': { $ref: '#/components/responses/Unauthorized' }
|
|
15168
15372
|
'404': { $ref: '#/components/responses/NotFound' }
|
|
@@ -15175,7 +15379,19 @@ paths:
|
|
|
15175
15379
|
parameters:
|
|
15176
15380
|
- { name: sequenceId, in: path, required: true, schema: { type: string } }
|
|
15177
15381
|
responses:
|
|
15178
|
-
'200':
|
|
15382
|
+
'200':
|
|
15383
|
+
description: Sequence paused
|
|
15384
|
+
content:
|
|
15385
|
+
application/json:
|
|
15386
|
+
schema:
|
|
15387
|
+
type: object
|
|
15388
|
+
properties:
|
|
15389
|
+
success: { type: boolean }
|
|
15390
|
+
sequence:
|
|
15391
|
+
type: object
|
|
15392
|
+
properties:
|
|
15393
|
+
id: { type: string }
|
|
15394
|
+
status: { type: string }
|
|
15179
15395
|
'400': { description: Sequence is not active }
|
|
15180
15396
|
'401': { $ref: '#/components/responses/Unauthorized' }
|
|
15181
15397
|
'404': { $ref: '#/components/responses/NotFound' }
|
|
@@ -15198,7 +15414,16 @@ paths:
|
|
|
15198
15414
|
contactIds: { type: array, items: { type: string } }
|
|
15199
15415
|
channelIds: { type: array, items: { type: string }, description: Optional. Auto-detected if not provided. }
|
|
15200
15416
|
responses:
|
|
15201
|
-
'200':
|
|
15417
|
+
'200':
|
|
15418
|
+
description: Enrollment results
|
|
15419
|
+
content:
|
|
15420
|
+
application/json:
|
|
15421
|
+
schema:
|
|
15422
|
+
type: object
|
|
15423
|
+
properties:
|
|
15424
|
+
success: { type: boolean }
|
|
15425
|
+
enrolled: { type: integer, description: Number of contacts successfully enrolled }
|
|
15426
|
+
skipped: { type: integer, description: Number skipped (already enrolled or missing channel) }
|
|
15202
15427
|
'401': { $ref: '#/components/responses/Unauthorized' }
|
|
15203
15428
|
'404': { $ref: '#/components/responses/NotFound' }
|
|
15204
15429
|
|
|
@@ -15226,7 +15451,38 @@ paths:
|
|
|
15226
15451
|
- { name: limit, in: query, schema: { type: integer, default: 50 } }
|
|
15227
15452
|
- { name: skip, in: query, schema: { type: integer, default: 0 } }
|
|
15228
15453
|
responses:
|
|
15229
|
-
'200':
|
|
15454
|
+
'200':
|
|
15455
|
+
description: Enrollments list with progress
|
|
15456
|
+
content:
|
|
15457
|
+
application/json:
|
|
15458
|
+
schema:
|
|
15459
|
+
type: object
|
|
15460
|
+
properties:
|
|
15461
|
+
success: { type: boolean }
|
|
15462
|
+
enrollments:
|
|
15463
|
+
type: array
|
|
15464
|
+
items:
|
|
15465
|
+
type: object
|
|
15466
|
+
properties:
|
|
15467
|
+
id: { type: string }
|
|
15468
|
+
contactId: { type: string }
|
|
15469
|
+
channelId: { type: string }
|
|
15470
|
+
platformIdentifier: { type: string }
|
|
15471
|
+
contactName: { type: string }
|
|
15472
|
+
currentStepIndex: { type: integer }
|
|
15473
|
+
status: { type: string, enum: [active, completed, exited, paused] }
|
|
15474
|
+
exitReason: { type: string }
|
|
15475
|
+
nextStepAt: { type: string, format: date-time }
|
|
15476
|
+
stepsSent: { type: integer }
|
|
15477
|
+
lastStepSentAt: { type: string, format: date-time }
|
|
15478
|
+
createdAt: { type: string, format: date-time }
|
|
15479
|
+
pagination:
|
|
15480
|
+
type: object
|
|
15481
|
+
properties:
|
|
15482
|
+
total: { type: integer }
|
|
15483
|
+
limit: { type: integer }
|
|
15484
|
+
skip: { type: integer }
|
|
15485
|
+
hasMore: { type: boolean }
|
|
15230
15486
|
'401': { $ref: '#/components/responses/Unauthorized' }
|
|
15231
15487
|
'404': { $ref: '#/components/responses/NotFound' }
|
|
15232
15488
|
|
|
@@ -37,7 +37,7 @@ describe 'BroadcastsApi' do
|
|
|
37
37
|
# @param broadcast_id
|
|
38
38
|
# @param add_broadcast_recipients_request
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
40
|
-
# @return [
|
|
40
|
+
# @return [AddBroadcastRecipients200Response]
|
|
41
41
|
describe 'add_broadcast_recipients test' do
|
|
42
42
|
it 'should work' do
|
|
43
43
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -48,7 +48,7 @@ describe 'BroadcastsApi' do
|
|
|
48
48
|
# Cancel a broadcast
|
|
49
49
|
# @param broadcast_id
|
|
50
50
|
# @param [Hash] opts the optional parameters
|
|
51
|
-
# @return [
|
|
51
|
+
# @return [CancelBroadcast200Response]
|
|
52
52
|
describe 'cancel_broadcast test' do
|
|
53
53
|
it 'should work' do
|
|
54
54
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -59,7 +59,7 @@ describe 'BroadcastsApi' do
|
|
|
59
59
|
# Create a broadcast draft
|
|
60
60
|
# @param create_broadcast_request
|
|
61
61
|
# @param [Hash] opts the optional parameters
|
|
62
|
-
# @return [
|
|
62
|
+
# @return [CreateBroadcast200Response]
|
|
63
63
|
describe 'create_broadcast test' do
|
|
64
64
|
it 'should work' do
|
|
65
65
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -81,7 +81,7 @@ describe 'BroadcastsApi' do
|
|
|
81
81
|
# Get broadcast details
|
|
82
82
|
# @param broadcast_id
|
|
83
83
|
# @param [Hash] opts the optional parameters
|
|
84
|
-
# @return [
|
|
84
|
+
# @return [GetBroadcast200Response]
|
|
85
85
|
describe 'get_broadcast test' do
|
|
86
86
|
it 'should work' do
|
|
87
87
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -95,7 +95,7 @@ describe 'BroadcastsApi' do
|
|
|
95
95
|
# @option opts [String] :status
|
|
96
96
|
# @option opts [Integer] :limit
|
|
97
97
|
# @option opts [Integer] :skip
|
|
98
|
-
# @return [
|
|
98
|
+
# @return [ListBroadcastRecipients200Response]
|
|
99
99
|
describe 'list_broadcast_recipients test' do
|
|
100
100
|
it 'should work' do
|
|
101
101
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -122,7 +122,7 @@ describe 'BroadcastsApi' do
|
|
|
122
122
|
# @param broadcast_id
|
|
123
123
|
# @param schedule_broadcast_request
|
|
124
124
|
# @param [Hash] opts the optional parameters
|
|
125
|
-
# @return [
|
|
125
|
+
# @return [ScheduleBroadcast200Response]
|
|
126
126
|
describe 'schedule_broadcast test' do
|
|
127
127
|
it 'should work' do
|
|
128
128
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -144,7 +144,7 @@ describe 'BroadcastsApi' do
|
|
|
144
144
|
# Update a broadcast
|
|
145
145
|
# @param broadcast_id
|
|
146
146
|
# @param [Hash] opts the optional parameters
|
|
147
|
-
# @return [
|
|
147
|
+
# @return [UpdateBroadcast200Response]
|
|
148
148
|
describe 'update_broadcast test' do
|
|
149
149
|
it 'should work' do
|
|
150
150
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -36,7 +36,7 @@ describe 'SequencesApi' do
|
|
|
36
36
|
# Activate a sequence
|
|
37
37
|
# @param sequence_id
|
|
38
38
|
# @param [Hash] opts the optional parameters
|
|
39
|
-
# @return [
|
|
39
|
+
# @return [ActivateSequence200Response]
|
|
40
40
|
describe 'activate_sequence test' do
|
|
41
41
|
it 'should work' do
|
|
42
42
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -47,7 +47,7 @@ describe 'SequencesApi' do
|
|
|
47
47
|
# Create a sequence
|
|
48
48
|
# @param create_sequence_request
|
|
49
49
|
# @param [Hash] opts the optional parameters
|
|
50
|
-
# @return [
|
|
50
|
+
# @return [CreateSequence200Response]
|
|
51
51
|
describe 'create_sequence test' do
|
|
52
52
|
it 'should work' do
|
|
53
53
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -70,7 +70,7 @@ describe 'SequencesApi' do
|
|
|
70
70
|
# @param sequence_id
|
|
71
71
|
# @param enroll_contacts_request
|
|
72
72
|
# @param [Hash] opts the optional parameters
|
|
73
|
-
# @return [
|
|
73
|
+
# @return [EnrollContacts200Response]
|
|
74
74
|
describe 'enroll_contacts test' do
|
|
75
75
|
it 'should work' do
|
|
76
76
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -81,7 +81,7 @@ describe 'SequencesApi' do
|
|
|
81
81
|
# Get sequence with steps
|
|
82
82
|
# @param sequence_id
|
|
83
83
|
# @param [Hash] opts the optional parameters
|
|
84
|
-
# @return [
|
|
84
|
+
# @return [GetSequence200Response]
|
|
85
85
|
describe 'get_sequence test' do
|
|
86
86
|
it 'should work' do
|
|
87
87
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -95,7 +95,7 @@ describe 'SequencesApi' do
|
|
|
95
95
|
# @option opts [String] :status
|
|
96
96
|
# @option opts [Integer] :limit
|
|
97
97
|
# @option opts [Integer] :skip
|
|
98
|
-
# @return [
|
|
98
|
+
# @return [ListSequenceEnrollments200Response]
|
|
99
99
|
describe 'list_sequence_enrollments test' do
|
|
100
100
|
it 'should work' do
|
|
101
101
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -120,7 +120,7 @@ describe 'SequencesApi' do
|
|
|
120
120
|
# Pause a sequence
|
|
121
121
|
# @param sequence_id
|
|
122
122
|
# @param [Hash] opts the optional parameters
|
|
123
|
-
# @return [
|
|
123
|
+
# @return [ActivateSequence200Response]
|
|
124
124
|
describe 'pause_sequence test' do
|
|
125
125
|
it 'should work' do
|
|
126
126
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -143,7 +143,7 @@ describe 'SequencesApi' do
|
|
|
143
143
|
# Update a sequence
|
|
144
144
|
# @param sequence_id
|
|
145
145
|
# @param [Hash] opts the optional parameters
|
|
146
|
-
# @return [
|
|
146
|
+
# @return [UpdateSequence200Response]
|
|
147
147
|
describe 'update_sequence test' do
|
|
148
148
|
it 'should work' do
|
|
149
149
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -0,0 +1,42 @@
|
|
|
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 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
require 'date'
|
|
16
|
+
|
|
17
|
+
# Unit tests for Late::ActivateSequence200Response
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Late::ActivateSequence200Response do
|
|
21
|
+
#let(:instance) { Late::ActivateSequence200Response.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of ActivateSequence200Response' do
|
|
24
|
+
it 'should create an instance of ActivateSequence200Response' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Late::ActivateSequence200Response)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "success"' do
|
|
31
|
+
it 'should work' do
|
|
32
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
describe 'test attribute "sequence"' do
|
|
37
|
+
it 'should work' do
|
|
38
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
end
|