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

# \AppsApi

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

| Method                                                                        | HTTP request                                               | Description                                                        |
| ----------------------------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------ |
| [**delete_using_delete1**](AppsApi.md#delete_using_delete1)                   | **Delete** /users-web/api/v3/apps/{anyStateAppId}          | delete                                                             |
| [**get_app_types_using_get1**](AppsApi.md#get_app_types_using_get1)           | **Get** /users-web/api/v3/apps/types                       | Get all App types supported for the account identified with apiKey |
| [**get_using_get1**](AppsApi.md#get_using_get1)                               | **Get** /users-web/api/v3/apps/{anyStateAppId}             | Gets defails for one particular App                                |
| [**invite_app_guests_using_post1**](AppsApi.md#invite_app_guests_using_post1) | **Post** /users-web/api/v3/apps/guests                     | Invite guests to an app                                            |
| [**list_apps_users_using_get1**](AppsApi.md#list_apps_users_using_get1)       | **Get** /users-web/api/v3/apps/users                       | Get all users of apps accessible to this account                   |
| [**list_using_get**](AppsApi.md#list_using_get)                               | **Get** /users-web/api/v3/apps                             | Get all apps accessible by account identified with apiKey          |
| [**update_description_using_put1**](AppsApi.md#update_description_using_put1) | **Put** /users-web/api/v3/apps/{anyStateAppId}/description | Update description of the app                                      |
| [**update_using_put3**](AppsApi.md#update_using_put3)                         | **Put** /users-web/api/v3/apps/{anyStateAppId}             | Update app                                                         |


# **delete_using_delete1**
> ::models::GenericMapBasedApiResponse delete_using_delete1(ctx, any_state_app_id)
delete

### Required Parameters

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

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

# **get_app_types_using_get1**
> ::models::AppTypesResponse get_app_types_using_get1(ctx, )
Get all App types supported for the account identified with apiKey

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

### Return type

[**::models::AppTypesResponse**](AppTypesResponse.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)

# **get_using_get1**
> ::models::AppResponse get_using_get1(ctx, any_state_app_id)
Gets defails for one particular App

### Required Parameters

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

### Return type

[**::models::AppResponse**](AppResponse.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)

# **invite_app_guests_using_post1**
> ::models::GenericMapBasedApiResponse invite_app_guests_using_post1(ctx, invitation)
Invite guests to an app

### Required Parameters

| Name           | Type                            | Description                                                                                                                                     | Notes                    |
| -------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| **ctx**        | **context.Context**             | context containing the authentication                                                                                                           | nil if no authentication |
| **invitation** | [**Invitation**](Invitation.md) | For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values |

### 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_apps_users_using_get1**
> ::models::AppsResponse list_apps_users_using_get1(ctx, )
Get all users of apps accessible to this account

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

### Return type

[**::models::AppsResponse**](AppsResponse.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_get**
> ::models::AppsResponse list_using_get(ctx, )
Get all apps accessible by account identified with apiKey

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

### Return type

[**::models::AppsResponse**](AppsResponse.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_description_using_put1**
> ::models::AppResponse update_description_using_put1(ctx, any_state_app_id, optional)
Update description of the app

App can be in any state

### Required Parameters

| Name                 | Type                       | Description                           | Notes                    |
| -------------------- | -------------------------- | ------------------------------------- | ------------------------ |
| **ctx**              | **context.Context**        | context containing the authentication | nil if no authentication |
| **any_state_app_id** | **i64**                    | App Id                                |
| **optional**         | **map[string]interface{}** | optional parameters                   | nil if no parameters     |

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

| Name                 | Type                                    | Description    | Notes |
| -------------------- | --------------------------------------- | -------------- | ----- |
| **any_state_app_id** | **i64**                                 | App Id         |
| **update_details**   | [**AppDescription**](AppDescription.md) | Update Details |

### Return type

[**::models::AppResponse**](AppResponse.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_using_put3**
> ::models::AppResponse update_using_put3(ctx, dto, any_state_app_id)
Update app

App can be in any state

### Required Parameters

| Name                 | Type                                  | Description                           | Notes                    |
| -------------------- | ------------------------------------- | ------------------------------------- | ------------------------ |
| **ctx**              | **context.Context**                   | context containing the authentication | nil if no authentication |
| **dto**              | [**UpdateAppInfo**](UpdateAppInfo.md) | dto                                   |
| **any_state_app_id** | **i64**                               | App Id                                |

### Return type

[**::models::AppResponse**](AppResponse.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)