stcloud 0.4.0

Client package for talking to Sematext Cloud.
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280

# \SubscriptionsApi

All URIs are relative to *https://localhost*

| Method                                                                             | HTTP request                                                          | Description                             |
| ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------- |
| [**create_for_app_using_post1**](SubscriptionsApi.md#create_for_app_using_post1)   | **Post** /users-web/api/v3/apps/{appId}/subscription                  | Create App subscription                 |
| [**create_for_dash_using_post**](SubscriptionsApi.md#create_for_dash_using_post)   | **Post** /users-web/api/v3/dashboards/{dashId}/subscription           | Create dashboard subscription           |
| [**delete_using_delete2**](SubscriptionsApi.md#delete_using_delete2)               | **Delete** /users-web/api/v3/subscriptions/{updateableSubscriptionId} | Delete subscription                     |
| [**list_using_get2**](SubscriptionsApi.md#list_using_get2)                         | **Get** /users-web/api/v3/apps/{appId}/subscriptions                  | Get subscriptions for an App            |
| [**list_using_get5**](SubscriptionsApi.md#list_using_get5)                         | **Get** /users-web/api/v3/subscriptions                               | Get current account's subscriptions |
| [**send_app_report_using_post1**](SubscriptionsApi.md#send_app_report_using_post1) | **Post** /users-web/api/v3/apps/{appId}/report/send                   | Email an App report                     |
| [**send_dash_report_using_post**](SubscriptionsApi.md#send_dash_report_using_post) | **Post** /users-web/api/v3/dashboards/{dashId}/report/send            | Email a dashboard report                |
| [**toggle_enabled_using_put1**](SubscriptionsApi.md#toggle_enabled_using_put1)     | **Put** /users-web/api/v3/subscriptions/{updateableSubscriptionId}    | Toggle subscription status              |
| [**update_for_app_using_put**](SubscriptionsApi.md#update_for_app_using_put)       | **Put** /users-web/api/v3/apps/{appId}/subscription                   | Update App subscription                 |
| [**update_for_dash_using_put1**](SubscriptionsApi.md#update_for_dash_using_put1)   | **Put** /users-web/api/v3/dashboards/{dashId}/subscription            | Update dashboard subscription           |


# **create_for_app_using_post1**
> ::models::SubscriptionResponse create_for_app_using_post1(ctx, app_id, subscription)
Create App subscription

### Required Parameters

| Name             | Type                                      | Description                           | Notes                    |
| ---------------- | ----------------------------------------- | ------------------------------------- | ------------------------ |
| **ctx**          | **context.Context**                       | context containing the authentication | nil if no authentication |
| **app_id**       | **i64**                                   | appId                                 |
| **subscription** | [**SubscriptionDto**](SubscriptionDto.md) | subscription                          |

### Return type

[**::models::SubscriptionResponse**](SubscriptionResponse.md)

### Authorization

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

### 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)

# **create_for_dash_using_post**
> ::models::SubscriptionResponse create_for_dash_using_post(ctx, dash_id, subscription)
Create dashboard subscription

### Required Parameters

| Name             | Type                                                        | Description                           | Notes                    |
| ---------------- | ----------------------------------------------------------- | ------------------------------------- | ------------------------ |
| **ctx**          | **context.Context**                                         | context containing the authentication | nil if no authentication |
| **dash_id**      | **i64**                                                     | dashId                                |
| **subscription** | [**SubscriptionDashboardDto**](SubscriptionDashboardDto.md) | subscription                          |

### Return type

[**::models::SubscriptionResponse**](SubscriptionResponse.md)

### Authorization

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

### 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_using_delete2**
> ::models::GenericMapBasedApiResponse delete_using_delete2(ctx, updateable_subscription_id)
Delete subscription

### Required Parameters

| Name                           | Type                | Description                           | Notes                    |
| ------------------------------ | ------------------- | ------------------------------------- | ------------------------ |
| **ctx**                        | **context.Context** | context containing the authentication | nil if no authentication |
| **updateable_subscription_id** | **i64**             | updateableSubscriptionId              |

### Return type

[**::models::GenericMapBasedApiResponse**](Generic Map Based Api Response.md)

### Authorization

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

### 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)

# **list_using_get2**
> ::models::SubscriptionsResponse list_using_get2(ctx, app_id)
Get subscriptions for an App

### Required Parameters

| Name       | Type                | Description                           | Notes                    |
| ---------- | ------------------- | ------------------------------------- | ------------------------ |
| **ctx**    | **context.Context** | context containing the authentication | nil if no authentication |
| **app_id** | **i64**             | appId                                 |

### Return type

[**::models::SubscriptionsResponse**](SubscriptionsResponse.md)

### Authorization

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

### 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)

# **list_using_get5**
> ::models::SubscriptionsResponse list_using_get5(ctx, )
Get current account's subscriptions

### Required Parameters
This endpoint does not need any parameter.

### Return type

[**::models::SubscriptionsResponse**](SubscriptionsResponse.md)

### Authorization

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

### 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)

# **send_app_report_using_post1**
> ::models::MailReportResponse send_app_report_using_post1(ctx, app_id, email_dto)
Email an App report

### Required Parameters

| Name          | Type                            | Description                           | Notes                    |
| ------------- | ------------------------------- | ------------------------------------- | ------------------------ |
| **ctx**       | **context.Context**             | context containing the authentication | nil if no authentication |
| **app_id**    | **i64**                         | appId                                 |
| **email_dto** | [**ReportInfo**](ReportInfo.md) | emailDto                              |

### Return type

[**::models::MailReportResponse**](MailReportResponse.md)

### Authorization

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

### 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)

# **send_dash_report_using_post**
> ::models::MailReportResponse send_dash_report_using_post(ctx, dash_id, email_dto)
Email a dashboard report

### Required Parameters

| Name          | Type                            | Description                           | Notes                    |
| ------------- | ------------------------------- | ------------------------------------- | ------------------------ |
| **ctx**       | **context.Context**             | context containing the authentication | nil if no authentication |
| **dash_id**   | **i64**                         | dashId                                |
| **email_dto** | [**ReportInfo**](ReportInfo.md) | emailDto                              |

### Return type

[**::models::MailReportResponse**](MailReportResponse.md)

### Authorization

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

### 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)

# **toggle_enabled_using_put1**
> ::models::SubscriptionResponse toggle_enabled_using_put1(ctx, updateable_subscription_id, dto)
Toggle subscription status

### Required Parameters

| Name                           | Type                                                  | Description                           | Notes                    |
| ------------------------------ | ----------------------------------------------------- | ------------------------------------- | ------------------------ |
| **ctx**                        | **context.Context**                                   | context containing the authentication | nil if no authentication |
| **updateable_subscription_id** | **i64**                                               | updateableSubscriptionId              |
| **dto**                        | [**UpdateSubscriptionDto**](UpdateSubscriptionDto.md) | dto                                   |

### Return type

[**::models::SubscriptionResponse**](SubscriptionResponse.md)

### Authorization

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

### 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)

# **update_for_app_using_put**
> ::models::SubscriptionResponse update_for_app_using_put(ctx, app_id, subscription)
Update App subscription

### Required Parameters

| Name             | Type                                      | Description                           | Notes                    |
| ---------------- | ----------------------------------------- | ------------------------------------- | ------------------------ |
| **ctx**          | **context.Context**                       | context containing the authentication | nil if no authentication |
| **app_id**       | **i64**                                   | appId                                 |
| **subscription** | [**SubscriptionDto**](SubscriptionDto.md) | subscription                          |

### Return type

[**::models::SubscriptionResponse**](SubscriptionResponse.md)

### Authorization

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

### 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)

# **update_for_dash_using_put1**
> ::models::SubscriptionResponse update_for_dash_using_put1(ctx, dash_id, subscription)
Update dashboard subscription

### Required Parameters

| Name             | Type                                                        | Description                           | Notes                    |
| ---------------- | ----------------------------------------------------------- | ------------------------------------- | ------------------------ |
| **ctx**          | **context.Context**                                         | context containing the authentication | nil if no authentication |
| **dash_id**      | **i64**                                                     | dashId                                |
| **subscription** | [**SubscriptionDashboardDto**](SubscriptionDashboardDto.md) | subscription                          |

### Return type

[**::models::SubscriptionResponse**](SubscriptionResponse.md)

### Authorization

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

### 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)