UNPKG

@port-labs/port

Version:

A Pulumi package for creating and managing Port resources.

1,979 lines 54.3 kB
import * as outputs from "../types/output"; export interface ActionApprovalEmailNotification { } export interface ActionApprovalWebhookNotification { /** * The format to invoke the webhook */ format?: string; /** * The URL to invoke the webhook */ url: string; } export interface ActionAutomationTrigger { /** * Any entity change event trigger */ anyEntityChangeEvent?: outputs.ActionAutomationTriggerAnyEntityChangeEvent; /** * Any run change event trigger */ anyRunChangeEvent?: outputs.ActionAutomationTriggerAnyRunChangeEvent; /** * Entity created event trigger */ entityCreatedEvent?: outputs.ActionAutomationTriggerEntityCreatedEvent; /** * Entity deleted event trigger */ entityDeletedEvent?: outputs.ActionAutomationTriggerEntityDeletedEvent; /** * Entity updated event trigger */ entityUpdatedEvent?: outputs.ActionAutomationTriggerEntityUpdatedEvent; /** * JQ condition for automation trigger */ jqCondition?: outputs.ActionAutomationTriggerJqCondition; /** * Run created event trigger */ runCreatedEvent?: outputs.ActionAutomationTriggerRunCreatedEvent; /** * Run updated event trigger */ runUpdatedEvent?: outputs.ActionAutomationTriggerRunUpdatedEvent; /** * Timer property expired event trigger */ timerPropertyExpiredEvent?: outputs.ActionAutomationTriggerTimerPropertyExpiredEvent; } export interface ActionAutomationTriggerAnyEntityChangeEvent { /** * The blueprint identifier of the changed entity */ blueprintIdentifier: string; } export interface ActionAutomationTriggerAnyRunChangeEvent { /** * The action identifier of the changed run */ actionIdentifier: string; } export interface ActionAutomationTriggerEntityCreatedEvent { /** * The blueprint identifier of the created entity */ blueprintIdentifier: string; } export interface ActionAutomationTriggerEntityDeletedEvent { /** * The blueprint identifier of the deleted entity */ blueprintIdentifier: string; } export interface ActionAutomationTriggerEntityUpdatedEvent { /** * The blueprint identifier of the updated entity */ blueprintIdentifier: string; } export interface ActionAutomationTriggerJqCondition { /** * The combinator of the condition */ combinator: string; /** * The jq expressions of the condition */ expressions: string[]; } export interface ActionAutomationTriggerRunCreatedEvent { /** * The action identifier of the created run */ actionIdentifier: string; } export interface ActionAutomationTriggerRunUpdatedEvent { /** * The action identifier of the updated run */ actionIdentifier: string; } export interface ActionAutomationTriggerTimerPropertyExpiredEvent { /** * The blueprint identifier of the expired timer property */ blueprintIdentifier: string; /** * The property identifier of the expired timer property */ propertyIdentifier: string; } export interface ActionAzureMethod { /** * Required when selecting type AZURE. The Azure org that the workflow belongs to */ org: string; /** * The Azure Devops workflow [payload](https://docs.getport.io/create-self-service-experiences/setup-backend/#define-the-actions-payload) should be in `JSON` format, encoded as a string. Use jsonencode to encode arrays or objects. Learn about how to [define the action payload](https://docs.getport.io/create-self-service-experiences/setup-backend/#define-the-actions-payload). */ payload?: string; /** * Required when selecting type AZURE. The Azure webhook that the workflow belongs to */ webhook: string; } export interface ActionGithubMethod { /** * Required when selecting type GITHUB. The GitHub org that the workflow belongs to */ org: string; /** * Required when selecting type GITHUB. The GitHub repo that the workflow belongs to */ repo: string; /** * Report the workflow status when invoking the action */ reportWorkflowStatus?: string; /** * The GitHub workflow that the action belongs to */ workflow: string; /** * The GitHub [workflow inputs](https://docs.getport.io/create-self-service-experiences/setup-backend/#define-the-actions-payload) should be in `JSON` format, encoded as a string. Use jsonencode to encode arrays or objects. Learn about how to [define the action payload](https://docs.getport.io/create-self-service-experiences/setup-backend/#define-the-actions-payload). */ workflowInputs?: string; } export interface ActionGitlabMethod { /** * The default ref of the action */ defaultRef?: string; /** * Required when selecting type GITLAB. The GitLab group name that the workflow belongs to */ groupName: string; /** * The Gitlab pipeline variables should be in `JSON` format, encoded as a string. Use jsonencode to encode arrays or objects. Learn about how to [define the action payload](https://docs.getport.io/create-self-service-experiences/setup-backend/#define-the-actions-payload). */ pipelineVariables?: string; /** * Required when selecting type GITLAB. The GitLab project name that the workflow belongs to */ projectName: string; } export interface ActionKafkaMethod { /** * The Kafka message [payload](https://docs.getport.io/create-self-service-experiences/setup-backend/#define-the-actions-payload) should be in `JSON` format, encoded as a string. Use jsonencode to encode arrays or objects. Learn about how to [define the action payload](https://docs.getport.io/create-self-service-experiences/setup-backend/#define-the-actions-payload). */ payload?: string; } export interface ActionPermissionsPermissions { /** * The permission to approve the action's runs */ approve: outputs.ActionPermissionsPermissionsApprove; /** * The permission to execute the action */ execute: outputs.ActionPermissionsPermissionsExecute; } export interface ActionPermissionsPermissionsApprove { /** * The policy to use for approval */ policy?: string; /** * The roles with approval permission */ roles: string[]; /** * The teams with approval permission */ teams: string[]; /** * The users with approval permission */ users: string[]; } export interface ActionPermissionsPermissionsExecute { /** * Give execution permission to the teams who own the entity */ ownedByTeam: boolean; /** * The policy to use for execution */ policy?: string; /** * The roles with execution permission */ roles: string[]; /** * The teams with execution permission */ teams: string[]; /** * The users with execution permission */ users: string[]; } export interface ActionSelfServiceTrigger { /** * The ID of the blueprint */ blueprintIdentifier?: string; /** * The `condition` field allows you to define rules using Port's [search & query syntax](https://docs.getport.io/search-and-query/#rules) to determine which entities the action will be available for. */ condition?: string; /** * The operation type of the action */ operation: string; /** * Order properties */ orderProperties?: string[]; /** * The required jq query of the property */ requiredJqQuery?: string; /** * The steps of the action */ steps?: outputs.ActionSelfServiceTriggerStep[]; /** * action titles */ titles?: { [key: string]: outputs.ActionSelfServiceTriggerTitles; }; /** * User properties */ userProperties?: outputs.ActionSelfServiceTriggerUserProperties; } export interface ActionSelfServiceTriggerStep { /** * The order of the properties in this step */ orders: string[]; /** * The step's title (max 25 characters) */ title: string; } export interface ActionSelfServiceTriggerTitles { /** * The description of the action title */ description?: string; /** * The title of the action title */ title: string; /** * The visibility of the string property */ visible?: boolean; /** * The visibility condition jq query of the string property */ visibleJqQuery?: string; } export interface ActionSelfServiceTriggerUserProperties { /** * The array property of the action */ arrayProps?: { [key: string]: outputs.ActionSelfServiceTriggerUserPropertiesArrayProps; }; /** * The boolean property of the action */ booleanProps?: { [key: string]: outputs.ActionSelfServiceTriggerUserPropertiesBooleanProps; }; /** * The number property of the action */ numberProps?: { [key: string]: outputs.ActionSelfServiceTriggerUserPropertiesNumberProps; }; /** * The object property of the action */ objectProps?: { [key: string]: outputs.ActionSelfServiceTriggerUserPropertiesObjectProps; }; /** * The string property of the action */ stringProps?: { [key: string]: outputs.ActionSelfServiceTriggerUserPropertiesStringProps; }; } export interface ActionSelfServiceTriggerUserPropertiesArrayProps { /** * An array of boolean items within the property */ booleanItems?: outputs.ActionSelfServiceTriggerUserPropertiesArrayPropsBooleanItems; /** * The default jq query of the array property */ defaultJqQuery?: string; /** * The properties that this property depends on */ dependsOns?: string[]; /** * The description of the property */ description?: string; /** * The disabled state of the array property */ disabled?: boolean; /** * The disabled state jq query of the array property */ disabledJqQuery?: string; /** * The icon of the property */ icon?: string; /** * The max items of the array property */ maxItems?: number; /** * The min items of the array property */ minItems?: number; /** * An array of number items within the property */ numberItems?: outputs.ActionSelfServiceTriggerUserPropertiesArrayPropsNumberItems; /** * An array of object items within the property */ objectItems?: outputs.ActionSelfServiceTriggerUserPropertiesArrayPropsObjectItems; /** * Whether the property is required, by default not required, this property can't be set at the same time if `requiredJqQuery` is set, and only supports true as value */ required?: boolean; /** * How to sort entities when in the self service action form in the UI */ sort?: outputs.ActionSelfServiceTriggerUserPropertiesArrayPropsSort; /** * An array of string items within the property */ stringItems?: outputs.ActionSelfServiceTriggerUserPropertiesArrayPropsStringItems; /** * The title of the property */ title?: string; /** * The visibility of the array property */ visible?: boolean; /** * The visibility condition jq query of the array property */ visibleJqQuery?: string; } export interface ActionSelfServiceTriggerUserPropertiesArrayPropsBooleanItems { /** * The default values for the boolean items */ defaults?: boolean[]; } export interface ActionSelfServiceTriggerUserPropertiesArrayPropsNumberItems { /** * The default values for the number items */ defaults?: number[]; /** * The jq query for the enum number items */ enumJqQuery?: string; /** * The enum of possible values for the number items */ enums?: number[]; } export interface ActionSelfServiceTriggerUserPropertiesArrayPropsObjectItems { /** * The default values for the object items */ defaults?: { [key: string]: string; }[]; } export interface ActionSelfServiceTriggerUserPropertiesArrayPropsSort { /** * The order to sort the entities in */ order: string; /** * The property to sort the entities by */ property: string; } export interface ActionSelfServiceTriggerUserPropertiesArrayPropsStringItems { /** * The blueprint identifier the action relates to */ blueprint?: string; /** * The dataset of the entity-format items */ dataset?: string; /** * The default value of the items */ defaults?: string[]; /** * The jq query for the enum of string items */ enumJqQuery?: string; /** * The enum of possible values for the string items */ enums?: string[]; /** * The format of the string property, Accepted values include `date-time`, `url`, `email`, `ipv4`, `ipv6`, `yaml`, `entity`, `user`, `team`, `proto`, `markdown` */ format?: string; } export interface ActionSelfServiceTriggerUserPropertiesBooleanProps { /** * The default of the boolean property */ default?: boolean; /** * The default jq query of the boolean property */ defaultJqQuery?: string; /** * The properties that this property depends on */ dependsOns?: string[]; /** * The description of the property */ description?: string; /** * The disabled state of the boolean property */ disabled?: boolean; /** * The disabled state jq query of the boolean property */ disabledJqQuery?: string; /** * The icon of the property */ icon?: string; /** * Whether the property is required, by default not required, this property can't be set at the same time if `requiredJqQuery` is set, and only supports true as value */ required?: boolean; /** * The title of the property */ title?: string; /** * The visibility of the boolean property */ visible?: boolean; /** * The visibility condition jq query of the boolean property */ visibleJqQuery?: string; } export interface ActionSelfServiceTriggerUserPropertiesNumberProps { /** * The default of the number property */ default?: number; /** * The default jq query of the number property */ defaultJqQuery?: string; /** * The properties that this property depends on */ dependsOns?: string[]; /** * The description of the property */ description?: string; /** * The disabled state of the number property */ disabled?: boolean; /** * The disabled state jq query of the number property */ disabledJqQuery?: string; /** * The enum colors of the number property */ enumColors?: { [key: string]: string; }; /** * The enum jq query of the string property */ enumJqQuery?: string; /** * The enum of the number property */ enums?: number[]; /** * The icon of the property */ icon?: string; /** * The min of the number property */ maximum?: number; /** * The max of the number property */ minimum?: number; /** * Whether the property is required, by default not required, this property can't be set at the same time if `requiredJqQuery` is set, and only supports true as value */ required?: boolean; /** * The title of the property */ title?: string; /** * The visibility of the number property */ visible?: boolean; /** * The visibility condition jq query of the number property */ visibleJqQuery?: string; } export interface ActionSelfServiceTriggerUserPropertiesObjectProps { /** * The default of the object property */ default?: string; /** * The default jq query of the object property */ defaultJqQuery?: string; /** * The properties that this property depends on */ dependsOns?: string[]; /** * The description of the property */ description?: string; /** * The disabled state of the object property */ disabled?: boolean; /** * The disabled state jq query of the object property */ disabledJqQuery?: string; /** * The algorithm to encrypt the property with. Accepted value: `aes256-gcm` */ encryption?: string; /** * The icon of the property */ icon?: string; /** * Whether the property is required, by default not required, this property can't be set at the same time if `requiredJqQuery` is set, and only supports true as value */ required?: boolean; /** * The title of the property */ title?: string; /** * The visibility of the object property */ visible?: boolean; /** * The visibility condition jq query of the object property */ visibleJqQuery?: string; } export interface ActionSelfServiceTriggerUserPropertiesStringProps { /** * The blueprint identifier the string property relates to */ blueprint?: string; /** * The dataset of an the entity-format property */ dataset?: outputs.ActionSelfServiceTriggerUserPropertiesStringPropsDataset; /** * The default of the string property */ default?: string; /** * The default jq query of the string property */ defaultJqQuery?: string; /** * The properties that this property depends on */ dependsOns?: string[]; /** * The description of the property */ description?: string; /** * The disabled state of the string property */ disabled?: boolean; /** * The disabled state jq query of the string property */ disabledJqQuery?: string; /** * The algorithm to encrypt the property with. Accepted value: `aes256-gcm` */ encryption?: string; /** * The enum colors of the string property */ enumColors?: { [key: string]: string; }; /** * The enum jq query of the string property */ enumJqQuery?: string; /** * The enum of the string property */ enums?: string[]; /** * The format of the string property, Accepted values include `date-time`, `url`, `email`, `ipv4`, `ipv6`, `yaml`, `entity`, `user`, `team`, `proto`, `markdown` */ format?: string; /** * The icon of the property */ icon?: string; /** * The max length of the string property */ maxLength?: number; /** * The min length of the string property */ minLength?: number; /** * The pattern of the string property */ pattern?: string; /** * The pattern jq query of the string property. This field accepts a JQ expression to dynamically generate either a regex pattern (as a string) or a list of allowed values (as an array). Cannot be used with `pattern`. Empty values are not allowed. Examples: `"if .env == \"prod\" then \"^[a-z]+$\" else \"^[a-zA-Z]+$\" end"` for dynamic regex patterns, or `"[\"value1\", \"value2\"]"` for a fixed list of allowed values. */ patternJqQuery?: string; /** * Whether the property is required, by default not required, this property can't be set at the same time if `requiredJqQuery` is set, and only supports true as value */ required?: boolean; /** * How to sort entities when in the self service action form in the UI */ sort?: outputs.ActionSelfServiceTriggerUserPropertiesStringPropsSort; /** * The title of the property */ title?: string; /** * The visibility of the string property */ visible?: boolean; /** * The visibility condition jq query of the string property */ visibleJqQuery?: string; } export interface ActionSelfServiceTriggerUserPropertiesStringPropsDataset { /** * The combinator of the dataset */ combinator: string; /** * The rules of the dataset */ rules: outputs.ActionSelfServiceTriggerUserPropertiesStringPropsDatasetRule[]; } export interface ActionSelfServiceTriggerUserPropertiesStringPropsDatasetRule { /** * The blueprint identifier the action relates to */ blueprint?: string; /** * The operator of the rule */ operator: string; /** * The property identifier of the rule */ property?: string; /** * The value of the rule */ value?: outputs.ActionSelfServiceTriggerUserPropertiesStringPropsDatasetRuleValue; } export interface ActionSelfServiceTriggerUserPropertiesStringPropsDatasetRuleValue { jqQuery: string; } export interface ActionSelfServiceTriggerUserPropertiesStringPropsSort { /** * The order to sort the entities in */ order: string; /** * The property to sort the entities by */ property: string; } export interface ActionUpsertEntityMethod { /** * Required when selecting type Upsert Entity. The blueprint identifier of the entity for the upsert */ blueprintIdentifier: string; /** * Upsert Entity invocation method */ mapping?: outputs.ActionUpsertEntityMethodMapping; /** * The title of the entity */ title?: string; } export interface ActionUpsertEntityMethodMapping { /** * The icon of the entity */ icon?: string; /** * Required when selecting type Upsert Entity. The entity identifier for the upsert */ identifier?: string; /** * The properties of the entity (key-value object encoded to a string) */ properties?: string; /** * The relations of the entity (key-value object encoded to a string) */ relations?: string; /** * The teams the entity belongs to */ teams?: string[]; /** * Jq that returns the teams the entity belongs to */ teamsJq?: string; } export interface ActionWebhookMethod { /** * Specifies whether to use an agent to invoke the action. This can be a boolean value (`'true''` or `'false'`) or a JQ if dynamic evaluation is needed. */ agent?: string; /** * The Webhook body should be in `JSON` format, encoded as a string. Use jsonencode to encode arrays or objects. Learn about how to [define the action payload](https://docs.getport.io/create-self-service-experiences/setup-backend/#define-the-actions-payload). */ body?: string; /** * The HTTP headers for invoking the action. They should be encoded as a key-value object to a string using jsonencode. Learn about how to [define the action payload](https://docs.getport.io/create-self-service-experiences/setup-backend/#define-the-actions-payload). */ headers?: { [key: string]: string; }; /** * The HTTP method to invoke the action */ method?: string; /** * Synchronize the action */ synchronized?: string; /** * Required when selecting type WEBHOOK. The URL to invoke the action */ url: string; } export interface AggregationPropertiesProperties { /** * The description of the aggregation property */ description?: string; /** * The icon of the aggregation property */ icon?: string; /** * The aggregation method to perform on the target blueprint, one of count*entities, average*entities, average*by*property, aggregate*by*property */ method: outputs.AggregationPropertiesPropertiesMethod; /** * Path filter to filter entities based on relation path */ pathFilters?: outputs.AggregationPropertiesPropertiesPathFilter[]; /** * Query to filter the target entities */ query?: string; /** * The identifier of the blueprint to perform the aggregation on */ targetBlueprintIdentifier: string; /** * The title of the aggregation property */ title?: string; } export interface AggregationPropertiesPropertiesMethod { /** * Function to calculate the aggregate by property value of the target entities, such as sum, min, max, median */ aggregateByProperty?: outputs.AggregationPropertiesPropertiesMethodAggregateByProperty; /** * Function to calculate the average by property value of the target entities */ averageByProperty?: outputs.AggregationPropertiesPropertiesMethodAverageByProperty; /** * Function to average the entities of the target entities */ averageEntities?: outputs.AggregationPropertiesPropertiesMethodAverageEntities; /** * Function to count the entities of the target entities */ countEntities?: boolean; } export interface AggregationPropertiesPropertiesMethodAggregateByProperty { /** * The func of the aggregate by property */ func: string; /** * The property of the aggregate by property */ property: string; } export interface AggregationPropertiesPropertiesMethodAverageByProperty { /** * The time periods to calculate the average by, e.g. hour, day, week, month */ averageOf: string; /** * The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property */ measureTimeBy: string; /** * The property name on which to calculate the average by */ property: string; } export interface AggregationPropertiesPropertiesMethodAverageEntities { /** * The time periods to calculate the average of, e.g. hour, day, week, month */ averageOf: string; /** * The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property */ measureTimeBy: string; } export interface AggregationPropertiesPropertiesPathFilter { /** * The blueprint to start the path from. Should be the target blueprint or undefined to start from the source blueprint */ fromBlueprint?: string; /** * The path array of relations to filter by */ paths: string[]; } export interface BlueprintCalculationProperties { /** * The calculation of the calculation property */ calculation: string; /** * The colorized of the calculation property */ colorized?: boolean; /** * The colors of the calculation property */ colors?: { [key: string]: string; }; /** * The description of the calculation property */ description?: string; /** * The format of the calculation property */ format?: string; /** * The icon of the calculation property */ icon?: string; /** * The title of the calculation property */ title?: string; /** * The type of the calculation property */ type: string; } export interface BlueprintKafkaChangelogDestination { } export interface BlueprintMirrorProperties { /** * The path of the mirror property */ path: string; /** * The title of the mirror property */ title?: string; } export interface BlueprintOwnership { /** * Path for the Inherited ownership type. Required when type is 'Inherited'. Must be a valid relation identifiers path. */ path?: string; /** * Optional title for the owning teams property. */ title?: string; /** * Ownership type: either 'Inherited' or 'Direct'. */ type: string; } export interface BlueprintPermissionsEntities { /** * Manage permissions to register entities of the blueprint */ register: outputs.BlueprintPermissionsEntitiesRegister; /** * Manage permissions to unregister entities of the blueprint */ unregister: outputs.BlueprintPermissionsEntitiesUnregister; /** * Manage permissions to update entities of the blueprint */ update: outputs.BlueprintPermissionsEntitiesUpdate; updateMetadataProperties: outputs.BlueprintPermissionsEntitiesUpdateMetadataProperties; /** * Manage permissions to update the entity properties */ updateProperties?: { [key: string]: outputs.BlueprintPermissionsEntitiesUpdateProperties; }; /** * Manage permissions to update the entity relations */ updateRelations?: { [key: string]: outputs.BlueprintPermissionsEntitiesUpdateRelations; }; } export interface BlueprintPermissionsEntitiesRegister { /** * Owned by team */ ownedByTeam: boolean; /** * Roles with register permissions */ roles?: string[]; /** * Teams with register permissions */ teams?: string[]; /** * Users with register permissions */ users?: string[]; } export interface BlueprintPermissionsEntitiesUnregister { /** * Owned by team */ ownedByTeam: boolean; /** * Roles with unregister permissions */ roles?: string[]; /** * Teams with unregister permissions */ teams?: string[]; /** * Users with unregister permissions */ users?: string[]; } export interface BlueprintPermissionsEntitiesUpdate { /** * Owned by team */ ownedByTeam: boolean; /** * Roles with update permissions */ roles?: string[]; /** * Teams with update permissions */ teams?: string[]; /** * Users with update permissions */ users?: string[]; } export interface BlueprintPermissionsEntitiesUpdateMetadataProperties { /** * The entity's icon */ icon: outputs.BlueprintPermissionsEntitiesUpdateMetadataPropertiesIcon; /** * Unique Entity identifier, used for API calls, programmatic access and distinguishing between different entities */ identifier: outputs.BlueprintPermissionsEntitiesUpdateMetadataPropertiesIdentifier; /** * The team this entity belongs to */ team: outputs.BlueprintPermissionsEntitiesUpdateMetadataPropertiesTeam; /** * A human-readable name for the entity */ title: outputs.BlueprintPermissionsEntitiesUpdateMetadataPropertiesTitle; } export interface BlueprintPermissionsEntitiesUpdateMetadataPropertiesIcon { /** * Owned by team */ ownedByTeam: boolean; /** * Roles with update `$icon` metadata permissions */ roles?: string[]; /** * Teams with update `$icon` metadata permissions */ teams?: string[]; /** * Users with update `$icon` metadata permissions */ users?: string[]; } export interface BlueprintPermissionsEntitiesUpdateMetadataPropertiesIdentifier { /** * Owned by team */ ownedByTeam: boolean; /** * Roles with update `$identifier` metadata permissions */ roles?: string[]; /** * Teams with update `$identifier` metadata permissions */ teams?: string[]; /** * Users with update `$identifier` metadata permissions */ users?: string[]; } export interface BlueprintPermissionsEntitiesUpdateMetadataPropertiesTeam { /** * Owned by team */ ownedByTeam: boolean; /** * Roles with update `$team` metadata permissions */ roles?: string[]; /** * Teams with update `$team` metadata permissions */ teams?: string[]; /** * Users with update `$team` metadata permissions */ users?: string[]; } export interface BlueprintPermissionsEntitiesUpdateMetadataPropertiesTitle { /** * Owned by team */ ownedByTeam: boolean; /** * Roles with update `$title` metadata permissions */ roles?: string[]; /** * Teams with update `$title` metadata permissions */ teams?: string[]; /** * Users with update `$title` metadata permissions */ users?: string[]; } export interface BlueprintPermissionsEntitiesUpdateProperties { /** * Owned by team */ ownedByTeam: boolean; /** * Roles with update specific property permissions */ roles?: string[]; /** * Teams with update specific property permissions */ teams?: string[]; /** * Users with update specific property permissions */ users?: string[]; } export interface BlueprintPermissionsEntitiesUpdateRelations { /** * Owned by team */ ownedByTeam: boolean; /** * Roles with update specific relation permissions */ roles?: string[]; /** * Teams with update specific relation permissions */ teams?: string[]; /** * Users with update specific relation permissions */ users?: string[]; } export interface BlueprintProperties { /** * The array property of the blueprint */ arrayProps?: { [key: string]: outputs.BlueprintPropertiesArrayProps; }; /** * The boolean property of the blueprint */ booleanProps?: { [key: string]: outputs.BlueprintPropertiesBooleanProps; }; /** * The number property of the blueprint */ numberProps?: { [key: string]: outputs.BlueprintPropertiesNumberProps; }; /** * The object property of the blueprint */ objectProps?: { [key: string]: outputs.BlueprintPropertiesObjectProps; }; /** * The string property of the blueprint */ stringProps?: { [key: string]: outputs.BlueprintPropertiesStringProps; }; } export interface BlueprintPropertiesArrayProps { /** * The items of the array property */ booleanItems?: outputs.BlueprintPropertiesArrayPropsBooleanItems; /** * The description of the property */ description?: string; /** * The icon of the property */ icon?: string; /** * The max items of the array property */ maxItems?: number; /** * The min items of the array property */ minItems?: number; /** * The items of the array property */ numberItems?: outputs.BlueprintPropertiesArrayPropsNumberItems; /** * The items of the array property */ objectItems?: outputs.BlueprintPropertiesArrayPropsObjectItems; /** * Whether the property is required */ required: boolean; /** * The items of the array property */ stringItems?: outputs.BlueprintPropertiesArrayPropsStringItems; /** * The title of the property */ title?: string; } export interface BlueprintPropertiesArrayPropsBooleanItems { /** * The default of the items */ defaults?: boolean[]; } export interface BlueprintPropertiesArrayPropsNumberItems { /** * The default of the items */ defaults?: number[]; } export interface BlueprintPropertiesArrayPropsObjectItems { /** * The default of the items */ defaults?: string[]; } export interface BlueprintPropertiesArrayPropsStringItems { /** * The default of the items */ defaults?: string[]; /** * The enum colors of the string array items */ enumColors?: { [key: string]: string; }; /** * The enum of the string array items */ enums?: string[]; /** * The format of the items */ format?: string; /** * The pattern of the string array items */ pattern?: string; } export interface BlueprintPropertiesBooleanProps { /** * The default of the boolean property */ default?: boolean; /** * The description of the property */ description?: string; /** * The icon of the property */ icon?: string; /** * Whether the property is required */ required: boolean; /** * The title of the property */ title?: string; } export interface BlueprintPropertiesNumberProps { /** * The default of the number property */ default?: number; /** * The description of the property */ description?: string; /** * The enum colors of the number property */ enumColors?: { [key: string]: string; }; /** * The enum of the number property */ enums?: number[]; /** * The icon of the property */ icon?: string; /** * The min of the number property */ maximum?: number; /** * The max of the number property */ minimum?: number; /** * Whether the property is required */ required: boolean; /** * The title of the property */ title?: string; } export interface BlueprintPropertiesObjectProps { /** * The default of the object property */ default?: string; /** * The description of the property */ description?: string; /** * The icon of the property */ icon?: string; /** * Whether the property is required */ required: boolean; /** * The spec of the object property */ spec?: string; /** * The title of the property */ title?: string; } export interface BlueprintPropertiesStringProps { /** * The default of the string property */ default?: string; /** * The description of the property */ description?: string; /** * The enum colors of the string property */ enumColors?: { [key: string]: string; }; /** * The enum of the string property */ enums?: string[]; /** * The format of the string property */ format?: string; /** * The icon of the property */ icon?: string; /** * The max length of the string property */ maxLength?: number; /** * The min length of the string property */ minLength?: number; /** * The pattern of the string property */ pattern?: string; /** * Whether the property is required */ required: boolean; /** * The spec of the string property */ spec?: string; /** * The spec authentication of the string property */ specAuthentication?: outputs.BlueprintPropertiesStringPropsSpecAuthentication; /** * The title of the property */ title?: string; } export interface BlueprintPropertiesStringPropsSpecAuthentication { /** * The authorizationUrl of the spec authentication */ authorizationUrl: string; /** * The clientId of the spec authentication */ clientId: string; /** * The tokenUrl of the spec authentication */ tokenUrl: string; } export interface BlueprintRelations { /** * The description of the relation */ description?: string; /** * The many of the relation */ many: boolean; /** * The required of the relation */ required: boolean; /** * The target of the relation */ target: string; /** * The title of the relation */ title?: string; } export interface BlueprintTeamInheritance { /** * The path of the team inheritance */ path: string; } export interface BlueprintWebhookChangelogDestination { /** * The agent of the webhook changelog destination */ agent?: boolean; /** * The url of the webhook changelog destination */ url: string; } export interface EntityProperties { /** * The array properties of the entity */ arrayProps?: outputs.EntityPropertiesArrayProps; /** * The bool properties of the entity */ booleanProps?: { [key: string]: boolean; }; /** * The number properties of the entity */ numberProps?: { [key: string]: number; }; /** * The object properties of the entity */ objectProps?: { [key: string]: string; }; /** * The string properties of the entity */ stringProps?: { [key: string]: string; }; } export interface EntityPropertiesArrayProps { booleanItems?: { [key: string]: boolean[]; }; numberItems?: { [key: string]: number[]; }; objectItems?: { [key: string]: string[]; }; stringItems?: { [key: string]: string[]; }; } export interface EntityRelations { /** * The many relation of the entity */ manyRelations?: { [key: string]: string[]; }; /** * The single relation of the entity */ singleRelations?: { [key: string]: string; }; } export interface GetSearchEntity { /** * The blueprint identifier the entity relates to */ blueprint: string; /** * The creation date of the entity */ createdAt: string; /** * The creator of the entity */ createdBy: string; /** * The icon of the entity */ icon: string; /** * The identifier of the entity */ identifier: string; /** * The properties of the entity */ properties: outputs.GetSearchEntityProperties; /** * The relations of the entity */ relations: outputs.GetSearchEntityRelations; /** * The runID of the action run that created the entity */ runId: string; /** * The scorecards of the entity */ scorecards: { [key: string]: outputs.GetSearchEntityScorecards; }; /** * The teams the entity belongs to */ teams: string[]; /** * The title of the entity */ title: string; /** * The last update date of the entity */ updatedAt: string; /** * The last updater of the entity */ updatedBy: string; } export interface GetSearchEntityProperties { /** * The array properties of the entity */ arrayProps: outputs.GetSearchEntityPropertiesArrayProps; /** * The bool properties of the entity */ booleanProps: { [key: string]: boolean; }; /** * The number properties of the entity */ numberProps: { [key: string]: number; }; /** * The object properties of the entity */ objectProps: { [key: string]: string; }; /** * The string properties of the entity */ stringProps: { [key: string]: string; }; } export interface GetSearchEntityPropertiesArrayProps { booleanItems: { [key: string]: boolean[]; }; numberItems: { [key: string]: number[]; }; objectItems: { [key: string]: string[]; }; stringItems: { [key: string]: string[]; }; } export interface GetSearchEntityRelations { /** * The many relation of the entity */ manyRelations: { [key: string]: string[]; }; /** * The single relation of the entity */ singleRelations: { [key: string]: string; }; } export interface GetSearchEntityScorecards { level: string; rules: outputs.GetSearchEntityScorecardsRule[]; } export interface GetSearchEntityScorecardsRule { identifier: string; level: string; status: string; } export interface IntegrationKafkaChangelogDestination { } export interface IntegrationWebhookChangelogDestination { /** * The agent of the webhook changelog destination */ agent?: boolean; /** * The url of the webhook changelog destination */ url: string; } export interface PagePermissionsRead { /** * The roles with read permission */ roles?: string[]; /** * The teams with read permission */ teams?: string[]; /** * The users with read permission */ users?: string[]; } export interface ScorecardFilter { /** * The combinator of the filter */ combinator: string; /** * The conditions of the filter. Each condition object should be encoded to a string */ conditions: string[]; } export interface ScorecardLevel { /** * The color of the level */ color: string; /** * The title of the level */ title: string; } export interface ScorecardRule { /** * The description of the rule */ description?: string; /** * The identifier of the rule */ identifier: string; /** * The level of the rule */ level: string; /** * The query of the rule */ query: outputs.ScorecardRuleQuery; /** * The title of the rule */ title: string; } export interface ScorecardRuleQuery { /** * The combinator of the query */ combinator: string; /** * The conditions of the query. Each condition object should be encoded to a string */ conditions: string[]; } export interface SystemBlueprintCalculationProperties { /** * The calculation of the calculation property */ calculation: string; /** * The colorized of the calculation property */ colorized?: boolean; /** * The colors of the calculation property */ colors?: { [key: string]: string; }; /** * The description of the calculation property */ description?: string; /** * The format of the calculation property */ format?: string; /** * The icon of the calculation property */ icon?: string; /** * The title of the calculation property */ title?: string; /** * The type of the calculation property */ type: string; } export interface SystemBlueprintMirrorProperties { /** * The path of the mirror property */ path: string; /** * The title of the mirror property */ title?: string; } export interface SystemBlueprintProperties { /** * The array property of the blueprint */ arrayProps?: { [key: string]: outputs.SystemBlueprintPropertiesArrayProps; }; /** * The boolean property of the blueprint */ booleanProps?: { [key: string]: outputs.SystemBlueprintPropertiesBooleanProps; }; /** * The number property of the blueprint */ numberProps?: { [key: string]: outputs.SystemBlueprintPropertiesNumberProps; }; /** * The object property of the blueprint */ objectProps?: { [key: string]: outputs.SystemBlueprintPropertiesObjectProps; }; /** * The string property of the blueprint */ stringProps?: { [key: string]: outputs.SystemBlueprintPropertiesStringProps; }; } export interface SystemBlueprintPropertiesArrayProps { /** * The items of the array property */ booleanItems?: outputs.SystemBlueprintPropertiesArrayPropsBooleanItems; /** * The description of the property */ description?: string; /** * The icon of the property */ icon?: string; /** * The max items of the array property */ maxItems?: number; /** * The min items of the array property */ minItems?: number; /** * The items of the array property */ numberItems?: outputs.SystemBlueprintPropertiesArrayPropsNumberItems; /** * The items of the array property */ objectItems?: outputs.SystemBlueprintPropertiesArrayPropsObjectItems; /** * Whether the property is required */ required: boolean; /** * The items of the array property */ stringItems?: outputs.SystemBlueprintPropertiesArrayPropsStringItems; /** * The title of the property */ title?: string; } export interface SystemBlueprintPropertiesArrayPropsBooleanItems { /** * The default of the items */ defaults?: boolean[]; } export interface SystemBlueprintPropertiesArrayPropsNumberItems { /** * The default of the items */ defaults?: number[]; } export interface SystemBlueprintPropertiesArrayPropsObjectItems { /** * The default of the items */ defaults?: string[]; } export interface SystemBlueprintPropertiesArrayPropsStringItems { /** * The default of the items */ defaults?: string[]; /** * The enum colors of the string array items */ enumColors?: { [key: string]: string; }; /** * The enum of the string array items */ enums?: string[]; /** * The format of the items */ format?: string; /** * The pattern of the string array items */ pattern?: string; } export interface SystemBlueprintPropertiesBooleanProps { /** * The default of the boolean property */ default?: boolean; /** * The description of the property */ description?: string; /** * The icon of the property */ icon?: string; /** * Whether the property is required */ required: boolean; /** * The title of the property */ title?: string; } export interface SystemBlueprintPropertiesNumberProps { /** * The default of the number property */ default?: number; /** * The description of the property */ description?: string; /** * The enum colors of the number property */ enumColors?: { [key: string]: string; }; /** * The enum of the number property */ enums?: number[]; /** * The icon of the property */ icon?: string; /** * The min of the number property */ maximum?: number; /** * The max of the number property */ minimum?: number; /** * Whether the property is required */ required: boolean; /** * The title of the property */ title?: string; } expor