late-sdk 0.0.68 → 0.0.70

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.
Files changed (95) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +62 -0
  3. data/docs/AddBroadcastRecipientsRequest.md +20 -0
  4. data/docs/BroadcastsApi.md +699 -0
  5. data/docs/BulkCreateContactsRequest.md +24 -0
  6. data/docs/BulkCreateContactsRequestContactsInner.md +28 -0
  7. data/docs/CommentAutomationsApi.md +430 -0
  8. data/docs/ContactsApi.md +500 -0
  9. data/docs/CreateBroadcastRequest.md +32 -0
  10. data/docs/CreateBroadcastRequestMessage.md +20 -0
  11. data/docs/CreateBroadcastRequestMessageAttachmentsInner.md +22 -0
  12. data/docs/CreateBroadcastRequestSegmentFilters.md +20 -0
  13. data/docs/CreateBroadcastRequestTemplate.md +22 -0
  14. data/docs/CreateCommentAutomationRequest.md +36 -0
  15. data/docs/CreateContactRequest.md +38 -0
  16. data/docs/CreateCustomFieldRequest.md +26 -0
  17. data/docs/CreateSequenceRequest.md +32 -0
  18. data/docs/CreateSequenceRequestStepsInner.md +24 -0
  19. data/docs/CreateSequenceRequestStepsInnerMessage.md +18 -0
  20. data/docs/CustomFieldsApi.md +421 -0
  21. data/docs/EnrollContactsRequest.md +20 -0
  22. data/docs/ListCommentAutomations200Response.md +20 -0
  23. data/docs/ListCommentAutomations200ResponseAutomationsInner.md +42 -0
  24. data/docs/ListCommentAutomations200ResponseAutomationsInnerStats.md +24 -0
  25. data/docs/ScheduleBroadcastRequest.md +18 -0
  26. data/docs/SequencesApi.md +697 -0
  27. data/docs/SetContactFieldValueRequest.md +18 -0
  28. data/docs/UpdateCommentAutomationRequest.md +28 -0
  29. data/docs/UpdateContactRequest.md +32 -0
  30. data/docs/UpdateCustomFieldRequest.md +20 -0
  31. data/docs/WhatsAppApi.md +25 -25
  32. data/lib/late-sdk/api/broadcasts_api.rb +685 -0
  33. data/lib/late-sdk/api/comment_automations_api.rb +416 -0
  34. data/lib/late-sdk/api/contacts_api.rb +499 -0
  35. data/lib/late-sdk/api/custom_fields_api.rb +420 -0
  36. data/lib/late-sdk/api/sequences_api.rb +677 -0
  37. data/lib/late-sdk/api/whats_app_api.rb +50 -50
  38. data/lib/late-sdk/models/add_broadcast_recipients_request.rb +160 -0
  39. data/lib/late-sdk/models/bulk_create_contacts_request.rb +253 -0
  40. data/lib/late-sdk/models/bulk_create_contacts_request_contacts_inner.rb +228 -0
  41. data/lib/late-sdk/models/create_broadcast_request.rb +302 -0
  42. data/lib/late-sdk/models/create_broadcast_request_message.rb +158 -0
  43. data/lib/late-sdk/models/create_broadcast_request_message_attachments_inner.rb +165 -0
  44. data/lib/late-sdk/models/create_broadcast_request_segment_filters.rb +158 -0
  45. data/lib/late-sdk/models/create_broadcast_request_template.rb +168 -0
  46. data/lib/late-sdk/models/create_comment_automation_request.rb +359 -0
  47. data/lib/late-sdk/models/create_contact_request.rb +276 -0
  48. data/lib/late-sdk/models/create_custom_field_request.rb +262 -0
  49. data/lib/late-sdk/models/create_sequence_request.rb +308 -0
  50. data/lib/late-sdk/models/create_sequence_request_steps_inner.rb +208 -0
  51. data/lib/late-sdk/models/create_sequence_request_steps_inner_message.rb +147 -0
  52. data/lib/late-sdk/models/enroll_contacts_request.rb +178 -0
  53. data/lib/late-sdk/models/list_comment_automations200_response.rb +158 -0
  54. data/lib/late-sdk/models/list_comment_automations200_response_automations_inner.rb +303 -0
  55. data/lib/late-sdk/models/list_comment_automations200_response_automations_inner_stats.rb +174 -0
  56. data/lib/late-sdk/models/schedule_broadcast_request.rb +164 -0
  57. data/lib/late-sdk/models/set_contact_field_value_request.rb +150 -0
  58. data/lib/late-sdk/models/update_comment_automation_request.rb +228 -0
  59. data/lib/late-sdk/models/update_contact_request.rb +212 -0
  60. data/lib/late-sdk/models/update_custom_field_request.rb +158 -0
  61. data/lib/late-sdk/version.rb +1 -1
  62. data/lib/late-sdk.rb +28 -0
  63. data/openapi.yaml +809 -13
  64. data/spec/api/broadcasts_api_spec.rb +154 -0
  65. data/spec/api/comment_automations_api_spec.rb +108 -0
  66. data/spec/api/contacts_api_spec.rb +122 -0
  67. data/spec/api/custom_fields_api_spec.rb +105 -0
  68. data/spec/api/sequences_api_spec.rb +153 -0
  69. data/spec/api/whats_app_api_spec.rb +25 -25
  70. data/spec/models/add_broadcast_recipients_request_spec.rb +42 -0
  71. data/spec/models/bulk_create_contacts_request_contacts_inner_spec.rb +66 -0
  72. data/spec/models/bulk_create_contacts_request_spec.rb +54 -0
  73. data/spec/models/create_broadcast_request_message_attachments_inner_spec.rb +48 -0
  74. data/spec/models/create_broadcast_request_message_spec.rb +42 -0
  75. data/spec/models/create_broadcast_request_segment_filters_spec.rb +42 -0
  76. data/spec/models/create_broadcast_request_spec.rb +82 -0
  77. data/spec/models/create_broadcast_request_template_spec.rb +48 -0
  78. data/spec/models/create_comment_automation_request_spec.rb +94 -0
  79. data/spec/models/create_contact_request_spec.rb +96 -0
  80. data/spec/models/create_custom_field_request_spec.rb +64 -0
  81. data/spec/models/create_sequence_request_spec.rb +82 -0
  82. data/spec/models/create_sequence_request_steps_inner_message_spec.rb +36 -0
  83. data/spec/models/create_sequence_request_steps_inner_spec.rb +54 -0
  84. data/spec/models/enroll_contacts_request_spec.rb +42 -0
  85. data/spec/models/list_comment_automations200_response_automations_inner_spec.rb +116 -0
  86. data/spec/models/list_comment_automations200_response_automations_inner_stats_spec.rb +54 -0
  87. data/spec/models/list_comment_automations200_response_spec.rb +42 -0
  88. data/spec/models/schedule_broadcast_request_spec.rb +36 -0
  89. data/spec/models/set_contact_field_value_request_spec.rb +36 -0
  90. data/spec/models/update_comment_automation_request_spec.rb +70 -0
  91. data/spec/models/update_contact_request_spec.rb +78 -0
  92. data/spec/models/update_custom_field_request_spec.rb +42 -0
  93. data/zernio-sdk-0.0.70.gem +0 -0
  94. metadata +114 -2
  95. data/zernio-sdk-0.0.68.gem +0 -0
