You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
print("Exception when calling DestinationsApi->create_destination: %s\n"% e)
43
44
```
@@ -50,7 +51,7 @@ Name | Type | Description | Notes
50
51
51
52
### Return type
52
53
53
-
void (empty response body)
54
+
[**Destination**](Destination.md)
54
55
55
56
### Authorization
56
57
@@ -59,12 +60,12 @@ void (empty response body)
59
60
### HTTP request headers
60
61
61
62
-**Content-Type**: application/json
62
-
-**Accept**: Not defined
63
+
-**Accept**: application/json
63
64
64
65
### HTTP response details
65
66
| Status code | Description | Response headers |
66
67
|-------------|-------------|------------------|
67
-
**200** | | - |
68
+
**200** | Successfully created destination | - |
68
69
**400** | Only a single destination per account is allowed | - |
69
70
70
71
[[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)
@@ -183,7 +184,7 @@ This endpoint does not need any parameter.
183
184
[[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)
184
185
185
186
# **get_destinations**
186
-
> get_destinations()
187
+
> list[Destination]get_destinations()
187
188
188
189
Lists the destination currently in use for a Stitch account. Only a single data warehouse is supported per Stitch client account.
# Lists the destination currently in use for a Stitch account. Only a single data warehouse is supported per Stitch client account.
210
-
api_instance.get_destinations()
211
+
api_response = api_instance.get_destinations()
212
+
pprint(api_response)
211
213
except ApiException as e:
212
214
print("Exception when calling DestinationsApi->get_destinations: %s\n"% e)
213
215
```
@@ -217,7 +219,7 @@ This endpoint does not need any parameter.
217
219
218
220
### Return type
219
221
220
-
void (empty response body)
222
+
[**list[Destination]**](Destination.md)
221
223
222
224
### Authorization
223
225
@@ -231,12 +233,12 @@ void (empty response body)
231
233
### HTTP response details
232
234
| Status code | Description | Response headers |
233
235
|-------------|-------------|------------------|
234
-
**200** | | - |
236
+
**200** | List of destination objects | - |
235
237
236
238
[[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)
print("Exception when calling DestinationsApi->update_destination: %s\n"% e)
268
271
```
@@ -276,7 +279,7 @@ Name | Type | Description | Notes
276
279
277
280
### Return type
278
281
279
-
void (empty response body)
282
+
[**Destination**](Destination.md)
280
283
281
284
### Authorization
282
285
@@ -285,12 +288,12 @@ void (empty response body)
285
288
### HTTP request headers
286
289
287
290
-**Content-Type**: application/json
288
-
-**Accept**: Not defined
291
+
-**Accept**: application/json
289
292
290
293
### HTTP response details
291
294
| Status code | Description | Response headers |
292
295
|-------------|-------------|------------------|
293
-
**200** | | - |
296
+
**200** | Successfully updated destination | - |
294
297
**400** | Invalid destination ID | - |
295
298
296
299
[[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)
**breadcrumbs** | **list[str]** | An array of strings describing a path into the schema. For example: A value of [] refers to the entire schema, or stream A value of [\"properties\", \"<FIELD_NAME>\"] refers to the properties.<FIELD_NAME> portion of the schema. For example: [\"properties\", \"id\"] would refer to a field named `id` |
8
-
**metadata** | [**OneOfstreamLevelMetadatafieldLevelMetadata**](OneOfstreamLevelMetadatafieldLevelMetadata.md) | An object containing metadata associated with the breadcrumb. The type of metadata object depends on the breadcrumb: For the entire schema (breadcrumb: []), this will be a Stream-level Metadata object. For an individual field (breadcrumb: [\"properties\", \"<FIELD_NAME>\"]), this will be a Field-level Metadata object |
7
+
**breadcrumb** | **list[str]** | An array of strings describing a path into the schema. For example: A value of [] refers to the entire schema, or stream A value of [\"properties\", \"<FIELD_NAME>\"] refers to the properties.<FIELD_NAME> portion of the schema. For example: [\"properties\", \"id\"] would refer to a field named `id` |[optional]
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
Copy file name to clipboardExpand all lines: client/docs/SourcesApi.md
+18-15Lines changed: 18 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@ Name | Type | Description | Notes
73
73
[[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)
74
74
75
75
# **delete_source**
76
-
> delete_source(source_id)
76
+
> Source delete_source(source_id)
77
77
78
78
Deletes an existing data source.
79
79
@@ -98,7 +98,8 @@ source_id = 'source_id_example' # str | The ID of the source
print("Exception when calling SourcesApi->delete_source: %s\n"% e)
104
105
```
@@ -111,7 +112,7 @@ Name | Type | Description | Notes
111
112
112
113
### Return type
113
114
114
-
void (empty response body)
115
+
[**Source**](Source.md)
115
116
116
117
### Authorization
117
118
@@ -120,12 +121,12 @@ void (empty response body)
120
121
### HTTP request headers
121
122
122
123
-**Content-Type**: Not defined
123
-
-**Accept**: Not defined
124
+
-**Accept**: application/json
124
125
125
126
### HTTP response details
126
127
| Status code | Description | Response headers |
127
128
|-------------|-------------|------------------|
128
-
**200** | | - |
129
+
**200** | Successfully deleted data source | - |
129
130
130
131
[[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)
131
132
@@ -188,7 +189,7 @@ Name | Type | Description | Notes
188
189
[[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)
189
190
190
191
# **get_source**
191
-
> get_source(source_id)
192
+
> Source get_source(source_id)
192
193
193
194
Retrieves a previously created data source by its unique identifier. This endpoint can be used to retrieve an active, paused, or deleted source.
194
195
@@ -213,7 +214,8 @@ source_id = 'source_id_example' # str | The ID of the source
213
214
214
215
try:
215
216
# Retrieves a previously created data source by its unique identifier. This endpoint can be used to retrieve an active, paused, or deleted source.
216
-
api_instance.get_source(source_id)
217
+
api_response = api_instance.get_source(source_id)
218
+
pprint(api_response)
217
219
except ApiException as e:
218
220
print("Exception when calling SourcesApi->get_source: %s\n"% e)
219
221
```
@@ -226,7 +228,7 @@ Name | Type | Description | Notes
226
228
227
229
### Return type
228
230
229
-
void (empty response body)
231
+
[**Source**](Source.md)
230
232
231
233
### Authorization
232
234
@@ -235,12 +237,12 @@ void (empty response body)
235
237
### HTTP request headers
236
238
237
239
-**Content-Type**: Not defined
238
-
-**Accept**: Not defined
240
+
-**Accept**: application/json
239
241
240
242
### HTTP response details
241
243
| Status code | Description | Response headers |
242
244
|-------------|-------------|------------------|
243
-
**200** | | - |
245
+
**200** | Successfully retrieved data source | - |
244
246
245
247
[[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)
246
248
@@ -358,7 +360,7 @@ Name | Type | Description | Notes
358
360
[[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)
print("Exception when calling SourcesApi->update_source: %s\n"% e)
390
393
```
@@ -398,7 +401,7 @@ Name | Type | Description | Notes
398
401
399
402
### Return type
400
403
401
-
void (empty response body)
404
+
[**Source**](Source.md)
402
405
403
406
### Authorization
404
407
@@ -407,12 +410,12 @@ void (empty response body)
407
410
### HTTP request headers
408
411
409
412
-**Content-Type**: application/json
410
-
-**Accept**: Not defined
413
+
-**Accept**: application/json
411
414
412
415
### HTTP response details
413
416
| Status code | Description | Response headers |
414
417
|-------------|-------------|------------------|
415
-
**200** | | - |
418
+
**200** | Successfully updated source | - |
416
419
417
420
[[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)
**database_name** | **str** | For database sources only. The name of the database containing the stream. | [optional]
8
-
**forced_replication_method** | **str** | Indicates which Replication Method is required for the stream. Possible values are: FULL_TABLE - The stream is using Full Table Replication INCREMENTAL - The stream is using Key-based Incremental Replication LOG_BASED - The stream is using Log-based Incremental Replication. | [optional]
**is_view** | **bool** | For database sources only. Indicates if the stream is a database view. | [optional]
10
10
**replication_key** | **str** | Indicates the field being used as the stream’s Replication Key. | [optional]
11
11
**replication_method** | **str** | The Replication Method the stream uses to replicate data. Accepted values are: FULL_TABLE - The stream is using Full Table Replication INCREMENTAL - The stream is using Key-based Incremental Replication LOG_BASED - The stream is using Log-based Incremental Replication. Note: This method is only available for certain database sources, and requires additional setup to use. | [optional]
print("Exception when calling StreamsApi->get_stream_schema: %s\n"% e)
42
43
```
@@ -50,7 +51,7 @@ Name | Type | Description | Notes
50
51
51
52
### Return type
52
53
53
-
void (empty response body)
54
+
[**StreamSchema**](StreamSchema.md)
54
55
55
56
### Authorization
56
57
@@ -59,13 +60,13 @@ void (empty response body)
59
60
### HTTP request headers
60
61
61
62
-**Content-Type**: Not defined
62
-
-**Accept**: Not defined
63
+
-**Accept**: application/json
63
64
64
65
### HTTP response details
65
66
| Status code | Description | Response headers |
66
67
|-------------|-------------|------------------|
67
-
**200** | | - |
68
-
**400** | Invalid source ID | - |
68
+
**200** | Schema for a stream object | - |
69
+
**400** | Invalid stream ID | - |
69
70
70
71
[[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)
0 commit comments