Automated SDK update

This updates the SDK from internal repo commit segmentio/public-api@d1d5aef1.

Author: APIs and Common Services team

docs/AudiencesApi.md

@@ -166,7 +166,7 @@ Name | Type | Description  | Notes
 
 ## Operation: list_audience_consumers_from_space_and_audience
 
-> ListAudienceConsumersFromSpaceAndAudience200Response list_audience_consumers_from_space_and_audience(space_id, id, pagination=pagination)
+> ListAudienceConsumersFromSpaceAndAudience200Response list_audience_consumers_from_space_and_audience(space_id, id, pagination=pagination, search=search, sort=sort)
 
 List Audience Consumers from Space And Audience
 
@@ -180,6 +180,8 @@ import time
 import os
 import segment_public_api
 from segment_public_api.models.list_audience_consumers_from_space_and_audience200_response import ListAudienceConsumersFromSpaceAndAudience200Response
+from segment_public_api.models.list_audience_consumers_search_input import ListAudienceConsumersSearchInput
+from segment_public_api.models.list_audience_consumers_sort_input import ListAudienceConsumersSortInput
 from segment_public_api.models.pagination_input import PaginationInput
 from segment_public_api.rest import ApiException
 from pprint import pprint
@@ -198,10 +200,12 @@ with segment_public_api.ApiClient(configuration) as api_client:
     space_id = 'spaceId' # str | 
     id = 'ReferencedAudienceId' # str | 
     pagination = segment_public_api.PaginationInput(count=10) # PaginationInput | 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)
+    search = segment_public_api.ListAudienceConsumersSearchInput() # ListAudienceConsumersSearchInput | Optional search criteria  This parameter exists in alpha. (optional)
+    sort = segment_public_api.ListAudienceConsumersSortInput() # ListAudienceConsumersSortInput | Optional sort criteria  This parameter exists in alpha. (optional)
 
     try:
         # List Audience Consumers from Space And Audience
-        api_response = api_instance.list_audience_consumers_from_space_and_audience(space_id, id, pagination=pagination)
+        api_response = api_instance.list_audience_consumers_from_space_and_audience(space_id, id, pagination=pagination, search=search, sort=sort)
         print("The response of AudiencesApi->list_audience_consumers_from_space_and_audience:\n")
         pprint(api_response)
     except Exception as e:
@@ -217,6 +221,8 @@ Name | Type | Description  | Notes
  **space_id** | **str**|  | 
  **id** | **str**|  | 
  **pagination** | [**PaginationInput**](.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] 
+ **search** | [**ListAudienceConsumersSearchInput**](.md)| Optional search criteria  This parameter exists in alpha. | [optional] 
+ **sort** | [**ListAudienceConsumersSortInput**](.md)| Optional sort criteria  This parameter exists in alpha. | [optional] 
 
 ### Return type
 

segment_public_api/__init__.py

@@ -351,6 +351,8 @@
 from segment_public_api.models.label_v1 import LabelV1
 from segment_public_api.models.list_audience_consumers_from_space_and_audience200_response import ListAudienceConsumersFromSpaceAndAudience200Response
 from segment_public_api.models.list_audience_consumers_from_space_and_audience_output import ListAudienceConsumersFromSpaceAndAudienceOutput
+from segment_public_api.models.list_audience_consumers_search_input import ListAudienceConsumersSearchInput
+from segment_public_api.models.list_audience_consumers_sort_input import ListAudienceConsumersSortInput
 from segment_public_api.models.list_audiences200_response import ListAudiences200Response
 from segment_public_api.models.list_audiences_alpha_output import ListAudiencesAlphaOutput
 from segment_public_api.models.list_audit_events200_response import ListAuditEvents200Response

segment_public_api/api/audiences_api.py

@@ -28,6 +28,8 @@
 from segment_public_api.models.create_audience_alpha_input import CreateAudienceAlphaInput
 from segment_public_api.models.get_audience200_response import GetAudience200Response
 from segment_public_api.models.list_audience_consumers_from_space_and_audience200_response import ListAudienceConsumersFromSpaceAndAudience200Response
+from segment_public_api.models.list_audience_consumers_search_input import ListAudienceConsumersSearchInput
+from segment_public_api.models.list_audience_consumers_sort_input import ListAudienceConsumersSortInput
 from segment_public_api.models.list_audiences200_response import ListAudiences200Response
 from segment_public_api.models.pagination_input import PaginationInput
 from segment_public_api.models.remove_audience_from_space200_response import RemoveAudienceFromSpace200Response
