|
5 | 5 |
|
6 | 6 | 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. |
7 | 7 |
|
8 | | - The version of the OpenAPI document: 58.3.0 |
| 8 | + The version of the OpenAPI document: 58.4.0 |
9 | 9 | |
10 | 10 | Generated by OpenAPI Generator (https://openapi-generator.tech) |
11 | 11 |
|
|
33 | 33 | from segment_public_api.models.list_audiences200_response import ListAudiences200Response |
34 | 34 | from segment_public_api.models.list_audiences_pagination_input import ListAudiencesPaginationInput |
35 | 35 | from segment_public_api.models.pagination_input import PaginationInput |
| 36 | +from segment_public_api.models.preview_audience200_response import PreviewAudience200Response |
| 37 | +from segment_public_api.models.preview_audience_input import PreviewAudienceInput |
36 | 38 | from segment_public_api.models.remove_audience_from_space200_response import RemoveAudienceFromSpace200Response |
37 | 39 | from segment_public_api.models.update_audience_for_space200_response import UpdateAudienceForSpace200Response |
38 | 40 | from segment_public_api.models.update_audience_for_space_alpha_input import UpdateAudienceForSpaceAlphaInput |
@@ -692,6 +694,164 @@ def list_audiences_with_http_info(self, space_id : constr(strict=True), paginati |
692 | 694 | collection_formats=_collection_formats, |
693 | 695 | _request_auth=_params.get('_request_auth')) |
694 | 696 |
|
| 697 | + @validate_arguments |
| 698 | + def preview_audience(self, space_id : constr(strict=True), preview_audience_input : PreviewAudienceInput, **kwargs) -> PreviewAudience200Response: # noqa: E501 |
| 699 | + """Preview Audience # noqa: E501 |
| 700 | +
|
| 701 | + Previews 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. • When called, this endpoint may generate the `Audience Preview Created` event in the [audit trail](/tag/Audit-Trail). # noqa: E501 |
| 702 | + This method makes a synchronous HTTP request by default. To make an |
| 703 | + asynchronous HTTP request, please pass async_req=True |
| 704 | +
|
| 705 | + >>> thread = api.preview_audience(space_id, preview_audience_input, async_req=True) |
| 706 | + >>> result = thread.get() |
| 707 | +
|
| 708 | + :param space_id: (required) |
| 709 | + :type space_id: str |
| 710 | + :param preview_audience_input: (required) |
| 711 | + :type preview_audience_input: PreviewAudienceInput |
| 712 | + :param async_req: Whether to execute the request asynchronously. |
| 713 | + :type async_req: bool, optional |
| 714 | + :param _request_timeout: timeout setting for this request. |
| 715 | + If one number provided, it will be total request |
| 716 | + timeout. It can also be a pair (tuple) of |
| 717 | + (connection, read) timeouts. |
| 718 | + :return: Returns the result object. |
| 719 | + If the method is called asynchronously, |
| 720 | + returns the request thread. |
| 721 | + :rtype: PreviewAudience200Response |
| 722 | + """ |
| 723 | + kwargs['_return_http_data_only'] = True |
| 724 | + if '_preload_content' in kwargs: |
| 725 | + message = "Error! Please call the preview_audience_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 |
| 726 | + raise ValueError(message) |
| 727 | + return self.preview_audience_with_http_info(space_id, preview_audience_input, **kwargs) # noqa: E501 |
| 728 | + |
| 729 | + @validate_arguments |
| 730 | + def preview_audience_with_http_info(self, space_id : constr(strict=True), preview_audience_input : PreviewAudienceInput, **kwargs) -> ApiResponse: # noqa: E501 |
| 731 | + """Preview Audience # noqa: E501 |
| 732 | +
|
| 733 | + Previews 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. • When called, this endpoint may generate the `Audience Preview Created` event in the [audit trail](/tag/Audit-Trail). # noqa: E501 |
| 734 | + This method makes a synchronous HTTP request by default. To make an |
| 735 | + asynchronous HTTP request, please pass async_req=True |
| 736 | +
|
| 737 | + >>> thread = api.preview_audience_with_http_info(space_id, preview_audience_input, async_req=True) |
| 738 | + >>> result = thread.get() |
| 739 | +
|
| 740 | + :param space_id: (required) |
| 741 | + :type space_id: str |
| 742 | + :param preview_audience_input: (required) |
| 743 | + :type preview_audience_input: PreviewAudienceInput |
| 744 | + :param async_req: Whether to execute the request asynchronously. |
| 745 | + :type async_req: bool, optional |
| 746 | + :param _preload_content: if False, the ApiResponse.data will |
| 747 | + be set to none and raw_data will store the |
| 748 | + HTTP response body without reading/decoding. |
| 749 | + Default is True. |
| 750 | + :type _preload_content: bool, optional |
| 751 | + :param _return_http_data_only: response data instead of ApiResponse |
| 752 | + object with status code, headers, etc |
| 753 | + :type _return_http_data_only: bool, optional |
| 754 | + :param _request_timeout: timeout setting for this request. If one |
| 755 | + number provided, it will be total request |
| 756 | + timeout. It can also be a pair (tuple) of |
| 757 | + (connection, read) timeouts. |
| 758 | + :param _request_auth: set to override the auth_settings for an a single |
| 759 | + request; this effectively ignores the authentication |
| 760 | + in the spec for a single request. |
| 761 | + :type _request_auth: dict, optional |
| 762 | + :type _content_type: string, optional: force content-type for the request |
| 763 | + :return: Returns the result object. |
| 764 | + If the method is called asynchronously, |
| 765 | + returns the request thread. |
| 766 | + :rtype: tuple(PreviewAudience200Response, status_code(int), headers(HTTPHeaderDict)) |
| 767 | + """ |
| 768 | + |
| 769 | + _params = locals() |
| 770 | + |
| 771 | + _all_params = [ |
| 772 | + 'space_id', |
| 773 | + 'preview_audience_input' |
| 774 | + ] |
| 775 | + _all_params.extend( |
| 776 | + [ |
| 777 | + 'async_req', |
| 778 | + '_return_http_data_only', |
| 779 | + '_preload_content', |
| 780 | + '_request_timeout', |
| 781 | + '_request_auth', |
| 782 | + '_content_type', |
| 783 | + '_headers' |
| 784 | + ] |
| 785 | + ) |
| 786 | + |
| 787 | + # validate the arguments |
| 788 | + for _key, _val in _params['kwargs'].items(): |
| 789 | + if _key not in _all_params: |
| 790 | + raise ApiTypeError( |
| 791 | + "Got an unexpected keyword argument '%s'" |
| 792 | + " to method preview_audience" % _key |
| 793 | + ) |
| 794 | + _params[_key] = _val |
| 795 | + del _params['kwargs'] |
| 796 | + |
| 797 | + _collection_formats = {} |
| 798 | + |
| 799 | + # process the path parameters |
| 800 | + _path_params = {} |
| 801 | + if _params['space_id']: |
| 802 | + _path_params['spaceId'] = _params['space_id'] |
| 803 | + |
| 804 | + |
| 805 | + # process the query parameters |
| 806 | + _query_params = [] |
| 807 | + # process the header parameters |
| 808 | + _header_params = dict(_params.get('_headers', {})) |
| 809 | + # process the form parameters |
| 810 | + _form_params = [] |
| 811 | + _files = {} |
| 812 | + # process the body parameter |
| 813 | + _body_params = None |
| 814 | + if _params['preview_audience_input'] is not None: |
| 815 | + _body_params = _params['preview_audience_input'] |
| 816 | + |
| 817 | + # set the HTTP header `Accept` |
| 818 | + _header_params['Accept'] = self.api_client.select_header_accept( |
| 819 | + ['application/vnd.segment.v1alpha+json', 'application/json']) # noqa: E501 |
| 820 | + |
| 821 | + # set the HTTP header `Content-Type` |
| 822 | + _content_types_list = _params.get('_content_type', |
| 823 | + self.api_client.select_header_content_type( |
| 824 | + ['application/vnd.segment.v1alpha+json'])) |
| 825 | + if _content_types_list: |
| 826 | + _header_params['Content-Type'] = _content_types_list |
| 827 | + |
| 828 | + # authentication setting |
| 829 | + _auth_settings = ['token'] # noqa: E501 |
| 830 | + |
| 831 | + _response_types_map = { |
| 832 | + '200': "PreviewAudience200Response", |
| 833 | + '404': "RequestErrorEnvelope", |
| 834 | + '422': "RequestErrorEnvelope", |
| 835 | + '429': "RequestErrorEnvelope", |
| 836 | + } |
| 837 | + |
| 838 | + return self.api_client.call_api( |
| 839 | + '/spaces/{spaceId}/audiences/previews', 'POST', |
| 840 | + _path_params, |
| 841 | + _query_params, |
| 842 | + _header_params, |
| 843 | + body=_body_params, |
| 844 | + post_params=_form_params, |
| 845 | + files=_files, |
| 846 | + response_types_map=_response_types_map, |
| 847 | + auth_settings=_auth_settings, |
| 848 | + async_req=_params.get('async_req'), |
| 849 | + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 |
| 850 | + _preload_content=_params.get('_preload_content', True), |
| 851 | + _request_timeout=_params.get('_request_timeout'), |
| 852 | + collection_formats=_collection_formats, |
| 853 | + _request_auth=_params.get('_request_auth')) |
| 854 | + |
695 | 855 | @validate_arguments |
696 | 856 | def remove_audience_from_space(self, space_id : constr(strict=True), id : constr(strict=True), **kwargs) -> RemoveAudienceFromSpace200Response: # noqa: E501 |
697 | 857 | """Remove Audience from Space # noqa: E501 |
|
0 commit comments