@directus/app 9.12.0 → 9.13.0

package/dist/assets/flows.5f5e16d5.js

@@ -0,0 +1,172 @@
+import{a as o,o as c,b as d,w as l,g as s,e as a,B as e}from"./runtime-core.esm-bundler.e6808e6c.js";const i={class:"markdown-body"},p=s("div",{class:"two-up"},[s("div",{class:"left"},[s("blockquote",null,[s("p",null,"Flows enable custom, event-driven data processing and task automation within Directus.")])]),s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-flow-object"},"The Flow Object")]),s("li",null,[s("a",{href:"#list-flows"},"List Flows")]),s("li",null,[s("a",{href:"#retrieve-a-flow"},"Retrieve a flow")]),s("li",null,[s("a",{href:"#create-a-flow"},"Create a Flow")]),s("li",null,[s("a",{href:"#create-multiple-flows"},"Create Multiple Flows")]),s("li",null,[s("a",{href:"#update-a-flow"},"Update a Flow")]),s("li",null,[s("a",{href:"#update-multiple-flows"},"Update Multiple Flows")]),s("li",null,[s("a",{href:"#delete-a-flow"},"Delete a Flow")]),s("li",null,[s("a",{href:"#delete-multiple-flows"},"Delete Multiple Flows")]),s("li",null,[s("a",{href:"#flow-with-get-webhook-trigger"},"Flow with GET webhook trigger")]),s("li",null,[s("a",{href:"#flow-with-post-webhook-trigger"},"Flow with POST webhook trigger")])])])])])],-1),u=s("hr",null,null,-1),f=s("h2",{id:"the-flow-object"},[e("The Flow Object "),s("a",{class:"header-anchor",href:"#the-flow-object"},"#")],-1),_={class:"two-up"},g={class:"left"},w={class:"definitions"},m=s("p",null,[s("code",null,"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the flow.")],-1),j=s("p",null,[s("code",null,"name"),e(),s("strong",null,"string"),s("br"),e(" Name for the flow.")],-1),y=s("p",null,[s("code",null,"icon"),e(),s("strong",null,"string"),s("br"),e(" Icon displayed in the Admin App for the flow.")],-1),b=s("p",null,[s("code",null,"color"),e(),s("strong",null,"string"),s("br"),e(" Color of the icon displayed in the Admin App for the flow.")],-1),q=s("p",null,[s("code",null,"note"),e(),s("strong",null,"text"),s("br"),e(" Short description displayed in the Admin App.")],-1),x=s("p",null,[s("code",null,"status"),e(),s("strong",null,"string"),s("br"),e(" Current status of the flow. One of "),s("code",null,"active"),e(", "),s("code",null,"inactive"),e(". Defaults to "),s("code",null,"active"),e(" when not specified.")],-1),v=s("p",null,[s("code",null,"trigger"),e(),s("strong",null,"string"),s("br"),e(" Type of trigger for the flow. One of "),s("code",null,"hook"),e(", "),s("code",null,"webhook"),e(", "),s("code",null,"operation"),e(", "),s("code",null,"schedule"),e(", "),s("code",null,"manual"),e(".")],-1),E=s("p",null,[s("code",null,"options"),e(),s("strong",null,"json"),s("br"),e(" Options of the selected trigger for the flow.")],-1),T=s("p",null,[s("code",null,"accountability"),e(),s("strong",null,"string"),s("br"),e(" The permission used during the flow. One of "),s("code",null,"$public"),e(", "),s("code",null,"$trigger"),e(", "),s("code",null,"$full"),e(", or UUID of a role.")],-1),k=s("p",null,[s("code",null,"date_created"),e(),s("strong",null,"timestamp"),s("br"),e(" Timestamp in ISO8601 when the flow was created.")],-1),P=s("code",null,"user_created",-1),S=e(),R=s("strong",null,"many-to-one",-1),F=s("br",null,null,-1),A=e(" The user who created the flow. Many-to-one to "),O=e("users"),D=e("."),I=s("p",null,[s("code",null,"operation"),e(),s("strong",null,"string"),s("br"),e(" UUID of the operation connected to the trigger in the flow.")],-1),M=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
+	`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-string"},'"2fab3b9d-0543-4b87-8a30-3c5ee66fedf1"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Flow"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"bolt"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"color"'),e(": "),s("span",{class:"hljs-string"},'"#112233"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"note"'),e(": "),s("span",{class:"hljs-string"},'"Note for my flow"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"manual"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"accountability"'),e(": "),s("span",{class:"hljs-string"},'"$trigger"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"date_created"'),e(": "),s("span",{class:"hljs-string"},'"2022-05-11T13:14:52Z"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"user_created"'),e(": "),s("span",{class:"hljs-string"},'"12e62fd0-29c7-4fd3-b3d3-c7a39933e8af"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"operation"'),e(": "),s("span",{class:"hljs-string"},'"92e82998-e421-412f-a513-13701e83e4ce"'),e(`
+}
+`)])])],-1),C=s("hr",null,null,-1),L=s("h2",{id:"list-flows"},[e("List Flows "),s("a",{class:"header-anchor",href:"#list-flows"},"#")],-1),G=s("p",null,"List all flows that exist in Directus.",-1),Q={class:"two-up"},U={class:"left"},B=s("h3",{id:"query-parameters"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),H=e("Supports all "),N=e("global query parameters"),$=e("."),V=s("h3",{id:"returns"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),Z=e("An array of up to "),z=e("limit"),J=e(),K=s("a",{href:"#the-flow-object"},"flow objects",-1),W=e(". If no items are available, data will be an empty array."),X={class:"right"},Y=s("h3",{id:"rest-api"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),ss=s("pre",null,[s("code",null,`GET /flows
+SEARCH /flows
+`)],-1),es=e("Learn more about SEARCH ->"),ls=s("h3",{id:"graphql"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),ts=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),as=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+	flows: [directus_flows]
+}
+`)])],-1),ns=s("h5",{id:"example"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),os=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
+	flows {
+		id
+		name
+		status
+	}
+}
+`)])],-1),rs=s("hr",null,null,-1),hs=s("h2",{id:"retrieve-a-flow"},[e("Retrieve a flow "),s("a",{class:"header-anchor",href:"#retrieve-a-flow"},"#")],-1),cs=s("p",null,"List an existing flow by primary key.",-1),ds={class:"two-up"},is={class:"left"},ps=s("h3",{id:"query-parameters-2"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),us=e("Supports all "),fs=e("global query parameters"),_s=e("."),gs=s("h3",{id:"returns-2"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),ws=s("p",null,[e("Returns the requested "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),ms=s("div",{class:"right"},[s("h3",{id:"rest-api-2"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",null,`GET /flows/:id
+`)]),s("h5",{id:"example-2"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",null,`GET /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2
+`)]),s("h3",{id:"graphql-2"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+	flows_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_flows
+}
+`)])]),s("h5",{id:"example-3"},[e("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
+	flows_by_id(id: `),s("span",{class:"hljs-string"},'"2fc325fb-299b-4d20-a9e7-a34349dee8b2"'),e(`) {
+		id
+		name
+		status
+	}
+}
+`)])])],-1),js=s("hr",null,null,-1),ys=s("h2",{id:"create-a-flow"},[e("Create a Flow "),s("a",{class:"header-anchor",href:"#create-a-flow"},"#")],-1),bs=s("p",null,"Create a new flow.",-1),qs={class:"two-up"},xs={class:"left"},vs=s("h3",{id:"query-parameters-3"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Es=e("Supports all "),Ts=e("global query parameters"),ks=e("."),Ps=s("h3",{id:"request-body"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ss=s("p",null,[e("A partial "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),Rs=s("h3",{id:"returns-3"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),Fs=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the created flow.")],-1),As=s("div",{class:"right"},[s("h3",{id:"rest-api-3"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",null,`POST /flows
+`)]),s("h5",{id:"example-4"},[e("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows"),e(`
+
+{
+	`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Flow"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"manual"'),e(`
+}
+`)])]),s("h3",{id:"graphql-3"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	create_flows_item(data: create_directus_flows_input!): directus_flows
+}
+`)])]),s("h5",{id:"example-5"},[e("Example "),s("a",{class:"header-anchor",href:"#example-5"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	create_flows_item(data: { name: `),s("span",{class:"hljs-string"},'"My Flow"'),e(", status: "),s("span",{class:"hljs-string"},'"active"'),e(", trigger: "),s("span",{class:"hljs-string"},'"manual"'),e(` }) {
+		id
+		name
+		status
+	}
+}
+`)])])],-1),Os=s("hr",null,null,-1),Ds=s("h2",{id:"create-multiple-flows"},[e("Create Multiple Flows "),s("a",{class:"header-anchor",href:"#create-multiple-flows"},"#")],-1),Is=s("p",null,"Create multiple new flows.",-1),Ms={class:"two-up"},Cs={class:"left"},Ls=s("h3",{id:"query-parameters-4"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Gs=e("Supports all "),Qs=e("global query parameters"),Us=e("."),Bs=s("h3",{id:"request-body-2"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Hs=s("p",null,[e("An array of partial "),s("a",{href:"#the-flow-object"},"flow objects"),e(".")],-1),Ns=s("h3",{id:"returns-4"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),$s=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the created flow.")],-1),Vs=s("div",{class:"right"},[s("h3",{id:"rest-api-4"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",null,`POST /flows
+`)]),s("h5",{id:"example-6"},[e("Example "),s("a",{class:"header-anchor",href:"#example-6"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows"),e(`
+
+[
+	{
+		`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Flow"'),e(`,
+		`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+		`),s("span",{class:"hljs-attr"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"manual"'),e(`
+	},
+	{
+		`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Another Flow"'),e(`,
+		`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+		`),s("span",{class:"hljs-attr"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"webhook"'),e(`
+	}
+]
+`)])]),s("h3",{id:"graphql-4"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	create_flows_items(data: [create_directus_flows_input!]!): [directus_flows]
+}
+`)])]),s("h5",{id:"example-7"},[e("Example "),s("a",{class:"header-anchor",href:"#example-7"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	create_flows_items(
+		data: [
+			{
+				`),s("span",{class:"hljs-string"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Flow"'),e(`,
+				`),s("span",{class:"hljs-string"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+				`),s("span",{class:"hljs-string"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"manual"'),e(`
+			},
+			{
+				`),s("span",{class:"hljs-string"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Another Flow"'),e(`,
+				`),s("span",{class:"hljs-string"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+				`),s("span",{class:"hljs-string"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"webhook"'),e(`
+			}
+		]
+	) {
+		id
+		name
+		status
+	}
+}
+`)])])],-1),Zs=s("hr",null,null,-1),zs=s("h2",{id:"update-a-flow"},[e("Update a Flow "),s("a",{class:"header-anchor",href:"#update-a-flow"},"#")],-1),Js=s("p",null,"Update an existing flow.",-1),Ks={class:"two-up"},Ws={class:"left"},Xs=s("h3",{id:"query-parameters-5"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Ys=e("Supports all "),se=e("global query parameters"),ee=e("."),le=s("h3",{id:"request-body-3"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),te=s("p",null,[e("A partial "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),ae=s("h3",{id:"returns-5"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),ne=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the updated flow.")],-1),oe=s("div",{class:"right"},[s("h3",{id:"rest-api-5"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",null,`PATCH /flows/:id
+`)]),s("h5",{id:"example-8"},[e("Example "),s("a",{class:"header-anchor",href:"#example-8"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2"),e(`
+
+{
+	`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Updated Flow"'),e(`
+}
+`)])]),s("h3",{id:"graphql-5"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	update_flows_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_flows_input): directus_flows
+}
+`)])]),s("h5",{id:"example-9"},[e("Example "),s("a",{class:"header-anchor",href:"#example-9"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	update_flows_item(id: `),s("span",{class:"hljs-string"},'"2fc325fb-299b-4d20-a9e7-a34349dee8b2"'),e(", data: { name: "),s("span",{class:"hljs-string"},'"My Updated Flow"'),e(` }) {
+		id
+		name
+	}
+}
+`)])])],-1),re=s("hr",null,null,-1),he=s("h2",{id:"update-multiple-flows"},[e("Update Multiple Flows "),s("a",{class:"header-anchor",href:"#update-multiple-flows"},"#")],-1),ce=s("p",null,"Update multiple existing flows.",-1),de={class:"two-up"},ie={class:"left"},pe=s("h3",{id:"query-parameters-6"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),ue=e("Supports all "),fe=e("global query parameters"),_e=e("."),ge=s("h3",{id:"request-body-4"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),we=s("div",{class:"definitions"},[s("p",null,[s("code",null,"keys"),e(),s("strong",null,"Required"),s("br"),e(" Array of primary keys of the flows you\u2019d like to update.")]),s("p",null,[s("code",null,"data"),e(),s("strong",null,"Required"),s("br"),e(" Any of "),s("a",{href:"#the-flow-object"},"the flow object"),e("\u2019s properties.")])],-1),me=s("h3",{id:"returns-6"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),je=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow objects"),e(" for the updated flows.")],-1),ye=s("div",{class:"right"},[s("h3",{id:"rest-api-6"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),s("pre",null,[s("code",null,`PATCH /flows
+`)]),s("h5",{id:"example-10"},[e("Example "),s("a",{class:"header-anchor",href:"#example-10"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /flows"),e(`
+
+{
+	`),s("span",{class:"hljs-attr"},'"keys"'),e(": ["),s("span",{class:"hljs-string"},'"3f2facab-7f05-4ee8-a7a3-d8b9c634a1fc"'),e(", "),s("span",{class:"hljs-string"},'"7259bfa8-3786-45c6-8c08-cc688e7ba229"'),e(`],
+	`),s("span",{class:"hljs-attr"},'"data"'),e(`: {
+		`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"inactive"'),e(`
+	}
+}
+`)])]),s("h3",{id:"graphql-6"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-6"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	update_flows_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_flows_input): [directus_flows]
+}
+`)])]),s("h5",{id:"example-11"},[e("Example "),s("a",{class:"header-anchor",href:"#example-11"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	update_flows_items(
+		ids: [`),s("span",{class:"hljs-string"},'"3f2facab-7f05-4ee8-a7a3-d8b9c634a1fc"'),e(", "),s("span",{class:"hljs-string"},'"7259bfa8-3786-45c6-8c08-cc688e7ba229"'),e(`]
+		data: { status: `),s("span",{class:"hljs-string"},'"inactive"'),e(` }
+	) {
+		id
+		name
+		status
+	}
+}
+`)])])],-1),be=s("hr",null,null,-1),qe=s("h2",{id:"delete-a-flow"},[e("Delete a Flow "),s("a",{class:"header-anchor",href:"#delete-a-flow"},"#")],-1),xe=s("p",null,"Delete an existing flow.",-1),ve=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-7"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-7"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-7"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),s("pre",null,[s("code",null,`DELETE /flows/:id
+`)]),s("h5",{id:"example-12"},[e("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),s("pre",null,[s("code",null,`DELETE /flows/12204ee2-2c82-4d9a-b044-2f4842a11dba
+`)]),s("h3",{id:"graphql-7"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-7"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	delete_flows_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): delete_one
+}
+`)])]),s("h5",{id:"example-13"},[e("Example "),s("a",{class:"header-anchor",href:"#example-13"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	delete_flows_item(id: `),s("span",{class:"hljs-string"},'"12204ee2-2c82-4d9a-b044-2f4842a11dba"'),e(`) {
+		id
+	}
+}
+`)])])])],-1),Ee=s("hr",null,null,-1),Te=s("h2",{id:"delete-multiple-flows"},[e("Delete Multiple Flows "),s("a",{class:"header-anchor",href:"#delete-multiple-flows"},"#")],-1),ke=s("p",null,"Delete multiple existing flows.",-1),Pe=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-5"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-5"},"#")]),s("p",null,"An array of flows primary keys"),s("h3",{id:"returns-8"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-8"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-8"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),s("pre",null,[s("code",null,`DELETE /flows
+`)]),s("h5",{id:"example-14"},[e("Example "),s("a",{class:"header-anchor",href:"#example-14"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// DELETE /flows"),e(`
+[`),s("span",{class:"hljs-string"},'"25821236-8c2a-4f89-8fdc-c7d01f35877d"'),e(", "),s("span",{class:"hljs-string"},'"02b9486e-4273-4fd5-b94b-e18fd923d1ed"'),e(", "),s("span",{class:"hljs-string"},'"7d62f1e9-a83f-407b-84f8-1c184f014501"'),e(`]
+`)])]),s("h3",{id:"graphql-8"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-8"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	delete_flows_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!): delete_many
+}
+`)])]),s("h5",{id:"example-15"},[e("Example "),s("a",{class:"header-anchor",href:"#example-15"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	delete_flows_items(
+		ids: [
+			`),s("span",{class:"hljs-string"},'"25821236-8c2a-4f89-8fdc-c7d01f35877d"'),e(`
+			`),s("span",{class:"hljs-string"},'"02b9486e-4273-4fd5-b94b-e18fd923d1ed"'),e(`
+			`),s("span",{class:"hljs-string"},'"7d62f1e9-a83f-407b-84f8-1c184f014501"'),e(`
+		]
+	) {
+		ids
+	}
+}
+`)])])])],-1),Se=s("h2",{id:"flow-with-get-webhook-trigger"},[e("Flow with GET webhook trigger "),s("a",{class:"header-anchor",href:"#flow-with-get-webhook-trigger"},"#")],-1),Re=s("p",null,"Start a flow with GET webhook trigger.",-1),Fe=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-9"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-9"},"#")]),s("p",null,"Result of the flow, if any.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-9"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-9"},"#")]),s("pre",null,[s("code",null,`GET /flows/trigger/:flow_uuid
+`)]),s("h5",{id:"example-16"},[e("Example "),s("a",{class:"header-anchor",href:"#example-16"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// GET /flows/trigger/202a940b-a00b-47df-b832-369c53f13122"),e(`
+`),s("span",{class:"hljs-comment"},"// Payload here"),e(`
+`)])])])],-1),Ae=s("h2",{id:"flow-with-post-webhook-trigger"},[e("Flow with POST webhook trigger "),s("a",{class:"header-anchor",href:"#flow-with-post-webhook-trigger"},"#")],-1),Oe=s("p",null,"Start a flow with POST webhook trigger.",-1),De=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-6"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-6"},"#")]),s("p",null,"Payload for the POST request."),s("h3",{id:"returns-10"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-10"},"#")]),s("p",null,"Result of the flow, if any.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-10"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-10"},"#")]),s("pre",null,[s("code",null,`POST /flows/trigger/:flow_uuid
+`)]),s("h5",{id:"example-17"},[e("Example "),s("a",{class:"header-anchor",href:"#example-17"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows/trigger/202a940b-a00b-47df-b832-369c53f13122"),e(`
+`),s("span",{class:"hljs-comment"},"// Payload here"),e(`
+`)])])])],-1),Ge="Flows",Qe=!1,Ue="page-reference",Be={name:"flows",setup(Ie,{expose:r}){const n={title:"Flows",modularExtension:!1,pageClass:"page-reference"};return r({frontmatter:n}),(Me,Ce)=>{const t=o("router-link"),h=o("docs-wrapper");return c(),d(h,{frontmatter:n},{default:l(()=>[s("div",i,[p,u,f,s("div",_,[s("div",g,[s("div",w,[m,j,y,b,q,x,v,E,T,k,s("p",null,[P,S,R,F,A,a(t,{to:"/docs/reference/system/users/#the-users-object"},{default:l(()=>[O]),_:1}),D]),I])]),M]),C,L,G,s("div",Q,[s("div",U,[B,s("p",null,[H,a(t,{to:"/docs/reference/query"},{default:l(()=>[N]),_:1}),$]),V,s("p",null,[Z,a(t,{to:"/docs/reference/query/#limit"},{default:l(()=>[z]),_:1}),J,K,W])]),s("div",X,[Y,ss,s("p",null,[a(t,{to:"/docs/reference/introduction/#search-http-method"},{default:l(()=>[es]),_:1})]),ls,ts,as,ns,os])]),rs,hs,cs,s("div",ds,[s("div",is,[ps,s("p",null,[us,a(t,{to:"/docs/reference/query"},{default:l(()=>[fs]),_:1}),_s]),gs,ws]),ms]),js,ys,bs,s("div",qs,[s("div",xs,[vs,s("p",null,[Es,a(t,{to:"/docs/reference/query"},{default:l(()=>[Ts]),_:1}),ks]),Ps,Ss,Rs,Fs]),As]),Os,Ds,Is,s("div",Ms,[s("div",Cs,[Ls,s("p",null,[Gs,a(t,{to:"/docs/reference/query"},{default:l(()=>[Qs]),_:1}),Us]),Bs,Hs,Ns,$s]),Vs]),Zs,zs,Js,s("div",Ks,[s("div",Ws,[Xs,s("p",null,[Ys,a(t,{to:"/docs/reference/query"},{default:l(()=>[se]),_:1}),ee]),le,te,ae,ne]),oe]),re,he,ce,s("div",de,[s("div",ie,[pe,s("p",null,[ue,a(t,{to:"/docs/reference/query"},{default:l(()=>[fe]),_:1}),_e]),ge,we,me,je]),ye]),be,qe,xe,ve,Ee,Te,ke,Pe,Se,Re,Fe,Ae,Oe,De])]),_:1})}}};export{Be as default,Qe as modularExtension,Ue as pageClass,Ge as title};

package/dist/assets/{folders.5102c9ea.js → folders.56c9a624.js}

@@ -1,13 +1,13 @@
-import{w as n,y as h,z as c,A as a,E as e,C as t,W as s}from"./vendor.f6090249.js";const i={class:"markdown-body"},p=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,"Folders can be used to organize files within the platform. Folders are virtual, and aren\u2019t mirrored within the storage adapter.")])]),e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-folder-object"},"The Folder Object")]),e("li",null,[e("a",{href:"#list-folders"},"List Folders")]),e("li",null,[e("a",{href:"#retrieve-a-folder"},"Retrieve a Folder")]),e("li",null,[e("a",{href:"#create-a-folder"},"Create a Folder")]),e("li",null,[e("a",{href:"#create-multiple-folders"},"Create Multiple Folders")]),e("li",null,[e("a",{href:"#update-a-folder"},"Update a Folder")]),e("li",null,[e("a",{href:"#update-multiple-folders"},"Update Multiple Folders")]),e("li",null,[e("a",{href:"#delete-a-folder"},"Delete a Folder")]),e("li",null,[e("a",{href:"#delete-multiple-folders"},"Delete Multiple Folders")])])])])])],-1),u=e("hr",null,null,-1),_=e("h2",{id:"the-folder-object"},[s("The Folder Object "),e("a",{class:"header-anchor",href:"#the-folder-object"},"#")],-1),f=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"definitions"},[e("p",null,[e("code",null,"id"),s(),e("strong",null,"uuid"),e("br"),s(" Primary key of the folder.")]),e("p",null,[e("code",null,"name"),s(),e("strong",null,"string"),e("br"),s(" Name of the folder.")]),e("p",null,[e("code",null,"parent"),s(),e("strong",null,"many-to-one"),e("br"),s(" Parent folder. Many-to-one to folders (recursive).")])])]),e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[s(`{
+import{a as n,o as h,b as c,w as a,g as e,e as t,B as s}from"./runtime-core.esm-bundler.e6808e6c.js";const i={class:"markdown-body"},p=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,"Folders can be used to organize files within the platform. Folders are virtual, and aren\u2019t mirrored within the storage adapter.")])]),e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-folder-object"},"The Folder Object")]),e("li",null,[e("a",{href:"#list-folders"},"List Folders")]),e("li",null,[e("a",{href:"#retrieve-a-folder"},"Retrieve a Folder")]),e("li",null,[e("a",{href:"#create-a-folder"},"Create a Folder")]),e("li",null,[e("a",{href:"#create-multiple-folders"},"Create Multiple Folders")]),e("li",null,[e("a",{href:"#update-a-folder"},"Update a Folder")]),e("li",null,[e("a",{href:"#update-multiple-folders"},"Update Multiple Folders")]),e("li",null,[e("a",{href:"#delete-a-folder"},"Delete a Folder")]),e("li",null,[e("a",{href:"#delete-multiple-folders"},"Delete Multiple Folders")])])])])])],-1),u=e("hr",null,null,-1),_=e("h2",{id:"the-folder-object"},[s("The Folder Object "),e("a",{class:"header-anchor",href:"#the-folder-object"},"#")],-1),f=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"definitions"},[e("p",null,[e("code",null,"id"),s(),e("strong",null,"uuid"),e("br"),s(" Primary key of the folder.")]),e("p",null,[e("code",null,"name"),s(),e("strong",null,"string"),e("br"),s(" Name of the folder.")]),e("p",null,[e("code",null,"parent"),s(),e("strong",null,"many-to-one"),e("br"),s(" Parent folder. Many-to-one to folders (recursive).")])])]),e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[s(`{
 	`),e("span",{class:"hljs-attr"},'"data"'),s(`: {
 		`),e("span",{class:"hljs-attr"},'"id"'),s(": "),e("span",{class:"hljs-string"},'"fc02d733-95b8-4e27-bd4b-08a32cbe4e66"'),s(`,
 		`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Test"'),s(`,
 		`),e("span",{class:"hljs-attr"},'"parent"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`
 	}
 }
