{"openapi":"3.0.2","paths":{"/flows":{"get":{"description":"Returns a paginated list of flows.","summary":"List flows","tags":["flows"],"parameters":[{"name":"teamId","in":"query","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"default":1,"type":"number","nullable":true}},{"name":"per_page","in":"query","schema":{"default":10,"type":"number","nullable":true}},{"name":"sort","in":"query","schema":{"type":"string"}},{"name":"operator","in":"query","schema":{"default":"and","type":"string","enum":["and","or"]}},{"name":"from","in":"query","schema":{"type":"string"}},{"name":"to","in":"query","schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string"}},{"name":"siteId","in":"query","schema":{"type":"string"}},{"name":"externalSiteId","in":"query","schema":{"type":"string"}},{"name":"streamId","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["INPUT","OUTPUT"]},"utilityState":{"type":"string","enum":["RESOURCES","RAW_MATERIALS","INTERMEDIATE_PRODUCTS","FINISHED_PRODUCTS","NEUTRALS","INACTIVE_NEUTRALS","ACTIVE_NEUTRALS","WASTE","PRODUCTION_WASTE","CONSUMPTION_WASTE","MIXED_WASTE"]},"hazards":{"type":"array","items":{"type":"string","enum":["ASPIRATION_TOXICITY","CARCINOGENICITY","CORROSIVENESS","EXPLOSIVENESS","FLAMMABILITY","INFECTIVITY","IRRITABILITY","MUTAGENESIS","OXIDIZING","RADIOACTIVITY","REPRODUCTIVE_TOXICITY","SENSITIZING"]}},"terminationStandard":{"type":"string","enum":["RECOVERY","RECOVERY_FUNCTION","RECOVERY_FUNCTION_PRODUCT","RECOVERY_FUNCTION_COMPONENT","RECOVERY_MATERIAL_ENHANCED_LOOP","RECOVERY_MATERIAL_PRESERVED_LOOP","RECOVERY_MATERIAL","RECOVERY_MATERIAL_CLOSED_LOOP","RECOVERY_MATERIAL_OPEN_LOOP","RECOVERY_MATERIAL_LINEAR","RECOVERY_NUTRIENT","RECOVERY_NUTRIENT_ANIMAL_FEED","RECOVERY_NUTRIENT_PLANT_FEED","RECOVERY_ENERGY","RECOVERY_ENERGY_POWER","RECOVERY_ENERGY_VECTOR","RECOVERY_ENERGY_KINETIC","RECOVERY_ENERGY_HEAT","CONTROL","CONTROL_NEUTRALIZATION","CONTROL_NEUTRALIZATION_ECO_IMPACT","CONTROL_NEUTRALIZATION_FREE_RELEASE","CONTROL_NEUTRALIZATION_LIMITED_RELEASE","CONTROL_DISPOSAL","CONTROL_DISPOSAL_ISOLATION","CONTROL_DISPOSAL_CONTAINMENT"],"nullable":true},"id":{"type":"string","format":"cuid"},"description":{"type":"string","nullable":true},"weight":{"type":"integer"},"units":{"type":"integer","nullable":true},"productId":{"type":"string","nullable":true},"complexity":{"type":"number","nullable":true},"geoTagId":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time","nullable":true},"siteId":{"type":"string","nullable":true},"externalSiteId":{"type":"string","nullable":true},"streamId":{"type":"string","nullable":true},"teamId":{"type":"string"},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true},"_count":{"type":"object","properties":{"items":{"type":"number"}},"required":["items"]},"product":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"nullable":true},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"required":["id","name","type","url"]}},"stream":{"type":"object","properties":{"id":{"type":"string","format":"cuid"},"name":{"type":"string","minLength":3,"maxLength":50}},"required":["id","name"],"nullable":true},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"cuid"},"materialId":{"type":"string"},"name":{"type":"string","minLength":3,"maxLength":50},"weight":{"type":"integer"},"material":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"required":["id","materialId","name","weight","material"]}}},"required":["type","utilityState","hazards","terminationStandard","id","description","weight","units","productId","complexity","geoTagId","date","siteId","externalSiteId","streamId","teamId","createdAt","updatedAt","_count","documents","items"]}},"total":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","total","pageCount"]}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Atlaz from '@atlaz/sdk';\n\nconst client = new Atlaz();\n\nasync function main() {\n  const flowListResponse = await client.flows.list({ teamId: 'teamId' });\n\n  console.log(flowListResponse.data);\n}\n\nmain();"}]},"post":{"description":"Returns the created flow.","summary":"Create a flow","tags":["flows"],"parameters":[{"name":"teamId","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Body","content":{"application/json":{"schema":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"description":{"type":"string","nullable":true},"utilityState":{"type":"string","enum":["RESOURCES","RAW_MATERIALS","INTERMEDIATE_PRODUCTS","FINISHED_PRODUCTS","NEUTRALS","INACTIVE_NEUTRALS","ACTIVE_NEUTRALS","WASTE","PRODUCTION_WASTE","CONSUMPTION_WASTE","MIXED_WASTE"]},"productId":{"type":"string","nullable":true},"geoTagId":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time","nullable":true},"hazards":{"type":"array","items":{"type":"string","enum":["ASPIRATION_TOXICITY","CARCINOGENICITY","CORROSIVENESS","EXPLOSIVENESS","FLAMMABILITY","INFECTIVITY","IRRITABILITY","MUTAGENESIS","OXIDIZING","RADIOACTIVITY","REPRODUCTIVE_TOXICITY","SENSITIZING"]}},"siteId":{"type":"string","nullable":true},"externalSiteId":{"type":"string","nullable":true},"streamId":{"type":"string","nullable":true},"units":{"type":"number","nullable":true},"weight":{"type":"number","nullable":true},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"cuid"},"type":{"type":"string","enum":["AUDIO","BILL_OF_LADING","INCIDENT_REPORT","MAINTENANCE_RECORD","PICTURE","SCALE_TICKET","TRAINING_RECORD","TRANSFER_NOTES","TRANSPORT_MANIFEST","WORK_ORDER","WORK_RECEIPT","VIDEO","CREDIT_NOTE","DEBIT_NOTE","INVOICE","PAYMENT_BILL","PAYMENT_RECEIPT","COMMERCIAL_AGREEMENT","LETTER_OF_INTENT","MEMORANDUM_OF_UNDERSTANDING","PURCHASE_ORDER","QUOTE","SALES_ORDER","AUDIT_REPORT","COMPLIANCE_REPORT","CERTIFICATION","RISK_ASSESSMENT_REPORT","PERMIT","END_OF_LIFE_CERTIFICATE","SAFETY_DATA_SHEET","TECHNICAL_DATA_SHEET"]},"url":{"type":"string"},"name":{"type":"string"}},"required":["id","type","url","name"]},"nullable":true},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":50},"weight":{"type":"integer"},"materialId":{"type":"string"}},"required":["name","weight","materialId"]}},"type":{"type":"string","enum":["OUTPUT"]},"terminationStandard":{"type":"string","enum":["RECOVERY","RECOVERY_FUNCTION","RECOVERY_FUNCTION_PRODUCT","RECOVERY_FUNCTION_COMPONENT","RECOVERY_MATERIAL_ENHANCED_LOOP","RECOVERY_MATERIAL_PRESERVED_LOOP","RECOVERY_MATERIAL","RECOVERY_MATERIAL_CLOSED_LOOP","RECOVERY_MATERIAL_OPEN_LOOP","RECOVERY_MATERIAL_LINEAR","RECOVERY_NUTRIENT","RECOVERY_NUTRIENT_ANIMAL_FEED","RECOVERY_NUTRIENT_PLANT_FEED","RECOVERY_ENERGY","RECOVERY_ENERGY_POWER","RECOVERY_ENERGY_VECTOR","RECOVERY_ENERGY_KINETIC","RECOVERY_ENERGY_HEAT","CONTROL","CONTROL_NEUTRALIZATION","CONTROL_NEUTRALIZATION_ECO_IMPACT","CONTROL_NEUTRALIZATION_FREE_RELEASE","CONTROL_NEUTRALIZATION_LIMITED_RELEASE","CONTROL_DISPOSAL","CONTROL_DISPOSAL_ISOLATION","CONTROL_DISPOSAL_CONTAINMENT"]}},"required":["description","utilityState","productId","geoTagId","date","hazards","siteId","externalSiteId","streamId","items","type","terminationStandard"]},{"type":"object","properties":{"description":{"type":"string","nullable":true},"utilityState":{"type":"string","enum":["RESOURCES","RAW_MATERIALS","INTERMEDIATE_PRODUCTS","FINISHED_PRODUCTS","NEUTRALS","INACTIVE_NEUTRALS","ACTIVE_NEUTRALS","WASTE","PRODUCTION_WASTE","CONSUMPTION_WASTE","MIXED_WASTE"]},"productId":{"type":"string","nullable":true},"geoTagId":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time","nullable":true},"hazards":{"type":"array","items":{"type":"string","enum":["ASPIRATION_TOXICITY","CARCINOGENICITY","CORROSIVENESS","EXPLOSIVENESS","FLAMMABILITY","INFECTIVITY","IRRITABILITY","MUTAGENESIS","OXIDIZING","RADIOACTIVITY","REPRODUCTIVE_TOXICITY","SENSITIZING"]}},"siteId":{"type":"string","nullable":true},"externalSiteId":{"type":"string","nullable":true},"streamId":{"type":"string","nullable":true},"units":{"type":"number","nullable":true},"weight":{"type":"number","nullable":true},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"cuid"},"type":{"type":"string","enum":["AUDIO","BILL_OF_LADING","INCIDENT_REPORT","MAINTENANCE_RECORD","PICTURE","SCALE_TICKET","TRAINING_RECORD","TRANSFER_NOTES","TRANSPORT_MANIFEST","WORK_ORDER","WORK_RECEIPT","VIDEO","CREDIT_NOTE","DEBIT_NOTE","INVOICE","PAYMENT_BILL","PAYMENT_RECEIPT","COMMERCIAL_AGREEMENT","LETTER_OF_INTENT","MEMORANDUM_OF_UNDERSTANDING","PURCHASE_ORDER","QUOTE","SALES_ORDER","AUDIT_REPORT","COMPLIANCE_REPORT","CERTIFICATION","RISK_ASSESSMENT_REPORT","PERMIT","END_OF_LIFE_CERTIFICATE","SAFETY_DATA_SHEET","TECHNICAL_DATA_SHEET"]},"url":{"type":"string"},"name":{"type":"string"}},"required":["id","type","url","name"]},"nullable":true},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":50},"weight":{"type":"integer"},"materialId":{"type":"string"}},"required":["name","weight","materialId"]}},"type":{"type":"string","enum":["INPUT"]}},"required":["description","utilityState","productId","geoTagId","date","hazards","siteId","externalSiteId","streamId","items","type"]}]}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["INPUT","OUTPUT"]},"utilityState":{"type":"string","enum":["RESOURCES","RAW_MATERIALS","INTERMEDIATE_PRODUCTS","FINISHED_PRODUCTS","NEUTRALS","INACTIVE_NEUTRALS","ACTIVE_NEUTRALS","WASTE","PRODUCTION_WASTE","CONSUMPTION_WASTE","MIXED_WASTE"]},"hazards":{"type":"array","items":{"type":"string","enum":["ASPIRATION_TOXICITY","CARCINOGENICITY","CORROSIVENESS","EXPLOSIVENESS","FLAMMABILITY","INFECTIVITY","IRRITABILITY","MUTAGENESIS","OXIDIZING","RADIOACTIVITY","REPRODUCTIVE_TOXICITY","SENSITIZING"]}},"terminationStandard":{"type":"string","enum":["RECOVERY","RECOVERY_FUNCTION","RECOVERY_FUNCTION_PRODUCT","RECOVERY_FUNCTION_COMPONENT","RECOVERY_MATERIAL_ENHANCED_LOOP","RECOVERY_MATERIAL_PRESERVED_LOOP","RECOVERY_MATERIAL","RECOVERY_MATERIAL_CLOSED_LOOP","RECOVERY_MATERIAL_OPEN_LOOP","RECOVERY_MATERIAL_LINEAR","RECOVERY_NUTRIENT","RECOVERY_NUTRIENT_ANIMAL_FEED","RECOVERY_NUTRIENT_PLANT_FEED","RECOVERY_ENERGY","RECOVERY_ENERGY_POWER","RECOVERY_ENERGY_VECTOR","RECOVERY_ENERGY_KINETIC","RECOVERY_ENERGY_HEAT","CONTROL","CONTROL_NEUTRALIZATION","CONTROL_NEUTRALIZATION_ECO_IMPACT","CONTROL_NEUTRALIZATION_FREE_RELEASE","CONTROL_NEUTRALIZATION_LIMITED_RELEASE","CONTROL_DISPOSAL","CONTROL_DISPOSAL_ISOLATION","CONTROL_DISPOSAL_CONTAINMENT"],"nullable":true},"id":{"type":"string","format":"cuid"},"description":{"type":"string","nullable":true},"weight":{"type":"integer"},"units":{"type":"integer","nullable":true},"productId":{"type":"string","nullable":true},"complexity":{"type":"number","nullable":true},"geoTagId":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time","nullable":true},"siteId":{"type":"string","nullable":true},"externalSiteId":{"type":"string","nullable":true},"streamId":{"type":"string","nullable":true},"teamId":{"type":"string"},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true}},"required":["type","utilityState","hazards","terminationStandard","id","description","weight","units","productId","complexity","geoTagId","date","siteId","externalSiteId","streamId","teamId","createdAt","updatedAt"]}}}}}}},"/flows/{id}":{"get":{"description":"Returns a flow by ID.","summary":"Get a flow","tags":["flows"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}}},"delete":{"description":"Deletes a flow and all its associated records.","summary":"Delete a flow","tags":["flows"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}}}},"patch":{"description":"Returns the updated flow.","summary":"Update a flow","tags":["flows"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["INPUT","OUTPUT"]},"description":{"type":"string","nullable":true},"utilityState":{"type":"string","enum":["RESOURCES","RAW_MATERIALS","INTERMEDIATE_PRODUCTS","FINISHED_PRODUCTS","NEUTRALS","INACTIVE_NEUTRALS","ACTIVE_NEUTRALS","WASTE","PRODUCTION_WASTE","CONSUMPTION_WASTE","MIXED_WASTE"]},"productId":{"type":"string","nullable":true},"geoTagId":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time","nullable":true},"hazards":{"type":"array","items":{"type":"string","enum":["ASPIRATION_TOXICITY","CARCINOGENICITY","CORROSIVENESS","EXPLOSIVENESS","FLAMMABILITY","INFECTIVITY","IRRITABILITY","MUTAGENESIS","OXIDIZING","RADIOACTIVITY","REPRODUCTIVE_TOXICITY","SENSITIZING"]}},"siteId":{"type":"string","nullable":true},"externalSiteId":{"type":"string","nullable":true},"streamId":{"type":"string","nullable":true},"units":{"type":"number","nullable":true},"weight":{"type":"number","nullable":true},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"cuid"},"type":{"type":"string","enum":["AUDIO","BILL_OF_LADING","INCIDENT_REPORT","MAINTENANCE_RECORD","PICTURE","SCALE_TICKET","TRAINING_RECORD","TRANSFER_NOTES","TRANSPORT_MANIFEST","WORK_ORDER","WORK_RECEIPT","VIDEO","CREDIT_NOTE","DEBIT_NOTE","INVOICE","PAYMENT_BILL","PAYMENT_RECEIPT","COMMERCIAL_AGREEMENT","LETTER_OF_INTENT","MEMORANDUM_OF_UNDERSTANDING","PURCHASE_ORDER","QUOTE","SALES_ORDER","AUDIT_REPORT","COMPLIANCE_REPORT","CERTIFICATION","RISK_ASSESSMENT_REPORT","PERMIT","END_OF_LIFE_CERTIFICATE","SAFETY_DATA_SHEET","TECHNICAL_DATA_SHEET"]},"url":{"type":"string"},"name":{"type":"string"}},"required":["type","url","name"]},"nullable":true},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":50},"weight":{"type":"integer"},"materialId":{"type":"string"}},"required":["name","weight","materialId"]}},"terminationStandard":{"type":"string","enum":["RECOVERY","RECOVERY_FUNCTION","RECOVERY_FUNCTION_PRODUCT","RECOVERY_FUNCTION_COMPONENT","RECOVERY_MATERIAL_ENHANCED_LOOP","RECOVERY_MATERIAL_PRESERVED_LOOP","RECOVERY_MATERIAL","RECOVERY_MATERIAL_CLOSED_LOOP","RECOVERY_MATERIAL_OPEN_LOOP","RECOVERY_MATERIAL_LINEAR","RECOVERY_NUTRIENT","RECOVERY_NUTRIENT_ANIMAL_FEED","RECOVERY_NUTRIENT_PLANT_FEED","RECOVERY_ENERGY","RECOVERY_ENERGY_POWER","RECOVERY_ENERGY_VECTOR","RECOVERY_ENERGY_KINETIC","RECOVERY_ENERGY_HEAT","CONTROL","CONTROL_NEUTRALIZATION","CONTROL_NEUTRALIZATION_ECO_IMPACT","CONTROL_NEUTRALIZATION_FREE_RELEASE","CONTROL_NEUTRALIZATION_LIMITED_RELEASE","CONTROL_DISPOSAL","CONTROL_DISPOSAL_ISOLATION","CONTROL_DISPOSAL_CONTAINMENT"]}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["INPUT","OUTPUT"]},"utilityState":{"type":"string","enum":["RESOURCES","RAW_MATERIALS","INTERMEDIATE_PRODUCTS","FINISHED_PRODUCTS","NEUTRALS","INACTIVE_NEUTRALS","ACTIVE_NEUTRALS","WASTE","PRODUCTION_WASTE","CONSUMPTION_WASTE","MIXED_WASTE"]},"hazards":{"type":"array","items":{"type":"string","enum":["ASPIRATION_TOXICITY","CARCINOGENICITY","CORROSIVENESS","EXPLOSIVENESS","FLAMMABILITY","INFECTIVITY","IRRITABILITY","MUTAGENESIS","OXIDIZING","RADIOACTIVITY","REPRODUCTIVE_TOXICITY","SENSITIZING"]}},"terminationStandard":{"type":"string","enum":["RECOVERY","RECOVERY_FUNCTION","RECOVERY_FUNCTION_PRODUCT","RECOVERY_FUNCTION_COMPONENT","RECOVERY_MATERIAL_ENHANCED_LOOP","RECOVERY_MATERIAL_PRESERVED_LOOP","RECOVERY_MATERIAL","RECOVERY_MATERIAL_CLOSED_LOOP","RECOVERY_MATERIAL_OPEN_LOOP","RECOVERY_MATERIAL_LINEAR","RECOVERY_NUTRIENT","RECOVERY_NUTRIENT_ANIMAL_FEED","RECOVERY_NUTRIENT_PLANT_FEED","RECOVERY_ENERGY","RECOVERY_ENERGY_POWER","RECOVERY_ENERGY_VECTOR","RECOVERY_ENERGY_KINETIC","RECOVERY_ENERGY_HEAT","CONTROL","CONTROL_NEUTRALIZATION","CONTROL_NEUTRALIZATION_ECO_IMPACT","CONTROL_NEUTRALIZATION_FREE_RELEASE","CONTROL_NEUTRALIZATION_LIMITED_RELEASE","CONTROL_DISPOSAL","CONTROL_DISPOSAL_ISOLATION","CONTROL_DISPOSAL_CONTAINMENT"],"nullable":true},"id":{"type":"string","format":"cuid"},"description":{"type":"string","nullable":true},"weight":{"type":"integer"},"units":{"type":"integer","nullable":true},"productId":{"type":"string","nullable":true},"complexity":{"type":"number","nullable":true},"geoTagId":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time","nullable":true},"siteId":{"type":"string","nullable":true},"externalSiteId":{"type":"string","nullable":true},"streamId":{"type":"string","nullable":true},"teamId":{"type":"string"},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true}},"required":["type","utilityState","hazards","terminationStandard","id","description","weight","units","productId","complexity","geoTagId","date","siteId","externalSiteId","streamId","teamId","createdAt","updatedAt"]}}}}}}}},"info":{"title":"Atlaz API","version":"1.0.0"}}