Skip to content

Commit e5dc2de

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

File tree

11 files changed

+42
-46
lines changed

11 files changed

+42
-46
lines changed

docs/DeliveryOverviewApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ with segment_public_api.ApiClient(configuration) as api_client:
5151
end_time = '2024-01-03T00:00:00Z' # str | The ISO8601 formatted timestamp corresponding to the end of the requested timeframe, noninclusive. This parameter exists in alpha.
5252
granularity = 'day' # str | The size of each bucket in the requested window. Based on the granularity chosen, there are restrictions on the time range you can query: **Minute**: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past **Hour**: - Max Time range: 14 days - Oldest possible start time: 30 days in the past **Day**: - Max time range: 30 days - Oldest possible start time: 30 days in the past This parameter exists in alpha.
5353
pagination = segment_public_api.PaginationInput(count=10) # PaginationInput | Params to specify the page cursor and count. This parameter exists in alpha.
54-
group_by = ['[\"eventName\"]'] # List[str] | A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `eventName`, `eventType`, `discardReason`, and `appVersion`. This parameter exists in alpha. (optional)
54+
group_by = ['groupBy.0=eventName'] # List[str] | A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `eventName`, `eventType`, `discardReason`, and `appVersion`. This parameter exists in alpha. (optional)
5555
filter = segment_public_api.DeliveryOverviewFilterBy() # DeliveryOverviewFilterBy | An optional filter for `eventName`, `eventType`, `discardReason`, and/or `appVersion` that can be applied in addition to a `groupBy`. Example: `filter: {discardReason: ['discard1'], eventName: ['name1', 'name2'], eventType: ['type1']}`. This parameter exists in alpha. (optional)
5656
subscription_id = 'subscription_id_example' # str | An optional filter for actions destinations, to filter by a specific action. This parameter exists in alpha. (optional)
5757

@@ -280,7 +280,7 @@ with segment_public_api.ApiClient(configuration) as api_client:
280280
granularity = 'day' # str | The size of each bucket in the requested window. Based on the granularity chosen, there are restrictions on the time range you can query: **Minute**: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past **Hour**: - Max Time range: 14 days - Oldest possible start time: 30 days in the past **Day**: - Max time range: 30 days - Oldest possible start time: 30 days in the past This parameter exists in alpha.
281281
pagination = segment_public_api.PaginationInput(count=10) # PaginationInput | Optional params to specify the page cursor and count. This parameter exists in alpha.
282282
destination_config_id = 'destination_config_id_example' # str | The ID tied to a workspace destination. This parameter exists in alpha. (optional)
283-
group_by = ['[\"eventName\"]'] # List[str] | A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `eventName`, `eventType`, `discardReason`, and `appVersion`. This parameter exists in alpha. (optional)
283+
group_by = ['groupBy.0=eventName'] # List[str] | A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `eventName`, `eventType`, `discardReason`, and `appVersion`. This parameter exists in alpha. (optional)
284284
filter = segment_public_api.DeliveryOverviewFilterBy() # DeliveryOverviewFilterBy | An optional filter for `eventName`, `eventType`, `discardReason`, and/or `appVersion` that can be applied in addition to a `groupBy`. Example: `filter: {discardReason: ['discard1'], eventName: ['name1', 'name2'], eventType: ['type1']}`. This parameter exists in alpha. (optional)
285285
subscription_id = 'subscription_id_example' # str | An optional filter for actions destinations, to filter by a specific action. This parameter exists in alpha. (optional)
286286

docs/EventsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ with segment_public_api.ApiClient(configuration) as api_client:
4242
granularity = 'DAY' # str | The size of each bucket in the requested window. This parameter exists in v1.
4343
start_time = '2021-10-28T00:00:00Z' # str | The ISO8601 formatted timestamp that corresponds to the beginning of the requested time frame, inclusive. This parameter exists in v1.
4444
end_time = '2021-10-29T16:40:00Z' # str | The ISO8601 formatted timestamp that corresponds to the end of the requested time frame, noninclusive. Segment recommends that you lag queries 1 minute behind clock time to reduce the risk for latency to impact the counts. This parameter exists in v1.
45-
group_by = ['[\"eventType\"]'] # List[str] | A comma-delimited list of strings that represents the dimensions to group the result by. The options are: `eventName`, `eventType` and `source`. This parameter exists in v1. (optional)
45+
group_by = ['groupBy.0=eventType'] # List[str] | A comma-delimited list of strings that represents the dimensions to group the result by. The options are: `eventName`, `eventType` and `source`. This parameter exists in v1. (optional)
4646
source_id = ['source_id_example'] # List[str] | A list of strings which filters the results to the given SourceIds. This parameter exists in v1. (optional)
4747
event_name = ['event_name_example'] # List[str] | A list of strings which filters the results to the given EventNames. This parameter exists in v1. (optional)
4848
event_type = ['event_type_example'] # List[str] | A list of strings which filters the results to the given EventTypes. This parameter exists in v1. (optional)

