late-sdk 0.0.67 → 0.0.69
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +63 -0
- data/docs/AddBroadcastRecipientsRequest.md +20 -0
- data/docs/BroadcastsApi.md +699 -0
- data/docs/BulkCreateContactsRequest.md +24 -0
- data/docs/BulkCreateContactsRequestContactsInner.md +28 -0
- data/docs/CommentAutomationsApi.md +428 -0
- data/docs/ContactsApi.md +500 -0
- data/docs/CreateBroadcastRequest.md +32 -0
- data/docs/CreateBroadcastRequestMessage.md +20 -0
- data/docs/CreateBroadcastRequestMessageAttachmentsInner.md +22 -0
- data/docs/CreateBroadcastRequestSegmentFilters.md +20 -0
- data/docs/CreateBroadcastRequestTemplate.md +22 -0
- data/docs/CreateCommentAutomationRequest.md +36 -0
- data/docs/CreateContactRequest.md +38 -0
- data/docs/CreateCustomFieldRequest.md +26 -0
- data/docs/CreateSequenceRequest.md +32 -0
- data/docs/CreateSequenceRequestStepsInner.md +24 -0
- data/docs/CreateSequenceRequestStepsInnerMessage.md +18 -0
- data/docs/CustomFieldsApi.md +419 -0
- data/docs/EnrollContactsRequest.md +20 -0
- data/docs/ListCommentAutomations200Response.md +20 -0
- data/docs/ListCommentAutomations200ResponseAutomationsInner.md +42 -0
- data/docs/ListCommentAutomations200ResponseAutomationsInnerStats.md +24 -0
- data/docs/ScheduleBroadcastRequest.md +18 -0
- data/docs/SequencesApi.md +697 -0
- data/docs/SetContactFieldValueRequest.md +18 -0
- data/docs/TwitterPlatformData.md +3 -1
- data/docs/TwitterPlatformDataPoll.md +20 -0
- data/docs/UpdateCommentAutomationRequest.md +28 -0
- data/docs/UpdateContactRequest.md +32 -0
- data/docs/UpdateCustomFieldRequest.md +20 -0
- data/docs/WhatsAppApi.md +25 -25
- data/lib/late-sdk/api/broadcasts_api.rb +689 -0
- data/lib/late-sdk/api/comment_automations_api.rb +420 -0
- data/lib/late-sdk/api/contacts_api.rb +503 -0
- data/lib/late-sdk/api/custom_fields_api.rb +424 -0
- data/lib/late-sdk/api/sequences_api.rb +681 -0
- data/lib/late-sdk/api/whats_app_api.rb +50 -50
- data/lib/late-sdk/models/add_broadcast_recipients_request.rb +160 -0
- data/lib/late-sdk/models/bulk_create_contacts_request.rb +253 -0
- data/lib/late-sdk/models/bulk_create_contacts_request_contacts_inner.rb +228 -0
- data/lib/late-sdk/models/create_broadcast_request.rb +302 -0
- data/lib/late-sdk/models/create_broadcast_request_message.rb +158 -0
- data/lib/late-sdk/models/create_broadcast_request_message_attachments_inner.rb +165 -0
- data/lib/late-sdk/models/create_broadcast_request_segment_filters.rb +158 -0
- data/lib/late-sdk/models/create_broadcast_request_template.rb +168 -0
- data/lib/late-sdk/models/create_comment_automation_request.rb +359 -0
- data/lib/late-sdk/models/create_contact_request.rb +276 -0
- data/lib/late-sdk/models/create_custom_field_request.rb +262 -0
- data/lib/late-sdk/models/create_sequence_request.rb +308 -0
- data/lib/late-sdk/models/create_sequence_request_steps_inner.rb +208 -0
- data/lib/late-sdk/models/create_sequence_request_steps_inner_message.rb +147 -0
- data/lib/late-sdk/models/enroll_contacts_request.rb +178 -0
- data/lib/late-sdk/models/list_comment_automations200_response.rb +158 -0
- data/lib/late-sdk/models/list_comment_automations200_response_automations_inner.rb +303 -0
- data/lib/late-sdk/models/list_comment_automations200_response_automations_inner_stats.rb +174 -0
- data/lib/late-sdk/models/schedule_broadcast_request.rb +164 -0
- data/lib/late-sdk/models/set_contact_field_value_request.rb +150 -0
- data/lib/late-sdk/models/twitter_platform_data.rb +13 -4
- data/lib/late-sdk/models/twitter_platform_data_poll.rb +231 -0
- data/lib/late-sdk/models/update_comment_automation_request.rb +228 -0
- data/lib/late-sdk/models/update_contact_request.rb +212 -0
- data/lib/late-sdk/models/update_custom_field_request.rb +158 -0
- data/lib/late-sdk/version.rb +1 -1
- data/lib/late-sdk.rb +29 -0
- data/openapi.yaml +830 -13
- data/spec/api/broadcasts_api_spec.rb +154 -0
- data/spec/api/comment_automations_api_spec.rb +108 -0
- data/spec/api/contacts_api_spec.rb +122 -0
- data/spec/api/custom_fields_api_spec.rb +105 -0
- data/spec/api/sequences_api_spec.rb +153 -0
- data/spec/api/whats_app_api_spec.rb +25 -25
- data/spec/models/add_broadcast_recipients_request_spec.rb +42 -0
- data/spec/models/bulk_create_contacts_request_contacts_inner_spec.rb +66 -0
- data/spec/models/bulk_create_contacts_request_spec.rb +54 -0
- data/spec/models/create_broadcast_request_message_attachments_inner_spec.rb +48 -0
- data/spec/models/create_broadcast_request_message_spec.rb +42 -0
- data/spec/models/create_broadcast_request_segment_filters_spec.rb +42 -0
- data/spec/models/create_broadcast_request_spec.rb +82 -0
- data/spec/models/create_broadcast_request_template_spec.rb +48 -0
- data/spec/models/create_comment_automation_request_spec.rb +94 -0
- data/spec/models/create_contact_request_spec.rb +96 -0
- data/spec/models/create_custom_field_request_spec.rb +64 -0
- data/spec/models/create_sequence_request_spec.rb +82 -0
- data/spec/models/create_sequence_request_steps_inner_message_spec.rb +36 -0
- data/spec/models/create_sequence_request_steps_inner_spec.rb +54 -0
- data/spec/models/enroll_contacts_request_spec.rb +42 -0
- data/spec/models/list_comment_automations200_response_automations_inner_spec.rb +116 -0
- data/spec/models/list_comment_automations200_response_automations_inner_stats_spec.rb +54 -0
- data/spec/models/list_comment_automations200_response_spec.rb +42 -0
- data/spec/models/schedule_broadcast_request_spec.rb +36 -0
- data/spec/models/set_contact_field_value_request_spec.rb +36 -0
- data/spec/models/twitter_platform_data_poll_spec.rb +42 -0
- data/spec/models/twitter_platform_data_spec.rb +6 -0
- data/spec/models/update_comment_automation_request_spec.rb +70 -0
- data/spec/models/update_contact_request_spec.rb +78 -0
- data/spec/models/update_custom_field_request_spec.rb +42 -0
- data/zernio-sdk-0.0.69.gem +0 -0
- metadata +118 -2
- data/zernio-sdk-0.0.67.gem +0 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Late::CreateCustomFieldRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **profile_id** | **String** | | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
| **slug** | **String** | Auto-generated from name if not provided | [optional] |
|
|
10
|
+
| **type** | **String** | | |
|
|
11
|
+
| **options** | **Array<String>** | Required for select type | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'late-sdk'
|
|
17
|
+
|
|
18
|
+
instance = Late::CreateCustomFieldRequest.new(
|
|
19
|
+
profile_id: null,
|
|
20
|
+
name: null,
|
|
21
|
+
slug: null,
|
|
22
|
+
type: null,
|
|
23
|
+
options: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Late::CreateSequenceRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **profile_id** | **String** | | |
|
|
8
|
+
| **account_id** | **String** | | |
|
|
9
|
+
| **platform** | **String** | | |
|
|
10
|
+
| **name** | **String** | | |
|
|
11
|
+
| **description** | **String** | | [optional] |
|
|
12
|
+
| **steps** | [**Array<CreateSequenceRequestStepsInner>**](CreateSequenceRequestStepsInner.md) | | [optional] |
|
|
13
|
+
| **exit_on_reply** | **Boolean** | | [optional][default to true] |
|
|
14
|
+
| **exit_on_unsubscribe** | **Boolean** | | [optional][default to true] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'late-sdk'
|
|
20
|
+
|
|
21
|
+
instance = Late::CreateSequenceRequest.new(
|
|
22
|
+
profile_id: null,
|
|
23
|
+
account_id: null,
|
|
24
|
+
platform: null,
|
|
25
|
+
name: null,
|
|
26
|
+
description: null,
|
|
27
|
+
steps: null,
|
|
28
|
+
exit_on_reply: null,
|
|
29
|
+
exit_on_unsubscribe: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Late::CreateSequenceRequestStepsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **order** | **Integer** | | |
|
|
8
|
+
| **delay_minutes** | **Integer** | | |
|
|
9
|
+
| **message** | [**CreateSequenceRequestStepsInnerMessage**](CreateSequenceRequestStepsInnerMessage.md) | | [optional] |
|
|
10
|
+
| **template** | [**GetWhatsAppBroadcasts200ResponseBroadcastsInnerTemplate**](GetWhatsAppBroadcasts200ResponseBroadcastsInnerTemplate.md) | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'late-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Late::CreateSequenceRequestStepsInner.new(
|
|
18
|
+
order: null,
|
|
19
|
+
delay_minutes: null,
|
|
20
|
+
message: null,
|
|
21
|
+
template: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Late::CreateSequenceRequestStepsInnerMessage
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **text** | **String** | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'late-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Late::CreateSequenceRequestStepsInnerMessage.new(
|
|
15
|
+
text: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,419 @@
|
|
|
1
|
+
# Late::CustomFieldsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://zernio.com/api*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**clear_contact_field_value**](CustomFieldsApi.md#clear_contact_field_value) | **DELETE** /v1/contacts/{contactId}/fields/{slug} | Clear a custom field value |
|
|
8
|
+
| [**create_custom_field**](CustomFieldsApi.md#create_custom_field) | **POST** /v1/custom-fields | Create a custom field definition |
|
|
9
|
+
| [**delete_custom_field**](CustomFieldsApi.md#delete_custom_field) | **DELETE** /v1/custom-fields/{fieldId} | Delete a custom field definition |
|
|
10
|
+
| [**list_custom_fields**](CustomFieldsApi.md#list_custom_fields) | **GET** /v1/custom-fields | List custom field definitions |
|
|
11
|
+
| [**set_contact_field_value**](CustomFieldsApi.md#set_contact_field_value) | **PUT** /v1/contacts/{contactId}/fields/{slug} | Set a custom field value |
|
|
12
|
+
| [**update_custom_field**](CustomFieldsApi.md#update_custom_field) | **PATCH** /v1/custom-fields/{fieldId} | Update a custom field definition |
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## clear_contact_field_value
|
|
16
|
+
|
|
17
|
+
> clear_contact_field_value(contact_id, slug)
|
|
18
|
+
|
|
19
|
+
Clear a custom field value
|
|
20
|
+
|
|
21
|
+
### Examples
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'time'
|
|
25
|
+
require 'late-sdk'
|
|
26
|
+
# setup authorization
|
|
27
|
+
Late.configure do |config|
|
|
28
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
29
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
api_instance = Late::CustomFieldsApi.new
|
|
33
|
+
contact_id = 'contact_id_example' # String |
|
|
34
|
+
slug = 'slug_example' # String |
|
|
35
|
+
|
|
36
|
+
begin
|
|
37
|
+
# Clear a custom field value
|
|
38
|
+
api_instance.clear_contact_field_value(contact_id, slug)
|
|
39
|
+
rescue Late::ApiError => e
|
|
40
|
+
puts "Error when calling CustomFieldsApi->clear_contact_field_value: #{e}"
|
|
41
|
+
end
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
#### Using the clear_contact_field_value_with_http_info variant
|
|
45
|
+
|
|
46
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
47
|
+
|
|
48
|
+
> <Array(nil, Integer, Hash)> clear_contact_field_value_with_http_info(contact_id, slug)
|
|
49
|
+
|
|
50
|
+
```ruby
|
|
51
|
+
begin
|
|
52
|
+
# Clear a custom field value
|
|
53
|
+
data, status_code, headers = api_instance.clear_contact_field_value_with_http_info(contact_id, slug)
|
|
54
|
+
p status_code # => 2xx
|
|
55
|
+
p headers # => { ... }
|
|
56
|
+
p data # => nil
|
|
57
|
+
rescue Late::ApiError => e
|
|
58
|
+
puts "Error when calling CustomFieldsApi->clear_contact_field_value_with_http_info: #{e}"
|
|
59
|
+
end
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Parameters
|
|
63
|
+
|
|
64
|
+
| Name | Type | Description | Notes |
|
|
65
|
+
| ---- | ---- | ----------- | ----- |
|
|
66
|
+
| **contact_id** | **String** | | |
|
|
67
|
+
| **slug** | **String** | | |
|
|
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**: Not defined
|
|
80
|
+
- **Accept**: application/json
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
## create_custom_field
|
|
84
|
+
|
|
85
|
+
> create_custom_field(create_custom_field_request)
|
|
86
|
+
|
|
87
|
+
Create a custom field definition
|
|
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::CustomFieldsApi.new
|
|
101
|
+
create_custom_field_request = Late::CreateCustomFieldRequest.new({profile_id: 'profile_id_example', name: 'name_example', type: 'text'}) # CreateCustomFieldRequest |
|
|
102
|
+
|
|
103
|
+
begin
|
|
104
|
+
# Create a custom field definition
|
|
105
|
+
api_instance.create_custom_field(create_custom_field_request)
|
|
106
|
+
rescue Late::ApiError => e
|
|
107
|
+
puts "Error when calling CustomFieldsApi->create_custom_field: #{e}"
|
|
108
|
+
end
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
#### Using the create_custom_field_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)> create_custom_field_with_http_info(create_custom_field_request)
|
|
116
|
+
|
|
117
|
+
```ruby
|
|
118
|
+
begin
|
|
119
|
+
# Create a custom field definition
|
|
120
|
+
data, status_code, headers = api_instance.create_custom_field_with_http_info(create_custom_field_request)
|
|
121
|
+
p status_code # => 2xx
|
|
122
|
+
p headers # => { ... }
|
|
123
|
+
p data # => nil
|
|
124
|
+
rescue Late::ApiError => e
|
|
125
|
+
puts "Error when calling CustomFieldsApi->create_custom_field_with_http_info: #{e}"
|
|
126
|
+
end
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### Parameters
|
|
130
|
+
|
|
131
|
+
| Name | Type | Description | Notes |
|
|
132
|
+
| ---- | ---- | ----------- | ----- |
|
|
133
|
+
| **create_custom_field_request** | [**CreateCustomFieldRequest**](CreateCustomFieldRequest.md) | | |
|
|
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**: application/json
|
|
146
|
+
- **Accept**: application/json
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
## delete_custom_field
|
|
150
|
+
|
|
151
|
+
> delete_custom_field(field_id)
|
|
152
|
+
|
|
153
|
+
Delete a custom field definition
|
|
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::CustomFieldsApi.new
|
|
167
|
+
field_id = 'field_id_example' # String |
|
|
168
|
+
|
|
169
|
+
begin
|
|
170
|
+
# Delete a custom field definition
|
|
171
|
+
api_instance.delete_custom_field(field_id)
|
|
172
|
+
rescue Late::ApiError => e
|
|
173
|
+
puts "Error when calling CustomFieldsApi->delete_custom_field: #{e}"
|
|
174
|
+
end
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
#### Using the delete_custom_field_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)> delete_custom_field_with_http_info(field_id)
|
|
182
|
+
|
|
183
|
+
```ruby
|
|
184
|
+
begin
|
|
185
|
+
# Delete a custom field definition
|
|
186
|
+
data, status_code, headers = api_instance.delete_custom_field_with_http_info(field_id)
|
|
187
|
+
p status_code # => 2xx
|
|
188
|
+
p headers # => { ... }
|
|
189
|
+
p data # => nil
|
|
190
|
+
rescue Late::ApiError => e
|
|
191
|
+
puts "Error when calling CustomFieldsApi->delete_custom_field_with_http_info: #{e}"
|
|
192
|
+
end
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### Parameters
|
|
196
|
+
|
|
197
|
+
| Name | Type | Description | Notes |
|
|
198
|
+
| ---- | ---- | ----------- | ----- |
|
|
199
|
+
| **field_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_custom_fields
|
|
216
|
+
|
|
217
|
+
> list_custom_fields(profile_id)
|
|
218
|
+
|
|
219
|
+
List custom field definitions
|
|
220
|
+
|
|
221
|
+
### Examples
|
|
222
|
+
|
|
223
|
+
```ruby
|
|
224
|
+
require 'time'
|
|
225
|
+
require 'late-sdk'
|
|
226
|
+
# setup authorization
|
|
227
|
+
Late.configure do |config|
|
|
228
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
229
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
230
|
+
end
|
|
231
|
+
|
|
232
|
+
api_instance = Late::CustomFieldsApi.new
|
|
233
|
+
profile_id = 'profile_id_example' # String |
|
|
234
|
+
|
|
235
|
+
begin
|
|
236
|
+
# List custom field definitions
|
|
237
|
+
api_instance.list_custom_fields(profile_id)
|
|
238
|
+
rescue Late::ApiError => e
|
|
239
|
+
puts "Error when calling CustomFieldsApi->list_custom_fields: #{e}"
|
|
240
|
+
end
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
#### Using the list_custom_fields_with_http_info variant
|
|
244
|
+
|
|
245
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
246
|
+
|
|
247
|
+
> <Array(nil, Integer, Hash)> list_custom_fields_with_http_info(profile_id)
|
|
248
|
+
|
|
249
|
+
```ruby
|
|
250
|
+
begin
|
|
251
|
+
# List custom field definitions
|
|
252
|
+
data, status_code, headers = api_instance.list_custom_fields_with_http_info(profile_id)
|
|
253
|
+
p status_code # => 2xx
|
|
254
|
+
p headers # => { ... }
|
|
255
|
+
p data # => nil
|
|
256
|
+
rescue Late::ApiError => e
|
|
257
|
+
puts "Error when calling CustomFieldsApi->list_custom_fields_with_http_info: #{e}"
|
|
258
|
+
end
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### Parameters
|
|
262
|
+
|
|
263
|
+
| Name | Type | Description | Notes |
|
|
264
|
+
| ---- | ---- | ----------- | ----- |
|
|
265
|
+
| **profile_id** | **String** | | |
|
|
266
|
+
|
|
267
|
+
### Return type
|
|
268
|
+
|
|
269
|
+
nil (empty response body)
|
|
270
|
+
|
|
271
|
+
### Authorization
|
|
272
|
+
|
|
273
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
274
|
+
|
|
275
|
+
### HTTP request headers
|
|
276
|
+
|
|
277
|
+
- **Content-Type**: Not defined
|
|
278
|
+
- **Accept**: application/json
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
## set_contact_field_value
|
|
282
|
+
|
|
283
|
+
> set_contact_field_value(contact_id, slug, set_contact_field_value_request)
|
|
284
|
+
|
|
285
|
+
Set a custom field value
|
|
286
|
+
|
|
287
|
+
### Examples
|
|
288
|
+
|
|
289
|
+
```ruby
|
|
290
|
+
require 'time'
|
|
291
|
+
require 'late-sdk'
|
|
292
|
+
# setup authorization
|
|
293
|
+
Late.configure do |config|
|
|
294
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
295
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
296
|
+
end
|
|
297
|
+
|
|
298
|
+
api_instance = Late::CustomFieldsApi.new
|
|
299
|
+
contact_id = 'contact_id_example' # String |
|
|
300
|
+
slug = 'slug_example' # String |
|
|
301
|
+
set_contact_field_value_request = Late::SetContactFieldValueRequest.new({value: 3.56}) # SetContactFieldValueRequest |
|
|
302
|
+
|
|
303
|
+
begin
|
|
304
|
+
# Set a custom field value
|
|
305
|
+
api_instance.set_contact_field_value(contact_id, slug, set_contact_field_value_request)
|
|
306
|
+
rescue Late::ApiError => e
|
|
307
|
+
puts "Error when calling CustomFieldsApi->set_contact_field_value: #{e}"
|
|
308
|
+
end
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
#### Using the set_contact_field_value_with_http_info variant
|
|
312
|
+
|
|
313
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
314
|
+
|
|
315
|
+
> <Array(nil, Integer, Hash)> set_contact_field_value_with_http_info(contact_id, slug, set_contact_field_value_request)
|
|
316
|
+
|
|
317
|
+
```ruby
|
|
318
|
+
begin
|
|
319
|
+
# Set a custom field value
|
|
320
|
+
data, status_code, headers = api_instance.set_contact_field_value_with_http_info(contact_id, slug, set_contact_field_value_request)
|
|
321
|
+
p status_code # => 2xx
|
|
322
|
+
p headers # => { ... }
|
|
323
|
+
p data # => nil
|
|
324
|
+
rescue Late::ApiError => e
|
|
325
|
+
puts "Error when calling CustomFieldsApi->set_contact_field_value_with_http_info: #{e}"
|
|
326
|
+
end
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
### Parameters
|
|
330
|
+
|
|
331
|
+
| Name | Type | Description | Notes |
|
|
332
|
+
| ---- | ---- | ----------- | ----- |
|
|
333
|
+
| **contact_id** | **String** | | |
|
|
334
|
+
| **slug** | **String** | | |
|
|
335
|
+
| **set_contact_field_value_request** | [**SetContactFieldValueRequest**](SetContactFieldValueRequest.md) | | |
|
|
336
|
+
|
|
337
|
+
### Return type
|
|
338
|
+
|
|
339
|
+
nil (empty response body)
|
|
340
|
+
|
|
341
|
+
### Authorization
|
|
342
|
+
|
|
343
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
344
|
+
|
|
345
|
+
### HTTP request headers
|
|
346
|
+
|
|
347
|
+
- **Content-Type**: application/json
|
|
348
|
+
- **Accept**: application/json
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
## update_custom_field
|
|
352
|
+
|
|
353
|
+
> update_custom_field(field_id, opts)
|
|
354
|
+
|
|
355
|
+
Update a custom field definition
|
|
356
|
+
|
|
357
|
+
### Examples
|
|
358
|
+
|
|
359
|
+
```ruby
|
|
360
|
+
require 'time'
|
|
361
|
+
require 'late-sdk'
|
|
362
|
+
# setup authorization
|
|
363
|
+
Late.configure do |config|
|
|
364
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
365
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
366
|
+
end
|
|
367
|
+
|
|
368
|
+
api_instance = Late::CustomFieldsApi.new
|
|
369
|
+
field_id = 'field_id_example' # String |
|
|
370
|
+
opts = {
|
|
371
|
+
update_custom_field_request: Late::UpdateCustomFieldRequest.new # UpdateCustomFieldRequest |
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
begin
|
|
375
|
+
# Update a custom field definition
|
|
376
|
+
api_instance.update_custom_field(field_id, opts)
|
|
377
|
+
rescue Late::ApiError => e
|
|
378
|
+
puts "Error when calling CustomFieldsApi->update_custom_field: #{e}"
|
|
379
|
+
end
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
#### Using the update_custom_field_with_http_info variant
|
|
383
|
+
|
|
384
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
385
|
+
|
|
386
|
+
> <Array(nil, Integer, Hash)> update_custom_field_with_http_info(field_id, opts)
|
|
387
|
+
|
|
388
|
+
```ruby
|
|
389
|
+
begin
|
|
390
|
+
# Update a custom field definition
|
|
391
|
+
data, status_code, headers = api_instance.update_custom_field_with_http_info(field_id, opts)
|
|
392
|
+
p status_code # => 2xx
|
|
393
|
+
p headers # => { ... }
|
|
394
|
+
p data # => nil
|
|
395
|
+
rescue Late::ApiError => e
|
|
396
|
+
puts "Error when calling CustomFieldsApi->update_custom_field_with_http_info: #{e}"
|
|
397
|
+
end
|
|
398
|
+
```
|
|
399
|
+
|
|
400
|
+
### Parameters
|
|
401
|
+
|
|
402
|
+
| Name | Type | Description | Notes |
|
|
403
|
+
| ---- | ---- | ----------- | ----- |
|
|
404
|
+
| **field_id** | **String** | | |
|
|
405
|
+
| **update_custom_field_request** | [**UpdateCustomFieldRequest**](UpdateCustomFieldRequest.md) | | [optional] |
|
|
406
|
+
|
|
407
|
+
### Return type
|
|
408
|
+
|
|
409
|
+
nil (empty response body)
|
|
410
|
+
|
|
411
|
+
### Authorization
|
|
412
|
+
|
|
413
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
414
|
+
|
|
415
|
+
### HTTP request headers
|
|
416
|
+
|
|
417
|
+
- **Content-Type**: application/json
|
|
418
|
+
- **Accept**: application/json
|
|
419
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::EnrollContactsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **contact_ids** | **Array<String>** | | |
|
|
8
|
+
| **channel_ids** | **Array<String>** | Optional. Auto-detected if not provided. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::EnrollContactsRequest.new(
|
|
16
|
+
contact_ids: null,
|
|
17
|
+
channel_ids: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::ListCommentAutomations200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | [optional] |
|
|
8
|
+
| **automations** | [**Array<ListCommentAutomations200ResponseAutomationsInner>**](ListCommentAutomations200ResponseAutomationsInner.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::ListCommentAutomations200Response.new(
|
|
16
|
+
success: null,
|
|
17
|
+
automations: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Late::ListCommentAutomations200ResponseAutomationsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **name** | **String** | | [optional] |
|
|
9
|
+
| **platform** | **String** | | [optional] |
|
|
10
|
+
| **account_id** | **String** | | [optional] |
|
|
11
|
+
| **platform_post_id** | **String** | | [optional] |
|
|
12
|
+
| **post_title** | **String** | | [optional] |
|
|
13
|
+
| **keywords** | **Array<String>** | | [optional] |
|
|
14
|
+
| **match_mode** | **String** | | [optional] |
|
|
15
|
+
| **dm_message** | **String** | | [optional] |
|
|
16
|
+
| **comment_reply** | **String** | | [optional] |
|
|
17
|
+
| **is_active** | **Boolean** | | [optional] |
|
|
18
|
+
| **stats** | [**ListCommentAutomations200ResponseAutomationsInnerStats**](ListCommentAutomations200ResponseAutomationsInnerStats.md) | | [optional] |
|
|
19
|
+
| **created_at** | **Time** | | [optional] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'late-sdk'
|
|
25
|
+
|
|
26
|
+
instance = Late::ListCommentAutomations200ResponseAutomationsInner.new(
|
|
27
|
+
id: null,
|
|
28
|
+
name: null,
|
|
29
|
+
platform: null,
|
|
30
|
+
account_id: null,
|
|
31
|
+
platform_post_id: null,
|
|
32
|
+
post_title: null,
|
|
33
|
+
keywords: null,
|
|
34
|
+
match_mode: null,
|
|
35
|
+
dm_message: null,
|
|
36
|
+
comment_reply: null,
|
|
37
|
+
is_active: null,
|
|
38
|
+
stats: null,
|
|
39
|
+
created_at: null
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Late::ListCommentAutomations200ResponseAutomationsInnerStats
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **triggered** | **Integer** | | [optional] |
|
|
8
|
+
| **dms_sent** | **Integer** | | [optional] |
|
|
9
|
+
| **dms_failed** | **Integer** | | [optional] |
|
|
10
|
+
| **unique_contacts** | **Integer** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'late-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Late::ListCommentAutomations200ResponseAutomationsInnerStats.new(
|
|
18
|
+
triggered: null,
|
|
19
|
+
dms_sent: null,
|
|
20
|
+
dms_failed: null,
|
|
21
|
+
unique_contacts: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Late::ScheduleBroadcastRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **scheduled_at** | **Time** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'late-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Late::ScheduleBroadcastRequest.new(
|
|
15
|
+
scheduled_at: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|