@@ -0,0 +1,28 @@
1
+ # Late::BulkCreateContactsRequestContactsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | |
8
+ | **platform_identifier** | **String** | | |
9
+ | **display_identifier** | **String** | | [optional] |
10
+ | **email** | **String** | | [optional] |
11
+ | **company** | **String** | | [optional] |
12
+ | **tags** | **Array<String>** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'late-sdk'
18
+
19
+ instance = Late::BulkCreateContactsRequestContactsInner.new(
20
+ name: null,
21
+ platform_identifier: null,
22
+ display_identifier: null,
23
+ email: null,
24
+ company: null,
25
+ tags: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,430 @@
1
+ # Late::CommentAutomationsApi
2
+
3
+ All URIs are relative to *https://zernio.com/api*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_comment_automation**](CommentAutomationsApi.md#create_comment_automation) | **POST** /v1/comment-automations | Create a comment-to-DM automation |
8
+ | [**delete_comment_automation**](CommentAutomationsApi.md#delete_comment_automation) | **DELETE** /v1/comment-automations/{automationId} | Delete automation and all logs |
9
+ | [**get_comment_automation**](CommentAutomationsApi.md#get_comment_automation) | **GET** /v1/comment-automations/{automationId} | Get automation details with recent logs |
10
+ | [**list_comment_automation_logs**](CommentAutomationsApi.md#list_comment_automation_logs) | **GET** /v1/comment-automations/{automationId}/logs | List trigger logs for an automation |
11
+ | [**list_comment_automations**](CommentAutomationsApi.md#list_comment_automations) | **GET** /v1/comment-automations | List comment-to-DM automations |
12
+ | [**update_comment_automation**](CommentAutomationsApi.md#update_comment_automation) | **PATCH** /v1/comment-automations/{automationId} | Update automation settings |
13
+
14
+
15
+ ## create_comment_automation
16
+
17
+ > create_comment_automation(create_comment_automation_request)
18
+
19
+ Create a comment-to-DM automation
20
+
21
+ Create a keyword-triggered DM automation on an Instagram or Facebook post. When someone comments a matching keyword, they automatically receive a DM. Only one active automation per post is allowed.
22
+
23
+ ### Examples
24
+
25
+ ```ruby
26
+ require 'time'
27
+ require 'late-sdk'
28
+ # setup authorization
29
+ Late.configure do |config|
30
+ # Configure Bearer authorization (JWT): bearerAuth
31
+ config.access_token = 'YOUR_BEARER_TOKEN'
32
+ end
33
+
34
+ api_instance = Late::CommentAutomationsApi.new
35
+ create_comment_automation_request = Late::CreateCommentAutomationRequest.new({profile_id: 'profile_id_example', account_id: 'account_id_example', platform_post_id: 'platform_post_id_example', name: 'name_example', dm_message: 'dm_message_example'}) # CreateCommentAutomationRequest |
36
+
37
+ begin
38
+ # Create a comment-to-DM automation
39
+ api_instance.create_comment_automation(create_comment_automation_request)
40
+ rescue Late::ApiError => e
41
+ puts "Error when calling CommentAutomationsApi->create_comment_automation: #{e}"
42
+ end
43
+ ```
44
+
45
+ #### Using the create_comment_automation_with_http_info variant
46
+
47
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
48
+
49
+ > <Array(nil, Integer, Hash)> create_comment_automation_with_http_info(create_comment_automation_request)
50
+
51
+ ```ruby
52
+ begin
53
+ # Create a comment-to-DM automation
54
+ data, status_code, headers = api_instance.create_comment_automation_with_http_info(create_comment_automation_request)
55
+ p status_code # => 2xx
56
+ p headers # => { ... }
57
+ p data # => nil
58
+ rescue Late::ApiError => e
59
+ puts "Error when calling CommentAutomationsApi->create_comment_automation_with_http_info: #{e}"
60
+ end
61
+ ```
62
+
63
+ ### Parameters
64
+
65
+ | Name | Type | Description | Notes |
66
+ | ---- | ---- | ----------- | ----- |
67
+ | **create_comment_automation_request** | [**CreateCommentAutomationRequest**](CreateCommentAutomationRequest.md) | | |
68
+
69
+ ### Return type
70
+
71
+ nil (empty response body)
72
+
73
+ ### Authorization
74
+
75
+ [bearerAuth](../README.md#bearerAuth)
76
+
77
+ ### HTTP request headers
78
+
79
+ - **Content-Type**: application/json
80
+ - **Accept**: application/json
81
+
82
+
83
+ ## delete_comment_automation
84
+
85
+ > delete_comment_automation(automation_id)
86
+
87
+ Delete automation and all logs
88
+
89
+ ### Examples
90
+
91
+ ```ruby
92
+ require 'time'
93
+ require 'late-sdk'
94
+ # setup authorization
95
+ Late.configure do |config|
96
+ # Configure Bearer authorization (JWT): bearerAuth
97
+ config.access_token = 'YOUR_BEARER_TOKEN'
98
+ end
99
+
100
+ api_instance = Late::CommentAutomationsApi.new
101
+ automation_id = 'automation_id_example' # String |
102
+
103
+ begin
104
+ # Delete automation and all logs
105
+ api_instance.delete_comment_automation(automation_id)
106
+ rescue Late::ApiError => e
107
+ puts "Error when calling CommentAutomationsApi->delete_comment_automation: #{e}"
108
+ end
109
+ ```
110
+
111
+ #### Using the delete_comment_automation_with_http_info variant
112
+
113
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
114
+
115
+ > <Array(nil, Integer, Hash)> delete_comment_automation_with_http_info(automation_id)
116
+
117
+ ```ruby
118
+ begin
119
+ # Delete automation and all logs
120
+ data, status_code, headers = api_instance.delete_comment_automation_with_http_info(automation_id)
121
+ p status_code # => 2xx
122
+ p headers # => { ... }
123
+ p data # => nil
124
+ rescue Late::ApiError => e
125
+ puts "Error when calling CommentAutomationsApi->delete_comment_automation_with_http_info: #{e}"
126
+ end
127
+ ```
128
+
129
+ ### Parameters
130
+
131
+ | Name | Type | Description | Notes |
132
+ | ---- | ---- | ----------- | ----- |
133
+ | **automation_id** | **String** | | |
134
+
135
+ ### Return type
136
+
137
+ nil (empty response body)
138
+
139
+ ### Authorization
140
+
141
+ [bearerAuth](../README.md#bearerAuth)
142
+
143
+ ### HTTP request headers
144
+
145
+ - **Content-Type**: Not defined
146
+ - **Accept**: application/json
147
+
148
+
149
+ ## get_comment_automation
150
+
151
+ > get_comment_automation(automation_id)
152
+
153
+ Get automation details with recent logs
154
+
155
+ ### Examples
156
+
157
+ ```ruby
158
+ require 'time'
159
+ require 'late-sdk'
160
+ # setup authorization
161
+ Late.configure do |config|
162
+ # Configure Bearer authorization (JWT): bearerAuth
163
+ config.access_token = 'YOUR_BEARER_TOKEN'
164
+ end
165
+
166
+ api_instance = Late::CommentAutomationsApi.new
167
+ automation_id = 'automation_id_example' # String |
168
+
169
+ begin
170
+ # Get automation details with recent logs
171
+ api_instance.get_comment_automation(automation_id)
172
+ rescue Late::ApiError => e
173
+ puts "Error when calling CommentAutomationsApi->get_comment_automation: #{e}"
174
+ end
175
+ ```
176
+
177
+ #### Using the get_comment_automation_with_http_info variant
178
+
179
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
180
+
181
+ > <Array(nil, Integer, Hash)> get_comment_automation_with_http_info(automation_id)
182
+
183
+ ```ruby
184
+ begin
185
+ # Get automation details with recent logs
186
+ data, status_code, headers = api_instance.get_comment_automation_with_http_info(automation_id)
187
+ p status_code # => 2xx
188
+ p headers # => { ... }
189
+ p data # => nil
190
+ rescue Late::ApiError => e
191
+ puts "Error when calling CommentAutomationsApi->get_comment_automation_with_http_info: #{e}"
192
+ end
193
+ ```
194
+
195
+ ### Parameters
196
+
197
+ | Name | Type | Description | Notes |
198
+ | ---- | ---- | ----------- | ----- |
199
+ | **automation_id** | **String** | | |
200
+
201
+ ### Return type
202
+
203
+ nil (empty response body)
204
+
205
+ ### Authorization
206
+
207
+ [bearerAuth](../README.md#bearerAuth)
208
+
209
+ ### HTTP request headers
210
+
211
+ - **Content-Type**: Not defined
212
+ - **Accept**: application/json
213
+
214
+
215
+ ## list_comment_automation_logs
216
+
217
+ > list_comment_automation_logs(automation_id, opts)
218
+
219
+ List trigger logs for an automation
220
+
221
+ Paginated list of every comment that triggered this automation, with send status and commenter info.
222
+
223
+ ### Examples
224
+
225
+ ```ruby
226
+ require 'time'
227
+ require 'late-sdk'
228
+ # setup authorization
229
+ Late.configure do |config|
230
+ # Configure Bearer authorization (JWT): bearerAuth
231
+ config.access_token = 'YOUR_BEARER_TOKEN'
232
+ end
233
+
234
+ api_instance = Late::CommentAutomationsApi.new
235
+ automation_id = 'automation_id_example' # String |
236
+ opts = {
237
+ status: 'sent', # String | Filter by result status
238
+ limit: 56, # Integer |
239
+ skip: 56 # Integer |
240
+ }
241
+
242
+ begin
243
+ # List trigger logs for an automation
244
+ api_instance.list_comment_automation_logs(automation_id, opts)
245
+ rescue Late::ApiError => e
246
+ puts "Error when calling CommentAutomationsApi->list_comment_automation_logs: #{e}"
247
+ end
248
+ ```
249
+
250
+ #### Using the list_comment_automation_logs_with_http_info variant
251
+
252
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
253
+
254
+ > <Array(nil, Integer, Hash)> list_comment_automation_logs_with_http_info(automation_id, opts)
255
+
256
+ ```ruby
257
+ begin
258
+ # List trigger logs for an automation
259
+ data, status_code, headers = api_instance.list_comment_automation_logs_with_http_info(automation_id, opts)
260
+ p status_code # => 2xx
261
+ p headers # => { ... }
262
+ p data # => nil
263
+ rescue Late::ApiError => e
264
+ puts "Error when calling CommentAutomationsApi->list_comment_automation_logs_with_http_info: #{e}"
265
+ end
266
+ ```
267
+
268
+ ### Parameters
269
+
270
+ | Name | Type | Description | Notes |
271
+ | ---- | ---- | ----------- | ----- |
272
+ | **automation_id** | **String** | | |
273
+ | **status** | **String** | Filter by result status | [optional] |
274
+ | **limit** | **Integer** | | [optional][default to 50] |
275
+ | **skip** | **Integer** | | [optional][default to 0] |
276
+
277
+ ### Return type
278
+
279
+ nil (empty response body)
280
+
281
+ ### Authorization
282
+
283
+ [bearerAuth](../README.md#bearerAuth)
284
+
285
+ ### HTTP request headers
286
+
287
+ - **Content-Type**: Not defined
288
+ - **Accept**: application/json
289
+
290
+
291
+ ## list_comment_automations
292
+
293
+ > <ListCommentAutomations200Response> list_comment_automations(opts)
294
+
295
+ List comment-to-DM automations
296
+
297
+ List all comment-to-DM automations for a profile. Returns automations with their stats.
298
+
299
+ ### Examples
300
+
301
+ ```ruby
302
+ require 'time'
303
+ require 'late-sdk'
304
+ # setup authorization
305
+ Late.configure do |config|
306
+ # Configure Bearer authorization (JWT): bearerAuth
307
+ config.access_token = 'YOUR_BEARER_TOKEN'
308
+ end
309
+
310
+ api_instance = Late::CommentAutomationsApi.new
311
+ opts = {
312
+ profile_id: 'profile_id_example' # String | Filter by profile. Omit to list across all profiles
313
+ }
314
+
315
+ begin
316
+ # List comment-to-DM automations
317
+ result = api_instance.list_comment_automations(opts)
318
+ p result
319
+ rescue Late::ApiError => e
320
+ puts "Error when calling CommentAutomationsApi->list_comment_automations: #{e}"
321
+ end
322
+ ```
323
+
324
+ #### Using the list_comment_automations_with_http_info variant
325
+
326
+ This returns an Array which contains the response data, status code and headers.
327
+
328
+ > <Array(<ListCommentAutomations200Response>, Integer, Hash)> list_comment_automations_with_http_info(opts)
329
+
330
+ ```ruby
331
+ begin
332
+ # List comment-to-DM automations
333
+ data, status_code, headers = api_instance.list_comment_automations_with_http_info(opts)
334
+ p status_code # => 2xx
335
+ p headers # => { ... }
336
+ p data # => <ListCommentAutomations200Response>
337
+ rescue Late::ApiError => e
338
+ puts "Error when calling CommentAutomationsApi->list_comment_automations_with_http_info: #{e}"
339
+ end
340
+ ```
341
+
342
+ ### Parameters
343
+
344
+ | Name | Type | Description | Notes |
345
+ | ---- | ---- | ----------- | ----- |
346
+ | **profile_id** | **String** | Filter by profile. Omit to list across all profiles | [optional] |
347
+
348
+ ### Return type
349
+
350
+ [**ListCommentAutomations200Response**](ListCommentAutomations200Response.md)
351
+
352
+ ### Authorization
353
+
354
+ [bearerAuth](../README.md#bearerAuth)
355
+
356
+ ### HTTP request headers
357
+
358
+ - **Content-Type**: Not defined
359
+ - **Accept**: application/json
360
+
361
+
362
+ ## update_comment_automation
363
+
364
+ > update_comment_automation(automation_id, opts)
365
+
366
+ Update automation settings
367
+
368
+ ### Examples
369
+
370
+ ```ruby
371
+ require 'time'
372
+ require 'late-sdk'
373
+ # setup authorization
374
+ Late.configure do |config|
375
+ # Configure Bearer authorization (JWT): bearerAuth
376
+ config.access_token = 'YOUR_BEARER_TOKEN'
377
+ end
378
+
379
+ api_instance = Late::CommentAutomationsApi.new
380
+ automation_id = 'automation_id_example' # String |
381
+ opts = {
382
+ update_comment_automation_request: Late::UpdateCommentAutomationRequest.new # UpdateCommentAutomationRequest |
383
+ }
384
+
385
+ begin
386
+ # Update automation settings
387
+ api_instance.update_comment_automation(automation_id, opts)
388
+ rescue Late::ApiError => e
389
+ puts "Error when calling CommentAutomationsApi->update_comment_automation: #{e}"
390
+ end
391
+ ```
392
+
393
+ #### Using the update_comment_automation_with_http_info variant
394
+
395
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
396
+
397
+ > <Array(nil, Integer, Hash)> update_comment_automation_with_http_info(automation_id, opts)
398
+
399
+ ```ruby
400
+ begin
401
+ # Update automation settings
402
+ data, status_code, headers = api_instance.update_comment_automation_with_http_info(automation_id, opts)
403
+ p status_code # => 2xx
404
+ p headers # => { ... }
405
+ p data # => nil
406
+ rescue Late::ApiError => e
407
+ puts "Error when calling CommentAutomationsApi->update_comment_automation_with_http_info: #{e}"
408
+ end
409
+ ```
410
+
411
+ ### Parameters
412
+
413
+ | Name | Type | Description | Notes |
414
+ | ---- | ---- | ----------- | ----- |
415
+ | **automation_id** | **String** | | |
416
+ | **update_comment_automation_request** | [**UpdateCommentAutomationRequest**](UpdateCommentAutomationRequest.md) | | [optional] |
417
+
418
+ ### Return type
419
+
420
+ nil (empty response body)
421
+
422
+ ### Authorization
423
+
424
+ [bearerAuth](../README.md#bearerAuth)
425
+
426
+ ### HTTP request headers
427
+
428
+ - **Content-Type**: application/json
429
+ - **Accept**: application/json
430
+