-`)])])])],-1),m=e("hr",null,null,-1),g=e("h2",{id:"list-folders"},[s("List Folders "),e("a",{class:"header-anchor",href:"#list-folders"},"#")],-1),y=e("p",null,"List all folders that exist in Directus.",-1),b={class:"two-up"},j={class:"left"},q=e("h3",{id:"query-parameters"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),x=s("Supports all "),v=s("global query parameters"),E=s("."),w=e("h3",{id:"returns"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),T=s("An array of up to "),P=s("limit"),R=s(),k=e("a",{href:"#the-folder-object"},"folder objects",-1),S=s(". If no items are available, data will be an empty array."),A={class:"right"},F=e("h3",{id:"rest-api"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),D=e("pre",null,[e("code",null,`GET /folders
+`)])])])],-1),m=e("hr",null,null,-1),g=e("h2",{id:"list-folders"},[s("List Folders "),e("a",{class:"header-anchor",href:"#list-folders"},"#")],-1),y=e("p",null,"List all folders that exist in Directus.",-1),b={class:"two-up"},j={class:"left"},q=e("h3",{id:"query-parameters"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),x=s("Supports all "),v=s("global query parameters"),E=s("."),w=e("h3",{id:"returns"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),T=s("An array of up to "),P=s("limit"),R=s(),k=e("a",{href:"#the-folder-object"},"folder objects",-1),S=s(". If no items are available, data will be an empty array."),F={class:"right"},A=e("h3",{id:"rest-api"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),C=e("pre",null,[e("code",null,`GET /folders
 SEARCH /folders
