-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This updates the SDK from internal repo commit segmentio/public-api@f3f82ca1.
- Loading branch information
APIs and Common Services team
committed
Dec 9, 2024
1 parent
d249ce3
commit 00edf51
Showing
598 changed files
with
1,183 additions
and
597 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
# segment_public_api.DBTApi | ||
|
||
All URIs are relative to *https://api.segmentapis.com* | ||
|
||
Method | HTTP request | Description | ||
------------- | ------------- | ------------- | ||
[**create_dbt_model_sync_trigger**](DBTApi.md#create_dbt_model_sync_trigger) | **POST** /dbt-model-syncs/trigger | Create Dbt Model Sync Trigger | ||
|
||
|
||
|
||
## Operation: create_dbt_model_sync_trigger | ||
|
||
> CreateDbtModelSyncTrigger200Response create_dbt_model_sync_trigger(create_dbt_model_sync_trigger_input) | ||
Create Dbt Model Sync Trigger | ||
|
||
Creates a trigger for a new dbt model sync for a Source. The rate limit for this endpoint is 10 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information. | ||
|
||
### Example | ||
|
||
* Bearer Authentication (token): | ||
```python | ||
import time | ||
import os | ||
import segment_public_api | ||
from segment_public_api.models.create_dbt_model_sync_trigger200_response import CreateDbtModelSyncTrigger200Response | ||
from segment_public_api.models.create_dbt_model_sync_trigger_input import CreateDbtModelSyncTriggerInput | ||
from segment_public_api.rest import ApiException | ||
from pprint import pprint | ||
|
||
|
||
|
||
# Configure Bearer authorization: token | ||
configuration = segment_public_api.Configuration( | ||
access_token = os.environ["BEARER_TOKEN"] | ||
) | ||
|
||
# Enter a context with an instance of the API client | ||
with segment_public_api.ApiClient(configuration) as api_client: | ||
# Create an instance of the API class | ||
api_instance = segment_public_api.DBTApi(api_client) | ||
create_dbt_model_sync_trigger_input = {"sourceId":"source-id"} # CreateDbtModelSyncTriggerInput | | ||
|
||
try: | ||
# Create Dbt Model Sync Trigger | ||
api_response = api_instance.create_dbt_model_sync_trigger(create_dbt_model_sync_trigger_input) | ||
print("The response of DBTApi->create_dbt_model_sync_trigger:\n") | ||
pprint(api_response) | ||
except Exception as e: | ||
print("Exception when calling DBTApi->create_dbt_model_sync_trigger: %s\n" % e) | ||
``` | ||
|
||
|
||
|
||
### Parameters | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**create_dbt_model_sync_trigger_input** | [**CreateDbtModelSyncTriggerInput**](CreateDbtModelSyncTriggerInput.md)| | | ||
|
||
### Return type | ||
|
||
[**CreateDbtModelSyncTrigger200Response**](CreateDbtModelSyncTrigger200Response.md) | ||
|
||
### Authorization | ||
|
||
[token](../README.md#token) | ||
|
||
### HTTP request headers | ||
|
||
- **Content-Type**: application/vnd.segment.v1beta+json | ||
- **Accept**: application/vnd.segment.v1beta+json, application/json | ||
|
||
### HTTP response details | ||
| Status code | Description | Response headers | | ||
|-------------|-------------|------------------| | ||
**200** | OK | - | | ||
**404** | Resource not found | - | | ||
**422** | Validation failure | - | | ||
**429** | Too many requests | - | | ||
|
||
[[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) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,22 +7,23 @@ | |
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API. | ||
The version of the OpenAPI document: 57.1.0 | ||
The version of the OpenAPI document: 57.2.0 | ||
Contact: [email protected] | ||
Generated by OpenAPI Generator (https://openapi-generator.tech) | ||
Do not edit the class manually. | ||
""" # noqa: E501 | ||
|
||
|
||
__version__ = "57.1.0" | ||
__version__ = "57.2.0" | ||
|
||
# import apis into sdk package | ||
from segment_public_api.api.api_calls_api import APICallsApi | ||
from segment_public_api.api.audiences_api import AudiencesApi | ||
from segment_public_api.api.audit_trail_api import AuditTrailApi | ||
from segment_public_api.api.catalog_api import CatalogApi | ||
from segment_public_api.api.computed_traits_api import ComputedTraitsApi | ||
from segment_public_api.api.dbt_api import DBTApi | ||
from segment_public_api.api.deletion_and_suppression_api import DeletionAndSuppressionApi | ||
from segment_public_api.api.delivery_overview_api import DeliveryOverviewApi | ||
from segment_public_api.api.destination_filters_api import DestinationFiltersApi | ||
|
@@ -110,6 +111,9 @@ | |
from segment_public_api.models.create_computed_trait200_response import CreateComputedTrait200Response | ||
from segment_public_api.models.create_computed_trait_alpha_input import CreateComputedTraitAlphaInput | ||
from segment_public_api.models.create_computed_trait_alpha_output import CreateComputedTraitAlphaOutput | ||
from segment_public_api.models.create_dbt_model_sync_trigger200_response import CreateDbtModelSyncTrigger200Response | ||
from segment_public_api.models.create_dbt_model_sync_trigger_input import CreateDbtModelSyncTriggerInput | ||
from segment_public_api.models.create_dbt_model_sync_trigger_output import CreateDbtModelSyncTriggerOutput | ||
from segment_public_api.models.create_destination200_response import CreateDestination200Response | ||
from segment_public_api.models.create_destination_subscription200_response import CreateDestinationSubscription200Response | ||
from segment_public_api.models.create_destination_subscription_alpha_input import CreateDestinationSubscriptionAlphaInput | ||
|
@@ -179,6 +183,7 @@ | |
from segment_public_api.models.create_workspace_regulation_v1_output import CreateWorkspaceRegulationV1Output | ||
from segment_public_api.models.create_write_key_for_source200_response import CreateWriteKeyForSource200Response | ||
from segment_public_api.models.create_write_key_for_source_alpha_output import CreateWriteKeyForSourceAlphaOutput | ||
from segment_public_api.models.dbt_model_sync_trigger import DbtModelSyncTrigger | ||
from segment_public_api.models.delete_destination200_response import DeleteDestination200Response | ||
from segment_public_api.models.delete_destination_v1_output import DeleteDestinationV1Output | ||
from segment_public_api.models.delete_filter_by_id200_response import DeleteFilterById200Response | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,7 @@ | |
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API. | ||
The version of the OpenAPI document: 57.1.0 | ||
The version of the OpenAPI document: 57.2.0 | ||
Contact: [email protected] | ||
Generated by OpenAPI Generator (https://openapi-generator.tech) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,7 @@ | |
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API. | ||
The version of the OpenAPI document: 57.1.0 | ||
The version of the OpenAPI document: 57.2.0 | ||
Contact: [email protected] | ||
Generated by OpenAPI Generator (https://openapi-generator.tech) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,7 @@ | |
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API. | ||
The version of the OpenAPI document: 57.1.0 | ||
The version of the OpenAPI document: 57.2.0 | ||
Contact: [email protected] | ||
Generated by OpenAPI Generator (https://openapi-generator.tech) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,7 @@ | |
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API. | ||
The version of the OpenAPI document: 57.1.0 | ||
The version of the OpenAPI document: 57.2.0 | ||
Contact: [email protected] | ||
Generated by OpenAPI Generator (https://openapi-generator.tech) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,7 @@ | |
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API. | ||
The version of the OpenAPI document: 57.1.0 | ||
The version of the OpenAPI document: 57.2.0 | ||
Contact: [email protected] | ||
Generated by OpenAPI Generator (https://openapi-generator.tech) | ||
|
Oops, something went wrong.