docs/IAMGroupsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -648,7 +648,7 @@ with segment_public_api.ApiClient(configuration) as api_client:
648648
# Create an instance of the API class
649649
api_instance = segment_public_api.IAMGroupsApi(api_client)
650650
user_group_id = 'bBABwqbaDf2QdwTbW8bNEm' # str |
651-
emails = ['[\"foo@example.com\"]'] # List[str] | The list of emails to remove from the user group. This parameter exists in v1.
651+
emails = ['emails.0=foo%40example.com'] # List[str] | The list of emails to remove from the user group. This parameter exists in v1.
652652

653653
try:
654654
# Remove Users from User Group

docs/IAMUsersApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ configuration = segment_public_api.Configuration(
196196
with segment_public_api.ApiClient(configuration) as api_client:
197197
# Create an instance of the API class
198198
api_instance = segment_public_api.IAMUsersApi(api_client)
199-
emails = ['[\"foo@example.com\"]'] # List[str] | The list of emails to delete invites for. This parameter exists in v1.
199+
emails = ['emails.0=foo%40example.com'] # List[str] | The list of emails to delete invites for. This parameter exists in v1.
200200

201201
try:
202202
# Delete Invites
@@ -269,7 +269,7 @@ configuration = segment_public_api.Configuration(
269269
with segment_public_api.ApiClient(configuration) as api_client:
270270
# Create an instance of the API class
271271
api_instance = segment_public_api.IAMUsersApi(api_client)
272-
user_ids = ['[\"dLPzv57d5nRGz8U5iegLKp\"]'] # List[str] | The ids of the users to remove. This parameter exists in v1.
272+
user_ids = ['userIds.0=dLPzv57d5nRGz8U5iegLKp'] # List[str] | The ids of the users to remove. This parameter exists in v1.
273273

274274
try:
275275
# Delete Users

segment_public_api/api/deletion_and_suppression_api.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
from typing_extensions import Annotated
2323
from pydantic import Field, StrictStr, conlist, constr, validator
2424

25-
from typing import List, Optional
25+
from typing import Optional
2626

2727
from segment_public_api.models.create_cloud_source_regulation200_response import CreateCloudSourceRegulation200Response
2828
from segment_public_api.models.create_cloud_source_regulation_v1_input import CreateCloudSourceRegulationV1Input
@@ -810,7 +810,7 @@ def get_regulation_with_http_info(self, regulate_id : constr(strict=True), **kwa
810810
_request_auth=_params.get('_request_auth'))
811811

812812
@validate_arguments
813-
def list_regulations_from_source(self, source_id : constr(strict=True), pagination : Annotated[PaginationInput, Field(..., description="Pagination parameters. This parameter exists in v1.")], status : Annotated[Optional[StrictStr], Field(description="The status on which to filter returned regulations. This parameter exists in v1.")] = None, regulation_types : Annotated[Optional[conlist(conlist(StrictStr))], Field(description="The regulation types on which to filter returned regulations. This parameter exists in v1.")] = None, **kwargs) -> ListRegulationsFromSource200Response: # noqa: E501
813+
def list_regulations_from_source(self, source_id : constr(strict=True), pagination : Annotated[PaginationInput, Field(..., description="Pagination parameters. This parameter exists in v1.")], status : Annotated[Optional[StrictStr], Field(description="The status on which to filter returned regulations. This parameter exists in v1.")] = None, regulation_types : Annotated[Optional[conlist(StrictStr)], Field(description="The regulation types on which to filter returned regulations. This parameter exists in v1.")] = None, **kwargs) -> ListRegulationsFromSource200Response: # noqa: E501
814814
"""List Regulations from Source # noqa: E501
815815
816816
Lists all Source-scoped regulations. # noqa: E501
@@ -846,7 +846,7 @@ def list_regulations_from_source(self, source_id : constr(strict=True), paginati
846846
return self.list_regulations_from_source_with_http_info(source_id, pagination, status, regulation_types, **kwargs) # noqa: E501
847847

848848
@validate_arguments
849-
def list_regulations_from_source_with_http_info(self, source_id : constr(strict=True), pagination : Annotated[PaginationInput, Field(..., description="Pagination parameters. This parameter exists in v1.")], status : Annotated[Optional[StrictStr], Field(description="The status on which to filter returned regulations. This parameter exists in v1.")] = None, regulation_types : Annotated[Optional[conlist(conlist(StrictStr))], Field(description="The regulation types on which to filter returned regulations. This parameter exists in v1.")] = None, **kwargs) -> ApiResponse: # noqa: E501
849+
def list_regulations_from_source_with_http_info(self, source_id : constr(strict=True), pagination : Annotated[PaginationInput, Field(..., description="Pagination parameters. This parameter exists in v1.")], status : Annotated[Optional[StrictStr], Field(description="The status on which to filter returned regulations. This parameter exists in v1.")] = None, regulation_types : Annotated[Optional[conlist(StrictStr)], Field(description="The regulation types on which to filter returned regulations. This parameter exists in v1.")] = None, **kwargs) -> ApiResponse: # noqa: E501
850850
"""List Regulations from Source # noqa: E501
851851
852852
Lists all Source-scoped regulations. # noqa: E501
@@ -934,7 +934,7 @@ def list_regulations_from_source_with_http_info(self, source_id : constr(strict=
934934

935935
if _params.get('regulation_types') is not None: # noqa: E501
936936
_query_params.append(('regulationTypes', _params['regulation_types']))
937-
_collection_formats['regulationTypes'] = 'csv'
937+
_collection_formats['regulationTypes'] = 'multi'
938938

939939
if _params.get('pagination') is not None: # noqa: E501
940940
_query_params.append(('pagination', _params['pagination']))
@@ -1121,7 +1121,7 @@ def list_suppressions_with_http_info(self, pagination : Annotated[PaginationInpu
11211121
_request_auth=_params.get('_request_auth'))
11221122

11231123
@validate_arguments
1124-
def list_workspace_regulations(self, pagination : Annotated[PaginationInput, Field(..., description="Pagination parameters. This parameter exists in v1.")], status : Annotated[Optional[StrictStr], Field(description="The status on which to filter the returned regulations. This parameter exists in v1.")] = None, regulation_types : Annotated[Optional[conlist(conlist(StrictStr))], Field(description="The regulation types on which to filter returned regulations. This parameter exists in v1.")] = None, **kwargs) -> ListWorkspaceRegulations200Response: # noqa: E501
1124+
def list_workspace_regulations(self, pagination : Annotated[PaginationInput, Field(..., description="Pagination parameters. This parameter exists in v1.")], status : Annotated[Optional[StrictStr], Field(description="The status on which to filter the returned regulations. This parameter exists in v1.")] = None, regulation_types : Annotated[Optional[conlist(StrictStr)], Field(description="The regulation types on which to filter returned regulations. This parameter exists in v1.")] = None, **kwargs) -> ListWorkspaceRegulations200Response: # noqa: E501
11251125
"""List Workspace Regulations # noqa: E501
11261126
11271127
Lists all Workspace-scoped regulations. # noqa: E501
@@ -1155,7 +1155,7 @@ def list_workspace_regulations(self, pagination : Annotated[PaginationInput, Fie
11551155
return self.list_workspace_regulations_with_http_info(pagination, status, regulation_types, **kwargs) # noqa: E501
11561156

11571157
@validate_arguments
1158-
def list_workspace_regulations_with_http_info(self, pagination : Annotated[PaginationInput, Field(..., description="Pagination parameters. This parameter exists in v1.")], status : Annotated[Optional[StrictStr], Field(description="The status on which to filter the returned regulations. This parameter exists in v1.")] = None, regulation_types : Annotated[Optional[conlist(conlist(StrictStr))], Field(description="The regulation types on which to filter returned regulations. This parameter exists in v1.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1158+
def list_workspace_regulations_with_http_info(self, pagination : Annotated[PaginationInput, Field(..., description="Pagination parameters. This parameter exists in v1.")], status : Annotated[Optional[StrictStr], Field(description="The status on which to filter the returned regulations. This parameter exists in v1.")] = None, regulation_types : Annotated[Optional[conlist(StrictStr)], Field(description="The regulation types on which to filter returned regulations. This parameter exists in v1.")] = None, **kwargs) -> ApiResponse: # noqa: E501
11591159
"""List Workspace Regulations # noqa: E501
11601160
11611161
Lists all Workspace-scoped regulations. # noqa: E501
@@ -1237,7 +1237,7 @@ def list_workspace_regulations_with_http_info(self, pagination : Annotated[Pagin
12371237

12381238
if _params.get('regulation_types') is not None: # noqa: E501
12391239
_query_params.append(('regulationTypes', _params['regulation_types']))
1240-
_collection_formats['regulationTypes'] = 'csv'
1240+
_collection_formats['regulationTypes'] = 'multi'
12411241

12421242
if _params.get('pagination') is not None: # noqa: E501
12431243
_query_params.append(('pagination', _params['pagination']))

0 commit comments

Comments
 (0)