-`)],-1),C=s("Learn more about SEARCH ->"),L=e("h3",{id:"graphql"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),Q=e("pre",null,[e("code",null,`POST /graphql/system
+`)],-1),D=s("Learn more about SEARCH ->"),L=e("h3",{id:"graphql"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),Q=e("pre",null,[e("code",null,`POST /graphql/system
 `)],-1),I=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
 	folders: directus_folders
 }
@@ -16,7 +16,7 @@ SEARCH /folders
 		name
 	}
 }
-`)])],-1),G=e("hr",null,null,-1),B=e("h2",{id:"retrieve-a-folder"},[s("Retrieve a Folder "),e("a",{class:"header-anchor",href:"#retrieve-a-folder"},"#")],-1),N=e("p",null,"List all folders that exist in Directus.",-1),H={class:"two-up"},U={class:"left"},V=e("h3",{id:"query-parameters-2"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),W=s("Supports all "),z=s("global query parameters"),J=s("."),K=e("h3",{id:"returns-2"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),X=e("p",null,[s("Returns a "),e("a",{href:"#the-folder-object"},"folder object"),s(" if a valid primary key was provided.")],-1),Y=e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`GET /folders/:id
+`)])],-1),G=e("hr",null,null,-1),B=e("h2",{id:"retrieve-a-folder"},[s("Retrieve a Folder "),e("a",{class:"header-anchor",href:"#retrieve-a-folder"},"#")],-1),N=e("p",null,"List all folders that exist in Directus.",-1),H={class:"two-up"},U={class:"left"},V=e("h3",{id:"query-parameters-2"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),z=s("Supports all "),J=s("global query parameters"),K=s("."),W=e("h3",{id:"returns-2"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),X=e("p",null,[s("Returns a "),e("a",{href:"#the-folder-object"},"folder object"),s(" if a valid primary key was provided.")],-1),Y=e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`GET /folders/:id
 `)]),e("h5",{id:"example-2"},[s("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",null,`GET /folders/fc02d733-95b8-4e27-bd4b-08a32cbe4e66
 `)]),e("h3",{id:"graphql-2"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
 `)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
@@ -64,7 +64,7 @@ SEARCH /folders
 		name
 	}
 }
-`)])])],-1),Te=e("hr",null,null,-1),Pe=e("h2",{id:"update-a-folder"},[s("Update a Folder "),e("a",{class:"header-anchor",href:"#update-a-folder"},"#")],-1),Re=e("p",null,"Update an existing folder.",-1),ke={class:"two-up"},Se={class:"left"},Ae=e("h3",{id:"query-parameters-5"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Fe=s("Supports all "),De=s("global query parameters"),Ce=s("."),Le=e("h3",{id:"request-body-3"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),Qe=e("p",null,[s("A partial "),e("a",{href:"#the-folder-object"},"folder object"),s(".")],-1),Ie=e("h3",{id:"returns-5"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),Oe=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was updated.")],-1),Me=e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`PATCH /folders/:id
+`)])])],-1),Te=e("hr",null,null,-1),Pe=e("h2",{id:"update-a-folder"},[s("Update a Folder "),e("a",{class:"header-anchor",href:"#update-a-folder"},"#")],-1),Re=e("p",null,"Update an existing folder.",-1),ke={class:"two-up"},Se={class:"left"},Fe=e("h3",{id:"query-parameters-5"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Ae=s("Supports all "),Ce=s("global query parameters"),De=s("."),Le=e("h3",{id:"request-body-3"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),Qe=e("p",null,[s("A partial "),e("a",{href:"#the-folder-object"},"folder object"),s(".")],-1),Ie=e("h3",{id:"returns-5"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),Oe=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was updated.")],-1),Me=e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`PATCH /folders/:id
 `)]),e("h5",{id:"example-8"},[s("Example "),e("a",{class:"header-anchor",href:"#example-8"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /folders/fac21847-d5ce-4e4b-a288-9abafbdfbc87"),s(`
 
 {
@@ -83,7 +83,7 @@ SEARCH /folders
 		name
 	}
 }
-`)])])],-1),Ge=e("hr",null,null,-1),Be=e("h2",{id:"update-multiple-folders"},[s("Update Multiple Folders "),e("a",{class:"header-anchor",href:"#update-multiple-folders"},"#")],-1),Ne=e("p",null,"Update multiple existing folders.",-1),He={class:"two-up"},Ue={class:"left"},Ve=e("h3",{id:"query-parameters-6"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),We=s("Supports all "),ze=s("global query parameters"),Je=s("."),Ke=e("h3",{id:"request-body-4"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),Xe=e("div",{class:"definitions"},[e("p",null,[e("code",null,"keys"),s(),e("strong",null,"Required"),e("br"),s(" Array of primary keys of the folders you\u2019d like to update.")]),e("p",null,[e("code",null,"data"),s(),e("strong",null,"Required"),e("br"),s(" Any of "),e("a",{href:"#the-folder-object"},"the folder object"),s("\u2019s properties.")])],-1),Ye=e("h3",{id:"returns-6"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),Ze=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder objects"),s(" of the folders that were updated.")],-1),$e=e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`PATCH /folders
+`)])])],-1),Ge=e("hr",null,null,-1),Be=e("h2",{id:"update-multiple-folders"},[s("Update Multiple Folders "),e("a",{class:"header-anchor",href:"#update-multiple-folders"},"#")],-1),Ne=e("p",null,"Update multiple existing folders.",-1),He={class:"two-up"},Ue={class:"left"},Ve=e("h3",{id:"query-parameters-6"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),ze=s("Supports all "),Je=s("global query parameters"),Ke=s("."),We=e("h3",{id:"request-body-4"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),Xe=e("div",{class:"definitions"},[e("p",null,[e("code",null,"keys"),s(),e("strong",null,"Required"),e("br"),s(" Array of primary keys of the folders you\u2019d like to update.")]),e("p",null,[e("code",null,"data"),s(),e("strong",null,"Required"),e("br"),s(" Any of "),e("a",{href:"#the-folder-object"},"the folder object"),s("\u2019s properties.")])],-1),Ye=e("h3",{id:"returns-6"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),Ze=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder objects"),s(" of the folders that were updated.")],-1),$e=e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`PATCH /folders
 `)]),e("h5",{id:"example-10"},[s("Example "),e("a",{class:"header-anchor",href:"#example-10"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /folders"),s(`
 
 {
@@ -129,4 +129,4 @@ SEARCH /folders
 		ids
 	}
 }
-`)])])])],-1),ps={setup(os,{expose:d}){const r={title:"Folders",modularExtension:!1,pageClass:"page-reference"};return d({frontmatter:r}),(hs,cs)=>{const l=n("router-link"),o=n("DocsWrapper");return h(),c(o,{frontmatter:r},{default:a(()=>[e("div",i,[p,u,_,f,m,g,y,e("div",b,[e("div",j,[q,e("p",null,[x,t(l,{to:"/docs/reference/query"},{default:a(()=>[v]),_:1}),E]),w,e("p",null,[T,t(l,{to:"/docs/reference/query/#limit"},{default:a(()=>[P]),_:1}),R,k,S])]),e("div",A,[F,D,e("p",null,[t(l,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[C]),_:1})]),L,Q,I,O,M])]),G,B,N,e("div",H,[e("div",U,[V,e("p",null,[W,t(l,{to:"/docs/reference/query"},{default:a(()=>[z]),_:1}),J]),K,X]),Y]),Z,$,ee,e("div",se,[e("div",ae,[le,e("p",null,[te,t(l,{to:"/docs/reference/query"},{default:a(()=>[re]),_:1}),ne]),de,oe,he,ce]),ie]),pe,ue,_e,e("div",fe,[e("div",me,[ge,e("p",null,[ye,t(l,{to:"/docs/reference/query"},{default:a(()=>[be]),_:1}),je]),qe,xe,ve,Ee]),we]),Te,Pe,Re,e("div",ke,[e("div",Se,[Ae,e("p",null,[Fe,t(l,{to:"/docs/reference/query"},{default:a(()=>[De]),_:1}),Ce]),Le,Qe,Ie,Oe]),Me]),Ge,Be,Ne,e("div",He,[e("div",Ue,[Ve,e("p",null,[We,t(l,{to:"/docs/reference/query"},{default:a(()=>[ze]),_:1}),Je]),Ke,Xe,Ye,Ze]),$e]),es,ss,as,ls,ts,rs,ns,ds])]),_:1})}}};export{ps as default};
+`)])])])],-1),ps="Folders",us=!1,_s="page-reference",fs={name:"folders",setup(os,{expose:d}){const r={title:"Folders",modularExtension:!1,pageClass:"page-reference"};return d({frontmatter:r}),(hs,cs)=>{const l=n("router-link"),o=n("docs-wrapper");return h(),c(o,{frontmatter:r},{default:a(()=>[e("div",i,[p,u,_,f,m,g,y,e("div",b,[e("div",j,[q,e("p",null,[x,t(l,{to:"/docs/reference/query"},{default:a(()=>[v]),_:1}),E]),w,e("p",null,[T,t(l,{to:"/docs/reference/query/#limit"},{default:a(()=>[P]),_:1}),R,k,S])]),e("div",F,[A,C,e("p",null,[t(l,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[D]),_:1})]),L,Q,I,O,M])]),G,B,N,e("div",H,[e("div",U,[V,e("p",null,[z,t(l,{to:"/docs/reference/query"},{default:a(()=>[J]),_:1}),K]),W,X]),Y]),Z,$,ee,e("div",se,[e("div",ae,[le,e("p",null,[te,t(l,{to:"/docs/reference/query"},{default:a(()=>[re]),_:1}),ne]),de,oe,he,ce]),ie]),pe,ue,_e,e("div",fe,[e("div",me,[ge,e("p",null,[ye,t(l,{to:"/docs/reference/query"},{default:a(()=>[be]),_:1}),je]),qe,xe,ve,Ee]),we]),Te,Pe,Re,e("div",ke,[e("div",Se,[Fe,e("p",null,[Ae,t(l,{to:"/docs/reference/query"},{default:a(()=>[Ce]),_:1}),De]),Le,Qe,Ie,Oe]),Me]),Ge,Be,Ne,e("div",He,[e("div",Ue,[Ve,e("p",null,[ze,t(l,{to:"/docs/reference/query"},{default:a(()=>[Je]),_:1}),Ke]),We,Xe,Ye,Ze]),$e]),es,ss,as,ls,ts,rs,ns,ds])]),_:1})}}};export{fs as default,us as modularExtension,_s as pageClass,ps as title};

