Skip to content

Commit bc9e601

Browse files
author
APIs and Common Services team
committed
Automated SDK update
This updates the SDK from internal repo commit segmentio/public-api@dee61337.
1 parent d1c30e7 commit bc9e601

File tree

634 files changed

+1918
-715
lines changed

Some content is hidden

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

634 files changed

+1918
-715
lines changed

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: 58.7.0
15-
- Package version: 58.7.0
14+
- API version: 58.8.0
15+
- Package version: 58.8.0
1616
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
1717

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

docs/AudiencesApi.md

Lines changed: 168 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Method | HTTP request | Description
88
[**create_audience_preview**](AudiencesApi.md#create_audience_preview) | **POST** /spaces/{spaceId}/audiences/previews | Create Audience Preview
99
[**get_audience**](AudiencesApi.md#get_audience) | **GET** /spaces/{spaceId}/audiences/{id} | Get Audience
1010
[**get_audience_preview**](AudiencesApi.md#get_audience_preview) | **GET** /spaces/{spaceId}/audiences/previews/{id} | Get Audience Preview
11+
[**get_audience_schedule_from_space_and_audience**](AudiencesApi.md#get_audience_schedule_from_space_and_audience) | **GET** /spaces/{spaceId}/audiences/{id}/schedules/{scheduleId} | Get Audience Schedule from Space And Audience
1112
[**list_audience_consumers_from_space_and_audience**](AudiencesApi.md#list_audience_consumers_from_space_and_audience) | **GET** /spaces/{spaceId}/audiences/{id}/audience-references | List Audience Consumers from Space And Audience
13+
[**list_audience_schedules_from_space_and_audience**](AudiencesApi.md#list_audience_schedules_from_space_and_audience) | **GET** /spaces/{spaceId}/audiences/{id}/schedules | List Audience Schedules from Space And Audience
1214
[**list_audiences**](AudiencesApi.md#list_audiences) | **GET** /spaces/{spaceId}/audiences | List Audiences
1315
[**remove_audience_from_space**](AudiencesApi.md#remove_audience_from_space) | **DELETE** /spaces/{spaceId}/audiences/{id} | Remove Audience from Space
1416
[**update_audience_for_space**](AudiencesApi.md#update_audience_for_space) | **PATCH** /spaces/{spaceId}/audiences/{id} | Update Audience for Space
@@ -169,11 +171,11 @@ Name | Type | Description | Notes
169171

170172
## Operation: get_audience
171173

172-
> GetAudience200Response get_audience(space_id, id)
174+
> GetAudience200Response get_audience(space_id, id, include=include)
173175
174176
Get Audience
175177

176-
Returns the Audience by id and spaceId. • This endpoint is in **Beta** testing. Please submit any feedback by sending an email to [email protected]. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 100 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.
178+
Returns the Audience by id and spaceId. Supports including audience schedules via `?include=schedules`. • This endpoint is in **Beta** testing. Please submit any feedback by sending an email to [email protected]. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 100 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.
177179

178180
### Example
179181

@@ -198,11 +200,12 @@ with segment_public_api.ApiClient(configuration) as api_client:
198200
# Create an instance of the API class
199201
api_instance = segment_public_api.AudiencesApi(api_client)
200202
space_id = '9aQ1Lj62S4bomZKLF4DPqW' # str |
201-
id = 'id' # str |
203+
id = 'aud_0ujsszwN8NRY24YaXiTIE2VWDTS' # str |
204+
include = 'include_example' # str | Additional resource to include, support schedules only. This parameter exists in alpha. (optional)
202205

203206
try:
204207
# Get Audience
205-
api_response = api_instance.get_audience(space_id, id)
208+
api_response = api_instance.get_audience(space_id, id, include=include)
206209
print("The response of AudiencesApi->get_audience:\n")
207210
pprint(api_response)
208211
except Exception as e:
@@ -217,6 +220,7 @@ Name | Type | Description | Notes
217220
------------- | ------------- | ------------- | -------------
218221
**space_id** | **str**| |
219222
**id** | **str**| |
223+
**include** | **str**| Additional resource to include, support schedules only. This parameter exists in alpha. | [optional]
220224

221225
### Return type
222226

@@ -317,6 +321,83 @@ Name | Type | Description | Notes
317321
[[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)
318322

319323

324+
## Operation: get_audience_schedule_from_space_and_audience
325+
326+
> GetAudienceScheduleFromSpaceAndAudience200Response get_audience_schedule_from_space_and_audience(space_id, id, schedule_id)
327+
328+
Get Audience Schedule from Space And Audience
329+
330+
Returns the schedule for the given audience and scheduleId. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to [email protected]. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.
331+
332+
### Example
333+
334+
* Bearer Authentication (token):
335+
```python
336+
import time
337+
import os
338+
import segment_public_api
339+
from segment_public_api.models.get_audience_schedule_from_space_and_audience200_response import GetAudienceScheduleFromSpaceAndAudience200Response
340+
from segment_public_api.rest import ApiException
341+
from pprint import pprint
342+
343+
344+
345+
# Configure Bearer authorization: token
346+
configuration = segment_public_api.Configuration(
347+
access_token = os.environ["BEARER_TOKEN"]
348+
)
349+
350+
# Enter a context with an instance of the API client
351+
with segment_public_api.ApiClient(configuration) as api_client:
352+
# Create an instance of the API class
353+
api_instance = segment_public_api.AudiencesApi(api_client)
354+
space_id = '9aQ1Lj62S4bomZKLF4DPqW' # str |
355+
id = 'aud_0ujsszwN8NRY24YaXiTIE2VWDTS' # str |
356+
schedule_id = 'sch_0ujsszwN8NRY24YaXiTIE2VWDTS' # str |
357+
358+
try:
359+
# Get Audience Schedule from Space And Audience
360+
api_response = api_instance.get_audience_schedule_from_space_and_audience(space_id, id, schedule_id)
361+
print("The response of AudiencesApi->get_audience_schedule_from_space_and_audience:\n")
362+
pprint(api_response)
363+
except Exception as e:
364+
print("Exception when calling AudiencesApi->get_audience_schedule_from_space_and_audience: %s\n" % e)
365+
```
366+
367+
368+
369+
### Parameters
370+
371+
Name | Type | Description | Notes
372+
------------- | ------------- | ------------- | -------------
373+
**space_id** | **str**| |
374+
**id** | **str**| |
375+
**schedule_id** | **str**| |
376+
377+
### Return type
378+
379+
[**GetAudienceScheduleFromSpaceAndAudience200Response**](GetAudienceScheduleFromSpaceAndAudience200Response.md)
380+
381+
### Authorization
382+
383+
[token](../README.md#token)
384+
385+
### HTTP request headers
386+
387+
- **Content-Type**: Not defined
388+
- **Accept**: application/vnd.segment.v1alpha+json, application/json
389+
390+
### HTTP response details
391+
| Status code | Description | Response headers |
392+
|-------------|-------------|------------------|
393+
**200** | OK | - |
394+
**404** | Resource not found | - |
395+
**422** | Validation failure | - |
396+
**429** | Too many requests | - |
397+
398+
[[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)
399+
400+
320401
## Operation: list_audience_consumers_from_space_and_audience
321402

322403
> ListAudienceConsumersFromSpaceAndAudience200Response list_audience_consumers_from_space_and_audience(space_id, id, pagination=pagination, search=search, sort=sort)
@@ -401,13 +482,88 @@ Name | Type | Description | Notes
401482
[[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)
402483

403484

485+
## Operation: list_audience_schedules_from_space_and_audience
486+
487+
> ListAudienceSchedulesFromSpaceAndAudience200Response list_audience_schedules_from_space_and_audience(space_id, id)
488+
489+
List Audience Schedules from Space And Audience
490+
491+
Returns the list of schedules for the given audience. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to [email protected]. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.
492+
493+
### Example
494+
495+
* Bearer Authentication (token):
496+
```python
497+
import time
498+
import os
499+
import segment_public_api
500+
from segment_public_api.models.list_audience_schedules_from_space_and_audience200_response import ListAudienceSchedulesFromSpaceAndAudience200Response
501+
from segment_public_api.rest import ApiException
502+
from pprint import pprint
503+
504+
505+
506+
# Configure Bearer authorization: token
507+
configuration = segment_public_api.Configuration(
508+
access_token = os.environ["BEARER_TOKEN"]
509+
)
510+
511+
# Enter a context with an instance of the API client
512+
with segment_public_api.ApiClient(configuration) as api_client:
513+
# Create an instance of the API class
514+
api_instance = segment_public_api.AudiencesApi(api_client)
515+
space_id = '9aQ1Lj62S4bomZKLF4DPqW' # str |
516+
id = 'aud_0ujsszwN8NRY24YaXiTIE2VWDTS' # str |
517+
518+
try:
519+
# List Audience Schedules from Space And Audience
520+
api_response = api_instance.list_audience_schedules_from_space_and_audience(space_id, id)
521+
print("The response of AudiencesApi->list_audience_schedules_from_space_and_audience:\n")
522+
pprint(api_response)
523+
except Exception as e:
524+
print("Exception when calling AudiencesApi->list_audience_schedules_from_space_and_audience: %s\n" % e)
525+
```
526+
527+
528+
529+
### Parameters
530+
531+
Name | Type | Description | Notes
532+
------------- | ------------- | ------------- | -------------
533+
**space_id** | **str**| |
534+
**id** | **str**| |
535+
536+
### Return type
537+
538+
[**ListAudienceSchedulesFromSpaceAndAudience200Response**](ListAudienceSchedulesFromSpaceAndAudience200Response.md)
539+
540+
### Authorization
541+
542+
[token](../README.md#token)
543+
544+
### HTTP request headers
545+
546+
- **Content-Type**: Not defined
547+
- **Accept**: application/vnd.segment.v1alpha+json, application/json
548+
549+
### HTTP response details
550+
| Status code | Description | Response headers |
551+
|-------------|-------------|------------------|
552+
**200** | OK | - |
553+
**404** | Resource not found | - |
554+
**422** | Validation failure | - |
555+
**429** | Too many requests | - |
556+
557+
[[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)
558+
559+
404560
## Operation: list_audiences
405561

406-
> ListAudiences200Response list_audiences(space_id, pagination=pagination)
562+
> ListAudiences200Response list_audiences(space_id, pagination=pagination, include=include)
407563
408564
List Audiences
409565

410-
Returns Audiences by spaceId. • This endpoint is in **Beta** testing. Please submit any feedback by sending an email to [email protected]. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. 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.
566+
Returns Audiences by spaceId. Supports including audience schedules via `?include=schedules`. • This endpoint is in **Beta** testing. Please submit any feedback by sending an email to [email protected]. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. 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.
411567

412568
### Example
413569

@@ -434,10 +590,11 @@ with segment_public_api.ApiClient(configuration) as api_client:
434590
api_instance = segment_public_api.AudiencesApi(api_client)
435591
space_id = '9aQ1Lj62S4bomZKLF4DPqW' # str |
436592
pagination = segment_public_api.ListAudiencesPaginationInput() # ListAudiencesPaginationInput | Information about the pagination of this response. [See pagination](https://docs.segmentapis.com/tag/Pagination/#section/Pagination-parameters) for more info. This parameter exists in alpha. (optional)
593+
include = 'include_example' # str | Additional resource to include, support schedules only. This parameter exists in alpha. (optional)
437594

438595
try:
439596
# List Audiences
440-
api_response = api_instance.list_audiences(space_id, pagination=pagination)
597+
api_response = api_instance.list_audiences(space_id, pagination=pagination, include=include)
441598
print("The response of AudiencesApi->list_audiences:\n")
442599
pprint(api_response)
443600
except Exception as e:
@@ -452,6 +609,7 @@ Name | Type | Description | Notes
452609
------------- | ------------- | ------------- | -------------
453610
**space_id** | **str**| |
454611
**pagination** | [**ListAudiencesPaginationInput**](.md)| Information about the pagination of this response. [See pagination](https://docs.segmentapis.com/tag/Pagination/#section/Pagination-parameters) for more info. This parameter exists in alpha. | [optional]
612+
**include** | **str**| Additional resource to include, support schedules only. This parameter exists in alpha. | [optional]
455613

456614
### Return type
457615

@@ -508,7 +666,7 @@ with segment_public_api.ApiClient(configuration) as api_client:
508666
# Create an instance of the API class
509667
api_instance = segment_public_api.AudiencesApi(api_client)
510668
space_id = '9aQ1Lj62S4bomZKLF4DPqW' # str |
511-
id = 'aud_0ujsswThIGTUYm2K8FjOOfXtY1K' # str |
669+
id = 'aud_0ujsszwN8NRY24YaXiTIE2VWDTS' # str |
512670

513671
try:
514672
# Remove Audience from Space
@@ -584,8 +742,8 @@ with segment_public_api.ApiClient(configuration) as api_client:
584742
# Create an instance of the API class
585743
api_instance = segment_public_api.AudiencesApi(api_client)
586744
space_id = '9aQ1Lj62S4bomZKLF4DPqW' # str |
587-
id = 'aud_0ujsswThIGTUYm2K8FjOOfXtY1K' # str |
588-
update_audience_for_space_alpha_input = {"enabled":false} # UpdateAudienceForSpaceAlphaInput |
745+
id = 'aud_0ujsszwN8NRY24YaXiTIE2VWDTS' # str |
746+
update_audience_for_space_alpha_input = {"enabled":true} # UpdateAudienceForSpaceAlphaInput |
589747

590748
try:
591749
# Update Audience for Space

0 commit comments

Comments
 (0)