{"components":{"schemas":{"AIKey":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"format":"^aikey_[0-9a-v]{20}$","type":"string"},"identity_id":{"format":"^[uo]_[0-9a-v]{20}$","type":"string"},"last4":{"type":"string"},"provider":{"enum":["openai","anthropic"],"type":"string"},"tenant_id":{"format":"^t_[0-9a-v]{20}$","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","id","provider","tenant_id","updated_by_id","version_id"],"type":"object"},"ActorWorkspace":{"properties":{"database_name":{"type":"string"},"handle":{"type":"string"},"host":{"type":"string"},"id":{"type":"string"},"identity":{"$ref":"#/components/schemas/Identity"},"identity_id":{"type":"string"},"role":{"type":"string"},"workspace":{"$ref":"#/components/schemas/Workspace"},"workspace_id":{"type":"string"}},"type":"object"},"Aggregator":{"properties":{"config":{"description":"The aggregator configuration.","properties":{},"type":"object"},"connections":{"description":"The plugin or connection configuration.","items":{"type":"string"},"type":"array"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"handle":{"description":"The handle name of the aggregator.","format":"^[a-z](?:[a-z0-9]|_(?=[a-z0-9])){0,38}$","type":"string"},"handle_dynamic":{"description":"The dynamically-generated handle for the aggregator. Only populated if this is a discovered aggregator.","type":"string"},"handle_mode":{"description":"The handle mode for the aggregator.","type":"string"},"handle_prefix":{"description":"The handle prefix to use for aggregators and connections discovered by this aggregator. Only populated if this is a dynamic aggregator.","type":"string"},"id":{"description":"The unique identifier for the aggregator.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"The unique identifier for an identity where the aggregator has been created.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"integration":{"$ref":"#/components/schemas/Integration"},"integration_resource_identifier":{"description":"The source identifier for this aggregator. Only populated if its a aggregator thats been discovered by an integration.","type":"string"},"integration_resource_name":{"description":"A friendly resource name for the aggregator. Only populated if its a aggregator thats been doscovered by an integration.","type":"string"},"integration_resource_path":{"description":"The source path for this aggregator. Only populated if its a aggregator thats been discovered by an integration.","type":"string"},"integration_resource_type":{"description":"The source type for this aggregator. Only populated if its a aggregator thats been discovered by an integration.","type":"string"},"managed_by_id":{"description":"The ID of the aggregator that manages this aggregator. Only populated if this is a discovered aggregator.","type":"string"},"plugin":{"description":"The plugin name for the aggregator.","type":"string"},"tenant_id":{"description":"The unique identifier for the tenant where this aggregator is created.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"type":{"description":"Type of connection i.e aggregator or connection.","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"description":"The unique identifier for the workspace.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},"required":["connections","created_at","created_by_id","deleted_by_id","handle","id","plugin","tenant_id","updated_by_id","version_id"],"type":"object"},"AttachWorkspaceSchemaRequest":{"properties":{"aggregator_handle":{"format":"^[a-z0-9][a-z0-9-]{1,37}[a-z0-9]$","type":"string"},"connection_folder":{"format":"^[a-z0-9][a-z0-9-]{1,37}[a-z0-9]$","type":"string"},"connection_handle":{"format":"^[a-z0-9][a-z0-9-]{1,37}[a-z0-9]$","type":"string"}},"type":"object"},"AuditRecord":{"properties":{"action_type":{"description":"The action performed on the resource.","type":"string"},"actor_avatar_url":{"type":"string"},"actor_display_name":{"description":"The display name of an actor.","type":"string"},"actor_handle":{"description":"The handle name of an actor.","type":"string"},"actor_id":{"description":"The unique identifier of an actor.","type":"string"},"actor_ip":{"type":"string"},"created_at":{"description":"The time when the audit log was recorded.","type":"string"},"data":{"description":"The data which has been modified on the entity.","properties":{},"type":"object"},"id":{"description":"The unique identifier for an audit log.","type":"string"},"identity_handle":{"description":"The handle name for an identity where the action has been performed.","type":"string"},"identity_id":{"description":"The unique identifier for an identity where the action has been performed.","type":"string"},"process_id":{"type":"string"},"target_handle":{"description":"The handle name of the entity on which the action has been performed.","type":"string"},"target_id":{"description":"The unique identifier of the entity on which the action has been performed.","type":"string"},"tenant_id":{"description":"The unique identifier for the where the action has been performed.","type":"string"}},"required":["action_type","actor_avatar_url","actor_display_name","actor_handle","actor_id","actor_ip","created_at","data","id","tenant_id"],"type":"object"},"BillingInfo":{"properties":{"cycle_anchor":{"description":"The time when the org was created in ISO 8601 UTC.","type":"string"},"delete_at":{"description":"The time when the identity will be deleted from Pipes.","type":"string"},"delete_at_reason":{"description":"The reason for the upcoming deletion.","type":"string"},"status":{"description":"The billing status for the org.","enum":["preview","trial","active","payment_failed"],"type":"string"},"status_updated_at":{"description":"When the billing status for the org was last updated.","type":"string"},"suspend_at":{"description":"The time when the org will be suspended due to failed billing in ISO 8601 UTC.","type":"string"},"suspend_at_reason":{"description":"The reason for the upcoming suspension.","type":"string"}},"required":["status"],"type":"object"},"BillingInvoice":{"properties":{"attempt_count":{"type":"integer"},"attempted":{"type":"boolean"},"billing_reason":{"type":"string"},"created_at":{"type":"string"},"currency":{"type":"string"},"hosted_invoice_url":{"type":"string"},"id":{"type":"string"},"invoice_pdf":{"type":"string"},"next_payment_attempt":{"type":"string"},"period_end":{"type":"string"},"period_start":{"type":"string"},"receipt_number":{"type":"string"},"status":{"type":"string"},"total":{"type":"integer"}},"required":["created_at","next_payment_attempt","period_end","period_start"],"type":"object"},"BillingSetupIntent":{"properties":{"client_secret":{"type":"string"},"id":{"type":"string"}},"type":"object"},"BillingSubscription":{"properties":{"cancel_at":{"type":"string"},"cancel_at_period_end":{"type":"string"},"canceled_at":{"type":"string"},"created_at":{"type":"string"},"currency":{"type":"string"},"current_period_end":{"type":"string"},"current_period_start":{"type":"string"},"default_payment_method_id":{"type":"string"},"id":{"format":"^sub_[0-9a-v]{20}$","type":"string"},"items":{"items":{"$ref":"#/components/schemas/BillingSubscriptionItem"},"type":"array"},"status":{"type":"string"}},"required":["cancel_at","cancel_at_period_end","canceled_at","created_at","currency","current_period_end","current_period_start","id"],"type":"object"},"BillingSubscriptionItem":{"properties":{"billing_scheme":{"description":"Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount\n(specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed),\nor per unit of total usage (for prices with usage_type=metered).\ntiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers\nand tiers_mode attributes.","type":"string"},"id":{"format":"^si_[0-9a-v]{20}$","type":"string"},"pricing_id":{"format":"^price_[0-9a-v]{20}$","type":"string"},"quantity":{"type":"integer"},"unit_amount":{"description":"The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.","type":"integer"}},"required":["billing_scheme","id","pricing_id","quantity","unit_amount"],"type":"object"},"Card":{"properties":{"brand":{"type":"string"},"country":{"type":"string"},"exp_month":{"type":"integer"},"exp_year":{"type":"integer"},"funding":{"type":"string"},"last4":{"type":"string"}},"type":"object"},"ChatRequest":{"properties":{"conversation_id":{"format":"^conv[0-9a-v]{20}$","type":"string"},"message":{"type":"string"},"model":{"type":"string"},"provider":{"description":"TODO: should provider be inferred from the model?","type":"string"}},"type":"object"},"CmdDatatankPartRequest":{"properties":{"command":{"format":"refresh","type":"string"}},"required":["command"],"type":"object"},"Connection":{"properties":{"config":{"description":"The plugin or connection configuration.","properties":{},"type":"object"},"config_source":{"description":"The source of the configuration that the conection will use. One of `self` or `integration`.","type":"string"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"credential_source":{"description":"The source of the credential that the conection will use. One of `self` or `integration`.","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"handle":{"description":"The handle name of the  connection.","format":"^[a-z](?:[a-z0-9]|_(?=[a-z0-9])){0,38}$","type":"string"},"handle_dynamic":{"description":"The dynamically-generated handle for the connection. Only populated if this is a discovered connection.","type":"string"},"handle_mode":{"description":"The handle mode for the connection.","type":"string"},"id":{"description":"The unique identifier for the connection.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"The unique identifier for an identity where the connection has been created.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"integration":{"$ref":"#/components/schemas/Integration"},"integration_resource_identifier":{"description":"The source identifier for this connection. Only populated if its a connection thats been discovered by an integration.","type":"string"},"integration_resource_name":{"description":"A friendly resource name for the connection. Only populated if its a connection thats been doscovered by an integration.","type":"string"},"integration_resource_path":{"description":"The source path for this connection. Only populated if its a connection thats been discovered by an integration.","type":"string"},"integration_resource_type":{"description":"The source type for this connection. Only populated if its a connection thats been discovered by an integration.","type":"string"},"last_error_at":{"type":"string"},"last_error_process_id":{"type":"string"},"last_successful_update_at":{"type":"string"},"last_successful_update_process_id":{"type":"string"},"last_update_attempt_at":{"type":"string"},"last_update_attempt_process_id":{"type":"string"},"managed_by_id":{"description":"The ID of the aggregator that manages this connection. Only populated if this is a discovered connection.","type":"string"},"parent_id":{"description":"The id of the entity where the connection is stored. Can be either tenant, identity, workspace or connection-folder.","type":"string"},"plugin":{"description":"The plugin name for the connection.","type":"string"},"plugin_version":{"description":"The plugin version for the connection.","type":"string"},"status":{"description":"The status of the connection.","type":"string"},"tenant_id":{"description":"The unique identifier for the tenant where the connection has been created.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"title":{"description":"The title of the connection. Only populated when the connection is of type connection folder.","type":"string"},"trunk":{"description":"The trunk for the connection.","items":{"$ref":"#/components/schemas/ConnectionTrunkItem"},"type":"array"},"type":{"description":"Type of connection i.e aggregator or connection.","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"description":"The unique identifier for the workspace where the connection has been created.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},"required":["created_at","created_by_id","deleted_by_id","id","parent_id","tenant_id","updated_by_id","version_id"],"type":"object"},"ConnectionTestResult":{"properties":{"reason":{"type":"string"},"status":{"type":"string"}},"type":"object"},"ConnectionTrunkItem":{"properties":{"id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"Constraint":{"properties":{"approval":{"description":"The status of the setting requested for the constraint at this level.","type":"string"},"datatank_id":{"description":"The datatank id for which the constraint applies to.","type":"string"},"datatank_table_id":{"description":"The datatank table id for which the constraint applies to.","type":"string"},"description":{"description":"A short description of the constraint.","type":"string"},"limit":{"nullable":true},"name":{"description":"The name of the constraint.","type":"string"},"org_id":{"description":"The org id for which the constraint applies to.","type":"string"},"pipeline_id":{"description":"The pipeline id for which the constraint applies to.","type":"string"},"plan_id":{"description":"The plan id for which the constraint applies to.","type":"string"},"setting":{"nullable":true},"statistics":{"nullable":true},"target":{"description":"The resource which the constraint targets.","type":"string"},"tenant_id":{"description":"The tenant id for which the constraint applies to.","type":"string"},"type":{"description":"The type of constraint. Can be one of rate, quota, range, feature or constant.","type":"string"},"user_id":{"description":"The user id for which the constraint applies to.","type":"string"},"value":{"nullable":true},"value_from":{"description":"The id of the item from which the value is inherited.","type":"string"},"visibility":{"description":"The visibility of the constraint. Can be one of public or private.","type":"string"},"workspace_id":{"description":"The workspace id for which the constraint applies to.","type":"string"}},"required":["name","target","type","value","value_from","visibility"],"type":"object"},"ConstraintOverrideRequest":{"properties":{"setting":{"nullable":true}}},"Conversation":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"type":"string"},"identity_id":{"format":"^[uo]_[0-9a-v]{20}$","type":"string"},"last_model":{"type":"string"},"provider":{"type":"string"},"tenant_id":{"format":"^t_[0-9a-v]{20}$","type":"string"},"title":{"type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"format":"^w_[0-9a-v]{20}$","type":"string"}},"required":["created_at","created_by_id","deleted_by_id","tenant_id","updated_by_id","version_id","workspace_id"],"type":"object"},"ConversationArtifact":{"properties":{"canvas_id":{"type":"string"},"conversation_id":{"format":"^conv_[0-9a-v]{20}$","type":"string"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"format":"^art_[0-9a-v]{20}$","type":"string"},"kind":{"type":"string"},"language":{"type":"string"},"row_count":{"type":"integer"},"sql":{"type":"string"},"title":{"type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"usage_storage_bytes":{"type":"integer"}},"required":["conversation_id","created_at","created_by_id","id","kind","updated_by_id"],"type":"object"},"ConversationMessage":{"properties":{"artifact_id":{"type":"string"},"artifact_type":{"type":"string"},"canvas_id":{"type":"string"},"content":{"properties":{},"type":"object"},"conversation_id":{"type":"string"},"created_at":{"type":"string"},"created_by_id":{"format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"type":"string"},"message_type":{"type":"string"},"metadata":{"properties":{},"type":"object"},"param":{"properties":{},"type":"object"},"role":{"type":"string"},"thinking_id":{"type":"string"},"tool_call_id":{"type":"string"}},"required":["created_at","created_by_id"],"type":"object"},"CreateAIKeyRequest":{"properties":{"api_key":{"type":"string"},"provider":{"enum":["openai","anthropic"],"type":"string"}},"required":["api_key","provider"],"type":"object"},"CreateAggregatorRequest":{"properties":{"config":{"description":"The configuration for the aggregator.","properties":{},"type":"object"},"connections":{"description":"The connections that are a part of the aggregator.","items":{"type":"string"},"type":"array"},"handle":{"description":"The handle of the aggregator.","format":"^[a-z](?:[a-z0-9]|_(?=[a-z0-9])){0,38}$","type":"string"},"plugin":{"type":"string"}},"required":["handle","plugin"],"type":"object"},"CreateAvatarResponse":{"properties":{"avatar_url":{"description":"The URL of the uploaded avatar.","type":"string"}},"type":"object"},"CreateConnectionFolderRequest":{"properties":{"parent_id":{"type":"string"},"title":{"format":"^[a-z](?:[a-z0-9]|_(?=[a-z0-9])){0,38}$","type":"string"}},"required":["title"],"type":"object"},"CreateConnectionRequest":{"properties":{"config":{"properties":{},"type":"object"},"handle":{"format":"^[a-z](?:[a-z0-9]|_(?=[a-z0-9])){0,38}$","type":"string"},"parent_id":{"type":"string"},"plugin":{"type":"string"}},"required":["handle","plugin"],"type":"object"},"CreateDatatankRequest":{"properties":{"description":{"type":"string"},"desired_state":{"enum":["enabled","disabled"],"type":"string"},"handle":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},"required":["handle"],"type":"object"},"CreateDatatankTableRequest":{"properties":{"description":{"type":"string"},"desired_state":{"enum":["enabled","disabled"],"type":"string"},"frequency":{"$ref":"#/components/schemas/PipelineFrequency"},"name":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"},"part_per":{"enum":["connection"],"type":"string"},"skip_initial_refresh":{"type":"boolean"},"source_query":{"type":"string"},"source_schema":{"type":"string"},"source_table":{"type":"string"},"type":{"enum":["table","query"],"type":"string"}},"required":["name","type"],"type":"object"},"CreateFlowpipeInputRequest":{"properties":{"execution_id":{"format":"^p_[0-9a-v]{20}$","type":"string"},"inputs":{"properties":{},"type":"object"},"message":{"type":"string"},"notifier_name":{"type":"string"},"overrides":{"properties":{},"type":"object"},"pipeline_execution_id":{"format":"^pexec_[0-9a-v]{20}$","type":"string"},"step_execution_id":{"format":"^sexec_[0-9a-v]{20}$","type":"string"},"step_type":{"enum":["input","message"],"type":"string"}},"required":["execution_id","notifier_name","step_execution_id","step_type"],"type":"object"},"CreateIntegrationRequest":{"properties":{"config":{"description":"The configuration for the integration.","properties":{},"type":"object"},"handle":{"description":"The handle for the integration.","type":"string"},"type":{"description":"The type of the integration, can be one of `aws`, `azure`, `gcp`, `gitlab` or `github`.","enum":["aws","azure","gcp","github","slack","gitlab"],"type":"string"}},"required":["handle","type"],"type":"object"},"CreateNotifierRequest":{"properties":{"name":{"description":"The name of the notifier to create","format":"^[a-z](?:[a-z0-9]|_(?=[a-z0-9])){0,38}$","type":"string"},"notifies":{"description":"The notify targets for the notifier to create","items":{"properties":{},"type":"object"},"type":"array"},"state":{"description":"The state of the notifier to create","format":"^(enabled|disabled)$","type":"string"}},"required":["name","notifies"],"type":"object"},"CreateOrgRequest":{"properties":{"display_name":{"type":"string"},"handle":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]){0,18}[a-z0-9]?$","type":"string"},"plan_id":{"type":"string"},"url":{"type":"string"}},"required":["handle"],"type":"object"},"CreateOrgUserRequest":{"properties":{"handle":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"role":{"type":"string"}},"required":["handle","role"],"type":"object"},"CreateOrgWorkspaceUserRequest":{"properties":{"handle":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"role":{"type":"string"}},"required":["handle","role"],"type":"object"},"CreatePermissionRequest":{"properties":{"identity_handle":{"type":"string"},"tenant_handle":{"type":"string"},"workspace_handle":{"type":"string"}},"type":"object"},"CreatePipelineRequest":{"properties":{"args":{"nullable":true},"desired_state":{"description":"The desired state of the pipeline.","enum":["enabled","disabled"],"type":"string"},"frequency":{"$ref":"#/components/schemas/PipelineFrequency"},"pipeline":{"description":"The name of the pipeline to be executed.","enum":["pipeline.snapshot_dashboard","pipeline.snapshot_query"],"type":"string"},"tags":{"nullable":true},"title":{"description":"The title of the pipeline.","type":"string"}},"required":["args","frequency","pipeline","title"],"type":"object"},"CreateServiceAccountUserRequest":{"properties":{"description":{"description":"The description of the service account user.","type":"string"},"title":{"description":"The title of the service account user.","type":"string"}},"type":"object"},"CreateTenantRequest":{"properties":{"display_name":{"type":"string"},"handle":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]){0,18}[a-z0-9]?$","type":"string"},"plan_id":{"type":"string"}},"required":["handle"],"type":"object"},"CreateTokenRequest":{"properties":{"description":{"type":"string"},"expiration":{"type":"integer"},"title":{"type":"string"}},"type":"object"},"CreateTriggerRequest":{"properties":{"args":{"description":"A map of arguments to be passed to be trigger.","properties":{},"type":"object"},"description":{"description":"Optional description for the trigger.","type":"string"},"name":{"description":"The name of the trigger, has to be unique in a workspace.","type":"string"},"pipeline":{"description":"The name / identifier of the pipeline which needs to be triggered.","type":"string"},"schedule":{"$ref":"#/components/schemas/PipelineFrequency"},"state":{"description":"The state of the trigger.","enum":["enabled","disabled"],"type":"string"},"title":{"description":"Optional title for the trigger.","type":"string"}},"required":["args","pipeline","schedule"],"type":"object"},"CreateUserPasswordRequest":{"properties":{"expires_in_minutes":{"type":"integer"}},"type":"object"},"CreateUserRequest":{"properties":{"display_name":{"type":"string"},"email":{"type":"string"},"handle":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]){0,18}[a-z0-9]?$","type":"string"},"url":{"type":"string"}},"required":["email","handle"],"type":"object"},"CreateWorkspaceConnRequest":{"properties":{"connection_handle":{"format":"^[a-z0-9][a-z0-9-]{1,37}[a-z0-9]$","type":"string"}},"required":["connection_handle"],"type":"object"},"CreateWorkspaceModRequest":{"properties":{"branch":{"type":"string"},"constraint":{"type":"string"},"integration_handle":{"type":"string"},"path":{"type":"string"},"version":{"type":"string"}},"required":["path"],"type":"object"},"CreateWorkspaceModVariableSettingRequest":{"properties":{"name":{"type":"string"},"setting":{}},"required":["name","setting"],"type":"object"},"CreateWorkspaceRequest":{"properties":{"db_volume_size_bytes":{"format":"int64","type":"integer"},"desired_state":{"description":"paused is not yet supported for Workspace","enum":["enabled","disabled"],"type":"string"},"handle":{"format":"^[a-z0-9]{1,23}$","type":"string"},"instance_type":{"enum":["db1.shared","db1.small","db1.medium"],"type":"string"}},"required":["handle"],"type":"object"},"CreateWorkspaceSnapshotRequest":{"properties":{"data":{"$ref":"#/components/schemas/WorkspaceSnapshotData"},"tags":{"nullable":true},"title":{"description":"The title of the snapshot.","type":"string"},"visibility":{"description":"The visibility of the snapshot to create.","enum":["workspace","anyone_with_link"],"type":"string"}},"required":["data"],"type":"object"},"Datatank":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"description":{"type":"string"},"desired_state":{"enum":["enabled","disabled","paused"],"type":"string"},"handle":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"},"id":{"format":"^dt_[0-9a-v]{20}$","type":"string"},"identity_id":{"format":"^[uo]_[0-9a-v]{20}$","type":"string"},"state":{"enum":["created","enabled","paused","deleted"],"type":"string"},"state_reason":{"type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"format":"^w_[0-9a-v]{20}$","type":"string"}},"required":["created_at","created_by_id","deleted_by_id","description","desired_state","handle","id","identity_id","state","updated_by_id","version_id","workspace_id"],"type":"object"},"DatatankPart":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"datatank_table":{"$ref":"#/components/schemas/DatatankTable"},"datatank_table_id":{"format":"^dt_[0-9a-v]{20}$","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"desired_state":{"type":"string"},"frequency":{"$ref":"#/components/schemas/PipelineFrequency"},"freshness_state":{"type":"string"},"id":{"format":"^part_[0-9a-v]{20}$","type":"string"},"last_error_at":{"type":"string"},"last_error_process":{"$ref":"#/components/schemas/SpProcess"},"last_error_process_id":{"type":"string"},"last_successful_update_at":{"type":"string"},"last_successful_update_process":{"$ref":"#/components/schemas/SpProcess"},"last_successful_update_process_id":{"type":"string"},"last_update_attempt_at":{"type":"string"},"last_update_attempt_process":{"$ref":"#/components/schemas/SpProcess"},"last_update_attempt_process_id":{"type":"string"},"migrating_freshness_state":{"type":"string"},"migrating_last_error_at":{"type":"string"},"migrating_last_error_process_id":{"type":"string"},"migrating_last_successful_update_at":{"type":"string"},"migrating_last_successful_update_process":{"$ref":"#/components/schemas/SpProcess"},"migrating_last_successful_update_process_id":{"type":"string"},"migrating_last_update_attempt_at":{"type":"string"},"migrating_last_update_attempt_process":{"$ref":"#/components/schemas/SpProcess"},"migrating_last_update_attempt_process_id":{"type":"string"},"partition_candidate":{"type":"string"},"partition_current":{"type":"string"},"pipeline":{"$ref":"#/components/schemas/Pipeline"},"pipeline_id":{"format":"^pipe_[0-9a-v]{20}$","type":"string"},"source_connection":{"$ref":"#/components/schemas/WorkspaceSchema"},"source_connection_id":{"format":"^c_[0-9a-v]{20}$","type":"string"},"state":{"type":"string"},"state_reason":{"type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","datatank_table_id","deleted_by_id","desired_state","frequency","freshness_state","id","partition_current","pipeline_id","state","updated_by_id","version_id"],"type":"object"},"DatatankTable":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"datatank":{"$ref":"#/components/schemas/Datatank"},"datatank_id":{"format":"^dt_[0-9a-v]{20}$","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"description":{"type":"string"},"desired_state":{"enum":["enabled","disabled"],"type":"string"},"frequency":{"$ref":"#/components/schemas/PipelineFrequency"},"freshness":{"$ref":"#/components/schemas/DatatankTableFreshness"},"id":{"format":"^tbl_[0-9a-v]{20}$","type":"string"},"migrating_freshness":{"$ref":"#/components/schemas/DatatankTableFreshness"},"migrating_name":{"type":"string"},"name":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"},"part_per":{"enum":["connection"],"type":"string"},"source_query":{"type":"string"},"source_schema":{"type":"string"},"source_table":{"type":"string"},"state":{"type":"string"},"state_reason":{"type":"string"},"type":{"enum":["table","query"],"type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","datatank_id","deleted_by_id","desired_state","frequency","id","name","state","type","updated_by_id","version_id"],"type":"object"},"DatatankTableFreshness":{"properties":{"disabled":{"description":"The number of parts that are disabled.","type":"integer"},"error":{"description":"The number of parts that have never successfully run.","type":"integer"},"expired":{"description":"The number of parts that did not have a successful refresh within the extended staleness timeframe.","type":"integer"},"fresh":{"description":"The number of parts that had a successful query within the staleness timeframe.","type":"integer"},"newest_part_updated_at":{"description":"The time when any of the parts was successfully refreshed most recently.","type":"string"},"oldest_part_updated_at":{"description":"The time when any of the parts was successfully refreshed least recently.","type":"string"},"pending":{"description":"The number of parts that are yet to be executed.","type":"integer"},"removing":{"description":"The number of parts for which the data is in the process of being deleted.","type":"integer"},"stale":{"description":"The number of parts that had a successful query but not within the staleness timeframe.","type":"integer"},"total_parts":{"description":"The total number of parts in the datatank table.","type":"integer"}},"type":"object"},"DeleteAvatarResponse":{"properties":{"avatar_url":{"description":"The URL of the deleted avatar.","type":"string"}},"type":"object"},"ErrorDetailModel":{"properties":{"location":{"type":"string"},"message":{"type":"string"}},"type":"object"},"ErrorModel":{"properties":{"detail":{"type":"string"},"instance":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"},"validation_errors":{"items":{"$ref":"#/components/schemas/ErrorDetailModel"},"type":"array"}},"required":["instance","status","title","type"],"type":"object"},"FlowpipeFormResponse":{"additionalProperties":true,"type":"object"},"FlowpipeInput":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"description":"The unique ID of the Flowpipe input.","format":"^fpi_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"The unique ID of the identity that owns the Flowpipe input.","format":"^[uo]_[0-9a-v]{20}$","type":"string"},"inputs":{"description":"The form data for the Flowpipe input.","properties":{},"type":"object"},"message":{"description":"The message for the Flowpipe message step.","type":"string"},"notifier":{"$ref":"#/components/schemas/Notifier"},"notifier_id":{"description":"The name of the Flowpipe notifier to use for this input.","format":"^notifier_[0-9a-v]{20}$","type":"string"},"overrides":{"description":"The overrides for the Flowpipe input notification targets.","properties":{},"type":"object"},"process":{"$ref":"#/components/schemas/SpProcess"},"process_id":{"description":"The unique ID of the Pipes process for the Flowpipe run that owns this input.","format":"^p_[0-9a-v]{20}$","type":"string"},"random_id":{"description":"The Flowpipe execution ID for this Flowpipe input.","type":"string"},"state":{"description":"The state of the Flowpipe input.","format":"^(pending|started|finished|error)$","type":"string"},"state_reason":{"description":"The reason for the state of the Flowpipe input.","type":"string"},"step_execution_id":{"description":"The Flowpipe step execution ID for this Flowpipe input.","format":"^sexec_[0-9a-v]{20}$","type":"string"},"step_type":{"description":"The type of step for the Flowpipe step input/message.","format":"^(input|message)$","type":"string"},"tenant_id":{"description":"The unique ID of the tenant that owns the Flowpipe input.","format":"^t_[0-9a-v]{20}$","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"description":"The unique ID of the workspace that owns the Flowpipe input.","format":"^w_[0-9a-v]{20}$","type":"string"}},"required":["created_at","created_by_id","deleted_by_id","id","tenant_id","updated_by_id","version_id"],"type":"object"},"GithubRepository":{"properties":{"description":{"type":"string"},"full_name":{"type":"string"},"homepage":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"private":{"type":"boolean"}},"type":"object"},"GithubRepositoryBranch":{"properties":{"name":{"type":"string"},"protected":{"type":"boolean"}},"type":"object"},"GitlabProject":{"properties":{"description":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"path_with_namespace":{"type":"string"},"visibility":{"type":"string"}},"type":"object"},"GitlabProjectBranch":{"properties":{"name":{"type":"string"},"protected":{"type":"boolean"}},"type":"object"},"Identity":{"properties":{"avatar_url":{"description":"The avatar URL of the identity.","type":"string"},"display_name":{"description":"The display name of the identity.","type":"string"},"handle":{"description":"The handle name of the identity.","type":"string"},"id":{"description":"The unique identifier of the identity.","type":"string"},"tenant":{"$ref":"#/components/schemas/Tenant"},"tenant_id":{"description":"The unique identifier of the tenant the identity belongs to.","format":"^t_[0-9a-v]{20}$","type":"string"},"type":{"description":"The type of identity e.g. user or org.","type":"string"}},"required":["handle","id","tenant_id","type"],"type":"object"},"IdentityPlan":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"expires_at":{"type":"string"},"identity_id":{"type":"string"},"plan":{"$ref":"#/components/schemas/Plan"},"plan_id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","identity_id","plan_id","updated_by_id","version_id"],"type":"object"},"Integration":{"properties":{"config":{"description":"The configuration for the integration.","properties":{},"type":"object"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"github_installation_id":{"description":"The GitHub installation ID for this integration, only applicable when the integration type is `github`.","type":"integer"},"handle":{"description":"The handle for the integration.","type":"string"},"id":{"description":"The unique identifier for the integration.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"The unique identifier for an identity where this integration is created.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"pipeline":{"$ref":"#/components/schemas/Pipeline"},"pipeline_id":{"description":"The pipeline ID for this integration.","type":"string"},"state":{"description":"The state of the integration.","type":"string"},"state_reason":{"description":"The reason for the state of the integration.","type":"string"},"tenant_id":{"description":"The unique identifier for the tenant where this integration is created.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"type":{"description":"The type of the integration.","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","deleted_by_id","handle","id","tenant_id","updated_by_id","version_id"],"type":"object"},"IntegrationCommandRequest":{"properties":{"command":{"description":"The command to execute.","enum":["refresh"],"type":"string"}},"required":["command"],"type":"object"},"InviteOrgUserRequest":{"properties":{"email":{"type":"string"},"handle":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"role":{"type":"string"}},"required":["role"],"type":"object"},"InviteTenantUserRequest":{"properties":{"email":{"type":"string"},"role":{"type":"string"}},"required":["email","role"],"type":"object"},"ListAIKeysResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AIKey"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListActorWorkspacesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ActorWorkspace"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListAuditLogsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AuditRecord"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListBillingInvoicesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BillingInvoice"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListBillingPaymentMethodsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PaymentMethod"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListConnectionsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Connection"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListConstraintsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Constraint"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListConversationMessagesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ConversationMessage"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListConversationsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Conversation"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListDatatankPartResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DatatankPart"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListDatatankResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Datatank"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListDatatankTableResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DatatankTable"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListFlowpipeInputsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/FlowpipeInput"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListFlowpipePipelinesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/WorkspaceModPipeline"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListFlowpipeTriggersResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/WorkspaceModTrigger"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListGithubRepositoriesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/GithubRepository"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListGithubRepositoryBranchesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/GithubRepositoryBranch"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListGitlabProjectBranchesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/GitlabProjectBranch"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListGitlabProjectsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/GitlabProject"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListIdentitiesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Identity"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListIntegrationsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Integration"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListLogArchivesResponse":{"properties":{"items":{"description":"The list of log archive entries.","items":{"$ref":"#/components/schemas/LogArchive"},"type":"array"},"next_token":{"description":"The token to retrieve the next page of results.","type":"string"}},"type":"object"},"ListLogsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/LogRecord"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListModelsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Model"},"type":"array"}},"type":"object"},"ListNotifiersResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Notifier"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListOrgUsersResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/OrgUser"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListOrgWorkspaceUsersResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/OrgWorkspaceUser"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListOrgsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Org"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListPermissionsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListPipelinesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Pipeline"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListProcessesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/SpProcess"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListSlackChannelsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/SlackChannel"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListSubscriptionsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BillingSubscription"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListTenantUsersResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/TenantUser"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListTenantsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Tenant"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListTokensResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Token"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListTriggersResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ModTriggerInfo"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListUsageMetricsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/UsageMetric"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListUserEmailsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/UserEmail"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListUserOrgsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/UserOrg"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListUsersResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/User"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListWorkspaceAggregatorsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/WorkspaceAggregator"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListWorkspaceConnResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/WorkspaceConn"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListWorkspaceConnectionAssociationsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/WorkspaceConnectionAssociation"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListWorkspaceConnectionsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/WorkspaceConnection"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListWorkspaceModVariablesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/WorkspaceModVariable"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListWorkspaceModsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/WorkspaceMod"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListWorkspaceSchemaResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/WorkspaceSchema"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListWorkspaceSchemaTableResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/WorkspaceSchemaTable"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListWorkspaceSnapshotsResponse":{"properties":{"items":{"description":"Metadata  ListResponseMetadata `json:\"metadata\"`","items":{"$ref":"#/components/schemas/WorkspaceSnapshot"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"ListWorkspacesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Workspace"},"type":"array"},"next_token":{"type":"string"}},"type":"object"},"LogArchive":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"description":"The unique identifier of the log archive entry.","format":"^la_[0-9a-v]{20}$","type":"string"},"log_date":{"description":"The date of the logs being archived in YYYY-MM-DD format.","type":"string"},"log_type":{"description":"The type of logs being archived (audit, db, etc.).","type":"string"},"storage_bytes":{"description":"The size of the archived logs in bytes.","type":"integer"},"storage_path":{"description":"The storage path where the archived logs are stored.","type":"string"},"tenant_id":{"description":"The tenant ID associated with the log archive entry.","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","deleted_by_id","id","log_date","log_type","storage_bytes","storage_path","tenant_id","updated_by_id","version_id"],"type":"object"},"LogRecord":{"properties":{"actor_avatar_url":{"description":"The avatar URL of the actor.","type":"string"},"actor_display_name":{"description":"The display name of the actor.","type":"string"},"actor_handle":{"description":"The actor handle who executed the query.","type":"string"},"actor_id":{"description":"The actor ID who executed the query.","type":"string"},"created_at":{"description":"The created time of the log.","type":"string"},"duration":{"description":"The duration of the query.","type":"integer"},"id":{"description":"The unique identifier of the DB log.","type":"string"},"log_timestamp":{"description":"The time when the log got captured in the postgres.","type":"string"},"query":{"description":"The query being executed in the workspace.","type":"string"},"tenant_id":{"description":"The tenant ID associated with the log.","type":"string"},"workspace_handle":{"description":"The workspace handle where the query was executed.","type":"string"},"workspace_id":{"description":"The workspace ID where the query was executed.","type":"string"}},"required":["actor_avatar_url","actor_display_name","actor_handle","actor_id","created_at","id","tenant_id","workspace_handle","workspace_id"],"type":"object"},"ModTriggerInfo":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"description":{"type":"string"},"id":{"type":"string"},"mod_id":{"type":"string"},"name":{"type":"string"},"params":{"properties":{},"type":"object"},"pipelines":{"properties":{},"type":"object"},"query":{"type":"string"},"schedule":{"type":"string"},"state":{"type":"string"},"tags":{"properties":{},"type":"object"},"title":{"type":"string"},"type":{"type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","updated_by_id","version_id"],"type":"object"},"Model":{"properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"provider":{"type":"string"},"state":{"type":"string"}},"type":"object"},"Notifier":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"description":"The unique identifier for the notifier.","format":"^notifier_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"The unique identifier for an identity where the notifier has been created.","format":"^[uo]_[0-9a-v]{20}$","type":"string"},"name":{"description":"The unique handle of the notifier, unique up and down the resource hierarchy.","format":"^[a-z](?:[a-z0-9]|_(?=[a-z0-9])){0,38}$","type":"string"},"notifies":{"description":"The configured notify targets for this notifier","items":{"properties":{},"type":"object"},"type":"array"},"precedence":{"description":"The precedence of this notifier","enum":["default"],"type":"string"},"state":{"description":"The state of the notifier","format":"^(enabled|disabled)$","type":"string"},"state_reason":{"description":"The reason for the state of the notifier","type":"string"},"tenant_id":{"description":"The unique identifier for the tenant where the notifier has been created.","format":"^t_[0-9a-v]{20}$","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"description":"The unique identifier for the workspace where the notifier has been created.","format":"^w_[0-9a-v]{20}$","type":"string"}},"required":["created_at","created_by_id","deleted_by_id","id","name","tenant_id","updated_by_id","version_id"],"type":"object"},"Org":{"properties":{"avatar_url":{"description":"The avatar of an org.","type":"string"},"billing":{"$ref":"#/components/schemas/BillingInfo"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"display_name":{"description":"The display name of an org.","type":"string"},"handle":{"description":"The handle name for an org.","type":"string"},"id":{"description":"The unique identifier for an org.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"tenant_id":{"description":"The unique identifier of the tenant the org belongs to.","format":"^t_[0-9a-v]{20}$","type":"string"},"token_min_issued_at":{"description":"The time which user and temporary auth tokens must be issued after.","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"url":{"type":"string"},"usage_compute_action":{"type":"string"},"usage_compute_threshold":{"format":"int64","type":"integer"},"usage_storage_action":{"type":"string"},"usage_storage_threshold":{"format":"int64","type":"integer"},"usage_user_action":{"type":"string"},"usage_user_threshold":{"format":"int64","type":"integer"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","deleted_by_id","handle","id","tenant_id","updated_by_id","version_id"],"type":"object"},"OrgUser":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"description":"The unique identifier of the org member.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"last_activity_at":{"description":"The time of the last activity for the member.","type":"string"},"org_id":{"description":"The identifier of an org.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"role":{"description":"The role of the org user.","type":"string"},"scope":{"description":"The scope of the role. Can be either of tenant / org / workspace","type":"string"},"status":{"description":"The status of the org member i.e invited or accepted.","enum":["invited","accepted"],"type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"user":{"$ref":"#/components/schemas/User"},"user_handle":{"description":"The user handle of the member.","type":"string"},"user_id":{"description":"The identifier of a user.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","id","org_id","status","updated_by_id","user_handle","user_id","version_id"],"type":"object"},"OrgWorkspaceUser":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"description":"The unique identifier of the org member.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"last_activity_at":{"description":"The time of the last activity for the member.","type":"string"},"org_id":{"description":"The identifier of an org.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"role":{"description":"The role of the workspace user.","type":"string"},"scope":{"description":"The scope of the role. Can be either of org / workspace","type":"string"},"status":{"description":"The status of the org member i.e pending or accepted.","format":"pending|accepted","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"user":{"$ref":"#/components/schemas/User"},"user_handle":{"description":"The user handle of the member.","type":"string"},"user_id":{"description":"The identifier of a user.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_handle":{"description":"The handle of the workspace with identifier WorkspaceID.","type":"string"},"workspace_id":{"description":"The identifier of a workspace belonging to the organization.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},"required":["created_at","created_by_id","id","org_id","status","updated_by_id","user_handle","user_id","version_id","workspace_handle","workspace_id"],"type":"object"},"PaymentMethod":{"properties":{"card":{"$ref":"#/components/schemas/Card"},"default":{"type":"boolean"},"id":{"type":"string"},"type":{"enum":["card","us_bank_account"],"type":"string"},"us_bank_account":{"$ref":"#/components/schemas/USBankAccount"}},"required":["type"],"type":"object"},"Permission":{"properties":{"aggregator_id":{"description":"The unique identifier for the aggregator that this permission applies to.","format":"^agg_[0-9a-v]{20}$","type":"string"},"connection_id":{"description":"The unique identifier for the connection that this permission applies to.","format":"^c_[0-9a-v]{20}$","type":"string"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"description":"The unique identifier for the connection permission record.","format":"^perm_[0-9a-v]{20}$","type":"string"},"identity":{"$ref":"#/components/schemas/Identity"},"identity_id":{"description":"The unique identifier for the identity that this permission applies to.","format":"^[ou]_[0-9a-v]{20}$","type":"string"},"tenant":{"$ref":"#/components/schemas/Tenant"},"tenant_id":{"description":"The unique identifier for the tenant that this permission applies to.","format":"^t_[0-9a-v]{20}$","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace":{"$ref":"#/components/schemas/Workspace"},"workspace_id":{"description":"The unique identifier for the workspace that this permission applies to.","format":"^w_[0-9a-v]{20}$","type":"string"}},"required":["created_at","created_by_id","id","updated_by_id","version_id"],"type":"object"},"Pipeline":{"properties":{"args":{"nullable":true},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"desired_state":{"description":"DesiredState is user editable state of the pipeline, there are only 3 options: enabled, disabled or paused","enum":["enabled","disabled","paused"],"type":"string"},"frequency":{"$ref":"#/components/schemas/PipelineFrequency"},"id":{"description":"The unique identifier of the pipeline.","format":"^pipe_[0-9a-z]{25}$","type":"string"},"identity_id":{"description":"The unique identifier of the identity for whom the pipeline is created.","format":"^[u|o]_[0-9a-v]{20}$","type":"string"},"instance_type":{"description":"The instance type of this pipeline.","enum":["c1.shared","c1.small"],"type":"string"},"last_process":{"$ref":"#/components/schemas/SpProcess"},"last_process_id":{"description":"The id of the last process that was run for the pipeline.","type":"string"},"next_run_at":{"description":"The time when the pipeline is next scheduled to run in ISO 8601 UTC.","type":"string"},"pipeline":{"description":"The name of the pipeline to be executed.","enum":["pipeline.snapshot_dashboard","pipeline.snapshot_query","pipeline.datatank_schedule","pipeline.import_integration"],"type":"string"},"state":{"description":"State is the system state of the pipeline. User should not be able to modify this value","enum":["enabled","enabling","disabled","disabling"],"type":"string"},"state_reason":{"type":"string"},"tags":{"nullable":true},"tenant_id":{"description":"We need the IdentityID to be in the JSON field because I'm sending the pipeline definition across the Temporal Workflow (see Datatank migration workflow)","format":"^t_[0-9a-v]{20}$","type":"string"},"title":{"description":"The title of the pipeline.","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"description":"The unique identifier of the workspace on which the pipeline is created if any.","format":"^w_[0-9a-v]{20}$","type":"string"}},"required":["created_at","created_by_id","deleted_by_id","desired_state","frequency","id","instance_type","pipeline","state","tenant_id","updated_by_id","version_id"],"type":"object"},"PipelineCommandRequest":{"properties":{"args":{"properties":{},"type":"object"},"command":{"enum":["run"],"type":"string"}},"required":["command"],"type":"object"},"PipelineCommandResponse":{"properties":{"command":{"enum":["run"],"type":"string"},"process_id":{"format":"^p_[0-9a-v]{20}$","type":"string"}},"required":["command","process_id"],"type":"object"},"PipelineFrequency":{"properties":{"schedule":{"description":"The schedule for the pipeline if the type is interval or cron.","type":"string"},"type":{"description":"The type of frequency. Can be interval, cron or manual.","enum":["interval","cron","manual"],"type":"string"}},"required":["type"],"type":"object"},"Plan":{"properties":{"created_at":{"type":"string"},"description":{"type":"string"},"id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"plan":{"type":"string"},"title":{"type":"string"},"updated_at":{"type":"string"},"version_id":{"type":"integer"}},"required":["created_at","description","id","plan","version_id"],"type":"object"},"SlackChannel":{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"type":"object"},"SpProcess":{"properties":{"connection_id":{"description":"The unique identifier of the connection for which the process is created.","format":"^c_[0-9a-v]{20}$","type":"string"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"flowpipe_pipeline_id":{"description":"The unique identifier of the flowpipe pipeline for which the process is created.","format":"^fp_[0-9a-v]{20}$","type":"string"},"id":{"description":"The unique identifier of the process.","format":"^p_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"The unique identifier of the identity for which the process is created.","format":"^[o|u]_[0-9a-v]{20}$","type":"string"},"pipe":{"description":"The pipe for which the process has been created.","enum":["steampipe","powerpipe","flowpipe"],"type":"string"},"pipeline":{"$ref":"#/components/schemas/Pipeline"},"pipeline_id":{"description":"The unique identifier of the pipeline for which the process is created.","format":"^pipe_[0-9a-v]{20}$","type":"string"},"state":{"description":"The state of the process.","enum":["pending","running","failed","completed","canceled","terminated"],"type":"string"},"state_reason":{"description":"The optional reason why the process is in its current state.","type":"string"},"tailpipe_partition_id":{"description":"The unique identifier of the tailpipe partition for which the process is created.","format":"^tp_[0-9a-v]{20}$","type":"string"},"tenant_id":{"description":"The unique identifier of the tenant for which the process is created.","type":"string"},"trigger":{"$ref":"#/components/schemas/WorkspaceModTrigger"},"trigger_id":{"description":"The unique identifier of the trigger for which the process is created.","format":"^t_[0-9a-v]{20}$","type":"string"},"type":{"description":"The type of the process, generally denotes the activity performed e.g. workspace.create, pipeline.execute, pipeline.command.run.","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"usage":{"description":"The usage information for this process.","properties":{},"type":"object"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"description":"The unique identifier of the workspace for which the process is created.","format":"^w_[0-9a-v]{20}$","type":"string"}},"required":["created_at","created_by_id","id","pipe","type","updated_at","updated_by_id","version_id"],"type":"object"},"TemporaryTokenRequest":{"properties":{"client_ip":{"type":"string"},"code":{"type":"string"},"created_at":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"},"token":{"type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"}},"required":["client_ip","code","created_at","id","state"],"type":"object"},"Tenant":{"properties":{"avatar_url":{"type":"string"},"billing":{"$ref":"#/components/schemas/BillingInfo"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"display_name":{"description":"The display name of the tenant.","type":"string"},"handle":{"description":"The handle name of the tenant.","type":"string"},"id":{"description":"The unique identifier of the tenant.","type":"string"},"state":{"description":"The state of the tenant.","type":"string"},"token_min_issued_at":{"description":"The time which auth tokens must be issued after for this tenant.","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"usage_compute_action":{"type":"string"},"usage_compute_threshold":{"format":"int64","type":"integer"},"usage_storage_action":{"type":"string"},"usage_storage_threshold":{"format":"int64","type":"integer"},"usage_user_action":{"type":"string"},"usage_user_threshold":{"type":"integer"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","deleted_by_id","handle","id","updated_by_id","version_id"],"type":"object"},"TenantLoginSettings":{"properties":{"state":{"enum":["enabled","disabled"],"type":"string"},"type":{"enum":["oauth","saml","email"],"type":"string"}},"required":["state","type"],"type":"object"},"TenantPlan":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"expires_at":{"type":"string"},"plan":{"$ref":"#/components/schemas/Plan"},"plan_id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"tenant_id":{"type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","plan_id","tenant_id","updated_by_id","version_id"],"type":"object"},"TenantSamlLoginSettings":{"properties":{"certificate":{"description":"The IdP public x509 certificate in PEM format.","type":"string"},"issuer":{"description":"The IdP issuer.","type":"string"},"sso_url":{"description":"The IdP SSO URL.","type":"string"},"state":{"enum":["enabled","disabled"],"type":"string"},"type":{"enum":["oauth","saml","email"],"type":"string"}},"required":["state","type"],"type":"object"},"TenantSettings":{"properties":{"ai_enabled":{"description":"The AI feature enable/disable state for the tenant.","type":"string"},"archive_audit_logs":{"description":"The audit log archiving enable/disable state for the tenant.","type":"string"},"archive_db_logs":{"description":"The database log archiving enable/disable state for the tenant.","type":"string"},"cli_session_timeout":{"description":"The CLI session timeout in hours.                                                                                             // The endpoint for the tenant's postgres database.","type":"integer"},"console_session_timeout":{"description":"The console (browser) session timeout in hours.","type":"integer"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"login_email":{"$ref":"#/components/schemas/TenantLoginSettings"},"login_github":{"$ref":"#/components/schemas/TenantLoginSettings"},"login_google":{"$ref":"#/components/schemas/TenantLoginSettings"},"login_saml":{"$ref":"#/components/schemas/TenantSamlLoginSettings"},"max_token_expiration":{"description":"The maximum token expiration in hours. (Default: 0 indicates we allow non-expiring tokens)","type":"integer"},"personal_workspaces":{"description":"Settings related to user personal workspaces.","type":"string"},"postgres_endpoint":{"description":"The endpoint for the tenant's postgres database.","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"user_provisioning":{"description":"The user provisioning settings for the tenant.","items":{"type":"string"},"type":"array"},"user_provisioning_permitted_domains":{"description":"The domains that new users are permitted to be provisioned from.","items":{"type":"string"},"type":"array"},"version_id":{"description":"The current version of the user setting.","type":"integer"},"workspace_snapshot_permitted_visibility":{"description":"List of allowed visibility settings for snapshots.","items":{"type":"string"},"type":"array"}},"required":["created_at","created_by_id","login_email","login_github","login_google","login_saml","max_token_expiration","personal_workspaces","updated_by_id","user_provisioning","user_provisioning_permitted_domains","version_id","workspace_snapshot_permitted_visibility"],"type":"object"},"TenantUser":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"email":{"description":"The email of the user.","format":"email","type":"string"},"id":{"description":"The unique identifier of the tenant member.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"last_activity_at":{"description":"The time of the last activity for the member.","type":"string"},"role":{"description":"The role of the tenant user.","enum":["member","owner"],"type":"string"},"status":{"description":"The status of the tenant member i.e invited or accepted.","enum":["invited","accepted"],"type":"string"},"tenant":{"$ref":"#/components/schemas/Tenant"},"tenant_id":{"description":"The identifier of the tenant.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"user":{"$ref":"#/components/schemas/User"},"user_id":{"description":"The identifier of the user that belongs to the tenant.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","email","id","role","status","tenant_id","updated_by_id","user_id","version_id"],"type":"object"},"TestAIKeyRequest":{"properties":{"api_key":{"type":"string"}},"type":"object"},"TestAIKeyResponse":{"properties":{"reason":{"type":"string"},"status":{"type":"string"}},"type":"object"},"TestConnectionRequest":{"properties":{"config":{"properties":{},"type":"object"},"plugin":{"type":"string"}},"required":["plugin"],"type":"object"},"TestIntegrationRequest":{"properties":{"config":{"properties":{},"type":"object"},"type":{"type":"string"}},"type":"object"},"Token":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"description":{"type":"string"},"expires_at":{"type":"string"},"id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"last4":{"type":"string"},"status":{"type":"string"},"title":{"type":"string"},"token_type":{"type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"user_id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","id","status","updated_by_id","user_id","version_id"],"type":"object"},"TokenWithValue":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"description":{"type":"string"},"expires_at":{"type":"string"},"id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"last4":{"type":"string"},"status":{"type":"string"},"title":{"type":"string"},"token":{"description":"Previously this was named \"Token\" and API expects \"token\" as the key, but to enable embedding of Token struct renamed it to \"Value\".","type":"string"},"token_type":{"type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"user_id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","id","status","updated_by_id","user_id","version_id"],"type":"object"},"TriggerCommandRequest":{"properties":{"args":{"properties":{},"type":"object"},"command":{"enum":["run","reset"],"type":"string"}},"required":["command"],"type":"object"},"TriggerCommandResponse":{"properties":{"command":{"enum":["run","reset"],"type":"string"},"process_id":{"format":"^p_[0-9a-v]{20}$","type":"string"}},"required":["command"],"type":"object"},"USBankAccount":{"properties":{"account_holder_type":{"type":"string"},"last4":{"type":"string"}},"type":"object"},"UpdateAIKeyRequest":{"properties":{"api_key":{"type":"string"}},"required":["api_key"],"type":"object"},"UpdateAggregatorRequest":{"properties":{"config":{"properties":{},"type":"object"},"connections":{"description":"The connections that are a part of the aggregator.","items":{"type":"string"},"type":"array"},"handle":{"format":"^[a-z](?:[a-z0-9]|_(?=[a-z0-9])){0,38}$","type":"string"}},"type":"object"},"UpdateBillingPaymentMethodRequest":{"properties":{"default":{"type":"boolean"}},"type":"object"},"UpdateBillingSubscriptionRequest":{"properties":{"action":{"enum":["stopcancel","upgrade"],"type":"string"}},"type":"object"},"UpdateConnectionFolderRequest":{"properties":{"parent_id":{"type":"string"},"title":{"type":"string"}},"type":"object"},"UpdateConnectionRequest":{"properties":{"config":{"properties":{},"type":"object"},"config_source":{"enum":["self","inherited"],"type":"string"},"credential_source":{"enum":["self","inherited"],"type":"string"},"handle":{"format":"^[a-z](?:[a-z0-9]|_(?=[a-z0-9])){0,38}$","type":"string"},"parent_id":{"type":"string"}},"type":"object"},"UpdateConversationRequest":{"properties":{"title":{"type":"string"}},"type":"object"},"UpdateDatatankPartRequest":{"properties":{"desired_state":{"enum":["enabled","disabled","paused"],"type":"string"}},"required":["desired_state"],"type":"object"},"UpdateDatatankRequest":{"properties":{"description":{"type":"string"},"desired_state":{"enum":["enabled","disabled","paused"],"type":"string"}},"type":"object"},"UpdateDatatankTableRequest":{"properties":{"description":{"type":"string"},"desired_state":{"enum":["enabled","disabled","paused"],"type":"string"},"frequency":{"$ref":"#/components/schemas/PipelineFrequency"},"name":{"type":"string"},"skip_initial_refresh":{"type":"boolean"},"source_query":{"type":"string"},"source_schema":{"type":"string"}},"type":"object"},"UpdateIntegrationRequest":{"properties":{"config":{"description":"The configuration for the integration.","properties":{},"type":"object"},"handle":{"description":"The handle for the integration.","type":"string"},"state":{"description":"The state of the integration.","enum":["enabled","disabled"],"type":"string"}},"type":"object"},"UpdateNotifierRequest":{"properties":{"name":{"description":"The name of the notifier to update","format":"^[a-z](?:[a-z0-9]|_(?=[a-z0-9])){0,38}$","type":"string"},"notifies":{"description":"The notify targets for the notifier to update","items":{"properties":{},"type":"object"},"type":"array"},"state":{"description":"The state of the notifier to update","format":"^(enabled|disabled)$","type":"string"}},"type":"object"},"UpdateOrgRequest":{"properties":{"display_name":{"type":"string"},"handle":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]){0,18}[a-z0-9]?$","type":"string"},"token_min_issued_at":{"description":"The time which user and temporary auth tokens must be issued after.","type":"string"},"url":{"type":"string"},"usage_compute_action":{"enum":["warn","cap_and_warn"],"type":"string"},"usage_compute_threshold":{"format":"int64","type":"integer"},"usage_storage_action":{"enum":["warn","cap_and_warn"],"type":"string"},"usage_storage_threshold":{"format":"int64","type":"integer"},"usage_user_action":{"enum":["warn","cap_and_warn"],"type":"string"},"usage_user_threshold":{"format":"int64","type":"integer"}},"type":"object"},"UpdateOrgUserRequest":{"properties":{"role":{"type":"string"}},"required":["role"],"type":"object"},"UpdateOrgWorkspaceUserRequest":{"properties":{"role":{"type":"string"}},"required":["role"],"type":"object"},"UpdatePermissionRequest":{"properties":{"identity_handle":{"type":"string"},"tenant_handle":{"type":"string"},"workspace_handle":{"type":"string"}},"type":"object"},"UpdatePipelineRequest":{"properties":{"args":{"nullable":true},"desired_state":{"description":"The desired state of the pipeline.","enum":["enabled","disabled"],"type":"string"},"frequency":{"$ref":"#/components/schemas/PipelineFrequency"},"tags":{"nullable":true},"title":{"description":"The title of the pipeline.","minLength":1,"type":"string"}},"type":"object"},"UpdateServiceAccountUserRequest":{"properties":{"description":{"description":"The description of the service account user.","type":"string"},"title":{"description":"The title of the service account user.","type":"string"},"token_min_issued_at":{"description":"The time which user and temporary auth tokens must be issued after.","type":"string"}},"type":"object"},"UpdateTemporaryTokenRequest":{"properties":{"state":{"type":"string"}},"required":["state"],"type":"object"},"UpdateTenantLoginSettings":{"properties":{"state":{"description":"The updated state of the login method.","enum":["enabled","disabled"],"type":"string"}},"required":["state"],"type":"object"},"UpdateTenantRequest":{"properties":{"display_name":{"type":"string"},"handle":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]){0,18}[a-z0-9]?$","type":"string"},"token_min_issued_at":{"type":"string"},"usage_compute_action":{"enum":["warn","cap_and_warn"],"type":"string"},"usage_compute_threshold":{"format":"int64","type":"integer"},"usage_storage_action":{"enum":["warn","cap_and_warn"],"type":"string"},"usage_storage_threshold":{"format":"int64","type":"integer"},"usage_user_action":{"enum":["warn","cap_and_warn"],"type":"string"},"usage_user_threshold":{"format":"int64","type":"integer"}},"type":"object"},"UpdateTenantSamlLoginSettings":{"properties":{"certificate":{"description":"The updated IdP public x509 certificate in PEM format.","type":"string"},"issuer":{"description":"The updated IdP issuer.","type":"string"},"sso_url":{"description":"The updated IdP SSO URL.","type":"string"},"state":{"description":"The updated state of the login method.","enum":["enabled","disabled"],"type":"string"}},"required":["state"],"type":"object"},"UpdateTenantSettingsRequest":{"properties":{"ai_enabled":{"description":"Enable/disable AI features for the tenant.","type":"string"},"archive_audit_logs":{"description":"Enable/disable audit log archiving for the tenant.","type":"string"},"archive_db_logs":{"description":"Enable/disable database log archiving for the tenant.","type":"string"},"cli_session_timeout":{"description":"The CLI session timeout in seconds.","type":"integer"},"console_session_timeout":{"description":"The console (browser) session timeout in seconds.","type":"integer"},"login_email":{"$ref":"#/components/schemas/UpdateTenantLoginSettings"},"login_github":{"$ref":"#/components/schemas/UpdateTenantLoginSettings"},"login_google":{"$ref":"#/components/schemas/UpdateTenantLoginSettings"},"login_saml":{"$ref":"#/components/schemas/UpdateTenantSamlLoginSettings"},"max_token_expiration":{"description":"The maximum token expiration in seconds. (Default: 0 indicates we allow non-expiring tokens)","type":"integer"},"personal_workspaces":{"description":"Settings related to user personal workspaces.","type":"string"},"postgres_endpoint":{"description":"Settings related to user personal workspaces.","type":"string"},"user_provisioning":{"description":"The user provisioning settings for the tenant.","items":{"type":"string"},"type":"array"},"user_provisioning_permitted_domains":{"description":"The domains that new users are permitted to be provisioned from.","items":{"type":"string"},"type":"array"},"workspace_snapshot_permitted_visibility":{"description":"Settings related to visibility of snapshots in the tenant.","items":{"type":"string"},"type":"array"}},"type":"object"},"UpdateTenantUserRequest":{"properties":{"role":{"type":"string"}},"type":"object"},"UpdateTokenRequest":{"properties":{"description":{"type":"string"},"status":{"type":"string"},"title":{"type":"string"}},"required":["status"],"type":"object"},"UpdateTriggerRequest":{"properties":{"args":{"description":"A map of arguments to be passed to be trigger.","properties":{},"type":"object"},"description":{"description":"Optional description for the trigger.","type":"string"},"name":{"description":"The name of the trigger.","minLength":1,"type":"string"},"schedule":{"$ref":"#/components/schemas/PipelineFrequency"},"state":{"description":"The desired state of the trigger.","enum":["enabled","disabled"],"type":"string"},"title":{"description":"Optional title for the trigger.","type":"string"}},"type":"object"},"UpdateUserPreferencesRequest":{"properties":{"communication_community_updates":{"enum":["enabled","disabled"],"type":"string"},"communication_product_updates":{"enum":["enabled","disabled"],"type":"string"},"communication_tips_and_tricks":{"enum":["enabled","disabled"],"type":"string"}},"type":"object"},"UpdateUserRequest":{"properties":{"display_name":{"type":"string"},"handle":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]){0,18}[a-z0-9]?$","type":"string"},"token_min_issued_at":{"description":"The time which user and temporary auth tokens must be issued after.","type":"string"},"url":{"type":"string"},"usage_compute_action":{"enum":["warn","cap_and_warn"],"type":"string"},"usage_compute_threshold":{"format":"int64","type":"integer"},"usage_storage_action":{"enum":["warn","cap_and_warn"],"type":"string"},"usage_storage_threshold":{"format":"int64","type":"integer"}},"type":"object"},"UpdateWorkspaceModRequest":{"properties":{"branch":{"type":"string"},"constraint":{"type":"string"},"version":{"type":"string"}},"type":"object"},"UpdateWorkspaceModVariableSettingRequest":{"properties":{"setting":{}},"required":["setting"],"type":"object"},"UpdateWorkspaceRequest":{"properties":{"db_volume_size_bytes":{"format":"int64","type":"integer"},"desired_state":{"description":"paused is not yet supported for Workspace","enum":["enabled","disabled"],"type":"string"},"handle":{"format":"^[a-z0-9]{1,23}$","type":"string"},"instance_type":{"description":"the updated instance type of the workspace","enum":["db1.shared","db1.small","db1.medium"],"type":"string"},"search_path_prefix":{"description":"Optionally update the search path prefix for the Steampipe DB.","items":{"type":"string"},"type":"array"}},"type":"object"},"UpdateWorkspaceSnapshotRequest":{"properties":{"tags":{"nullable":true},"title":{"description":"The updated title for the snapshot.","minLength":1,"type":"string"},"visibility":{"description":"The updated visibility for the snapshot.","enum":["workspace","anyone_with_link"],"type":"string"}},"type":"object"},"UsageMetric":{"properties":{"billing_mode":{"description":"The billing mode for this usage metric record.","enum":["billable","non_billable"],"type":"string"},"dimension":{"description":"The dimension for this usage metric record.","enum":["compute","storage","user"],"type":"string"},"identity_id":{"description":"The identity ID for this usage metric record","type":"string"},"instance_type":{"description":"The instance type for the usage record.                                                                                                                                                       // The instance type for this usage metric record. Only populated if the usage is for a workspace.","type":"string"},"metric":{"description":"The metric for this usage metric record.","enum":["user_count","db_execution_ms","db_volume_size_bytes","process_execution_ms","process_log_bytes","snapshot_storage_bytes","artifact_storage_bytes","log_archive_storage_bytes"],"type":"string"},"pipe":{"description":"The pipe for which the metric is recorded.","type":"string"},"tenant_id":{"description":"The tenant ID for this usage metric record","type":"string"},"unit":{"description":"The unit for this usage metric record.","enum":["byte","count","millisecond"],"type":"string"},"usage_date":{"description":"The start time for this usage metric record.","type":"string"},"value":{"description":"The value for this usage metric record.","format":"int64","type":"integer"},"value_rounded":{"description":"The rounded value for this usage metric record to the nearest billable unit.","format":"int64","type":"integer"},"value_weighted":{"description":"The value for this usage metric record weighted according to any billing rules such as DB instance type.","format":"int64","type":"integer"},"workspace_id":{"description":"The workspace ID for this usage metric record. Only populated if the usage is for a workspace.","type":"string"}},"required":["billing_mode","dimension","metric","unit","usage_date"],"type":"object"},"User":{"properties":{"avatar_url":{"type":"string"},"billing":{"$ref":"#/components/schemas/BillingInfo"},"created_at":{"description":"The user created time.","type":"string"},"description":{"type":"string"},"display_name":{"type":"string"},"handle":{"description":"The handle name of a user.","type":"string"},"id":{"description":"The unique identifier of a user.","format":"^u_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"If set, the service account is restricted to an identity and its children.","format":"^[a-z]{1,3}_[0-9a-v]{20}$","type":"string"},"preview_access_mode":{"type":"string"},"status":{"description":"The status of the user i.e accepted or pending.","type":"string"},"tenant_id":{"description":"The unique identifier of the tenant the user belongs to.","format":"^t_[0-9a-v]{20}$","type":"string"},"title":{"description":"The below should only be populated for service accounts","type":"string"},"token_min_issued_at":{"description":"The time which user and temporary auth tokens must be issued after.","type":"string"},"tokens":{"description":"Tokens is populated only when requested via ?include=tokens on list endpoints","items":{"$ref":"#/components/schemas/Token"},"type":"array"},"type":{"description":"The type of user, either user or service_account.","enum":["user","service_account"],"type":"string"},"updated_at":{"description":"The user updated time.","type":"string"},"url":{"type":"string"},"usage_compute_action":{"type":"string"},"usage_compute_threshold":{"format":"int64","type":"integer"},"usage_storage_action":{"type":"string"},"usage_storage_threshold":{"format":"int64","type":"integer"},"version_id":{"description":"The current version of a user.","type":"integer"}},"required":["created_at","handle","id","status","tenant_id","type","version_id"],"type":"object"},"UserDatabasePassword":{"properties":{"$password":{"type":"string"},"created_at":{"type":"string"},"expires_at":{"type":"string"},"id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"user_id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},"required":["$password","created_at","id"],"type":"object"},"UserEmail":{"properties":{"created_at":{"description":"The time when the user setting was created.","type":"string"},"email":{"description":"The email address of the user.","type":"string"},"id":{"description":"The unique identifier of the user email record.","format":"^up_[0-9a-v]{20}$","type":"string"},"status":{"description":"The status of the email id i.e. whether its pending verification or verified.","enum":["pending","verified"],"type":"string"},"tenant_id":{"description":"The unique identifier of the tenant to which the email record belongs to.","type":"string"},"updated_at":{"description":"The time when the user setting was last updated.","type":"string"},"version_id":{"description":"The current version of the user setting.","type":"integer"}},"required":["created_at","email","status","version_id"],"type":"object"},"UserLoginRequest":{"properties":{"email":{"type":"string"},"state":{"type":"string"}},"required":["email"],"type":"object"},"UserOrg":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"org":{"$ref":"#/components/schemas/Org"},"org_id":{"type":"string"},"role":{"type":"string"},"status":{"format":"pending|accepted","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"user_id":{"type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","org_id","role","status","updated_by_id","user_id","version_id"],"type":"object"},"UserPreferences":{"properties":{"communication_community_updates":{"description":"Whether the user is subscribed to community update emails.","type":"string"},"communication_product_updates":{"description":"Whether the user is subscribed to product update emails.","type":"string"},"communication_tips_and_tricks":{"description":"Whether the user is subscribed to tips and tricks emails.","type":"string"},"created_at":{"description":"The time when the user setting was created.","type":"string"},"id":{"description":"The unique identifier of the user preferences record.","format":"^up_[0-9a-v]{20}$","type":"string"},"updated_at":{"description":"The time when the user setting was last updated.","type":"string"},"version_id":{"description":"The current version of the user setting.","type":"integer"}},"required":["communication_community_updates","communication_product_updates","communication_tips_and_tricks","created_at","version_id"],"type":"object"},"UserSignupRequest":{"properties":{"email":{"type":"string"},"state":{"type":"string"}},"required":["email"],"type":"object"},"Workspace":{"properties":{"api_version":{"type":"string"},"cli_version":{"type":"string"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"database_name":{"description":"The name of the database.","type":"string"},"db_volume_size_bytes":{"description":"The current size of the database volume in bytes.","format":"int64","type":"integer"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"desired_state":{"enum":["enabled","disabled"],"type":"string"},"handle":{"description":"The handle name for the workspace.","example":"aaa","format":"^[a-z0-9]{1,23}$","type":"string"},"hive":{"description":"The database hive for this workspace.","type":"string"},"host":{"type":"string"},"id":{"description":"The unique identifier for the workspace.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"The unique identifier for an identity where the workspace is created.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"instance_type":{"description":"The instance type of this workspace.","enum":["db1.shared","db1.small","db1.medium"],"type":"string"},"notices":{"properties":{},"type":"object"},"powerpipe_version":{"type":"string"},"public_key":{"type":"string"},"search_path":{"description":"The configured Steampipe database search path for the workspace.","items":{"type":"string"},"type":"array"},"search_path_prefix":{"description":"The optional Steampipe database search path prefix for the workspace.","items":{"type":"string"},"type":"array"},"state":{"description":"The current state of the workspace.","type":"string"},"state_reason":{"type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"}},"required":["created_at","created_by_id","db_volume_size_bytes","deleted_by_id","desired_state","handle","id","identity_id","instance_type","updated_by_id","version_id"],"type":"object"},"WorkspaceAggregator":{"properties":{"association":{"$ref":"#/components/schemas/WorkspaceAggregatorAssociation"},"config":{"description":"The aggregator configuration.","properties":{},"type":"object"},"connections":{"description":"The plugin or connection configuration.","items":{"type":"string"},"type":"array"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"handle":{"description":"The handle name of the aggregator.","format":"^[a-z](?:[a-z0-9]|_(?=[a-z0-9])){0,38}$","type":"string"},"handle_dynamic":{"description":"The dynamically-generated handle for the aggregator. Only populated if this is a discovered aggregator.","type":"string"},"handle_mode":{"description":"The handle mode for the aggregator.","type":"string"},"handle_prefix":{"description":"The handle prefix to use for aggregators and connections discovered by this aggregator. Only populated if this is a dynamic aggregator.","type":"string"},"id":{"description":"The unique identifier for the aggregator.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"The unique identifier for an identity where the aggregator has been created.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"integration":{"$ref":"#/components/schemas/Integration"},"integration_resource_identifier":{"description":"The source identifier for this aggregator. Only populated if its a aggregator thats been discovered by an integration.","type":"string"},"integration_resource_name":{"description":"A friendly resource name for the aggregator. Only populated if its a aggregator thats been doscovered by an integration.","type":"string"},"integration_resource_path":{"description":"The source path for this aggregator. Only populated if its a aggregator thats been discovered by an integration.","type":"string"},"integration_resource_type":{"description":"The source type for this aggregator. Only populated if its a aggregator thats been discovered by an integration.","type":"string"},"managed_by_id":{"description":"The ID of the aggregator that manages this aggregator. Only populated if this is a discovered aggregator.","type":"string"},"plugin":{"description":"The plugin name for the aggregator.","type":"string"},"tenant_id":{"description":"The unique identifier for the tenant where this aggregator is created.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"type":{"description":"Type of connection i.e aggregator or connection.","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"description":"The unique identifier for the workspace.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},"required":["connections","created_at","created_by_id","deleted_by_id","handle","id","plugin","tenant_id","updated_by_id","version_id"],"type":"object"},"WorkspaceAggregatorAssociation":{"properties":{"aggregator":{"$ref":"#/components/schemas/Aggregator"},"aggregator_id":{"description":"The unique identifier for the aggregator.","type":"string"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"description":"The unique identifier for the workspace connection association.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"The identity ID where the association exists.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"description":"The unique identifier for the wokspace.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},"required":["aggregator_id","created_at","created_by_id","id","identity_id","updated_by_id","version_id","workspace_id"],"type":"object"},"WorkspaceCommandRequest":{"properties":{"command":{"type":"string"}},"required":["command"],"type":"object"},"WorkspaceCommandResponse":{"properties":{"command":{"type":"string"},"process_id":{"format":"^p_[0-9a-v]{20}$","type":"string"}},"required":["command","process_id"],"type":"object"},"WorkspaceConn":{"properties":{"connection":{"$ref":"#/components/schemas/Connection"},"connection_id":{"description":"The unique identifier for the connection.","type":"string"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"description":"The unique identifier for the workspace connection association.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"The identity ID where the association exists.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"description":"The unique identifier for the wokspace.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},"required":["connection_id","created_at","created_by_id","id","identity_id","updated_by_id","version_id","workspace_id"],"type":"object"},"WorkspaceConnection":{"properties":{"association":{"$ref":"#/components/schemas/WorkspaceConnectionAssociation"},"config":{"description":"The plugin or connection configuration.","properties":{},"type":"object"},"config_source":{"description":"The source of the configuration that the conection will use. One of `self` or `integration`.","type":"string"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"credential_source":{"description":"The source of the credential that the conection will use. One of `self` or `integration`.","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"handle":{"description":"The handle name of the  connection.","format":"^[a-z](?:[a-z0-9]|_(?=[a-z0-9])){0,38}$","type":"string"},"handle_dynamic":{"description":"The dynamically-generated handle for the connection. Only populated if this is a discovered connection.","type":"string"},"handle_mode":{"description":"The handle mode for the connection.","type":"string"},"id":{"description":"The unique identifier for the connection.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"The unique identifier for an identity where the connection has been created.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"integration":{"$ref":"#/components/schemas/Integration"},"integration_resource_identifier":{"description":"The source identifier for this connection. Only populated if its a connection thats been discovered by an integration.","type":"string"},"integration_resource_name":{"description":"A friendly resource name for the connection. Only populated if its a connection thats been doscovered by an integration.","type":"string"},"integration_resource_path":{"description":"The source path for this connection. Only populated if its a connection thats been discovered by an integration.","type":"string"},"integration_resource_type":{"description":"The source type for this connection. Only populated if its a connection thats been discovered by an integration.","type":"string"},"last_error_at":{"type":"string"},"last_error_process_id":{"type":"string"},"last_successful_update_at":{"type":"string"},"last_successful_update_process_id":{"type":"string"},"last_update_attempt_at":{"type":"string"},"last_update_attempt_process_id":{"type":"string"},"managed_by_id":{"description":"The ID of the aggregator that manages this connection. Only populated if this is a discovered connection.","type":"string"},"parent_id":{"description":"The id of the entity where the connection is stored. Can be either tenant, identity, workspace or connection-folder.","type":"string"},"plugin":{"description":"The plugin name for the connection.","type":"string"},"plugin_version":{"description":"The plugin version for the connection.","type":"string"},"status":{"description":"The status of the connection.","type":"string"},"tenant_id":{"description":"The unique identifier for the tenant where the connection has been created.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"title":{"description":"The title of the connection. Only populated when the connection is of type connection folder.","type":"string"},"trunk":{"description":"The trunk for the connection.","items":{"$ref":"#/components/schemas/ConnectionTrunkItem"},"type":"array"},"type":{"description":"Type of connection i.e aggregator or connection.","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"description":"The unique identifier for the workspace where the connection has been created.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},"required":["created_at","created_by_id","deleted_by_id","id","parent_id","tenant_id","updated_by_id","version_id"],"type":"object"},"WorkspaceConnectionAssociation":{"properties":{"connection":{"$ref":"#/components/schemas/Connection"},"connection_id":{"description":"The unique identifier for the connection.","type":"string"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"description":"The unique identifier for the workspace connection association.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"The identity ID where the association exists.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"description":"The unique identifier for the wokspace.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},"required":["connection_id","created_at","created_by_id","id","identity_id","updated_by_id","version_id","workspace_id"],"type":"object"},"WorkspaceMod":{"properties":{"alias":{"format":"^[a-z0-9-_]{1,40}$","type":"string"},"branch":{"type":"string"},"constraint":{"type":"string"},"constraint_mode":{"type":"string"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"The unique identifier for an identity where the workspace mod has been install.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"installed_commit":{"type":"string"},"installed_version":{"type":"string"},"integration_id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"mod_id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"path":{"type":"string"},"pipe":{"type":"string"},"source_type":{"enum":["repository","archive"],"type":"string"},"state":{"type":"string"},"state_reason":{"type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version":{"type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},"required":["created_at","created_by_id","id","identity_id","source_type","updated_by_id","version_id","workspace_id"],"type":"object"},"WorkspaceModPipeline":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"description":{"type":"string"},"id":{"type":"string"},"last_process":{"$ref":"#/components/schemas/SpProcess"},"last_process_id":{"description":"The id of the last process that was run for the pipeline.","type":"string"},"name":{"type":"string"},"params":{"properties":{},"type":"object"},"steps":{"properties":{},"type":"object"},"tags":{"properties":{},"type":"object"},"title":{"type":"string"},"triggers":{"description":"The list of triggers which the pipeline is associated with.","properties":{},"type":"object"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_mod":{"$ref":"#/components/schemas/WorkspaceMod"},"workspace_mod_id":{"type":"string"}},"required":["created_at","created_by_id","updated_by_id","version_id"],"type":"object"},"WorkspaceModTrigger":{"properties":{"args":{"properties":{},"type":"object"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"default_schedule":{"type":"string"},"default_state":{"type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"description":{"type":"string"},"id":{"type":"string"},"identity":{"$ref":"#/components/schemas/Identity"},"identity_id":{"type":"string"},"last_process":{"$ref":"#/components/schemas/SpProcess"},"last_process_id":{"description":"The id of the last process that was run for the pipeline.","type":"string"},"name":{"type":"string"},"next_run_at":{"description":"The time when the trigger is next scheduled to run in ISO 8601 UTC.","type":"string"},"params":{"properties":{},"type":"object"},"pipelines":{"properties":{},"type":"object"},"query":{"type":"string"},"schedule":{"$ref":"#/components/schemas/PipelineFrequency"},"state":{"type":"string"},"state_reason":{"type":"string"},"tags":{"properties":{},"type":"object"},"title":{"type":"string"},"type":{"type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace":{"$ref":"#/components/schemas/Workspace"},"workspace_id":{"type":"string"},"workspace_mod":{"$ref":"#/components/schemas/WorkspaceMod"},"workspace_mod_id":{"type":"string"}},"required":["created_at","created_by_id","deleted_by_id","updated_by_id","version_id"],"type":"object"},"WorkspaceModVariable":{"properties":{"created_at":{"type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"description":{"type":"string"},"enum":{"properties":{},"type":"object"},"format":{"type":"string"},"id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"mod_alias":{"type":"string"},"name":{"type":"string"},"pipe":{"type":"string"},"tags":{"properties":{},"type":"object"},"type":{"type":"string"},"updated_at":{"type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"value":{"nullable":true},"value_default":{"nullable":true},"value_setting":{"nullable":true},"version_id":{"type":"integer"}},"required":["created_at","created_by_id","id","version_id"],"type":"object"},"WorkspaceNotifierCommandRequest":{"properties":{"command":{"enum":["set_default"],"type":"string"}},"required":["command"],"type":"object"},"WorkspaceNotifierCommandResponse":{"properties":{"command":{"enum":["set_default"],"type":"string"},"process_id":{"format":"^p_[0-9a-v]{20}$","type":"string"}},"required":["command","process_id"],"type":"object"},"WorkspaceProcessCommandRequest":{"properties":{"command":{"type":"string"}},"required":["command"],"type":"object"},"WorkspaceProcessCommandResponse":{"properties":{"command":{"type":"string"}},"required":["command"],"type":"object"},"WorkspaceQueryResult":{"properties":{"columns":{"items":{"$ref":"#/components/schemas/WorkspaceQueryResultColumn"},"type":"array"},"detail":{"type":"string"},"instance":{"type":"string"},"rows":{"properties":{},"type":"object"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"required":["columns","rows"],"type":"object"},"WorkspaceQueryResultColumn":{"properties":{"data_type":{"type":"string"},"max_data_length":{"type":"integer"},"name":{"type":"string"},"original_name":{"type":"string"}},"required":["data_type","name"],"type":"object"},"WorkspaceSchema":{"properties":{"aggregated_by":{"description":"The list of aggregators that are using this schema.","items":{"type":"string"},"type":"array"},"aggregator":{"$ref":"#/components/schemas/Aggregator"},"aggregator_id":{"description":"The id of the aggregator if the schema is of type 'aggregator'.","type":"string"},"connection":{"$ref":"#/components/schemas/Connection"},"connection_id":{"description":"The id of the connection if the schema is of type 'connection'.","type":"string"},"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"datatank":{"$ref":"#/components/schemas/Datatank"},"datatank_id":{"description":"The id of the datatank if the schema is of type 'datatank'.","type":"string"},"deleted_at":{"description":"The time the item was deleted in ISO 8601 UTC.","type":"string"},"deleted_by":{"$ref":"#/components/schemas/User"},"deleted_by_id":{"description":"The ID of the user that performed the deletion.","format":"^u_[0-9a-v]{20}$","type":"string"},"id":{"description":"The unique identifier for the schema.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"identity_id":{"description":"The unique identifier for an identity where the schema has been created.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"name":{"description":"The name of the schema.","format":"^[a-z](?:[a-z0-9]|_(?=[a-z0-9])){0,38}$","type":"string"},"state":{"description":"State of the schema e.g. `granted`, `direct` or `indirect`.","type":"string"},"type":{"description":"Type of schema can be one of datatank, aggregator or connection.","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"workspace_id":{"description":"The unique identifier for the workspace where the schema exists.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},"required":["created_at","created_by_id","deleted_by_id","id","identity_id","name","updated_by_id","version_id","workspace_id"],"type":"object"},"WorkspaceSchemaTable":{"properties":{"columns":{"items":{"$ref":"#/components/schemas/WorkspaceSchemaTableColumn"},"type":"array"},"description":{"type":"string"},"name":{"type":"string"}},"required":["columns","name"],"type":"object"},"WorkspaceSchemaTableColumn":{"properties":{"data_type":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"}},"required":["data_type","name"],"type":"object"},"WorkspaceSnapshot":{"properties":{"created_at":{"description":"The time of creation in ISO 8601 UTC.","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"created_by_id":{"description":"The ID of the user that created this.","format":"^u_[0-9a-v]{20}$","type":"string"},"dashboard_name":{"description":"The mod-prefixed name of the dashboard this snapshot belongs to.","type":"string"},"dashboard_title":{"description":"The title of the dashboard this snapshot belongs to.","type":"string"},"expires_at":{"description":"The time when the snapshot will expire.","type":"string"},"id":{"description":"The unique identifier for the snapshot.","format":"^snap_[0-9a-z]{25}$","type":"string"},"identity_id":{"description":"The unique identifier for the identity that the snapshot belongs to.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"},"inputs":{"nullable":true},"schema_version":{"description":"The schema version of the underlying snapshot.","type":"string"},"state":{"description":"The current state of the snapshot.","type":"string"},"tags":{"nullable":true},"title":{"description":"The title of the snapshot.","type":"string"},"updated_at":{"description":"The time of the last update in ISO 8601 UTC.","type":"string"},"updated_by":{"$ref":"#/components/schemas/User"},"updated_by_id":{"description":"The ID of the user that performed the last update.","format":"^u_[0-9a-v]{20}$","type":"string"},"usage":{"description":"The usage information for this snapshot.","properties":{},"type":"object"},"version_id":{"description":"The version ID of this item. Pass this version ID via an If-Match header when performing mutation operations on the item.","type":"integer"},"visibility":{"description":"The visibility of the snapshot.","type":"string"},"workspace_id":{"description":"The unique identifier for the workspace that the snapshot belongs to.","format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},"required":["created_at","created_by_id","dashboard_name","dashboard_title","id","identity_id","schema_version","updated_by_id","version_id","workspace_id"],"type":"object"},"WorkspaceSnapshotData":{"properties":{"end_time":{"description":"The time the dashboard execution ended.","type":"string"},"inputs":{"description":"Any inputs and their values used in this snapshot.","properties":{},"type":"object"},"layout":{"$ref":"#/components/schemas/WorkspaceSnapshotDataLayout"},"metadata":{"description":"Any additional metadata for this snapshot.","properties":{},"type":"object"},"panels":{"description":"The map of panels and their data for this snapshot.","properties":{},"type":"object"},"schema_version":{"description":"The schema version of this snapshot.","type":"string"},"start_time":{"description":"The time the dashboard execution started.","type":"string"},"variables":{"description":"Any mod variables in scope for this snapshot.","properties":{},"type":"object"}},"required":["end_time","layout","panels","schema_version","start_time"],"type":"object"},"WorkspaceSnapshotDataLayout":{"properties":{"children":{"items":{"$ref":"#/components/schemas/WorkspaceSnapshotDataLayout"},"type":"array"},"name":{"type":"string"},"panel_type":{"type":"string"}},"required":["name","panel_type"],"type":"object"}},"securitySchemes":{"ApiKeyAuth":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"contact":{"name":"Turbot Support","url":"https://turbot.com/pipes"},"description":"Turbot Pipes is an intelligence, automation \u0026 security platform built specifically for DevOps.","title":"Turbot Pipes","version":"1.22.50"},"openapi":"3.0.1","paths":{"/actor":{"get":{"description":"Returns the actor information.","operationId":"actor_get","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Actor information","tags":["Actors"]}},"/actor/activity":{"get":{"description":"List the activity for an actor.","operationId":"actor_listActivity","parameters":[{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuditLogsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List actor activity","tags":["Actors"]}},"/actor/conn":{"get":{"description":"List the connections for an actor.","operationId":"actor_listConnections","parameters":[{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List actor connections","tags":["Actors"]}},"/actor/org":{"get":{"description":"List the orgs and org workspaces for an actor, along with role within each.","operationId":"actor_listOrgs","parameters":[{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUserOrgsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List actor orgs","tags":["Actors"]}},"/actor/org/invite":{"get":{"description":"List the orgs to which the actor has been invited.","operationId":"actor_listOrgInvites","parameters":[{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUserOrgsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org invites for actor","tags":["Actors"]}},"/actor/workspace":{"get":{"description":"List the workspaces for an actor.","operationId":"actor_listWorkspaces","parameters":[{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListActorWorkspacesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List actor workspaces","tags":["Actors"]}},"/ai/key":{"get":{"description":"Lists AI provider API keys configured at the tenant level.","operationId":"aiKey_tenant_list","parameters":[{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned. Pass next_token to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAIKeysResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant AI keys","tags":["AIKeys"]},"post":{"description":"Creates a new AI provider API key at the tenant level.","operationId":"aiKey_tenant_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAIKeyRequest"}}},"description":"The request body containing the AI provider and API key to save.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIKey"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create tenant AI key","tags":["AIKeys"],"x-codegen-request-body-name":"body"}},"/ai/key/{provider}":{"delete":{"description":"Deletes an existing AI provider API key at the tenant level.","operationId":"aiKey_tenant_delete","parameters":[{"description":"The AI provider for which to delete the key.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIKey"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete tenant AI key","tags":["AIKeys"]},"get":{"description":"Retrieves the AI provider API key metadata at the tenant level.","operationId":"aiKey_tenant_get","parameters":[{"description":"The AI provider for which to retrieve the key.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIKey"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant AI key","tags":["AIKeys"]},"patch":{"description":"Updates an existing AI provider API key at the tenant level.","operationId":"aiKey_tenant_update","parameters":[{"description":"The AI provider for which to update the key.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAIKeyRequest"}}},"description":"The request body containing the updated API key value.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIKey"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update tenant AI key","tags":["AIKeys"],"x-codegen-request-body-name":"body"}},"/ai/key/{provider}/test":{"post":{"description":"Tests whether an AI provider API key is valid at the tenant level. If a key is not provided in the body, the existing saved key for the provider will be tested.","operationId":"aiKey_tenant_test","parameters":[{"description":"The AI provider for which to test the key.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestAIKeyRequest"}}},"description":"Optional request body containing an API key to test instead of the saved one.","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestAIKeyResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Test tenant AI key","tags":["AIKeys"],"x-codegen-request-body-name":"body"}},"/audit_log":{"get":{"description":"Returns the audit logs for a custom tenant.","operationId":"tenant_listAuditLogs","parameters":[{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuditLogsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Tenant audit logs","tags":["Tenants"]}},"/auth/{provider}":{"get":{"description":"With an authentication provider, users can access Turbot Pipes with single sign-on (SSO) using credentials from a third party. Turbot Pipes currently supports GitHub and Google as an authentication provider.","operationId":"auth_provider","parameters":[{"description":"The authentication provider.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"responses":{"307":{"content":{},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Auth Provider","tags":["Auth"]}},"/auth/{provider}/callback":{"get":{"description":"Auth provider callback.","operationId":"auth_providerCallback","parameters":[{"description":"The authentication provider.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"responses":{"307":{"content":{},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Auth provider callback","tags":["Auth"]},"post":{"description":"Auth provider callback.","operationId":"auth_postProviderCallback","parameters":[{"description":"The authentication provider.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"responses":{"307":{"content":{},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Post auth provider callback","tags":["Auth"]}},"/connection":{"get":{"description":"List connections for a tenant.","operationId":"tenantConnection_list","parameters":[{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant connections","tags":["TenantConnections"]},"post":{"description":"Creates a new connection for a custom tenant.","operationId":"tenantConnection_create","parameters":[{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionRequest"}}},"description":"The request body for the connection to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create tenant connection","tags":["TenantConnections"],"x-codegen-request-body-name":"request"}},"/connection/{connection_handle}":{"delete":{"description":"Deletes a connection defined at the tenant level.","operationId":"tenantConnection_delete","parameters":[{"description":"The handle of the connection that needs to be deleted.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete tenant connection","tags":["TenantConnections"]},"get":{"description":"Get connection for a tenant.","operationId":"tenantConnection_get","parameters":[{"description":"The handle of the connection to retrieve.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant connection","tags":["TenantConnections"]},"patch":{"description":"Update the details of a connection belonging to a tenant.","operationId":"tenantConnection_update","parameters":[{"description":"The handle of the connection which needs to be updated.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectionRequest"}}},"description":"The request body for the connection which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update tenant connection","tags":["TenantConnections"],"x-codegen-request-body-name":"request"}},"/connection/{connection_handle}/permission":{"get":{"description":"List permissions for a connection defined on a custom tenant.","operationId":"tenantConnection_listPermission","parameters":[{"description":"The handle of the connection for which we want to list permissions.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant connection permissions","tags":["TenantConnections"]},"post":{"description":"Create permissions for a tenant connection.","operationId":"tenantConnection_createPermission","parameters":[{"description":"The handle of the connection for which we want to list permissions.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePermissionRequest"}}},"description":"The request body for the connection permission to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create tenant connection permission","tags":["TenantConnections"],"x-codegen-request-body-name":"request"}},"/connection/{connection_handle}/permission/{permission_id}":{"delete":{"description":"Delete permission for a connection defined on a custom tenant.","operationId":"tenantConnection_deletePermission","parameters":[{"description":"The handle of the connection for which we want to delete permission for.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The id of the permission which we want to delete.","in":"path","name":"permission_id","required":true,"schema":{"format":"^perm[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete tenant connection permission","tags":["TenantConnections"]},"get":{"description":"Get permission for a connection defined on a custom tenant.","operationId":"tenantConnection_getPermission","parameters":[{"description":"The handle of the connection for which we want to get permission for.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The id of the permission which we want to retrieve.","in":"path","name":"permission_id","required":true,"schema":{"format":"^perm[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant connection permission","tags":["TenantConnections"]},"patch":{"description":"Update permission for a connection defined on a custom tenant.","operationId":"tenantConnection_updatePermission","parameters":[{"description":"The handle of the connection for which we want to update permission for.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The id of the permission which we want to update.","in":"path","name":"permission_id","required":true,"schema":{"format":"^perm[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePermissionRequest"}}},"description":"The request body for the connection permission to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update tenant connection permission","tags":["TenantConnections"],"x-codegen-request-body-name":"request"}},"/connection/{connection_handle}/test":{"post":{"description":"Test the config for a tenant connection to check for basic connectivity.","operationId":"tenantConnection_test","parameters":[{"description":"The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestConnectionRequest"}}},"description":"The request body for the connection to be tested.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionTestResult"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Test tenant connection","tags":["TenantConnections"],"x-codegen-request-body-name":"request"}},"/connection/{connection_handle}/workspace":{"get":{"description":"List the workspaces that a tenant connection has been added to.","operationId":"tenantConnection_listWorkspaces","parameters":[{"description":"The handle of the connection for which we want to list workspaces.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceConnectionAssociationsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant connection workspaces","tags":["TenantConnections"]}},"/connection_folder":{"get":{"description":"List connection folders for a custom tenant.","operationId":"tenantConnectionFolder_list","parameters":[{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant connection folders","tags":["TenantConnectionFolders"]},"post":{"description":"Creates a new connection folder for a custom tenant.","operationId":"tenantConnectionFolder_create","parameters":[{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionFolderRequest"}}},"description":"The request body for the connection to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create tenant connection folder","tags":["TenantConnectionFolders"],"x-codegen-request-body-name":"request"}},"/connection_folder/{folder_id}":{"delete":{"description":"Deletes a connection folder defined at the tenant level.","operationId":"tenantConnectionFolder_delete","parameters":[{"description":"The ID of the connection folder that needs to be deleted.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete tenant connection folder","tags":["TenantConnectionFolders"]},"get":{"description":"Get connection folder for a custom tenant.","operationId":"tenantConnectionFolder_get","parameters":[{"description":"The ID of the connection folder to retrieve.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant connection folder","tags":["TenantConnectionFolders"]},"patch":{"description":"Update the details of a connection folder belonging to a custom tenant.","operationId":"tenantConnectionFolder_update","parameters":[{"description":"The handle of the connection folder which needs to be updated.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectionFolderRequest"}}},"description":"The request body for the connection which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update tenant connection folder","tags":["TenantConnectionFolders"],"x-codegen-request-body-name":"request"}},"/connection_folder/{folder_id}/permission":{"get":{"description":"List permissions for a connection folder defined on a custom tenant.","operationId":"tenantConnectionFolder_listPermission","parameters":[{"description":"The ID of the connection folder for which we want to list permissions.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant connection folder permissions","tags":["TenantConnectionFolders"]},"post":{"description":"Create permissions for a connection folder defined on a custom tenant.","operationId":"tenantConnectionFolder_createPermission","parameters":[{"description":"The ID of the connection folder for which we want to list permissions.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePermissionRequest"}}},"description":"The request body for the connection folder permission to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create tenant connection folder permission","tags":["TenantConnectionFolders"],"x-codegen-request-body-name":"request"}},"/connection_folder/{folder_id}/permission/{permission_id}":{"delete":{"description":"Delete permission for a connection folder defined on a custom tenant.","operationId":"tenantConnectionFolder_deletePermission","parameters":[{"description":"The ID of the connection folder for which we want to delete permission.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The id of the permission which we want to delete.","in":"path","name":"permission_id","required":true,"schema":{"format":"^perm[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete tenant connection folder permission","tags":["TenantConnectionFolders"]},"get":{"description":"Get permission for a connection folder defined on a custom tenant.","operationId":"tenantConnectionFolder_getPermission","parameters":[{"description":"The id of the folder which we want to get permission for.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The id of the permission which we want to retrieve.","in":"path","name":"permission_id","required":true,"schema":{"format":"^perm[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant connection folder permission","tags":["TenantConnectionFolders"]},"patch":{"description":"Update permission for a connection folder defined on a custom tenant.","operationId":"tenantConnectionFolder_updatePermission","parameters":[{"description":"The ID of the connection folder for which we want to update the permissions.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The id of the permission which we want to update.","in":"path","name":"permission_id","required":true,"schema":{"format":"^perm[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePermissionRequest"}}},"description":"The request body for the connection permission to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update tenant connection folder permission","tags":["TenantConnectionFolders"],"x-codegen-request-body-name":"request"}},"/connection_folder/{folder_id}/workspace":{"get":{"description":"List the workspaces that a tenant connection folder has been added to.","operationId":"tenantConnectionFolder_listWorkspaces","parameters":[{"description":"The ID of the connection folder for which we want to list workspaces.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceConnectionAssociationsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant connection folder workspaces","tags":["TenantConnectionFolders"]}},"/connection_tree":{"get":{"description":"List connection tree for a tenant.","operationId":"tenantConnectionTree_list","parameters":[{"description":"The prefix to be used when listing items in a connection tree","in":"query","name":"prefix","schema":{"type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant connection tree","tags":["TenantConnectionTree"]}},"/identity":{"get":{"description":"List identities with their public information.","operationId":"identity_list","parameters":[{"description":"Optional free-text search to filter the identities.","in":"query","name":"q","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListIdentitiesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List identities","tags":["Identities"]}},"/identity/{identity_handle}":{"get":{"description":"Get public information for an identity.","operationId":"identity_get","parameters":[{"description":"Specify the handle of the identity whose information you want to retrieve.","in":"path","name":"identity_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Identity"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get identity","tags":["Identities"]}},"/identity/{identity_handle}/avatar":{"get":{"description":"Get public avatar for an identity.","operationId":"identity_getAvatar","parameters":[{"description":"Specify the handle of the identity whose avatar you want to retrieve.","in":"path","name":"identity_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/WorkspaceSnapshotData"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get identity avatar","tags":["Identities"]}},"/integration":{"get":{"description":"List integrations configured on a custom tenant.","operationId":"tenantIntegration_list","parameters":[{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListIntegrationsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant integrations","tags":["TenantIntegrations"]},"post":{"description":"Creates a new integration on a custom tenant.","operationId":"tenantIntegration_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationRequest"}}},"description":"The request body for the integration to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create tenant integration","tags":["TenantIntegrations"],"x-codegen-request-body-name":"request"}},"/integration/{integration_handle}":{"delete":{"description":"Delete an integration configured on a custom tenant.","operationId":"tenantIntegration_delete","parameters":[{"description":"The handle of the integration which needs to be deleted.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete tenant integration","tags":["TenantIntegrations"]},"get":{"description":"Get details of an integration configured on a custom tenant.","operationId":"tenantIntegration_get","parameters":[{"description":"The handle of the integration whose details need to be retrieved.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant integration","tags":["TenantIntegrations"]},"patch":{"description":"Update details of an integration configured on a custom tenant.","operationId":"tenantIntegration_update","parameters":[{"description":"The handle of the integration whose details need to be updated.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationRequest"}}},"description":"The request body for the integration update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update tenant integration","tags":["TenantIntegrations"],"x-codegen-request-body-name":"request"}},"/integration/{integration_handle}/command":{"post":{"description":"Run a command for a tenant integration","operationId":"tenantIntegration_command","parameters":[{"description":"The handle of the integration for which we want to run the command.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCommandRequest"}}},"description":"The request body for the workspace command.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationCommandRequest"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Run tenant integration command","tags":["TenantIntegrations"],"x-codegen-request-body-name":"request"}},"/integration/{integration_handle}/github/install":{"get":{"description":"Install a GitHub integration on a custom tenant.","operationId":"tenantIntegration_installGithubIntegration","parameters":[{"description":"The handle of the GitHub integration which needs to be installed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"307":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Temporary Redirect"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Install GitHub integration on a custom tenant","tags":["TenantIntegrations"]}},"/integration/{integration_handle}/slack/channel":{"get":{"description":"List Slack channels that are given access to a tenant Slack integration.","operationId":"tenantIntegration_listSlackChannels","parameters":[{"description":"The handle of the integration for which Slack channels will be listed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSlackChannelsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant integration Slack channels","tags":["TenantIntegrations"]}},"/integration/{integration_handle}/slack/install":{"get":{"description":"Install a Slack integration on a custom tenant.","operationId":"tenantIntegration_installSlackIntegration","parameters":[{"description":"The handle of the Slack integration which needs to be installed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"307":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Temporary Redirect"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Install Slack integration on a custom tenant","tags":["TenantIntegrations"]}},"/integration/{integration_handle}/test":{"post":{"description":"Test the config for a custom tenant integration to check for basic connectivity before you create it.","operationId":"tenantIntegration_test","parameters":[{"description":"The handle of the integration to be tested. For integrations that are not yet created, use underscore `_` as the handle, else pass the handle of the existing integration.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Test custom tenant integration","tags":["TenantIntegrations"]}},"/log_archive":{"get":{"description":"List log archives for the tenant","operationId":"tenantLogArchives_list","parameters":[{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLogArchivesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant log archives","tags":["TenantLogArchives"]}},"/log_archive/{log_archive_identifier}":{"delete":{"description":"Delete a log archive for the tenant","operationId":"tenantLogArchives_delete","parameters":[{"description":"The log archive identifier (ID).","in":"path","name":"log_archive_identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogArchive"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete tenant log archive","tags":["TenantLogArchives"]},"get":{"description":"Get a log archive for the tenant","operationId":"tenantLogArchives_get","parameters":[{"description":"The log archive identifier (ID).","in":"path","name":"log_archive_identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogArchive"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant log archive","tags":["TenantLogArchives"]}},"/log_archive/{log_archive_identifier}/download":{"get":{"description":"Download a log archive for the tenant","operationId":"tenantLogArchives_download","parameters":[{"description":"The log archive identifier (ID).","in":"path","name":"log_archive_identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/x-ndjson":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"content":{"application/x-ndjson":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/x-ndjson":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/x-ndjson":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/x-ndjson":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/x-ndjson":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/x-ndjson":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Download a tenant log archive","tags":["TenantLogArchives"]}},"/login":{"post":{"description":"User login.","operationId":"auth_login","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserLoginRequest"}}},"description":"The request body to login.","required":true},"responses":{"201":{"content":{},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"User login","tags":["Auth"],"x-codegen-request-body-name":"request"}},"/login/confirm":{"get":{"description":"Confirm user login.","operationId":"auth_confirmLogin","parameters":[{"description":"Specify the token.","in":"query","name":"t","required":true,"schema":{"type":"string"}}],"responses":{"201":{"content":{},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Confirm user login","tags":["Auth"]}},"/login/token":{"post":{"description":"Generate a temporary token request for CLI login.","operationId":"auth_loginToken_create","responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryTokenRequest"}}},"description":"Created"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Generate temporary token request","tags":["Auth"]}},"/login/token/{temporary_token_request_id}":{"delete":{"description":"Delete a temporary token request status.","operationId":"auth_loginToken_delete","parameters":[{"description":"The ID of the temporary token request to delete.","in":"path","name":"temporary_token_request_id","required":true,"schema":{"format":"^spttr_[0-9a-v]{20}_[0-9a-z]{26}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryTokenRequest"}}},"description":"OK"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete temporary token request","tags":["Auth"]},"get":{"description":"Get a temporary token request status with token.","operationId":"auth_loginToken_get","parameters":[{"description":"The ID of the temporary token request to get.","in":"path","name":"temporary_token_request_id","required":true,"schema":{"format":"^spttr_[0-9a-v]{20}_[0-9a-z]{26}$","type":"string"}},{"description":"The challenge code to request the temporary token. Will only be obtained after confirming the login request in the Turbot Pipes UI.","in":"query","name":"code","schema":{"format":"^[0-9]{6}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryTokenRequest"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get temporary token request","tags":["Auth"]},"patch":{"description":"Update a temporary token request status.","operationId":"auth_loginToken_update","parameters":[{"description":"The ID of the temporary token request to update.","in":"path","name":"temporary_token_request_id","required":true,"schema":{"format":"^spttr_[0-9a-v]{20}_[0-9a-z]{26}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTemporaryTokenRequest"}}},"description":"The request body containing updates for the temporary token request.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryTokenRequest"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update temporary token request","tags":["Auth"],"x-codegen-request-body-name":"request"}},"/logout/{provider}":{"get":{"description":"Removes the session that is associated with the user.","operationId":"auth_logout","parameters":[{"description":"The authentication provider.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"responses":{"307":{"content":{},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"User logout","tags":["Auth"]}},"/notifier":{"get":{"description":"List all notifiers for a custom tenant","operationId":"tenantNotifier_list","parameters":[{"description":"The maximum number of items to return.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"The token to retrieve the next page.","in":"query","name":"next_token","schema":{"type":"string"}},{"description":"The filter to apply to the list.","in":"query","name":"where","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNotifiersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant notifiers","tags":["TenantNotifiers"]},"post":{"description":"Create a new notifier for a custom tenant","operationId":"tenantNotifier_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNotifierRequest"}}},"description":"The request body for the notifier to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create tenant notifier","tags":["TenantNotifiers"],"x-codegen-request-body-name":"request"}},"/notifier/{notifier_name}":{"delete":{"description":"Delete a notifier for a custom tenant","operationId":"tenantNotifier_delete","parameters":[{"description":"The name of the notifier to be deleted.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete tenant notifier","tags":["TenantNotifiers"]},"get":{"description":"Get a notifier for a custom tenant","operationId":"tenantNotifier_get","parameters":[{"description":"The name of the notifier to be retrieved.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant notifier","tags":["TenantNotifiers"]},"patch":{"description":"Update a notifier for a custom tenant","operationId":"tenantNotifier_update","parameters":[{"description":"The name of the notifier to be updated.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNotifierRequest"}}},"description":"The request body for the notifier to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update tenant notifier","tags":["TenantNotifiers"],"x-codegen-request-body-name":"request"}},"/org":{"get":{"description":"List all the organizations.","operationId":"org_list","parameters":[{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrgsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List orgs","tags":["Orgs"]},"post":{"description":"Creates an organization.","operationId":"org_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrgRequest"}}},"description":"The request body to create the organization.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Org"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org","tags":["Orgs"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}":{"delete":{"description":"Deletes the specified organization if you have the appropriate access.","operationId":"org_delete","parameters":[{"description":"Specify the handle of the organization which need to be deleted.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Org"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org","tags":["Orgs"]},"get":{"description":"Retrieves the organization information.","operationId":"org_get","parameters":[{"description":"Specify the handle of an organization whose information you want to retrieve.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Org"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org","tags":["Orgs"]},"patch":{"description":"Updates the handle name, display name, or the URL of an organization.","operationId":"org_update","parameters":[{"description":"Specify the handle of the organization which need to be updated.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrgRequest"}}},"description":"The request body for the organization.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Org"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org","tags":["Orgs"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/ai/key":{"get":{"description":"Lists AI provider API keys configured at the organization level.","operationId":"aiKey_org_list","parameters":[{"description":"The handle of the organization for which to list AI keys.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned. Pass next_token to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAIKeysResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org AI keys","tags":["AIKeys"]},"post":{"description":"Creates a new AI provider API key at the organization level.","operationId":"aiKey_org_create","parameters":[{"description":"The handle of the organization for which the AI key is being created.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAIKeyRequest"}}},"description":"The request body containing the AI provider and API key to save.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIKey"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org AI key","tags":["AIKeys"],"x-codegen-request-body-name":"body"}},"/org/{org_handle}/ai/key/{provider}":{"delete":{"description":"Deletes an existing AI provider API key at the organization level.","operationId":"aiKey_org_delete","parameters":[{"description":"The handle of the organization that owns the AI key.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The AI provider for which to delete the key.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIKey"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org AI key","tags":["AIKeys"]},"get":{"description":"Retrieves the AI provider API key metadata at the organization level.","operationId":"aiKey_org_get","parameters":[{"description":"The handle of the organization that owns the AI key.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The AI provider for which to retrieve the key.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIKey"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org AI key","tags":["AIKeys"]},"patch":{"description":"Updates an existing AI provider API key at the organization level.","operationId":"aiKey_org_update","parameters":[{"description":"The handle of the organization that owns the AI key.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The AI provider for which to update the key.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAIKeyRequest"}}},"description":"The request body containing the updated API key value.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIKey"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org AI key","tags":["AIKeys"],"x-codegen-request-body-name":"body"}},"/org/{org_handle}/ai/key/{provider}/test":{"post":{"description":"Tests whether an AI provider API key is valid at the organization level. If a key is not provided in the body, the existing saved key for the provider will be tested.","operationId":"aiKey_org_test","parameters":[{"description":"The handle of the organization that owns the AI key.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The AI provider for which to test the key.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestAIKeyRequest"}}},"description":"Optional request body containing an API key to test instead of the saved one.","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestAIKeyResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Test org AI key","tags":["AIKeys"],"x-codegen-request-body-name":"body"}},"/org/{org_handle}/audit_log":{"get":{"description":"Returns the audit logs for an org.","operationId":"org_listAuditLogs","parameters":[{"description":"Specify the org handle to get the audit logs.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuditLogsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Org audit logs","tags":["Orgs"]}},"/org/{org_handle}/avatar":{"delete":{"description":"Delete custom avatar for an org.","operationId":"org_deleteAvatar","parameters":[{"description":"The handle of the org whose avatar is to be deleted.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAvatarResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org avatar","tags":["Orgs"]},"post":{"description":"Create custom avatar for an org.","operationId":"org_createAvatar","parameters":[{"description":"The handle of the org whose avatar is to be created.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"string"}}},"description":"The format data containing the org avatar.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAvatarResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org avatar","tags":["Orgs"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/billing/invoice":{"get":{"description":"List org invoices. TODO: paging, Stripe suports this we need to to implement it.","operationId":"orgBilling_listOrgBillingInvoices","parameters":[{"description":"The handle of an organization","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBillingInvoicesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org invoices","tags":["OrgBilling"]}},"/org/{org_handle}/billing/invoice/{invoice_id}":{"get":{"description":"Get an invoice for an organization.","operationId":"orgBilling_getOrgBillingInvoice","parameters":[{"description":"The handle of an organization","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The org invoice id.","in":"path","name":"invoice_id","required":true,"schema":{"format":"^in_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingInvoice"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get an organization invoice","tags":["OrgBilling"]}},"/org/{org_handle}/billing/payment_method":{"get":{"description":"List org billing payment methods.","operationId":"orgBilling_listOrgBillingPaymentMethod","parameters":[{"description":"The handle of an organization","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBillingPaymentMethodsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org billing payment methods.","tags":["OrgBilling"]}},"/org/{org_handle}/billing/payment_method/intent":{"post":{"description":"Create Stripe billing intent","operationId":"orgBilling_createBillingIntent","parameters":[{"description":"The handle of an organization where the billing intent will be created","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSetupIntent"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create Stripe billing intent","tags":["OrgBilling"]}},"/org/{org_handle}/billing/payment_method/{payment_method_id}":{"delete":{"description":"Delete org billing payment method. Deleting default payment method will result in a 403 (forbidden) error.","operationId":"orgBilling_deleteOrgBillingPaymentMethod","parameters":[{"description":"The handle of an organization","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The org payment method id.","in":"path","name":"payment_method_id","required":true,"schema":{"format":"^pm_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org billing payment method.","tags":["OrgBilling"]},"get":{"description":"List org billing payment method.","operationId":"orgBilling_getOrgBillingPaymentMethod","parameters":[{"description":"The handle of an organization","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The org payment method id.","in":"path","name":"payment_method_id","required":true,"schema":{"format":"^pm_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org billing payment method.","tags":["OrgBilling"]},"patch":{"description":"Update org billing payment method.","operationId":"orgBilling_updateOrgBillingPaymentMethod","parameters":[{"description":"The handle of an organization","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The org payment method id.","in":"path","name":"payment_method_id","required":true,"schema":{"format":"^pm_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingPaymentMethodRequest"}}},"description":"The request body for the org billing payment method update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org billing payment method.","tags":["OrgBilling"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/billing/plan":{"get":{"description":"Get the current organization billing plan.","operationId":"org_getPlan","parameters":[{"description":"Specify the handle of the organization to retrieve the billing plan for.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityPlan"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org billing plan.","tags":["Orgs"]}},"/org/{org_handle}/billing/stripe/invoice/upcoming":{"get":{"description":"Get upcoming invoice. Can be used to let subscriber know the estimated amount for next invoice.","operationId":"orgBilling_getOrgBillingUpcomingInvoice","parameters":[{"description":"The handle of an organization","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingInvoice"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get upcoming invoice","tags":["OrgBilling"]}},"/org/{org_handle}/billing/subscription":{"get":{"description":"List org subscriptions. TODO: org should only have 1 active subscriptions, but what if we change subscriptions (is it possible?). Should we display old subscriptions?","operationId":"orgBilling_listOrgSubscription","parameters":[{"description":"The handle of an organization","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSubscriptionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org subscriptions","tags":["OrgBilling"]},"post":{"description":"Create a new subscription for the org. There can only be 1 active subscription per org.","operationId":"orgBilling_createOrgSubscription","parameters":[{"description":"The handle of the organization where the subscription will be created.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscription"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create a new subscription","tags":["OrgBilling"]}},"/org/{org_handle}/billing/subscription/{subscription_id}":{"delete":{"description":"Delete org subscription. TODO: prorate, when to delete subscription. Webhook when the Subscription is finally deleted.","operationId":"orgBilling_deleteOrgBillingSubscription","parameters":[{"description":"The handle of an organization.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The org subscription id.","in":"path","name":"subscription_id","required":true,"schema":{"format":"^sub_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscription"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org subscription","tags":["OrgBilling"]},"get":{"description":"Get org subscription","operationId":"orgBilling_getOrgBillingSubscription","parameters":[{"description":"The handle of an organization.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The org subscription id.","in":"path","name":"subscription_id","required":true,"schema":{"format":"^sub_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscription"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org subscription","tags":["OrgBilling"]},"patch":{"description":"Update org subscription. Use this API to \"stop cancel at the next billing period\" by passing \"stopcancel\" in the action parameter.","operationId":"orgBilling_updateOrgBillingSubscription","parameters":[{"description":"The handle of an organization.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The org subscription id.","in":"path","name":"subscription_id","required":true,"schema":{"format":"^sub_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingSubscriptionRequest"}}},"description":"Request body to update org subscription","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscription"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org subscription","tags":["OrgBilling"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/conn":{"get":{"deprecated":true,"description":"List connections for an organization.","operationId":"orgConnection_listDeprecated","parameters":[{"description":"The handle of the org for which we want to list connections.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org connections","tags":["OrgConnections"]},"post":{"deprecated":true,"description":"Creates a new connection for an organization.","operationId":"orgConnection_createDeprecated","parameters":[{"description":"The handle of the organization where we want to create the connection.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionRequest"}}},"description":"The request body for the connection to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org connection","tags":["OrgConnections"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/conn/{conn_handle}":{"delete":{"deprecated":true,"description":"Delete a connection belonging to an org.","operationId":"orgConnection_deleteDeprecated","parameters":[{"description":"The handle of the organization where the connection exist.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection that needs to be deleted.","in":"path","name":"conn_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org connection","tags":["OrgConnections"]},"get":{"deprecated":true,"description":"Get the details for a connection belonging to an org.","operationId":"orgConnection_getDeprecated","parameters":[{"description":"The handle of an organization where the connection exists.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection whose detail needs to be fetched.","in":"path","name":"conn_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org connection","tags":["OrgConnections"]},"patch":{"deprecated":true,"description":"Update the details of a connection belonging to an org.","operationId":"orgConnection_updateDeprecated","parameters":[{"description":"The handle of the organization where the connection exist.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection which needs to be updated.","in":"path","name":"conn_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectionRequest"}}},"description":"The request body for the connection which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org connection","tags":["OrgConnections"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/conn/{conn_handle}/test":{"post":{"deprecated":true,"description":"Test the config for an org connection to check for basic connectivity.","operationId":"orgConnection_testDeprecated","parameters":[{"description":"The handle of the org where the connection exists / intends to be created.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection.","in":"path","name":"conn_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestConnectionRequest"}}},"description":"The request body for the connection to be tested.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionTestResult"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Test org connection","tags":["OrgConnections"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/conn/{conn_handle}/workspace":{"get":{"deprecated":true,"description":"List the workspaces that an org connection has been added to.","operationId":"orgConnection_listWorkspacesDeprecated","parameters":[{"description":"The handle of the organization where the connection exists.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection for which we want to list workspaces.","in":"path","name":"conn_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceConnResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org connection workspaces","tags":["OrgConnections"]}},"/org/{org_handle}/connection":{"get":{"description":"List connections for an organization.","operationId":"orgConnection_list","parameters":[{"description":"The handle of the organization for which we want to list connections.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org connections","tags":["OrgConnections"]},"post":{"description":"Creates a new connection for an organization.","operationId":"orgConnection_create","parameters":[{"description":"The handle of the organization where we want to create the connection.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionRequest"}}},"description":"The request body for the connection to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org connection","tags":["OrgConnections"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/connection/{connection_handle}":{"delete":{"description":"Deletes a connection belonging to an org.","operationId":"orgConnection_delete","parameters":[{"description":"The handle of the organization where the connection exists.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection that needs to be deleted.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org connection","tags":["OrgConnections"]},"get":{"description":"Get the details of a connection belonging to an org.","operationId":"orgConnection_get","parameters":[{"description":"The handle of an organization where the connection exists.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection whose detail needs to be fetched.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org connection","tags":["OrgConnections"]},"patch":{"description":"Update the details of a connection belonging to an org.","operationId":"orgConnection_update","parameters":[{"description":"The handle of the organization where the connection exists.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection which needs to be updated.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectionRequest"}}},"description":"The request body of the connection which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org connection","tags":["OrgConnections"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/connection/{connection_handle}/permission":{"get":{"description":"List permissions for a connection defined on an org.","operationId":"orgConnection_listPermission","parameters":[{"description":"The handle of the org for which we want to list connection permissions.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection for which we want to list permissions.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org connection permissions","tags":["OrgConnections"]},"post":{"description":"Create permissions for a connection defined on an org.","operationId":"orgConnection_createPermission","parameters":[{"description":"The handle of the org for which we want to list connection permissions.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection for which we want to list permissions.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePermissionRequest"}}},"description":"The request body for the connection permission to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org connection permission","tags":["OrgConnections"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/connection/{connection_handle}/permission/{permission_id}":{"delete":{"description":"Delete permission for a connection defined on an org.","operationId":"orgConnection_deletePermission","parameters":[{"description":"The handle of the org for which we want to delete connection permission for.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection for which we want to delete permission for.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The id of the permission which we want to delete.","in":"path","name":"permission_id","required":true,"schema":{"format":"^perm[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org connection permission","tags":["OrgConnections"]},"get":{"description":"Get permission for a connection defined on an org.","operationId":"orgConnection_getPermission","parameters":[{"description":"The handle of the org for which we want to get connection permission for.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection for which we want to get permission for.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The id of the permission which we want to retrieve.","in":"path","name":"permission_id","required":true,"schema":{"format":"^perm[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org connection permission","tags":["OrgConnections"]},"patch":{"description":"Update permission for a connection defined on an org.","operationId":"orgConnection_updatePermission","parameters":[{"description":"The handle of the org for which we want to update connection permission for.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection for which we want to update permission for.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The id of the permission which we want to update.","in":"path","name":"permission_id","required":true,"schema":{"format":"^perm[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePermissionRequest"}}},"description":"The request body for the connection permission to be update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org connection permission","tags":["OrgConnections"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/connection/{connection_handle}/test":{"post":{"description":"Test the config for an org connection to check for basic connectivity before you create it.","operationId":"orgConnection_test","parameters":[{"description":"The handle of the org performing the action.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestConnectionRequest"}}},"description":"The request body for the connection to be tested.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionTestResult"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Test org connection","tags":["OrgConnections"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/connection/{connection_handle}/workspace":{"get":{"description":"List the workspaces that an org connection has been added to.","operationId":"orgConnection_listWorkspaces","parameters":[{"description":"The handle of the organization where the connection exists.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection for which we want to list workspaces.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceConnectionAssociationsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org connection workspaces","tags":["OrgConnections"]}},"/org/{org_handle}/connection_folder":{"get":{"description":"List connection folders for an org.","operationId":"orgConnectionFolder_list","parameters":[{"description":"The handle of the org for which we want to list connection folders.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org connection folders","tags":["OrgConnectionFolders"]},"post":{"description":"Creates a new connection folder for an org.","operationId":"orgConnectionFolder_create","parameters":[{"description":"The handle of the org for which we want to create a connection folder.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionFolderRequest"}}},"description":"The request body for the connection folder to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org connection folder","tags":["OrgConnectionFolders"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/connection_folder/{folder_id}":{"delete":{"description":"Deletes an org connection folder.","operationId":"orgConnectionFolder_delete","parameters":[{"description":"The handle of the org for which we want to delete the connection folder.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The ID of the connection folder that needs to be deleted.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org connection folder","tags":["OrgConnectionFolders"]},"get":{"description":"Get connection folder for an org.","operationId":"orgConnectionFolder_get","parameters":[{"description":"The handle of the org for which we want to retrieve the connection folder.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The ID of the connection folder to retrieve.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org connection folder","tags":["OrgConnectionFolders"]},"patch":{"description":"Update the details of an org connection folder.","operationId":"orgConnectionFolder_update","parameters":[{"description":"The handle of the org for which we want to update the connection folder.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The ID of the connection folder which needs to be updated.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectionFolderRequest"}}},"description":"The request body for the connection which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org connection folder","tags":["OrgConnectionFolders"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/connection_folder/{folder_id}/permission":{"get":{"description":"List permissions for a connection folder defined on an organization.","operationId":"orgConnectionFolder_listPermission","parameters":[{"description":"The handle of the org for which we want to list connection folder permissions.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The ID of the connection folder for which we want to list permissions.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org connection folder permissions","tags":["OrgConnectionFolders"]},"post":{"description":"Create permissions for a connection folder defined on the organization level.","operationId":"orgConnectionFolder_createPermission","parameters":[{"description":"The handle of the org for which we want to create connection folder permissions.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The ID of the connection folder for which we want to create permissions.","in":"path","name":"folder_id","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePermissionRequest"}}},"description":"The request body for the connection folder permission to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org connection folder permission","tags":["OrgConnectionFolders"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/connection_folder/{folder_id}/permission/{permission_id}":{"delete":{"description":"Delete permission for a connection folder defined on an org.","operationId":"orgConnectionFolder_deletePermission","parameters":[{"description":"The handle of the org for which we want to delete connection folder permissions.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The ID of the connection folder for which we want to delete permission.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The id of the permission which we want to delete.","in":"path","name":"permission_id","required":true,"schema":{"format":"^perm[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org connection folder permission","tags":["OrgConnectionFolders"]},"get":{"description":"Get permission for a connection folder defined on an org.","operationId":"orgConnectionFolder_getPermission","parameters":[{"description":"The handle of the org for which we want to get connection folder permissions.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The ID of the connection folder for which we want to get permission.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The id of the permission which we want to retrieve.","in":"path","name":"permission_id","required":true,"schema":{"format":"^perm[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org connection folder permission","tags":["OrgConnectionFolders"]},"patch":{"description":"Update permission for a connection folder defined on an org.","operationId":"orgConnectionFolder_updatePermission","parameters":[{"description":"The handle of the org for which we want to update connection permissions.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The ID of the connection folder for which we want to update permission.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The id of the permission which we want to update.","in":"path","name":"permission_id","required":true,"schema":{"format":"^perm[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePermissionRequest"}}},"description":"The request body for the connection permission to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org connection folder permission","tags":["OrgConnectionFolders"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/connection_folder/{folder_id}/workspace":{"get":{"description":"List the workspaces that an org connection folder has been added to.","operationId":"orgConnectionFolder_listWorkspaces","parameters":[{"description":"The handle of the org for which we want to list connection folder workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The ID of the connection folder for which we want to list workspaces.","in":"path","name":"folder_id","required":true,"schema":{"format":"^c[a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceConnectionAssociationsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org connection folder workspaces","tags":["OrgConnectionFolders"]}},"/org/{org_handle}/connection_tree":{"get":{"description":"List connection tree for a tenant.","operationId":"orgConnectionTree_list","parameters":[{"description":"The handle of the org for which we want to list connection tree.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The prefix to be used when listing items in a connection tree","in":"query","name":"prefix","schema":{"type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant connection tree","tags":["OrgConnectionTree"]}},"/org/{org_handle}/constraint":{"get":{"description":"List all applicable constraints for an org.","operationId":"org_listConstraints","parameters":[{"description":"Specify the handle of the org whose constraints you want to retrieve.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConstraintsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org constraints","tags":["Orgs"]}},"/org/{org_handle}/integration":{"get":{"description":"List integrations configured for an organization.","operationId":"orgIntegration_list","parameters":[{"description":"The handle of the org for which you want to list integrations.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListIntegrationsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org integrations","tags":["OrgIntegrations"]},"post":{"description":"Creates a new integration for an organization.","operationId":"orgIntegration_create","parameters":[{"description":"The handle of the org for which you want to create an integration.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationRequest"}}},"description":"The request body for the integration to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org integration","tags":["OrgIntegrations"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/integration/{integration_handle}":{"delete":{"description":"Delete an integration configured for an organization.","operationId":"orgIntegration_delete","parameters":[{"description":"The handle of the organization on which the integration is configured.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration which needs to be deleted.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org integration","tags":["OrgIntegrations"]},"get":{"description":"Get details of an integration configured on an organization.","operationId":"orgIntegration_get","parameters":[{"description":"The handle of the org to which the integration belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration whose details need to be retrieved.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org integration","tags":["OrgIntegrations"]},"patch":{"description":"Update details of an integration configured for an organization.","operationId":"orgIntegration_update","parameters":[{"description":"The handle of the org on which the integration is configured.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration whose details need to be updated.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationRequest"}}},"description":"The request body for the integration update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org integration","tags":["OrgIntegrations"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/integration/{integration_handle}/command":{"post":{"description":"Run a command for an org integration","operationId":"orgIntegration_command","parameters":[{"description":"The handle of the organization to which the integration belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration for which we want to run the command.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCommandRequest"}}},"description":"The request body for the workspace command.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationCommandRequest"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Run org integration command","tags":["OrgIntegrations"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/integration/{integration_handle}/github/install":{"get":{"description":"Install a GitHub integration for an org identity.","operationId":"orgIntegration_installGithubIntegration","parameters":[{"description":"The handle of the organization to which the integration belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the GitHub integration which needs to be installed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"307":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Temporary Redirect"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Install GitHub integration for an org","tags":["OrgIntegrations"]}},"/org/{org_handle}/integration/{integration_handle}/slack/channel":{"get":{"description":"List Slack channels that are given access to a user Slack integration.","operationId":"orgIntegration_listSlackChannels","parameters":[{"description":"The handle of the organization to which the integration belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration for which Slack channels will be listed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSlackChannelsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org integration Slack channels","tags":["OrgIntegrations"]}},"/org/{org_handle}/integration/{integration_handle}/slack/install":{"get":{"description":"Install a Slack integration for an org identity.","operationId":"orgIntegration_installSlackIntegration","parameters":[{"description":"The handle of the organization to which the integration belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the Slack integration which needs to be installed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"307":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Temporary Redirect"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Install Slack integration for an org","tags":["OrgIntegrations"]}},"/org/{org_handle}/integration/{integration_handle}/test":{"post":{"description":"Test the config for an org integration to check for basic connectivity before you create it.","operationId":"orgIntegration_test","parameters":[{"description":"The handle of the org to which the integration belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration to be tested. For integrations that are not yet created, use underscore `_` as the handle, else pass the handle of the existing integration.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestIntegrationRequest"}}},"description":"The request body configuration for the integration to be tested.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Test org integration","tags":["OrgIntegrations"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/member":{"get":{"description":"List all members of an organization who are invited / accepted.","operationId":"orgMember_list","parameters":[{"description":"Specify the organization handle.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Optional free-text search to filter the org members.","in":"query","name":"q","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrgUsersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List Organization Members","tags":["OrgMembers"]},"post":{"description":"Add a user as a member of an org in a custom tenant.","operationId":"orgMember_create","parameters":[{"description":"Specify the handle of the organization where the member need to be created.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrgUserRequest"}}},"description":"The request body to create a member in an organization in a custom tenant.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgUser"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create Org Member","tags":["OrgMembers"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/member/invite":{"delete":{"description":"Delete the org member invite.","operationId":"orgMember_deleteInvite","parameters":[{"description":"Specify the organization handle.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the token to be rejected.","in":"query","name":"t","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{},"description":""},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org member invite","tags":["OrgMembers"]},"post":{"description":"Invite member to an org.","operationId":"orgMember_invite","parameters":[{"description":"Specify the handle of an organization where the member need to be invited.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteOrgUserRequest"}}},"description":"The request body to invite a member to an organization.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgUser"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Invite org member","tags":["OrgMembers"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/member/invite/confirm":{"get":{"description":"Confirm org member invite.","operationId":"orgMember_confirmInvite","parameters":[{"description":"Specify the handle of an organization where the member need to be invited.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the token.","in":"query","name":"t","required":true,"schema":{"type":"string"}}],"responses":{"201":{"content":{},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Confirm org member invite","tags":["OrgMembers"]}},"/org/{org_handle}/member/{user_handle}":{"delete":{"description":"Delete the user from the org.","operationId":"orgMember_delete","parameters":[{"description":"Specify the handle of the organization where the member exists.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the handle of the user which need to be removed.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgUser"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org member","tags":["OrgMembers"]},"get":{"description":"Get org member.","operationId":"orgMember_get","parameters":[{"description":"Specify the organization handle where the member is associated.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the handle of the user whose information you want to retrieve.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgUser"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org member","tags":["OrgMembers"]},"patch":{"description":"Update the role of the member.","operationId":"orgMember_update","parameters":[{"description":"Specify the handle of the organization where the member exists.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the handle of the user whose role need to be updated.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrgUserRequest"}}},"description":"The request body for the member.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgUser"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org member","tags":["OrgMembers"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/notifier":{"get":{"description":"List all notifiers for an org","operationId":"orgNotifier_list","parameters":[{"description":"The handle of the org for which the notifiers are to be listed.","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The maximum number of items to return.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"The token to retrieve the next page.","in":"query","name":"next_token","schema":{"type":"string"}},{"description":"The filter to apply to the list.","in":"query","name":"where","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNotifiersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org notifiers","tags":["OrgNotifiers"]},"post":{"description":"Create a new notifier for an org","operationId":"orgNotifier_create","parameters":[{"description":"The handle of the org for which the notifier is to be created.","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNotifierRequest"}}},"description":"The request body for the notifier to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org notifier","tags":["OrgNotifiers"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/notifier/{notifier_name}":{"delete":{"description":"Delete a notifier for an org","operationId":"orgNotifier_delete","parameters":[{"description":"The handle of the org for which the notifier is to be deleted.","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The name of the notifier to be deleted.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org notifier","tags":["OrgNotifiers"]},"get":{"description":"Get a notifier for an org","operationId":"orgNotifier_get","parameters":[{"description":"The handle of the org for which the notifier is to be retrieved.","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The name of the notifier to be retrieved.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org notifier","tags":["OrgNotifiers"]},"patch":{"description":"Update a notifier for an org","operationId":"orgNotifier_update","parameters":[{"description":"The handle of the org for which the notifier is to be updated.","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The name of the notifier to be updated.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNotifierRequest"}}},"description":"The request body for the notifier to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org notifier","tags":["OrgNotifiers"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/process":{"get":{"description":"List processes for an org.","operationId":"orgProcess_list","parameters":[{"description":"The handle of an organization to list the processes.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProcessesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List Org processes","tags":["OrgProcesses"]}},"/org/{org_handle}/process/{process_id}":{"get":{"description":"Get a process for an org.","operationId":"orgProcess_get","parameters":[{"description":"The handle of an organization to get the process.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The id of the process to be fetched.","in":"path","name":"process_id","required":true,"schema":{"format":"^[a-z]{1,3}_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpProcess"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get Org process","tags":["OrgProcesses"]}},"/org/{org_handle}/process/{process_id}/log/{log_file}.{content_type}":{"get":{"description":"List the process logs for a given process of an org.","operationId":"orgProcess_log","parameters":[{"description":"The handle of an organization to list the process logs.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The id of the process where you want to list the process logs.","in":"path","name":"process_id","required":true,"schema":{"format":"^[a-z]{1,3}_[0-9a-v]{20}$","type":"string"}},{"description":"The process logs file to be fetched.","in":"path","name":"log_file","required":true,"schema":{"enum":["process"],"type":"string"}},{"description":"The required content type of the process logs.","in":"path","name":"content_type","required":true,"schema":{"enum":["jsonl"],"type":"string"}}],"responses":{"200":{"content":{"application/jsonlines+json":{"schema":{"type":"string"}}},"description":"OK"},"204":{"content":{"application/jsonlines+json":{"schema":{"type":"string"}}},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List Org process logs","tags":["OrgProcesses"]}},"/org/{org_handle}/service_account":{"get":{"description":"Lists service accounts at the organization level.","operationId":"orgServiceAccount_list","parameters":[{"description":"The handle of the organization","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"Maximum number of items to return. Default 100. Max 1000.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}},{"description":"Additional data to include. Supported value: tokens.","in":"query","name":"include","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List organization service accounts","tags":["OrgServiceAccounts"]},"post":{"description":"Create a new service account at the organization level.","operationId":"orgServiceAccount_create","parameters":[{"description":"The handle of the organization where the service account will be created","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceAccountUserRequest"}}},"description":"The request body containing service account details","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create a service account at the organization level","tags":["OrgServiceAccounts"],"x-codegen-request-body-name":"body"}},"/org/{org_handle}/service_account/{service_account_identifier}":{"delete":{"description":"Delete an existing service account at the organization level.","operationId":"orgServiceAccount_delete","parameters":[{"description":"The handle of the organization","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The ID of the service account to delete","in":"path","name":"service_account_identifier","required":true,"schema":{"type":"string"}}],"responses":{"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete an organization service account","tags":["OrgServiceAccounts"]},"get":{"description":"Retrieves a specific org-level service account.","operationId":"orgServiceAccount_get","parameters":[{"description":"The handle of the organization","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The ID of the service account","in":"path","name":"service_account_identifier","required":true,"schema":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get organization service account","tags":["OrgServiceAccounts"]},"patch":{"description":"Update an existing service account at the organization level.","operationId":"orgServiceAccount_update","parameters":[{"description":"The handle of the organization","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The ID of the service account to update","in":"path","name":"service_account_identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateServiceAccountUserRequest"}}},"description":"The request body containing the updated service account details","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update an organization service account","tags":["OrgServiceAccounts"],"x-codegen-request-body-name":"body"}},"/org/{org_handle}/service_account/{service_account_identifier}/audit_log":{"get":{"description":"Returns the audit logs where the service account is either the actor or the identity (org-level service account).","operationId":"orgServiceAccountAudit_list","parameters":[{"description":"The handle of the organization","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The ID of the service account","in":"path","name":"service_account_identifier","required":true,"schema":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuditLogsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List audit logs for an org service account","tags":["OrgServiceAccountAuditLogs"]}},"/org/{org_handle}/service_account/{service_account_identifier}/token":{"get":{"description":"Lists tokens for an organization-level service account.","operationId":"orgServiceAccountToken_list","parameters":[{"description":"The handle of the organization","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The ID of the service account","in":"path","name":"service_account_identifier","required":true,"schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTokensResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List organization service account tokens","tags":["OrgServiceAccountTokens"]},"post":{"description":"Create a new token for an organization-level service account.","operationId":"orgServiceAccountToken_create","parameters":[{"description":"The handle of the organization","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The ID of the service account","in":"path","name":"service_account_identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTokenRequest"}}},"description":"The request body containing token details","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenWithValue"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create an organization service account token","tags":["OrgServiceAccountTokens"],"x-codegen-request-body-name":"body"}},"/org/{org_handle}/service_account/{service_account_identifier}/token/{token_id}":{"delete":{"description":"Delete a token for an organization-level service account.","operationId":"orgServiceAccountToken_delete","parameters":[{"description":"The handle of the organization","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The ID of the service account","in":"path","name":"service_account_identifier","required":true,"schema":{"type":"string"}},{"description":"The identifier of the token","in":"path","name":"token_id","required":true,"schema":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete an organization service account token","tags":["OrgServiceAccountTokens"]},"get":{"description":"Retrieves a specific token for an organization-level service account.","operationId":"orgServiceAccountToken_get","parameters":[{"description":"The handle of the organization","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The ID of the service account","in":"path","name":"service_account_identifier","required":true,"schema":{"type":"string"}},{"description":"The identifier of the token","in":"path","name":"token_id","required":true,"schema":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get an organization service account token","tags":["OrgServiceAccountTokens"]},"patch":{"description":"Update an existing token for an organization-level service account.","operationId":"orgServiceAccountToken_update","parameters":[{"description":"The handle of the organization","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The ID of the service account","in":"path","name":"service_account_identifier","required":true,"schema":{"type":"string"}},{"description":"The identifier of the token","in":"path","name":"token_id","required":true,"schema":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTokenRequest"}}},"description":"The request body containing the updated token details","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update an organization service account token","tags":["OrgServiceAccountTokens"],"x-codegen-request-body-name":"body"}},"/org/{org_handle}/usage":{"get":{"description":"List all usage metrics for an org.","operationId":"org_listUsage","parameters":[{"description":"Specify the handle of the org whose constraints you want to retrieve.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsageMetricsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org usage","tags":["Orgs"]}},"/org/{org_handle}/workspace":{"get":{"description":"List the workspace for an organization.","operationId":"orgWorkspace_list","parameters":[{"description":"The handle of the organization for which we want to list the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspacesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspaces","tags":["OrgWorkspaces"]},"post":{"description":"Creates a new workspace for an organization. The limit is 10 per organization. If you require more than 10, you must contact support to request an increase.","operationId":"orgWorkspace_create","parameters":[{"description":"The handle of the organization where we want to create the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceRequest"}}},"description":"The request body for the workspace to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org workspace","tags":["OrgWorkspaces"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}":{"delete":{"description":"Deletes the workspace specified in the request.","operationId":"orgWorkspace_delete","parameters":[{"description":"The handle of the organization where the workspace exist.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Provide the handle of the workspace which needs to be deleted.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org workspace","tags":["OrgWorkspaces"]},"get":{"description":"Get the details for a workspace in an organization.","operationId":"orgWorkspace_get","parameters":[{"description":"The handle for an organization where the workspace exist.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace whose detail needs to be fetched.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace","tags":["OrgWorkspaces"]},"patch":{"description":"Update a workspace in an organization.","operationId":"orgWorkspace_update","parameters":[{"description":"The handle of the organization where the workspace exist.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace which needs to be updated.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceRequest"}}},"description":"The request body of the workspace which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org workspace","tags":["OrgWorkspaces"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/aggregator":{"get":{"description":"List aggregators for a workspace of an org.","operationId":"orgWorkspaceAggregator_list","parameters":[{"description":"The handle of the org to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace for which we will be listing aggregators.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceAggregatorsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List aggregators for an org workspace","tags":["OrgWorkspaceAggregators"]},"post":{"description":"Creates an aggregator for a workspace of an org.","operationId":"orgWorkspaceAggregator_create","parameters":[{"description":"The handle of the org to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the aggregator will be created.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAggregatorRequest"}}},"description":"The request body for the aggregator to the created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Aggregator"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create an aggregator for an org workspace","tags":["OrgWorkspaceAggregators"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle}":{"delete":{"description":"Deletes an aggregator belonging to a workspace of an org.","operationId":"orgWorkspaceAggregator_delete","parameters":[{"description":"The handle of the org to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the aggregator exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the aggregator that needs to be deleted.","in":"path","name":"aggregator_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Aggregator"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete an aggregator for a org workspace","tags":["OrgWorkspaceAggregators"]},"get":{"description":"Get the details of an aggregator belonging to a workspace of an org.","operationId":"orgWorkspaceAggregator_get","parameters":[{"description":"The handle of the org to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the aggregator exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the aggregator whose details needs to be fetched.","in":"path","name":"aggregator_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Aggregator"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get an aggregator for a org workspace","tags":["OrgWorkspaceAggregators"]},"patch":{"description":"Update the details of an aggregator belonging to a workspace of an org.","operationId":"orgWorkspaceAggregator_update","parameters":[{"description":"The handle of the org to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the aggregator exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the aggregator whose details needs to be updated.","in":"path","name":"aggregator_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAggregatorRequest"}}},"description":"The request body for the aggregator which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Aggregator"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update an aggregator for a org workspace","tags":["OrgWorkspaceAggregators"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle}/connection":{"get":{"description":"List all connections that are a part of an aggregator defined in a workspace of an org.","operationId":"orgWorkspaceAggregator_listConnections","parameters":[{"description":"The handle of the org to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the aggregator exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the aggregator whose connections need to be fetched.","in":"path","name":"aggregator_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List connections in the scope of an aggregator for a org workspace","tags":["OrgWorkspaceAggregators"]}},"/org/{org_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle}/connection/{connection_handle}":{"get":{"description":"Get a connection that is a part of an aggregator defined in a workspace of an org.","operationId":"orgWorkspaceAggregator_getConnection","parameters":[{"description":"The handle of the org to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the aggregator exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the aggregator which the connection is a part of.","in":"path","name":"aggregator_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The handle of the connection whose details need to be fetched.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceConnection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get a connection in the scope of an aggregator for a org workspace","tags":["OrgWorkspaceAggregators"]}},"/org/{org_handle}/workspace/{workspace_handle}/ai/chat":{"post":{"description":"Sends a chat message to the AI agent in an org workspace. Creates a new conversation if conversation_id is not provided.","operationId":"conversation_org_chat","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatRequest"}}},"description":"The chat request payload containing the message, model and optional conversation_id.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Chat in org workspace","tags":["OrgWorkspaceConversations"],"x-codegen-request-body-name":"body"}},"/org/{org_handle}/workspace/{workspace_handle}/ai/conversation":{"get":{"description":"Lists AI conversations in an org workspace with optional filtering and pagination.","operationId":"conversation_org_list","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"Optional filter expression for title.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned. Pass next_token to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConversationsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace conversations","tags":["OrgWorkspaceConversations"]}},"/org/{org_handle}/workspace/{workspace_handle}/ai/conversation/{conversation_id}":{"delete":{"description":"Deletes a specific org workspace conversation.","operationId":"conversation_org_delete","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The ID of the conversation to delete.","in":"path","name":"conversation_id","required":true,"schema":{"format":"^conv_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org workspace conversation","tags":["OrgWorkspaceConversations"]},"get":{"description":"Retrieves details for a specific org workspace conversation.","operationId":"conversation_org_get","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The ID of the conversation to retrieve.","in":"path","name":"conversation_id","required":true,"schema":{"format":"^conv_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace conversation","tags":["OrgWorkspaceConversations"]},"patch":{"description":"Updates an org workspace conversation (e.g., title).","operationId":"conversation_org_update","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The ID of the conversation to update.","in":"path","name":"conversation_id","required":true,"schema":{"format":"^conv_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConversationRequest"}}},"description":"Fields to update on the conversation.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org workspace conversation","tags":["OrgWorkspaceConversations"],"x-codegen-request-body-name":"body"}},"/org/{org_handle}/workspace/{workspace_handle}/ai/conversation/{conversation_id}/artifact/{artifact_id}":{"get":{"description":"Retrieves metadata for a specific artifact created by an org workspace conversation.","operationId":"conversationArtifact_org_get","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The ID of the conversation that produced the artifact.","in":"path","name":"conversation_id","required":true,"schema":{"format":"^conv_[0-9a-v]{20}$","type":"string"}},{"description":"The ID of the artifact to retrieve.","in":"path","name":"artifact_id","required":true,"schema":{"format":"^art_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationArtifact"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace conversation artifact metadata","tags":["OrgWorkspaceConversationArtifacts"]}},"/org/{org_handle}/workspace/{workspace_handle}/ai/conversation/{conversation_id}/artifact/{artifact_id}.{content_type}":{"get":{"description":"Downloads an artifact file from an org workspace AI conversation.","operationId":"orgWorkspaceArtifact_download","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The ID of the conversation that produced the artifact.","in":"path","name":"conversation_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the artifact to download.","in":"path","name":"artifact_id","required":true,"schema":{"type":"string"}},{"description":"The type/extension of the artifact to download.","in":"path","name":"content_type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Download org workspace artifact","tags":["OrgWorkspaceArtifacts"]}},"/org/{org_handle}/workspace/{workspace_handle}/ai/conversation/{conversation_id}/message":{"get":{"description":"Lists messages for a specific org workspace conversation with pagination.","operationId":"conversationMessage_org_list","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The ID of the conversation whose messages are being listed.","in":"path","name":"conversation_id","required":true,"schema":{"format":"^conv_[0-9a-v]{20}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned. Pass next_token to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConversationMessagesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace conversation messages","tags":["OrgWorkspaceConversationMessages"]}},"/org/{org_handle}/workspace/{workspace_handle}/ai/model":{"get":{"description":"Lists available AI models for an org workspace based on configured AI keys.","operationId":"model_org_list","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListModelsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace AI models","tags":["OrgWorkspaceAIModels"]}},"/org/{org_handle}/workspace/{workspace_handle}/audit_log":{"get":{"description":"Returns the audit logs for an org workspace.","operationId":"orgWorkspace_listAuditLogs","parameters":[{"description":"Specify the org handle to get the audit logs.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace whose logs needs to be fetched.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuditLogsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Org workspace audit logs","tags":["OrgWorkspaces"]}},"/org/{org_handle}/workspace/{workspace_handle}/command":{"post":{"description":"Run a command in the workspace. Valid commands are: reboot.","operationId":"orgWorkspace_command","parameters":[{"description":"The handle of the org where we want to run the workspace command.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where command will be executed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCommandRequest"}}},"description":"The request body for the workspace command.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCommandResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Run org workspace command","tags":["OrgWorkspaces"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/conn":{"get":{"description":"List the connections associated with a workspace.","operationId":"orgWorkspaceConnectionAssociation_list","parameters":[{"description":"The handle of an organization for which you want to list the associations.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where you want to list the associations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceConnResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace connection associations","tags":["OrgWorkspaceConnectionAssociations"]},"post":{"description":"Associate a connection with the workspace. A workspace can have multiple association.","operationId":"orgWorkspaceConnectionAssociation_create","parameters":[{"description":"The handle of the organization where we want to create an association.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the connection will be associated.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceConnRequest"}}},"description":"The request body for the association to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceConn"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org workspace connection association","tags":["OrgWorkspaceConnectionAssociations"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/conn/{conn_handle}":{"delete":{"description":"Dissociates or delete the workspace and connection association.","operationId":"orgWorkspaceConnectionAssociation_delete","parameters":[{"description":"The handle of an organization where we want to delete the association.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace whose association needs to be deleted.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the conn whose association needs to be deleted.","in":"path","name":"conn_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceConn"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org workspace connection association","tags":["OrgWorkspaceConnectionAssociations"]},"get":{"description":"Get the details for a workspace and connection association on an organization.","operationId":"orgWorkspaceConnectionAssociation_get","parameters":[{"description":"The handle of the org for which you want to get the association.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the connection exist.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the conn whose association details needs to be fetched.","in":"path","name":"conn_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceConn"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace connection association","tags":["OrgWorkspaceConnectionAssociations"]}},"/org/{org_handle}/workspace/{workspace_handle}/connection":{"get":{"description":"List the connections associated with a workspace.","operationId":"orgWorkspaceConnection_list","parameters":[{"description":"The handle of an organization for which you want to list the associations.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where you want to list the associations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceConnResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace connection associations","tags":["OrgWorkspaceConnections"]},"post":{"description":"Allows to create a connection on a workspace for an org or associate a connection already existing on the org to the workspace.","operationId":"orgWorkspaceConnection_create","parameters":[{"description":"The handle of the organization to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the connection will be created / associated.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionRequest"}}},"description":"The request body for the connection to the created / identity connection to be associated.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create a connection for an org workspace or associate an org connection to the workspace","tags":["OrgWorkspaceConnections"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/connection/{connection_handle}":{"delete":{"description":"Dissociates or delete the workspace and connection association.","operationId":"orgWorkspaceConnection_delete","parameters":[{"description":"The handle of an organization where we want to delete the association.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace whose association needs to be deleted.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the connection whose association needs to be deleted.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceConnection"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org workspace connection association","tags":["OrgWorkspaceConnections"]},"get":{"description":"Get the details for a workspace and connection association on an organization.","operationId":"orgWorkspaceConnection_get","parameters":[{"description":"The handle of the org for which you want to get the association.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the connection exist.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the connection whose association details needs to be fetched.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceConnection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace connection association","tags":["OrgWorkspaceConnections"]},"patch":{"description":"Update the details of a connection belonging to a workspace of an org.","operationId":"orgWorkspaceConnection_update","parameters":[{"description":"The handle of the org where the connection to be updated exists.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the connection to be updated exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection to update.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectionRequest"}}},"description":"The request body for the connection which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org workspace connection","tags":["OrgWorkspaceConnections"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/connection/{connection_handle}/test":{"post":{"description":"Test the config for a connection configured on an org workspace to check for basic connectivity.","operationId":"orgWorkspaceConnection_test","parameters":[{"description":"The handle of the org where the connection exists / intends to be created.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the connection exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestConnectionRequest"}}},"description":"The request body for the connection to be tested.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionTestResult"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Test org workspace connection","tags":["OrgWorkspaceConnections"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/connection_folder":{"get":{"description":"List connection folders for an org workspace.","operationId":"orgWorkspaceConnectionFolder_list","parameters":[{"description":"The handle of the org where we want to create the connection folder.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the folder is to be created.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace connection folders","tags":["OrgWorkspaceConnectionFolders"]},"post":{"description":"Creates a new connection folder in a workspace of an org.","operationId":"orgWorkspaceConnectionFolder_create","parameters":[{"description":"The handle of the org where we want to create the connection folder.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the folder is to be created.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionFolderRequest"}}},"description":"The request body for the connection to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org workspace connection folder","tags":["OrgWorkspaceConnectionFolders"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/connection_folder/{folder_id}":{"delete":{"description":"Deletes a connection folder defined at an org workspace.","operationId":"orgWorkspaceConnectionFolder_delete","parameters":[{"description":"The handle of the org where the folder to be deleted exists.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the folder to be deleted exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The id of the connection folder to delete.","in":"path","name":"folder_id","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org workspace connection folder","tags":["OrgWorkspaceConnectionFolders"]},"get":{"description":"Get connection folder for a org workspace.","operationId":"orgWorkspaceConnectionFolder_get","parameters":[{"description":"The handle of the org where the folder exists.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the folder exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The id of the connection folder to retrieve.","in":"path","name":"folder_id","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace connection folder","tags":["OrgWorkspaceConnectionFolders"]},"patch":{"description":"Update the details of a connection folder belonging to an org workspace.","operationId":"orgWorkspaceConnectionFolder_update","parameters":[{"description":"The handle of the org where the folder to be updated exists.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the folder to be updated exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The id of the connection folder to be updated.","in":"path","name":"folder_id","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectionFolderRequest"}}},"description":"The request body for the connection which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org workspace connection folder","tags":["OrgWorkspaceConnectionFolders"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/connection_tree":{"get":{"description":"List connection tree for an org workspace.","operationId":"orgWorkspaceConnectionTree_list","parameters":[{"description":"The handle of the org to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace for which we want to retrieve the connection tree.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The prefix to be used when listing items in a connection tree","in":"query","name":"prefix","schema":{"type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace connection tree","tags":["OrgWorkspaceConnectionTree"]}},"/org/{org_handle}/workspace/{workspace_handle}/datatank":{"get":{"description":"List the org workspace Datatank.","operationId":"orgWorkspaceDatatank_list","parameters":[{"description":"The handle of the org for which we want to list the workspace Datatank.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDatatankResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace Datatank","tags":["OrgWorkspaceDatatanks"]},"post":{"description":"Creates a new org workspace tank.","operationId":"orgWorkspaceDatatank_create","parameters":[{"description":"The handle of the org where we want to create the workspace Datatank.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDatatankRequest"}}},"description":"The request body for the workspace Datatank to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Datatank"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org workspace Datatank","tags":["OrgWorkspaceDatatanks"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}":{"delete":{"description":"Deletes the org workspace Datatank.","operationId":"orgWorkspaceDatatank_delete","parameters":[{"description":"The handle of the org.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank to be deleted.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Datatank"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org workspace Datatank","tags":["OrgWorkspaceDatatanks"]},"get":{"description":"Get the details for the workspace Datatank.","operationId":"orgWorkspaceDatatank_get","parameters":[{"description":"The handle of the org.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Datatank"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace Datatank","tags":["OrgWorkspaceDatatanks"]},"patch":{"description":"Update the org workspace Datatank.","operationId":"orgWorkspaceDatatank_update","parameters":[{"description":"The handle of the org.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDatatankRequest"}}},"description":"The request body to update workspace Datatank.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Datatank"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org workspace Datatank","tags":["OrgWorkspaceDatatanks"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table":{"get":{"description":"List the org workspace Datatank tables.","operationId":"orgWorkspaceDatatankTable_list","parameters":[{"description":"The handle of the user for which we want to list the workspace Datatank tables.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDatatankTableResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace Datatank tables","tags":["OrgWorkspaceDatatankTables"]},"post":{"description":"Creates a new org workspace tank table.","operationId":"orgWorkspaceDatatankTable_create","parameters":[{"description":"The handle of the org where we want to create the workspace Datatank table.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDatatankTableRequest"}}},"description":"The request body for the workspace Datatank table to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatatankTable"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org workspace Datatank table","tags":["OrgWorkspaceDatatankTables"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}":{"delete":{"description":"Deletes the org workspace Datatank table.","operationId":"orgWorkspaceDatatankTable_delete","parameters":[{"description":"The handle of the org.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank to be deleted.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The name of the workspace Datatank table.","in":"path","name":"datatank_table_name","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatatankTable"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org workspace Datatank table","tags":["OrgWorkspaceDatatankTables"]},"get":{"description":"Get the details for the workspace Datatank table","operationId":"orgWorkspaceDatatankTable_get","parameters":[{"description":"The handle of the org where we want to create the workspace Datatank table.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The name of the workspace Datatank table.","in":"path","name":"datatank_table_name","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatatankTable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace Datatank table","tags":["OrgWorkspaceDatatankTables"]},"patch":{"description":"Update the org workspace Datatank table.","operationId":"orgWorkspaceDatatankTable_update","parameters":[{"description":"The handle of the org for which we want to list the workspace Datatank.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The name of the workspace Datatank table to be updated.","in":"path","name":"datatank_table_name","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDatatankTableRequest"}}},"description":"The request body to update workspace Datatank table.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatatankTable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org workspace Datatank table","tags":["OrgWorkspaceDatatankTables"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/part":{"get":{"description":"List the org workspace Datatank partitions","operationId":"orgWorkspaceDatatankPart_list","parameters":[{"description":"The handle of the org.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The name of the workspace Datatank table.","in":"path","name":"datatank_table_name","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDatatankPartResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace Datatank partitions","tags":["OrgWorkspaceDatatankParts"]}},"/org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/part/{datatank_part_id}":{"patch":{"description":"Update the org workspace Datatank table partition.","operationId":"orgWorkspaceDatatankPart_update","parameters":[{"description":"The handle of the org for which we want to list the workspace Datatank.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The name of the workspace Datatank table.","in":"path","name":"datatank_table_name","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The id of the workspace Datatank table partition to be updated.","in":"path","name":"datatank_part_id","required":true,"schema":{"format":"^dtc_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDatatankPartRequest"}}},"description":"The request body to update workspace Datatank table partition.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatatankPart"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org workspace Datatank table partition","tags":["OrgWorkspaceDatatankParts"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/part/{datatank_part_id}/command":{"post":{"description":"Run org workspace Datatank table partition command. Valid commands are: refresh.","operationId":"orgWorkspaceDatatankPart_command","parameters":[{"description":"The handle of the org for which we want to list the workspace Datatank.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The name of the workspace Datatank table.","in":"path","name":"datatank_table_name","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The id of the workspace Datatank table partition.","in":"path","name":"datatank_part_id","required":true,"schema":{"format":"^dtc_[0-9a-v]{20}$","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatatankPart"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Run org workspace Datatank table partition command","tags":["OrgWorkspaceDatatankParts"]}},"/org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/table/{datatank_part_id}":{"get":{"description":"Get the details for the workspace Datatank table partition","operationId":"orgWorkspaceDatatankPart_get","parameters":[{"description":"The handle of the org.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The name of the workspace Datatank table.","in":"path","name":"datatank_table_name","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The id of the workspace Datatank table partition.","in":"path","name":"datatank_part_id","required":true,"schema":{"format":"^dtc_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatatankPart"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace Datatank table partition","tags":["OrgWorkspaceDatatankParts"]}},"/org/{org_handle}/workspace/{workspace_handle}/db_log":{"get":{"description":"Returns the workspace logs for an org.","operationId":"orgWorkspace_listDBLogs","parameters":[{"description":"Specify the org handle to get the workspace logs.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace whose logs needs to be fetched.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLogsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Org workspace logs","tags":["OrgWorkspaces"]}},"/org/{org_handle}/workspace/{workspace_handle}/flowpipe/form/{step_execution_id}/{random_id}":{"get":{"description":"Get details of a Flowpipe input step form for an org workspace","operationId":"orgWorkspaceFlowpipeForm_get","parameters":[{"description":"The handle of the org to which the workspace belongs.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to which the Flowpipe input belongs.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The execution ID of the step to which the Flowpipe input belongs.","in":"path","name":"step_execution_id","required":true,"schema":{"format":"^sexec_[0-9a-v]{20}$","type":"string"}},{"description":"The random ID used to verify the input response.","in":"path","name":"random_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowpipeInput"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace flowpipe form","tags":["OrgWorkspaceFlowpipeInputs"]}},"/org/{org_handle}/workspace/{workspace_handle}/flowpipe/form/{step_execution_id}/{random_id}/submit":{"post":{"description":"Submit response to a Flowpipe input step form for an org workspace","operationId":"orgWorkspaceFlowpipeFormResponse_post","parameters":[{"description":"The handle of the org to which the workspace belongs.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to which the Flowpipe input belongs.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The execution ID of the step to which the Flowpipe input belongs.","in":"path","name":"step_execution_id","required":true,"schema":{"format":"^sexec_[0-9a-v]{20}$","type":"string"}},{"description":"The random ID used to verify the input response.","in":"path","name":"random_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowpipeFormResponse"}}},"description":"The request body for the response to the Flowpipe input form.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowpipeInput"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Post org workspace flowpipe form response","tags":["OrgWorkspaceFlowpipeInputs"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/flowpipe/input":{"get":{"description":"List Flowpipe inputs for an org workspace","operationId":"orgWorkspaceFlowpipeInputs_list","parameters":[{"description":"The handle of the org to which the workspace belongs.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to which the Flowpipe inputs belong.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFlowpipeInputsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace flowpipe inputs","tags":["OrgWorkspaceFlowpipeInputs"]},"post":{"description":"Create a Flowpipe input for an org workspace","operationId":"orgWorkspaceFlowpipeInput_create","parameters":[{"description":"The handle of the org to which the workspace belongs.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to create the Flowpipe input against.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFlowpipeInputRequest"}}},"description":"The request body for the Flowpipe input.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowpipeInput"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org workspace flowpipe input","tags":["OrgWorkspaceFlowpipeInputs"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/flowpipe/input/{input_id}":{"get":{"description":"Get details of a Flowpipe input for an org workspace","operationId":"orgWorkspaceFlowpipeInput_get","parameters":[{"description":"The handle of the org to which the workspace belongs.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to which the Flowpipe input belongs.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The ID of the Flowpipe input. Optionally can pass the step execution ID in lieu of the input ID.","in":"path","name":"input_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowpipeInput"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace flowpipe input","tags":["OrgWorkspaceFlowpipeInputs"]}},"/org/{org_handle}/workspace/{workspace_handle}/flowpipe/mod":{"post":{"description":"Install flowpipe mod to a organization workspace.","operationId":"orgWorkspaceFlowpipeMod_install","parameters":[{"description":"The handle of an organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod will be installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceModRequest"}},"multipart/form-data":{"schema":{"properties":{"file":{"description":"The mod file to be uploaded.","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"description":"The request body to install a mod in the mentioned workspace for this organization.","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Install flowpipe mod to organization workspace.","tags":["OrgWorkspaceFlowpipeMods"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/flowpipe/mod/{mod_alias}":{"delete":{"description":"Uninstall flowpipe mod from organization workspace.","operationId":"orgWorkspaceFlowpipeMod_uninstall","parameters":[{"description":"The handle of an organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID to delete.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Uninstall flowpipe mod from organization workspace.","tags":["OrgWorkspaceFlowpipeMods"]},"get":{"description":"Get organization workspace installed flowpipe mod by mod alias","operationId":"orgWorkspaceFlowpipeMod_get","parameters":[{"description":"The handle of an organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get organization workspace installed flowpipe mod","tags":["OrgWorkspaceFlowpipeMods"]},"patch":{"description":"Update a flowpipe mod in an organization workspace","operationId":"orgWorkspaceFlowpipeMod_update","parameters":[{"description":"The handle of an organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod will be updated.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID to update.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceModRequest"}},"multipart/form-data":{"schema":{"properties":{"file":{"description":"The mod file to be uploaded.","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"description":"The request body to update a mod for this workspace.","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update a flowpipe mod in an organization workspace","tags":["OrgWorkspaceFlowpipeMods"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/flowpipe/mod/{mod_alias}/variable":{"get":{"description":"List all variables applicable for a flowpipe mod in a workspace specific to an organization","operationId":"orgWorkspaceFlowpipeModVariable_list","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID for which we want the variables to be listed.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceModVariablesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List variables in an organization flowpipe workspace mod","tags":["OrgWorkspaceFlowpipeModVariables"]},"post":{"description":"Create a setting for a flowpipe mod variable in an organization workspace","operationId":"orgWorkspaceFlowpipeModVariable_createSetting","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID for which the variable setting is to be created.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceModVariableSettingRequest"}}},"description":"The request body to create setting for mod variable in the organization workspace.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create a setting for a flowpipe mod variable in an organization workspace","tags":["OrgWorkspaceFlowpipeModVariables"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/flowpipe/mod/{mod_alias}/variable/{variable_name}":{"delete":{"description":"Delete setting for a flowpipe mod variable in an organization workspace","operationId":"orgWorkspaceFlowpipeModVariable_deleteSetting","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID which contains the variable.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The name of the variable to delete the setting for.","in":"path","name":"variable_name","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete setting for a flowpipe mod variable in an organization workspace","tags":["OrgWorkspaceFlowpipeModVariables"]},"get":{"description":"Get setting for a flowpipe mod variable in an organization workspace","operationId":"orgWorkspaceFlowpipeModVariable_getSetting","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID for which the variable setting belongs to.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The name of the variable to get the setting for.","in":"path","name":"variable_name","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get setting for a flowpipe mod variable in an organization workspace","tags":["OrgWorkspaceFlowpipeModVariables"]},"patch":{"description":"Update setting for a flowpipe mod variable in an organization workspace","operationId":"orgWorkspaceFlowpipeModVariable_updateSetting","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID which contains the variable.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The name of the variable for which setting is to be updated.","in":"path","name":"variable_name","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceModVariableSettingRequest"}}},"description":"The request body to update setting for mod variable in the organization workspace.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update setting for a flowpipe mod variable in an organization workspace","tags":["OrgWorkspaceFlowpipeModVariables"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/flowpipe/pipeline":{"get":{"description":"Lists the pipelines for an organization workspace.","operationId":"orgWorkspaceFlowpipePipeline_list","parameters":[{"description":"The handle of the organization which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace for which we want to list the pipelines.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFlowpipePipelinesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List organization workspace pipelines","tags":["OrgWorkspaceFlowpipePipelines"]}},"/org/{org_handle}/workspace/{workspace_handle}/flowpipe/pipeline/{pipeline_id}":{"get":{"description":"Get the details of a pipeline for a workspace of an organization.","operationId":"orgWorkspaceFlowpipePipeline_get","parameters":[{"description":"The handle of the organization which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The id of the pipeline whose detail needs to be fetched.","in":"path","name":"pipeline_id","required":true,"schema":{"format":"^pipe_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModPipeline"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace pipeline","tags":["OrgWorkspaceFlowpipePipelines"]}},"/org/{org_handle}/workspace/{workspace_handle}/flowpipe/pipeline/{pipeline_id}/trigger":{"get":{"description":"Get the list of triggers that a pipeline is associated with.","operationId":"orgWorkspaceFlowpipePipeline_listTriggers","parameters":[{"description":"The handle of the org which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The id of the pipeline whose triggers need to be fetched.","in":"path","name":"pipeline_id","required":true,"schema":{"format":"^pipe_[0-9a-v]{20}$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFlowpipeTriggersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace pipeline triggers","tags":["OrgWorkspaceFlowpipePipelines"]}},"/org/{org_handle}/workspace/{workspace_handle}/flowpipe/pipeline/{pipeline_name}/command":{"post":{"description":"Run a command on a pipeline in a workspace belonging to an organization.","operationId":"orgWorkspaceFlowpipePipeline_command","parameters":[{"description":"The handle of the organization which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the Flowpipe pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"Identifier of the Flowpipe pipeline on which the command will be run.","in":"path","name":"pipeline_name","required":true,"schema":{"format":"^modp_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineCommandRequest"}}},"description":"The request body of the pipeline command to run.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineCommandResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Run organization workspace Flowpipe pipeline command","tags":["OrgWorkspaceFlowpipePipelines"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/flowpipe/trigger/{trigger_name}":{"delete":{"description":"Deletes the pipeline specified in the request for a workspace of an organization.","operationId":"orgWorkspaceFlowpipeTrigger_delete","parameters":[{"description":"The handle of the organization which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The name of the trigger which needs to be deleted.","in":"path","name":"trigger_name","required":true,"schema":{"format":"^modt[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org workspace pipeline","tags":["OrgWorkspaceFlowpipeTriggers"]},"get":{"description":"Get the details of a trigger for a workspace of an org.","operationId":"orgWorkspaceFlowpipeTrigger_get","parameters":[{"description":"The handle of the org which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the trigger exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The name of the flowpipe trigger whose details needs to be fetched.","in":"path","name":"trigger_name","required":true,"schema":{"format":"^pipe_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModTrigger"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace flowpipe trigger","tags":["OrgWorkspaceFlowpipeTriggers"]},"patch":{"description":"Updates a trigger for a workspace of an org.","operationId":"orgWorkspaceFlowpipeTrigger_update","parameters":[{"description":"The handle of the org which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the trigger exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The name of the trigger which needs to be updated.","in":"path","name":"trigger_name","required":true,"schema":{"format":"^modt_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTriggerRequest"}}},"description":"The request body for the trigger which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModTrigger"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org workspace trigger","tags":["OrgWorkspaceFlowpipeTriggers"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/flowpipe/trigger/{trigger_name}/command":{"post":{"description":"Run a command on a trigger in a workspace belonging to an organization.","operationId":"orgWorkspaceFlowpipeTrigger_command","parameters":[{"description":"The handle of the organization which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the Flowpipe trigger exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"Identifier of the Flowpipe trigger on which the command will be run.","in":"path","name":"trigger_name","required":true,"schema":{"format":"^modp_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCommandRequest"}}},"description":"The request body of the trigger command to run.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCommandResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Run organization workspace Flowpipe trigger command","tags":["OrgWorkspaceFlowpipeTriggers"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/integration":{"get":{"description":"List integrations available for an organization workspace. If run on a custom tenant this will return integrations configured both on tenant and org level.","operationId":"orgWorkspaceIntegration_list","parameters":[{"description":"The handle of the organization to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace for whom you want to list available integrations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListIntegrationsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace integrations","tags":["OrgWorkspaceIntegrations"]}},"/org/{org_handle}/workspace/{workspace_handle}/integration/{integration_handle}":{"get":{"description":"Get details of an integration available for a workspace belonging to an organization.","operationId":"orgWorkspaceIntegration_get","parameters":[{"description":"The handle of the org to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace for which we want to get the integration details.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration whose details need to be retrieved.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace integration","tags":["OrgWorkspaceIntegrations"]}},"/org/{org_handle}/workspace/{workspace_handle}/integration/{integration_handle}/github/repository":{"get":{"description":"List respositories that are given access to the integration available for an organization workspace.","operationId":"orgWorkspaceIntegration_listGithubRepositories","parameters":[{"description":"The handle of the organization to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace for whom you want to list available integrations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration for which permitted repositories will be listed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGithubRepositoriesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace integration github respositories","tags":["OrgWorkspaceIntegrations"]}},"/org/{org_handle}/workspace/{workspace_handle}/integration/{integration_handle}/github/repository/{repository_owner}/{repository_name}/head":{"get":{"description":"List heads for a respository of an integration available for an organization workspace.","operationId":"orgWorkspaceIntegration_listGithubRepositoryHeads","parameters":[{"description":"The handle of the organization to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace for whom you want to list available integrations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration for which heads will be listed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The owner of the repository.","in":"path","name":"repository_owner","required":true,"schema":{"type":"string"}},{"description":"The name of the repository for which heads will be listed.","in":"path","name":"repository_name","required":true,"schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGithubRepositoryBranchesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace integration github respository heads","tags":["OrgWorkspaceIntegrations"]}},"/org/{org_handle}/workspace/{workspace_handle}/integration/{integration_handle}/gitlab/project":{"get":{"description":"List projects that are given access to the integration available for an organization workspace.","operationId":"orgWorkspaceIntegration_listGitlabProjects","parameters":[{"description":"The handle of the organization to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace for whom you want to list available integrations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration for which permitted repositories will be listed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGitlabProjectsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace integration gitlab projects","tags":["OrgWorkspaceIntegrations"]}},"/org/{org_handle}/workspace/{workspace_handle}/integration/{integration_handle}/gitlab/project/{project_id}/branch":{"get":{"description":"List branches for a gitlab project of an integration available for an organization workspace.","operationId":"orgWorkspaceIntegration_listGitlabProjectBranches","parameters":[{"description":"The handle of the organization to which the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace for whom you want to list available integrations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration for which heads will be listed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The id of the project including the namespace and the name.","in":"path","name":"project_id","required":true,"schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGitlabProjectBranchesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace integration gitlab project branches","tags":["OrgWorkspaceIntegrations"]}},"/org/{org_handle}/workspace/{workspace_handle}/member":{"get":{"description":"List all members of a workspace in an organization who has accepted / invited.","operationId":"orgWorkspaceMember_list","parameters":[{"description":"Specify the handle of the organization where the member need to be invited.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the handle of the workspace where the member need to be invited.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Optional free-text search to filter the org workspace members.","in":"query","name":"q","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrgWorkspaceUsersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List Organization Workspace Members","tags":["OrgWorkspaceMembers"]},"post":{"description":"Add an individual as a member of a workspace in an organization.","operationId":"orgWorkspaceMember_create","parameters":[{"description":"Specify the handle of the organization where the member need to be invited.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the handle of the workspace where the member need to be invited.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrgWorkspaceUserRequest"}}},"description":"The request body to invite a member to an organization.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgWorkspaceUser"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create Org Workspace Member","tags":["OrgWorkspaceMembers"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/member/{user_handle}":{"delete":{"description":"Remove a member from a workspace of an organization.","operationId":"orgWorkspaceMember_delete","parameters":[{"description":"Specify the handle of the organization where the member need to be invited.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the handle of the workspace where the member need to be invited.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the handle of the user whose information you want to retrive.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgWorkspaceUser"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete Org Workspace Member","tags":["OrgWorkspaceMembers"]},"get":{"description":"Get details of a member belonging to a workspace of an organization.","operationId":"orgWorkspaceMember_get","parameters":[{"description":"Specify the handle of the organization where the member need to be invited.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the handle of the workspace where the member need to be invited.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the handle of the user whose information you want to retrive.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgWorkspaceUser"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get Org Workspace Member","tags":["OrgWorkspaceMembers"]},"patch":{"description":"Update the role of a member belonging to a workspace of an organization.","operationId":"orgWorkspaceMember_update","parameters":[{"description":"Specify the handle of the organization where the member need to be invited.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the handle of the workspace where the member need to be invited.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the handle of the user whose information you want to retrive.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrgWorkspaceUserRequest"}}},"description":"The request body for the member.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgWorkspaceUser"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update Org Workspace Member","tags":["OrgWorkspaceMembers"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/mod":{"get":{"description":"List organization workspace installed mods","operationId":"orgWorkspaceMod_list","parameters":[{"description":"The handle of an organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where mods were installed","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceModsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List organization workspace installed mods","tags":["OrgWorkspaceMods"]},"post":{"description":"Install a mod to an organization workspace","operationId":"orgWorkspaceMod_install","parameters":[{"description":"The handle of an organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod will be installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceModRequest"}},"multipart/form-data":{"schema":{"properties":{"file":{"description":"The mod file to be uploaded.","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"description":"The request body to install a mod in the mentioned workspace for this organization.","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Install a mod to an organization workspace","tags":["OrgWorkspaceMods"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias}":{"delete":{"description":"Uninstall mod from organization workspace.","operationId":"orgWorkspaceMod_uninstall","parameters":[{"description":"The handle of an organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID to delete.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Uninstall mod from organization workspace.","tags":["OrgWorkspaceMods"]},"get":{"description":"Get organization workspace installed mod by mod alias","operationId":"orgWorkspaceMod_get","parameters":[{"description":"The handle of an organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get organization workspace installed mod","tags":["OrgWorkspaceMods"]},"patch":{"description":"Update a mod in an organization workspace","operationId":"orgWorkspaceMod_update","parameters":[{"description":"The handle of an organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod will be updated.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID to update.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceModRequest"}},"multipart/form-data":{"schema":{"properties":{"file":{"description":"The mod file to be uploaded.","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"description":"The request body to update a mod for this workspace.","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update a mod in an organization workspace","tags":["OrgWorkspaceMods"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable":{"get":{"description":"List all variables applicable for a mod in a workspace specific to an organization","operationId":"orgWorkspaceModVariable_list","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID for which we want the variables to be listed.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceModVariablesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List variables in an organization workspace mod","tags":["OrgWorkspaceModVariables"]},"post":{"description":"Create a setting for a mod variable in an organization workspace","operationId":"orgWorkspaceModVariable_createSetting","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID for which the variable setting is to be created.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceModVariableSettingRequest"}}},"description":"The request body to create setting for mod variable in the organization workspace.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create a setting for a mod variable in an organization workspace","tags":["OrgWorkspaceModVariables"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable/{variable_name}":{"delete":{"description":"Delete setting for a mod variable in an organization workspace","operationId":"orgWorkspaceModVariable_deleteSetting","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID which contains the variable.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The name of the variable to delete the setting for.","in":"path","name":"variable_name","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete setting for a mod variable in an organization workspace","tags":["OrgWorkspaceModVariables"]},"get":{"description":"Get setting for a mod variable in an organization workspace","operationId":"orgWorkspaceModVariable_getSetting","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID for which the variable setting belongs to.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The name of the variable to get the setting for.","in":"path","name":"variable_name","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get setting for a mod variable in an organization workspace","tags":["OrgWorkspaceModVariables"]},"patch":{"description":"Update setting for a mod variable in an organization workspace","operationId":"orgWorkspaceModVariable_updateSetting","parameters":[{"description":"The handle of the organization that owns the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID which contains the variable.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The name of the variable for which setting is to be updated.","in":"path","name":"variable_name","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceModVariableSettingRequest"}}},"description":"The request body to update setting for mod variable in the organization workspace.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update setting for a mod variable in an organization workspace","tags":["OrgWorkspaceModVariables"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/notifier":{"get":{"description":"List all notifiers for an org workspace","operationId":"orgWorkspaceNotifier_list","parameters":[{"description":"The handle of the org for which the notifiers are to be listed.","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The handle of the workspace for which the notifiers are to be listed.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The maximum number of items to return.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"The token to retrieve the next page.","in":"query","name":"next_token","schema":{"type":"string"}},{"description":"The filter to apply to the list.","in":"query","name":"where","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNotifiersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace notifiers","tags":["OrgWorkspaceNotifiers"]},"post":{"description":"Create a new notifier for an org workspace","operationId":"orgWorkspaceNotifier_create","parameters":[{"description":"The handle of the org for which the notifier is to be created.","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The handle of the workspace for which the notifier is to be created.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNotifierRequest"}}},"description":"The request body for the notifier to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org workspace notifier","tags":["OrgWorkspaceNotifiers"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/notifier/{notifier_name}":{"delete":{"description":"Delete a notifier for an org workspace","operationId":"orgWorkspaceNotifier_delete","parameters":[{"description":"The handle of the org for which the notifier is to be deleted.","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The handle of the workspace for which the notifier is to be deleted.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The name of the notifier to be deleted.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org workspace notifier","tags":["OrgWorkspaceNotifiers"]},"get":{"description":"Get a notifier for an org workspace","operationId":"orgWorkspaceNotifier_get","parameters":[{"description":"The handle of the org for which the notifier is to be retrieved.","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The handle of the workspace for which the notifier is to be retrieved.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The name of the notifier to be retrieved.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace notifier","tags":["OrgWorkspaceNotifiers"]},"patch":{"description":"Update a notifier for an org workspace","operationId":"orgWorkspaceNotifier_update","parameters":[{"description":"The handle of the org for which the notifier is to be updated.","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The handle of the workspace for which the notifier is to be updated.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The name of the notifier to be updated.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNotifierRequest"}}},"description":"The request body for the notifier to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org workspace notifier","tags":["OrgWorkspaceNotifiers"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/notifier/{notifier_name}/command":{"post":{"description":"Post a command for a notifier for an orgs workspace","operationId":"orgWorkspaceNotifierCommand_post","parameters":[{"description":"The handle of the org for which the notifier is to be updated.","in":"path","name":"org_handle","required":true,"schema":{"type":"string"}},{"description":"The handle of the workspace for which the notifier is to be updated.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The name of the notifier for which the command is to be posted.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceNotifierCommandRequest"}}},"description":"The request body for the notifier command to be posted.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceNotifierCommandResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Implemented"}},"summary":"Post org workspace notifier commands","tags":["OrgWorkspaceNotifiers"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/pipeline":{"get":{"description":"Lists the pipelines for a workspace of an organization.","operationId":"orgWorkspacePipeline_list","parameters":[{"description":"The handle of the organization which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace for which we want to list the pipelines.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPipelinesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace pipelines","tags":["OrgWorkspacePipelines"]},"post":{"description":"Creates a new pipeline for a workspace of an organization.","operationId":"orgWorkspacePipeline_create","parameters":[{"description":"The handle of the organization which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where we want to create the pipeline.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePipelineRequest"}}},"description":"The request body for the pipeline to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org workspace pipeline","tags":["OrgWorkspacePipelines"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/pipeline/{pipeline_id}":{"delete":{"description":"Deletes the pipeline specified in the request for a workspace of an organization.","operationId":"orgWorkspacePipeline_delete","parameters":[{"description":"The handle of the organization which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"Provide the id of the pipeline which needs to be deleted.","in":"path","name":"pipeline_id","required":true,"schema":{"format":"^pipe_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org workspace pipeline","tags":["OrgWorkspacePipelines"]},"get":{"description":"Get the details of a pipeline for a workspace of an organization.","operationId":"orgWorkspacePipeline_get","parameters":[{"description":"The handle of the organization which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The id of the pipeline whose detail needs to be fetched.","in":"path","name":"pipeline_id","required":true,"schema":{"format":"^pipe_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace pipeline","tags":["OrgWorkspacePipelines"]},"patch":{"description":"Updates a pipeline for a workspace of an organization.","operationId":"orgWorkspacePipeline_update","parameters":[{"description":"The handle of the organization which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The id of the pipeline which needs to be updated.","in":"path","name":"pipeline_id","required":true,"schema":{"format":"^pipe_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePipelineRequest"}}},"description":"The request body for the pipeline which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org workspace pipeline","tags":["OrgWorkspacePipelines"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/pipeline/{pipeline_id}/command":{"post":{"description":"Run a command on a pipeline in a workspace belonging to an organization.","operationId":"orgWorkspacePipeline_command","parameters":[{"description":"The handle of the organization which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"Id of the pipeline on which the command will be run.","in":"path","name":"pipeline_id","required":true,"schema":{"format":"^pipe_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineCommandRequest"}}},"description":"The request body of the pipeline command to run.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineCommandResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Run org workspace pipeline command","tags":["OrgWorkspacePipelines"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/process":{"get":{"description":"List the processes associated with an org workspace.","operationId":"orgWorkspaceProcess_list","parameters":[{"description":"The handle of an organization for which you want to list the processes.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where you want to list the processes.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProcessesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace processes","tags":["OrgWorkspaceProcesses"]}},"/org/{org_handle}/workspace/{workspace_handle}/process/{process_id}":{"get":{"description":"Get the details for the process.","operationId":"orgWorkspaceProcess_get","parameters":[{"description":"The handle of the org where the workspace exist.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace whose process needs to be fetched.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The id of the process to be fetched.","in":"path","name":"process_id","required":true,"schema":{"format":"^[a-z]{1,3}_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpProcess"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace process","tags":["OrgWorkspaceProcesses"]}},"/org/{org_handle}/workspace/{workspace_handle}/process/{process_id}/command":{"post":{"description":"Run a command against an org workspace process.","operationId":"orgWorkspaceProcess_command","parameters":[{"description":"The handle of the org where we want to run the workspace process command.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the process command will be executed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The id of the process where the command will be executed against.","in":"path","name":"process_id","required":true,"schema":{"format":"^[a-z]{1,3}_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceProcessCommandRequest"}}},"description":"The request body for the workspace process command.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceProcessCommandResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Implemented"}},"summary":"Run org workspace process command","tags":["OrgWorkspaceProcesses"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/process/{process_id}/log/{log_file}.{content_type}":{"get":{"description":"List the process logs associated with a workspace process.","operationId":"orgWorkspaceProcess_log","parameters":[{"description":"The handle of the org for which you want to list process logs.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where you want to list the process logs.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The id of the process where you want to list the process logs.","in":"path","name":"process_id","required":true,"schema":{"format":"^[a-z]{1,3}_[0-9a-v]{20}$","type":"string"}},{"description":"The process logs file to be fetched.","in":"path","name":"log_file","required":true,"schema":{"enum":["process"],"type":"string"}},{"description":"The required content type of the process logs.","in":"path","name":"content_type","required":true,"schema":{"enum":["jsonl"],"type":"string"}}],"responses":{"200":{"content":{"application/jsonlines+json":{"schema":{"type":"string"}}},"description":"OK"},"204":{"content":{"application/jsonlines+json":{"schema":{"type":"string"}}},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace process logs","tags":["OrgWorkspaceProcesses"]}},"/org/{org_handle}/workspace/{workspace_handle}/query":{"get":{"description":"Performs a query in an org workspace. Results are limited to 5000 rows or 30 seconds of query execution.","operationId":"orgWorkspace_getQuery","parameters":[{"description":"The handle of the org that the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to query.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The sql query to perform against the org workspace.","in":"query","name":"sql","required":true,"schema":{"type":"string"}},{"description":"The required content type for the response. Defaults to application/json. Supported values are json, application/json, csv, text/csv, md and text/markdown.","in":"query","name":"content_type","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"OK"},"206":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"Partial Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Query org workspace","tags":["OrgWorkspaces"]},"post":{"description":"Performs a query in an org workspace. Results are limited to 5000 rows or 30 seconds of query execution.","operationId":"orgWorkspace_postQuery","parameters":[{"description":"The handle of the org that the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to query.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The required content type for the response. Defaults to application/json. Supported values are json, application/json, csv, text/csv, md and text/markdown.","in":"query","name":"content_type","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/csv":{"schema":{"type":"string"}},"text/markdown":{"schema":{"type":"string"}}},"description":"The sql query to perform against the org workspace.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"OK"},"206":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"Partial Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Query org workspace","tags":["OrgWorkspaces"],"x-codegen-request-body-name":"sql"}},"/org/{org_handle}/workspace/{workspace_handle}/query/data.{extensions}":{"get":{"description":"Performs a query in an org workspace, with content type and content encoding forming part of the API path. Results are limited to 5000 rows or 30 seconds of query execution.","operationId":"orgWorkspace_getQueryWithExtensions","parameters":[{"description":"The handle of the org that the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to query.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The content type for the request. E.g. ","in":"path","name":"extensions","required":true,"schema":{"type":"string"}},{"description":"The sql query to perform against the org workspace.","in":"query","name":"sql","required":true,"schema":{"type":"string"}},{"description":"The required content type for the response. Defaults to application/json. Supported values are json, application/json, csv, text/csv, md and text/markdown.","in":"query","name":"content_type","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"OK"},"206":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"Partial Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Query org workspace with extensions","tags":["OrgWorkspaces"]},"post":{"description":"Performs a query in an org workspace, with content type and content encoding forming part of the API path. Results are limited to 5000 rows or 30 seconds of query execution.","operationId":"orgWorkspace_postQueryWithExtensions","parameters":[{"description":"The handle of the org that the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to query.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The content type for the request. E.g. ","in":"path","name":"extensions","required":true,"schema":{"type":"string"}},{"description":"The sql query to perform against the org workspace.","in":"query","name":"sql","required":true,"schema":{"type":"string"}},{"description":"The required content type for the response. Defaults to application/json. Supported values are json, application/json, csv, text/csv, md and text/markdown.","in":"query","name":"content_type","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"OK"},"206":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"Partial Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Query org workspace with extensions","tags":["OrgWorkspaces"]}},"/org/{org_handle}/workspace/{workspace_handle}/schema":{"get":{"description":"List the schemas for the org workspace. This will consist of the aggregators, datatanks and identity-level connections associated with the workspace.","operationId":"orgWorkspaceSchema_list","parameters":[{"description":"The handle of the org that the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace to get the schemas for.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceSchemaResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace schemas","tags":["OrgWorkspaceSchemas"]},"post":{"description":"Attach an identity-level connection schema to an org workspace.","operationId":"orgWorkspaceSchema_attach","parameters":[{"description":"The handle of the org that the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the schema will be attached.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachWorkspaceSchemaRequest"}}},"description":"The request body for the schema to be attached.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSchema"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Attach a schema to an org workspace","tags":["OrgWorkspaceSchemas"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/schema/{schema_name}":{"delete":{"description":"Detach an identity-level connection schema from an org workspace.","operationId":"orgWorkspaceSchema_detach","parameters":[{"description":"The handle of the org that the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace from which the schema will be detached.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the schema that will be detached.","in":"path","name":"schema_name","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSchema"}}},"description":"Created"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Detach a schema from an org workspace","tags":["OrgWorkspaceSchemas"]},"get":{"description":"Get the details for an org workspace schema.","operationId":"orgWorkspaceSchema_get","parameters":[{"description":"The handle of the org that the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the schema exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the schema whose detail needs to be fetched.","in":"path","name":"schema_name","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSchema"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace schema","tags":["OrgWorkspaceSchemas"]}},"/org/{org_handle}/workspace/{workspace_handle}/schema/{schema_name}/table":{"get":{"description":"List the tables for an org workspace schema.","operationId":"orgWorkspaceSchema_listTables","parameters":[{"description":"The handle of the org that the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the schema exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the schema whose detail needs to be fetched.","in":"path","name":"schema_name","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceSchemaTableResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace schema tables","tags":["OrgWorkspaceSchemas"]}},"/org/{org_handle}/workspace/{workspace_handle}/schema/{schema_name}/table/{table_name}":{"get":{"description":"Get details about a specific table in a org workspace schema.","operationId":"orgWorkspaceSchema_getTable","parameters":[{"description":"The handle of the org where the workspace belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the schema exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the schema to which the table belongs.","in":"path","name":"schema_name","required":true,"schema":{"type":"string"}},{"description":"The name of the table whose detail needs to be fetched.","in":"path","name":"table_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSchemaTable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace schema table","tags":["OrgWorkspaceSchemas"]}},"/org/{org_handle}/workspace/{workspace_handle}/snapshot":{"get":{"description":"List the workspace snapshots for an org.","operationId":"orgWorkspaceSnapshot_list","parameters":[{"description":"The handle of the org to list the workspace snapshots for.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace to list snapshots for.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceSnapshotsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace snapshots","tags":["OrgWorkspaceSnapshots"]},"post":{"description":"Creates a new workspace snapshot for an org.","operationId":"orgWorkspaceSnapshot_create","parameters":[{"description":"The handle of the org to create the workspace snapshot for.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace to create the snapshot for.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceSnapshotRequest"}}},"description":"The request body for the org workspace snapshot to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSnapshot"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org workspace snapshot","tags":["OrgWorkspaceSnapshots"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/snapshot/{snapshot_id}":{"delete":{"description":"Deletes an org workspace snapshot.","operationId":"orgWorkspaceSnapshot_delete","parameters":[{"description":"The handle of the org that the workspace snapshot belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace that the snapshot belongs to.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the snapshot which needs to be deleted.","in":"path","name":"snapshot_id","required":true,"schema":{"format":"^snap_[0-9a-v]{20}_[0-9a-z]{19,26}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSnapshot"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete org workspace snapshot","tags":["OrgWorkspaceSnapshots"]},"get":{"description":"Get the details for an org workspace snapshot.","operationId":"orgWorkspaceSnapshot_get","parameters":[{"description":"The handle of the org that the workspace snapshot belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace that the snapshot belongs to.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the snapshot whose detail needs to be fetched.","in":"path","name":"snapshot_id","required":true,"schema":{"format":"^snap_[0-9a-v]{20}_[0-9a-z]{19,26}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSnapshot"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get org workspace snapshot","tags":["OrgWorkspaceSnapshots"]},"patch":{"description":"Updates an org workspace snapshot.","operationId":"orgWorkspaceSnapshot_update","parameters":[{"description":"The handle of the org that the workspace snapshot belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace that the snapshot belongs to.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the snapshot to update.","in":"path","name":"snapshot_id","required":true,"schema":{"format":"^snap_[0-9a-v]{20}_[0-9a-z]{19,26}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceSnapshotRequest"}}},"description":"The request body for the org workspace snapshot to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSnapshot"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update org workspace snapshot","tags":["OrgWorkspaceSnapshots"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/snapshot/{snapshot_id}.{content_type}":{"get":{"description":"Downloads the full data for an org workspace snapshot.","operationId":"orgWorkspaceSnapshot_download","parameters":[{"description":"The handle of the org that the workspace snapshot belongs to.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the org workspace that the snapshot belongs to.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The Id of the snapshot to be downloaded.","in":"path","name":"snapshot_id","required":true,"schema":{"type":"string"}},{"description":"The type of content to the downloaded.","in":"path","name":"content_type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSnapshotData"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Download org workspace snapshot","tags":["OrgWorkspaceSnapshots"]},"servers":[{"description":"Pipes organization workspace snapshot download API","url":"https://pipes.turbot.com/download"}]},"/org/{org_handle}/workspace/{workspace_handle}/trigger":{"get":{"description":"Lists the pipelines for an organization workspace.","operationId":"orgWorkspaceFlowpipeTrigger_list","parameters":[{"description":"The handle of the organization which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace for which we want to list the triggers.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTriggersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List organization workspace triggers","tags":["OrgWorkspaceFlowpipeTriggers"]},"post":{"description":"Creates a new trigger for an org workspace.","operationId":"orgWorkspaceFlowpipeTrigger_create","parameters":[{"description":"The handle of the org which contains the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where we want to create the trigger.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTriggerRequest"}}},"description":"The request body for the trigger to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModTrigger"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create org workspace trigger","tags":["OrgWorkspaceFlowpipeTriggers"],"x-codegen-request-body-name":"request"}},"/org/{org_handle}/workspace/{workspace_handle}/usage":{"get":{"description":"List the usage associated with an org workspace.","operationId":"orgWorkspaceUsage_list","parameters":[{"description":"The handle of the organization where we want to create the workspace.","in":"path","name":"org_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where you want to list the associations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsageMetricsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List org workspace usage","tags":["OrgWorkspaceUsages"]}},"/service_account":{"get":{"description":"Lists service accounts at the tenant level.","operationId":"tenantServiceAccount_list","parameters":[{"description":"Maximum number of items to return. Default 100. Max 1000.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}},{"description":"Additional data to include. Supported value: tokens.","in":"query","name":"include","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant service accounts","tags":["TenantServiceAccounts"]},"post":{"description":"Create a new service account at the tenant level.","operationId":"tenantServiceAccount_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceAccountUserRequest"}}},"description":"The request body containing service account details","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create a tenant service account","tags":["TenantServiceAccounts"],"x-codegen-request-body-name":"body"}},"/service_account/{service_account_identifier}":{"delete":{"description":"Delete an existing service account at the tenant level.","operationId":"tenantServiceAccount_delete","parameters":[{"description":"The ID of the service account to delete","in":"path","name":"service_account_identifier","required":true,"schema":{"type":"string"}}],"responses":{"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete a tenant service account","tags":["TenantServiceAccounts"]},"get":{"description":"Retrieves a specific tenant-level service account.","operationId":"tenantServiceAccount_get","parameters":[{"description":"The ID of the service account","in":"path","name":"service_account_identifier","required":true,"schema":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant service account","tags":["TenantServiceAccounts"]},"patch":{"description":"Update an existing service account at the tenant level.","operationId":"tenantServiceAccount_update","parameters":[{"description":"The ID of the service account to update","in":"path","name":"service_account_identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateServiceAccountUserRequest"}}},"description":"The request body containing the updated service account details","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update a tenant service account","tags":["TenantServiceAccounts"],"x-codegen-request-body-name":"body"}},"/service_account/{service_account_identifier}/audit_log":{"get":{"description":"Returns the audit logs where the service account is either the actor or the identity (tenant-level service account).","operationId":"tenantServiceAccountAudit_list","parameters":[{"description":"The ID of the service account","in":"path","name":"service_account_identifier","required":true,"schema":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuditLogsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List audit logs for a tenant service account","tags":["TenantServiceAccountAuditLogs"]}},"/service_account/{service_account_identifier}/token":{"get":{"description":"Lists tokens for a tenant-level service account.","operationId":"tenantServiceAccountToken_list","parameters":[{"description":"The ID of the service account","in":"path","name":"service_account_identifier","required":true,"schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTokensResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant service account tokens","tags":["TenantServiceAccountTokens"]},"post":{"description":"Create a new token for a tenant-level service account.","operationId":"tenantServiceAccountToken_create","parameters":[{"description":"The ID of the service account","in":"path","name":"service_account_identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTokenRequest"}}},"description":"The request body containing token details","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenWithValue"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create a tenant service account token","tags":["TenantServiceAccountTokens"],"x-codegen-request-body-name":"body"}},"/service_account/{service_account_identifier}/token/{token_id}":{"delete":{"description":"Delete a token for a tenant-level service account.","operationId":"tenantServiceAccountToken_delete","parameters":[{"description":"The ID of the service account","in":"path","name":"service_account_identifier","required":true,"schema":{"type":"string"}},{"description":"The identifier of the token","in":"path","name":"token_id","required":true,"schema":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete a tenant service account token","tags":["TenantServiceAccountTokens"]},"get":{"description":"Retrieves a specific token for a tenant-level service account.","operationId":"tenantServiceAccountToken_get","parameters":[{"description":"The ID of the service account","in":"path","name":"service_account_identifier","required":true,"schema":{"type":"string"}},{"description":"The identifier of the token","in":"path","name":"token_id","required":true,"schema":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get a tenant service account token","tags":["TenantServiceAccountTokens"]},"patch":{"description":"Update an existing token for a tenant-level service account.","operationId":"tenantServiceAccountToken_update","parameters":[{"description":"The ID of the service account","in":"path","name":"service_account_identifier","required":true,"schema":{"type":"string"}},{"description":"The identifier of the token","in":"path","name":"token_id","required":true,"schema":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTokenRequest"}}},"description":"The request body containing the updated token details","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update a tenant service account token","tags":["TenantServiceAccountTokens"],"x-codegen-request-body-name":"body"}},"/settings":{"get":{"description":"Retrieves the tenant settings.","operationId":"tenant_getSettings","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantSettings"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant settings","tags":["Tenants"]},"patch":{"description":"Update settings for a custom tenant.","operationId":"tenant_updateSettings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTenantSettingsRequest"}}},"description":"The request body for updating tenant settings.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantSettings"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update tenant settings","tags":["Tenants"],"x-codegen-request-body-name":"request"}},"/signup":{"post":{"description":"New user signup.","operationId":"auth_signup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSignupRequest"}}},"description":"The request body to signup.","required":true},"responses":{"201":{"content":{},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"User signup","tags":["Auth"],"x-codegen-request-body-name":"request"}},"/signup/confirm":{"get":{"description":"Confirm user signup.","operationId":"auth_confirmSignup","parameters":[{"description":"Specify the token.","in":"query","name":"t","required":true,"schema":{"type":"string"}}],"responses":{"201":{"content":{},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Confirm user signup","tags":["Auth"]}},"/tenant":{"get":{"description":"List tenants the actor is a member of.","operationId":"tenant_list","parameters":[{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTenantsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenants","tags":["Tenants"]},"post":{"description":"Creates a tenant.","operationId":"tenant_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTenantRequest"}}},"description":"The request body to create the tenant.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tenant"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create tenant","tags":["Tenants"],"x-codegen-request-body-name":"request"}},"/tenant/{tenant_handle}":{"delete":{"description":"Deletes the specified tenant.","operationId":"tenant_delete","parameters":[{"description":"Specify the handle of the tenant which need to be deleted.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tenant"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete tenant","tags":["Tenants"]},"get":{"description":"Retrieves the tenant information.","operationId":"tenant_get","parameters":[{"description":"Specify the handle of a tenant whose information you want to retrieve.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tenant"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant","tags":["Tenants"]},"patch":{"description":"Updates various information about a tenant.","operationId":"tenant_update","parameters":[{"description":"Specify the handle of the tenant which needs to be updated.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTenantRequest"}}},"description":"The request body for the tenant update request.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tenant"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update tenant","tags":["Tenants"],"x-codegen-request-body-name":"request"}},"/tenant/{tenant_handle}/avatar":{"delete":{"description":"Delete custom avatar for a tenant.","operationId":"tenant_deleteAvatar","parameters":[{"description":"Specify the handle of the tenant to delete the avatar for.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAvatarResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete tenant avatar","tags":["Tenants"]},"get":{"description":"Get public avatar for a tenant.","operationId":"tenant_getAvatar","parameters":[{"description":"Specify the handle of the tenant to retrieve the avatar for.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"string"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant avatar","tags":["Tenants"]},"post":{"description":"Create custom avatar for a tenant.","operationId":"tenant_createAvatar","parameters":[{"description":"Specify the handle of the tenant to create the avatar for.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"string"}}},"description":"The format data containing the tenant avatar.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAvatarResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create tenant avatar","tags":["Tenants"],"x-codegen-request-body-name":"request"}},"/tenant/{tenant_handle}/billing/invoice":{"get":{"description":"List tenant invoices. TODO: paging, Stripe suports this we need to to implement it.","operationId":"tenantBilling_listTenantBillingInvoices","parameters":[{"description":"The handle of the tenant to list invoices for","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBillingInvoicesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant invoices","tags":["TenantBilling"]}},"/tenant/{tenant_handle}/billing/invoice/{invoice_id}":{"get":{"description":"Get an invoice for a tenant.","operationId":"tenantBilling_getTenantBillingInvoice","parameters":[{"description":"The handle of an organization","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The org invoice id.","in":"path","name":"invoice_id","required":true,"schema":{"format":"^in_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingInvoice"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get a tenant invoice","tags":["TenantBilling"]}},"/tenant/{tenant_handle}/billing/payment_method":{"get":{"description":"List tenant billing payment methods.","operationId":"tenantBilling_listTenantBillingPaymentMethod","parameters":[{"description":"The handle of the tenant to list payment methods for","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBillingPaymentMethodsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant billing payment methods.","tags":["TenantBilling"]}},"/tenant/{tenant_handle}/billing/payment_method/intent":{"post":{"description":"Create tenant Stripe billing intent","operationId":"tenantBilling_createBillingIntent","parameters":[{"description":"The handle of an organization where the billing intent will be created","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSetupIntent"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create tenant Stripe billing intent","tags":["TenantBilling"]}},"/tenant/{tenant_handle}/billing/payment_method/{payment_method_id}":{"delete":{"description":"Delete tenant billing payment method. Deleting default payment method will result in a 403 (forbidden) error.","operationId":"tenantBilling_deleteTenantBillingPaymentMethod","parameters":[{"description":"The handle of the tenant to delete the payment method for","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The org payment method id.","in":"path","name":"payment_method_id","required":true,"schema":{"format":"^pm_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete tenant billing payment method.","tags":["TenantBilling"]},"get":{"description":"List tenant billing payment method.","operationId":"tenantBilling_getTenantBillingPaymentMethod","parameters":[{"description":"The handle of the tenant to get the payment method for","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The org payment method id.","in":"path","name":"payment_method_id","required":true,"schema":{"format":"^pm_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant billing payment method.","tags":["TenantBilling"]},"patch":{"description":"Update tenant billing payment method.","operationId":"tenantBilling_updateTenantBillingPaymentMethod","parameters":[{"description":"The handle of the tenant to update the payment method for","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The org payment method id.","in":"path","name":"payment_method_id","required":true,"schema":{"format":"^pm_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingPaymentMethodRequest"}}},"description":"The request body for the tenant billing payment method update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update tenant billing payment method.","tags":["TenantBilling"],"x-codegen-request-body-name":"request"}},"/tenant/{tenant_handle}/billing/plan":{"get":{"description":"Get the current tenant billing plan.","operationId":"tenantBilling_getPlan","parameters":[{"description":"Specify the handle of the tenant to retrieve the billing plan for.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantPlan"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant billing plan.","tags":["TenantBilling"]}},"/tenant/{tenant_handle}/billing/stripe/invoice/upcoming":{"get":{"description":"Get upcoming invoice. Can be used to let subscriber know the estimated amount for next invoice.","operationId":"tenantBilling_getTenantBillingUpcomingInvoice","parameters":[{"description":"The handle of the tenant","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingInvoice"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get upcoming invoice","tags":["TenantBilling"]}},"/tenant/{tenant_handle}/billing/subscription":{"get":{"description":"List tenant subscriptions.","operationId":"tenantBilling_listTenantSubscription","parameters":[{"description":"The handle of the tenant to list subscriptions for.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSubscriptionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant subscriptions","tags":["TenantBilling"]},"post":{"description":"Create a new subscription for the tenant. There can only be 1 active subscription per tenant.","operationId":"tenantBilling_createTenantSubscription","parameters":[{"description":"The handle of the tenant where the subscription will be created.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscription"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create a new subscription","tags":["TenantBilling"]}},"/tenant/{tenant_handle}/billing/subscription/{subscription_id}":{"delete":{"description":"Delete tenant subscription.","operationId":"tenantBilling_deleteTenantBillingSubscription","parameters":[{"description":"The handle of the tenant to delete the subscription for.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The tenant subscription id.","in":"path","name":"subscription_id","required":true,"schema":{"format":"^sub_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscription"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete tenant subscription","tags":["TenantBilling"]},"get":{"description":"Get tenant subscription","operationId":"tenantBilling_getTenantBillingSubscription","parameters":[{"description":"The handle of a the tenant to get the subscription for.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The tenant subscription id.","in":"path","name":"subscription_id","required":true,"schema":{"format":"^sub_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscription"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant subscription","tags":["TenantBilling"]},"patch":{"description":"Update tenant subscription. Use this API to \"stop cancel at the next billing period\" by passing \"stopcancel\" in the action parameter.","operationId":"tenantBilling_updateTenantBillingSubscription","parameters":[{"description":"The handle of the tenant to update the subscription for.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The tenant subscription id.","in":"path","name":"subscription_id","required":true,"schema":{"format":"^sub_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingSubscriptionRequest"}}},"description":"Request body to update the tenant subscription","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscription"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update tenant subscription","tags":["TenantBilling"],"x-codegen-request-body-name":"request"}},"/tenant/{tenant_handle}/constraint":{"get":{"description":"List all applicable constraints for a tenant.","operationId":"tenant_listConstraints","parameters":[{"description":"The handle of the tenant whose constraints you want to retrieve.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConstraintsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant constraints","tags":["Tenants"]}},"/tenant/{tenant_handle}/member":{"get":{"description":"List all members of a tenant who are invited / accepted.","operationId":"tenantMember_list","parameters":[{"description":"Specify the tenant handle.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTenantUsersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List Tenant Members","tags":["TenantMembers"]}},"/tenant/{tenant_handle}/member/invite":{"delete":{"description":"Delete the tenant member invite.","operationId":"tenantMember_deleteInvite","parameters":[{"description":"Specify the tenant handle.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the token to be rejected.","in":"query","name":"t","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{},"description":""},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete tenant member invite","tags":["TenantMembers"]},"post":{"description":"Invite member to a tenant.","operationId":"tenantMember_invite","parameters":[{"description":"Specify the handle of an tenant where the member need to be invited.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteTenantUserRequest"}}},"description":"The request body to invite a member to a tenant.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantUser"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Invite tenant member","tags":["TenantMembers"],"x-codegen-request-body-name":"request"}},"/tenant/{tenant_handle}/member/invite/confirm":{"get":{"description":"Confirm tenant member invite.","operationId":"tenantMember_confirmInvite","parameters":[{"description":"Specify the handle of an tenant where the member needs to be invited.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the token.","in":"query","name":"t","required":true,"schema":{"type":"string"}}],"responses":{"201":{"content":{},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Confirm tenant member invite","tags":["TenantMembers"]}},"/tenant/{tenant_handle}/member/{user_handle}":{"delete":{"description":"Delete the user from the tenant.","operationId":"tenantMember_delete","parameters":[{"description":"Specify the handle of the tenant where the member exists.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the handle of the user which need to be removed.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantUser"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete tenant member","tags":["TenantMembers"]},"get":{"description":"Get tenant member.","operationId":"tenantMember_get","parameters":[{"description":"Specify the tenant handle where the member is associated.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the handle of the user whose information you want to retrieve.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantUser"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get tenant member","tags":["TenantMembers"]},"patch":{"description":"Update the role of a member of a tenant.","operationId":"tenantMember_update","parameters":[{"description":"Specify the handle of the tenant where the member exists.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the handle of the user whose role need to be updated.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTenantUserRequest"}}},"description":"The request body for the member.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantUser"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update tenant member","tags":["TenantMembers"],"x-codegen-request-body-name":"request"}},"/tenant/{tenant_handle}/usage":{"get":{"description":"List all usage metrics for a tenant.","operationId":"tenant_listUsage","parameters":[{"description":"Specify the handle of the tenant which need to be deleted.","in":"path","name":"tenant_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsageMetricsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tenant usage","tags":["Tenants"]}},"/user":{"get":{"description":"List the users.","operationId":"user_list","parameters":[{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List users","tags":["Users"]},"post":{"description":"Creates a new user.","operationId":"user_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserRequest"}}},"description":"The request body to create the user.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user","tags":["Users"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}":{"delete":{"description":"Deletes the specified user.","operationId":"user_delete","parameters":[{"description":"Specify the handle of the user which need to be deleted.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user","tags":["Users"]},"get":{"description":"Retrieves information of the specified user.","operationId":"user_get","parameters":[{"description":"Specify the handle of the user whose information you want to retrieve.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user","tags":["Users"]},"patch":{"description":"Updates the handle name, display name, or the URL of a user.","operationId":"user_update","parameters":[{"description":"Specify the handle of the user which need to be updated.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserRequest"}}},"description":"The request body for the user.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user","tags":["Users"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/ai/key":{"get":{"description":"Lists AI provider API keys configured at the user level.","operationId":"aiKey_user_list","parameters":[{"description":"The handle of the user for which to list AI keys.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned. Pass next_token to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAIKeysResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user AI keys","tags":["AIKeys"]},"post":{"description":"Creates a new AI provider API key at the user level.","operationId":"aiKey_user_create","parameters":[{"description":"The handle of the user for which the AI key is being created.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAIKeyRequest"}}},"description":"The request body containing the AI provider and API key to save.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIKey"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user AI key","tags":["AIKeys"],"x-codegen-request-body-name":"body"}},"/user/{user_handle}/ai/key/{provider}":{"delete":{"description":"Deletes an existing AI provider API key at the user level.","operationId":"aiKey_user_delete","parameters":[{"description":"The handle of the user that owns the AI key.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The AI provider for which to delete the key.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIKey"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user AI key","tags":["AIKeys"]},"get":{"description":"Retrieves the AI provider API key metadata at the user level.","operationId":"aiKey_user_get","parameters":[{"description":"The handle of the user that owns the AI key.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The AI provider for which to retrieve the key.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIKey"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user AI key","tags":["AIKeys"]},"patch":{"description":"Updates an existing AI provider API key at the user level.","operationId":"aiKey_user_update","parameters":[{"description":"The handle of the user that owns the AI key.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The AI provider for which to update the key.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAIKeyRequest"}}},"description":"The request body containing the updated API key value.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIKey"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user AI key","tags":["AIKeys"],"x-codegen-request-body-name":"body"}},"/user/{user_handle}/ai/key/{provider}/test":{"post":{"description":"Tests whether an AI provider API key is valid at the user level. If a key is not provided in the body, the existing saved key for the provider will be tested.","operationId":"aiKey_user_test","parameters":[{"description":"The handle of the user that owns the AI key.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The AI provider for which to test the key.","in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestAIKeyRequest"}}},"description":"Optional request body containing an API key to test instead of the saved one.","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestAIKeyResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Test user AI key","tags":["AIKeys"],"x-codegen-request-body-name":"body"}},"/user/{user_handle}/audit_log":{"get":{"description":"Returns the audit logs for a user.","operationId":"user_listAuditLogs","parameters":[{"description":"Specify the user handle to get the audit logs.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuditLogsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"User audit logs","tags":["Users"]}},"/user/{user_handle}/avatar":{"delete":{"description":"Delete custom avatar for a user.","operationId":"user_deleteAvatar","parameters":[{"description":"The handle of the user whose avatar is to be deleted.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAvatarResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user avatar","tags":["Users"]},"post":{"description":"Create custom avatar for a user.","operationId":"user_createAvatar","parameters":[{"description":"The handle of the user whose avatar is to be created.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"string"}}},"description":"The format data containing the user avatar.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAvatarResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user avatar","tags":["Users"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/billing/invoice":{"get":{"description":"List user invoices. TODO: paging, Stripe suports this we need to to implement it.","operationId":"userBilling_listUserBillingInvoices","parameters":[{"description":"The handle of a user to list invoices for.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBillingInvoicesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user invoices","tags":["UserBilling"]}},"/user/{user_handle}/billing/invoice/{invoice_id}":{"get":{"description":"Get an invoice.","operationId":"userBilling_getUserBillingInvoice","parameters":[{"description":"Specify the handle of a user to retrieve an invoice for.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The user invoice id.","in":"path","name":"invoice_id","required":true,"schema":{"format":"^in_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingInvoice"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get a user invoice","tags":["UserBilling"]}},"/user/{user_handle}/billing/payment_method":{"get":{"description":"List user billing payment methods.","operationId":"userBilling_listUserBillingPaymentMethod","parameters":[{"description":"The handle of the user to list the payment methods for.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBillingPaymentMethodsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user billing payment methods.","tags":["UserBilling"]}},"/user/{user_handle}/billing/payment_method/intent":{"post":{"description":"Create Stripe billing intent","operationId":"userBilling_createBillingIntent","parameters":[{"description":"The handle of a user where the billing intent will be created.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSetupIntent"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create Stripe billing intent","tags":["UserBilling"]}},"/user/{user_handle}/billing/payment_method/{payment_method_id}":{"delete":{"description":"Delete user billing payment method. Deleting default payment method will result in a 403 (forbidden) error.","operationId":"userBilling_deleteUserBillingPaymentMethod","parameters":[{"description":"The handle of the user to delete the payment method for.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The user payment method id.","in":"path","name":"payment_method_id","required":true,"schema":{"format":"^pm_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user billing payment method.","tags":["UserBilling"]},"get":{"description":"List user billing payment method.","operationId":"userBilling_getUserBillingPaymentMethod","parameters":[{"description":"The handle of the user to get the payment method for.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The user payment method id.","in":"path","name":"payment_method_id","required":true,"schema":{"format":"^pm_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user billing payment method.","tags":["UserBilling"]},"patch":{"description":"Update user billing payment method.","operationId":"userBilling_updateUserBillingPaymentMethod","parameters":[{"description":"The handle of the user to update the payment method for.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The user payment method id.","in":"path","name":"payment_method_id","required":true,"schema":{"format":"^pm_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingPaymentMethodRequest"}}},"description":"The request body for the user billing payment method update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user billing payment method.","tags":["UserBilling"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/billing/plan":{"get":{"description":"Get the current user billing plan.","operationId":"user_getPlan","parameters":[{"description":"Specify the handle of the user to retrieve the billing plan for.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityPlan"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user billing plan.","tags":["Users"]}},"/user/{user_handle}/billing/stripe/invoice/upcoming":{"get":{"description":"Get the upcoming invoice for this user. Can be used to let the user know the estimated amount for next invoice.","operationId":"userBilling_getUserBillingUpcomingInvoice","parameters":[{"description":"The handle of the user to get the upcoming invoice for.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingInvoice"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get upcoming user invoice","tags":["UserBilling"]}},"/user/{user_handle}/billing/subscription":{"get":{"description":"List user subscriptions. TODO: user should only have 1 active subscriptions, but what if we change subscriptions (is it possible?). Should we display old subscriptions?","operationId":"userBilling_listUserSubscription","parameters":[{"description":"The handle of the user to retrieve the subscriptions for.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSubscriptionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user subscriptions","tags":["UserBilling"]},"post":{"description":"Create a new subscription for the user. There can only be 1 active subscription per user. TODO: webhook when subscription payment fail? What to do when subscription is deactivated?","operationId":"userBilling_createUserSubscription","parameters":[{"description":"The handle of a user where the subscription will be created.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscription"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create a new subscription","tags":["UserBilling"]}},"/user/{user_handle}/billing/subscription/{subscription_id}":{"delete":{"description":"Delete user subscription. TODO: prorate, when to delete subscription. Webhook when the Subscription is finally deleted.","operationId":"userBilling_deleteUserBillingSubscription","parameters":[{"description":"The handle of a user to delete the subscription for.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The user subscription id.","in":"path","name":"subscription_id","required":true,"schema":{"format":"^sub_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscription"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user subscription","tags":["UserBilling"]},"get":{"description":"Get user subscription","operationId":"userBilling_getUserBillingSubscription","parameters":[{"description":"The handle of a user.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The user subscription id.","in":"path","name":"subscription_id","required":true,"schema":{"format":"^sub_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscription"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user subscription","tags":["UserBilling"]}},"/user/{user_handle}/conn":{"get":{"deprecated":true,"description":"List the connection for a user.","operationId":"userConnection_listDeprecated","parameters":[{"description":"The handle of the user for which we want to list connections.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user connections","tags":["UserConnections"]},"post":{"deprecated":true,"description":"Creates a new connection for a user.","operationId":"userConnection_createDeprecated","parameters":[{"description":"The handle of the user where we want to create the connection.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionRequest"}}},"description":"The request body for the connection to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user connection","tags":["UserConnections"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/conn/{conn_handle}":{"delete":{"deprecated":true,"description":"Delete a connection belonging to a user.","operationId":"userConnection_deleteDeprecated","parameters":[{"description":"The handle of the user where the connection exist.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection that needs to be deleted.","in":"path","name":"conn_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user connection","tags":["UserConnections"]},"get":{"deprecated":true,"description":"Get the details for a connection belonging to a user.","operationId":"userConnection_getDeprecated","parameters":[{"description":"The handle for the user where the connection exist.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection whose detail needs to be fetched.","in":"path","name":"conn_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user connection","tags":["UserConnections"]},"patch":{"deprecated":true,"description":"Update a connection for a user.","operationId":"userConnection_updateDeprecated","parameters":[{"description":"The handle of the user where the connection exist.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection which needs to be updated.","in":"path","name":"conn_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectionRequest"}}},"description":"The request body for the connection which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user connection","tags":["UserConnections"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/conn/{conn_handle}/test":{"post":{"deprecated":true,"description":"Test the config for a user connection to check for basic connectivity.","operationId":"userConnection_testDeprecated","parameters":[{"description":"The handle of the user where the connection exists / intends to be created.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection.","in":"path","name":"conn_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestConnectionRequest"}}},"description":"The request body for the connection to be tested.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionTestResult"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Test user connection","tags":["UserConnections"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/conn/{conn_handle}/workspace":{"get":{"deprecated":true,"description":"List the workspaces that a user connection has been added to.","operationId":"userConnection_listWorkspacesDeprecated","parameters":[{"description":"The handle of the user where the connection exists.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection for which we want to list workspaces.","in":"path","name":"conn_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceConnResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user connection workspaces","tags":["UserConnections"]}},"/user/{user_handle}/connection":{"get":{"description":"List connections for a user.","operationId":"userConnection_list","parameters":[{"description":"The handle of the user for which we want to list connections.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user connections","tags":["UserConnections"]},"post":{"description":"Creates a new connection for a user.","operationId":"userConnection_create","parameters":[{"description":"The handle of the user where we want to create the connection.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionRequest"}}},"description":"The request body for the connection to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user connection","tags":["UserConnections"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/connection/{connection_handle}":{"delete":{"description":"Deletes a connection belonging to a user.","operationId":"userConnection_delete","parameters":[{"description":"The handle of the user where the connection exists.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection that needs to be deleted.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user connection","tags":["UserConnections"]},"get":{"description":"Get the details of a connection belonging to a user.","operationId":"userConnection_get","parameters":[{"description":"The handle for the user where the connection exists.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection whose detail needs to be fetched.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user connection","tags":["UserConnections"]},"patch":{"description":"Update the details of a connection belonging to a user.","operationId":"userConnection_update","parameters":[{"description":"The handle of the user where the connection exists.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection which needs to be updated.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectionRequest"}}},"description":"The request body for the connection which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user connection","tags":["UserConnections"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/connection/{connection_handle}/test":{"post":{"description":"Test the config for a user connection to check for basic connectivity.","operationId":"userConnection_test","parameters":[{"description":"The handle of the user where the connection exists / intends to be created.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestConnectionRequest"}}},"description":"The request body for the connection to be tested.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionTestResult"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Test user connection","tags":["UserConnections"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/connection/{connection_handle}/workspace":{"get":{"description":"List the workspaces that a user connection has been added to.","operationId":"userConnection_listWorkspaces","parameters":[{"description":"The handle of the user where the connection exists.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection for which we want to list workspaces.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceConnectionAssociationsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user connection workspaces","tags":["UserConnections"]}},"/user/{user_handle}/constraint":{"get":{"description":"List all applicable constraints for a user.","operationId":"user_listConstraints","parameters":[{"description":"Specify the handle of the user whose constraints you want to retrieve.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConstraintsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user constraints","tags":["Users"]}},"/user/{user_handle}/email":{"get":{"description":"List emails for a user along with other metadata information for each item.","operationId":"user_listEmails","parameters":[{"description":"Specify the handle of the user whose information you want to retrieve.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUserEmailsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user emails","tags":["Users"]}},"/user/{user_handle}/email/{email_id}":{"get":{"description":"Get a particular user email record along with its metadata information.","operationId":"user_getEmail","parameters":[{"description":"Specify the handle of the user whose information you want to retrieve.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Specify the id of the email object you want to retrieve.","in":"path","name":"email_id","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEmail"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user email","tags":["Users"]}},"/user/{user_handle}/integration":{"get":{"description":"List integrations configuered for a user.","operationId":"userIntegration_list","parameters":[{"description":"The handle of the user for whom you want to list integrations.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListIntegrationsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user integrations","tags":["UserIntegrations"]},"post":{"description":"Creates a new integration for a user. A user can only create a Github integration.","operationId":"userIntegration_create","parameters":[{"description":"The handle of the user for which you want to create an integration.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationRequest"}}},"description":"The request body for the integration to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user integration","tags":["UserIntegrations"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/integration/{integration_handle}":{"delete":{"description":"Delete an integration configured for a user.","operationId":"userIntegration_delete","parameters":[{"description":"The handle of the user on which the integration is configured.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration which needs to be deleted.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user integration","tags":["UserIntegrations"]},"get":{"description":"Get details of an integration configured on a user.","operationId":"userIntegration_get","parameters":[{"description":"The handle of the user to which the integration belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration whose details need to be retrieved.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user integration","tags":["UserIntegrations"]},"patch":{"description":"Update details of an integration configured for a user.","operationId":"userIntegration_update","parameters":[{"description":"The handle of the user on which the integration is configured.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration whose details need to be updated.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationRequest"}}},"description":"The request body for the integration update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user integration","tags":["UserIntegrations"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/integration/{integration_handle}/command":{"post":{"description":"Run a command for a user integration","operationId":"userIntegration_command","parameters":[{"description":"The handle of the user to which the integration belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration for which we want to run the command.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCommandRequest"}}},"description":"The request body for the workspace command.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationCommandRequest"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Run user integration command","tags":["UserIntegrations"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/integration/{integration_handle}/github/install":{"get":{"description":"Install a GitHub integration for a user identity.","operationId":"userIntegration_installGithubIntegration","parameters":[{"description":"The handle of the user to which the integration belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the GitHub integration which needs to be installed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"307":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Temporary Redirect"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Install GitHub integration for a user","tags":["UserIntegrations"]}},"/user/{user_handle}/integration/{integration_handle}/slack/channel":{"get":{"description":"List Slack channels that are given access to a user Slack integration.","operationId":"userIntegration_listSlackChannels","parameters":[{"description":"The handle of the user to which the integration belongs.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration for which Slack channels will be listed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSlackChannelsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user integration Slack channels","tags":["UserIntegrations"]}},"/user/{user_handle}/integration/{integration_handle}/slack/install":{"get":{"description":"Install a Slack integration for a user identity.","operationId":"userIntegration_installSlackIntegration","parameters":[{"description":"The handle of the user to which the integration belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the Slack integration which needs to be installed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"307":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Temporary Redirect"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Install Slack integration for a user","tags":["UserIntegrations"]}},"/user/{user_handle}/integration/{integration_handle}/test":{"post":{"description":"Test the config for a user integration to check for basic connectivity before you create it.","operationId":"userIntegration_test","parameters":[{"description":"The handle of the user to which the integration belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration to be tested. For integrations that are not yet created, use underscore `_` as the handle, else pass the handle of the existing integration.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Test user integration","tags":["UserIntegrations"]}},"/user/{user_handle}/notifier":{"get":{"description":"List all notifiers for a user","operationId":"userNotifier_list","parameters":[{"description":"The handle of the user for which the notifiers are to be listed.","in":"path","name":"user_handle","required":true,"schema":{"type":"string"}},{"description":"The maximum number of items to return.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"The token to retrieve the next page.","in":"query","name":"next_token","schema":{"type":"string"}},{"description":"The filter to apply to the list.","in":"query","name":"where","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNotifiersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user notifiers","tags":["UserNotifiers"]},"post":{"description":"Create a new notifier for a user","operationId":"userNotifier_create","parameters":[{"description":"The handle of the user for which the notifier is to be created.","in":"path","name":"user_handle","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNotifierRequest"}}},"description":"The request body for the notifier to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user notifier","tags":["UserNotifiers"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/notifier/{notifier_name}":{"delete":{"description":"Delete a notifier for a user","operationId":"userNotifier_delete","parameters":[{"description":"The handle of the user for which the notifier is to be deleted.","in":"path","name":"user_handle","required":true,"schema":{"type":"string"}},{"description":"The name of the notifier to be deleted.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user notifier","tags":["UserNotifiers"]},"get":{"description":"Get a notifier for a user","operationId":"userNotifier_get","parameters":[{"description":"The handle of the user for which the notifier is to be retrieved.","in":"path","name":"user_handle","required":true,"schema":{"type":"string"}},{"description":"The name of the notifier to be retrieved.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user notifier","tags":["UserNotifiers"]},"patch":{"description":"Update a notifier for a user","operationId":"userNotifier_update","parameters":[{"description":"The handle of the user for which the notifier is to be updated.","in":"path","name":"user_handle","required":true,"schema":{"type":"string"}},{"description":"The name of the notifier to be updated.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNotifierRequest"}}},"description":"The request body for the notifier to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user notifier","tags":["UserNotifiers"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/password":{"get":{"description":"Get user password.","operationId":"user_getDBPassword","parameters":[{"description":"Specify the handle of the user whose password need to be retrieved.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDatabasePassword"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user password","tags":["Users"]},"post":{"description":"Create or rotate user password.","operationId":"user_createDBPassword","parameters":[{"description":"Specify the handle of the user whose password need to be created or rotated.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserPasswordRequest"}}},"description":"The request body to create or rotate the password.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDatabasePassword"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user password","tags":["Users"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/preferences":{"get":{"description":"Get preferences for the user such as email preferences.","operationId":"user_getPreferences","parameters":[{"description":"Specify the handle of the user whose preferences need to be retrieved.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPreferences"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user preferences","tags":["Users"]},"patch":{"description":"Update preferences for the user e.g. opting out of receiving certain kind of emails.","operationId":"user_updatePreferences","parameters":[{"description":"Specify the handle of the user whose preferences need to be retrieved.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPreferencesRequest"}}},"description":"The request body for updating user preferences.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPreferences"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user preferences","tags":["Users"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/process":{"get":{"description":"List processes for a user.","operationId":"userProcess_list","parameters":[{"description":"The handle of the user to list the processes.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProcessesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List User processes","tags":["UserProcesses"]}},"/user/{user_handle}/process/{process_id}":{"get":{"description":"Get process for a user.","operationId":"userProcess_get","parameters":[{"description":"The handle of the user to get the process.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The id of the process to be fetched.","in":"path","name":"process_id","required":true,"schema":{"format":"^[a-z]{1,3}_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpProcess"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get User process","tags":["UserProcesses"]}},"/user/{user_handle}/process/{process_id}/log/{log_file}.{content_type}":{"get":{"description":"List the process logs for a given process of a user.","operationId":"userProcess_log","parameters":[{"description":"The handle of the user for which you want to list the process logs.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The id of the process where you want to list the process logs.","in":"path","name":"process_id","required":true,"schema":{"format":"^[a-z]{1,3}_[0-9a-v]{20}$","type":"string"}},{"description":"The process logs file to be fetched.","in":"path","name":"log_file","required":true,"schema":{"enum":["process"],"type":"string"}},{"description":"The required content type of the process logs.","in":"path","name":"content_type","required":true,"schema":{"enum":["jsonl"],"type":"string"}}],"responses":{"200":{"content":{"application/jsonlines+json":{"schema":{"type":"string"}}},"description":"OK"},"204":{"content":{"application/jsonlines+json":{"schema":{"type":"string"}}},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user process logs","tags":["UserProcesses"]}},"/user/{user_handle}/token":{"get":{"description":"List the token for a user.","operationId":"userToken_list","parameters":[{"description":"The handle of the user.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTokensResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List tokens","tags":["UserTokens"]},"post":{"description":"Creates a new token for the specified user. The limit is 2 per user.","operationId":"userToken_create","parameters":[{"description":"The handle of the user where the token will be created.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create token","tags":["UserTokens"]}},"/user/{user_handle}/token/{token_id}":{"delete":{"description":"Deletes the token associated with the specified user.","operationId":"userToken_delete","parameters":[{"description":"The handle of the user where the token exist.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The identifier of the token.","in":"path","name":"token_id","required":true,"schema":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete token","tags":["UserTokens"]},"get":{"description":"Retrieves the information of a specified token.","operationId":"userToken_get","parameters":[{"description":"The identifier of the token.","in":"path","name":"token_id","required":true,"schema":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}},{"description":"The handle of the user where the token exist.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get token","tags":["UserTokens"]},"patch":{"description":"Changes the status of the specified token from Active to Inactive or vice versa.","operationId":"userToken_update","parameters":[{"description":"The handle of the user where the token exist.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The identifier of the token.","in":"path","name":"token_id","required":true,"schema":{"format":"^[a-z]_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTokenRequest"}}},"description":"The request body for the token which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update token","tags":["UserTokens"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/usage":{"get":{"description":"List all usage metrics for a user.","operationId":"user_listUsage","parameters":[{"description":"The handle of the user to list usage for.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsageMetricsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user usage","tags":["Users"]}},"/user/{user_handle}/workspace":{"get":{"description":"List the workspace for a user.","operationId":"userWorkspace_list","parameters":[{"description":"The handle of the user for which we want to list the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspacesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspaces","tags":["UserWorkspaces"]},"post":{"description":"Creates a new workspace for a user.","operationId":"userWorkspace_create","parameters":[{"description":"The handle of the user where we want to create the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceRequest"}}},"description":"The request body for the workspace to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user workspace","tags":["UserWorkspaces"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}":{"delete":{"description":"Deletes the workspace specified in the request by the user.","operationId":"userWorkspace_delete","parameters":[{"description":"The handle of the user where the workspace exist.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Provide the handle of the workspace which needs to be deleted.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user workspace","tags":["UserWorkspaces"]},"get":{"description":"Get the details for the workspace.","operationId":"userWorkspace_get","parameters":[{"description":"The handle of the user where the workspace exist.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace whose detail needs to be fetched.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace","tags":["UserWorkspaces"]},"patch":{"description":"Update the workspace for a user.","operationId":"userWorkspace_update","parameters":[{"description":"The handle of the user where the workspace exist.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace which needs to be updated.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceRequest"}}},"description":"The request body for the workspace which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user workspace","tags":["UserWorkspaces"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/aggregator":{"get":{"description":"List aggregators for a workspace of a user.","operationId":"userWorkspaceAggregator_list","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace for which we will be listing aggregators.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceAggregatorsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List aggregators for a user workspace","tags":["UserWorkspaceAggregators"]},"post":{"description":"Creates an aggregator for a workspace of a user.","operationId":"userWorkspaceAggregator_create","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the aggregator will be created.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAggregatorRequest"}}},"description":"The request body for the aggregator to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Aggregator"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create an aggregator for a user workspace","tags":["UserWorkspaceAggregators"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle}":{"delete":{"description":"Deletes an aggregator belonging to a workspace of a user.","operationId":"userWorkspaceAggregator_delete","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the aggregator exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the aggregator that needs to be deleted.","in":"path","name":"aggregator_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Aggregator"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete an aggregator for a user workspace","tags":["UserWorkspaceAggregators"]},"get":{"description":"Get the details of an aggregator belonging to a workspace of a user.","operationId":"userWorkspaceAggregator_get","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the aggregator exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the aggregator whose details need to be fetched.","in":"path","name":"aggregator_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Aggregator"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get an aggregator for a user workspace","tags":["UserWorkspaceAggregators"]},"patch":{"description":"Update the details of an aggregator belonging to workspace of a user.","operationId":"userWorkspaceAggregator_update","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the aggregator exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the aggregator whose details need to be updated.","in":"path","name":"aggregator_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAggregatorRequest"}}},"description":"The request body for the aggregator which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Aggregator"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update an aggregator for a user workspace","tags":["UserWorkspaceAggregators"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle}/connection":{"get":{"description":"List all connections that are a part of an aggregator defined in a workspace of a user.","operationId":"userWorkspaceAggregator_listConnections","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the aggregator exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the aggregator whose connections need to be fetched.","in":"path","name":"aggregator_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List connections in the scope of an aggregator for a user workspace","tags":["UserWorkspaceAggregators"]}},"/user/{user_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle}/connection/{connection_handle}":{"get":{"description":"Get a connection that is a part of an aggregator defined in a workspace of a user.","operationId":"userWorkspaceAggregator_getConnection","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the aggregator exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the aggregator which the connection is a part of.","in":"path","name":"aggregator_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The handle of the connection whose details need to be fetched.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceConnection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get a connection in the scope of an aggregator for a user workspace","tags":["UserWorkspaceAggregators"]}},"/user/{user_handle}/workspace/{workspace_handle}/ai/chat":{"post":{"description":"Sends a chat message to the AI agent in a user workspace. Creates a new conversation if conversation_id is not provided.","operationId":"conversation_user_chat","parameters":[{"description":"The handle of the user that owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the user workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatRequest"}}},"description":"The chat request payload containing the message, model and optional conversation_id.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Chat in user workspace","tags":["UserWorkspaceConversations"],"x-codegen-request-body-name":"body"}},"/user/{user_handle}/workspace/{workspace_handle}/ai/conversation":{"get":{"description":"Lists AI conversations in a user workspace with optional filtering and pagination.","operationId":"conversation_user_list","parameters":[{"description":"The handle of the user that owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the user workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"Optional filter expression for title.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned. Pass next_token to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConversationsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace conversations","tags":["UserWorkspaceConversations"]}},"/user/{user_handle}/workspace/{workspace_handle}/ai/conversation/{conversation_id}":{"delete":{"description":"Deletes a specific user workspace conversation.","operationId":"conversation_user_delete","parameters":[{"description":"The handle of the user that owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the user workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The ID of the conversation to delete.","in":"path","name":"conversation_id","required":true,"schema":{"format":"^conv_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user workspace conversation","tags":["UserWorkspaceConversations"]},"get":{"description":"Retrieves details for a specific user workspace conversation.","operationId":"conversation_user_get","parameters":[{"description":"The handle of the user that owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the user workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The ID of the conversation to retrieve.","in":"path","name":"conversation_id","required":true,"schema":{"format":"^conv_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace conversation","tags":["UserWorkspaceConversations"]},"patch":{"description":"Updates a user workspace conversation (e.g., title).","operationId":"conversation_user_update","parameters":[{"description":"The handle of the user that owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the user workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The ID of the conversation to update.","in":"path","name":"conversation_id","required":true,"schema":{"format":"^conv_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConversationRequest"}}},"description":"Fields to update on the conversation.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user workspace conversation","tags":["UserWorkspaceConversations"],"x-codegen-request-body-name":"body"}},"/user/{user_handle}/workspace/{workspace_handle}/ai/conversation/{conversation_id}/artifact/{artifact_id}":{"get":{"description":"Retrieves metadata for a specific artifact created by a user workspace conversation.","operationId":"conversationArtifact_user_get","parameters":[{"description":"The handle of the user that owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the user workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The ID of the conversation that produced the artifact.","in":"path","name":"conversation_id","required":true,"schema":{"format":"^conv_[0-9a-v]{20}$","type":"string"}},{"description":"The ID of the artifact to retrieve.","in":"path","name":"artifact_id","required":true,"schema":{"format":"^art_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationArtifact"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace conversation artifact metadata","tags":["UserWorkspaceConversationArtifacts"]}},"/user/{user_handle}/workspace/{workspace_handle}/ai/conversation/{conversation_id}/artifact/{artifact_id}.{content_type}":{"get":{"description":"Downloads an artifact file from a user workspace AI conversation.","operationId":"userWorkspaceArtifact_download","parameters":[{"description":"The handle of the user that owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the user workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The ID of the conversation that produced the artifact.","in":"path","name":"conversation_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the artifact to download.","in":"path","name":"artifact_id","required":true,"schema":{"type":"string"}},{"description":"The type/extension of the artifact to download.","in":"path","name":"content_type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Download user workspace artifact","tags":["UserWorkspaceArtifacts"]}},"/user/{user_handle}/workspace/{workspace_handle}/ai/conversation/{conversation_id}/message":{"get":{"description":"Lists messages for a specific user workspace conversation with pagination.","operationId":"conversationMessage_user_list","parameters":[{"description":"The handle of the user that owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the user workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The ID of the conversation whose messages are being listed.","in":"path","name":"conversation_id","required":true,"schema":{"format":"^conv_[0-9a-v]{20}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned. Pass next_token to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConversationMessagesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace conversation messages","tags":["UserWorkspaceConversationMessages"]}},"/user/{user_handle}/workspace/{workspace_handle}/ai/model":{"get":{"description":"Lists available AI models for a user workspace based on configured AI keys.","operationId":"model_user_list","parameters":[{"description":"The handle of the user that owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the user workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListModelsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace AI models","tags":["UserWorkspaceAIModels"]}},"/user/{user_handle}/workspace/{workspace_handle}/audit_log":{"get":{"description":"Returns the audit logs for a user workspace.","operationId":"userWorkspace_listAuditLogs","parameters":[{"description":"Specify the user handle to get the audit logs.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace whose logs needs to be fetched.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuditLogsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"User workspace audit logs","tags":["UserWorkspaces"]}},"/user/{user_handle}/workspace/{workspace_handle}/command":{"post":{"description":"Run a command in the workspace. Valid commands are: reboot.","operationId":"userWorkspace_command","parameters":[{"description":"The handle of the user where we want to run the workspace command.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where command will be executed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCommandRequest"}}},"description":"The request body for the workspace command.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCommandResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Run user workspace command","tags":["UserWorkspaces"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/conn":{"get":{"description":"List the connections associated with a workspace.","operationId":"userWorkspaceConnectionAssociation_list","parameters":[{"description":"The handle of the user for which you want to start listing associations.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where you want to list the associations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceConnResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace connection associations","tags":["UserWorkspaceConnectionAssociations"]},"post":{"description":"Associate a connection with the workspace. A workspace can have multiple association.","operationId":"userWorkspaceConnectionAssociation_create","parameters":[{"description":"The handle of the user where we want to create an association.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the connection will be associated.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceConnRequest"}}},"description":"The request body for the association to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceConn"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user workspace connection association","tags":["UserWorkspaceConnectionAssociations"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/conn/{conn_handle}":{"delete":{"description":"Dissociates or delete the workspace and connection association.","operationId":"userWorkspaceConnectionAssociation_delete","parameters":[{"description":"The handle of the user performing the action.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace whose association needs to be deleted.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the conn whose association needs to be deleted.","in":"path","name":"conn_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceConn"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user workspace connection association","tags":["UserWorkspaceConnectionAssociations"]},"get":{"description":"Get the details for a workspace and connection association.","operationId":"userWorkspaceConnectionAssociation_get","parameters":[{"description":"The handle of the user for which you want to get the association.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace wherethe association exist.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the conn whose association details needs to be fetched.","in":"path","name":"conn_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceConn"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace connection association","tags":["UserWorkspaceConnectionAssociations"]}},"/user/{user_handle}/workspace/{workspace_handle}/connection":{"get":{"description":"List connections explicitly defined or associated to the workspace.","operationId":"userWorkspaceConnection_list","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace for which we want to list connections.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List connections for a user workspace","tags":["UserWorkspaceConnections"]},"post":{"description":"Allows to create a connection on a workspace for a user.","operationId":"userWorkspaceConnection_create","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the connection will be created.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionRequest"}}},"description":"The request body for the connection to the created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create a connection for a user workspace","tags":["UserWorkspaceConnections"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/connection/{connection_handle}":{"delete":{"description":"Dissociates or delete the workspace and connection association.","operationId":"userWorkspaceConnection_delete","parameters":[{"description":"The handle of the user performing the action.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace whose association needs to be deleted.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the connection whose association needs to be deleted.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceConnection"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user workspace connection","tags":["UserWorkspaceConnections"]},"get":{"description":"Get the details for a workspace and connection association.","operationId":"userWorkspaceConnection_get","parameters":[{"description":"The handle of the user for which you want to get the association.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace wherethe association exist.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the connection whose association details needs to be fetched.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceConnection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace connection association","tags":["UserWorkspaceConnections"]},"patch":{"description":"Update the details of a connection belonging to a workspace of a user.","operationId":"userWorkspaceConnection_update","parameters":[{"description":"The handle of the user where the connection to be updated exists.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the connection to be updated exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the connection to update.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectionRequest"}}},"description":"The request body for the connection which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user workspace connection","tags":["UserWorkspaceConnections"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/connection/{connection_handle}/test":{"post":{"description":"Test the config for a connection configured on a user workspace to check for basic connectivity.","operationId":"userWorkspaceConnection_test","parameters":[{"description":"The handle of the user where the connection exists / intends to be created.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the connection exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection.","in":"path","name":"connection_handle","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestConnectionRequest"}}},"description":"The request body for the connection to be tested.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionTestResult"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Test user workspace connection","tags":["UserWorkspaceConnections"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/connection_folder":{"get":{"description":"List connection folders for a user workspace.","operationId":"userWorkspaceConnectionFolder_list","parameters":[{"description":"The handle of the user where we want to create the connection folder.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the folder is to be created.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace connections folders","tags":["UserWorkspaceConnectionFolders"]},"post":{"description":"Creates a new connection folder in a workspace of a user.","operationId":"userWorkspaceConnectionFolder_create","parameters":[{"description":"The handle of the user where we want to create the connection folder.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the folder is to be created.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionFolderRequest"}}},"description":"The request body for the connection to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user workspace connection folder","tags":["UserWorkspaceConnectionFolders"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/connection_folder/{folder_id}":{"delete":{"description":"Deletes a connection folder defined at a user workspace.","operationId":"userWorkspaceConnectionFolder_delete","parameters":[{"description":"The handle of the user where the folder to be deleted exists.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the folder to be deleted exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The id of the connection folder to delete.","in":"path","name":"folder_id","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user workspace connection folder","tags":["UserWorkspaceConnectionFolders"]},"get":{"description":"Get connection folder for a user workspace.","operationId":"userWorkspaceConnectionFolder_get","parameters":[{"description":"The handle of the user where the folder exists.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the folder exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The id of the connection folder to retrieve.","in":"path","name":"folder_id","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace connection folder","tags":["UserWorkspaceConnectionFolders"]},"patch":{"description":"Update the details of a connection folder belonging to a user workspace.","operationId":"userWorkspaceConnectionFolder_update","parameters":[{"description":"The handle of the user where the folder to be updated exists.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the folder to be updated exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The id of the connection folder to update.","in":"path","name":"folder_id","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}},{"description":"The mode of this request","in":"query","name":"mode","schema":{"enum":["available"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectionFolderRequest"}}},"description":"The request body for the connection which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user workspace connection folder","tags":["UserWorkspaceConnectionFolders"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/connection_tree":{"get":{"description":"List connection tree for a user workspace.","operationId":"userWorkspaceConnectionTree_list","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace for which we want to retrieve the connection tree.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The prefix to be used when listing items in a connection tree","in":"query","name":"prefix","schema":{"type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace connection tree","tags":["UserWorkspaceConnectionTree"]}},"/user/{user_handle}/workspace/{workspace_handle}/datatank":{"get":{"description":"List the user workspace Datatank.","operationId":"userWorkspaceDatatank_list","parameters":[{"description":"The handle of the user for which we want to list the workspace Datatank.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDatatankResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace Datatank","tags":["UserWorkspaceDatatanks"]},"post":{"description":"Creates a new user workspace tank.","operationId":"userWorkspaceDatatank_create","parameters":[{"description":"The handle of the user where we want to create the workspace Datatank.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDatatankRequest"}}},"description":"The request body for the workspace Datatank to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Datatank"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user workspace Datatank","tags":["UserWorkspaceDatatanks"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}":{"delete":{"description":"Deletes the user workspace Datatank table.","operationId":"userWorkspaceDatatank_delete","parameters":[{"description":"The handle of the user.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank to be deleted.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Datatank"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user workspace Datatank table","tags":["UserWorkspaceDatatanks"]},"get":{"description":"Get the details for the workspace Datatank.","operationId":"userWorkspaceDatatank_get","parameters":[{"description":"The handle of the user.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Datatank"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace Datatank","tags":["UserWorkspaceDatatanks"]},"patch":{"description":"Update the user workspace Datatank.","operationId":"userWorkspaceDatatank_update","parameters":[{"description":"The handle of the user.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDatatankRequest"}}},"description":"The request body to update workspace Datatank.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Datatank"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user workspace Datatank","tags":["UserWorkspaceDatatanks"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table":{"get":{"description":"List the user workspace Datatank tables.","operationId":"userWorkspaceDatatankTable_list","parameters":[{"description":"The handle of the user for which we want to list the workspace Datatank tables.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDatatankTableResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace Datatank tables","tags":["UserWorkspaceDatatankTables"]},"post":{"description":"Creates a new user workspace tank table.","operationId":"userWorkspaceDatatankTable_create","parameters":[{"description":"The handle of the user where we want to create the workspace Datatank table.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDatatankTableRequest"}}},"description":"The request body for the workspace Datatank table to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatatankTable"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user workspace Datatank table","tags":["UserWorkspaceDatatankTables"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}":{"delete":{"description":"Deletes the user workspace Datatank table.","operationId":"userWorkspaceDatatankTable_delete","parameters":[{"description":"The handle of the user.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The name of the workspace Datatank table to be deleted.","in":"path","name":"datatank_table_name","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatatankTable"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user workspace Datatank table","tags":["UserWorkspaceDatatankTables"]},"get":{"description":"Get the details for the workspace Datatank table","operationId":"userWorkspaceDatatankTable_get","parameters":[{"description":"The handle of the user.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The name of the workspace Datatank table.","in":"path","name":"datatank_table_name","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatatankTable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace Datatank table","tags":["UserWorkspaceDatatankTables"]},"patch":{"description":"Update the user workspace Datatank table.","operationId":"userWorkspaceDatatankTable_update","parameters":[{"description":"The handle of the user.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The name of the workspace Datatank table to be updated.","in":"path","name":"datatank_table_name","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDatatankTableRequest"}}},"description":"The request body to update workspace Datatank table.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatatankTable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user workspace Datatank table","tags":["UserWorkspaceDatatankTables"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/part":{"get":{"description":"List the user workspace Datatank partitions","operationId":"userWorkspaceDatatankPart_list","parameters":[{"description":"The handle of the user for which we want to list the workspace Datatank.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The name of the workspace Datatank table.","in":"path","name":"datatank_table_name","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDatatankPartResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace Datatank partitions","tags":["UserWorkspaceDatatankParts"]}},"/user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/part/{datatank_part_id}":{"patch":{"description":"Update the user workspace Datatank table partition.","operationId":"userWorkspaceDatatankPart_update","parameters":[{"description":"The handle of the user.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The name of the workspace Datatank table.","in":"path","name":"datatank_table_name","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The id of the workspace Datatank table partition to be updated.","in":"path","name":"datatank_part_id","required":true,"schema":{"format":"^dtc_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDatatankPartRequest"}}},"description":"The request body to update workspace Datatank table partition.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatatankPart"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user workspace Datatank table partition","tags":["UserWorkspaceDatatankParts"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/part/{datatank_part_id}/command":{"post":{"description":"Run user workspace Datatank table partition command. Valid commands are: refresh.","operationId":"userWorkspaceDatatankPart_command","parameters":[{"description":"The handle of the user.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The name of the workspace Datatank table.","in":"path","name":"datatank_table_name","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The id of the workspace Datatank table partition.","in":"path","name":"datatank_part_id","required":true,"schema":{"format":"^dtc_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmdDatatankPartRequest"}}},"description":"The request body for the datatank part command.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatatankPart"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Run user workspace Datatank table partition command","tags":["UserWorkspaceDatatankParts"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/table/{datatank_part_id}":{"get":{"description":"Get the details for the workspace Datatank table partition","operationId":"userWorkspaceDatatankPart_get","parameters":[{"description":"The handle of the user.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the workspace Datatank.","in":"path","name":"datatank_handle","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The name of the workspace Datatank table.","in":"path","name":"datatank_table_name","required":true,"schema":{"format":"^[A-Za-z_][A-Za-z_0-9$]*$","type":"string"}},{"description":"The id of the workspace Datatank table partition.","in":"path","name":"datatank_part_id","required":true,"schema":{"format":"^dtc_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatatankPart"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace Datatank table partition","tags":["UserWorkspaceDatatankParts"]}},"/user/{user_handle}/workspace/{workspace_handle}/db_log":{"get":{"description":"Returns the workspace logs for a user.","operationId":"userWorkspace_listDBLogs","parameters":[{"description":"Specify the user handle to get the workspace logs.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace whose logs needs to be fetched.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLogsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"User workspace logs","tags":["UserWorkspaces"]}},"/user/{user_handle}/workspace/{workspace_handle}/flowpipe/form/{step_execution_id}/{random_id}":{"get":{"description":"Get details of a Flowpipe input step form for a user workspace","operationId":"userWorkspaceFlowpipeForm_get","parameters":[{"description":"The handle of the user to which the workspace belongs.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to which the Flowpipe input belongs.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The execution ID of the step to which the Flowpipe input belongs.","in":"path","name":"step_execution_id","required":true,"schema":{"format":"^sexec_[0-9a-v]{20}$","type":"string"}},{"description":"The random ID used to verify the input response.","in":"path","name":"random_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowpipeInput"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace flowpipe form","tags":["UserWorkspaceFlowpipeInputs"]}},"/user/{user_handle}/workspace/{workspace_handle}/flowpipe/form/{step_execution_id}/{random_id}/submit":{"post":{"description":"Submit response to a Flowpipe input step form for a user workspace","operationId":"userWorkspaceFlowpipeFormResponse_post","parameters":[{"description":"The handle of the user to which the workspace belongs.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to which the Flowpipe input belongs.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The execution ID of the step to which the Flowpipe input belongs.","in":"path","name":"step_execution_id","required":true,"schema":{"format":"^sexec_[0-9a-v]{20}$","type":"string"}},{"description":"The random ID used to verify the input response.","in":"path","name":"random_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowpipeFormResponse"}}},"description":"The request body for the response to the Flowpipe input form.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowpipeInput"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Post user workspace flowpipe form response","tags":["UserWorkspaceFlowpipeInputs"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/flowpipe/input":{"get":{"description":"List Flowpipe inputs for a user workspace","operationId":"userWorkspaceFlowpipeInputs_list","parameters":[{"description":"The handle of the user to which the workspace belongs.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to which the Flowpipe inputs belong.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFlowpipeInputsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace flowpipe inputs","tags":["UserWorkspaceFlowpipeInputs"]},"post":{"description":"Create a Flowpipe input for a user workspace","operationId":"userWorkspaceFlowpipeInput_create","parameters":[{"description":"The handle of the user to which the workspace belongs.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to create the Flowpipe input against.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFlowpipeInputRequest"}}},"description":"The request body for the Flowpipe input.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowpipeInput"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user workspace flowpipe input","tags":["UserWorkspaceFlowpipeInputs"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/flowpipe/input/{input_id}":{"get":{"description":"Get details of a Flowpipe input for a user workspace","operationId":"userWorkspaceFlowpipeInput_get","parameters":[{"description":"The handle of the user to which the workspace belongs.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to which the Flowpipe input belongs.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The ID of the Flowpipe input. Optionally can pass the step execution ID in lieu of the input ID.","in":"path","name":"input_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowpipeInput"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace flowpipe input","tags":["UserWorkspaceFlowpipeInputs"]}},"/user/{user_handle}/workspace/{workspace_handle}/flowpipe/mod":{"post":{"description":"Install flowpipe mod to a user's workspace","operationId":"userWorkspaceFlowpipeMod_install","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod will be installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceModRequest"}},"multipart/form-data":{"schema":{"properties":{"file":{"description":"The mod file to be uploaded.","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"description":"The request body to install a mod in the mentioned workspace for this user.","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Install flowpipe mod to a user's workspace","tags":["UserWorkspaceFlowpipeMods"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/flowpipe/mod/{mod_alias}":{"delete":{"description":"Uninstall flowpipe mod from a user's workspace","operationId":"userWorkspaceFlowpipeMod_uninstall","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID to delete.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Uninstall flowpipe mod from a user's workspace.","tags":["UserWorkspaceFlowpipeMods"]},"get":{"description":"Get user workspace installed flowpipe mod by mod alias","operationId":"userWorkspaceFlowpipeMod_get","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Provide the handle of the workspace where mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace installed flowpipe mod","tags":["UserWorkspaceFlowpipeMods"]},"patch":{"description":"Update a flowpipe mod in a user's workspace","operationId":"userWorkspaceFlowpipeMod_update","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod will be updated.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID to update.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceModRequest"}},"multipart/form-data":{"schema":{"properties":{"file":{"description":"The mod file to be uploaded.","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"description":"The request body to update a mod for this workspace.","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update a flowpipe mod in a user's workspace","tags":["UserWorkspaceFlowpipeMods"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/flowpipe/mod/{mod_alias}/variable":{"get":{"description":"List all variables applicable for a flowpipe mod in a workspace specific to a user","operationId":"userWorkspaceFlowpipeModVariable_list","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where mods were installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID for which we want the variables to be listed.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceModVariablesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List variables for a user workspace flowpipe mod","tags":["UserWorkspaceFlowpipeModVariables"]},"post":{"description":"Create a setting for a flowpipe mod variable in a user workspace","operationId":"userWorkspaceFlowpipeModVariable_createSetting","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID for which the variable setting is to be created.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceModVariableSettingRequest"}}},"description":"The request body to create setting for mod variable in the user workspace.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create a setting for a flowpipe mod variable in a user workspace","tags":["UserWorkspaceFlowpipeModVariables"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/flowpipe/mod/{mod_alias}/variable/{variable_name}":{"delete":{"description":"Delete setting for a flowpipe mod variable in a user workspace","operationId":"userWorkspaceFlowpipeModVariable_deleteSetting","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID for which the variable setting is to be deleted.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The name of the variable to delete the setting for.","in":"path","name":"variable_name","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete setting for a flowpipe mod variable in a user workspace","tags":["UserWorkspaceFlowpipeModVariables"]},"get":{"description":"Get setting for a flowpipe mod variable in a user workspace","operationId":"userWorkspaceFlowpipeModVariable_getSetting","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID for which the variable setting belongs to.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The name of the variable to get the setting for.","in":"path","name":"variable_name","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get setting for a flowpipe mod variable in a user workspace","tags":["UserWorkspaceFlowpipeModVariables"]},"patch":{"description":"Update setting for a flowpipe mod variable in a user workspace","operationId":"userWorkspaceFlowpipeModVariable_updateSetting","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID which contains the variable.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The name of the variable for which setting is to be updated.","in":"path","name":"variable_name","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceModVariableSettingRequest"}}},"description":"The request body to update setting for mod variable in the user workspace.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update setting for a flowpipe mod variable in a user workspace","tags":["UserWorkspaceFlowpipeModVariables"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/flowpipe/pipeline":{"get":{"description":"Lists the pipelines for a user workspace.","operationId":"userWorkspaceFlowpipePipeline_list","parameters":[{"description":"The handle of the user for which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace for which we want to list the pipelines.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFlowpipePipelinesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace pipelines","tags":["UserWorkspaceFlowpipePipelines"]}},"/user/{user_handle}/workspace/{workspace_handle}/flowpipe/pipeline/{pipeline_id}":{"get":{"description":"Get the details of a pipeline for a workspace of a user.","operationId":"userWorkspaceFlowpipePipeline_get","parameters":[{"description":"The handle of the user which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The id of the pipeline whose detail needs to be fetched.","in":"path","name":"pipeline_id","required":true,"schema":{"format":"^pipe_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModPipeline"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace pipeline","tags":["UserWorkspaceFlowpipePipelines"]}},"/user/{user_handle}/workspace/{workspace_handle}/flowpipe/pipeline/{pipeline_id}/trigger":{"get":{"description":"Get the list of triggers that a pipeline is associated with.","operationId":"userWorkspaceFlowpipePipeline_listTriggers","parameters":[{"description":"The handle of the user which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The id of the pipeline whose triggers need to be fetched.","in":"path","name":"pipeline_id","required":true,"schema":{"format":"^pipe_[0-9a-v]{20}$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFlowpipeTriggersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace pipeline triggers","tags":["UserWorkspaceFlowpipePipelines"]}},"/user/{user_handle}/workspace/{workspace_handle}/flowpipe/pipeline/{pipeline_name}/command":{"post":{"description":"Run a command on a pipeline in a workspace belonging to a user.","operationId":"userWorkspaceFlowpipePipeline_command","parameters":[{"description":"The handle of the user which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the Flowpipe pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"Identifier of the Flowpipe pipeline on which the command will be run.","in":"path","name":"pipeline_name","required":true,"schema":{"format":"^modp_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineCommandRequest"}}},"description":"The request body of the pipeline command to run.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineCommandResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Run user workspace Flowpipe pipeline command","tags":["UserWorkspaceFlowpipePipelines"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/flowpipe/trigger/{trigger_name}":{"delete":{"description":"Deletes the pipeline specified in the request for a workspace of a user.","operationId":"userWorkspaceFlowpipeTrigger_delete","parameters":[{"description":"The handle of the user which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The name of the trigger which needs to be deleted.","in":"path","name":"trigger_name","required":true,"schema":{"format":"^modt[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user workspace pipeline","tags":["UserWorkspaceFlowpipeTriggers"]},"get":{"description":"Get the details of a trigger for a workspace of a user.","operationId":"userWorkspaceFlowpipeTrigger_get","parameters":[{"description":"The handle of the user which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the trigger exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The name of the flowpipe trigger whose details needs to be fetched.","in":"path","name":"trigger_name","required":true,"schema":{"format":"^pipe_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModTrigger"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace flowpipe trigger","tags":["UserWorkspaceFlowpipeTriggers"]},"patch":{"description":"Updates a trigger for a workspace of a user.","operationId":"userWorkspaceFlowpipeTrigger_update","parameters":[{"description":"The handle of the user which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the trigger exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The name of the trigger which needs to be updated.","in":"path","name":"trigger_name","required":true,"schema":{"format":"^modt_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTriggerRequest"}}},"description":"The request body for the trigger which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModTrigger"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user workspace trigger","tags":["UserWorkspaceFlowpipeTriggers"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/flowpipe/trigger/{trigger_name}/command":{"post":{"description":"Run a command on a trigger in a workspace belonging to a user.","operationId":"userWorkspaceFlowpipeTrigger_command","parameters":[{"description":"The handle of the user which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the Flowpipe trigger exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"Identifier of the Flowpipe trigger on which the command will be run.","in":"path","name":"trigger_name","required":true,"schema":{"format":"^modp_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCommandRequest"}}},"description":"The request body of the trigger command to run.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCommandResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Run user workspace Flowpipe trigger command","tags":["UserWorkspaceFlowpipeTriggers"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/integration":{"get":{"description":"List integrations available for a user workspace. If run on a custom tenant this will return integrations configured both on tenant and user level.","operationId":"userWorkspaceIntegration_list","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace for whom you want to list available integrations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListIntegrationsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace integrations","tags":["UserWorkspaceIntegrations"]}},"/user/{user_handle}/workspace/{workspace_handle}/integration/{integration_handle}":{"get":{"description":"Get details of an integration available for a workspace belonging to a user.","operationId":"userWorkspaceIntegration_get","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace for which we want to get the integration details.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration whose details need to be retrieved.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace integration","tags":["UserWorkspaceIntegrations"]}},"/user/{user_handle}/workspace/{workspace_handle}/integration/{integration_handle}/github/repository":{"get":{"description":"List respositories that are given access to the integration available for a user workspace.","operationId":"userWorkspaceIntegration_listGithubRepositories","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace for whom you want to list available integrations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration for which permitted repositories will be listed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGithubRepositoriesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace integration github respositories","tags":["UserWorkspaceIntegrations"]}},"/user/{user_handle}/workspace/{workspace_handle}/integration/{integration_handle}/github/repository/{repository_owner}/{repository_name}/head":{"get":{"description":"List heads for a respository of an integration available for a user workspace.","operationId":"userWorkspaceIntegration_listGithubRepositoryHeads","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace for whom you want to list available integrations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration for which heads will be listed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The owner of the repository.","in":"path","name":"repository_owner","required":true,"schema":{"type":"string"}},{"description":"The name of the repository for which heads will be listed.","in":"path","name":"repository_name","required":true,"schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGithubRepositoryBranchesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace integration github respository heads","tags":["UserWorkspaceIntegrations"]}},"/user/{user_handle}/workspace/{workspace_handle}/integration/{integration_handle}/gitlab/project":{"get":{"description":"List gitlab proejcts that are given access to the integration available for a user workspace.","operationId":"userWorkspaceIntegration_listGitlabProjects","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace for whom you want to list available integrations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration for which permitted repositories will be listed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGitlabProjectsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace integration gitlab projects","tags":["UserWorkspaceIntegrations"]}},"/user/{user_handle}/workspace/{workspace_handle}/integration/{integration_handle}/gitlab/project/{project_id}/branch":{"get":{"description":"List branches for a gitlab project of an integration available for a user workspace.","operationId":"userWorkspaceIntegration_listGitlabProjectBranches","parameters":[{"description":"The handle of the user to which the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace for whom you want to list available integrations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the integration for which heads will be listed.","in":"path","name":"integration_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The id of the project including the namespace and the name.","in":"path","name":"project_id","required":true,"schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGitlabProjectBranchesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace integration gitlab project branches","tags":["UserWorkspaceIntegrations"]}},"/user/{user_handle}/workspace/{workspace_handle}/mod":{"get":{"description":"List user workspace installed mods","operationId":"userWorkspaceMod_list","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where mods were installed","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceModsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace installed mods","tags":["UserWorkspaceMods"]},"post":{"description":"Install a mod to a user's workspace","operationId":"userWorkspaceMod_install","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod will be installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceModRequest"}},"multipart/form-data":{"schema":{"properties":{"file":{"description":"The mod file to be uploaded.","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"description":"The request body to install a mod in the mentioned workspace for this user.","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Install a mod to a user's workspace","tags":["UserWorkspaceMods"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/mod/{mod_alias}":{"delete":{"description":"Uninstall mod from a user's workspace","operationId":"userWorkspaceMod_uninstall","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID to delete.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Uninstall mod from a user's workspace.","tags":["UserWorkspaceMods"]},"get":{"description":"Get user workspace installed mod by mod alias","operationId":"userWorkspaceMod_get","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"Provide the handle of the workspace where mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace installed mod","tags":["UserWorkspaceMods"]},"patch":{"description":"Update a mod in a user's workspace","operationId":"userWorkspaceMod_update","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod will be updated.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID to update.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceModRequest"}},"multipart/form-data":{"schema":{"properties":{"file":{"description":"The mod file to be uploaded.","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"description":"The request body to update a mod for this workspace.","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMod"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update a mod in a user's workspace","tags":["UserWorkspaceMods"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable":{"get":{"description":"List all variables applicable for a mod in a workspace specific to a user","operationId":"userWorkspaceModVariable_list","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where mods were installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID for which we want the variables to be listed.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceModVariablesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List variables for a user workspace mod","tags":["UserWorkspaceModVariables"]},"post":{"description":"Create a setting for a mod variable in a user workspace","operationId":"userWorkspaceModVariable_createSetting","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID for which the variable setting is to be created.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceModVariableSettingRequest"}}},"description":"The request body to create setting for mod variable in the user workspace.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create a setting for a mod variable in a user workspace","tags":["UserWorkspaceModVariables"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable/{variable_name}":{"delete":{"description":"Delete setting for a mod variable in a user workspace","operationId":"userWorkspaceModVariable_deleteSetting","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID for which the variable setting is to be deleted.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The name of the variable to delete the setting for.","in":"path","name":"variable_name","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete setting for a mod variable in a user workspace","tags":["UserWorkspaceModVariables"]},"get":{"description":"Get setting for a mod variable in a user workspace","operationId":"userWorkspaceModVariable_getSetting","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID for which the variable setting belongs to.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The name of the variable to get the setting for.","in":"path","name":"variable_name","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get setting for a mod variable in a user workspace","tags":["UserWorkspaceModVariables"]},"patch":{"description":"Update setting for a mod variable in a user workspace","operationId":"userWorkspaceModVariable_updateSetting","parameters":[{"description":"The handle of the user who owns the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the mod was installed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The mod alias or mod ID which contains the variable.","in":"path","name":"mod_alias","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}},{"description":"The name of the variable for which setting is to be updated.","in":"path","name":"variable_name","required":true,"schema":{"format":"^[a-z0-9-_]{1,40}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceModVariableSettingRequest"}}},"description":"The request body to update setting for mod variable in the user workspace.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModVariable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update setting for a mod variable in a user workspace","tags":["UserWorkspaceModVariables"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/notifier":{"get":{"description":"List all notifiers for a user workspace","operationId":"userWorkspaceNotifier_list","parameters":[{"description":"The handle of the user for which the notifiers are to be listed.","in":"path","name":"user_handle","required":true,"schema":{"type":"string"}},{"description":"The handle of the workspace for which the notifiers are to be listed.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The maximum number of items to return.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"The token to retrieve the next page.","in":"query","name":"next_token","schema":{"type":"string"}},{"description":"The filter to apply to the list.","in":"query","name":"where","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNotifiersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace notifiers","tags":["UserWorkspaceNotifiers"]},"post":{"description":"Create a new notifier for a user workspace","operationId":"userWorkspaceNotifier_create","parameters":[{"description":"The handle of the user for which the notifier is to be created.","in":"path","name":"user_handle","required":true,"schema":{"type":"string"}},{"description":"The handle of the workspace for which the notifier is to be created.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNotifierRequest"}}},"description":"The request body for the notifier to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user workspace notifier","tags":["UserWorkspaceNotifiers"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/notifier/{notifier_name}":{"delete":{"description":"Delete a notifier for a user workspace","operationId":"userWorkspaceNotifier_delete","parameters":[{"description":"The handle of the user for which the notifier is to be deleted.","in":"path","name":"user_handle","required":true,"schema":{"type":"string"}},{"description":"The handle of the workspace for which the notifier is to be deleted.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The name of the notifier to be deleted.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user workspace notifier","tags":["UserWorkspaceNotifiers"]},"get":{"description":"Get a notifier for a user workspace","operationId":"userWorkspaceNotifier_get","parameters":[{"description":"The handle of the user for which the notifier is to be retrieved.","in":"path","name":"user_handle","required":true,"schema":{"type":"string"}},{"description":"The handle of the workspace for which the notifier is to be retrieved.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The name of the notifier to be retrieved.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace notifier","tags":["UserWorkspaceNotifiers"]},"patch":{"description":"Update a notifier for a user workspace","operationId":"userWorkspaceNotifier_update","parameters":[{"description":"The handle of the user for which the notifier is to be updated.","in":"path","name":"user_handle","required":true,"schema":{"type":"string"}},{"description":"The handle of the workspace for which the notifier is to be updated.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The name of the notifier to be updated.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNotifierRequest"}}},"description":"The request body for the notifier to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifier"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user workspace notifier","tags":["UserWorkspaceNotifiers"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/notifier/{notifier_name}/command":{"post":{"description":"Post a command for a notifier for a users workspace","operationId":"userWorkspaceNotifierCommand_post","parameters":[{"description":"The handle of the user for which the notifier is to be updated.","in":"path","name":"user_handle","required":true,"schema":{"type":"string"}},{"description":"The handle of the workspace for which the notifier is to be updated.","in":"path","name":"workspace_handle","required":true,"schema":{"type":"string"}},{"description":"The name of the notifier for which the command is to be posted.","in":"path","name":"notifier_name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceNotifierCommandRequest"}}},"description":"The request body for the notifier command to be posted.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceNotifierCommandResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Implemented"}},"summary":"Post user workspace notifier commands","tags":["UserWorkspaceNotifiers"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/pipeline":{"get":{"description":"Lists the pipelines for a workspace of a user.","operationId":"userWorkspacePipeline_list","parameters":[{"description":"The handle of the user for which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace for which we want to list the pipelines.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPipelinesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace pipelines","tags":["UserWorkspacePipelines"]},"post":{"description":"Creates a new pipeline for a workspace of a user.","operationId":"userWorkspacePipeline_create","parameters":[{"description":"The handle of the user which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where we want to create the pipeline.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePipelineRequest"}}},"description":"The request body for the pipeline to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user workspace pipeline","tags":["UserWorkspacePipelines"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/pipeline/{pipeline_id}":{"delete":{"description":"Deletes the pipeline specified in the request for a workspace of a user.","operationId":"userWorkspacePipeline_delete","parameters":[{"description":"The handle of the user which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"Provide the id of the pipeline which needs to be deleted.","in":"path","name":"pipeline_id","required":true,"schema":{"format":"^pipe_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user workspace pipeline","tags":["UserWorkspacePipelines"]},"get":{"description":"Get the details of a pipeline for a workspace of a user.","operationId":"userWorkspacePipeline_get","parameters":[{"description":"The handle of the user which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The id of the pipeline whose detail needs to be fetched.","in":"path","name":"pipeline_id","required":true,"schema":{"format":"^pipe_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace pipeline","tags":["UserWorkspacePipelines"]},"patch":{"description":"Updates a pipeline for a workspace of a user.","operationId":"userWorkspacePipeline_update","parameters":[{"description":"The handle of the user which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The id of the pipeline which needs to be updated.","in":"path","name":"pipeline_id","required":true,"schema":{"format":"^pipe_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePipelineRequest"}}},"description":"The request body for the pipeline which needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user workspace pipeline","tags":["UserWorkspacePipelines"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/pipeline/{pipeline_id}/command":{"post":{"description":"Run a command on a pipeline in a workspace belonging to a user.","operationId":"userWorkspacePipeline_command","parameters":[{"description":"The handle of the user which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the pipeline exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"Id of the pipeline on which the command will be run.","in":"path","name":"pipeline_id","required":true,"schema":{"format":"^pipe_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineCommandRequest"}}},"description":"The request body of the pipeline command to run.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineCommandResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Run user workspace pipeline command","tags":["UserWorkspacePipelines"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/process":{"get":{"description":"List the process associated with a user workspace.","operationId":"userWorkspaceProcess_list","parameters":[{"description":"The handle of the user for which you want to start listing processes.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where you want to list the processes.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProcessesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace processes","tags":["UserWorkspaceProcesses"]}},"/user/{user_handle}/workspace/{workspace_handle}/process/{process_id}":{"get":{"description":"Get the details for a user workspace process.","operationId":"userWorkspaceProcess_get","parameters":[{"description":"The handle of the user where the workspace exist.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace whose process needs to be fetched.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The id of the process to be fetched.","in":"path","name":"process_id","required":true,"schema":{"format":"^[a-z]{1,3}_[0-9a-v]{20}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpProcess"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace process","tags":["UserWorkspaceProcesses"]}},"/user/{user_handle}/workspace/{workspace_handle}/process/{process_id}/command":{"post":{"description":"Run a command against a users workspace process.","operationId":"userWorkspaceProcess_command","parameters":[{"description":"The handle of the user where we want to run the workspace process command.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where the process command will be executed.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The id of the process where the command will be executed against.","in":"path","name":"process_id","required":true,"schema":{"format":"^[a-z]{1,3}_[0-9a-v]{20}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceProcessCommandRequest"}}},"description":"The request body for the workspace process command.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceProcessCommandResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Implemented"}},"summary":"Run user workspace process command","tags":["UserWorkspaceProcesses"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/process/{process_id}/log/{log_file}.{content_type}":{"get":{"description":"List the process logs associated with a workspace process.","operationId":"userWorkspaceProcess_log","parameters":[{"description":"The handle of the user where the workspace exist.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where you want to list the process logs.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The id of the process where you want to list the process logs.","in":"path","name":"process_id","required":true,"schema":{"format":"^[a-z]{1,3}_[0-9a-v]{20}$","type":"string"}},{"description":"The process logs file to be fetched.","in":"path","name":"log_file","required":true,"schema":{"enum":["process"],"type":"string"}},{"description":"The required content type of the process logs.","in":"path","name":"content_type","required":true,"schema":{"enum":["jsonl"],"type":"string"}}],"responses":{"200":{"content":{"application/jsonlines+json":{"schema":{"type":"string"}}},"description":"OK"},"204":{"content":{"application/jsonlines+json":{"schema":{"type":"string"}}},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace process logs","tags":["UserWorkspaceProcesses"]}},"/user/{user_handle}/workspace/{workspace_handle}/query":{"get":{"description":"Performs a query in a user workspace. Results are limited to 5000 rows or 30 seconds of query execution.","operationId":"userWorkspace_getQuery","parameters":[{"description":"The handle of the user that the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to query.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The sql query to perform against the user workspace.","in":"query","name":"sql","required":true,"schema":{"type":"string"}},{"description":"The required content type for the response. Defaults to application/json. Supported values are json, application/json, csv, text/csv, md and text/markdown.","in":"query","name":"content_type","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"OK"},"206":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"Partial Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Query user workspace","tags":["UserWorkspaces"]},"post":{"description":"Performs a query in a user workspace. Results are limited to 5000 rows or 30 seconds of query execution.","operationId":"userWorkspace_postQuery","parameters":[{"description":"The handle of the user that the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to query.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The required content type for the response. Defaults to application/json. Supported values are json, application/json, csv, text/csv, md and text/markdown.","in":"query","name":"content_type","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/csv":{"schema":{"type":"string"}},"text/markdown":{"schema":{"type":"string"}}},"description":"The sql query to perform against the user workspace.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"OK"},"206":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"Partial Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Query user workspace","tags":["UserWorkspaces"],"x-codegen-request-body-name":"sql"}},"/user/{user_handle}/workspace/{workspace_handle}/query/data.{extensions}":{"get":{"description":"Performs a query in a user workspace, with content type and content encoding forming part of the API path. Results are limited to 5000 rows or 30 seconds of query execution.","operationId":"userWorkspace_getQueryWithExtensions","parameters":[{"description":"The handle of the user that the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to query.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The content type for the request. E.g. ","in":"path","name":"extensions","required":true,"schema":{"type":"string"}},{"description":"The sql query to perform against the user workspace.","in":"query","name":"sql","required":true,"schema":{"type":"string"}},{"description":"The required content type for the response. Defaults to application/json. Supported values are json, application/json, csv, text/csv, md and text/markdown.","in":"query","name":"content_type","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"OK"},"206":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"Partial Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Query user workspace with extensions","tags":["UserWorkspaces"]},"post":{"description":"Performs a query in a user workspace, with content type and content encoding forming part of the API path. Results are limited to 5000 rows or 30 seconds of query execution.","operationId":"userWorkspace_postQueryWithExtensions","parameters":[{"description":"The handle of the user that the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to query.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The content type for the request. E.g. ","in":"path","name":"extensions","required":true,"schema":{"type":"string"}},{"description":"The sql query to perform against the user workspace.","in":"query","name":"sql","required":true,"schema":{"type":"string"}},{"description":"The required content type for the response. Defaults to application/json. Supported values are json, application/json, csv, text/csv, md and text/markdown.","in":"query","name":"content_type","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"OK"},"206":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/csv":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/WorkspaceQueryResult"}}},"description":"Partial Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"text/markdown":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Query user workspace with extensions","tags":["UserWorkspaces"]}},"/user/{user_handle}/workspace/{workspace_handle}/schema":{"get":{"description":"List the schemas for the user workspace. This will consist of the aggregators, datatanks and identity-level connections associated with the workspace.","operationId":"userWorkspaceSchema_list","parameters":[{"description":"The handle of the user that the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace to get the schemas for.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceSchemaResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace schemas","tags":["UserWorkspaceSchemas"]},"post":{"description":"Attach an identity-level connection schema to a user workspace.","operationId":"userWorkspaceSchema_attach","parameters":[{"description":"The handle of the user that the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the schema will be attached.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachWorkspaceSchemaRequest"}}},"description":"The request body for the schema to be attached.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSchema"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Attach a schema to a user workspace","tags":["UserWorkspaceSchemas"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/schema/{schema_name}":{"delete":{"description":"Detach an identity-level connection schema from a user workspace.","operationId":"userWorkspaceSchema_detach","parameters":[{"description":"The handle of the user that the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace from which the schema will be detached.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the schema that will be detached.","in":"path","name":"schema_name","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSchema"}}},"description":"Created"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Detach a schema from a user workspace","tags":["UserWorkspaceSchemas"]},"get":{"description":"Get the details for a user workspace schema.","operationId":"userWorkspaceSchema_get","parameters":[{"description":"The handle of the user that the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the schema exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the schema whose detail needs to be fetched.","in":"path","name":"schema_name","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSchema"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace schema","tags":["UserWorkspaceSchemas"]}},"/user/{user_handle}/workspace/{workspace_handle}/schema/{schema_name}/table":{"get":{"description":"List the tables for a user workspace schema.","operationId":"userWorkspaceSchema_listTables","parameters":[{"description":"The handle of the user that the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the schema exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the schema whose detail needs to be fetched.","in":"path","name":"schema_name","required":true,"schema":{"format":"^[a-z][a-z0-9_]{0,37}[a-z0-9]?$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceSchemaTableResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace schema tables","tags":["UserWorkspaceSchemas"]}},"/user/{user_handle}/workspace/{workspace_handle}/schema/{schema_name}/table/{table_name}":{"get":{"description":"Get details about a specific table in a user workspace schema.","operationId":"userWorkspaceSchema_getTable","parameters":[{"description":"The handle of the user that the workspace belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where the schema exists.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The name of the schema to which the table belongs.","in":"path","name":"schema_name","required":true,"schema":{"type":"string"}},{"description":"The name of the table whose detail needs to be fetched.","in":"path","name":"table_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSchemaTable"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace schema table","tags":["UserWorkspaceSchemas"]}},"/user/{user_handle}/workspace/{workspace_handle}/snapshot":{"get":{"description":"List the workspace snapshots for a user.","operationId":"userWorkspaceSnapshot_list","parameters":[{"description":"The handle of the user to list the workspace snapshots for.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace to list snapshots for.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkspaceSnapshotsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace snapshots","tags":["UserWorkspaceSnapshots"]},"post":{"description":"Creates a new workspace snapshot for a user.","operationId":"userWorkspaceSnapshot_create","parameters":[{"description":"The handle of the user to create the workspace snapshot for.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the user workspace to create the snapshot for.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceSnapshotRequest"}}},"description":"The request body for the user workspace snapshot to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSnapshot"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user workspace snapshot","tags":["UserWorkspaceSnapshots"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/snapshot/{snapshot_id}":{"delete":{"description":"Deletes a user workspace snapshot.","operationId":"userWorkspaceSnapshot_delete","parameters":[{"description":"The handle of the user that the workspace snapshot belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the user workspace that the snapshot belongs to.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the snapshot which needs to be deleted.","in":"path","name":"snapshot_id","required":true,"schema":{"format":"^snap_[0-9a-v]{20}_[0-9a-z]{19,26}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSnapshot"}}},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete user workspace snapshot","tags":["UserWorkspaceSnapshots"]},"get":{"description":"Get the details for a user workspace snapshot.","operationId":"userWorkspaceSnapshot_get","parameters":[{"description":"The handle of the user that the workspace snapshot belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the user workspace that the snapshot belongs to.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the snapshot whose detail needs to be fetched.","in":"path","name":"snapshot_id","required":true,"schema":{"format":"^snap_[0-9a-v]{20}_[0-9a-z]{19,26}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSnapshot"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get user workspace snapshot","tags":["UserWorkspaceSnapshots"]},"patch":{"description":"Updates a user workspace snapshot.","operationId":"userWorkspaceSnapshot_update","parameters":[{"description":"The handle of the user that the workspace snapshot belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the user workspace that the snapshot belongs to.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The handle of the snapshot to update.","in":"path","name":"snapshot_id","required":true,"schema":{"format":"^snap_[0-9a-v]{20}_[0-9a-z]{19,26}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceSnapshotRequest"}}},"description":"The request body for the user workspace snapshot to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSnapshot"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Update user workspace snapshot","tags":["UserWorkspaceSnapshots"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/snapshot/{snapshot_id}.{content_type}":{"get":{"description":"Downloads the full data for a user workspace snapshot.","operationId":"userWorkspaceSnapshot_download","parameters":[{"description":"The handle of the user that the workspace snapshot belongs to.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the user workspace that the snapshot belongs to.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The Id of the snapshot to be downloaded.","in":"path","name":"snapshot_id","required":true,"schema":{"type":"string"}},{"description":"The type of content to the downloaded.","in":"path","name":"content_type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSnapshotData"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Download user workspace snapshot","tags":["UserWorkspaceSnapshots"]},"servers":[{"description":"Pipes user workspace snapshot download API","url":"https://pipes.turbot.com/download"}]},"/user/{user_handle}/workspace/{workspace_handle}/trigger":{"get":{"description":"Lists the triggers for a user workspace.","operationId":"userWorkspaceFlowpipeTrigger_list","parameters":[{"description":"The handle of the user for which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace for which we want to list the triggers.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTriggersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace triggers","tags":["UserWorkspaceFlowpipeTriggers"]},"post":{"description":"Creates a new trigger for a user workspace.","operationId":"userWorkspaceFlowpipeTrigger_create","parameters":[{"description":"The handle of the user which contains the workspace.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}},{"description":"The handle of the workspace where we want to create the trigger.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTriggerRequest"}}},"description":"The request body for the trigger to be created.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceModTrigger"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Payment Required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create user workspace trigger","tags":["UserWorkspaceFlowpipeTriggers"],"x-codegen-request-body-name":"request"}},"/user/{user_handle}/workspace/{workspace_handle}/usage":{"get":{"description":"List the usage associated with a user workspace.","operationId":"userWorkspaceUsage_list","parameters":[{"description":"The handle of the user for which you want to start listing associations.","in":"path","name":"user_handle","required":true,"schema":{"format":"^[a-z0-9][a-z0-9-]{0,37}[a-z0-9]$","type":"string"}},{"description":"The handle of the workspace where you want to list the associations.","in":"path","name":"workspace_handle","required":true,"schema":{"format":"^[a-z0-9]{1,23}$","type":"string"}},{"description":"The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.","in":"query","name":"where","schema":{"type":"string"}},{"description":"The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.","in":"query","name":"next_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsageMetricsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"List user workspace usage","tags":["UserWorkspaceUsages"]}}},"servers":[{"description":"Pipes API base URL","url":"https://pipes.turbot.com/api/v0"}],"x-original-swagger-version":"2.0"}