package/dist/assets/forth.127a7f69.js

@@ -0,0 +1 @@
+import{A}from"./index.876852bd.entry.js";function S(f,O){return O.forEach(function(E){E&&typeof E!="string"&&!Array.isArray(E)&&Object.keys(E).forEach(function(i){if(i!=="default"&&!(i in f)){var R=Object.getOwnPropertyDescriptor(E,i);Object.defineProperty(f,i,R.get?R:{enumerable:!0,get:function(){return E[i]}})}})}),Object.freeze(Object.defineProperty(f,Symbol.toStringTag,{value:"Module"}))}var u={exports:{}};(function(f,O){(function(E){E(A.exports)})(function(E){function i(n){var r=[];return n.split(" ").forEach(function(e){r.push({name:e})}),r}var R=i("INVERT AND OR XOR 2* 2/ LSHIFT RSHIFT 0= = 0< < > U< MIN MAX 2DROP 2DUP 2OVER 2SWAP ?DUP DEPTH DROP DUP OVER ROT SWAP >R R> R@ + - 1+ 1- ABS NEGATE S>D * M* UM* FM/MOD SM/REM UM/MOD */ */MOD / /MOD MOD HERE , @ ! CELL+ CELLS C, C@ C! CHARS 2@ 2! ALIGN ALIGNED +! ALLOT CHAR [CHAR] [ ] BL FIND EXECUTE IMMEDIATE COUNT LITERAL STATE ; DOES> >BODY EVALUATE SOURCE >IN <# # #S #> HOLD SIGN BASE >NUMBER HEX DECIMAL FILL MOVE . CR EMIT SPACE SPACES TYPE U. .R U.R ACCEPT TRUE FALSE <> U> 0<> 0> NIP TUCK ROLL PICK 2>R 2R@ 2R> WITHIN UNUSED MARKER I J TO COMPILE, [COMPILE] SAVE-INPUT RESTORE-INPUT PAD ERASE 2LITERAL DNEGATE D- D+ D0< D0= D2* D2/ D< D= DMAX DMIN D>S DABS M+ M*/ D. D.R 2ROT DU< CATCH THROW FREE RESIZE ALLOCATE CS-PICK CS-ROLL GET-CURRENT SET-CURRENT FORTH-WORDLIST GET-ORDER SET-ORDER PREVIOUS SEARCH-WORDLIST WORDLIST FIND ALSO ONLY FORTH DEFINITIONS ORDER -TRAILING /STRING SEARCH COMPARE CMOVE CMOVE> BLANK SLITERAL"),a=i("IF ELSE THEN BEGIN WHILE REPEAT UNTIL RECURSE [IF] [ELSE] [THEN] ?DO DO LOOP +LOOP UNLOOP LEAVE EXIT AGAIN CASE OF ENDOF ENDCASE");E.defineMode("forth",function(){function n(r,e){var t;for(t=r.length-1;t>=0;t--)if(r[t].name===e.toUpperCase())return r[t]}return{startState:function(){return{state:"",base:10,coreWordList:R,immediateWordList:a,wordList:[]}},token:function(r,e){var t;if(r.eatSpace())return null;if(e.state===""){if(r.match(/^(\]|:NONAME)(\s|$)/i))return e.state=" compilation","builtin compilation";if(t=r.match(/^(\:)\s+(\S+)(\s|$)+/),t)return e.wordList.push({name:t[2].toUpperCase()}),e.state=" compilation","def"+e.state;if(t=r.match(/^(VARIABLE|2VARIABLE|CONSTANT|2CONSTANT|CREATE|POSTPONE|VALUE|WORD)\s+(\S+)(\s|$)+/i),t)return e.wordList.push({name:t[2].toUpperCase()}),"def"+e.state;if(t=r.match(/^(\'|\[\'\])\s+(\S+)(\s|$)+/),t)return"builtin"+e.state}else{if(r.match(/^(\;|\[)(\s)/))return e.state="",r.backUp(1),"builtin compilation";if(r.match(/^(\;|\[)($)/))return e.state="","builtin compilation";if(r.match(/^(POSTPONE)\s+\S+(\s|$)+/))return"builtin"}if(t=r.match(/^(\S+)(\s+|$)/),t)return n(e.wordList,t[1])!==void 0?"variable"+e.state:t[1]==="\\"?(r.skipToEnd(),"comment"+e.state):n(e.coreWordList,t[1])!==void 0?"builtin"+e.state:n(e.immediateWordList,t[1])!==void 0?"keyword"+e.state:t[1]==="("?(r.eatWhile(function(o){return o!==")"}),r.eat(")"),"comment"+e.state):t[1]===".("?(r.eatWhile(function(o){return o!==")"}),r.eat(")"),"string"+e.state):t[1]==='S"'||t[1]==='."'||t[1]==='C"'?(r.eatWhile(function(o){return o!=='"'}),r.eat('"'),"string"+e.state):t[1]-68719476735?"number"+e.state:"atom"+e.state}}}),E.defineMIME("text/x-forth","forth")})})();var T=u.exports,D=S({__proto__:null,default:T},[u.exports]);export{D as f};

package/dist/assets/fortran.64d2bcc8.js

@@ -0,0 +1 @@
+import{A as h}from"./index.876852bd.entry.js";function x(o,s){return s.forEach(function(n){n&&typeof n!="string"&&!Array.isArray(n)&&Object.keys(n).forEach(function(i){if(i!=="default"&&!(i in o)){var c=Object.getOwnPropertyDescriptor(n,i);Object.defineProperty(o,i,c.get?c:{enumerable:!0,get:function(){return n[i]}})}})}),Object.freeze(Object.defineProperty(o,Symbol.toStringTag,{value:"Module"}))}var u={exports:{}};(function(o,s){(function(n){n(h.exports)})(function(n){n.defineMode("fortran",function(){function i(t){for(var r={},e=0;e<t.length;++e)r[t[e]]=!0;return r}var c=i(["abstract","accept","allocatable","allocate","array","assign","asynchronous","backspace","bind","block","byte","call","case","class","close","common","contains","continue","cycle","data","deallocate","decode","deferred","dimension","do","elemental","else","encode","end","endif","entry","enumerator","equivalence","exit","external","extrinsic","final","forall","format","function","generic","go","goto","if","implicit","import","include","inquire","intent","interface","intrinsic","module","namelist","non_intrinsic","non_overridable","none","nopass","nullify","open","optional","options","parameter","pass","pause","pointer","print","private","program","protected","public","pure","read","recursive","result","return","rewind","save","select","sequence","stop","subroutine","target","then","to","type","use","value","volatile","where","while","write"]),f=i(["abort","abs","access","achar","acos","adjustl","adjustr","aimag","aint","alarm","all","allocated","alog","amax","amin","amod","and","anint","any","asin","associated","atan","besj","besjn","besy","besyn","bit_size","btest","cabs","ccos","ceiling","cexp","char","chdir","chmod","clog","cmplx","command_argument_count","complex","conjg","cos","cosh","count","cpu_time","cshift","csin","csqrt","ctime","c_funloc","c_loc","c_associated","c_null_ptr","c_null_funptr","c_f_pointer","c_null_char","c_alert","c_backspace","c_form_feed","c_new_line","c_carriage_return","c_horizontal_tab","c_vertical_tab","dabs","dacos","dasin","datan","date_and_time","dbesj","dbesj","dbesjn","dbesy","dbesy","dbesyn","dble","dcos","dcosh","ddim","derf","derfc","dexp","digits","dim","dint","dlog","dlog","dmax","dmin","dmod","dnint","dot_product","dprod","dsign","dsinh","dsin","dsqrt","dtanh","dtan","dtime","eoshift","epsilon","erf","erfc","etime","exit","exp","exponent","extends_type_of","fdate","fget","fgetc","float","floor","flush","fnum","fputc","fput","fraction","fseek","fstat","ftell","gerror","getarg","get_command","get_command_argument","get_environment_variable","getcwd","getenv","getgid","getlog","getpid","getuid","gmtime","hostnm","huge","iabs","iachar","iand","iargc","ibclr","ibits","ibset","ichar","idate","idim","idint","idnint","ieor","ierrno","ifix","imag","imagpart","index","int","ior","irand","isatty","ishft","ishftc","isign","iso_c_binding","is_iostat_end","is_iostat_eor","itime","kill","kind","lbound","len","len_trim","lge","lgt","link","lle","llt","lnblnk","loc","log","logical","long","lshift","lstat","ltime","matmul","max","maxexponent","maxloc","maxval","mclock","merge","move_alloc","min","minexponent","minloc","minval","mod","modulo","mvbits","nearest","new_line","nint","not","or","pack","perror","precision","present","product","radix","rand","random_number","random_seed","range","real","realpart","rename","repeat","reshape","rrspacing","rshift","same_type_as","scale","scan","second","selected_int_kind","selected_real_kind","set_exponent","shape","short","sign","signal","sinh","sin","sleep","sngl","spacing","spread","sqrt","srand","stat","sum","symlnk","system","system_clock","tan","tanh","time","tiny","transfer","transpose","trim","ttynam","ubound","umask","unlink","unpack","verify","xor","zabs","zcos","zexp","zlog","zsin","zsqrt"]),p=i(["c_bool","c_char","c_double","c_double_complex","c_float","c_float_complex","c_funptr","c_int","c_int16_t","c_int32_t","c_int64_t","c_int8_t","c_int_fast16_t","c_int_fast32_t","c_int_fast64_t","c_int_fast8_t","c_int_least16_t","c_int_least32_t","c_int_least64_t","c_int_least8_t","c_intmax_t","c_intptr_t","c_long","c_long_double","c_long_double_complex","c_long_long","c_ptr","c_short","c_signed_char","c_size_t","character","complex","double","integer","logical","real"]),d=/[+\-*&=<>\/\:]/,m=new RegExp("(.and.|.or.|.eq.|.lt.|.le.|.gt.|.ge.|.ne.|.not.|.eqv.|.neqv.)","i");function g(t,r){if(t.match(m))return"operator";var e=t.next();if(e=="!")return t.skipToEnd(),"comment";if(e=='"'||e=="'")return r.tokenize=b(e),r.tokenize(t,r);if(/[\[\]\(\),]/.test(e))return null;if(/\d/.test(e))return t.eatWhile(/[\w\.]/),"number";if(d.test(e))return t.eatWhile(d),"operator";t.eatWhile(/[\w\$_]/);var a=t.current().toLowerCase();return c.hasOwnProperty(a)?"keyword":f.hasOwnProperty(a)||p.hasOwnProperty(a)?"builtin":"variable"}function b(t){return function(r,e){for(var a=!1,l,_=!1;(l=r.next())!=null;){if(l==t&&!a){_=!0;break}a=!a&&l=="\\"}return(_||!a)&&(e.tokenize=null),"string"}}return{startState:function(){return{tokenize:null}},token:function(t,r){if(t.eatSpace())return null;var e=(r.tokenize||g)(t,r);return e=="comment"||e=="meta",e}}}),n.defineMIME("text/x-fortran","fortran")})})();var y=u.exports,k=x({__proto__:null,default:y},[u.exports]);export{k as f};