@segment/public-api-sdk-typescript 54.1.0-b9779 → 54.2.0-b9800
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/api/aPICallsApi.ts +1 -1
- package/api/apis.ts +5 -2
- package/api/audiencesApi.ts +3 -3
- package/api/auditTrailApi.ts +1 -1
- package/api/catalogApi.ts +1 -1
- package/api/computedTraitsApi.ts +3 -3
- package/api/deletionAndSuppressionApi.ts +1 -1
- package/api/deliveryOverviewApi.ts +25 -25
- package/api/destinationFiltersApi.ts +1 -1
- package/api/destinationsApi.ts +1 -1
- package/api/edgeFunctionsApi.ts +1 -1
- package/api/eventsApi.ts +1 -1
- package/api/functionsApi.ts +1 -1
- package/api/iAMGroupsApi.ts +1 -1
- package/api/iAMRolesApi.ts +1 -1
- package/api/iAMUsersApi.ts +1 -1
- package/api/labelsApi.ts +1 -1
- package/api/monthlyTrackedUsersApi.ts +1 -1
- package/api/profilesSyncApi.ts +1 -1
- package/api/reverseETLApi.ts +2 -2
- package/api/selectiveSyncApi.ts +1 -1
- package/api/sourcesApi.ts +1 -1
- package/api/spaceFiltersApi.ts +725 -0
- package/api/spacesApi.ts +1 -1
- package/api/testingApi.ts +1 -1
- package/api/trackingPlansApi.ts +1 -1
- package/api/transformationsApi.ts +1 -1
- package/api/warehousesApi.ts +1 -1
- package/api/workspacesApi.ts +1 -1
- package/dist/api/apis.d.ts +3 -1
- package/dist/api/apis.js +5 -2
- package/dist/api/apis.js.map +1 -1
- package/dist/api/spaceFiltersApi.d.ts +74 -0
- package/dist/api/spaceFiltersApi.js +550 -0
- package/dist/api/spaceFiltersApi.js.map +1 -0
- package/dist/model/createFilter200Response.d.ts +15 -0
- package/dist/model/createFilter200Response.js +21 -0
- package/dist/model/createFilter200Response.js.map +1 -0
- package/dist/model/createFilterInput.d.ts +21 -0
- package/dist/model/createFilterInput.js +56 -0
- package/dist/model/createFilterInput.js.map +1 -0
- package/dist/model/createFilterOutput.d.ts +15 -0
- package/dist/model/createFilterOutput.js +21 -0
- package/dist/model/createFilterOutput.js.map +1 -0
- package/dist/model/deleteFilterById200Response.d.ts +15 -0
- package/dist/model/deleteFilterById200Response.js +21 -0
- package/dist/model/deleteFilterById200Response.js.map +1 -0
- package/dist/model/deleteFilterByIdOutput.d.ts +14 -0
- package/dist/model/deleteFilterByIdOutput.js +21 -0
- package/dist/model/deleteFilterByIdOutput.js.map +1 -0
- package/dist/model/filter.d.ts +23 -0
- package/dist/model/filter.js +66 -0
- package/dist/model/filter.js.map +1 -0
- package/dist/model/getFilterById200Response.d.ts +15 -0
- package/dist/model/getFilterById200Response.js +21 -0
- package/dist/model/getFilterById200Response.js.map +1 -0
- package/dist/model/getFilterByIdOutput.d.ts +15 -0
- package/dist/model/getFilterByIdOutput.js +21 -0
- package/dist/model/getFilterByIdOutput.js.map +1 -0
- package/dist/model/listFiltersByIntegrationId200Response.d.ts +15 -0
- package/dist/model/listFiltersByIntegrationId200Response.js +21 -0
- package/dist/model/listFiltersByIntegrationId200Response.js.map +1 -0
- package/dist/model/listFiltersByIntegrationIdOutput.d.ts +17 -0
- package/dist/model/listFiltersByIntegrationIdOutput.js +26 -0
- package/dist/model/listFiltersByIntegrationIdOutput.js.map +1 -0
- package/dist/model/listFiltersPaginationInput.d.ts +15 -0
- package/dist/model/listFiltersPaginationInput.js +26 -0
- package/dist/model/listFiltersPaginationInput.js.map +1 -0
- package/dist/model/listFiltersPaginationOutput.d.ts +16 -0
- package/dist/model/listFiltersPaginationOutput.js +31 -0
- package/dist/model/listFiltersPaginationOutput.js.map +1 -0
- package/dist/model/models.d.ts +15 -0
- package/dist/model/models.js +45 -0
- package/dist/model/models.js.map +1 -1
- package/dist/model/updateFilterById200Response.d.ts +15 -0
- package/dist/model/updateFilterById200Response.js +21 -0
- package/dist/model/updateFilterById200Response.js.map +1 -0
- package/dist/model/updateFilterByIdInput.d.ts +21 -0
- package/dist/model/updateFilterByIdInput.js +56 -0
- package/dist/model/updateFilterByIdInput.js.map +1 -0
- package/dist/model/updateFilterByIdOutput.d.ts +15 -0
- package/dist/model/updateFilterByIdOutput.js +21 -0
- package/dist/model/updateFilterByIdOutput.js.map +1 -0
- package/model/aPICallSnapshotV1.ts +1 -1
- package/model/accessPermissionV1.ts +1 -1
- package/model/addConnectionFromSourceToWarehouse201Response.ts +1 -1
- package/model/addConnectionFromSourceToWarehouseV1Output.ts +1 -1
- package/model/addLabelsToSource200Response.ts +1 -1
- package/model/addLabelsToSource200Response1.ts +1 -1
- package/model/addLabelsToSourceAlphaInput.ts +1 -1
- package/model/addLabelsToSourceAlphaOutput.ts +1 -1
- package/model/addLabelsToSourceV1Input.ts +1 -1
- package/model/addLabelsToSourceV1Output.ts +1 -1
- package/model/addPermissionsToUser200Response.ts +1 -1
- package/model/addPermissionsToUserGroup200Response.ts +1 -1
- package/model/addPermissionsToUserGroupV1Input.ts +1 -1
- package/model/addPermissionsToUserGroupV1Output.ts +1 -1
- package/model/addPermissionsToUserV1Input.ts +1 -1
- package/model/addPermissionsToUserV1Output.ts +1 -1
- package/model/addSourceToTrackingPlan200Response.ts +1 -1
- package/model/addSourceToTrackingPlanV1Input.ts +1 -1
- package/model/addSourceToTrackingPlanV1Output.ts +1 -1
- package/model/addUsersToUserGroup200Response.ts +1 -1
- package/model/addUsersToUserGroupV1Input.ts +1 -1
- package/model/addUsersToUserGroupV1Output.ts +1 -1
- package/model/advancedWarehouseSyncScheduleV1Input.ts +1 -1
- package/model/advancedWarehouseSyncScheduleV1Output.ts +1 -1
- package/model/allowedLabelBeta.ts +1 -1
- package/model/audienceComputationDefinition.ts +1 -1
- package/model/audienceDefinition.ts +1 -1
- package/model/audienceOptions.ts +1 -1
- package/model/audienceSummary.ts +1 -1
- package/model/auditEventV1.ts +1 -1
- package/model/batchQueryMessagingSubscriptionsForSpace200Response.ts +1 -1
- package/model/batchQueryMessagingSubscriptionsForSpaceAlphaInput.ts +1 -1
- package/model/batchQueryMessagingSubscriptionsForSpaceAlphaOutput.ts +1 -1
- package/model/breakdownBeta.ts +1 -1
- package/model/commonSourceSettingsV1.ts +1 -1
- package/model/computedTraitSummary.ts +1 -1
- package/model/computedTraitsDefinition.ts +1 -1
- package/model/config.ts +2 -2
- package/model/contact.ts +1 -1
- package/model/createAudience200Response.ts +1 -1
- package/model/createAudienceAlphaInput.ts +1 -1
- package/model/createAudienceAlphaOutput.ts +1 -1
- package/model/createCloudSourceRegulation200Response.ts +1 -1
- package/model/createCloudSourceRegulationV1Input.ts +1 -1
- package/model/createCloudSourceRegulationV1Output.ts +1 -1
- package/model/createComputedTrait200Response.ts +1 -1
- package/model/createComputedTraitAlphaInput.ts +1 -1
- package/model/createComputedTraitAlphaOutput.ts +1 -1
- package/model/createDestination200Response.ts +1 -1
- package/model/createDestinationSubscription200Response.ts +1 -1
- package/model/createDestinationSubscriptionAlphaInput.ts +1 -1
- package/model/createDestinationSubscriptionAlphaOutput.ts +1 -1
- package/model/createDestinationV1Input.ts +1 -1
- package/model/createDestinationV1Output.ts +1 -1
- package/model/createEdgeFunctions200Response.ts +1 -1
- package/model/createEdgeFunctionsAlphaInput.ts +1 -1
- package/model/createEdgeFunctionsAlphaOutput.ts +1 -1
- package/model/createFilter200Response.ts +36 -0
- package/model/createFilterForDestination200Response.ts +1 -1
- package/model/createFilterForDestinationV1Input.ts +1 -1
- package/model/createFilterForDestinationV1Output.ts +1 -1
- package/model/createFilterInput.ts +104 -0
- package/model/createFilterOutput.ts +39 -0
- package/model/createFunction200Response.ts +1 -1
- package/model/createFunctionDeployment200Response.ts +1 -1
- package/model/createFunctionDeploymentV1Output.ts +1 -1
- package/model/createFunctionV1Input.ts +1 -1
- package/model/createFunctionV1Output.ts +1 -1
- package/model/createInsertFunctionInstance200Response.ts +1 -1
- package/model/createInsertFunctionInstanceAlphaInput.ts +1 -1
- package/model/createInsertFunctionInstanceAlphaOutput.ts +1 -1
- package/model/createInvites201Response.ts +1 -1
- package/model/createInvitesV1Input.ts +1 -1
- package/model/createInvitesV1Output.ts +1 -1
- package/model/createLabel201Response.ts +1 -1
- package/model/createLabelV1Input.ts +1 -1
- package/model/createLabelV1Output.ts +1 -1
- package/model/createProfilesWarehouse201Response.ts +1 -1
- package/model/createProfilesWarehouseAlphaInput.ts +1 -1
- package/model/createProfilesWarehouseAlphaOutput.ts +1 -1
- package/model/createReverseETLManualSync200Response.ts +1 -1
- package/model/createReverseETLManualSyncInput.ts +1 -1
- package/model/createReverseETLManualSyncOutput.ts +1 -1
- package/model/createReverseEtlModel201Response.ts +1 -1
- package/model/createReverseEtlModelInput.ts +1 -1
- package/model/createReverseEtlModelOutput.ts +1 -1
- package/model/createSource201Response.ts +1 -1
- package/model/createSource201Response1.ts +1 -1
- package/model/createSourceAlphaInput.ts +1 -1
- package/model/createSourceAlphaOutput.ts +1 -1
- package/model/createSourceRegulation200Response.ts +1 -1
- package/model/createSourceRegulationV1Input.ts +1 -1
- package/model/createSourceRegulationV1Output.ts +1 -1
- package/model/createSourceV1Input.ts +1 -1
- package/model/createSourceV1Output.ts +1 -1
- package/model/createTrackingPlan200Response.ts +1 -1
- package/model/createTrackingPlanV1Input.ts +1 -1
- package/model/createTrackingPlanV1Output.ts +1 -1
- package/model/createTransformation200Response.ts +1 -1
- package/model/createTransformationBetaInput.ts +1 -1
- package/model/createTransformationBetaOutput.ts +1 -1
- package/model/createTransformationV1Input.ts +1 -1
- package/model/createTransformationV1Output.ts +1 -1
- package/model/createUserGroup200Response.ts +1 -1
- package/model/createUserGroupV1Input.ts +1 -1
- package/model/createUserGroupV1Output.ts +1 -1
- package/model/createValidationInWarehouse200Response.ts +1 -1
- package/model/createValidationInWarehouseV1Input.ts +1 -1
- package/model/createValidationInWarehouseV1Output.ts +1 -1
- package/model/createWarehouse201Response.ts +1 -1
- package/model/createWarehouseV1Input.ts +1 -1
- package/model/createWarehouseV1Output.ts +1 -1
- package/model/createWorkspaceRegulation200Response.ts +1 -1
- package/model/createWorkspaceRegulationV1Input.ts +1 -1
- package/model/createWorkspaceRegulationV1Output.ts +1 -1
- package/model/createWriteKeyForSource200Response.ts +1 -1
- package/model/createWriteKeyForSourceAlphaOutput.ts +1 -1
- package/model/deleteDestination200Response.ts +1 -1
- package/model/deleteDestinationV1Output.ts +1 -1
- package/model/deleteFilterById200Response.ts +36 -0
- package/model/deleteFilterByIdOutput.ts +41 -0
- package/model/deleteFunction200Response.ts +1 -1
- package/model/deleteFunctionV1Output.ts +1 -1
- package/model/deleteInsertFunctionInstance200Response.ts +1 -1
- package/model/deleteInsertFunctionInstanceAlphaOutput.ts +1 -1
- package/model/deleteInvites200Response.ts +1 -1
- package/model/deleteInvitesV1Output.ts +1 -1
- package/model/deleteLabel200Response.ts +1 -1
- package/model/deleteLabel200Response1.ts +1 -1
- package/model/deleteLabelAlphaOutput.ts +1 -1
- package/model/deleteLabelV1Output.ts +1 -1
- package/model/deleteRegulation200Response.ts +1 -1
- package/model/deleteRegulationV1Output.ts +1 -1
- package/model/deleteReverseEtlModel200Response.ts +1 -1
- package/model/deleteReverseEtlModelOutput.ts +1 -1
- package/model/deleteSource200Response.ts +1 -1
- package/model/deleteSource200Response1.ts +1 -1
- package/model/deleteSourceAlphaOutput.ts +1 -1
- package/model/deleteSourceV1Output.ts +1 -1
- package/model/deleteTrackingPlan200Response.ts +1 -1
- package/model/deleteTrackingPlanV1Output.ts +1 -1
- package/model/deleteTransformation200Response.ts +1 -1
- package/model/deleteTransformationBetaInput.ts +1 -1
- package/model/deleteTransformationBetaOutput.ts +1 -1
- package/model/deleteTransformationV1Output.ts +1 -1
- package/model/deleteUserGroup200Response.ts +1 -1
- package/model/deleteUserGroupV1Output.ts +1 -1
- package/model/deleteUsers200Response.ts +1 -1
- package/model/deleteUsersV1Output.ts +1 -1
- package/model/deleteWarehouse200Response.ts +1 -1
- package/model/deleteWarehouseV1Output.ts +1 -1
- package/model/deliveryMetricsSummaryBeta.ts +1 -1
- package/model/deliveryOverviewDestinationFilterBy.ts +4 -4
- package/model/deliveryOverviewMetricsDatapoint.ts +2 -2
- package/model/deliveryOverviewMetricsDataset.ts +7 -7
- package/model/deliveryOverviewSourceFilterBy.ts +1 -1
- package/model/deliveryOverviewSuccessfullyReceivedFilterBy.ts +1 -1
- package/model/destinationFilterActionV1.ts +1 -1
- package/model/destinationFilterV1.ts +1 -1
- package/model/destinationMetadataActionFieldV1.ts +1 -1
- package/model/destinationMetadataActionV1.ts +1 -1
- package/model/destinationMetadataComponentV1.ts +1 -1
- package/model/destinationMetadataFeaturesV1.ts +1 -1
- package/model/destinationMetadataMethodsV1.ts +1 -1
- package/model/destinationMetadataPlatformsV1.ts +1 -1
- package/model/destinationMetadataSubscriptionPresetV1.ts +1 -1
- package/model/destinationMetadataV1.ts +1 -1
- package/model/destinationStatusV1.ts +1 -1
- package/model/destinationSubscription.ts +1 -1
- package/model/destinationSubscriptionUpdateInput.ts +1 -1
- package/model/destinationV1.ts +1 -1
- package/model/disableEdgeFunctions200Response.ts +1 -1
- package/model/disableEdgeFunctionsAlphaOutput.ts +1 -1
- package/model/echo200Response.ts +1 -1
- package/model/echo200Response1.ts +1 -1
- package/model/echoAlphaOutput.ts +1 -1
- package/model/echoV1Output.ts +1 -1
- package/model/edgeFunctionsAlpha.ts +1 -1
- package/model/eventSourceV1.ts +1 -1
- package/model/fQLDefinedPropertyV1.ts +1 -1
- package/model/filter.ts +122 -0
- package/model/functionDeployment.ts +1 -1
- package/model/functionSettingV1.ts +1 -1
- package/model/functionV1.ts +1 -1
- package/model/generateUploadURLForEdgeFunctions200Response.ts +1 -1
- package/model/generateUploadURLForEdgeFunctionsAlphaOutput.ts +1 -1
- package/model/getAdvancedSyncScheduleFromWarehouse200Response.ts +1 -1
- package/model/getAdvancedSyncScheduleFromWarehouseV1Output.ts +1 -1
- package/model/getAudience200Response.ts +1 -1
- package/model/getAudienceAlphaOutput.ts +1 -1
- package/model/getComputedTrait200Response.ts +1 -1
- package/model/getComputedTraitAlphaOutput.ts +1 -1
- package/model/getConnectionStateFromWarehouse200Response.ts +1 -1
- package/model/getConnectionStateFromWarehouseV1Output.ts +1 -1
- package/model/getDailyPerSourceAPICallsUsage200Response.ts +1 -1
- package/model/getDailyPerSourceAPICallsUsageV1Output.ts +1 -1
- package/model/getDailyPerSourceMTUUsage200Response.ts +1 -1
- package/model/getDailyPerSourceMTUUsageV1Output.ts +1 -1
- package/model/getDailyWorkspaceAPICallsUsage200Response.ts +1 -1
- package/model/getDailyWorkspaceAPICallsUsageV1Output.ts +1 -1
- package/model/getDailyWorkspaceMTUUsage200Response.ts +1 -1
- package/model/getDailyWorkspaceMTUUsageV1Output.ts +1 -1
- package/model/getDeliveryOverviewMetricsBetaOutput.ts +3 -3
- package/model/getDestination200Response.ts +1 -1
- package/model/getDestinationMetadata200Response.ts +1 -1
- package/model/getDestinationMetadataV1Output.ts +1 -1
- package/model/getDestinationV1Output.ts +1 -1
- package/model/getDestinationsCatalog200Response.ts +1 -1
- package/model/getDestinationsCatalogV1Output.ts +1 -1
- package/model/getEgressFailedMetricsFromDeliveryOverview200Response.ts +1 -1
- package/model/getEventsVolumeFromWorkspace200Response.ts +1 -1
- package/model/getEventsVolumeFromWorkspaceV1Output.ts +1 -1
- package/model/getEventsVolumeFromWorkspaceV1Query.ts +1 -1
- package/model/getFilterById200Response.ts +36 -0
- package/model/getFilterByIdOutput.ts +39 -0
- package/model/getFilterInDestination200Response.ts +1 -1
- package/model/getFilterInDestinationV1Output.ts +1 -1
- package/model/getFunction200Response.ts +1 -1
- package/model/getFunctionV1Output.ts +1 -1
- package/model/getFunctionVersion200Response.ts +1 -1
- package/model/getFunctionVersionAlphaOutput.ts +1 -1
- package/model/getInsertFunctionInstance200Response.ts +1 -1
- package/model/getInsertFunctionInstanceAlphaOutput.ts +1 -1
- package/model/getLatestFromEdgeFunctions200Response.ts +1 -1
- package/model/getLatestFromEdgeFunctionsAlphaOutput.ts +1 -1
- package/model/getMessagingSubscriptionFailureResponse.ts +1 -1
- package/model/getMessagingSubscriptionSuccessResponse.ts +1 -1
- package/model/getRegulation200Response.ts +1 -1
- package/model/getRegulationV1Output.ts +1 -1
- package/model/getReverseETLSyncStatus200Response.ts +1 -1
- package/model/getReverseETLSyncStatusOutput.ts +1 -1
- package/model/getReverseEtlModel200Response.ts +1 -1
- package/model/getReverseEtlModelOutput.ts +1 -1
- package/model/getSource200Response.ts +1 -1
- package/model/getSource200Response1.ts +1 -1
- package/model/getSourceAlphaOutput.ts +1 -1
- package/model/getSourceMetadata200Response.ts +1 -1
- package/model/getSourceMetadataV1Output.ts +1 -1
- package/model/getSourceV1Output.ts +1 -1
- package/model/getSourcesCatalog200Response.ts +1 -1
- package/model/getSourcesCatalogV1Output.ts +1 -1
- package/model/getSpace200Response.ts +1 -1
- package/model/getSpaceAlphaOutput.ts +1 -1
- package/model/getSubscriptionFromDestination200Response.ts +1 -1
- package/model/getSubscriptionFromDestinationAlphaOutput.ts +1 -1
- package/model/getSubscriptionRequest.ts +1 -1
- package/model/getTrackingPlan200Response.ts +1 -1
- package/model/getTrackingPlanV1Output.ts +1 -1
- package/model/getTransformation200Response.ts +1 -1
- package/model/getTransformationBetaInput.ts +1 -1
- package/model/getTransformationBetaOutput.ts +1 -1
- package/model/getTransformationV1Output.ts +1 -1
- package/model/getUser200Response.ts +1 -1
- package/model/getUserGroup200Response.ts +1 -1
- package/model/getUserGroupV1Output.ts +1 -1
- package/model/getUserV1Output.ts +1 -1
- package/model/getWarehouse200Response.ts +1 -1
- package/model/getWarehouseMetadata200Response.ts +1 -1
- package/model/getWarehouseMetadataV1Output.ts +1 -1
- package/model/getWarehouseV1Output.ts +1 -1
- package/model/getWarehousesCatalog200Response.ts +1 -1
- package/model/getWarehousesCatalogV1Output.ts +1 -1
- package/model/getWorkspace200Response.ts +1 -1
- package/model/getWorkspaceV1Output.ts +1 -1
- package/model/groupSourceSettingsV1.ts +1 -1
- package/model/groupSubscriptionStatus.ts +1 -1
- package/model/groupSubscriptionStatusResponse.ts +1 -1
- package/model/handleWebhookInput.ts +1 -1
- package/model/handleWebhookOutput.ts +1 -1
- package/model/hashPropertiesConfiguration.ts +1 -1
- package/model/identifySourceSettingsV1.ts +1 -1
- package/model/insertFunctionInstanceAlpha.ts +1 -1
- package/model/integrationOptionBeta.ts +1 -1
- package/model/invitePermissionV1.ts +1 -1
- package/model/inviteV1.ts +1 -1
- package/model/labelAlpha.ts +1 -1
- package/model/labelV1.ts +1 -1
- package/model/listAudiences200Response.ts +1 -1
- package/model/listAudiencesAlphaOutput.ts +1 -1
- package/model/listAuditEvents200Response.ts +1 -1
- package/model/listAuditEventsV1Output.ts +1 -1
- package/model/listComputedTraits200Response.ts +1 -1
- package/model/listComputedTraitsAlphaOutput.ts +1 -1
- package/model/listConnectedDestinationsFromSource200Response.ts +1 -1
- package/model/listConnectedDestinationsFromSource200Response1.ts +1 -1
- package/model/listConnectedDestinationsFromSourceAlphaOutput.ts +1 -1
- package/model/listConnectedDestinationsFromSourceV1Output.ts +1 -1
- package/model/listConnectedSourcesFromWarehouse200Response.ts +1 -1
- package/model/listConnectedSourcesFromWarehouseV1Output.ts +1 -1
- package/model/listConnectedWarehousesFromSource200Response.ts +1 -1
- package/model/listConnectedWarehousesFromSource200Response1.ts +1 -1
- package/model/listConnectedWarehousesFromSourceAlphaOutput.ts +1 -1
- package/model/listConnectedWarehousesFromSourceV1Output.ts +1 -1
- package/model/listDeliveryMetricsSummaryFromDestination200Response.ts +1 -1
- package/model/listDeliveryMetricsSummaryFromDestinationBetaOutput.ts +1 -1
- package/model/listDestinations200Response.ts +1 -1
- package/model/listDestinationsV1Output.ts +1 -1
- package/model/listFiltersByIntegrationId200Response.ts +36 -0
- package/model/listFiltersByIntegrationIdOutput.ts +49 -0
- package/model/listFiltersFromDestination200Response.ts +1 -1
- package/model/listFiltersFromDestinationV1Output.ts +1 -1
- package/model/listFiltersPaginationInput.ts +50 -0
- package/model/listFiltersPaginationOutput.ts +59 -0
- package/model/listFunctionItemV1.ts +1 -1
- package/model/listFunctionVersions200Response.ts +1 -1
- package/model/listFunctionVersionsAlphaOutput.ts +1 -1
- package/model/listFunctions200Response.ts +1 -1
- package/model/listFunctionsV1Output.ts +1 -1
- package/model/listInsertFunctionInstances200Response.ts +1 -1
- package/model/listInsertFunctionInstancesAlphaOutput.ts +1 -1
- package/model/listInvites200Response.ts +1 -1
- package/model/listInvitesFromUserGroup200Response.ts +1 -1
- package/model/listInvitesFromUserGroupV1Output.ts +1 -1
- package/model/listInvitesV1Output.ts +1 -1
- package/model/listLabels200Response.ts +1 -1
- package/model/listLabels200Response1.ts +1 -1
- package/model/listLabelsAlphaOutput.ts +1 -1
- package/model/listLabelsV1Output.ts +1 -1
- package/model/listProfilesWarehouseInSpace200Response.ts +1 -1
- package/model/listProfilesWarehouseInSpaceAlphaOutput.ts +1 -1
- package/model/listRegulationsFromSource200Response.ts +1 -1
- package/model/listRegulationsFromSourceV1Output.ts +1 -1
- package/model/listReverseETLSyncStatusesFromModelAndSubscriptionId200Response.ts +1 -1
- package/model/listReverseETLSyncStatusesFromModelAndSubscriptionIdOutput.ts +2 -2
- package/model/listReverseEtlModels200Response.ts +1 -1
- package/model/listReverseEtlModelsOutput.ts +1 -1
- package/model/listRoles200Response.ts +1 -1
- package/model/listRolesV1Output.ts +1 -1
- package/model/listRulesFromTrackingPlan200Response.ts +1 -1
- package/model/listRulesFromTrackingPlanV1Output.ts +1 -1
- package/model/listSchemaSettingsInSource200Response.ts +1 -1
- package/model/listSchemaSettingsInSourceV1Output.ts +1 -1
- package/model/listSelectiveSyncsFromWarehouseAndSource200Response.ts +1 -1
- package/model/listSelectiveSyncsFromWarehouseAndSourceV1Output.ts +1 -1
- package/model/listSelectiveSyncsFromWarehouseAndSpace200Response.ts +1 -1
- package/model/listSelectiveSyncsFromWarehouseAndSpaceAlphaOutput.ts +1 -1
- package/model/listSources200Response.ts +1 -1
- package/model/listSources200Response1.ts +1 -1
- package/model/listSourcesAlphaOutput.ts +1 -1
- package/model/listSourcesFromTrackingPlan200Response.ts +1 -1
- package/model/listSourcesFromTrackingPlanV1Output.ts +1 -1
- package/model/listSourcesV1Output.ts +1 -1
- package/model/listSpaces200Response.ts +1 -1
- package/model/listSpacesAlphaOutput.ts +1 -1
- package/model/listSubscriptionsFromDestination200Response.ts +1 -1
- package/model/listSubscriptionsFromDestinationAlphaOutput.ts +1 -1
- package/model/listSuppressions200Response.ts +1 -1
- package/model/listSuppressionsV1Output.ts +1 -1
- package/model/listSyncsFromWarehouse200Response.ts +1 -1
- package/model/listSyncsFromWarehouseAndSource200Response.ts +1 -1
- package/model/listSyncsFromWarehouseAndSourceV1Output.ts +1 -1
- package/model/listSyncsFromWarehouseV1Output.ts +1 -1
- package/model/listTrackingPlans200Response.ts +1 -1
- package/model/listTrackingPlansV1Output.ts +1 -1
- package/model/listTransformations200Response.ts +1 -1
- package/model/listTransformationsBetaInput.ts +1 -1
- package/model/listTransformationsBetaOutput.ts +1 -1
- package/model/listTransformationsV1Output.ts +1 -1
- package/model/listUserGroups200Response.ts +1 -1
- package/model/listUserGroupsFromUser200Response.ts +1 -1
- package/model/listUserGroupsFromUserV1Output.ts +1 -1
- package/model/listUserGroupsV1Output.ts +1 -1
- package/model/listUsers200Response.ts +1 -1
- package/model/listUsersFromUserGroup200Response.ts +1 -1
- package/model/listUsersFromUserGroupV1Output.ts +1 -1
- package/model/listUsersV1Output.ts +1 -1
- package/model/listWarehouses200Response.ts +1 -1
- package/model/listWarehousesV1Output.ts +1 -1
- package/model/listWorkspaceRegulations200Response.ts +1 -1
- package/model/listWorkspaceRegulationsV1Output.ts +1 -1
- package/model/logosBeta.ts +1 -1
- package/model/messageSubscriptionResponse.ts +1 -1
- package/model/messageSubscriptionResponseError.ts +1 -1
- package/model/messagesSubscriptionRequest.ts +1 -1
- package/model/metricBeta.ts +1 -1
- package/model/minimalUserGroupV1.ts +1 -1
- package/model/minimalUserV1.ts +1 -1
- package/model/models.ts +46 -0
- package/model/mtuSnapshotV1.ts +1 -1
- package/model/paginationInput.ts +1 -1
- package/model/paginationOutput.ts +1 -1
- package/model/permissionInputV1.ts +1 -1
- package/model/permissionResourceV1.ts +1 -1
- package/model/permissionV1.ts +1 -1
- package/model/previewDestinationFilter200Response.ts +1 -1
- package/model/previewDestinationFilterV1.ts +1 -1
- package/model/previewDestinationFilterV1Input.ts +1 -1
- package/model/previewDestinationFilterV1Output.ts +1 -1
- package/model/profilesWarehouseAlpha.ts +1 -1
- package/model/propertyRenameBeta.ts +1 -1
- package/model/propertyRenameV1.ts +1 -1
- package/model/propertyValueTransformationBeta.ts +1 -1
- package/model/propertyValueTransformationV1.ts +1 -1
- package/model/regulation.ts +1 -1
- package/model/regulationListEntryV1.ts +1 -1
- package/model/removeAudienceFromSpace200Response.ts +1 -1
- package/model/removeAudienceFromSpaceAlphaOutput.ts +1 -1
- package/model/removeComputedTraitFromSpace200Response.ts +1 -1
- package/model/removeComputedTraitFromSpaceAlphaOutput.ts +1 -1
- package/model/removeFilterFromDestination200Response.ts +1 -1
- package/model/removeFilterFromDestinationV1Output.ts +1 -1
- package/model/removeProfilesWarehouseFromSpace200Response.ts +1 -1
- package/model/removeProfilesWarehouseFromSpaceAlphaOutput.ts +1 -1
- package/model/removeRuleV1.ts +1 -1
- package/model/removeRulesFromTrackingPlan200Response.ts +1 -1
- package/model/removeRulesFromTrackingPlanV1Output.ts +1 -1
- package/model/removeSourceConnectionFromWarehouse200Response.ts +1 -1
- package/model/removeSourceConnectionFromWarehouseV1Output.ts +1 -1
- package/model/removeSourceFromTrackingPlan200Response.ts +1 -1
- package/model/removeSourceFromTrackingPlanV1Output.ts +1 -1
- package/model/removeSubscriptionFromDestination200Response.ts +1 -1
- package/model/removeSubscriptionFromDestinationAlphaOutput.ts +1 -1
- package/model/removeUsersFromUserGroup200Response.ts +1 -1
- package/model/removeUsersFromUserGroupV1Output.ts +1 -1
- package/model/removeWriteKeyFromSource200Response.ts +1 -1
- package/model/removeWriteKeyFromSourceAlphaOutput.ts +1 -1
- package/model/replaceAdvancedSyncScheduleForWarehouse200Response.ts +1 -1
- package/model/replaceAdvancedSyncScheduleForWarehouseV1Input.ts +1 -1
- package/model/replaceAdvancedSyncScheduleForWarehouseV1Output.ts +1 -1
- package/model/replaceLabelsInSource200Response.ts +1 -1
- package/model/replaceLabelsInSource200Response1.ts +1 -1
- package/model/replaceLabelsInSourceAlphaInput.ts +1 -1
- package/model/replaceLabelsInSourceAlphaOutput.ts +1 -1
- package/model/replaceLabelsInSourceV1Input.ts +1 -1
- package/model/replaceLabelsInSourceV1Output.ts +1 -1
- package/model/replaceMessagingSubscriptionsInSpaces200Response.ts +1 -1
- package/model/replaceMessagingSubscriptionsInSpacesAlphaInput.ts +1 -1
- package/model/replaceMessagingSubscriptionsInSpacesAlphaOutput.ts +1 -1
- package/model/replacePermissionsForUser200Response.ts +1 -1
- package/model/replacePermissionsForUserGroup200Response.ts +1 -1
- package/model/replacePermissionsForUserGroupV1Input.ts +1 -1
- package/model/replacePermissionsForUserGroupV1Output.ts +1 -1
- package/model/replacePermissionsForUserV1Input.ts +1 -1
- package/model/replacePermissionsForUserV1Output.ts +1 -1
- package/model/replaceRulesInTrackingPlan200Response.ts +1 -1
- package/model/replaceRulesInTrackingPlanV1Input.ts +1 -1
- package/model/replaceRulesInTrackingPlanV1Output.ts +1 -1
- package/model/replaceUsersInUserGroup200Response.ts +1 -1
- package/model/replaceUsersInUserGroupV1Input.ts +1 -1
- package/model/replaceUsersInUserGroupV1Output.ts +1 -1
- package/model/requestError.ts +1 -1
- package/model/requestErrorEnvelope.ts +1 -1
- package/model/resourceV1.ts +1 -1
- package/model/restoreFunctionVersion200Response.ts +1 -1
- package/model/restoreFunctionVersionAlphaInput.ts +1 -1
- package/model/restoreFunctionVersionAlphaOutput.ts +1 -1
- package/model/reverseETLManualSyncJobOutput.ts +1 -1
- package/model/reverseETLSyncStatus.ts +1 -1
- package/model/reverseEtlModel.ts +1 -1
- package/model/reverseEtlPeriodicScheduleConfig.ts +2 -2
- package/model/reverseEtlScheduleConfig.ts +2 -2
- package/model/reverseEtlScheduleDefinition.ts +1 -1
- package/model/reverseEtlSpecificTimeScheduleConfig.ts +1 -1
- package/model/roleV1.ts +1 -1
- package/model/ruleInputV1.ts +1 -1
- package/model/ruleV1.ts +1 -1
- package/model/scheduleConfig.ts +2 -2
- package/model/sourceAPICallSnapshotV1.ts +1 -1
- package/model/sourceAlpha.ts +1 -1
- package/model/sourceEventVolumeDatapointV1.ts +1 -1
- package/model/sourceEventVolumeV1.ts +1 -1
- package/model/sourceMetadataV1.ts +1 -1
- package/model/sourceSettingsOutputV1.ts +1 -1
- package/model/sourceV1.ts +1 -1
- package/model/space.ts +1 -1
- package/model/spaceWarehouseSchemaOverride.ts +1 -1
- package/model/spaceWarehouseSelectiveSyncItemAlpha.ts +1 -1
- package/model/streamStatusV1.ts +1 -1
- package/model/suppressedInner.ts +1 -1
- package/model/syncExtractPhase.ts +1 -1
- package/model/syncLoadPhase.ts +1 -1
- package/model/syncNoticeV1.ts +1 -1
- package/model/syncV1.ts +1 -1
- package/model/trackSourceSettingsV1.ts +1 -1
- package/model/trackingPlanV1.ts +1 -1
- package/model/traitDefinition.ts +1 -1
- package/model/traitOptions.ts +1 -1
- package/model/transformationBeta.ts +1 -1
- package/model/transformationV1.ts +1 -1
- package/model/updateAudienceForSpace200Response.ts +1 -1
- package/model/updateAudienceForSpaceAlphaOutput.ts +1 -1
- package/model/updateAudienceForSpaceInput.ts +1 -1
- package/model/updateComputedTraitForSpace200Response.ts +1 -1
- package/model/updateComputedTraitForSpaceAlphaInput.ts +1 -1
- package/model/updateComputedTraitForSpaceAlphaOutput.ts +1 -1
- package/model/updateDestination200Response.ts +1 -1
- package/model/updateDestinationV1Input.ts +1 -1
- package/model/updateDestinationV1Output.ts +1 -1
- package/model/updateFilterById200Response.ts +36 -0
- package/model/updateFilterByIdInput.ts +104 -0
- package/model/updateFilterByIdOutput.ts +39 -0
- package/model/updateFilterForDestination200Response.ts +1 -1
- package/model/updateFilterForDestinationV1Input.ts +1 -1
- package/model/updateFilterForDestinationV1Output.ts +1 -1
- package/model/updateFunction200Response.ts +1 -1
- package/model/updateFunctionV1Input.ts +1 -1
- package/model/updateFunctionV1Output.ts +1 -1
- package/model/updateGroupSubscriptionStatusResponse.ts +1 -1
- package/model/updateInsertFunctionInstance200Response.ts +1 -1
- package/model/updateInsertFunctionInstanceAlphaInput.ts +1 -1
- package/model/updateInsertFunctionInstanceAlphaOutput.ts +1 -1
- package/model/updateProfilesWarehouseForSpaceWarehouse200Response.ts +1 -1
- package/model/updateProfilesWarehouseForSpaceWarehouseAlphaInput.ts +1 -1
- package/model/updateProfilesWarehouseForSpaceWarehouseAlphaOutput.ts +1 -1
- package/model/updateReverseEtlModel200Response.ts +1 -1
- package/model/updateReverseEtlModelInput.ts +1 -1
- package/model/updateReverseEtlModelOutput.ts +1 -1
- package/model/updateRulesInTrackingPlan200Response.ts +1 -1
- package/model/updateRulesInTrackingPlanV1Input.ts +1 -1
- package/model/updateRulesInTrackingPlanV1Output.ts +1 -1
- package/model/updateSchemaSettingsInSource200Response.ts +1 -1
- package/model/updateSchemaSettingsInSourceV1Input.ts +1 -1
- package/model/updateSchemaSettingsInSourceV1Output.ts +1 -1
- package/model/updateSelectiveSyncForWarehouse200Response.ts +1 -1
- package/model/updateSelectiveSyncForWarehouseAndSpace200Response.ts +1 -1
- package/model/updateSelectiveSyncForWarehouseAndSpaceAlphaInput.ts +1 -1
- package/model/updateSelectiveSyncForWarehouseAndSpaceAlphaOutput.ts +1 -1
- package/model/updateSelectiveSyncForWarehouseV1Input.ts +1 -1
- package/model/updateSelectiveSyncForWarehouseV1Output.ts +1 -1
- package/model/updateSource200Response.ts +1 -1
- package/model/updateSource200Response1.ts +1 -1
- package/model/updateSourceAlphaInput.ts +1 -1
- package/model/updateSourceAlphaOutput.ts +1 -1
- package/model/updateSourceV1Input.ts +1 -1
- package/model/updateSourceV1Output.ts +1 -1
- package/model/updateSubscriptionForDestination200Response.ts +1 -1
- package/model/updateSubscriptionForDestinationAlphaInput.ts +1 -1
- package/model/updateSubscriptionForDestinationAlphaOutput.ts +1 -1
- package/model/updateTrackingPlan200Response.ts +1 -1
- package/model/updateTrackingPlanV1Input.ts +1 -1
- package/model/updateTrackingPlanV1Output.ts +1 -1
- package/model/updateTransformation200Response.ts +1 -1
- package/model/updateTransformationBetaInput.ts +1 -1
- package/model/updateTransformationBetaOutput.ts +1 -1
- package/model/updateTransformationV1Input.ts +1 -1
- package/model/updateTransformationV1Output.ts +1 -1
- package/model/updateUserGroup200Response.ts +1 -1
- package/model/updateUserGroupV1Input.ts +1 -1
- package/model/updateUserGroupV1Output.ts +1 -1
- package/model/updateWarehouse200Response.ts +1 -1
- package/model/updateWarehouseV1Input.ts +1 -1
- package/model/updateWarehouseV1Output.ts +1 -1
- package/model/upsertRuleV1.ts +1 -1
- package/model/userGroupV1.ts +1 -1
- package/model/userV1.ts +1 -1
- package/model/usersPerSourceSnapshotV1.ts +1 -1
- package/model/version.ts +1 -1
- package/model/warehouseAdvancedSyncV1.ts +1 -1
- package/model/warehouseMetadataV1.ts +1 -1
- package/model/warehouseSelectiveSyncItemV1.ts +1 -1
- package/model/warehouseSyncOverrideV1.ts +1 -1
- package/model/warehouseV1.ts +1 -1
- package/model/workspaceV1.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ All endpoints in the API follow REST conventions and use standard HTTP methods.
|
|
|
10
10
|
|
|
11
11
|
See the next sections for more information on how to use the Segment Public API TypeScript SDK.
|
|
12
12
|
|
|
13
|
-
Latest API and SDK version: 54.
|
|
13
|
+
Latest API and SDK version: 54.2.0
|
|
14
14
|
|
|
15
15
|
## Installation
|
|
16
16
|
|
package/api/aPICallsApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/apis.ts
CHANGED
|
@@ -40,6 +40,8 @@ export * from './selectiveSyncApi';
|
|
|
40
40
|
import { SelectiveSyncApi } from './selectiveSyncApi';
|
|
41
41
|
export * from './sourcesApi';
|
|
42
42
|
import { SourcesApi } from './sourcesApi';
|
|
43
|
+
export * from './spaceFiltersApi';
|
|
44
|
+
import { SpaceFiltersApi } from './spaceFiltersApi';
|
|
43
45
|
export * from './spacesApi';
|
|
44
46
|
import { SpacesApi } from './spacesApi';
|
|
45
47
|
export * from './testingApi';
|
|
@@ -89,6 +91,7 @@ export const APIS = [
|
|
|
89
91
|
ReverseETLApi,
|
|
90
92
|
SelectiveSyncApi,
|
|
91
93
|
SourcesApi,
|
|
94
|
+
SpaceFiltersApi,
|
|
92
95
|
SpacesApi,
|
|
93
96
|
TestingApi,
|
|
94
97
|
TrackingPlansApi,
|
|
@@ -159,7 +162,7 @@ export function configureApis(
|
|
|
159
162
|
|
|
160
163
|
for (const k of Object.keys(apis)) {
|
|
161
164
|
const key = k as keyof typeof apis;
|
|
162
|
-
headers['User-Agent'] = 'Public API SDK 54.
|
|
165
|
+
headers['User-Agent'] = 'Public API SDK 54.2.0 (TypeScript)';
|
|
163
166
|
apis[key].accessToken = token;
|
|
164
167
|
apis[key].defaultHeaders = headers;
|
|
165
168
|
}
|
|
@@ -206,7 +209,7 @@ export function configureEuApis(
|
|
|
206
209
|
|
|
207
210
|
for (const k of Object.keys(apis)) {
|
|
208
211
|
const key = k as keyof typeof apis;
|
|
209
|
-
headers['User-Agent'] = 'Public API SDK 54.
|
|
212
|
+
headers['User-Agent'] = 'Public API SDK 54.2.0 (TypeScript)';
|
|
210
213
|
apis[key].accessToken = token;
|
|
211
214
|
apis[key].defaultHeaders = headers;
|
|
212
215
|
}
|
package/api/audiencesApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -113,7 +113,7 @@ export class AudiencesApi {
|
|
|
113
113
|
}
|
|
114
114
|
|
|
115
115
|
/**
|
|
116
|
-
* Creates 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. • When called, this endpoint may generate the `Audience Created` event in the [audit trail](/tag/Audit-Trail). Note: The definition for an Audience created
|
|
116
|
+
* Creates 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. • When called, this endpoint may generate the `Audience Created` event in the [audit trail](/tag/Audit-Trail). Note: The definition for an Audience created using the API is not editable through the Segment App. The rate limit for this endpoint is 10 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.
|
|
117
117
|
* @summary Create Audience
|
|
118
118
|
* @param spaceId
|
|
119
119
|
* @param CreateAudienceAlphaInput
|
|
@@ -628,7 +628,7 @@ export class AudiencesApi {
|
|
|
628
628
|
});
|
|
629
629
|
}
|
|
630
630
|
/**
|
|
631
|
-
* Updates the enabled status for an 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. • When called, this endpoint may generate the `Audience Modified` event in the [audit trail](/tag/Audit-Trail). • Note that when an Audience is updated, the Audience will be locked from future edits until the changes have been incorporated. You can find more information [in the Segment docs](https://segment-docs.netlify.app/docs/engage/audiences/#editing-realtime-audiences-and-traits). Note: The definition for an Audience updated
|
|
631
|
+
* Updates the enabled status for an 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. • When called, this endpoint may generate the `Audience Modified` event in the [audit trail](/tag/Audit-Trail). • Note that when an Audience is updated, the Audience will be locked from future edits until the changes have been incorporated. You can find more information [in the Segment docs](https://segment-docs.netlify.app/docs/engage/audiences/#editing-realtime-audiences-and-traits). Note: The definition for an Audience updated using the API is not editable through the Segment App. The rate limit for this endpoint is 10 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.
|
|
632
632
|
* @summary Update Audience for Space
|
|
633
633
|
* @param spaceId
|
|
634
634
|
* @param id
|
package/api/auditTrailApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/catalogApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/computedTraitsApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -114,7 +114,7 @@ export class ComputedTraitsApi {
|
|
|
114
114
|
}
|
|
115
115
|
|
|
116
116
|
/**
|
|
117
|
-
* Creates a Computed Trait • 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 Computed Trait feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Computed Trait Created` event in the [audit trail](/tag/Audit-Trail). Note: The definition for a Computed Trait created
|
|
117
|
+
* Creates a Computed Trait • 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 Computed Trait feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Computed Trait Created` event in the [audit trail](/tag/Audit-Trail). Note: The definition for a Computed Trait created using the API is not editable through the Segment App. The rate limit for this endpoint is 10 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.
|
|
118
118
|
* @summary Create Computed Trait
|
|
119
119
|
* @param spaceId
|
|
120
120
|
* @param CreateComputedTraitAlphaInput
|
|
@@ -629,7 +629,7 @@ export class ComputedTraitsApi {
|
|
|
629
629
|
});
|
|
630
630
|
}
|
|
631
631
|
/**
|
|
632
|
-
* Updates the enabled status for a computed trait. • 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 Computed Trait feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Computed Trait Modified` event in the [audit trail](/tag/Audit-Trail). • Note that when a Computed Trait is updated, the Computed Trait will be locked from future edits until the changes have been incorporated. You can find more information [in the Segment docs](https://segment-docs.netlify.app/docs/unify/traits/computed-traits/#editing-realtime-traits). Note: The definition for a Computed Trait updated
|
|
632
|
+
* Updates the enabled status for a computed trait. • 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 Computed Trait feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Computed Trait Modified` event in the [audit trail](/tag/Audit-Trail). • Note that when a Computed Trait is updated, the Computed Trait will be locked from future edits until the changes have been incorporated. You can find more information [in the Segment docs](https://segment-docs.netlify.app/docs/unify/traits/computed-traits/#editing-realtime-traits). Note: The definition for a Computed Trait updated using the API is not editable through the Segment App. The rate limit for this endpoint is 10 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.
|
|
633
633
|
* @summary Update Computed Trait for Space
|
|
634
634
|
* @param spaceId
|
|
635
635
|
* @param id
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -115,11 +115,11 @@ export class DeliveryOverviewApi {
|
|
|
115
115
|
* @summary Get Egress Failed Metrics from Delivery Overview
|
|
116
116
|
* @param sourceId The sourceId for the Workspace. This parameter exists in beta.
|
|
117
117
|
* @param destinationConfigId The id tied to a Workspace Destination. This parameter exists in beta.
|
|
118
|
-
* @param startTime The ISO8601 formatted timestamp corresponding to the beginning of the requested
|
|
119
|
-
* @param endTime The ISO8601 formatted timestamp corresponding to the end of the requested
|
|
118
|
+
* @param startTime The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta.
|
|
119
|
+
* @param endTime The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta.
|
|
120
120
|
* @param granularity 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 beta.
|
|
121
|
-
* @param groupBy A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `
|
|
122
|
-
* @param filter An optional filter for `
|
|
121
|
+
* @param groupBy A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `event Name`, `event Type`, `discard Reason`, `app Version`, `subscription Id`, `activationId`, `audienceId`, and `spaceId`. This parameter exists in beta.
|
|
122
|
+
* @param filter An optional filter for `event Name`, `event Type`, `discard Reason`, `app Version`, `subscription Id`, `activationId`, `audienceId`, and/or `spaceId` that can be applied in addition to a `group By`. This parameter exists in beta.
|
|
123
123
|
* @param pagination Params to specify the page cursor and count. This parameter exists in beta.
|
|
124
124
|
*/
|
|
125
125
|
public async getEgressFailedMetricsFromDeliveryOverview(
|
|
@@ -324,11 +324,11 @@ export class DeliveryOverviewApi {
|
|
|
324
324
|
* @summary Get Egress Success Metrics from Delivery Overview
|
|
325
325
|
* @param sourceId The sourceId for the Workspace. This parameter exists in beta.
|
|
326
326
|
* @param destinationConfigId The id tied to a Workspace Destination. This parameter exists in beta.
|
|
327
|
-
* @param startTime The ISO8601 formatted timestamp corresponding to the beginning of the requested
|
|
328
|
-
* @param endTime The ISO8601 formatted timestamp corresponding to the end of the requested
|
|
327
|
+
* @param startTime The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta.
|
|
328
|
+
* @param endTime The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta.
|
|
329
329
|
* @param granularity 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 beta.
|
|
330
|
-
* @param groupBy A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `
|
|
331
|
-
* @param filter An optional filter for `
|
|
330
|
+
* @param groupBy A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `event Name`, `event Type`, `discard Reason`, `app Version`, `subscription Id`, `activationId`, `audienceId`, and `spaceId`. This parameter exists in beta.
|
|
331
|
+
* @param filter An optional filter for `event Name`, `event Type`, `discard Reason`, `appVersion`, `subscription Id`, `activationId`, `audienceId`, or `spaceId` that can be applied in addition to a `group By`. If you would like to view retry attempts for a successful delivery, you can filter `discard Reason` from `successes.attempt.1` through `successes.attempt.10`. This parameter exists in beta.
|
|
332
332
|
* @param pagination Params to specify the page cursor and count. This parameter exists in beta.
|
|
333
333
|
*/
|
|
334
334
|
public async getEgressSuccessMetricsFromDeliveryOverview(
|
|
@@ -533,11 +533,11 @@ export class DeliveryOverviewApi {
|
|
|
533
533
|
* @summary Get Filtered At Destination Metrics from Delivery Overview
|
|
534
534
|
* @param sourceId The sourceId for the Workspace. This parameter exists in beta.
|
|
535
535
|
* @param destinationConfigId The id tied to a Workspace Destination. This parameter exists in beta.
|
|
536
|
-
* @param startTime The ISO8601 formatted timestamp corresponding to the beginning of the requested
|
|
537
|
-
* @param endTime The ISO8601 formatted timestamp corresponding to the end of the requested
|
|
536
|
+
* @param startTime The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta.
|
|
537
|
+
* @param endTime The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta.
|
|
538
538
|
* @param granularity 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 beta.
|
|
539
|
-
* @param groupBy A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `
|
|
540
|
-
* @param filter An optional filter for `
|
|
539
|
+
* @param groupBy A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `event Name`, `event Type`, `discard Reason`, `app Version`, `subscription Id`, `activationId`, `audienceId`, and `spaceId`. This parameter exists in beta.
|
|
540
|
+
* @param filter An optional filter for `event Name`, `event Type`, `discard Reason`, `app Version`, `subscription Id`, `activationId`, `audienceId`, and/or `spaceId` that can be applied in addition to a `group By`. This parameter exists in beta.
|
|
541
541
|
* @param pagination Params to specify the page cursor and count. This parameter exists in beta.
|
|
542
542
|
*/
|
|
543
543
|
public async getFilteredAtDestinationMetricsFromDeliveryOverview(
|
|
@@ -741,11 +741,11 @@ export class DeliveryOverviewApi {
|
|
|
741
741
|
* Get events that were filtered at Source.
|
|
742
742
|
* @summary Get Filtered At Source Metrics from Delivery Overview
|
|
743
743
|
* @param sourceId The sourceId for the Workspace. This parameter exists in beta.
|
|
744
|
-
* @param startTime The ISO8601 formatted timestamp corresponding to the beginning of the requested
|
|
745
|
-
* @param endTime The ISO8601 formatted timestamp corresponding to the end of the requested
|
|
744
|
+
* @param startTime The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta.
|
|
745
|
+
* @param endTime The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta.
|
|
746
746
|
* @param granularity 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 beta.
|
|
747
|
-
* @param groupBy A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `
|
|
748
|
-
* @param filter An optional filter for `
|
|
747
|
+
* @param groupBy A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `event Name`, `event Type`, `discard Reason`, and `app Version`. This parameter exists in beta.
|
|
748
|
+
* @param filter An optional filter for `event Name`, `event Type`, `discard Reason`, and/or `app Version` that can be applied in addition to a `group By`. This parameter exists in beta.
|
|
749
749
|
* @param pagination Optional params to specify the page cursor and count. This parameter exists in beta.
|
|
750
750
|
*/
|
|
751
751
|
public async getFilteredAtSourceMetricsFromDeliveryOverview(
|
|
@@ -936,11 +936,11 @@ export class DeliveryOverviewApi {
|
|
|
936
936
|
* Get events that failed on ingest.
|
|
937
937
|
* @summary Get Ingress Failed Metrics from Delivery Overview
|
|
938
938
|
* @param sourceId The sourceId for the Workspace. This parameter exists in beta.
|
|
939
|
-
* @param startTime The ISO8601 formatted timestamp corresponding to the beginning of the requested
|
|
940
|
-
* @param endTime The ISO8601 formatted timestamp corresponding to the end of the requested
|
|
939
|
+
* @param startTime The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta.
|
|
940
|
+
* @param endTime The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta.
|
|
941
941
|
* @param granularity 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 beta.
|
|
942
|
-
* @param groupBy A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `
|
|
943
|
-
* @param filter An optional filter for `
|
|
942
|
+
* @param groupBy A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `event Name`, `event Type`, `discard Reason`, and/or `appVersion`. This parameter exists in beta.
|
|
943
|
+
* @param filter An optional filter for `event Name`, `event Type`, `discard Reason`, and/or `app Version` that can be applied in addition to a `group By`. This parameter exists in beta.
|
|
944
944
|
* @param pagination Optional params to specify the page cursor and count. This parameter exists in beta.
|
|
945
945
|
*/
|
|
946
946
|
public async getIngressFailedMetricsFromDeliveryOverview(
|
|
@@ -1131,11 +1131,11 @@ export class DeliveryOverviewApi {
|
|
|
1131
1131
|
* Get events that were successfully received by Segment.
|
|
1132
1132
|
* @summary Get Ingress Success Metrics from Delivery Overview
|
|
1133
1133
|
* @param sourceId The sourceId for the Workspace. This parameter exists in beta.
|
|
1134
|
-
* @param startTime The ISO8601 formatted timestamp corresponding to the beginning of the requested
|
|
1135
|
-
* @param endTime The ISO8601 formatted timestamp corresponding to the end of the requested
|
|
1134
|
+
* @param startTime The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta.
|
|
1135
|
+
* @param endTime The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta.
|
|
1136
1136
|
* @param granularity 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 beta.
|
|
1137
|
-
* @param groupBy A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `
|
|
1138
|
-
* @param filter An optional filter for `
|
|
1137
|
+
* @param groupBy A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `event Name`, `event Type`, and/or `app Version`. This parameter exists in beta.
|
|
1138
|
+
* @param filter An optional filter for `event Name`, `event Type`, and/or `app Version` that can be applied in addition to a `group By`. This parameter exists in beta.
|
|
1139
1139
|
* @param pagination Optional params to specify the page cursor and count. This parameter exists in beta.
|
|
1140
1140
|
*/
|
|
1141
1141
|
public async getIngressSuccessMetricsFromDeliveryOverview(
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/destinationsApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/edgeFunctionsApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/eventsApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/functionsApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/iAMGroupsApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/iAMRolesApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/iAMUsersApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/labelsApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/profilesSyncApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/reverseETLApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -117,7 +117,7 @@ export class ReverseETLApi {
|
|
|
117
117
|
}
|
|
118
118
|
|
|
119
119
|
/**
|
|
120
|
-
* Triggers a manual sync for a Reverse ETL Connection. In the request body, the `
|
|
120
|
+
* Triggers a manual sync for a Reverse ETL Connection. In the request body, the `subscription id` is the id that follows after `/mappings/` portion in the URL of the sync. For example, the `subscription id` would be `2` for this sync: https://app.Segment.com/example-workspace/reverse-etl/destinations/example-destination/sources/example-source/instances/1/mappings/2/source-id/3/model-id/4/sync-details The rate limit for this endpoint is 20 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.
|
|
121
121
|
* @summary Create Reverse ETL Manual Sync
|
|
122
122
|
* @param CreateReverseETLManualSyncInput
|
|
123
123
|
*/
|
package/api/selectiveSyncApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/sourcesApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Segment Public API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 54.
|
|
5
|
+
* The version of the OpenAPI document: 54.2.0
|
|
6
6
|
* Contact: friends@segment.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|