Skip to content

Commit 17fbbed

Browse files
author
APIs and Common Services team
committed
Automated SDK update
This updates the SDK from internal repo commit segmentio/public-api@c3865a8a.
1 parent 9c7683c commit 17fbbed

739 files changed

Lines changed: 2954 additions & 732 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ See the next sections for more information on how to use the Segment Public API.
1111

1212
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
1313

14-
- API version: 73.0.1
15-
- Package version: 73.0.1
14+
- API version: 73.0.2
15+
- Package version: 73.0.2
1616
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
1717

1818
For more information, please visit [https://docs.segmentapis.com](https://docs.segmentapis.com)

‎docs/SpaceSchemaApi.md‎

Lines changed: 255 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,255 @@
1+
# segment_public_api.SpaceSchemaApi
2+
3+
All URIs are relative to *https://api.segmentapis.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**list_events**](SpaceSchemaApi.md#list_events) | **GET** /spaces/{spaceId}/events | List Events
8+
[**list_properties_from_event**](SpaceSchemaApi.md#list_properties_from_event) | **GET** /spaces/{spaceId}/events/{eventName}/properties | List Properties from Event
9+
[**list_sample_values_from_event_property**](SpaceSchemaApi.md#list_sample_values_from_event_property) | **GET** /spaces/{spaceId}/events/{eventName}/properties/{propertyName}/sample-values | List Sample Values from Event Property
10+
11+
12+
13+
## Operation: list_events
14+
15+
> ListEvents200Response list_events(space_id, pagination=pagination, sort_by=sort_by, sort_dir=sort_dir, search=search)
16+
17+
List Events
18+
19+
Returns a list of Events for a Space. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. The rate limit for this endpoint is 25 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.
20+
21+
### Example
22+
23+
* Bearer Authentication (token):
24+
```python
25+
import time
26+
import os
27+
import segment_public_api
28+
from segment_public_api.models.list_events200_response import ListEvents200Response
29+
from segment_public_api.models.pagination_input import PaginationInput
30+
from segment_public_api.rest import ApiException
31+
from pprint import pprint
32+
33+
34+
35+
# Configure Bearer authorization: token
36+
configuration = segment_public_api.Configuration(
37+
access_token = os.environ["BEARER_TOKEN"]
38+
)
39+
# Enter a context with an instance of the API client
40+
with segment_public_api.ApiClient(configuration) as api_client:
41+
# Create an instance of the API class
42+
api_instance = segment_public_api.SpaceSchemaApi(api_client)
43+
space_id = 'spaceId' # str |
44+
pagination = segment_public_api.PaginationInput(count=10) # PaginationInput | Pagination params. Defaults to count 200. This parameter exists in alpha. (optional)
45+
sort_by = 'lastSeenAt' # str | Field to sort by. Defaults to 'lastSeenAt'. This parameter exists in alpha. (optional)
46+
sort_dir = 'desc' # str | Sort direction. Defaults to 'desc'. This parameter exists in alpha. (optional)
47+
search = 'search_example' # str | Filter events by name substring. This parameter exists in alpha. (optional)
48+
49+
try:
50+
# List Events
51+
api_response = api_instance.list_events(space_id, pagination=pagination, sort_by=sort_by, sort_dir=sort_dir, search=search)
52+
print("The response of SpaceSchemaApi->list_events:\n")
53+
pprint(api_response)
54+
except Exception as e:
55+
print("Exception when calling SpaceSchemaApi->list_events: %s\n" % e)
56+
```
57+
58+
59+
### Parameters
60+
61+
Name | Type | Description | Notes
62+
------------- | ------------- | ------------- | -------------
63+
**space_id** | **str**| |
64+
**pagination** | [**PaginationInput**](.md)| Pagination params. Defaults to count 200. This parameter exists in alpha. | [optional]
65+
**sort_by** | **str**| Field to sort by. Defaults to 'lastSeenAt'. This parameter exists in alpha. | [optional]
66+
**sort_dir** | **str**| Sort direction. Defaults to 'desc'. This parameter exists in alpha. | [optional]
67+
**search** | **str**| Filter events by name substring. This parameter exists in alpha. | [optional]
68+
69+
### Return type
70+
71+
[**ListEvents200Response**](ListEvents200Response.md)
72+
73+
### Authorization
74+
75+
[token](../README.md#token)
76+
77+
### HTTP request headers
78+
79+
- **Content-Type**: Not defined
80+
- **Accept**: application/vnd.segment.v1alpha+json, application/json
81+
82+
### HTTP response details
83+
| Status code | Description | Response headers |
84+
|-------------|-------------|------------------|
85+
**200** | OK | - |
86+
**404** | Resource not found | - |
87+
**422** | Validation failure | - |
88+
**429** | Too many requests | - |
89+
90+
[[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)
91+
92+
93+
## Operation: list_properties_from_event
94+
95+
> ListPropertiesFromEvent200Response list_properties_from_event(space_id, event_name, pagination=pagination, sort_by=sort_by, sort_dir=sort_dir, search=search, include_sample_values=include_sample_values, samples_count=samples_count)
96+
97+
List Properties from Event
98+
99+
Returns a list of Properties for an Event in a Space. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. The rate limit for this endpoint is 25 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.
100+
101+
### Example
102+
103+
* Bearer Authentication (token):
104+
```python
105+
import time
106+
import os
107+
import segment_public_api
108+
from segment_public_api.models.list_properties_from_event200_response import ListPropertiesFromEvent200Response
109+
from segment_public_api.models.pagination_input import PaginationInput
110+
from segment_public_api.rest import ApiException
111+
from pprint import pprint
112+
113+
114+
115+
# Configure Bearer authorization: token
116+
configuration = segment_public_api.Configuration(
117+
access_token = os.environ["BEARER_TOKEN"]
118+
)
119+
# Enter a context with an instance of the API client
120+
with segment_public_api.ApiClient(configuration) as api_client:
121+
# Create an instance of the API class
122+
api_instance = segment_public_api.SpaceSchemaApi(api_client)
123+
space_id = 'spaceId' # str |
124+
event_name = 'Order Completed' # str |
125+
pagination = segment_public_api.PaginationInput(count=10) # PaginationInput | Pagination params. Defaults to count 200. This parameter exists in alpha. (optional)
126+
sort_by = 'name' # str | Field to sort by. Defaults to 'lastSeenAt'. This parameter exists in alpha. (optional)
127+
sort_dir = 'asc' # str | Sort direction. Defaults to 'desc'. This parameter exists in alpha. (optional)
128+
search = 'search_example' # str | Filter properties by name substring. This parameter exists in alpha. (optional)
129+
include_sample_values = True # bool | When true, include sample values for each property. Defaults to false. This parameter exists in alpha. (optional)
130+
samples_count = 3.4 # float | Max number of sample values to return per property. Defaults to 20, min 1, max 100. This parameter exists in alpha. (optional)
131+
132+
try:
133+
# List Properties from Event
134+
api_response = api_instance.list_properties_from_event(space_id, event_name, pagination=pagination, sort_by=sort_by, sort_dir=sort_dir, search=search, include_sample_values=include_sample_values, samples_count=samples_count)
135+
print("The response of SpaceSchemaApi->list_properties_from_event:\n")
136+
pprint(api_response)
137+
except Exception as e:
138+
print("Exception when calling SpaceSchemaApi->list_properties_from_event: %s\n" % e)
139+
```
140+
141+
142+
### Parameters
143+
144+
Name | Type | Description | Notes
145+
------------- | ------------- | ------------- | -------------
146+
**space_id** | **str**| |
147+
**event_name** | **str**| |
148+
**pagination** | [**PaginationInput**](.md)| Pagination params. Defaults to count 200. This parameter exists in alpha. | [optional]
149+
**sort_by** | **str**| Field to sort by. Defaults to 'lastSeenAt'. This parameter exists in alpha. | [optional]
150+
**sort_dir** | **str**| Sort direction. Defaults to 'desc'. This parameter exists in alpha. | [optional]
151+
**search** | **str**| Filter properties by name substring. This parameter exists in alpha. | [optional]
152+
**include_sample_values** | **bool**| When true, include sample values for each property. Defaults to false. This parameter exists in alpha. | [optional]
153+
**samples_count** | **float**| Max number of sample values to return per property. Defaults to 20, min 1, max 100. This parameter exists in alpha. | [optional]
154+
155+
### Return type
156+
157+
[**ListPropertiesFromEvent200Response**](ListPropertiesFromEvent200Response.md)
158+
159+
### Authorization
160+
161+
[token](../README.md#token)
162+
163+
### HTTP request headers
164+
165+
- **Content-Type**: Not defined
166+
- **Accept**: application/vnd.segment.v1alpha+json, application/json
167+
168+
### HTTP response details
169+
| Status code | Description | Response headers |
170+
|-------------|-------------|------------------|
171+
**200** | OK | - |
172+
**404** | Resource not found | - |
173+
**422** | Validation failure | - |
174+
**429** | Too many requests | - |
175+
176+
[[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)
177+
178+
179+
## Operation: list_sample_values_from_event_property
180+
181+
> ListSampleValuesFromEventProperty200Response list_sample_values_from_event_property(space_id, event_name, property_name, property_type)
182+
183+
List Sample Values from Event Property
184+
185+
Returns sample values for an Event Property in a Space. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. The rate limit for this endpoint is 25 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.
186+
187+
### Example
188+
189+
* Bearer Authentication (token):
190+
```python
191+
import time
192+
import os
193+
import segment_public_api
194+
from segment_public_api.models.event_property_type import EventPropertyType
195+
from segment_public_api.models.list_sample_values_from_event_property200_response import ListSampleValuesFromEventProperty200Response
196+
from segment_public_api.rest import ApiException
197+
from pprint import pprint
198+
199+
200+
201+
# Configure Bearer authorization: token
202+
configuration = segment_public_api.Configuration(
203+
access_token = os.environ["BEARER_TOKEN"]
204+
)
205+
# Enter a context with an instance of the API client
206+
with segment_public_api.ApiClient(configuration) as api_client:
207+
# Create an instance of the API class
208+
api_instance = segment_public_api.SpaceSchemaApi(api_client)
209+
space_id = 'spaceId' # str |
210+
event_name = 'Order Completed' # str |
211+
property_name = 'revenue' # str |
212+
property_type = segment_public_api.EventPropertyType() # EventPropertyType | The property type. This parameter exists in alpha.
213+
214+
try:
215+
# List Sample Values from Event Property
216+
api_response = api_instance.list_sample_values_from_event_property(space_id, event_name, property_name, property_type)
217+
print("The response of SpaceSchemaApi->list_sample_values_from_event_property:\n")
218+
pprint(api_response)
219+
except Exception as e:
220+
print("Exception when calling SpaceSchemaApi->list_sample_values_from_event_property: %s\n" % e)
221+
```
222+
223+
224+
### Parameters
225+
226+
Name | Type | Description | Notes
227+
------------- | ------------- | ------------- | -------------
228+
**space_id** | **str**| |
229+
**event_name** | **str**| |
230+
**property_name** | **str**| |
231+
**property_type** | [**EventPropertyType**](.md)| The property type. This parameter exists in alpha. |
232+
233+
### Return type
234+
235+
[**ListSampleValuesFromEventProperty200Response**](ListSampleValuesFromEventProperty200Response.md)
236+
237+
### Authorization
238+
239+
[token](../README.md#token)
240+
241+
### HTTP request headers
242+
243+
- **Content-Type**: Not defined
244+
- **Accept**: application/vnd.segment.v1alpha+json, application/json
245+
246+
### HTTP response details
247+
| Status code | Description | Response headers |
248+
|-------------|-------------|------------------|
249+
**200** | OK | - |
250+
**404** | Resource not found | - |
251+
**422** | Validation failure | - |
252+
**429** | Too many requests | - |
253+
254+
[[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)
255+

0 commit comments

Comments
 (0)