@@ -364,14 +366,14 @@ def get_audience_with_http_info(self, space_id : constr(strict=True), id : const
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def list_audience_consumers_from_space_and_audience(self, space_id : constr(strict=True), id : constr(strict=True), pagination : Annotated[Optional[PaginationInput], Field(description="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.")] = None, **kwargs) -> ListAudienceConsumersFromSpaceAndAudience200Response:  # noqa: E501
+    def list_audience_consumers_from_space_and_audience(self, space_id : constr(strict=True), id : constr(strict=True), pagination : Annotated[Optional[PaginationInput], Field(description="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.")] = None, search : Annotated[Optional[ListAudienceConsumersSearchInput], Field(description="Optional search criteria  This parameter exists in alpha.")] = None, sort : Annotated[Optional[ListAudienceConsumersSortInput], Field(description="Optional sort criteria  This parameter exists in alpha.")] = None, **kwargs) -> ListAudienceConsumersFromSpaceAndAudience200Response:  # noqa: E501
         """List Audience Consumers from Space And Audience  # noqa: E501
 
         Returns the list of consumers for the given audience.  • This endpoint is in **Alpha** testing.  Please submit any feedback by sending an email to friends@segment.com.   • 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.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.list_audience_consumers_from_space_and_audience(space_id, id, pagination, async_req=True)
+        >>> thread = api.list_audience_consumers_from_space_and_audience(space_id, id, pagination, search, sort, async_req=True)
         >>> result = thread.get()
 
         :param space_id: (required)
@@ -380,6 +382,10 @@ def list_audience_consumers_from_space_and_audience(self, space_id : constr(stri
         :type id: str
         :param pagination: 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.
         :type pagination: PaginationInput
+        :param search: Optional search criteria  This parameter exists in alpha.
+        :type search: ListAudienceConsumersSearchInput
+        :param sort: Optional sort criteria  This parameter exists in alpha.
+        :type sort: ListAudienceConsumersSortInput
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _request_timeout: timeout setting for this request.
@@ -395,17 +401,17 @@ def list_audience_consumers_from_space_and_audience(self, space_id : constr(stri
         if '_preload_content' in kwargs:
             message = "Error! Please call the list_audience_consumers_from_space_and_audience_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
             raise ValueError(message)
-        return self.list_audience_consumers_from_space_and_audience_with_http_info(space_id, id, pagination, **kwargs)  # noqa: E501
+        return self.list_audience_consumers_from_space_and_audience_with_http_info(space_id, id, pagination, search, sort, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def list_audience_consumers_from_space_and_audience_with_http_info(self, space_id : constr(strict=True), id : constr(strict=True), pagination : Annotated[Optional[PaginationInput], Field(description="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.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+    def list_audience_consumers_from_space_and_audience_with_http_info(self, space_id : constr(strict=True), id : constr(strict=True), pagination : Annotated[Optional[PaginationInput], Field(description="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.")] = None, search : Annotated[Optional[ListAudienceConsumersSearchInput], Field(description="Optional search criteria  This parameter exists in alpha.")] = None, sort : Annotated[Optional[ListAudienceConsumersSortInput], Field(description="Optional sort criteria  This parameter exists in alpha.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """List Audience Consumers from Space And Audience  # noqa: E501
 
         Returns the list of consumers for the given audience.  • This endpoint is in **Alpha** testing.  Please submit any feedback by sending an email to friends@segment.com.   • 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.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.list_audience_consumers_from_space_and_audience_with_http_info(space_id, id, pagination, async_req=True)
+        >>> thread = api.list_audience_consumers_from_space_and_audience_with_http_info(space_id, id, pagination, search, sort, async_req=True)
         >>> result = thread.get()
 
         :param space_id: (required)
@@ -414,6 +420,10 @@ def list_audience_consumers_from_space_and_audience_with_http_info(self, space_i
         :type id: str
         :param pagination: 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.
         :type pagination: PaginationInput
+        :param search: Optional search criteria  This parameter exists in alpha.
+        :type search: ListAudienceConsumersSearchInput
+        :param sort: Optional sort criteria  This parameter exists in alpha.
+        :type sort: ListAudienceConsumersSortInput
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the ApiResponse.data will
@@ -444,7 +454,9 @@ def list_audience_consumers_from_space_and_audience_with_http_info(self, space_i
         _all_params = [
             'space_id',
             'id',
-            'pagination'
+            'pagination',
+            'search',
+            'sort'
         ]
         _all_params.extend(
             [
@@ -484,6 +496,12 @@ def list_audience_consumers_from_space_and_audience_with_http_info(self, space_i
         if _params.get('pagination') is not None:  # noqa: E501
             _query_params.append(('pagination', _params['pagination']))
 
+        if _params.get('search') is not None:  # noqa: E501
+            _query_params.append(('search', _params['search']))
+
+        if _params.get('sort') is not None:  # noqa: E501
+            _query_params.append(('sort', _params['sort']))
+
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
         # process the form parameters

segment_public_api/models/__init__.py

@@ -306,6 +306,8 @@
 from segment_public_api.models.label_v1 import LabelV1
 from segment_public_api.models.list_audience_consumers_from_space_and_audience200_response import ListAudienceConsumersFromSpaceAndAudience200Response
 from segment_public_api.models.list_audience_consumers_from_space_and_audience_output import ListAudienceConsumersFromSpaceAndAudienceOutput
+from segment_public_api.models.list_audience_consumers_search_input import ListAudienceConsumersSearchInput
+from segment_public_api.models.list_audience_consumers_sort_input import ListAudienceConsumersSortInput
 from segment_public_api.models.list_audiences200_response import ListAudiences200Response
 from segment_public_api.models.list_audiences_alpha_output import ListAudiencesAlphaOutput
 from segment_public_api.models.list_audit_events200_response import ListAuditEvents200Response

segment_public_api/models/list_audience_consumers_search_input.py

@@ -0,0 +1,81 @@
+# coding: utf-8
+
+"""
+    Segment Public API
+
+    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: 58.1.1
+    Contact: friends@segment.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+
+from pydantic import BaseModel, Field, StrictStr, validator
+
+class ListAudienceConsumersSearchInput(BaseModel):
+    """
+    Search criteria input for list audience consumers.  # noqa: E501
+    """
+    type: StrictStr = Field(..., description="Field to filter by.")
+    query: StrictStr = Field(..., description="Text to match the field value.")
+    __properties = ["type", "query"]
+
+    @validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in ('DEFINITION', 'NAME'):
+            raise ValueError("must be one of enum values ('DEFINITION', 'NAME')")
+        return value
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> ListAudienceConsumersSearchInput:
+        """Create an instance of ListAudienceConsumersSearchInput from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ListAudienceConsumersSearchInput:
+        """Create an instance of ListAudienceConsumersSearchInput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ListAudienceConsumersSearchInput.parse_obj(obj)
+
+        _obj = ListAudienceConsumersSearchInput.parse_obj({
+            "type": obj.get("type"),
+            "query": obj.get("query")
+        })
+        return _obj
+
+

segment_public_api/models/list_audience_consumers_sort_input.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+    Segment Public API
+
+    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: 58.1.1
+    Contact: friends@segment.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+
+from pydantic import BaseModel, Field, StrictStr, validator
+
+class ListAudienceConsumersSortInput(BaseModel):
+    """
+    Sort criteria input for list audience consumers.  # noqa: E501
+    """
+    field: StrictStr = Field(..., description="Field to sort by.")
+    direction: StrictStr = Field(..., description="Sort direction (ascending or descending).")
+    __properties = ["field", "direction"]
+
+    @validator('field')
+    def field_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in ('CREATED_AT', 'NAME', 'UPDATED_AT'):
+            raise ValueError("must be one of enum values ('CREATED_AT', 'NAME', 'UPDATED_AT')")
+        return value
+
+    @validator('direction')
+    def direction_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in ('ASC', 'DESC'):
+            raise ValueError("must be one of enum values ('ASC', 'DESC')")
+        return value
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> ListAudienceConsumersSortInput:
+        """Create an instance of ListAudienceConsumersSortInput from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ListAudienceConsumersSortInput:
+        """Create an instance of ListAudienceConsumersSortInput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ListAudienceConsumersSortInput.parse_obj(obj)
+
+        _obj = ListAudienceConsumersSortInput.parse_obj({
+            "field": obj.get("field"),
+            "direction": obj.get("direction")
+        })
+        return _obj
+
+