zernio 0.0.76

API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200

# \QueueApi

All URIs are relative to *https://zernio.com/api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_queue_slot**](QueueApi.md#create_queue_slot) | **POST** /v1/queue/slots | Create schedule
[**delete_queue_slot**](QueueApi.md#delete_queue_slot) | **DELETE** /v1/queue/slots | Delete schedule
[**get_next_queue_slot**](QueueApi.md#get_next_queue_slot) | **GET** /v1/queue/next-slot | Get next available slot
[**list_queue_slots**](QueueApi.md#list_queue_slots) | **GET** /v1/queue/slots | List schedules
[**preview_queue**](QueueApi.md#preview_queue) | **GET** /v1/queue/preview | Preview upcoming slots
[**update_queue_slot**](QueueApi.md#update_queue_slot) | **PUT** /v1/queue/slots | Update schedule



## create_queue_slot

> models::CreateQueueSlot201Response create_queue_slot(create_queue_slot_request)
Create schedule

Create an additional queue for a profile. The first queue created becomes the default. Subsequent queues are non-default unless explicitly set. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_queue_slot_request** | [**CreateQueueSlotRequest**](CreateQueueSlotRequest.md) |  | [required] |

### Return type

[**models::CreateQueueSlot201Response**](createQueueSlot_201_response.md)

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_queue_slot

> models::DeleteQueueSlot200Response delete_queue_slot(profile_id, queue_id)
Delete schedule

Delete a queue from a profile. Requires queueId to specify which queue to delete. If deleting the default queue, another queue will be promoted to default. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**profile_id** | **String** |  | [required] |
**queue_id** | **String** | Queue ID to delete | [required] |

### Return type

[**models::DeleteQueueSlot200Response**](deleteQueueSlot_200_response.md)

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_next_queue_slot

> models::GetNextQueueSlot200Response get_next_queue_slot(profile_id, queue_id)
Get next available slot

Returns the next available queue slot for preview purposes. To create a queue post, use POST /v1/posts with queuedFromProfile instead of scheduledFor.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**profile_id** | **String** |  | [required] |
**queue_id** | Option<**String**> | Specific queue ID (optional, defaults to profile's default queue) |  |

### Return type

[**models::GetNextQueueSlot200Response**](getNextQueueSlot_200_response.md)

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_queue_slots

> models::ListQueueSlots200Response list_queue_slots(profile_id, queue_id, all)
List schedules

Returns queue schedules for a profile. Use all=true for all queues, or queueId for a specific one. Defaults to the default queue.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**profile_id** | **String** | Profile ID to get queues for | [required] |
**queue_id** | Option<**String**> | Specific queue ID to retrieve (optional) |  |
**all** | Option<**String**> | Set to 'true' to list all queues for the profile |  |

### Return type

[**models::ListQueueSlots200Response**](listQueueSlots_200_response.md)

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## preview_queue

> models::PreviewQueue200Response preview_queue(profile_id, queue_id, count)
Preview upcoming slots

Returns the next N upcoming queue slot times for a profile as ISO datetime strings.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**profile_id** | **String** |  | [required] |
**queue_id** | Option<**String**> | Filter by specific queue ID. Omit to use the default queue. |  |
**count** | Option<**i32**> |  |  |[default to 20]

### Return type

[**models::PreviewQueue200Response**](previewQueue_200_response.md)

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_queue_slot

> models::UpdateQueueSlot200Response update_queue_slot(update_queue_slot_request)
Update schedule

Create a new queue or update an existing one. Without queueId, creates/updates the default queue. With queueId, updates a specific queue. With setAsDefault=true, makes this queue the default for the profile. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**update_queue_slot_request** | [**UpdateQueueSlotRequest**](UpdateQueueSlotRequest.md) |  | [required] |

### Return type

[**models::UpdateQueueSlot200Response**](updateQueueSlot_200_response.md)

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)