{"openapi":"3.0.0","info":{"title":"Beam Public API","version":"1.0.0"},"components":{"securitySchemes":{"beamApiKey":{"type":"apiKey","in":"header","name":"beam-api-key"}},"schemas":{"Error":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"code":{"type":"number"},"details":{"type":"object","additionalProperties":{"nullable":true}}},"required":["status","message","code","details"]},"Attribute":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["id","name","description"]},"InventoryItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"purchasedPrice":{"type":"number","nullable":true},"serial":{"type":"string","nullable":true},"purchasedDate":{"type":"string","nullable":true,"format":"date-time"},"statusUpdatedAt":{"type":"string","nullable":true,"format":"date-time"},"statusComment":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true,"format":"uuid"},"studioId":{"type":"string","nullable":true,"format":"uuid"},"vendor":{"type":"string","nullable":true},"installDate":{"type":"string","nullable":true,"format":"date-time"},"firmwareId":{"type":"string","nullable":true,"format":"uuid"},"equipmentStatusId":{"type":"string","nullable":true,"format":"uuid"},"productId":{"type":"string","nullable":true,"format":"uuid"},"statusUserId":{"type":"string","nullable":true,"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identificationStatus":{"type":"string","nullable":true,"enum":["inventory","internal","unidentified","identified","discarded","identification_requested","error",null]},"importedModel":{"type":"string","nullable":true},"importedName":{"type":"string","nullable":true},"importedManufacturerName":{"type":"string","nullable":true},"isCheckedIn":{"type":"boolean"},"checkedInAt":{"type":"string","nullable":true,"format":"date-time"},"checkedInBy":{"type":"string","nullable":true},"checkedInNote":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"barcode":{"type":"string","nullable":true},"type":{"type":"string","enum":["asset","spare"]},"quantity":{"type":"number","nullable":true},"autoStatus":{"type":"string","nullable":true,"enum":["overstock","in stock","low stock","reorder","ordered","out of stock","unknown status",null]},"attributes":{"type":"array","items":{"type":"string","format":"uuid"}},"tags":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"tagCategoryId":{"type":"string","format":"uuid"},"color":{"type":"string","nullable":true}},"required":["id","name","description","tagCategoryId","color"]}},"tagCategory":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"required":["id","name","color","description"]}},"fields":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"content":{"type":"string","nullable":true},"customFieldId":{"type":"string","format":"uuid"}},"required":["id","content","customFieldId"]}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"model":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"pageUrl":{"type":"string","nullable":true},"standardWarrantyLength":{"type":"number","nullable":true},"description":{"type":"string","nullable":true},"productStatus":{"type":"string","nullable":true},"categoryJson":{"type":"object","nullable":true,"additionalProperties":{"nullable":true}},"category":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true}},"required":["id","name","color"]},"status":{"type":"string","nullable":true}},"required":["id","name","model","type","imageUrl","pageUrl","standardWarrantyLength","description","productStatus","categoryJson","category","status"]}},"manufacturer":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"required":["id","name","imageUrl","status"]}},"users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"role":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"blocked":{"type":"boolean","nullable":true}},"required":["id","name","role","email","blocked"]}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true},"icon":{"type":"string","nullable":true},"nestedLevel":{"type":"number","nullable":true}},"required":["id","name","color","icon","nestedLevel"]}},"equipmentStatus":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","category"]}},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"logo":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"category":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true}},"required":["id","name","color"]}},"required":["id","name","logo","description","category"]}},"productDimension":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"width":{"type":"number","nullable":true},"height":{"type":"number","nullable":true},"depth":{"type":"number","nullable":true},"weight":{"type":"number","nullable":true},"dimensionUnitId":{"type":"string","nullable":true,"format":"uuid"},"dimensionUnitName":{"type":"string","nullable":true},"dimensionUnitSymbol":{"type":"string","nullable":true},"weightUnitId":{"type":"string","nullable":true,"format":"uuid"},"weightUnitName":{"type":"string","nullable":true},"weightUnitSymbol":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"dimensionType":{"type":"string"}},"required":["id","productId","width","height","depth","weight","dimensionUnitId","dimensionUnitName","dimensionUnitSymbol","weightUnitId","weightUnitName","weightUnitSymbol","note","dimensionType"]}},"reservationLink":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"reservationStartDate":{"type":"string","nullable":true,"format":"date-time"},"reservationEndDate":{"type":"string","nullable":true,"format":"date-time"},"defaultTimezone":{"type":"string","nullable":true},"status":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","color","category"]}},"required":["id","seqId","title","createdAt","reservationStartDate","reservationEndDate","defaultTimezone","status"]}},"ticketLink":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"dueDate":{"type":"string","nullable":true},"ticketType":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"icon":{"type":"string","nullable":true}},"required":["id","name","color","icon"]},"status":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","color","category"]}},"required":["id","seqId","title","priority","createdAt","dueDate","ticketType","status"]}},"scheduleStatus":{"type":"object","properties":{"reservations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string","nullable":true},"startDate":{"type":"string","nullable":true,"format":"date-time"},"endDate":{"type":"string","nullable":true,"format":"date-time"},"defaultTimezone":{"type":"string","nullable":true},"status":{"type":"object","nullable":true,"properties":{"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["name","color","category"]},"checkStatus":{"type":"object","nullable":true,"properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true},"isAvailable":{"type":"boolean","nullable":true}},"required":["id","name","color","category","isAvailable"]},"locations":{"type":"array","items":{"type":"object","additionalProperties":{"nullable":true}}}},"required":["id","seqId","title","startDate","endDate","defaultTimezone","status","checkStatus"]}},"status":{"type":"string","nullable":true}},"required":["reservations","status"]}},"required":["id","purchasedPrice","serial","purchasedDate","statusUpdatedAt","statusComment","userId","studioId","vendor","installDate","firmwareId","equipmentStatusId","productId","statusUserId","createdAt","updatedAt","identificationStatus","importedModel","importedName","importedManufacturerName","isCheckedIn","checkedInAt","checkedInBy","checkedInNote","isActive","barcode","type","quantity","autoStatus","attributes","tags","tagCategory","fields","products","manufacturer","users","locations","equipmentStatus","companies","productDimension","reservationLink","ticketLink","scheduleStatus"]},"InventoryListItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"purchasedPrice":{"type":"number","nullable":true},"serial":{"type":"string","nullable":true},"purchasedDate":{"type":"string","nullable":true,"format":"date-time"},"statusUpdatedAt":{"type":"string","nullable":true,"format":"date-time"},"statusComment":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true,"format":"uuid"},"studioId":{"type":"string","nullable":true,"format":"uuid"},"vendor":{"type":"string","nullable":true},"installDate":{"type":"string","nullable":true,"format":"date-time"},"firmwareId":{"type":"string","nullable":true,"format":"uuid"},"equipmentStatusId":{"type":"string","nullable":true,"format":"uuid"},"productId":{"type":"string","nullable":true,"format":"uuid"},"statusUserId":{"type":"string","nullable":true,"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastActivityAt":{"type":"string","nullable":true,"format":"date-time"},"identificationStatus":{"type":"string","nullable":true,"enum":["inventory","internal","unidentified","identified","discarded","identification_requested","error",null]},"importedModel":{"type":"string","nullable":true},"importedName":{"type":"string","nullable":true},"importedManufacturerName":{"type":"string","nullable":true},"isCheckedIn":{"type":"boolean"},"checkedInNote":{"type":"string","nullable":true},"type":{"type":"string","enum":["asset","spare"]},"quantity":{"type":"number","nullable":true},"group":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]},"autoStatus":{"type":"string","nullable":true,"enum":["overstock","in stock","low stock","reorder","ordered","out of stock","unknown status",null]},"barcode":{"type":"string","nullable":true},"isOrdered":{"type":"boolean"},"isActive":{"type":"boolean"},"approxMatchId":{"type":"string","nullable":true,"format":"uuid"},"productStatus":{"type":"string","nullable":true},"product.manufacturer":{"type":"string","nullable":true},"primaryContact.firstName":{"type":"string","nullable":true},"primaryContact.lastName":{"type":"string","nullable":true},"primaryContact.email":{"type":"string","nullable":true},"tags":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"tagCategoryId":{"type":"string","format":"uuid"},"color":{"type":"string","nullable":true}},"required":["id","name","description","tagCategoryId","color"]}},"tagCategory":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"required":["id","name","color","description"]}},"fields":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"content":{"type":"string","nullable":true},"customFieldId":{"type":"string","format":"uuid"}},"required":["id","content","customFieldId"]}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"model":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"pageUrl":{"type":"string","nullable":true},"standardWarrantyLength":{"type":"number","nullable":true},"description":{"type":"string","nullable":true},"productStatus":{"type":"string","nullable":true},"categoryJson":{"type":"object","nullable":true,"additionalProperties":{"nullable":true}}},"required":["id","name","model","type","imageUrl","pageUrl","standardWarrantyLength","description","productStatus","categoryJson"]}},"manufacturer":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true}},"required":["id","name","imageUrl"]}},"users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"role":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"blocked":{"type":"boolean","nullable":true},"avatar":{"type":"string","nullable":true}},"required":["id","name","role","email","blocked","avatar"]}},"equipmentStatus":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","category"]}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true},"icon":{"type":"string","nullable":true},"nestedLevel":{"type":"number","nullable":true}},"required":["id","name","color","icon","nestedLevel"]}},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"logo":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"category":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true}},"required":["id","name","color"]}},"required":["id","name","logo","description","category"]}},"productDimension":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"width":{"type":"number","nullable":true},"height":{"type":"number","nullable":true},"depth":{"type":"number","nullable":true},"weight":{"type":"number","nullable":true},"dimensionUnitId":{"type":"string","nullable":true,"format":"uuid"},"dimensionUnitName":{"type":"string","nullable":true},"dimensionUnitSymbol":{"type":"string","nullable":true},"weightUnitId":{"type":"string","nullable":true,"format":"uuid"},"weightUnitName":{"type":"string","nullable":true},"weightUnitSymbol":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"dimensionType":{"type":"string"}},"required":["id","productId","width","height","depth","weight","dimensionUnitId","dimensionUnitName","dimensionUnitSymbol","weightUnitId","weightUnitName","weightUnitSymbol","note","dimensionType"]}},"reservationLink":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"reservationStartDate":{"type":"string","nullable":true,"format":"date-time"},"reservationEndDate":{"type":"string","nullable":true,"format":"date-time"},"defaultTimezone":{"type":"string","nullable":true},"status":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","color","category"]}},"required":["id","seqId","title","createdAt","reservationStartDate","reservationEndDate","defaultTimezone","status"]}},"ticketLink":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"dueDate":{"type":"string","nullable":true},"ticketType":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"icon":{"type":"string","nullable":true}},"required":["id","name","color","icon"]},"status":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","color","category"]}},"required":["id","seqId","title","priority","createdAt","dueDate","ticketType","status"]}},"openedTicketsByType":{"type":"object","nullable":true,"additionalProperties":{"type":"number"}}},"required":["id","purchasedPrice","serial","purchasedDate","statusUpdatedAt","statusComment","userId","studioId","vendor","installDate","firmwareId","equipmentStatusId","productId","statusUserId","createdAt","updatedAt","lastActivityAt","identificationStatus","importedModel","importedName","importedManufacturerName","isCheckedIn","checkedInNote","type","quantity","group","autoStatus","barcode","isOrdered","isActive","approxMatchId","productStatus","product.manufacturer","primaryContact.firstName","primaryContact.lastName","primaryContact.email","tags","tagCategory","fields","products","manufacturer","users","equipmentStatus","locations","companies","productDimension","reservationLink","ticketLink","openedTicketsByType"]},"Product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"modelNumber":{"type":"string","nullable":true},"productCode":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"stockType":{"type":"string"},"description":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"manufacturer":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true}},"required":["id","name"]},"category":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true}},"required":["id","name","color"]},"customFields":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"content":{"type":"string","nullable":true},"customFieldId":{"type":"string","nullable":true,"format":"uuid"}},"required":["id","content","customFieldId"]}}},"required":["id","name","modelNumber","productCode","imageUrl","stockType","description","isActive","manufacturer","category","customFields"]},"ProductDetail":{"type":"object","properties":{"id":{"type":"string"},"studioId":{"type":"string"},"productId":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"modelNumber":{"type":"string","nullable":true},"productCode":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"replacementCost":{"type":"number","nullable":true},"retailPrice":{"type":"number","nullable":true},"rentalRate":{"type":"number","nullable":true},"rentalRateType":{"type":"string","nullable":true,"enum":["daily","hourly","weekly",null]},"stockType":{"type":"string","enum":["serializable","bulk","consumable"]},"stockQnt":{"type":"number","nullable":true},"wontMatchReason":{"type":"string","nullable":true,"enum":["accessory","insufficient_info","not_equipment","duplicate","discontinued","custom_build","other",null]},"studioManufacturerId":{"type":"string","nullable":true},"countryOfOrigin":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"manufacturer":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true}},"required":["id","name"]},"category":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true}},"required":["id","name","color"]},"dimensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"width":{"type":"number","nullable":true},"height":{"type":"number","nullable":true},"depth":{"type":"number","nullable":true},"weight":{"type":"number","nullable":true},"dimensionUnitId":{"type":"string","nullable":true},"dimensionUnitName":{"type":"string","nullable":true},"weightUnitId":{"type":"string","nullable":true},"weightUnitName":{"type":"string","nullable":true}},"required":["id","width","height","depth","weight","dimensionUnitId","dimensionUnitName","weightUnitId","weightUnitName"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"tagCategory":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"color":{"type":"string","nullable":true}},"required":["id","name","description","color"]}},"required":["id","name","description","tagCategory"]}},"customFields":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string","nullable":true},"customFieldId":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"content":{"type":"string","nullable":true}},"required":["id","customFieldId","name","type","content"]}},"totalAccessories":{"type":"number"},"totalSubstitutions":{"type":"number"},"bundles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}}},"required":["id","studioId","productId","name","description","modelNumber","productCode","imageUrl","replacementCost","retailPrice","rentalRate","rentalRateType","stockType","stockQnt","wontMatchReason","studioManufacturerId","countryOfOrigin","isActive","createdAt","updatedAt","manufacturer","category","dimensions","tags","customFields","totalAccessories","totalSubstitutions","bundles"]},"UpdateProductParams":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]},"UpdateProductBody":{"type":"object","properties":{"customFields":{"type":"object","additionalProperties":{"type":"string","nullable":true}},"options":{"type":"object","properties":{"skipProductNameManufacturerDuplicate":{"type":"boolean","default":false}},"default":{"skipProductNameManufacturerDuplicate":false}},"basicInfo":{"type":"object","properties":{"productId":{"type":"string","nullable":true,"format":"uuid"},"categoryId":{"type":"string","nullable":true,"format":"uuid"},"manufacturerName":{"type":"string","nullable":true},"name":{"type":"string","minLength":1},"description":{"type":"string","nullable":true},"modelNumber":{"type":"string","nullable":true},"productCode":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true,"format":"uri"},"stockType":{"type":"string","enum":["serializable","bulk","consumable"],"default":"serializable"},"stockQnt":{"type":"number","nullable":true},"tagIds":{"type":"array","items":{"type":"string","format":"uuid"}},"priceAndCost":{"type":"object","properties":{"replacementCost":{"type":"number","nullable":true},"retailPrice":{"type":"number","nullable":true},"rentalRate":{"type":"number","nullable":true},"rentalRateType":{"type":"string","enum":["daily","hourly","weekly"],"default":"daily"}}},"shippingDetails":{"type":"object","properties":{"dimensionUnitId":{"type":"string","format":"uuid"},"depth":{"type":"number","nullable":true},"width":{"type":"number","nullable":true},"height":{"type":"number","nullable":true},"weightUnitId":{"type":"string","format":"uuid"},"weight":{"type":"number","nullable":true},"countryOfOrigin":{"type":"string","nullable":true}},"required":["dimensionUnitId","depth","width","height","weightUnitId","weight"]}},"default":{}}}},"Tag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"tagCategoryId":{"type":"string","nullable":true,"format":"uuid"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"tagCategory":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["id","name","description"]}},"required":["id","name","description","tagCategoryId","createdAt","updatedAt","tagCategory"]},"TicketPriority":{"type":"string","enum":["urgent","important","non-critical","uncertain"]},"Ticket":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string"},"description":{"type":"string","nullable":true},"priority":{"type":"string","enum":["urgent","important","non-critical","uncertain"]},"statusId":{"type":"string"},"studioId":{"type":"string"},"ticketTypeId":{"type":"string","nullable":true},"dueDate":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"status":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"},"category":{"type":"string"}},"required":["name","color","category"]}},"required":["id","seqId","title","description","priority","statusId","studioId","ticketTypeId","dueDate","createdAt","updatedAt","status"]},"TicketType":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"icon":{"type":"string"},"color":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isDefaultFromEmail":{"type":"boolean"},"ticketsCount":{"type":"number"}},"required":["id","name","icon","color","description","isDefaultFromEmail","ticketsCount"]},"TicketStatus":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"category":{"type":"string","enum":["open","progress","closed"]},"color":{"type":"string","nullable":true},"isDefault":{"type":"boolean"},"order":{"type":"number"}},"required":["id","name","description","category","color","isDefault","order"]}},"parameters":{}},"paths":{"/v1/abac/attributes":{"get":{"summary":"List attributes","description":"Returns a paginated list of ABAC attributes.","tags":["abac"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"default":1},"required":false,"name":"page","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"q","in":"query"}],"responses":{"200":{"description":"Paginated list of attributes","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"currentPage":{"type":"number"},"totalPages":{"type":"number"},"hasMore":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}}},"required":["total","currentPage","totalPages","hasMore","results"]}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/bulk-items/{id}":{"get":{"summary":"Get a bulk item","description":"Returns a single bulk item.","tags":["bulk items"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"The bulk item","content":{"application/json":{"schema":{"type":"object","properties":{"bulkItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"purchasedPrice":{"type":"number","nullable":true},"serial":{"type":"string","nullable":true},"purchasedDate":{"type":"string","nullable":true,"format":"date-time"},"statusUpdatedAt":{"type":"string","nullable":true,"format":"date-time"},"statusComment":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true,"format":"uuid"},"studioId":{"type":"string","nullable":true,"format":"uuid"},"vendor":{"type":"string","nullable":true},"installDate":{"type":"string","nullable":true,"format":"date-time"},"firmwareId":{"type":"string","nullable":true,"format":"uuid"},"equipmentStatusId":{"type":"string","nullable":true,"format":"uuid"},"productId":{"type":"string","nullable":true,"format":"uuid"},"statusUserId":{"type":"string","nullable":true,"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identificationStatus":{"type":"string","nullable":true,"enum":["inventory","internal","unidentified","identified","discarded","identification_requested","error",null]},"importedModel":{"type":"string","nullable":true},"importedName":{"type":"string","nullable":true},"importedManufacturerName":{"type":"string","nullable":true},"isCheckedIn":{"type":"boolean"},"checkedInAt":{"type":"string","nullable":true,"format":"date-time"},"checkedInBy":{"type":"string","nullable":true},"checkedInNote":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"barcode":{"type":"string","nullable":true},"type":{"type":"string","enum":["asset","spare"]},"quantity":{"type":"number","nullable":true},"autoStatus":{"type":"string","nullable":true,"enum":["overstock","in stock","low stock","reorder","ordered","out of stock","unknown status",null]},"attributes":{"type":"array","items":{"type":"string","format":"uuid"}},"tags":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"tagCategoryId":{"type":"string","format":"uuid"},"color":{"type":"string","nullable":true}},"required":["id","name","description","tagCategoryId","color"]}},"tagCategory":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"required":["id","name","color","description"]}},"fields":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"content":{"type":"string","nullable":true},"customFieldId":{"type":"string","format":"uuid"}},"required":["id","content","customFieldId"]}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"model":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"pageUrl":{"type":"string","nullable":true},"standardWarrantyLength":{"type":"number","nullable":true},"description":{"type":"string","nullable":true},"productStatus":{"type":"string","nullable":true},"categoryJson":{"type":"object","nullable":true,"additionalProperties":{"nullable":true}},"category":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true}},"required":["id","name","color"]},"status":{"type":"string","nullable":true}},"required":["id","name","model","type","imageUrl","pageUrl","standardWarrantyLength","description","productStatus","categoryJson","category","status"]}},"manufacturer":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"required":["id","name","imageUrl","status"]}},"users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"role":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"blocked":{"type":"boolean","nullable":true}},"required":["id","name","role","email","blocked"]}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true},"icon":{"type":"string","nullable":true},"nestedLevel":{"type":"number","nullable":true}},"required":["id","name","color","icon","nestedLevel"]}},"equipmentStatus":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","category"]}},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"logo":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"category":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true}},"required":["id","name","color"]}},"required":["id","name","logo","description","category"]}},"productDimension":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"width":{"type":"number","nullable":true},"height":{"type":"number","nullable":true},"depth":{"type":"number","nullable":true},"weight":{"type":"number","nullable":true},"dimensionUnitId":{"type":"string","nullable":true,"format":"uuid"},"dimensionUnitName":{"type":"string","nullable":true},"dimensionUnitSymbol":{"type":"string","nullable":true},"weightUnitId":{"type":"string","nullable":true,"format":"uuid"},"weightUnitName":{"type":"string","nullable":true},"weightUnitSymbol":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"dimensionType":{"type":"string"}},"required":["id","productId","width","height","depth","weight","dimensionUnitId","dimensionUnitName","dimensionUnitSymbol","weightUnitId","weightUnitName","weightUnitSymbol","note","dimensionType"]}},"reservationLink":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"reservationStartDate":{"type":"string","nullable":true,"format":"date-time"},"reservationEndDate":{"type":"string","nullable":true,"format":"date-time"},"defaultTimezone":{"type":"string","nullable":true},"status":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","color","category"]}},"required":["id","seqId","title","createdAt","reservationStartDate","reservationEndDate","defaultTimezone","status"]}},"ticketLink":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"dueDate":{"type":"string","nullable":true},"ticketType":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"icon":{"type":"string","nullable":true}},"required":["id","name","color","icon"]},"status":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","color","category"]}},"required":["id","seqId","title","priority","createdAt","dueDate","ticketType","status"]}},"scheduleStatus":{"type":"object","properties":{"reservations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string","nullable":true},"startDate":{"type":"string","nullable":true,"format":"date-time"},"endDate":{"type":"string","nullable":true,"format":"date-time"},"defaultTimezone":{"type":"string","nullable":true},"status":{"type":"object","nullable":true,"properties":{"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["name","color","category"]},"checkStatus":{"type":"object","nullable":true,"properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true},"isAvailable":{"type":"boolean","nullable":true}},"required":["id","name","color","category","isAvailable"]},"locations":{"type":"array","items":{"type":"object","additionalProperties":{"nullable":true}}}},"required":["id","seqId","title","startDate","endDate","defaultTimezone","status","checkStatus"]}},"status":{"type":"string","nullable":true}},"required":["reservations","status"]}},"required":["id","purchasedPrice","serial","purchasedDate","statusUpdatedAt","statusComment","userId","studioId","vendor","installDate","firmwareId","equipmentStatusId","productId","statusUserId","createdAt","updatedAt","identificationStatus","importedModel","importedName","importedManufacturerName","isCheckedIn","checkedInAt","checkedInBy","checkedInNote","isActive","barcode","type","quantity","autoStatus","attributes","tags","tagCategory","fields","products","manufacturer","users","locations","equipmentStatus","companies","productDimension","reservationLink","ticketLink","scheduleStatus"]}},"required":["bulkItem"]}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Bulk item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"summary":"Update a bulk item","description":"Updates an existing bulk item.","tags":["bulk items"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","nullable":true,"items":{"type":"string","format":"uuid"}},"autoStatus":{"type":"string","enum":["overstock","in stock","low stock","reorder","ordered","out of stock","unknown status"]},"barcode":{"type":"string","nullable":true},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"content":{"type":"string"}},"required":["id","content"]}},"equipmentStatusId":{"type":"string","format":"uuid"},"extendedWarrantyPurchased":{"type":"boolean"},"importedManufacturerName":{"type":"string","nullable":true},"importedModel":{"type":"string","nullable":true},"importedName":{"type":"string","nullable":true},"installDate":{"type":"string","nullable":true,"format":"date-time"},"productId":{"type":"string","format":"uuid"},"purchasedDate":{"type":"string","nullable":true,"format":"date-time"},"purchasedPrice":{"type":"number","nullable":true},"quantity":{"type":"number","nullable":true,"minimum":0},"quantityComment":{"type":"string","nullable":true},"serial":{"type":"string","nullable":true},"statusComment":{"type":"string","nullable":true},"tagsId":{"type":"array","items":{"type":"string","format":"uuid"}},"userId":{"type":"string","nullable":true,"format":"uuid"},"vendor":{"type":"string","nullable":true},"isOrdered":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The updated bulk item","content":{"application/json":{"schema":{"type":"object","properties":{"bulkItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"purchasedPrice":{"type":"number","nullable":true},"serial":{"type":"string","nullable":true},"purchasedDate":{"type":"string","nullable":true,"format":"date-time"},"statusUpdatedAt":{"type":"string","nullable":true,"format":"date-time"},"statusComment":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true,"format":"uuid"},"studioId":{"type":"string","nullable":true,"format":"uuid"},"vendor":{"type":"string","nullable":true},"installDate":{"type":"string","nullable":true,"format":"date-time"},"firmwareId":{"type":"string","nullable":true,"format":"uuid"},"equipmentStatusId":{"type":"string","nullable":true,"format":"uuid"},"productId":{"type":"string","nullable":true,"format":"uuid"},"statusUserId":{"type":"string","nullable":true,"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identificationStatus":{"type":"string","nullable":true,"enum":["inventory","internal","unidentified","identified","discarded","identification_requested","error",null]},"importedModel":{"type":"string","nullable":true},"importedName":{"type":"string","nullable":true},"importedManufacturerName":{"type":"string","nullable":true},"isCheckedIn":{"type":"boolean"},"checkedInAt":{"type":"string","nullable":true,"format":"date-time"},"checkedInBy":{"type":"string","nullable":true},"checkedInNote":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"barcode":{"type":"string","nullable":true},"type":{"type":"string","enum":["asset","spare"]},"quantity":{"type":"number","nullable":true},"autoStatus":{"type":"string","nullable":true,"enum":["overstock","in stock","low stock","reorder","ordered","out of stock","unknown status",null]},"attributes":{"type":"array","items":{"type":"string","format":"uuid"}},"tags":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"tagCategoryId":{"type":"string","format":"uuid"},"color":{"type":"string","nullable":true}},"required":["id","name","description","tagCategoryId","color"]}},"tagCategory":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"required":["id","name","color","description"]}},"fields":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"content":{"type":"string","nullable":true},"customFieldId":{"type":"string","format":"uuid"}},"required":["id","content","customFieldId"]}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"model":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"pageUrl":{"type":"string","nullable":true},"standardWarrantyLength":{"type":"number","nullable":true},"description":{"type":"string","nullable":true},"productStatus":{"type":"string","nullable":true},"categoryJson":{"type":"object","nullable":true,"additionalProperties":{"nullable":true}},"category":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true}},"required":["id","name","color"]},"status":{"type":"string","nullable":true}},"required":["id","name","model","type","imageUrl","pageUrl","standardWarrantyLength","description","productStatus","categoryJson","category","status"]}},"manufacturer":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"required":["id","name","imageUrl","status"]}},"users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"role":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"blocked":{"type":"boolean","nullable":true}},"required":["id","name","role","email","blocked"]}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true},"icon":{"type":"string","nullable":true},"nestedLevel":{"type":"number","nullable":true}},"required":["id","name","color","icon","nestedLevel"]}},"equipmentStatus":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","category"]}},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"logo":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"category":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true}},"required":["id","name","color"]}},"required":["id","name","logo","description","category"]}},"productDimension":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"width":{"type":"number","nullable":true},"height":{"type":"number","nullable":true},"depth":{"type":"number","nullable":true},"weight":{"type":"number","nullable":true},"dimensionUnitId":{"type":"string","nullable":true,"format":"uuid"},"dimensionUnitName":{"type":"string","nullable":true},"dimensionUnitSymbol":{"type":"string","nullable":true},"weightUnitId":{"type":"string","nullable":true,"format":"uuid"},"weightUnitName":{"type":"string","nullable":true},"weightUnitSymbol":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"dimensionType":{"type":"string"}},"required":["id","productId","width","height","depth","weight","dimensionUnitId","dimensionUnitName","dimensionUnitSymbol","weightUnitId","weightUnitName","weightUnitSymbol","note","dimensionType"]}},"reservationLink":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"reservationStartDate":{"type":"string","nullable":true,"format":"date-time"},"reservationEndDate":{"type":"string","nullable":true,"format":"date-time"},"defaultTimezone":{"type":"string","nullable":true},"status":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","color","category"]}},"required":["id","seqId","title","createdAt","reservationStartDate","reservationEndDate","defaultTimezone","status"]}},"ticketLink":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"dueDate":{"type":"string","nullable":true},"ticketType":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"icon":{"type":"string","nullable":true}},"required":["id","name","color","icon"]},"status":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","color","category"]}},"required":["id","seqId","title","priority","createdAt","dueDate","ticketType","status"]}},"scheduleStatus":{"type":"object","properties":{"reservations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string","nullable":true},"startDate":{"type":"string","nullable":true,"format":"date-time"},"endDate":{"type":"string","nullable":true,"format":"date-time"},"defaultTimezone":{"type":"string","nullable":true},"status":{"type":"object","nullable":true,"properties":{"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["name","color","category"]},"checkStatus":{"type":"object","nullable":true,"properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true},"isAvailable":{"type":"boolean","nullable":true}},"required":["id","name","color","category","isAvailable"]},"locations":{"type":"array","items":{"type":"object","additionalProperties":{"nullable":true}}}},"required":["id","seqId","title","startDate","endDate","defaultTimezone","status","checkStatus"]}},"status":{"type":"string","nullable":true}},"required":["reservations","status"]}},"required":["id","purchasedPrice","serial","purchasedDate","statusUpdatedAt","statusComment","userId","studioId","vendor","installDate","firmwareId","equipmentStatusId","productId","statusUserId","createdAt","updatedAt","identificationStatus","importedModel","importedName","importedManufacturerName","isCheckedIn","checkedInAt","checkedInBy","checkedInNote","isActive","barcode","type","quantity","autoStatus","attributes","tags","tagCategory","fields","products","manufacturer","users","locations","equipmentStatus","companies","productDimension","reservationLink","ticketLink","scheduleStatus"]}},"required":["bulkItem"]}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Bulk item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/bulk-items":{"post":{"summary":"Create a bulk item","description":"Creates a new bulk item.","tags":["bulk items"],"security":[{"beamApiKey":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"manufacturer":{"type":"string"},"model":{"type":"string"},"quantity":{"type":"integer","minimum":1,"default":1},"minQuantity":{"type":"integer","minimum":1},"maxQuantity":{"type":"integer","minimum":1},"restockQuantity":{"type":"integer","minimum":1},"tags":{"type":"array","items":{"type":"string","format":"uuid"}},"attributes":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["name"]}}}},"responses":{"201":{"description":"The created bulk item","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"studioId":{"type":"string","format":"uuid"},"importedName":{"type":"string","nullable":true},"importedModel":{"type":"string","nullable":true},"importedManufacturerName":{"type":"string","nullable":true},"quantity":{"type":"number","nullable":true},"type":{"type":"string"},"attributes":{"type":"array","items":{"type":"string"}},"autoStatus":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"serial":{"type":"string","nullable":true},"purchasedPrice":{"type":"number","nullable":true},"barcode":{"type":"string","nullable":true},"productId":{"type":"string","nullable":true},"locationId":{"type":"string","nullable":true},"equipmentStatusId":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true},"isOrdered":{"type":"boolean"},"order":{"type":"number"}},"required":["id","studioId","importedName","importedModel","importedManufacturerName","quantity","type","attributes","autoStatus","isActive","createdAt","updatedAt","serial","purchasedPrice","barcode","productId","locationId","equipmentStatusId","userId","isOrdered","order"],"additionalProperties":{"nullable":true}}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"A bulk item with this name already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"summary":"List bulk items","description":"Returns a paginated list of bulk items.","tags":["bulk items"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"string"},"required":false,"name":"query","in":"query"},{"schema":{"type":"integer","minimum":1,"default":1},"required":false,"name":"page","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Paginated list of bulk items","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"currentPage":{"type":"number"},"totalPages":{"type":"number"},"hasMore":{"type":"boolean"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"purchasedPrice":{"type":"number","nullable":true},"serial":{"type":"string","nullable":true},"purchasedDate":{"type":"string","nullable":true,"format":"date-time"},"statusUpdatedAt":{"type":"string","nullable":true,"format":"date-time"},"statusComment":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true,"format":"uuid"},"studioId":{"type":"string","nullable":true,"format":"uuid"},"vendor":{"type":"string","nullable":true},"installDate":{"type":"string","nullable":true,"format":"date-time"},"firmwareId":{"type":"string","nullable":true,"format":"uuid"},"equipmentStatusId":{"type":"string","nullable":true,"format":"uuid"},"productId":{"type":"string","nullable":true,"format":"uuid"},"statusUserId":{"type":"string","nullable":true,"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identificationStatus":{"type":"string","nullable":true,"enum":["inventory","internal","unidentified","identified","discarded","identification_requested","error",null]},"importedModel":{"type":"string","nullable":true},"importedName":{"type":"string","nullable":true},"importedManufacturerName":{"type":"string","nullable":true},"isCheckedIn":{"type":"boolean"},"checkedInAt":{"type":"string","nullable":true,"format":"date-time"},"checkedInBy":{"type":"string","nullable":true},"checkedInNote":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"barcode":{"type":"string","nullable":true},"type":{"type":"string","enum":["asset","spare"]},"quantity":{"type":"number","nullable":true},"autoStatus":{"type":"string","nullable":true,"enum":["overstock","in stock","low stock","reorder","ordered","out of stock","unknown status",null]},"attributes":{"type":"array","items":{"type":"string","format":"uuid"}},"tags":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"tagCategoryId":{"type":"string","format":"uuid"},"color":{"type":"string","nullable":true}},"required":["id","name","description","tagCategoryId","color"]}},"tagCategory":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"required":["id","name","color","description"]}},"fields":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"content":{"type":"string","nullable":true},"customFieldId":{"type":"string","format":"uuid"}},"required":["id","content","customFieldId"]}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"model":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"pageUrl":{"type":"string","nullable":true},"standardWarrantyLength":{"type":"number","nullable":true},"description":{"type":"string","nullable":true},"productStatus":{"type":"string","nullable":true},"categoryJson":{"type":"object","nullable":true,"additionalProperties":{"nullable":true}},"category":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true}},"required":["id","name","color"]},"status":{"type":"string","nullable":true}},"required":["id","name","model","type","imageUrl","pageUrl","standardWarrantyLength","description","productStatus","categoryJson","category","status"]}},"manufacturer":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"required":["id","name","imageUrl","status"]}},"users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"role":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"blocked":{"type":"boolean","nullable":true}},"required":["id","name","role","email","blocked"]}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true},"icon":{"type":"string","nullable":true},"nestedLevel":{"type":"number","nullable":true}},"required":["id","name","color","icon","nestedLevel"]}},"equipmentStatus":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","category"]}},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"logo":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"category":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true}},"required":["id","name","color"]}},"required":["id","name","logo","description","category"]}},"productDimension":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"width":{"type":"number","nullable":true},"height":{"type":"number","nullable":true},"depth":{"type":"number","nullable":true},"weight":{"type":"number","nullable":true},"dimensionUnitId":{"type":"string","nullable":true,"format":"uuid"},"dimensionUnitName":{"type":"string","nullable":true},"dimensionUnitSymbol":{"type":"string","nullable":true},"weightUnitId":{"type":"string","nullable":true,"format":"uuid"},"weightUnitName":{"type":"string","nullable":true},"weightUnitSymbol":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"dimensionType":{"type":"string"}},"required":["id","productId","width","height","depth","weight","dimensionUnitId","dimensionUnitName","dimensionUnitSymbol","weightUnitId","weightUnitName","weightUnitSymbol","note","dimensionType"]}},"reservationLink":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"reservationStartDate":{"type":"string","nullable":true,"format":"date-time"},"reservationEndDate":{"type":"string","nullable":true,"format":"date-time"},"defaultTimezone":{"type":"string","nullable":true},"status":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","color","category"]}},"required":["id","seqId","title","createdAt","reservationStartDate","reservationEndDate","defaultTimezone","status"]}},"ticketLink":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"dueDate":{"type":"string","nullable":true},"ticketType":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"icon":{"type":"string","nullable":true}},"required":["id","name","color","icon"]},"status":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["id","name","color","category"]}},"required":["id","seqId","title","priority","createdAt","dueDate","ticketType","status"]}},"scheduleStatus":{"type":"object","properties":{"reservations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string","nullable":true},"startDate":{"type":"string","nullable":true,"format":"date-time"},"endDate":{"type":"string","nullable":true,"format":"date-time"},"defaultTimezone":{"type":"string","nullable":true},"status":{"type":"object","nullable":true,"properties":{"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true}},"required":["name","color","category"]},"checkStatus":{"type":"object","nullable":true,"properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"name":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"category":{"type":"string","nullable":true},"isAvailable":{"type":"boolean","nullable":true}},"required":["id","name","color","category","isAvailable"]},"locations":{"type":"array","items":{"type":"object","additionalProperties":{"nullable":true}}}},"required":["id","seqId","title","startDate","endDate","defaultTimezone","status","checkStatus"]}},"status":{"type":"string","nullable":true}},"required":["reservations","status"]}},"required":["id","purchasedPrice","serial","purchasedDate","statusUpdatedAt","statusComment","userId","studioId","vendor","installDate","firmwareId","equipmentStatusId","productId","statusUserId","createdAt","updatedAt","identificationStatus","importedModel","importedName","importedManufacturerName","isCheckedIn","checkedInAt","checkedInBy","checkedInNote","isActive","barcode","type","quantity","autoStatus","attributes","tags","tagCategory","fields","products","manufacturer","users","locations","equipmentStatus","companies","productDimension","reservationLink","ticketLink","scheduleStatus"]}}},"required":["total","currentPage","totalPages","hasMore","results"]}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/inventory":{"get":{"summary":"List inventory items","description":"Returns a page of inventory items for the studio the API key is issued for. The q parameter accepts the Beam query syntax, for example serial~\"SN-1\" AND quantity>2. For a free text match across serial, model, product and manufacturer names, use search~\"text\" where \"text\" is the free search field","tags":["inventory"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"default":1},"required":false,"name":"page","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"q","in":"query"}],"responses":{"200":{"description":"A page of inventory items","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"currentPage":{"type":"number"},"totalPages":{"type":"number"},"hasMore":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/InventoryListItem"}}},"required":["total","currentPage","totalPages","hasMore","results"]}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/inventory/{id}":{"get":{"summary":"Get an inventory item","description":"Returns a single inventory item belonging to the studio the API key is issued for.","tags":["inventory"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"The inventory item","content":{"application/json":{"schema":{"type":"object","properties":{"inventory":{"$ref":"#/components/schemas/InventoryItem"}},"required":["inventory"]}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No such item in the studio the API key belongs to","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"summary":"Update an inventory item","description":"Updates a single non-bulk inventory item.","tags":["inventory"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","nullable":true,"items":{"type":"string","format":"uuid"}},"barcode":{"type":"string","nullable":true},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"content":{"type":"string"}},"required":["id","content"]}},"equipmentStatusId":{"type":"string","format":"uuid"},"extendedWarrantyPurchased":{"type":"boolean"},"importedManufacturerName":{"type":"string","nullable":true},"importedModel":{"type":"string","nullable":true},"importedName":{"type":"string","nullable":true},"installDate":{"type":"string","nullable":true,"format":"date-time"},"productId":{"type":"string","format":"uuid"},"purchasedDate":{"type":"string","nullable":true,"format":"date-time"},"purchasedPrice":{"type":"number","nullable":true},"serial":{"type":"string","nullable":true},"statusComment":{"type":"string","nullable":true},"tagsId":{"type":"array","items":{"type":"string","format":"uuid"}},"userId":{"type":"string","nullable":true,"format":"uuid"},"vendor":{"type":"string","nullable":true}}}}}},"responses":{"200":{"description":"The updated inventory item","content":{"application/json":{"schema":{"type":"object","properties":{"inventory":{"$ref":"#/components/schemas/InventoryItem"}},"required":["inventory"]}}}},"400":{"description":"Item is a bulk item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Inventory item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/inventory/custom-fields":{"get":{"summary":"List inventory custom fields","tags":["inventory","custom-fields"],"security":[{"beamApiKey":[]}],"responses":{"200":{"description":"Paginated list of custom fields","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"currentPage":{"type":"number"},"totalPages":{"type":"number"},"hasMore":{"type":"boolean"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string","enum":["text","select","description","date","email","number","checkbox","url","currency","signature","hyperlink"]},"isUnique":{"type":"boolean"},"isSearchable":{"type":"boolean"},"defaultValue":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"entityType":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"currencyId":{"type":"string","nullable":true,"format":"uuid"},"selectableValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"value":{"type":"string"},"order":{"type":"number"},"parentId":{"type":"string","nullable":true,"format":"uuid"},"customFieldId":{"type":"string","format":"uuid"}},"required":["id","value","order","parentId"]}}},"required":["id","name","type","isUnique","isSearchable","defaultValue","description","entityType","createdAt","updatedAt","currencyId","selectableValues"]}}},"required":["total","currentPage","totalPages","hasMore","results"]}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/inventory/statuses":{"get":{"summary":"List inventory statuses","tags":["inventory"],"security":[{"beamApiKey":[]}],"responses":{"200":{"description":"Paginated list of equipment statuses","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"currentPage":{"type":"number"},"totalPages":{"type":"number"},"hasMore":{"type":"boolean"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"category":{"type":"string","nullable":true,"enum":["Online","Offline","Decommissioned",null]},"studioId":{"type":"string","format":"uuid"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","description","category","studioId","createdAt","updatedAt"]}}},"required":["total","currentPage","totalPages","hasMore","results"]}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/products":{"get":{"summary":"List products","description":"Returns a paginated list of products.","tags":["products"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"string"},"required":false,"name":"query","in":"query"},{"schema":{"type":"integer","minimum":1,"default":1},"required":false,"name":"page","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Paginated list of products","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"currentPage":{"type":"number"},"totalPages":{"type":"number"},"hasMore":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Product"}}},"required":["total","currentPage","totalPages","hasMore","results"]}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create a product","description":"Creates a new product.","tags":["products"],"security":[{"beamApiKey":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"basicInfo":{"type":"object","properties":{"productId":{"type":"string","nullable":true,"format":"uuid"},"categoryId":{"type":"string","nullable":true,"format":"uuid"},"manufacturerName":{"type":"string","nullable":true},"name":{"type":"string","minLength":1},"description":{"type":"string","nullable":true},"modelNumber":{"type":"string","nullable":true},"productCode":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true,"format":"uri"},"stockType":{"type":"string","enum":["serializable","bulk","consumable"],"default":"serializable"},"stockQnt":{"type":"number","nullable":true},"tagIds":{"type":"array","items":{"type":"string","format":"uuid"}},"priceAndCost":{"type":"object","properties":{"replacementCost":{"type":"number","nullable":true},"retailPrice":{"type":"number","nullable":true},"rentalRate":{"type":"number","nullable":true},"rentalRateType":{"type":"string","enum":["daily","hourly","weekly"],"default":"daily"}}},"shippingDetails":{"type":"object","properties":{"dimensionUnitId":{"type":"string","format":"uuid"},"depth":{"type":"number","nullable":true},"width":{"type":"number","nullable":true},"height":{"type":"number","nullable":true},"weightUnitId":{"type":"string","format":"uuid"},"weight":{"type":"number","nullable":true},"countryOfOrigin":{"type":"string","nullable":true}},"required":["dimensionUnitId","depth","width","height","weightUnitId","weight"]}},"required":["name","stockQnt"]},"assets":{"type":"array","items":{"type":"object","properties":{"serial":{"type":"string"},"barcode":{"type":"string"},"customName":{"type":"string"},"inServiceDate":{"type":"string","format":"date-time"}}}},"accessories":{"type":"array","items":{"type":"object","properties":{"accessoryStudioProductId":{"type":"string","format":"uuid"},"quantity":{"type":"integer","minimum":1}},"required":["accessoryStudioProductId","quantity"]}},"accessoryOf":{"type":"array","items":{"type":"object","properties":{"studioProductId":{"type":"string","format":"uuid"},"quantity":{"type":"integer","minimum":1}},"required":["studioProductId","quantity"]}},"substitutions":{"type":"array","items":{"type":"object","properties":{"substitutionStudioProductId":{"type":"string","format":"uuid"},"substitutionType":{"type":"string","enum":["BI_DIRECTIONAL","SUBSTITUTION_OF","SUBSTITUTED_BY"]}},"required":["substitutionStudioProductId","substitutionType"]}},"bundles":{"type":"array","items":{"type":"object","properties":{"bundleId":{"type":"string","format":"uuid"},"quantity":{"type":"integer","minimum":1,"default":1},"accessories":{"type":"array","items":{"type":"object","properties":{"accessoryStudioProductId":{"type":"string","format":"uuid"},"quantity":{"type":"integer","minimum":1}},"required":["accessoryStudioProductId","quantity"]},"default":[]}},"required":["bundleId"]}},"customFields":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","format":"uuid"},"content":{"type":"string","nullable":true}},"required":["customFieldId"]}},"options":{"type":"object","properties":{"skipProductNameManufacturerDuplicate":{"type":"boolean","default":false}}}},"required":["basicInfo","options"]}}}},"responses":{"201":{"description":"The created product","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"modelNumber":{"type":"string","nullable":true},"productCode":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"stockType":{"type":"string"},"isActive":{"type":"boolean"},"studioId":{"type":"string","format":"uuid"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","modelNumber","productCode","imageUrl","stockType","isActive","studioId","createdAt","updatedAt"],"additionalProperties":{"nullable":true}}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/products/{id}":{"patch":{"summary":"Update a product","description":"Updates an existing product.","tags":["products"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductBody"}}}},"responses":{"204":{"description":"Product updated successfully"},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"summary":"Get a product","description":"Returns a single product.","tags":["products"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"The product","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/ProductDetail"}},"required":["product"]}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Product not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/tags":{"get":{"summary":"List tags","description":"Returns a paginated list of tags.","tags":["tags"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"string"},"required":false,"name":"query","in":"query"},{"schema":{"type":"integer","minimum":1,"default":1},"required":false,"name":"page","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Paginated list of tags","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"currentPage":{"type":"number"},"totalPages":{"type":"number"},"hasMore":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}},"required":["total","currentPage","totalPages","hasMore","results"]}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/tickets":{"post":{"summary":"Create a ticket","description":"Creates a new ticket.","tags":["tickets"],"security":[{"beamApiKey":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1},"priority":{"type":"string","enum":["urgent","important","non-critical","uncertain"]},"equipmentsIds":{"type":"array","items":{"type":"string","format":"uuid"}},"ticketTypeId":{"type":"string","minLength":1,"format":"uuid"},"dueDate":{"type":"string","format":"date"},"description":{"type":"string"},"statusId":{"type":"string","minLength":1,"format":"uuid"},"categoryId":{"type":"string","nullable":true,"format":"uuid"},"assigneeIds":{"type":"array","nullable":true,"items":{"type":"string","format":"uuid"}},"fields":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"format":"uuid"},"content":{"type":"string"}},"required":["customFieldId"]}},"companyIds":{"type":"array","items":{"type":"string","format":"uuid"}},"contactEntityIds":{"type":"array","items":{"type":"string","format":"uuid"}},"contactEmail":{"type":"string","format":"email"},"shouldReturn":{"type":"boolean","default":true},"subStatus":{"type":"string"},"primaryEquipmentId":{"type":"string","format":"uuid"},"maintenanceId":{"type":"string","format":"uuid"},"equipmentsQty":{"type":"array","items":{"type":"object","properties":{"equipmentId":{"type":"string","minLength":1},"stockQty":{"type":"number","minimum":1}},"required":["equipmentId","stockQty"]}},"locationIds":{"type":"array","items":{"type":"string","format":"uuid"}},"locationComment":{"type":"string"},"attributes":{"type":"array","items":{"type":"string","format":"uuid"}},"files":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"size":{"type":"string","pattern":"^-?\\d+$"},"mimeType":{"type":"string","minLength":1},"checksum":{"type":"string","minLength":1}},"required":["name","size","mimeType","checksum"]}}},"required":["title","priority","ticketTypeId","statusId"]}}}},"responses":{"200":{"description":"The created ticket","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string"},"description":{"type":"string","nullable":true},"priority":{"type":"string","enum":["urgent","important","non-critical","uncertain"]},"statusId":{"type":"string","format":"uuid"},"studioId":{"type":"string","format":"uuid"},"ticketTypeId":{"type":"string","nullable":true,"format":"uuid"},"dueDate":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","seqId","title","description","priority","statusId","studioId","ticketTypeId","dueDate","createdAt","updatedAt"],"additionalProperties":{"nullable":true}}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"summary":"List tickets","description":"Returns a paginated list of tickets.","tags":["tickets"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"string"},"required":false,"name":"query","in":"query"},{"schema":{"type":"integer","minimum":1,"default":1},"required":false,"name":"page","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Paginated list of tickets","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"currentPage":{"type":"number"},"totalPages":{"type":"number"},"hasMore":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Ticket"}}},"required":["total","currentPage","totalPages","hasMore","results"]}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/tickets/{id}":{"patch":{"summary":"Update a ticket","description":"Updates an existing ticket.","tags":["tickets"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"number","nullable":true},"required":false,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dueDate":{"type":"string","nullable":true,"format":"date"},"title":{"type":"string"},"description":{"type":"string","nullable":true},"statusId":{"type":"string","format":"uuid"},"categoryId":{"type":"string","nullable":true,"format":"uuid"},"assigneeId":{"type":"string","nullable":true,"format":"uuid"},"assigneeIds":{"type":"array","nullable":true,"items":{"type":"string","format":"uuid"}},"priority":{"type":"string","nullable":true,"enum":["urgent","important","non-critical","uncertain",null]},"fields":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","format":"uuid"},"content":{"type":"string","nullable":true}},"required":["customFieldId"]}},"ticketTypeId":{"type":"string","format":"uuid"},"contactEntityId":{"type":"string","nullable":true},"contactEntityIds":{"type":"array","nullable":true,"items":{"type":"string","format":"uuid"}},"contactEmail":{"type":"string","nullable":true,"format":"email"},"shouldReturn":{"type":"boolean"},"subStatus":{"type":"string","nullable":true},"maintenanceId":{"type":"string","nullable":true,"format":"uuid"},"attributes":{"type":"array","nullable":true,"items":{"type":"string","format":"uuid"}}}}}}},"responses":{"200":{"description":"The updated ticket","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"number"},"title":{"type":"string"},"description":{"type":"string","nullable":true},"priority":{"type":"string","enum":["urgent","important","non-critical","uncertain"]},"statusId":{"type":"string","format":"uuid"},"studioId":{"type":"string","format":"uuid"},"ticketTypeId":{"type":"string","nullable":true,"format":"uuid"},"dueDate":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","seqId","title","description","priority","statusId","studioId","ticketTypeId","dueDate","createdAt","updatedAt"],"additionalProperties":{"nullable":true}}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"summary":"Get a ticket","description":"Returns a single ticket with all related data.","tags":["tickets"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"number","nullable":true},"required":false,"name":"id","in":"path"}],"responses":{"200":{"description":"The ticket","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"seqId":{"type":"string"},"title":{"type":"string"},"description":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"dueDate":{"nullable":true},"createdAt":{"nullable":true},"closedAt":{"nullable":true},"statusId":{"type":"string"},"publicMessageUnread":{"type":"boolean"},"ticketTypeId":{"type":"string"},"isNotCreated":{"type":"boolean"},"contactEntityId":{"type":"string","nullable":true},"primaryEquipmentId":{"type":"string","nullable":true},"subStatus":{"type":"string","nullable":true},"attributes":{"nullable":true},"isInternal":{"type":"boolean"},"status":{"type":"object","nullable":true,"properties":{"name":{"type":"string"},"color":{"type":"string"},"category":{"type":"string"}},"required":["name","color","category"]},"contact":{"type":"object","nullable":true,"properties":{"id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"pictureUrl":{"type":"string","nullable":true}},"required":["id","firstName","lastName","email","pictureUrl"]},"assignee":{"type":"object","nullable":true,"properties":{"userId":{"type":"string"},"userName":{"type":"string"},"userAvatar":{"type":"string","nullable":true}},"required":["userId","userName","userAvatar"]},"createdBy":{"type":"object","nullable":true,"properties":{"userId":{"type":"string"},"userName":{"type":"string"},"userAvatar":{"type":"string","nullable":true}},"required":["userId","userName","userAvatar"]},"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string","nullable":true},"customField":{"type":"object","nullable":true,"properties":{"id":{"type":"string"},"ticketTypeId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","ticketTypeId","name","type"]}},"required":["id","content","customField"]}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string","nullable":true},"icon":{"type":"string","nullable":true},"nestedLevel":{"type":"number"}},"required":["id","name","color","icon","nestedLevel"]}},"tags":{"nullable":true},"tagCategory":{"nullable":true},"products":{"nullable":true},"manufacturer":{"nullable":true},"asset":{"nullable":true},"customFieldAssets":{"nullable":true},"purchase":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"categoryId":{"type":"string","nullable":true},"categoryName":{"type":"string","nullable":true},"categoryColor":{"type":"string","nullable":true},"statusId":{"type":"string","nullable":true},"statusName":{"type":"string","nullable":true},"statusCategory":{"type":"string","nullable":true},"statusColor":{"type":"string","nullable":true},"orderNumber":{"type":"string","nullable":true}},"required":["id","title","description","priority","categoryId","categoryName","categoryColor","statusId","statusName","statusCategory","statusColor","orderNumber"]}},"maintenance":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string","nullable":true},"seqId":{"type":"string"},"startDate":{"nullable":true},"endDate":{"nullable":true},"status":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"string"},"color":{"type":"string"},"name":{"type":"string"}},"required":["id","category","color","name"]}},"required":["id","title","description","seqId","status"]}},"assignees":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string"},"userName":{"type":"string"},"userAvatar":{"type":"string","nullable":true},"email":{"type":"string"}},"required":["userId","userName","userAvatar","email"]}},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"pictureUrl":{"type":"string","nullable":true}},"required":["id","firstName","lastName","email","pictureUrl"]}},"mgHistory":{"type":"array","items":{"nullable":true}}},"required":["id","seqId","title","description","priority","email","statusId","publicMessageUnread","ticketTypeId","isNotCreated","contactEntityId","primaryEquipmentId","subStatus","isInternal","status","contact","assignee","createdBy","fields","locations","purchase","maintenance","assignees","contacts","mgHistory"],"additionalProperties":{"nullable":true}}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Ticket not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ticket-types":{"get":{"summary":"List ticket types","description":"Returns a paginated list of ticket types.","tags":["tickets"],"security":[{"beamApiKey":[]}],"responses":{"200":{"description":"Paginated list of ticket types","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"currentPage":{"type":"number"},"totalPages":{"type":"number"},"hasMore":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TicketType"}}},"required":["total","currentPage","totalPages","hasMore","results"]}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ticket-types/{id}/statuses":{"get":{"summary":"List ticket type statuses","tags":["tickets"],"security":[{"beamApiKey":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Paginated list of ticket type statuses","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"currentPage":{"type":"number"},"totalPages":{"type":"number"},"hasMore":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TicketStatus"}}},"required":["total","currentPage","totalPages","hasMore","results"]}}}},"400":{"description":"The request could not be understood","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Ticket type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}